summary refs log tree commit diff
diff options
context:
space:
mode:
-rw-r--r--MANIFEST.in1
-rw-r--r--contrib/docker/README.md19
-rw-r--r--contrib/docker/docker-compose.yml7
3 files changed, 17 insertions, 10 deletions
diff --git a/MANIFEST.in b/MANIFEST.in
index afb60e12ee..8c9a57a9ca 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -25,6 +25,7 @@ recursive-include synapse/static *.js
 exclude jenkins.sh
 exclude jenkins*.sh
 exclude jenkins*
+exclude Dockerfile
 recursive-exclude jenkins *.sh
 
 prune .github
diff --git a/contrib/docker/README.md b/contrib/docker/README.md
index 8ba5f79692..73e53e4306 100644
--- a/contrib/docker/README.md
+++ b/contrib/docker/README.md
@@ -23,7 +23,7 @@ You may have a local Python wheel cache available, in which case copy the releva
 
 It is recommended that you use Docker Compose to run your containers, including
 this image and a Postgres server. A sample ``docker-compose.yml`` is provided,
-with example labels for a reverse proxy and other artifacts.
+including example labels for reverse proxying and other artifacts.
 
 Then, to run the server:
 
@@ -35,13 +35,13 @@ In the case you specified a custom path for you configuration file and wish to
 generate a fresh ``homeserver.yaml``, simply run:
 
 ```
-docker-compose run synapse generate
+docker-compose run --rm synapse generate
 ```
 
 If you do not wish to use Compose, you may still run this image using plain
-Docker commands:
-
-Note that the following is just a guideline and you may need to add parameters to the docker run command to account for the network situation with your postgres database.
+Docker commands. Note that the following is just a guideline and you may need
+to add parameters to the docker run command to account for the network situation
+with your postgres database.
 
 ```
 docker run \
@@ -55,7 +55,7 @@ docker run \
 
 ## Volumes
 
-The image expects a single volue, located at ``/data``, that will hold:
+The image expects a single volume, located at ``/data``, that will hold:
 
 * temporary files during uploads;
 * uploaded media and thumbnais;
@@ -63,10 +63,15 @@ The image expects a single volue, located at ``/data``, that will hold:
 
 ## Environment
 
-If you do not specify a custom path for the configuration file, a very generic
+Unless you specify a custom path for the configuration file, a very generic
 file will be generated, based on the following environment settings.
 These are a good starting point for setting up your own deployment.
 
+Global settings:
+
+* ``UID``, the user id Synapse will run as [default 991]
+* ``GID``, the group id Synapse will run as [default 991]
+
 Synapse specific settings:
 
 * ``SYNAPSE_SERVER_NAME`` (mandatory), the current server public hostname.
diff --git a/contrib/docker/docker-compose.yml b/contrib/docker/docker-compose.yml
index b8f9741f05..727743effa 100644
--- a/contrib/docker/docker-compose.yml
+++ b/contrib/docker/docker-compose.yml
@@ -1,4 +1,4 @@
-# This compose file is compatible with Copose itself, it might need some
+# This compose file is compatible with Compose itself, it might need some
 # adjustments to run properly with stack.
 
 version: '3'
@@ -18,10 +18,11 @@ services:
       - ./files:/data
     depends_on:
       - db
-    # One may either expose ports directly
+    # In order to expose Synapse, remove one of the following, you might for
+    # instance expose the TLS port directly:
     ports:
       - 8448:8448/tcp
-    # ... or use a reverse proxy, here is an example for traefik
+    # ... or use a reverse proxy, here is an example for traefik:
     labels:
       - traefik.enable=true
       - traefik.frontend.rule=Host:my.matrix.Host