encode: Document zstd levels

This commit is contained in:
Matthew Holt 2024-08-09 11:37:30 -06:00
parent 30f3b386e6
commit 441f11e1c3
No known key found for this signature in database
GPG key ID: 2A349DD577D586A5

View file

@ -19,7 +19,7 @@ Encodes responses using the configured encoding(s). A typical use for encoding i
encode [<matcher>] <formats...> {
# encoding formats
gzip [<level>]
zstd
zstd [<level>]
minimum_length <length>
@ -35,9 +35,9 @@ encode [<matcher>] <formats...> {
- **&lt;formats...&gt;** is the list of encoding formats to enable. If multiple encodings are enabled, the encoding is chosen based the request's Accept-Encoding header; if the client has no strong preference (q-factor), then the first supported encoding is used.
- **gzip** <span id="gzip"/> enables Gzip compression, optionally at the specified level.
- **gzip** <span id="gzip"/> enables Gzip compression, optionally at a specified level.
- **zstd** <span id="zstd"/> enables Zstandard compression.
- **zstd** <span id="zstd"/> enables Zstandard compression, optionally at a specified level (possible values = default, fastest, better, best). The default compression level is roughly equivalent to the default Zstandard mode (level 3).
- **minimum_length** <span id="minimum_length"/> the minimum number of bytes a response should have to be encoded (default: 512).