Document that pusher instances are shardable (#9407)

This commit is contained in:
Erik Johnston 2021-02-16 13:27:49 +00:00 committed by GitHub
parent 74af356baf
commit ddfdf94506
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 1 deletions

1
changelog.d/9407.doc Normal file
View file

@ -0,0 +1 @@
Document that pusher instances are shardable.

View file

@ -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 REST endpoints itself, but you should set `start_pushers: False` in the
shared configuration file to stop the main synapse sending push notifications. 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` ### `synapse.app.appservice`