MirrorHub/synapse
0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-12-14 17:13:54 +01:00
Code Issues Projects Releases Wiki Activity

Clarifications to the workers documentation

Browse source 
* 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>
This commit is contained in:
Jason Robinson 2020-01-24 11:01:57 +02:00
parent fa4d609e20
commit aa6ad288f1
2 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/6775.doc Normal file
View file

@ -0,0 +1 @@
Clarify documentation related to user_dir and federation_reader workers.

7
docs/workers.md
View file

@ -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:
^/_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