diff --git a/packages/xo-server-auth-ldap/README.md b/packages/xo-server-auth-ldap/README.md index a6b825be9..b88e20f2d 100644 --- a/packages/xo-server-auth-ldap/README.md +++ b/packages/xo-server-auth-ldap/README.md @@ -2,6 +2,11 @@ > LDAP authentication plugin for XO-Server +This plugin allows LDAP users to authenticate to Xen-Orchestra. + +The first time a user signs in, XO will create a new XO user with the +same identifier. + ## Install Installation of the [npm package](https://npmjs.org/package/xo-server-auth-ldap): @@ -28,6 +33,9 @@ plugins: # Distinguished name of the user permitted to search the LDAP # directory for the user to authenticate. + # + # For Microsoft Active Directory, it can also be + # `'@'` dn: 'cn=admin,ou=people,dc=example,dc=org' # Password of the user permitted to search the LDAP directory. @@ -39,6 +47,9 @@ plugins: # Filter used to find the user. # + # For Microsoft Active Directory, the filter should be + # `'(cn={{name}})'` or `'(sAMAccountName={{name}}@)'`. + # # Default is `'(uid={{name}})'`. #filter: '(uid={{name}})' ```