diff options
| author | Michael Kaye <1917473+michaelkaye@users.noreply.github.com> | 2018-05-16 10:10:31 +0100 |
|---|---|---|
| committer | Neil Johnson <neil@matrix.org> | 2018-05-17 18:12:00 +0100 |
| commit | 450f500d0c96919a657225da63662555531531cb (patch) | |
| tree | ccb49c74ca48bc29640caa040233cb827ba0b774 /contrib/docker/README.md | |
| parent | Document macaroon env var correctly (diff) | |
| download | synapse-450f500d0c96919a657225da63662555531531cb.tar.xz | |
Note that secrets need to be retained.
Diffstat (limited to '')
| -rw-r--r-- | contrib/docker/README.md | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/contrib/docker/README.md b/contrib/docker/README.md index dee5e92cab..ef022f9dc1 100644 --- a/contrib/docker/README.md +++ b/contrib/docker/README.md @@ -1,6 +1,6 @@ # Synapse Docker -This Docker image will run Synapse as a single process. It does not provide any +The `matrixdotorg/synapse` Docker image will run Synapse as a single process. It does not provide any database server or TURN server that you should run separately. If you run a Postgres server, you should simply have it in the same Compose @@ -37,10 +37,15 @@ then run the server: docker-compose up -d ``` +If secrets are not specified in the environment variables, they will be generated +as part of the startup. Please ensure these secrets are kept between launches of the +Docker container, as their loss may require users to log in again. + ### Manual configuration A sample ``docker-compose.yml`` is provided, including example labels for -reverse proxying and other artifacts. +reverse proxying and other artifacts. The docker-compose file is an example, +please comment/uncomment sections that are not suitable for your usecase. Specify a ``SYNAPSE_CONFIG_PATH``, preferably to a persistent path, to use manual configuration. To generate a fresh ``homeserver.yaml``, simply run: |