summary refs log tree commit diff
path: root/docs/workers.md
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2020-06-17 14:13:30 +0100
committerGitHub <noreply@github.com>2020-06-17 14:13:30 +0100
commitb44bdd7f7b261ec26e5d824a8caf97c6f56e1fbd (patch)
tree0493f76617ddcfdfbcc3d23cdd43e83f6d0830a2 /docs/workers.md
parentFetch from the r0 media path instead of the unspecced v1. (#7714) (diff)
downloadsynapse-b44bdd7f7b261ec26e5d824a8caf97c6f56e1fbd.tar.xz
Support running multiple media repos. (#7706)
This requires a new config option to specify which media repo should be
responsible for running background jobs to e.g. clear out expired URL
preview caches.
Diffstat (limited to 'docs/workers.md')
-rw-r--r--docs/workers.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/workers.md b/docs/workers.md
index 7512eff43a..f4cbbc0400 100644
--- a/docs/workers.md
+++ b/docs/workers.md
@@ -307,7 +307,12 @@ expose the `media` resource. For example:
            - media
 ```
 
-Note this worker cannot be load-balanced: only one instance should be active.
+Note that if running multiple media repositories they must be on the same server
+and you must configure a single instance to run the background tasks, e.g.:
+
+```yaml
+    media_instance_running_background_jobs: "media-repository-1"
+```
 
 ### `synapse.app.client_reader`