paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-14 10:57:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Discuss outgoing email senders in email.md.

Browse Source 
Outgoing email documentation should mention that the SMTP server needs
to allow emails originating from ZULIP_ADMINISTRATOR as well as the
noreply email addresses; previously, one would typically find this out
using the test tool, which was not ideal.

Substantially tweaked by tabbott for organization and content.
This commit is contained in:
Tej Pochiraju
2019-07-16 09:39:34 +05:30
committed by Tim Abbott
parent 3ffc174dcb
commit cb10a3231c
1 changed files with 21 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/production/email.md
View File

@@ -9,12 +9,12 @@ email addresses and send notifications.
send mail. If you don't already have one you want to use, see send mail. If you don't already have one you want to use, see
[Email services](#email-services) below. [Email services](#email-services) below.
2. Fill out the section of `/etc/zulip/settings.py` headed "Outgoing 1. Fill out the section of `/etc/zulip/settings.py` headed "Outgoing
email (SMTP) settings". This includes the hostname and typically email (SMTP) settings". This includes the hostname and typically
the port to reach your SMTP provider, and the username to log into the port to reach your SMTP provider, and the username to log into
it as. it. You'll also want to fill out the noreply email section.
3. Put the password for the SMTP user account in 1. Put the password for the SMTP user account in
`/etc/zulip/zulip-secrets.conf` by setting `email_password`. For `/etc/zulip/zulip-secrets.conf` by setting `email_password`. For
example: `email_password = abcd1234`. example: `email_password = abcd1234`.
@@ -22,9 +22,24 @@ email addresses and send notifications.
[restart the server](settings.html) to make your changes take [restart the server](settings.html) to make your changes take
effect. effect.
4. Test that your configuration is working. See the test command in 1. Configure your SMTP server to allows your Zulip server to send
the [Troubleshooting](#troubleshooting) section below. If it's not emails originating from the email addresses listed in
working, see the suggestions in that section. `/etc/zulip/settings.py` as `ZULIP_ADMINISTRATOR`,
`NOREPLY_EMAIL_ADDRESS` and if `ADD_TOKENS_TO_NOREPLY_ADDRESS=True`
(the default), `TOKENIZED_NOREPLY_EMAIL_ADDRESS`.
If you don't know how to do this, we recommend using a [free
transactional email service](#free-outgoing-email-services); they
will guide you through everything you need to do, covering details
like configuring DKIM/SPF authentication so your Zulip emails won't
be spam filtered.
1. Use Zulip's email configuration test tool, documented in the
[Troubleshooting section](#troubleshooting), to verify that your
configuration is working.
1. Once your configuration is working, restart the Zulip server with
`/home/zulip/deployments/current/scripts/restart`.
## Email services ## Email services