Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Explicitly mention which resources support compression in the config guide #13221

Merged
merged 3 commits into from
Jul 29, 2022
Merged

Explicitly mention which resources support compression in the config guide #13221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f66a75d
Explicitly mention which resources support compression in the config …
babolivier Jul 8, 2022
b4d759a
Changelog
babolivier Jul 8, 2022
e2fdb71
Merge branch 'develop' into babolivier/resource_compress_config
babolivier Jul 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/13221.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document which HTTP resources support gzip compression.
3 changes: 2 additions & 1 deletion docs/usage/configuration/config_documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wait, do we really not do this for federation endpoints?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, we just ignore compress if it's set for this resource:

synapse/synapse/app/homeserver.py

Lines 222 to 223 in f30bcbd

if name == "federation":
resources.update({FEDERATION_PREFIX: TransportLayerServer(self)})

I didn't open a new issue initially because I thought #2434 was about this but now that I'm reading this issue again it seems to assume it's possible, which doesn't show in the code.


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