aboutsummaryrefslogtreecommitdiff
path: root/pkg/auth/ldap/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'pkg/auth/ldap/README.md')
-rw-r--r--pkg/auth/ldap/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/pkg/auth/ldap/README.md b/pkg/auth/ldap/README.md
index 3a3e0204..b8c95b3b 100644
--- a/pkg/auth/ldap/README.md
+++ b/pkg/auth/ldap/README.md
@@ -99,3 +99,21 @@ share the following fields:
matching parameter will be substituted with the user's username.
* Example: (&(objectClass=posixAccount)(cn=%s))
* Example: (&(objectClass=posixAccount)(uid=%s))
+
+**Verify group membership in LDAP** uses the following fields:
+
+* Group Search Base (optional)
+ * The LDAP DN used for groups.
+ * Example: ou=group,dc=mydomain,dc=com
+
+* Group Name Filter (optional)
+ * An LDAP filter declaring how to find valid groups in the above DN.
+ * Example: (|(cn=gogs_users)(cn=admins))
+
+* User Attribute in Group (optional)
+ * Which user LDAP attribute is listed in the group.
+ * Example: uid
+
+* Group Attribute for User (optional)
+ * Which group LDAP attribute contains an array above user attribute names.
+ * Example: memberUid