From 55d6f809ba15af4abd8b736c7c65a9ea8190ee4e Mon Sep 17 00:00:00 2001 From: Jason Date: Sat, 16 Dec 2023 12:18:16 -0600 Subject: [PATCH] docs: Improve STARTTLS / SSL documentation for Django email settings. Django has some somewhat archaic variable names for configuring SMTP that are misleading for users not familiar with Django. Be more explicit about the correct configuration for both implicit and explicit TLS. Co-authored-by: Alex Vandiver --- docs/production/email.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/production/email.md b/docs/production/email.md index 79d19de717..70766a59f8 100644 --- a/docs/production/email.md +++ b/docs/production/email.md @@ -72,6 +72,11 @@ follows: providers - The password like `email_password = abcd1234` in `/etc/zulip/zulip-secrets.conf`. +If your SMTP provider uses implicit SSL/TLS on port 465 (and not `STARTTLS` on +port 587), you need to set `EMAIL_PORT = 465`, as well as replacing +[`EMAIL_USE_TLS = True`](https://docs.djangoproject.com/en/5.0/ref/settings/#std-setting-EMAIL_USE_TLS) +with [`EMAIL_USE_SSL = True`](https://docs.djangoproject.com/en/5.0/ref/settings/#std-setting-EMAIL_USE_SSL). + ### Using system email If you'd like to send outgoing email using the local operating @@ -201,11 +206,6 @@ aren't receiving emails from Zulip: should be in `/var/log/zulip/errors.log`, along with any other exceptions Zulip encounters. -- If your SMTP provider uses SSL on port 465 (and not TLS on port - 587), you need to set `EMAIL_PORT = 465` as well as replacing - `EMAIL_USE_TLS = True` with `EMAIL_USE_SSL = True`; otherwise, Zulip - will try to use the TLS protocol on port 465, which won't work. - - Zulip's email sending configuration is based on the standard Django [SMTP backend](https://docs.djangoproject.com/en/5.0/topics/email/#smtp-backend) configuration. So if you're having trouble getting your email