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

Clarifications to the workers documentation #6775

Merged
merged 3 commits into from
Jan 27, 2020
Merged

Clarifications to the workers documentation #6775

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aa6ad28
Clarifications to the workers documentation
jaywink Jan 24, 2020
1fe5001
Fix federation_reader listeners doc as per PR review
jaywink Jan 27, 2020
cf9d56e
Formatting of changelog
jaywink Jan 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/6775.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify documentation related to user_dir and federation_reader workers.
jaywink marked this conversation as resolved.
Show resolved Hide resolved
7 changes: 7 additions & 0 deletions docs/workers.md
View file
Open in desktop
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.
babolivier marked this conversation as resolved.
Show resolved Hide resolved

### `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