Skip to content

Commit bbf1622

Browse files
committed
Add zstd compression support to documentation
- Update documentation to include zstd algorithm description - Add zstd examples in configuration samples - Update release notes and README to mention zstd support
1 parent 6f58f74 commit bbf1622

File tree

4 files changed

+33
-5
lines changed

4 files changed

+33
-5
lines changed

doc/admin-guide/plugins/compress.en.rst

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -186,9 +186,19 @@ supported-algorithms
186186

187187
Provides the compression algorithms that are supported, a comma separate list
188188
of values. This will allow |TS| to selectively support ``gzip``, ``deflate``,
189-
and brotli (``br``) compression. The default is ``gzip``. Multiple algorithms can
190-
be selected using ',' delimiter, for instance, ``supported-algorithms
191-
deflate,gzip,br``. Note that this list must **not** contain any white-spaces!
189+
brotli (``br``), and zstd (``zstd``) compression. The default is ``gzip``.
190+
Multiple algorithms can be selected using ',' delimiter, for instance,
191+
``supported-algorithms deflate,gzip,br,zstd``. Note that this list must **not**
192+
contain any white-spaces!
193+
194+
============== =================================================================
195+
Algorithm Description
196+
============== =================================================================
197+
gzip Standard gzip compression (default, widely supported)
198+
deflate Deflate compression (RFC 1951)
199+
br Brotli compression (modern, efficient)
200+
zstd Zstandard compression (fast, high compression ratio)
201+
============== =================================================================
192202

193203
Note that if :ts:cv:`proxy.config.http.normalize_ae` is ``1``, only gzip will
194204
be considered, and if it is ``2``, only br or gzip will be considered.
@@ -233,6 +243,23 @@ might create a configuration with the following options::
233243
flush true
234244
supported-algorithms br,gzip
235245

246+
# Supports zstd compression for high efficiency
247+
[zstd.compress.com]
248+
enabled true
249+
compressible-content-type text/*
250+
compressible-content-type application/json
251+
compressible-content-type application/javascript
252+
flush true
253+
supported-algorithms zstd,gzip
254+
255+
# Supports all compression algorithms
256+
[all.compress.com]
257+
enabled true
258+
compressible-content-type text/*
259+
compressible-content-type application/json
260+
flush true
261+
supported-algorithms zstd,br,gzip,deflate
262+
236263
# This origin does it all
237264
[bar.example.com]
238265
enabled false

doc/release-notes/whats-new.en.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ Plugins
8181
* xdebug - ``--enable`` option to selectively enable features has been added
8282
* system_stats - Stats about memory have been added
8383
* slice plugin - This plugin was promoted to stable.
84+
* compress plugin - Added support for Zstandard (zstd) compression algorithm.
8485

8586
JSON-RPC
8687
^^^^^^^^

plugins/compress/README

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
What this plugin does:
22
=====================
33

4-
This plugin compresses responses, via gzip or brotli, whichever is applicable
4+
This plugin compresses responses, via gzip, deflate, brotli, or zstd (Zstandard), whichever is applicable
55
it can compress origin responses as well as cached responses
66

77
installation:

plugins/compress/sample.compress.config

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ allow !*/bla*
5656

5757
minimum-content-length 1024
5858
#supported algorithms
59-
supported-algorithms br,gzip
59+
supported-algorithms br,gzip,zstd
6060

6161
#override the global configuration for a host.
6262
#www.foo.nl does NOT inherit anything

0 commit comments

Comments
 (0)