summary refs log tree commit diff
path: root/contrib/docker/README.md
diff options
context:
space:
mode:
authorkaiyou <pierre@jaury.eu>2018-02-08 19:48:53 +0100
committerkaiyou <pierre@jaury.eu>2018-02-08 19:48:53 +0100
commit58df3a8c5dcf5de12bcf9190551dc8241d32b8a1 (patch)
treeb9cdf56a2b939e25d2b4ebe35037bb25b4d05488 /contrib/docker/README.md
parentMake it clear that two modes are avaiable in the documentation, improve the c... (diff)
downloadsynapse-58df3a8c5dcf5de12bcf9190551dc8241d32b8a1.tar.xz
Add some documentation about high performance storage
Diffstat (limited to '')
-rw-r--r--contrib/docker/README.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/contrib/docker/README.md b/contrib/docker/README.md
index 197bad103e..3710afb0cf 100644
--- a/contrib/docker/README.md
+++ b/contrib/docker/README.md
@@ -31,11 +31,11 @@ Then, to run the server:
 docker-compose up -d
 ```
 
-In the case you specified a custom path for you configuration file and wish to
+In the case you specify a custom path for you configuration file and wish to
 generate a fresh ``homeserver.yaml``, simply run:
 
 ```
-docker-compose run --rm synapse generate
+docker-compose run --rm -e SYNAPSE_SERVER_NAME=my.matrix.host synapse generate
 ```
 
 If you do not wish to use Compose, you may still run this image using plain
@@ -62,6 +62,11 @@ The image expects a single volume, located at ``/data``, that will hold:
 * the SQLite database if you do not configure postgres;
 * the appservices configuration.
 
+You are free to use separate volumes depending on storage endpoints at your
+disposal. For instance, ``/data/media`` coud be stored on a large but low
+performance hdd storage while other files could be stored on high performance
+endpoints.
+
 In order to setup an application service, simply create an ``appservices``
 directory in the data volume and write the application service Yaml
 configuration file there. Multiple application services are supported.