diff options
| author | Brendan Abolivier <babolivier@matrix.org> | 2022-07-29 11:09:57 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-29 09:09:57 +0000 |
| commit | 24ef1460f691c0fb40470784603c6b0c34629d09 (patch) | |
| tree | af68e2105e70fac32d69cfb88813374b8f531170 | |
| parent | Use stable prefixes for MSC3827: filtering of `/publicRooms` by room type (#1... (diff) | |
| download | synapse-24ef1460f691c0fb40470784603c6b0c34629d09.tar.xz | |
Explicitly mention which resources support compression in the config guide (#13221)
| -rw-r--r-- | changelog.d/13221.doc | 1 | ||||
| -rw-r--r-- | docs/usage/configuration/config_documentation.md | 3 |
2 files changed, 3 insertions, 1 deletions
diff --git a/changelog.d/13221.doc b/changelog.d/13221.doc new file mode 100644 index 0000000000..dd2b3d8972 --- /dev/null +++ b/changelog.d/13221.doc @@ -0,0 +1 @@ +Document which HTTP resources support gzip compression. diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index eefcc7829d..5558b0d2ec 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -486,7 +486,8 @@ Sub-options for each listener include: * `names`: a list of names of HTTP resources. See below for a list of valid resource names. - * `compress`: set to true to enable HTTP compression for this resource. + * `compress`: set to true to enable gzip compression on HTTP bodies for this resource. This is currently only supported with the + `client`, `consent` and `metrics` resources. * `additional_resources`: Only valid for an 'http' listener. A map of additional endpoints which should be loaded via dynamic modules. |