diff --git a/modules/blocks/lldap/docs/default.md b/modules/blocks/lldap/docs/default.md index 3eb5ab6..da7ef3c 100644 --- a/modules/blocks/lldap/docs/default.md +++ b/modules/blocks/lldap/docs/default.md @@ -60,6 +60,9 @@ Also, all other groups will be deleted and only the "family" group will remain. Note that the `lldap_admin`, `lldap_password_manager` and `lldap_strict_readonly` groups, which are internal to LLDAP, will always exist. +If you want existing groups not declared in the `shb.lldap.ensureGroups` to be deleted, +set [`shb.lldap.enforceGroups`](#blocks-lldap-options-shb.lldap.enforceGroups) to `false`. + ```nix { shb.lldap.ensureGroups = { @@ -111,6 +114,20 @@ shb.lldap = { The following snippet creates a user and makes it a member of the "family" group. +Note the following behavior: + +- New users will be created following the `shb.lldap.ensureUsers` option. +- Existing users will be updated, their password included, if they are mentioned in the `shb.lldap.ensureUsers` option. +- Existing users not declared in the `shb.lldap.ensureUsers` will be left as-is. +- User memberships to groups not declared in their respective `shb.lldap.ensureUsers..groups`. + +If you want existing users not declared in the `shb.lldap.ensureUsers` to be deleted, +set [`shb.lldap.enforceUsers`](#blocks-lldap-options-shb.lldap.enforceUsers) to `true`. + +If you want memberships to groups not declared in the respective +`shb.lldap.ensureUsers..groups` option to be deleted, +set [`shb.lldap.enforceUserMemberships`](#blocks-lldap-options-shb.lldap.enforceUserMemberships) `true`. + ```nix { shb.lldap.ensureUsers = {