summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2021-02-16 13:27:49 +0000
committerGitHub <noreply@github.com>2021-02-16 13:27:49 +0000
commitddfdf945064925eba761ae3748e38f3a1c73c328 (patch)
tree843f1ec5924dbde670fbbde8d406d8a31cbe6c15 /docs
parentConvert additional test-cases to homeserver test case. (#9396) (diff)
downloadsynapse-ddfdf945064925eba761ae3748e38f3a1c73c328.tar.xz
Document that pusher instances are shardable (#9407)
Diffstat (limited to '')
-rw-r--r--docs/workers.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/workers.md b/docs/workers.md
index f7fc6df119..9bda0f8c23 100644
--- a/docs/workers.md
+++ b/docs/workers.md
@@ -373,7 +373,15 @@ Handles sending push notifications to sygnal and email. Doesn't handle any
 REST endpoints itself, but you should set `start_pushers: False` in the
 shared configuration file to stop the main synapse sending push notifications.
 
-Note this worker cannot be load-balanced: only one instance should be active.
+To run multiple instances at once the `pusher_instances` option should list all
+pusher instances by their worker name, e.g.:
+
+```yaml
+pusher_instances:
+    - pusher_worker1
+    - pusher_worker2
+```
+
 
 ### `synapse.app.appservice`