Skip to content
Snippets Groups Projects
Commit aa6ad288 authored by Jason Robinson's avatar Jason Robinson
Browse files

Clarifications to the workers documentation


* Add note that user_dir requires disabling user dir
  updates from the main synapse process.
* Add note that federation_reader should have
  the federation listener resource.

Signed-off-by: default avatarJason Robinson <jasonr@matrix.org>
parent fa4d609e
No related branches found
No related tags found
No related merge requests found
Clarify documentation related to user_dir and federation_reader workers.
...@@ -185,6 +185,9 @@ reverse-proxy configuration. ...@@ -185,6 +185,9 @@ reverse-proxy configuration.
The `^/_matrix/federation/v1/send/` endpoint must only be handled by a single The `^/_matrix/federation/v1/send/` endpoint must only be handled by a single
instance. instance.
Note that the `worker_listeners.resources.name` needs to be set to `federation`
for this worker.
### `synapse.app.federation_sender` ### `synapse.app.federation_sender`
Handles sending federation traffic to other servers. Doesn't handle any Handles sending federation traffic to other servers. Doesn't handle any
...@@ -265,6 +268,10 @@ the following regular expressions: ...@@ -265,6 +268,10 @@ the following regular expressions:
^/_matrix/client/(api/v1|r0|unstable)/user_directory/search$ ^/_matrix/client/(api/v1|r0|unstable)/user_directory/search$
When using this worker you must also set `update_user_directory: False` in the
shared configuration file to stop the main synapse running background
jobs related to updating the user directory.
### `synapse.app.frontend_proxy` ### `synapse.app.frontend_proxy`
Proxies some frequently-requested client endpoints to add caching and remove Proxies some frequently-requested client endpoints to add caching and remove
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment