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: Jason Robinson <jasonr@matrix.org>pull/6775/head
parent
fa4d609e20
commit
aa6ad288f1
|
@ -0,0 +1 @@
|
|||
Clarify documentation related to user_dir and federation_reader workers.
|
|
@ -185,6 +185,9 @@ reverse-proxy configuration.
|
|||
The `^/_matrix/federation/v1/send/` endpoint must only be handled by a single
|
||||
instance.
|
||||
|
||||
Note that the `worker_listeners.resources.name` needs to be set to `federation`
|
||||
for this worker.
|
||||
|
||||
### `synapse.app.federation_sender`
|
||||
|
||||
Handles sending federation traffic to other servers. Doesn't handle any
|
||||
|
@ -265,6 +268,10 @@ the following regular expressions:
|
|||
|
||||
^/_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`
|
||||
|
||||
Proxies some frequently-requested client endpoints to add caching and remove
|
||||
|
|
Loading…
Reference in New Issue