summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorAndrew Morgan <andrew@amorgan.xyz>2020-02-20 15:59:36 +0000
committerAndrew Morgan <andrew@amorgan.xyz>2020-02-20 15:59:36 +0000
commit57c2254daa2beacd0ca7f6cbda9b7f9c9c6b802d (patch)
tree44111d4519b9ec368ff19d485e6b779d76b6d354 /docs
parentMerge pull request #5836 from matrix-org/erikj/lower_bound_ttl_well_known (diff)
parentDon't load the media repo when configured to use an external media repo (#5754) (diff)
downloadsynapse-57c2254daa2beacd0ca7f6cbda9b7f9c9c6b802d.tar.xz
Don't load the media repo when configured to use an external media repo (#5754)
Diffstat (limited to 'docs')
-rw-r--r--docs/sample_config.yaml7
-rw-r--r--docs/workers.rst7
2 files changed, 14 insertions, 0 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index 61c5ef1ea5..32db620853 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -646,6 +646,13 @@ log_config: "CONFDIR/SERVERNAME.log.config"
 
 
 
+## Media Store ##
+
+# Enable the media store service in the Synapse master. Uncomment the
+# following if you are using a separate media store worker.
+#
+#enable_media_repo: false
+
 # Directory where uploaded images and attachments are stored.
 #
 media_store_path: "DATADIR/media_store"
diff --git a/docs/workers.rst b/docs/workers.rst
index 7b2d2db533..e11e117418 100644
--- a/docs/workers.rst
+++ b/docs/workers.rst
@@ -206,6 +206,13 @@ Handles the media repository. It can handle all endpoints starting with::
 
     /_matrix/media/
 
+And the following regular expressions matching media-specific administration
+APIs::
+
+    ^/_synapse/admin/v1/purge_media_cache$
+    ^/_synapse/admin/v1/room/.*/media$
+    ^/_synapse/admin/v1/quarantine_media/.*$
+
 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.