From a4aaecef39677790b6813aba7e36e1ad7fc0055d Mon Sep 17 00:00:00 2001
From: Georg Abenthung <georg@abenthung.name>
Date: Wed, 4 Aug 2021 12:52:35 +0000
Subject: [PATCH] Add hint how to urlencode special characters in EMAIL_CONFIG
variable of .env file
---
deploy/env.prod.sample | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/deploy/env.prod.sample b/deploy/env.prod.sample
index 73ba778fff..3220170978 100644
--- a/deploy/env.prod.sample
+++ b/deploy/env.prod.sample
@@ -52,6 +52,12 @@ LOGLEVEL=error
# EMAIL_CONFIG=consolemail:// # output e-mails to console (the default)
# EMAIL_CONFIG=dummymail:// # disable e-mail sending completely
# On a production instance, you'll usually want to use an external SMTP server:
+# If `user` or `password` contain special characters (eg.
+# `noreply@youremail.host` as `user`), be sure to urlencode them, using
+# for example the command:
+# `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
--
GitLab