diff options
| author | kaniini <nenolod@gmail.com> | 2019-03-15 19:57:09 +0000 |
|---|---|---|
| committer | kaniini <nenolod@gmail.com> | 2019-03-15 19:57:09 +0000 |
| commit | 8b352af4dd4f79432e3e9c48593380292e4002d7 (patch) | |
| tree | 095ae99a4174942d170b14578a9e079077befb1d /docs/config.md | |
| parent | acf215d983f7a57fb8375184e24d2e04eda74eb5 (diff) | |
| parent | a070dd4a83788dfd76809d8b4ee4111b05cdff47 (diff) | |
| download | pleroma-8b352af4dd4f79432e3e9c48593380292e4002d7.tar.gz | |
Merge branch 'feature/openldap-support' into 'develop'
OpenLDAP support
Closes #203
See merge request pleroma/pleroma!859
Diffstat (limited to 'docs/config.md')
| -rw-r--r-- | docs/config.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/config.md b/docs/config.md index e34ffe980..201180373 100644 --- a/docs/config.md +++ b/docs/config.md @@ -331,3 +331,26 @@ config :auto_linker, rel: false ] ``` + +## :ldap + +Use LDAP for user authentication. When a user logs in to the Pleroma +instance, the name and password will be verified by trying to authenticate +(bind) to an LDAP server. If a user exists in the LDAP directory but there +is no account with the same name yet on the Pleroma instance then a new +Pleroma account will be created with the same name as the LDAP user name. + +* `enabled`: enables LDAP authentication +* `host`: LDAP server hostname +* `port`: LDAP port, e.g. 389 or 636 +* `ssl`: true to use SSL, usually implies the port 636 +* `sslopts`: additional SSL options +* `tls`: true to start TLS, usually implies the port 389 +* `tlsopts`: additional TLS options +* `base`: LDAP base, e.g. "dc=example,dc=com" +* `uid`: LDAP attribute name to authenticate the user, e.g. when "cn", the filter will be "cn=username,base" + +## Pleroma.Web.Auth.Authenticator + +* `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator +* `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication |