From ddfdf945064925eba761ae3748e38f3a1c73c328 Mon Sep 17 00:00:00 2001 From: Erik Johnston <erik@matrix.org> Date: Tue, 16 Feb 2021 13:27:49 +0000 Subject: [PATCH] Document that pusher instances are shardable (#9407) --- changelog.d/9407.doc | 1 + docs/workers.md | 10 +++++++++- 2 files changed, 10 insertions(+), 1 deletion(-) create mode 100644 changelog.d/9407.doc diff --git a/changelog.d/9407.doc b/changelog.d/9407.doc new file mode 100644 index 0000000000..36979bc0d8 --- /dev/null +++ b/changelog.d/9407.doc @@ -0,0 +1 @@ +Document that pusher instances are shardable. 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` -- GitLab