mirror of
https://github.com/element-hq/synapse
synced 2024-09-12 10:35:11 +00:00
Merge pull request #6775 from matrix-org/jaywink/worker-docs-tweaks
Clarifications to the workers documentation
This commit is contained in:
commit
f74d178b17
2 changed files with 18 additions and 0 deletions
1
changelog.d/6775.doc
Normal file
1
changelog.d/6775.doc
Normal file
|
@ -0,0 +1 @@
|
||||||
|
Clarify documentation related to `user_dir` and `federation_reader` workers.
|
|
@ -185,6 +185,19 @@ 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 `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`
|
### `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 +278,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
|
||||||
|
|
Loading…
Reference in a new issue