Document how to set up multiple event persisters (#8706)

matrix-org · Nov 3, 2020 · 4b09b74 · 4b09b74
1 parent d04c2d1
commit 4b09b74
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/changelog.d/8706.doc b/changelog.d/8706.doc
@@ -0,0 +1 @@
+Document experimental support for running multiple event persisters.
diff --git 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