summary refs log tree commit diff
path: root/docs/media_repository.rst
diff options
context:
space:
mode:
authorMark Haines <mark.haines@matrix.org>2014-12-10 16:54:37 +0000
committerMark Haines <mark.haines@matrix.org>2014-12-10 16:54:37 +0000
commit7f193b9958f9fc3e039564a9360767530c09b803 (patch)
treeb217d635fcc9b3c9c204b66192681bec1ef61505 /docs/media_repository.rst
parentMerge branch 'develop' into media_repository (diff)
downloadsynapse-7f193b9958f9fc3e039564a9360767530c09b803.tar.xz
update media repository implementation docs
Diffstat (limited to 'docs/media_repository.rst')
-rw-r--r--docs/media_repository.rst13
1 files changed, 9 insertions, 4 deletions
diff --git a/docs/media_repository.rst b/docs/media_repository.rst
index e554d0f495..e4a6974041 100644
--- a/docs/media_repository.rst
+++ b/docs/media_repository.rst
@@ -12,9 +12,14 @@ Each item of media is assigned a ``media_id`` when it is uploaded.
 The ``media_id`` is a randomly chosen, URL safe 24 character string.
 Metadata such as the MIME type, upload time and length are stored in the
 sqlite3 database indexed by ``media_id``.
-Content is stored on the filesystem under a "content" directory. Thumbnails are
-stored under a "thumbnails" directory.
+Content is stored on the filesystem under a ``"local_content"`` directory.
+Thumbnails are stored under a ``"local_thumbnails"`` directory.
 The item with ``media_id`` ``"aabbccccccccdddddddddddd"`` is stored under
-``"local/content/aa/bb/ccccccccdddddddddddd"``. Its thumbnail with width
+``"local_content/aa/bb/ccccccccdddddddddddd"``. Its thumbnail with width
 ``128`` and height ``96`` and type ``"image/jpeg"`` is stored under
-``"local/thumbnails/aa/bb/ccccccccdddddddddddd/128-96-image-jpeg"``
+``"local_thumbnails/aa/bb/ccccccccdddddddddddd/128-96-image-jpeg"``
+Remote content is cached under ``"remote_content"`` directory. Each item of
+remote content is assigned a local "``filesystem_id``" to ensure that the
+directory structure ``"remote_content/server_name/aa/bb/ccccccccdddddddddddd"``
+is appropriate. Thumbnails for remote content are stored under
+``"remote_thumbnails/server_name/..."``