Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Update email section of INSTALL.md about account_threepid_delegates (#…
Browse files Browse the repository at this point in the history
…6272)

* commit '7e1795998':
  • Loading branch information
anoadragon453 committed Mar 16, 2020
2 parents cb16924 + 7e17959 commit f836584
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
16 changes: 9 additions & 7 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions changelog.d/6272.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update `INSTALL.md` Email section to talk about `account_threepid_delegates`.

0 comments on commit f836584

Please sign in to comment.