Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add LDAP fields #179

Closed
wants to merge 1 commit into from
Closed

docs: Add LDAP fields #179

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions _guides/ldap.md
View file
Open in desktop
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`