Skip to content

Commit 2d7e9cf

Browse files
committed
Add the documentation for the Email Notification plugin
We have added documentation for the Email notification plugin to the Configuring Notification Plugins section. Previously, the related information could be found in the Configuring an SMTP Server section within Configuring Django. We have moved the Promgen-related configuration to the newly created section and retained only the Django-related configuration in the Configuring Django section.
1 parent 7ff006d commit 2d7e9cf

2 files changed

Lines changed: 16 additions & 3 deletions

File tree

docs/conf/django.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,16 @@ All available django settings (not every setting may apply to promgen)
99
are listed in the `django
1010
reference <https://docs.djangoproject.com/en/1.11/ref/settings/>`__.
1111

12+
.. _smtp_config:
1213
Configuring an SMTP Server
1314
--------------------------
1415

1516
An SMTP server for sending outgoing mail can be configured this way:
1617

1718
.. code-block:: yaml
1819
19-
promgen.notification.email:
20-
sender: promgen@example.com
21-
2220
django:
21+
DEFAULT_FROM_EMAIL: promgen@example.com
2322
EMAIL_HOST: mail.example.com
2423
EMAIL_PORT: 587
2524
EMAIL_HOST_USER: user@example.com

docs/conf/notification.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,20 @@ Configuring Notification Plugins
33

44
Different settings for the Notification Plugins can be defined in the ``promgen.yml`` file.
55

6+
Email
7+
---------------------
8+
9+
An SMTP server for sending outgoing mail can be configured by adding Django email settings
10+
(see :ref:`smtp_config`).
11+
The **email's sender address** either can be set using the ``DEFAULT_FROM_EMAIL`` Django setting
12+
or by setting the ``sender`` configuration as shown below. If both are set, the ``sender``
13+
configuration will take precedence.
14+
15+
.. code-block:: yaml
16+
17+
promgen.notification.email:
18+
sender: promgen@example.com
19+
620
PagerDuty
721
---------------------
822

0 commit comments

Comments
 (0)