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

Fix worker doc for synapse.app.frontend_proxy #13451

Closed
wants to merge 5 commits into from
Closed

Fix worker doc for synapse.app.frontend_proxy #13451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fb5e393
Fix worker doc for `synapse.app.frontend_proxy`
dklimpel Aug 3, 2022
eaa25d8
newsfile
dklimpel Aug 3, 2022
12877da
Apply suggestions from code review
dklimpel Aug 4, 2022
f7297ab
Change wording from `not cached` to `uncached`
dklimpel Aug 9, 2022
78501b3
update newsfile
dklimpel Aug 9, 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/13451.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Correct misleading wording in worker documentation for `synapse.app.frontend_proxy`.
6 changes: 3 additions & 3 deletions docs/workers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -589,15 +589,15 @@ regular expressions:

^/_matrix/client/(r0|v3|unstable)/keys/upload

If `use_presence` is False in the homeserver config, it can also handle REST
endpoints matching the following regular expressions:
If `use_presence` is set to `false` in the homeserver config, the frontend proxy can also handle REST
endpoints matching the following regular expression:

^/_matrix/client/(api/v1|r0|v3|unstable)/presence/[^/]+/status

This "stub" presence handler will pass through `GET` request but make the
`PUT` effectively a no-op.
Comment on lines +592 to 598
Copy link
Member

Choose a reason for hiding this comment

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

It really doesn't matter whether use_presence is set to false or not: any worker can now handle ^/_matrix/client/.../presence/[^/]+/status. It is no longer a "stub".


It will proxy any requests it cannot handle to the main synapse instance. It
It will proxy uncached requests to the main synapse instance. It
must therefore be configured with the location of the main instance, via
the `worker_main_http_uri` setting in the `frontend_proxy` worker configuration
file. For example:
Expand Down