Improve LDAP group config documentation (#21227) (#26921)

backport #21227

author @svenseeberg

Co-authored-by: Sven Seeberg <mail@sven-seeberg.de>
Co-authored-by: Giteabot <teabot@gitea.io>

diff --git a/docs/content/usage/authentication.en-us.md b/docs/content/usage/authentication.en-us.md
index 4ab5cad3e184fedd3ed49bc12e64f9dfd40679f7..6e4ede0be6c89729d327fdd441fc25b404862efb 100644 (file)
--- 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 568bc78275993afc5d0ed3ce042b5cfbc5175fe0..34c811703f6504cbad11a3536276730d868ac980 100644 (file)
--- 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.