NuKVM/xen-orchestra
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README updates.

Browse Source
This commit is contained in:
Julien Fontanet 2015-12-30 19:12:24 +01:00
parent 2193c26acb
commit 5515f90147
1 changed files with 18 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
packages/xo-server-auth-ldap/README.md
View File

@ -17,58 +17,26 @@ Installation of the [npm package](https://npmjs.org/package/xo-server-auth-ldap)
## Usage ## Usage
To enable this plugin you have to add it into the configuration file Like all other xo-server plugins, it can be configured directly via
of XO-Server: the web iterface, see [the plugin documentation](https://xen-orchestra.com/docs/plugins.html).
```yaml If you have issues, you can use the provided CLI to gather more
plugins: information:
auth-ldap: ```
uri: "ldap://ldap.example.org" > xo-server-auth-ldap
? uri ldap://ldap.company.net
# Path to CA certificates to use when connecting to SSL-secured ? fill optional certificateAuthorities? No
# LDAP servers. ? fill optional checkCertificate? No
# ? fill optional bind? No
# If not specified, it will use a default set of well-known CAs. ? base ou=people,dc=company,dc=net
#certificateAuthorities: ? fill optional filter? No
# - /path/to/ca_cert.pem configuration saved in ./ldap.cache.conf
# - /path/to/another/ca_cert.pem ? Username john.smith
? Password *****
# Check the validity of the server's certificate. Useful when searching for entries...
# connecting to servers that use a self-signed certificate. 0 entries found
# could not authenticate john.smith
# Default to true
#checkCertificate: true
# Credentials to use before looking for the user record.
#
# Default to anonymous.
bind:
# Distinguished name of the user permitted to search the LDAP
# directory for the user to authenticate.
#
# For Microsoft Active Directory, it can also be
# '<user>@<domain>'
dn: 'cn=admin,ou=people,dc=example,dc=org'
# Password of the user permitted to search the LDAP directory.
password: 'secret'
# The base is the part of the directory tree where the users are
# looked for.
base: 'ou=people,dc=example,dc=org'
# Filter used to find the user.
#
# For Microsoft Active Directory, you can try one of the following
# filters:
#
# - '(cn={{name}})'
# - '(sAMAccountName={{name}})'
# - '(sAMAccountName={{name}}@<domain>)'
# - '(userPrincipalName={{name}})'
#filter: '(uid={{name}})'
``` ```
## Algorithm ## Algorithm