summary refs log tree commit diff
path: root/docs/workers.md
diff options
context:
space:
mode:
authorJason Robinson <jasonr@matrix.org>2020-01-27 10:20:48 +0200
committerJason Robinson <jasonr@matrix.org>2020-01-27 10:21:25 +0200
commit1fe50013691873e7549276fcc7a679bfe19595f9 (patch)
treececa228bad3bcb82d033dbf09d9f1ce692088f46 /docs/workers.md
parentClarifications to the workers documentation (diff)
downloadsynapse-1fe50013691873e7549276fcc7a679bfe19595f9.tar.xz
Fix federation_reader listeners doc as per PR review
Signed-off-by: Jason Robinson <jasonr@matrix.org>
Diffstat (limited to 'docs/workers.md')
-rw-r--r--docs/workers.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/docs/workers.md b/docs/workers.md
index a5d6d18f23..09a9d8a7b8 100644
--- a/docs/workers.md
+++ b/docs/workers.md
@@ -185,8 +185,18 @@ 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.
+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`