From aefaa63967c22e45233d84aaa1cb0633e5093806 Mon Sep 17 00:00:00 2001 From: jovuit Date: Sun, 23 May 2021 17:51:30 +0200 Subject: [PATCH] Added Email configuration to documentation --- CHANGELOG | 4 ++-- changes/changelog.d/1481.doc | 1 + docs/admin/configuration.rst | 9 +++++++++ 3 files changed, 12 insertions(+), 2 deletions(-) create mode 100644 changes/changelog.d/1481.doc diff --git a/CHANGELOG b/CHANGELOG index f1a7c0283..0a96c4957 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -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 ` 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. diff --git a/changes/changelog.d/1481.doc b/changes/changelog.d/1481.doc new file mode 100644 index 000000000..a1107b41e --- /dev/null +++ b/changes/changelog.d/1481.doc @@ -0,0 +1 @@ +Added email configuration to the documentation (#1481) diff --git a/docs/admin/configuration.rst b/docs/admin/configuration.rst index c2bbd5f9f..e68215e26 100644 --- a/docs/admin/configuration.rst +++ b/docs/admin/configuration.rst @@ -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 +.. autodata:: config.settings.common.EMAIL_SUBJECT_PREFIX + Other settings ^^^^^^^^^^^^^^