From 68fd40a604c3ca9ed83d07c42681f5f21479324e Mon Sep 17 00:00:00 2001 From: David Christofas Date: Thu, 1 Dec 2022 11:21:18 +0100 Subject: [PATCH] add a README to the idm package --- services/idm/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 services/idm/README.md diff --git a/services/idm/README.md b/services/idm/README.md new file mode 100644 index 0000000000..20e3797e66 --- /dev/null +++ b/services/idm/README.md @@ -0,0 +1,9 @@ +# Idm + +The IDM service provides a minimal LDAP Service, based on [Libregraph idm](https://github.com/libregraph/idm), for oCIS. It is started as part of the default configuration and serves as a central place for storing user and group information. + +It is mainly targeted at small oCIS installations. For larger setups it is recommended to replace IDM with a “real” LDAP server or to switch to an external Identity Management Solution. + +IDM listens on port 9325 by default. In the default configuration it only accepts TLS protected connections (LDAPS). The BaseDN of the LDAP tree is o=libregraph-idm. IDM gives LDAP write permissions to a single user (DN: uid=libregraph,ou=sysusers,o=libregraph-idm). Any other authenticated user has read-only access. IDM stores its data in a boltdb file idm/ocis.boltdb inside the oCIS base data directory. + +Note: IDM is limited in its functionality. It only supports a subset of the LDAP operations (namely BIND, SEARCH, ADD, MODIFY, DELETE). Also IDM currently does not do any schema verification (e.g. structural vs. auxiliary object classes, require and option attributes, syntax checks, …). So it’s not meant as a general purpose LDAP server.