summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDustin Frisch2018-03-01 23:51:47 +0100
committerDustin Frisch2018-03-01 23:51:47 +0100
commitd6ee10d17645bed82ad39276fb4c26705edbacf9 (patch)
tree1dc2228372e95de7f84ea9d8e6cc6b3453f34906 /README.md
parentb0ce3d0230a104fe6e4e136f8ecb57a87c6d264b (diff)
Introduce ldap.useridField
Signed-off-by: Dustin Frisch <fooker@lab.sh>
Diffstat (limited to 'README.md')
-rw-r--r--README.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/README.md b/README.md
index fb4e2223..3b91a1b6 100644
--- a/README.md
+++ b/README.md
@@ -175,7 +175,8 @@ There are some config settings you need to change in the files below.
| `HMD_LDAP_SEARCHBASE` | `o=users,dc=example,dc=com` | LDAP directory to begin search from |
| `HMD_LDAP_SEARCHFILTER` | `(uid={{username}})` | LDAP filter to search with |
| `HMD_LDAP_SEARCHATTRIBUTES` | `displayName, mail` | LDAP attributes to search with (use comma to separate) |
-| `HMD_LDAP_USERNAMEFIELD` | `uid` | The LDAP field which is used as the username on HackMD |
+| `HMD_LDAP_USERIDFIELD` | `uidNumber` or `uid` or `sAMAccountName` | The LDAP field which is used uniquely identify a user on HackMD |
+| `HMD_LDAP_USERNAMEFIELD` | Fallback to userid | The LDAP field which is used as the username on HackMD |
| `HMD_LDAP_TLS_CA` | `server-cert.pem, root.pem` | Root CA for LDAP TLS in PEM format (use comma to separate) |
| `HMD_LDAP_PROVIDERNAME` | `My institution` | Optional name to be displayed at login form indicating the LDAP provider |
| `HMD_SAML_IDPSSOURL` | `https://idp.example.com/sso` | authentication endpoint of IdP. for details, see [guide](docs/guides/auth.md#saml-onelogin). |