diff options
| author | Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> | 2019-10-30 11:37:56 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-10-30 11:37:56 +0000 |
| commit | 7e179599848a1005f753a1ab58953107fc2540df (patch) | |
| tree | 0d69c7f875b9c51db7cbce7910ee16c95512c881 /INSTALL.md | |
| parent | Clarify environment variable usage when running in Docker (#6181) (diff) | |
| download | synapse-7e179599848a1005f753a1ab58953107fc2540df.tar.xz | |
Update email section of INSTALL.md about account_threepid_delegates (#6272)
Diffstat (limited to 'INSTALL.md')
| -rw-r--r-- | INSTALL.md | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/INSTALL.md b/INSTALL.md index 69e423923b..e7b429c05d 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -413,16 +413,18 @@ For a more detailed guide to configuring your server for federation, see ## Email -It is desirable for Synapse to have the capability to send email. For example, -this is required to support the 'password reset' feature. +It is desirable for Synapse to have the capability to send email. This allows +Synapse to send password reset emails, send verifications when an email address +is added to a user's account, and send email notifications to users when they +receive new messages. 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``. +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. +If email is not configured, password reset, registration and notifications via +email will be disabled. ## Registering a user |