diff --git a/changelog.d/13451.doc b/changelog.d/13451.doc new file mode 100644 index 000000000000..b50685bda73c --- /dev/null +++ b/changelog.d/13451.doc @@ -0,0 +1 @@ +Correct misleading wording in worker documentation for `synapse.app.frontend_proxy`. diff --git a/docs/workers.md b/docs/workers.md index 6969c424d8cd..cd341862d6c1 100644 --- a/docs/workers.md +++ b/docs/workers.md @@ -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. -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: