From 21f75372a3dec490f7e38be0bed2e6a55aeaa852 Mon Sep 17 00:00:00 2001
From: Georg Abenthung <georg@abenthung.name>
Date: Thu, 22 Jul 2021 07:37:13 +0000
Subject: [PATCH] Add hint how to urlencode special characters in EMAIL_CONFIG
variable of .env file
---
deploy/env.prod.sample | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/deploy/env.prod.sample b/deploy/env.prod.sample
index 69b3e466e2..4b6b0f86ed 100644
--- a/deploy/env.prod.sample
+++ b/deploy/env.prod.sample
@@ -49,6 +49,13 @@ FUNKWHALE_PROTOCOL=https
# 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