diff --git a/docs/admin/00_index.rst b/docs/admin/00_index.rst new file mode 100644 index 0000000000000000000000000000000000000000..8d3c47f21663d83e4ce90925c00c88b6186a7d45 --- /dev/null +++ b/docs/admin/00_index.rst @@ -0,0 +1,7 @@ +Configuration and andministration +================================= + +.. toctree:: + :glob: + + * diff --git a/docs/admin/01_ldap.rst b/docs/admin/01_ldap.rst new file mode 100644 index 0000000000000000000000000000000000000000..a5b54779f1cf53fd338178bdfc5f4dee3d1cd198 --- /dev/null +++ b/docs/admin/01_ldap.rst @@ -0,0 +1,32 @@ +Authenticating against LDAP +=========================== + +BiscuIT can authenticate users against an LDAP directory (like OpenLDAP or +Active Directory). The BiscuIT core can only authenticate and synchronise +authenticated users to BiscuIT's database. There are apps that help with +tasks like mass-importing accounts and linking accounts to persons in +the BiscuIY system (see below). + + +Installing packages for LDAP support +------------------------------------ + +Installing the necessary librairies for LDAP support unfortunately is not +very straightforward under all circumstances. + +TBA. + + +Configuration of LDAP support +----------------------------- + +Configuration is done under the `default.ldap` section in BiscuIT's +configuration file. For example, add something like the following to your +configuration (normally in `/etc/biscuit`; 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" } + users = { base = "ou=people,dc=myschool,dc=edu", filter = "(uid=%(user)s)" } + map = { first_name = "givenName", last_name = "sn", email = "mail" } diff --git a/docs/index.rst b/docs/index.rst index c21b7403108ebca2deaad8d51b37cbb4f33037b5..1cb4bca97a4eefddd59278ec377704f425579e0b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,6 +10,7 @@ Welcome to BiscuIT's documentation! :maxdepth: 2 :caption: Contents: + admin/00_index dev/00_index ref/00_index