summary refs log tree commit diff
path: root/INSTALL.md
diff options
context:
space:
mode:
authorRichard van der Hoff <richard@matrix.org>2019-10-31 11:17:05 +0000
committerRichard van der Hoff <richard@matrix.org>2019-10-31 11:17:05 +0000
commiteb9a0d9e48cb28987dd795293803217427721b8c (patch)
tree9124a2575bb845eabea6056fc0ad7b651f996cc1 /INSTALL.md
parentRemove usage of deprecated logger.warn method from codebase (#6271) (diff)
parentUpdate email section of INSTALL.md about account_threepid_delegates (#6272) (diff)
downloadsynapse-eb9a0d9e48cb28987dd795293803217427721b8c.tar.xz
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md16
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