summary refs log tree commit diff
path: root/docs/workers.md
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2019-12-13 10:55:47 +0000
committerErik Johnston <erik@matrix.org>2019-12-13 10:55:47 +0000
commitf46e05d0537e79e2811522fad5021a20f41fd733 (patch)
tree8e64bd77b9771d32c594470cbab9225b74701f09 /docs/workers.md
parentAdjust the sytest blacklist for worker mode (#6538) (diff)
parentMerge tag 'v1.7.0' (diff)
downloadsynapse-f46e05d0537e79e2811522fad5021a20f41fd733.tar.xz
Merge branch 'master' into develop
Diffstat (limited to 'docs/workers.md')
-rw-r--r--docs/workers.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/docs/workers.md b/docs/workers.md
index 4bd60ba0a0..1b5d94f5eb 100644
--- a/docs/workers.md
+++ b/docs/workers.md
@@ -196,7 +196,7 @@ Handles the media repository. It can handle all endpoints starting with:
 
     /_matrix/media/
 
-And the following regular expressions matching media-specific administration APIs:
+... and the following regular expressions matching media-specific administration APIs:
 
     ^/_synapse/admin/v1/purge_media_cache$
     ^/_synapse/admin/v1/room/.*/media$
@@ -206,6 +206,18 @@ You should also set `enable_media_repo: False` in the shared configuration
 file to stop the main synapse running background jobs related to managing the
 media repository.
 
+In the `media_repository` worker configuration file, configure the http listener to
+expose the `media` resource. For example:
+
+```yaml
+    worker_listeners:
+     - type: http
+       port: 8085
+       resources:
+         - names:
+           - media
+```
+
 Note this worker cannot be load-balanced: only one instance should be active.
 
 ### `synapse.app.client_reader`