diff --git a/docs/admin/18_mail.rst b/docs/admin/18_mail.rst new file mode 100644 index 0000000000000000000000000000000000000000..60e02d1c72a62d9e90ce438a9595e1de54e5f08b --- /dev/null +++ b/docs/admin/18_mail.rst @@ -0,0 +1,36 @@ +Mail +==== + +AlekSIS needs to send mails e.g. for account confirmations, feedback or +error reports. + +Configure mailing +----------------- + +The mailserver can be configured via the configuration file + +.. code-block:: toml + + [mail.server] + host = "mail.example.com" + tls = False + ssl = True + port = 25 + user = "mailuser" + password = "password" + +Name and address for mails sent by AlekSIS can be configured in the +webinterface. To configure, visit `Admin → Configuration` and click on the +`Mail` tab. + +Configure mail recipients +------------------------- + +You can configure admin contacts in your configuration file, located at +``/etc/aleksis/``. + +.. code-blocK:: toml + + [contact] + admins = [["AlekSIS - Admins", "root@example.com"],["AlekSIS - Admins2", "root2@example.com"]] + from = 'aleksis@example.com' diff --git a/docs/admin/22_registration.rst b/docs/admin/22_registration.rst index c7ab3ed25e4db0b64af97efe5674c4061deb17aa..845fe06221696d155df7c537b9351355948838c7 100644 --- a/docs/admin/22_registration.rst +++ b/docs/admin/22_registration.rst @@ -1,6 +1,10 @@ Registration and user invitations ================================= +User invitations and registration can be used to allow e.g. guardians, that +don't have an account managed by the school, to use AlekSIS. + + Configuration ------------- @@ -22,11 +26,11 @@ User invitations User invitation can be enabled and configured via the configuration interface in frontend. -In the ``Authentication`` tab, click the checkbox ``Enable invitations``, to -enable invitations. +* Authentication -You can also configure the length of the invite code, defaults to ``3``, and -the size of packets, defaults to ``5``. + * Enable invitations: Click to enable invitations. + * Length of invite code: Length of invitation code packets, defaults to 5. + * Size of packets: Configure how many packets are generated, defaults to 3. By default, an invitation code looks like the following: ``abcde-abcde-abcde`` diff --git a/docs/user/01_registration.rst b/docs/user/01_registration.rst index 593012670726e723a36ceee74a809a7dfe6e6119..ba6d743bb5ccce05e6807995c8fd690961f9c4c0 100644 --- a/docs/user/01_registration.rst +++ b/docs/user/01_registration.rst @@ -1,5 +1,5 @@ Register a new account -==================== +====================== .. _core-user-registration: