forked from Github-Mirrors/canaille
104 lines
3.3 KiB
ReStructuredText
104 lines
3.3 KiB
ReStructuredText
|
Databases
|
||
|
|
#########
|
||
|
|
|
||
|
|
Canaille can read and save data in different databases.
|
||
|
|
This page presents the different database backends and their specificities:
|
||
|
|
|
||
|
|
.. contents::
|
||
|
|
:local:
|
||
|
|
|
||
|
|
Memory
|
||
|
|
======
|
||
|
|
|
||
|
|
Canaille comes with a lightweight inmemory backend by default.
|
||
|
|
It is used when no other backend has been configured, i.e. when the ``BACKENDS`` configuration parameter is unset or empty.
|
||
|
|
|
||
|
|
This backend is only for test purpose and should not be used in production environments.
|
||
|
|
|
||
|
|
SQL
|
||
|
|
===
|
||
|
|
|
||
|
|
Canaille can use any database supported by `SQLAlchemy <https://www.sqlalchemy.org/>`_, such as
|
||
|
|
sqlite, postgresql or mariadb.
|
||
|
|
|
||
|
|
It is used when the ``BACKENDS.SQL`` configuration parameter is defined. For instance::
|
||
|
|
|
||
|
|
[BACKENDS.SQL]
|
||
|
|
SQL_DATABASE_URI = "postgresql://user:password@localhost/database"
|
||
|
|
|
||
|
|
LDAP
|
||
|
|
====
|
||
|
|
|
||
|
|
Canaille can use OpenLDAP as its main database.
|
||
|
|
It is used when the ``BACKENDS.LDAP`` configuration parameter is defined. For instance::
|
||
|
|
|
||
|
|
[BACKENDS.LDAP]
|
||
|
|
URI = "ldap://ldap"
|
||
|
|
ROOT_DN = "dc=mydomain,dc=tld"
|
||
|
|
BIND_DN = "cn=admin,dc=mydomain,dc=tld"
|
||
|
|
BIND_PW = "very-secret-password"
|
||
|
|
|
||
|
|
USER_BASE = "ou=users,dc=mydomain,dc=tld"
|
||
|
|
USER_CLASS = "inetOrgPerson"
|
||
|
|
USER_FILTER = "(|(uid={{ login }})(mail={{ login }}))"
|
||
|
|
|
||
|
|
GROUP_BASE = "ou=groups,dc=mydomain,dc=tld"
|
||
|
|
|
||
|
|
.. note ::
|
||
|
|
Currently, only the ``inetOrgPerson`` and ``groupOfNames`` schemas have been tested.
|
||
|
|
If you want to use different schemas or LDAP servers, adaptations may be needed.
|
||
|
|
Patches are welcome.
|
||
|
|
|
||
|
|
OpenLDAP overlays integration
|
||
|
|
-----------------------------
|
||
|
|
|
||
|
|
Canaille can integrate with several OpenLDAP overlays:
|
||
|
|
|
||
|
|
memberof / refint
|
||
|
|
~~~~~~~~~~~~~~~~~
|
||
|
|
|
||
|
|
`memberof <https://www.openldap.org/doc/admin24/overlays.html#Reverse%20Group%20Membership%20Maintenance>`_
|
||
|
|
and `refint <https://www.openldap.org/doc/admin24/overlays.html#Referential Integrity>`_
|
||
|
|
overlays are needed for the Canaille group membership to work correctly.
|
||
|
|
|
||
|
|
Here is a configuration example compatible with canaille:
|
||
|
|
|
||
|
|
.. literalinclude :: ../demo/ldif/memberof-config.ldif
|
||
|
|
:language: ldif
|
||
|
|
:caption: memberof-config.ldif
|
||
|
|
|
||
|
|
.. literalinclude :: ../demo/ldif/refint-config.ldif
|
||
|
|
:language: ldif
|
||
|
|
:caption: refint-config.ldif
|
||
|
|
|
||
|
|
You can adapt and load those configuration files with:
|
||
|
|
|
||
|
|
.. code-block:: bash
|
||
|
|
|
||
|
|
# Adapt those commands according to your setup
|
||
|
|
sudo ldapadd -Q -H ldapi:/// -Y EXTERNAL -f memberof-config.ldif
|
||
|
|
sudo ldapadd -Q -H ldapi:/// -Y EXTERNAL -f refint-config.ldif
|
||
|
|
|
||
|
|
ppolicy
|
||
|
|
~~~~~~~
|
||
|
|
|
||
|
|
If the `ppolicy <https://www.ietf.org/archive/id/draft-behera-ldap-password-policy-11.html>`_ overlay is configured and the ``pwdEndTime`` attribute is available (since OpenLDAP 2.6), then account locking support will be enabled in canaille. To allow users to manage account expiration, they need to have a *write* permission on the ``lock_date`` attribute.
|
||
|
|
|
||
|
|
Here is a configuration example compatible with canaille:
|
||
|
|
|
||
|
|
.. literalinclude :: ../demo/ldif/ppolicy-config.ldif
|
||
|
|
:language: ldif
|
||
|
|
:caption: ppolicy-config.ldif
|
||
|
|
|
||
|
|
.. literalinclude :: ../demo/ldif/ppolicy.ldif
|
||
|
|
:language: ldif
|
||
|
|
:caption: ppolicy.ldif
|
||
|
|
|
||
|
|
You can adapt and load those configuration files with:
|
||
|
|
|
||
|
|
.. code-block:: bash
|
||
|
|
|
||
|
|
# Adapt those commands according to your setup
|
||
|
|
sudo ldapadd -Q -H ldapi:/// -Y EXTERNAL -f ppolicy-config.ldif
|
||
|
|
sudo ldapadd -Q -H ldapi:/// -Y EXTERNAL -f ppolicy.ldif
|