Explicitly mention which resources support compression in the config …

…guide (matrix-org#13221)
azmeuk · Aug 8, 2022 · 8e1cb39 · 8e1cb39
1 parent a1ccbac
commit 8e1cb39
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/changelog.d/13221.doc 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
@@ -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.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Document which HTTP resources support gzip compression.