Merge branch 'patch-1' into 'develop'

Update configuration.rst for unsafe characters in URLs

Closes #1049

See merge request funkwhale/funkwhale!1061
environments/review-front-list-6rg6z1/deployments/4496
Eliot Berriot 2020-03-23 11:38:58 +01:00
commit 48681c39db
1 zmienionych plików z 19 dodań i 0 usunięć

Wyświetl plik

@ -16,7 +16,17 @@ and technical aspects of your instance, such as database credentials.
You should restart all Funkwhale processes when you change the values
on environment variables.
.. note::
Some characters are unsafe to use in configuration variables that are URLs,
such as the user and password in the database and SMTP sections.
If those variables contain such characters, they must be urlencoded, for
instance using the following command:
``python3 -c 'import urllib.parse; print(urllib.parse.quote_plus("p@ssword"))``
cf. https://github.com/joke2k/django-environ#using-unsafe-characters-in-urls
.. _instance-settings:
@ -65,6 +75,15 @@ Possible values:
- ``smtp+ssl://user:password@youremail.host:465``: Send emails via SMTP via youremail.host on port 465, using SSL encryption, authenticating as user "user" with password "password"
- ``smtp+tls://user:password@youremail.host:587``: Send emails via SMTP via youremail.host on port 587, using TLS encryption, authenticating as user "user" with password "password"
.. note::
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``)
.. _setting-DEFAULT_FROM_EMAIL:
``DEFAULT_FROM_EMAIL``