Skip to content
Snippets Groups Projects
Select Git revision
  • 1225-rebuild-account-registration-form
  • master default protected
  • stable/4.0
  • 928-add-frontend-for-free-busy-model
  • renovate/ipython-9.x
  • renovate/graphene-django-3.x
  • 1172-add-button-that-marks-all-notifications-as-read
  • tmp-ticdesk
  • 1181-rebuild-dashboard-using-vue-vuetify-and-new-structure
  • 1209-introduce-django-rest-framework-serializers
  • 1232-group-calendars
  • db-init
  • renovate/intlify-eslint-plugin-vue-i18n-4.x
  • renovate/eslint-plugin-vue-10.x
  • 1162-strange-behaviour-with-personal-events
  • check/update-pyproject-toml
  • check/update-builddeps-package-json
  • revert-7fe8b8b1
  • check/delete-eslint-rc-js
  • check/update-eslint-rc-js
  • 4.0.0 protected
  • 4.0.0.dev16 protected
  • 3.2.2 protected
  • 3.1.7 protected
  • 4.0.0.dev15 protected
  • 4.0.0.dev14 protected
  • 4.0.0.dev13 protected
  • 4.0.0.dev12 protected
  • 4.0.0.dev11 protected
  • 3.2.1 protected
  • 3.1.6 protected
  • 4.0.0.dev10 protected
  • 4.0.0.dev9 protected
  • 4.0.0.dev8 protected
  • 4.0.0.dev7 protected
  • 4.0.0.dev6 protected
  • 4.0.0.dev5 protected
  • 4.0.0.dev4 protected
  • 4.0.0.dev3 protected
  • 4.0.0.dev2 protected
40 results
Blame Permalink
22_registration.rst 2.97 KiB

Registration and user invitations

In addition to central management of user accounts, AlekSIS allows self-registration by users. Registration can be either fully open, or based on personal invitations.

In a system handling ciritcal data, access control should be as tight as possible. However, there are scenarios where central account creation is not feasible, e.g. for optional guardian accounts. In such a scenario, the invitation system allows for processes like handing out invitation codes as a letter or through e-mail campaigns.

Configuration

Registration

Registration can be enabled via the configuration interface in frontend.

In the Authentication tab, click the checkbox Enable signup to enable signup for everyone. A menu item will be added for public registration.

Warning

Do not enable this feature unless you intend to run a public AlekSIS instance.

Before enabling registration, you should consider restricting allowed usernames. By default, all ASCII characters are allowed in usernames. Often, it is advisable to not allow special characters. This often depends on the systems that will be linked to AlekSIS.

To restrict usernames to a certain format, a regular expression can be defined in the Regular expression for allowed usernames preference. For example, to restrict the username to lower case letters and numbers, and beginning with a number, the regex can be set to ``^[a-z][a-z0-9]+$`.

User invitations

In the same location as public registration, the invitation system can be enabled.

  • Authentication
    • 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.

A menu item will become available for users to enter their invitation code.

Usage

Invite by email or code

To invite a new user , visit the invitation page located at People → Invite person

Here you are able to invite the user by email address or generate an invitation code.

Invitations page

This mechanism allows for registration of entirely new persons that do not exist in the system, e.g. if perosnal details are not known in advance.

Invite existing person

To invite an existing person, open the person in AlekSIS and click Invite user.

The invitation will be sent to the person's email address, and can only be used by this person. Upon registration, the new account will automatically be linked to the existing person.

Invite existing person

Note

Before using this feature, make sure to read and understand :ref:`core-concept-person`.