From 17c52687a641038b4eae36b90eb41554420f9e97 Mon Sep 17 00:00:00 2001 From: fnoah Date: Tue, 22 Oct 2019 17:24:27 +0200 Subject: [PATCH 1/5] 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 2f5806bb3..29cec488d 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 From 64ce74137c2a29542a5b0a1d91571923c4e5e142 Mon Sep 17 00:00:00 2001 From: fnoah Date: Wed, 23 Oct 2019 16:14:29 +0200 Subject: [PATCH 2/5] Add documentation part 2 --- docs/configuring-playbook-ldap-auth.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/configuring-playbook-ldap-auth.md b/docs/configuring-playbook-ldap-auth.md index 5658b8a90..4fe812fb1 100644 --- a/docs/configuring-playbook-ldap-auth.md +++ b/docs/configuring-playbook-ldap-auth.md @@ -27,3 +27,6 @@ If you wish for users to **authenticate only against configured password provide ```yaml matrix_synapse_password_config_localdb_enabled: false ``` + +## Using mxisd Identity Server for authentication +If you wish to use the mxisd Identity Server for LDAP authentication instead of [matrix-synapse-ldap3](https://github.com/matrix-org/matrix-synapse-ldap3) consult [Adjusting mxisd Identity Server configuration](https://github.com/kamax-matrix/mxisd/blob/master/docs/features/configuring-playbook-mxisd.md#authentication). \ No newline at end of file From 7b65a163758d83a9340c82d60dc9f9bc3d771b0b Mon Sep 17 00:00:00 2001 From: fnoah Date: Wed, 23 Oct 2019 16:16:32 +0200 Subject: [PATCH 3/5] Fix --- docs/configuring-playbook-ldap-auth.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuring-playbook-ldap-auth.md b/docs/configuring-playbook-ldap-auth.md index 4fe812fb1..35addbb78 100644 --- a/docs/configuring-playbook-ldap-auth.md +++ b/docs/configuring-playbook-ldap-auth.md @@ -29,4 +29,4 @@ matrix_synapse_password_config_localdb_enabled: false ``` ## Using mxisd Identity Server for authentication -If you wish to use the mxisd Identity Server for LDAP authentication instead of [matrix-synapse-ldap3](https://github.com/matrix-org/matrix-synapse-ldap3) consult [Adjusting mxisd Identity Server configuration](https://github.com/kamax-matrix/mxisd/blob/master/docs/features/configuring-playbook-mxisd.md#authentication). \ No newline at end of file +If you wish to use the mxisd Identity Server for LDAP authentication instead of [matrix-synapse-ldap3](https://github.com/matrix-org/matrix-synapse-ldap3) consult [Adjusting mxisd Identity Server configuration](configuring-dns.md#authentication). \ No newline at end of file From 692355e3e276ccb0c0668c15a2631a69f7c041ac Mon Sep 17 00:00:00 2001 From: fnoah Date: Wed, 23 Oct 2019 16:19:46 +0200 Subject: [PATCH 4/5] Fix link --- docs/configuring-playbook-ldap-auth.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuring-playbook-ldap-auth.md b/docs/configuring-playbook-ldap-auth.md index 35addbb78..e41d4a52b 100644 --- a/docs/configuring-playbook-ldap-auth.md +++ b/docs/configuring-playbook-ldap-auth.md @@ -29,4 +29,4 @@ matrix_synapse_password_config_localdb_enabled: false ``` ## Using mxisd Identity Server for authentication -If you wish to use the mxisd Identity Server for LDAP authentication instead of [matrix-synapse-ldap3](https://github.com/matrix-org/matrix-synapse-ldap3) consult [Adjusting mxisd Identity Server configuration](configuring-dns.md#authentication). \ No newline at end of file +If you wish to use the mxisd Identity Server for LDAP authentication instead of [matrix-synapse-ldap3](https://github.com/matrix-org/matrix-synapse-ldap3) consult [Adjusting mxisd Identity Server configuration](configuring-playbook-mxisd#authentication). \ No newline at end of file From fe103489c6d72a0e0b3545c8580f6f8483a6ca62 Mon Sep 17 00:00:00 2001 From: fnoah Date: Wed, 23 Oct 2019 16:21:14 +0200 Subject: [PATCH 5/5] Add file ending --- docs/configuring-playbook-ldap-auth.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuring-playbook-ldap-auth.md b/docs/configuring-playbook-ldap-auth.md index e41d4a52b..c9f15c317 100644 --- a/docs/configuring-playbook-ldap-auth.md +++ b/docs/configuring-playbook-ldap-auth.md @@ -29,4 +29,4 @@ matrix_synapse_password_config_localdb_enabled: false ``` ## Using mxisd Identity Server for authentication -If you wish to use the mxisd Identity Server for LDAP authentication instead of [matrix-synapse-ldap3](https://github.com/matrix-org/matrix-synapse-ldap3) consult [Adjusting mxisd Identity Server configuration](configuring-playbook-mxisd#authentication). \ No newline at end of file +If you wish to use the mxisd Identity Server for LDAP authentication instead of [matrix-synapse-ldap3](https://github.com/matrix-org/matrix-synapse-ldap3) consult [Adjusting mxisd Identity Server configuration](configuring-playbook-mxisd.md#authentication). \ No newline at end of file