Commit 7b4b37aa authored by Ilias Tsitsimpis's avatar Ilias Tsitsimpis Committed by Ilias Tsitsimpis

astakos: Document usage of '*_RECIPIENTS' settings

Document the usage of '*_RECIPIENTS' settings in Astakos to control the
lists were Astakos sends notifications. These lists used to be
preconfigured.
parent a8df9f4c
......@@ -8,6 +8,17 @@ repository and have aligned versions.
.. _Changelog-0.16:
v0.16rc3
========
Released:
Astakos
-------
* Explicitly specify the lists in which every notification will be sent.
v0.16rc2
========
......
......@@ -218,8 +218,8 @@ user in the following cases:
:ref:`authentication methods policies <auth_methods_policies>`).
If all of the above fail to trigger automatic activation, an email is sent to
the persons listed in ``HELPDESK``, ``MANAGERS`` and ``ADMINS`` settings,
notifing that there is a new user pending for moderation and that it's up to
the persons listed in ``ACCOUNT_NOTIFICATIONS_RECIPIENTS`` setting,
notifying that there is a new user pending for moderation and that it's up to
the administrator to decide if the user should be activated. The UI also shows
a corresponding 'pending moderation' message to the user. The administrator can
activate a user using the ``snf-manage user-modify`` command:
......@@ -234,7 +234,7 @@ activate a user using the ``snf-manage user-modify`` command:
Once the activation process finishes, a greeting message is sent to the user
email address and a notification for the activation to the persons listed in
``HELPDESK``, ``MANAGERS`` and ``ADMINS`` settings. Once activated the user is
``ACCOUNT_NOTIFICATIONS_RECIPIENTS`` setting. Once activated the user is
able to login and access the Synnefo services.
Additional authentication methods
......
......@@ -696,18 +696,19 @@ notify administrators with a notice that a new account has just been verified.
More specifically Astakos sends emails in the following cases
- An email containing a verification link after each signup process.
- An email to the people listed in ``ADMINS`` setting after each email
verification if ``ASTAKOS_MODERATION`` setting is ``True``. The email
notifies administrators that an additional action is required in order to
activate the user.
- A welcome email to the user email and an admin notification to ``ADMINS``
right after each account activation.
- Feedback messages submited from Astakos contact view and Astakos feedback
API endpoint are sent to contacts listed in ``HELPDESK`` setting.
- Project application request notifications to people included in ``HELPDESK``
and ``MANAGERS`` settings.
- An email to the people listed in ``ACCOUNT_NOTIFICATIONS_RECIPIENTS``
setting after each email verification if ``ASTAKOS_MODERATION`` setting is
``True``. The email notifies administrators that an additional action is
required in order to activate the user.
- A welcome email to the user email and a notification to
``ACCOUNT_NOTIFICATIONS_RECIPIENTS`` right after each account activation.
- Feedback messages submitted from Astakos contact view and Astakos feedback
API endpoint are sent to contacts listed in
``FEEDBACK_NOTIFICATIONS_RECIPIENTS`` setting.
- Project application request notifications to people included in
``PROJECT_NOTIFICATIONS_RECIPIENTS`` setting.
- Notifications after each project members action (join request, membership
accepted/declinde etc.) to project members or project owners.
accepted/declined etc.) to project members or project owners.
Astakos uses the Django internal email delivering mechanism to send email
notifications. A simple configuration, using an external smtp server to
......@@ -744,11 +745,13 @@ Refer to
`Django documentation <https://docs.djangoproject.com/en/1.4/topics/email/>`_
for additional information on available email settings.
As refered in the previous section, based on the operation that triggers
an email notification, the recipients list differs. Specifically, for
emails whose recipients include contacts from your service team
(administrators, managers, helpdesk etc) Synnefo provides the following
settings located in ``00-snf-common-admins.conf``:
As referred in the previous section, based on the operation that triggers an
email notification, the recipients list differs. For convenience (and backward
compatibility), Astakos defines three service teams (administrators, managers
and helpdesk) and send the above notifications to these teams in a
preconfigured way (ie. project notifications are sent to the members of
managers and helpdesk teams). These settings are located in
``00-snf-common-admins.conf``:
.. code-block:: python
......
......@@ -746,18 +746,19 @@ notify administrators with a notice that a new account has just been verified.
More specifically Astakos sends emails in the following cases
- An email containing a verification link after each signup process.
- An email to the people listed in ``ADMINS`` setting after each email
verification if ``ASTAKOS_MODERATION`` setting is ``True``. The email
notifies administrators that an additional action is required in order to
activate the user.
- A welcome email to the user email and an admin notification to ``ADMINS``
right after each account activation.
- Feedback messages submited from Astakos contact view and Astakos feedback
API endpoint are sent to contacts listed in ``HELPDESK`` setting.
- Project application request notifications to people included in ``HELPDESK``
and ``MANAGERS`` settings.
- An email to the people listed in ``ACCOUNT_NOTIFICATIONS_RECIPIENTS``
setting after each email verification if ``ASTAKOS_MODERATION`` setting is
``True``. The email notifies administrators that an additional action is
required in order to activate the user.
- A welcome email to the user email and a notification to
``ACCOUNT_NOTIFICATIONS_RECIPIENTS`` right after each account activation.
- Feedback messages submitted from Astakos contact view and Astakos feedback
API endpoint are sent to contacts listed in
``FEEDBACK_NOTIFICATIONS_RECIPIENTS`` setting.
- Project application request notifications to people included in
``PROJECT_NOTIFICATIONS_RECIPIENTS`` setting.
- Notifications after each project members action (join request, membership
accepted/declinde etc.) to project members or project owners.
accepted/declined etc.) to project members or project owners.
Astakos uses the Django internal email delivering mechanism to send email
notifications. A simple configuration, using an external smtp server to
......@@ -794,11 +795,13 @@ Refer to
`Django documentation <https://docs.djangoproject.com/en/1.4/topics/email/>`_
for additional information on available email settings.
As refered in the previous section, based on the operation that triggers
an email notification, the recipients list differs. Specifically, for
emails whose recipients include contacts from your service team
(administrators, managers, helpdesk etc) synnefo provides the following
settings located in ``00-snf-common-admins.conf``:
As referred in the previous section, based on the operation that triggers an
email notification, the recipients list differs. For convenience (and backward
compatibility), Astakos defines three service teams (administrators, managers
and helpdesk) and send the above notifications to these teams in a
preconfigured way (ie. project notifications are sent to the members of
managers and helpdesk teams). These settings are located in
``00-snf-common-admins.conf``:
.. code-block:: python
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment