diff options
| author | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2019-11-05 17:08:07 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-11-05 17:08:07 +0000 |
| commit | 55a7da247a912ca2a4d539a63200fca0d6541f46 (patch) | |
| tree | c0445991317e3dc26def157bfeb70d76d1b830c5 /INSTALL.md | |
| parent | Apply suggestions from code review (diff) | |
| parent | Improve documentation for EventContext fields (#6319) (diff) | |
| download | synapse-55a7da247a912ca2a4d539a63200fca0d6541f46.tar.xz | |
Merge branch 'develop' into rav/url_preview_limit_title
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 |