diff --git a/docs/_static/create_social_application.png b/docs/_static/create_social_application.png new file mode 100644 index 0000000000000000000000000000000000000000..c28c5c30a6d71f8aa0f1177b92048449c688d113 Binary files /dev/null and b/docs/_static/create_social_application.png differ diff --git a/docs/admin/03_socialaccounts.rst b/docs/admin/03_socialaccounts.rst new file mode 100644 index 0000000000000000000000000000000000000000..1f4148a8974d235eb8a15688cd4bd9328889e09d --- /dev/null +++ b/docs/admin/03_socialaccounts.rst @@ -0,0 +1,36 @@ +Social accounts +=============== + +AlekSIS can authenticate users against third party applications using OAuth2 +or OpenID + + +.. warning:: + Socialaccounts are NOT working with two factor authentication! If a user + authenticates with a social account, the two factor authentication is + ignored! Will be fixed in a future release. + +Configuring social account provider +----------------------------------- + +For available providers, see documentation of `django-allauth +<https://django-allauth.readthedocs.io/en/latest/providers.html>`_. + +A new social account provider can be configured in your configuration file +(located in ``/etc/aleksis/``). + +Configuration example:: + + [auth.providers.gitlab] + GITLAB_URL = "https://gitlab.exmaple.com" + +After configuring a new auth provider, you have to restart your AlekSIS +instance and configure client id and secret in the Backend Admin interface, +located at `https://aleksis.example.com/admin <https://aleksis.example.com/admin>`_. +Click "Social applications" and add a new application. Choose your +provider and enter client id and secret from your application and choose +your site: + +.. image:: ../_static/create_social_application.png + :width: 400 + :alt: Create social application