From 5f7fa27a447fbbc978283009e1913aee0aab2cfc Mon Sep 17 00:00:00 2001 From: Sven Seeberg Date: Tue, 5 Sep 2023 19:18:53 +0200 Subject: [PATCH] Improve LDAP group config documentation, fixes #21159 (#21227) Improve the wording of the LDAP group attributes documentation and expand the examples. --- docs/content/usage/authentication.en-us.md | 9 +++++---- services/auth/source/ldap/README.md | 9 +++++---- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/content/usage/authentication.en-us.md b/docs/content/usage/authentication.en-us.md index 4ab5cad3e184..6e4ede0be6c8 100644 --- a/docs/content/usage/authentication.en-us.md +++ b/docs/content/usage/authentication.en-us.md @@ -157,12 +157,13 @@ Uses the following fields: - User Attribute in Group (optional) - - Which user LDAP attribute is listed in the group. - - Example: `uid` + - The user attribute that is used to reference a user in the group object. + - Example: `uid` if the group objects contains a `member: bender` and the user object contains a `uid: bender`. + - Example: `dn` if the group object contains a `member: uid=bender,ou=users,dc=planetexpress,dc=com`. - Group Attribute for User (optional) - - Which group LDAP attribute contains an array above user attribute names. - - Example: `memberUid` + - The attribute of the group object that lists/contains the group members. + - Example: `memberUid` or `member` ## PAM (Pluggable Authentication Module) diff --git a/services/auth/source/ldap/README.md b/services/auth/source/ldap/README.md index 568bc7827599..34c811703f65 100644 --- a/services/auth/source/ldap/README.md +++ b/services/auth/source/ldap/README.md @@ -114,12 +114,13 @@ share the following fields: * Example: (|(cn=gitea_users)(cn=admins)) * User Attribute in Group (optional) - * Which user LDAP attribute is listed in the group. - * Example: uid + * The user attribute that is used to reference a user in the group object. + * Example: uid if the group objects contains a member: bender and the user object contains a uid: bender. + * Example: dn if the group object contains a member: uid=bender,ou=users,dc=planetexpress,dc=com. * Group Attribute for User (optional) - * Which group LDAP attribute contains an array above user attribute names. - * Example: memberUid + * The attribute of the group object that lists/contains the group members. + * Example: memberUid or member * Team group map (optional) * Automatically add users to Organization teams, depending on LDAP group memberships.