diff options
| author | Jason Robinson <jasonr@matrix.org> | 2020-01-24 11:01:57 +0200 |
|---|---|---|
| committer | Jason Robinson <jasonr@matrix.org> | 2020-01-24 11:08:50 +0200 |
| commit | aa6ad288f16ed263b2a94b480259639d52ff6cad (patch) | |
| tree | 6ecac5d640e5030ddcf0706faea4c03859375c50 | |
| parent | Make 'event.redacts' never raise. (#6771) (diff) | |
| download | synapse-aa6ad288f16ed263b2a94b480259639d52ff6cad.tar.xz | |
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>
Diffstat (limited to '')
| -rw-r--r-- | changelog.d/6775.doc | 1 | ||||
| -rw-r--r-- | docs/workers.md | 7 |
2 files changed, 8 insertions, 0 deletions
diff --git a/changelog.d/6775.doc b/changelog.d/6775.doc new file mode 100644 index 0000000000..9421250f8b --- /dev/null +++ b/changelog.d/6775.doc @@ -0,0 +1 @@ +Clarify documentation related to user_dir and federation_reader workers. diff --git a/docs/workers.md b/docs/workers.md index 0ab269fd96..a5d6d18f23 100644 --- a/docs/workers.md +++ b/docs/workers.md @@ -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 |