Added Email configuration to documentation

This commit is contained in:
jovuit 2021-05-23 17:51:30 +02:00
parent 8202c1879b
commit aefaa63967
3 changed files with 12 additions and 2 deletions

View File

@ -3298,12 +3298,12 @@ Email sending is disabled by default, as it requires additional configuration.
In this mode, emails are simply outputed on stdout.
If you want to actually send those emails to your users, you should edit your
.env file and tweak the EMAIL_CONFIG variable. See :ref:`setting-EMAIL_CONFIG`
.env file and tweak the ``EMAIL_CONFIG`` variable. See :data:`EMAIL_CONFIG <config.settings.common.EMAIL_CONFIG>`
for more details.
.. note::
As a result of these changes, the DJANGO_EMAIL_BACKEND variable,
As a result of these changes, the ``DJANGO_EMAIL_BACKEND`` variable,
which was not documented, has no effect anymore. You can safely remove it from
your .env file if it is set.

View File

@ -0,0 +1 @@
Added email configuration to the documentation (#1481)

View File

@ -163,6 +163,15 @@ Subsonic
.. autodata:: config.settings.common.SUBSONIC_DEFAULT_TRANSCODING_FORMAT
Email configuration
^^^^^^^^^^^^^^^^^^^
.. autodata:: config.settings.common.EMAIL_CONFIG
:annotation: = consolemail://
.. autodata:: config.settings.common.DEFAULT_FROM_EMAIL
:annotation: = Funkwhale <noreply@yourdomain>
.. autodata:: config.settings.common.EMAIL_SUBJECT_PREFIX
Other settings
^^^^^^^^^^^^^^