Revision 657f8ad7 docs/quick-install-admin-guide.rst
b/docs/quick-install-admin-guide.rst | ||
---|---|---|
560 | 560 |
|
561 | 561 |
.. code-block:: console |
562 | 562 |
|
563 |
ASTAKOS_DEFAULT_ADMIN_EMAIL = None |
|
564 |
|
|
565 | 563 |
ASTAKOS_COOKIE_DOMAIN = '.example.com' |
566 | 564 |
|
567 | 565 |
ASTAKOS_BASE_URL = 'https://node1.example.com/astakos' |
... | ... | |
571 | 569 |
extra path (``/astakos`` here) is recommended in order to distinguish |
572 | 570 |
components, if more than one are installed on the same machine. |
573 | 571 |
|
574 |
``ASTAKOS_DEFAULT_ADMIN_EMAIL`` refers to the administrator's email. |
|
575 |
Every time a new account is created a notification is sent to this email. |
|
576 |
For this we need access to a running mail server, so we have disabled |
|
577 |
it for now by setting its value to None. For more informations on this, |
|
578 |
read the relative :ref:`section <mail-server>`. |
|
579 |
|
|
580 | 572 |
.. note:: For the purpose of this guide, we don't enable recaptcha authentication. |
581 | 573 |
If you would like to enable it, you have to edit the following options: |
582 | 574 |
|
... | ... | |
607 | 599 |
If you are an advanced user and want to use the Shibboleth Authentication |
608 | 600 |
method, read the relative :ref:`section <shibboleth-auth>`. |
609 | 601 |
|
602 |
|
|
603 |
Email delivery configuration |
|
604 |
---------------------------- |
|
605 |
|
|
606 |
Many of the ``astakos`` operations require server to notify service users and |
|
607 |
administrators via email. e.g. right after the signup process the service sents |
|
608 |
an email to the registered email address containing an email verification url, |
|
609 |
after the user verifies the email address astakos once again needs to notify |
|
610 |
administrators with a notice that a new account has just been verified. |
|
611 |
|
|
612 |
More specifically astakos sends emails in the following cases |
|
613 |
|
|
614 |
- An email containing a verification link after each signup process. |
|
615 |
- An email to the people listed in ``ADMINS`` setting after each email |
|
616 |
verification if ``ASTAKOS_MODERATION`` setting is ``True``. The email |
|
617 |
notifies administrators that an additional action is required in order to |
|
618 |
activate the user. |
|
619 |
- A welcome email to the user email and an admin notification to ``ADMINS`` |
|
620 |
right after each account activation. |
|
621 |
- Feedback messages submited from astakos contact view and astakos feedback |
|
622 |
API endpoint are sent to contacts listed in ``HELPDESK`` setting. |
|
623 |
- Project application request notifications to people included in ``HELPDESK`` |
|
624 |
and ``MANAGERS`` settings. |
|
625 |
- Notifications after each project members action (join request, membership |
|
626 |
accepted/declinde etc.) to project members or project owners. |
|
627 |
|
|
628 |
Astakos uses the Django internal email delivering mechanism to send email |
|
629 |
notifications. A simple configuration, using an external smtp server to |
|
630 |
deliver messages, is shown below. |
|
631 |
|
|
632 |
.. code-block:: python |
|
633 |
|
|
634 |
# /etc/synnefo/10-snf-common-admins.conf |
|
635 |
EMAIL_HOST = "mysmtp.server.synnefo.org" |
|
636 |
EMAIL_HOST_USER = "<smtpuser>" |
|
637 |
EMAIL_HOST_PASSWORD = "<smtppassword>" |
|
638 |
|
|
639 |
# this gets appended in all email subjects |
|
640 |
EMAIL_SUBJECT_PREFIX = "[example.synnefo.org] " |
|
641 |
|
|
642 |
# Address to use for outgoing emails |
|
643 |
DEFAULT_FROM_EMAIL = "server@example.synnefo.org" |
|
644 |
|
|
645 |
# Email where users can contact for support. This is used in html/email |
|
646 |
# templates. |
|
647 |
CONTACT_EMAIL = "server@example.synnefo.org" |
|
648 |
|
|
649 |
# The email address that error messages come from |
|
650 |
SERVER_EMAIL = "server-errors@example.synnefo.org" |
|
651 |
|
|
652 |
Notice that since email settings might be required by applications other than |
|
653 |
astakos they are defined in a different configuration file than the one |
|
654 |
previously used to set astakos specific settings. |
|
655 |
|
|
656 |
Refer to |
|
657 |
`Django documentation <https://docs.djangoproject.com/en/1.2/topics/email/>`_ |
|
658 |
for additional information on available email settings. |
|
659 |
|
|
660 |
As refered in the previous section, based on the operation that triggers |
|
661 |
an email notification, the recipients list differs. Specifically for |
|
662 |
emails whose recipients include contacts from your service team |
|
663 |
(administrators, managers, helpdesk etc) synnefo provides the following |
|
664 |
settings located in ``10-snf-common-admins.conf``: |
|
665 |
|
|
666 |
.. code-block:: python |
|
667 |
|
|
668 |
ADMINS = (('Admin name', 'admin@example.synnefo.org'), |
|
669 |
('Admin2 name', 'admin2@example.synnefo.org)) |
|
670 |
MANAGERS = (('Manager name', 'manager@example.synnefo.org'),) |
|
671 |
HELPDESK = (('Helpdesk user name', 'helpdesk@example.synnefo.org'),) |
|
672 |
|
|
673 |
|
|
674 |
|
|
610 | 675 |
Enable Pooling |
611 | 676 |
-------------- |
612 | 677 |
|
Also available in: Unified diff