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

Commit

Permalink
Merge pull request #6775 from matrix-org/jaywink/worker-docs-tweaks
Browse files Browse the repository at this point in the history
* commit 'f74d178b1':
  Formatting of changelog
  Fix federation_reader listeners doc as per PR review
  Clarifications to the workers documentation
  • Loading branch information
anoadragon453 committed Mar 23, 2020
2 parents 8632f34 + f74d178 commit 645a30b
Show file tree
Hide file tree
Showing 2 changed files with 18 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.
17 changes: 17 additions & 0 deletions docs/workers.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,19 @@ reverse-proxy configuration.
The `^/_matrix/federation/v1/send/` endpoint must only be handled by a single
instance.

Note that `federation` must be added to the listener resources in the worker config:

```yaml
worker_app: synapse.app.federation_reader
...
worker_listeners:
- type: http
port: <port>
resources:
- names:
- federation
```
### `synapse.app.federation_sender`

Handles sending federation traffic to other servers. Doesn't handle any
Expand Down Expand Up @@ -265,6 +278,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 645a30b

Please sign in to comment.