diff options
author | Tilman Vatteroth | 2021-01-04 13:07:44 +0100 |
---|---|---|
committer | Tilman Vatteroth | 2021-01-05 13:15:32 +0100 |
commit | eaeb88401d07687eb3db8c273f7a4c0ed31ec153 (patch) | |
tree | c05c4f17da9ce1cd0aa603febc6a14b2410e6a5e /docs/guides/auth/ldap-ad.md | |
parent | d52d1d255a876fcf937c9df3717f6df9b745ad22 (diff) |
Move docs into subdirectory to make mkdocs work in a subdirectory
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
Diffstat (limited to 'docs/guides/auth/ldap-ad.md')
-rw-r--r-- | docs/guides/auth/ldap-ad.md | 38 |
1 files changed, 0 insertions, 38 deletions
diff --git a/docs/guides/auth/ldap-ad.md b/docs/guides/auth/ldap-ad.md deleted file mode 100644 index b7d0284e..00000000 --- a/docs/guides/auth/ldap-ad.md +++ /dev/null @@ -1,38 +0,0 @@ -# AD LDAP auth - -To setup your HedgeDoc instance with Active Directory you need the following configs: - -```env -CMD_LDAP_URL=ldap://internal.example.com -CMD_LDAP_BINDDN=cn=binduser,cn=Users,dc=internal,dc=example,dc=com -CMD_LDAP_BINDCREDENTIALS=<super secret password> -CMD_LDAP_SEARCHBASE=dc=internal,dc=example,dc=com -CMD_LDAP_SEARCHFILTER=(&(objectcategory=person)(objectclass=user)(|(sAMAccountName={{username}})(mail={{username}}))) -CMD_LDAP_USERIDFIELD=sAMAccountName -CMD_LDAP_PROVIDERNAME=Example Inc AD -``` - -`CMD_LDAP_BINDDN` is either the `distinguishedName` or the `userPrincipalName`. *This can cause "username/password is invalid" when either this value or the password from `CMD_LDAP_BINDCREDENTIALS` are incorrect.* - -`CMD_LDAP_SEARCHFILTER` matches on all users and uses either the email address or the `sAMAccountName` (usually the login name you also use to login to Windows). - -*Only using `sAMAccountName` looks like this:* `(&(objectcategory=person)(objectclass=user)(sAMAccountName={{username}}))` - -`CMD_LDAP_USERIDFIELD` says we want to use `sAMAccountName` as unique identifier for the account itself. - -`CMD_LDAP_PROVIDERNAME` just the name written above the username and password field on the login page. - -Same in json: - -```json -"ldap": { - "url": "ldap://internal.example.com", - "bindDn": "cn=binduser,cn=Users,dc=internal,dc=example,dc=com", - "bindCredentials": "<super secret password>", - "searchBase": "dc=internal,dc=example,dc=com", - "searchFilter": "(&(objectcategory=person)(objectclass=user)(|(sAMAccountName={{username}})(mail={{username}})))", - "useridField": "sAMAccountName", -}, -``` - -More details and example: <https://www.npmjs.com/package/passport-ldapauth> |