Skip to content

Commit 8e1cb39

Browse files
babolivierazmeuk
authored andcommitted
Explicitly mention which resources support compression in the config guide (matrix-org#13221)
1 parent a1ccbac commit 8e1cb39

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

changelog.d/13221.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Document which HTTP resources support gzip compression.

docs/usage/configuration/config_documentation.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -486,7 +486,8 @@ Sub-options for each listener include:
486486

487487
* `names`: a list of names of HTTP resources. See below for a list of valid resource names.
488488

489-
* `compress`: set to true to enable HTTP compression for this resource.
489+
* `compress`: set to true to enable gzip compression on HTTP bodies for this resource. This is currently only supported with the
490+
`client`, `consent` and `metrics` resources.
490491

491492
* `additional_resources`: Only valid for an 'http' listener. A map of
492493
additional endpoints which should be loaded via dynamic modules.

0 commit comments

Comments
 (0)