Merge branch 'patch-1' into 'develop'
Update configuration.rst for unsafe characters in URLs Closes #1049 See merge request funkwhale/funkwhale!1061
This commit is contained in:
commit
48681c39db
|
@ -18,6 +18,16 @@ and technical aspects of your instance, such as database credentials.
|
||||||
on environment variables.
|
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:
|
.. _instance-settings:
|
||||||
|
|
||||||
Instance settings
|
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+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"
|
- ``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:
|
.. _setting-DEFAULT_FROM_EMAIL:
|
||||||
|
|
||||||
``DEFAULT_FROM_EMAIL``
|
``DEFAULT_FROM_EMAIL``
|
||||||
|
|
Loading…
Reference in New Issue