From 0ee92b2aa1a4f0938d3d2c16f6d800c843d2b7ec Mon Sep 17 00:00:00 2001 From: asonix Date: Fri, 8 Dec 2023 23:27:24 -0600 Subject: [PATCH] Add Logging, Quality, Read-Only, and Danger-Dummy documentation --- releases/0.5.0.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/releases/0.5.0.md b/releases/0.5.0.md index eb3551d..05a3561 100644 --- a/releases/0.5.0.md +++ b/releases/0.5.0.md @@ -337,15 +337,43 @@ request to be rejected with a 400 Bad Request error. ### Logging Verbosity +pict-rs 0.5 no longer logs the opening and closing of tracing spans. This means the logs will now +be mostly empty aside from the occasional warning or error. Errors should still provide ample debug +information, so the decrease in verbosity should not negatively affect debugging of the program. + ### Quality Configuration +pict-rs 0.5 now supports configuring the quality and compression of transcoded media. New +configuration sections have been introduced to allow setting values for each image format +individually, as well as individual quality settings for different video resolutions. + +For the specifics of quality configuration, see the example +[pict-rs.toml](https://git.asonix.dog/asonix/pict-rs/src/branch/main/pict-rs.toml). + ### Read-Only Mode +pict-rs 0.5 has gained the ability to run in a "read-only" mode, which will forbid the application +from accepting new uploaded media, creating new media variants, or updating any metadata. This is +useful for complex environments that are capable of running a copy of the pict-rs application while +performing maintenance on the "real" deployment. + +For configuration information, see the example +[pict-rs.toml](https://git.asonix.dog/asonix/pict-rs/src/branch/main/pict-rs.toml). ### Danger-Dummy Mode +pict-rs 0.5 can now run without any external dependencies in "Danger-Dummy Mode." This allows +uploading and serving media, but all of the metadata for that media will be fake default values, and +the media cannot be processed in any way. This is not intended for production uses, since generic +file stores (like directly using object storage) are more tailored for this use case. Instead, this +is provided to enable applications to perform integration tests with pict-rs without needing to +reconstruct a valid environment to run the application. + +For configuration information, see the example +[pict-rs.toml](https://git.asonix.dog/asonix/pict-rs/src/branch/main/pict-rs.toml). + ### Media Variant Retention