summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorBrendan Abolivier <babolivier@matrix.org>2022-07-29 11:09:57 +0200
committerGitHub <noreply@github.com>2022-07-29 09:09:57 +0000
commit24ef1460f691c0fb40470784603c6b0c34629d09 (patch)
treeaf68e2105e70fac32d69cfb88813374b8f531170 /docs
parentUse stable prefixes for MSC3827: filtering of `/publicRooms` by room type (#1... (diff)
downloadsynapse-24ef1460f691c0fb40470784603c6b0c34629d09.tar.xz
Explicitly mention which resources support compression in the config guide (#13221)
Diffstat (limited to 'docs')
-rw-r--r--docs/usage/configuration/config_documentation.md3
1 files changed, 2 insertions, 1 deletions
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.