summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2020-11-03 10:27:11 +0000
committerGitHub <noreply@github.com>2020-11-03 10:27:11 +0000
commit4b09b7438e99e379c483026fb578f92fd7e30d9f (patch)
tree82d8c7bf3e3b06e3c0f7891594586d7f1f67f7fb /docs
parentgrammar (diff)
downloadsynapse-4b09b7438e99e379c483026fb578f92fd7e30d9f.tar.xz
Document how to set up multiple event persisters (#8706)
Diffstat (limited to 'docs')
-rw-r--r--docs/workers.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/workers.md b/docs/workers.md
index cd1f823b77..4e046bdb31 100644
--- a/docs/workers.md
+++ b/docs/workers.md
@@ -319,6 +319,18 @@ stream_writers:
     events: event_persister1
 ```
 
+The `events` stream also experimentally supports having multiple writers, where
+work is sharded between them by room ID. Note that you *must* restart all worker
+instances when adding or removing event persisters. An example `stream_writers`
+configuration with multiple writers:
+
+```yaml
+stream_writers:
+    events:
+        - event_persister1
+        - event_persister2
+```
+
 #### Background tasks
 
 There is also *experimental* support for moving background tasks to a separate