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

Commit ddfdf94

Browse files
authored
Document that pusher instances are shardable (#9407)
1 parent 74af356 commit ddfdf94

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

changelog.d/9407.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Document that pusher instances are shardable.

docs/workers.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -373,7 +373,15 @@ Handles sending push notifications to sygnal and email. Doesn't handle any
373373
REST endpoints itself, but you should set `start_pushers: False` in the
374374
shared configuration file to stop the main synapse sending push notifications.
375375

376-
Note this worker cannot be load-balanced: only one instance should be active.
376+
To run multiple instances at once the `pusher_instances` option should list all
377+
pusher instances by their worker name, e.g.:
378+
379+
```yaml
380+
pusher_instances:
381+
- pusher_worker1
382+
- pusher_worker2
383+
```
384+
377385

378386
### `synapse.app.appservice`
379387

0 commit comments

Comments
 (0)