Skip to content
Snippets Groups Projects
Commit 06fd06cf authored by Tom Teichler's avatar Tom Teichler :beers:
Browse files

Update docs for LDAP and celery

parent b814e632
No related branches found
No related tags found
1 merge request!333Documentation for beta release (Documentation for first release part 1)
......@@ -5,30 +5,37 @@ AlekSIS can authenticate users against an LDAP directory (like OpenLDAP or
Active Directory). The AlekSIS core can only authenticate and synchronise
authenticated users to AlekSIS’ database. There are apps that help with
tasks like mass-importing accounts and linking accounts to persons in
the BiscuIY system (see below).
the AlekSIS system (see below).
Installing packages for LDAP support
------------------------------------
Installing the necessary librairies for LDAP support unfortunately is not
very straightforward under all circumstances.
very straightforward under all circumstances. On Debian, install these packages::
TBA.
sudo apt install python3-ldap libldap2-dev libssl-dev libsasl2-dev python3-dev
Configuration of LDAP support
-----------------------------
Configuration is done under the `default.ldap` section in AlekSIS’
Configuration is done under the ``default.ldap`` section in AlekSIS’
configuration file. For example, add something like the following to your
configuration (normally in `/etc/aleksis`; you can either append to an
configuration (normally in ``/etc/aleksis``; you can either append to an
existing file or add a new one)::
[default.ldap]
uri = "ldaps://ldap.myschool.edu"
bind = { dn = "cn=reader,dc=myschool,dc=edu", password = "secret" }
# Authentication via LDAP, optional
[default.ldap]
uri = "ldaps://ldap.myschool.edu"
bind = { dn = "cn=reader,dc=myschool,dc=edu", password = "secret" }
map = { first_name = "givenName", last_name = "sn", email = "mail" }
[default.ldap.users]
search = { base = "ou=people,dc=myschool,dc=edu", filter = "(uid=%(user)s)" }
map = { first_name = "givenName", last_name = "sn", email = "mail" }
[default.ldap.users]
search = { base = "ou=people,dc=myschool,dc=edu", filter = "(uid=%(user)s)" }
[default.ldap.groups]
search = { base = "ou=groups,dc=myschool,dc=edu" }
type = "groupOfNames"
# Users in group "admins" are superusers
flags = { is_superuser = "cn=admins,ou=groups,dc=myschool,dc=edu" }
......@@ -8,7 +8,7 @@ Celery and Celery beat worker
To run asyncronous Celery tasks, you will need a running Celery and Celery beat worker on your system. You can find instructions to run them via systemd in the `Celery docs`_
Enable celery in AlekSIS Configuration
Enable celery in AlekSIS configuration
--------------------------------------
To enable Celery in your AlekSIS instance, add the following to your ``/etc/aleksis/aleksis.toml``::
......@@ -34,7 +34,7 @@ After you've installed the redis server, you should start it. If you're using sy
For other operating systems please look into their package index.
Enable redis in AlekSIS Configuration
Enable redis in AlekSIS configuration
-------------------------------------
To enable the Celery broker in your AlekSIS instance, add the following to your ``/etc/aleksis/aleksis.toml``::
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment