summary refs log tree commit diff
path: root/docs/workers.md
diff options
context:
space:
mode:
authorMark Nowiasz <36151963+mnowiasz@users.noreply.github.com>2019-12-11 17:23:38 +0100
committerRichard van der Hoff <1389908+richvdh@users.noreply.github.com>2019-12-11 16:23:38 +0000
commit58fdcbdfe7f064f336f514b921a556c116c757cb (patch)
tree18ba4578f85d7d22ac7de338b4e9d29ebd75737e /docs/workers.md
parentRemove #6369 changelog (diff)
downloadsynapse-58fdcbdfe7f064f336f514b921a556c116c757cb.tar.xz
Update workers.md to make media_repository work (again) (#6519)
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`