Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Clarifications to the workers documentation
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
jaywink committed Jan 24, 2020
1 parent fa4d609 commit aa6ad28
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
1 change: 1 addition & 0 deletions changelog.d/6775.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify documentation related to user_dir and federation_reader workers.
7 changes: 7 additions & 0 deletions docs/workers.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit aa6ad28

Please sign in to comment.