Skip to content

Commit

Permalink
docs: Add LDAP fields
Browse files Browse the repository at this point in the history
  • Loading branch information
gramakri committed Nov 14, 2018
1 parent 5c869bf commit 4a1d0ed
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions _guides/ldap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
layout: documentation
title: Set up LDAP authentication for The Lounge
---

Open your configuration file, located at `${THELOUNGE_HOME}/config.js` and look for the `ldap` key,
and set the following values:

* `enable` - Set to true to enable LDAP
* `url` - A url of the form `ldaps://<ldapserver>:<ldapport>`. For plain connections, use the `ldap` scheme
* `baseDN` - LDAP base DN. When unset, the LDAP auth logic with use `searchDN` instead to locate users (see below).
For example, set it to `"ou=accounts,dc=example,dc=com"`.
* `primaryKey` - LDAP primary key. It is set to `"uid"` by default
* `searchDN` - This method is used for searching and identifying a user DN before authenticating a user.
This field is only used when `baseDN` is unset. This object with the following fields:
* `rootDN` - The bind DN to be used for searching
* `rootPassword` - The bind password to be used for searching
* `base` - The base DN to search for users
* `filter` - The filter to be used for searching. For example, `(objectclass=user)`
* `scope` - The scope of the search. For example, `sub`

0 comments on commit 4a1d0ed

Please sign in to comment.