summary refs log tree commit diff
path: root/contrib/docker/README.md
diff options
context:
space:
mode:
authorkaiyou <pierre@jaury.eu>2018-02-08 20:53:12 +0100
committerkaiyou <pierre@jaury.eu>2018-02-08 20:53:12 +0100
commitef1f8d4be6e970043b8283f5caa1ca764652ad56 (patch)
treef432d08161a67b07f412d9fb4749487a616dd29f /contrib/docker/README.md
parentHonor the SYNAPSE_REPORT_STATS parameter in the Docker image (diff)
downloadsynapse-ef1f8d4be6e970043b8283f5caa1ca764652ad56.tar.xz
Enable email server configuration from environment variables
Diffstat (limited to 'contrib/docker/README.md')
-rw-r--r--contrib/docker/README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/contrib/docker/README.md b/contrib/docker/README.md
index 9f40dc0d58..b74c72698c 100644
--- a/contrib/docker/README.md
+++ b/contrib/docker/README.md
@@ -119,3 +119,10 @@ Database specific values (will use SQLite if not set):
 * `POSTGRES_HOST` - The host of the postgres database if you wish to use postgresql instead of sqlite3. [default: `db` which is useful when using a container on the same docker network in a compose file where the postgres service is called `db`]
 * `POSTGRES_PASSWORD` - The password for the synapse postgres database. **If this is set then postgres will be used instead of sqlite3.** [default: none] **NOTE**: You are highly encouraged to use postgresql! Please use the compose file to make it easier to deploy.
 * `POSTGRES_USER` - The user for the synapse postgres database. [default: `matrix`]
+
+Mail server specific values (will not send emails if not set):
+
+* ``SYNAPSE_SMTP_HOST``, hostname to the mail server.
+* ``SYNAPSE_SMTP_PORT``, TCP port for accessing the mail server [default ``25``].
+* ``SYNAPSE_SMTP_USER``, username for authenticating against the mail server if any.
+* ``SYNAPSE_SMTP_PASSWORD``, password for authenticating against the mail server if any.