From b8f0811332213b6b3ae856d9cd37a30b199a338d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcos=20Pe=C3=B1a?= Date: Fri, 8 Apr 2022 16:11:09 +0200 Subject: [PATCH] Fixes SMTP URI documentation --- api/config/settings/common.py | 6 +++--- changes/changelog.d/1749.bugfix | 1 + deploy/env.prod.sample | 6 +++--- 3 files changed, 7 insertions(+), 6 deletions(-) create mode 100644 changes/changelog.d/1749.bugfix diff --git a/api/config/settings/common.py b/api/config/settings/common.py index d9b2df10c..ee9c56f67 100644 --- a/api/config/settings/common.py +++ b/api/config/settings/common.py @@ -335,9 +335,9 @@ SMTP configuration for sending e-mails. Possible values: On a production instance, you'll usually want to use an external SMTP server: -- ``EMAIL_CONFIG=smtp://user@:password@youremail.host:25`` -- ``EMAIL_CONFIG=smtp+ssl://user@:password@youremail.host:465`` -- ``EMAIL_CONFIG=smtp+tls://user@:password@youremail.host:587`` +- ``EMAIL_CONFIG=smtp://user:password@youremail.host:25`` +- ``EMAIL_CONFIG=smtp+ssl://user:password@youremail.host:465`` +- ``EMAIL_CONFIG=smtp+tls://user:password@youremail.host:587`` .. note:: diff --git a/changes/changelog.d/1749.bugfix b/changes/changelog.d/1749.bugfix new file mode 100644 index 000000000..14c0f2dcb --- /dev/null +++ b/changes/changelog.d/1749.bugfix @@ -0,0 +1 @@ +Fixes docs' SMTP URI configuration (#1749) (1749) diff --git a/deploy/env.prod.sample b/deploy/env.prod.sample index 9c3f0d764..1e8a913a9 100644 --- a/deploy/env.prod.sample +++ b/deploy/env.prod.sample @@ -58,9 +58,9 @@ LOGLEVEL=error # `python3 -c 'import urllib.parse; print(urllib.parse.quote_plus # ("noreply@youremail.host"))'` # (returns `noreply%40youremail.host`) -# EMAIL_CONFIG=smtp://user@:password@youremail.host:25 -# EMAIL_CONFIG=smtp+ssl://user@:password@youremail.host:465 -# EMAIL_CONFIG=smtp+tls://user@:password@youremail.host:587 +# EMAIL_CONFIG=smtp://user:password@youremail.host:25 +# EMAIL_CONFIG=smtp+ssl://user:password@youremail.host:465 +# EMAIL_CONFIG=smtp+tls://user:password@youremail.host:587 # Make e-mail verification mandatory before using the service # Doesn't apply to admins.