From 17c52687a641038b4eae36b90eb41554420f9e97 Mon Sep 17 00:00:00 2001 From: fnoah Date: Tue, 22 Oct 2019 17:24:27 +0200 Subject: [PATCH] Add documentation --- docs/configuring-playbook-mxisd.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/configuring-playbook-mxisd.md b/docs/configuring-playbook-mxisd.md index 2f5806bb..29cec488 100644 --- a/docs/configuring-playbook-mxisd.md +++ b/docs/configuring-playbook-mxisd.md @@ -36,6 +36,27 @@ To use the [Registration](https://github.com/kamax-matrix/mxisd/blob/master/docs - `matrix_mxisd_configuration_extension_yaml` - to configure mxisd as required. See the [Registration feature's docs](https://github.com/kamax-matrix/mxisd/blob/master/docs/features/registration.md) for inspiration. Also see the [Additional features](#additional-features) section below to learn more about how to use `matrix_mxisd_configuration_extension_yaml`. +## Authentication + +[Authentication](https://github.com/kamax-matrix/mxisd/blob/master/docs/features/authentication.md) provides the possibility to use your own [Identity Stores](https://github.com/kamax-matrix/mxisd/blob/master/docs/stores/README.md) (for example LDAP) to authenticate users on your Homeserver. The following configuration can be used to authenticate against an LDAP server: + +```yaml +matrix_synapse_ext_password_provider_rest_auth_enabled: true + +# matrix-mxisd is the hostname of the mxisd Docker container +matrix_synapse_ext_password_provider_rest_auth_endpoint: "http://matrix-mxisd:8090" + +matrix_mxisd_configuration_extension_yaml: | + ldap: + enabled: true + connection: + host: ldapHostnameOrIp + tls: false + port: 389 + baseDNs: ['OU=Users,DC=example,DC=org'] + bindDn: CN=My Mxisd User,OU=Users,DC=example,DC=org + bindPassword: TheUserPassword +``` ## Additional features