summaryrefslogtreecommitdiffstats
path: root/modules/auth
diff options
context:
space:
mode:
authorSergio Benitez <sbenitez@mit.edu>2015-09-05 15:26:31 -0700
committerSergio Benitez <sbenitez@mit.edu>2015-09-05 15:26:31 -0700
commit079a2d68db5c843ef2dbba65aeca46d5887d6b02 (patch)
tree85bcee7b3df2029bce860454bc640b457280a1e2 /modules/auth
parent0f07a5cb84e9a24df3d5cf1fcfeb58bac301d646 (diff)
downloadgitea-079a2d68db5c843ef2dbba65aeca46d5887d6b02.tar.gz
gitea-079a2d68db5c843ef2dbba65aeca46d5887d6b02.zip
Minor fixes to the LDAP module readme
Diffstat (limited to 'modules/auth')
-rw-r--r--modules/auth/ldap/README.md15
1 files changed, 8 insertions, 7 deletions
diff --git a/modules/auth/ldap/README.md b/modules/auth/ldap/README.md
index 8a03384fbf..3a3e020436 100644
--- a/modules/auth/ldap/README.md
+++ b/modules/auth/ldap/README.md
@@ -4,15 +4,15 @@ Gogs LDAP Authentication Module
## About
This authentication module attempts to authorize and authenticate a user
-against an LDAP server. It provides two methods of authenitcation: LDAP via
+against an LDAP server. It provides two methods of authentication: LDAP via
BindDN, and LDAP simple authentication.
-LDAP via BindDN functions like most LDAP authentication systems.
-First, it queries the LDAP server using a Bind DN and
-searches for the user that is attempting to sign in. If the user is found, the
-module attempts to bind to the server using the user's supplied credentials. If
-this succeeds, the user has been authenticated, and his account information is
-retrieved and passed to the Gogs login infrastructure.
+LDAP via BindDN functions like most LDAP authentication systems. First, it
+queries the LDAP server using a Bind DN and searches for the user that is
+attempting to sign in. If the user is found, the module attempts to bind to the
+server using the user's supplied credentials. If this succeeds, the user has
+been authenticated, and his account information is retrieved and passed to the
+Gogs login infrastructure.
LDAP simple authentication does not utilize a Bind DN. Instead, it binds
directly with the LDAP server using the user's supplied credentials. If the bind
@@ -97,4 +97,5 @@ share the following fields:
* User Filter **(required)**
* An LDAP filter declaring when a user should be allowed to log in. The `%s`
matching parameter will be substituted with the user's username.
+ * Example: (&(objectClass=posixAccount)(cn=%s))
* Example: (&(objectClass=posixAccount)(uid=%s))