diff options
| author | Richard van der Hoff <richard@matrix.org> | 2019-06-10 20:28:08 +0100 |
|---|---|---|
| committer | Richard van der Hoff <richard@matrix.org> | 2019-06-10 20:28:08 +0100 |
| commit | 69a43d9974824893605252bf32d08484fdaa28fb (patch) | |
| tree | 180a6d2e659269ebf6e61b424051497cbab22848 /INSTALL.md | |
| parent | SAML2 Improvements and redirect stuff (diff) | |
| parent | Merge branch 'release-v1.0.0' of github.com:matrix-org/synapse into develop (diff) | |
| download | synapse-69a43d9974824893605252bf32d08484fdaa28fb.tar.xz | |
Merge remote-tracking branch 'origin/develop' into rav/saml2_client
Diffstat (limited to 'INSTALL.md')
| -rw-r--r-- | INSTALL.md | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/INSTALL.md b/INSTALL.md index 1934593148..a1ff91a98e 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -5,6 +5,7 @@ * [Prebuilt packages](#prebuilt-packages) * [Setting up Synapse](#setting-up-synapse) * [TLS certificates](#tls-certificates) + * [Email](#email) * [Registering a user](#registering-a-user) * [Setting up a TURN server](#setting-up-a-turn-server) * [URL previews](#url-previews) @@ -394,9 +395,22 @@ To configure Synapse to expose an HTTPS port, you will need to edit instance, if using certbot, use `fullchain.pem` as your certificate, not `cert.pem`). -For those of you upgrading your TLS certificate in readiness for Synapse 1.0, +For those of you upgrading your TLS certificate for Synapse 1.0 compliance, please take a look at [our guide](docs/MSC1711_certificates_FAQ.md#configuring-certificates-for-compatibility-with-synapse-100). +## Email + +It is desirable for Synapse to have the capability to send email. For example, +this is required to support the 'password reset' feature. + +To configure an SMTP server for Synapse, modify the configuration section +headed ``email``, and be sure to have at least the ``smtp_host``, ``smtp_port`` +and ``notif_from`` fields filled out. You may also need to set ``smtp_user``, +``smtp_pass``, and ``require_transport_security``. + +If Synapse is not configured with an SMTP server, password reset via email will + be disabled by default. + ## Registering a user You will need at least one user on your server in order to use a Matrix |