From 2da5c13c265c355b5025c0ff6b11f387dcac9335 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara <acioustick@noreply.codeberg.org> Date: Sat, 28 Dec 2024 07:41:30 -0500 Subject: [PATCH 1/4] Update docs/configuring-playbook-matrix-ldap-registration-proxy.md: add the common section "Extending the configuration" Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> --- ...configuring-playbook-matrix-ldap-registration-proxy.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/configuring-playbook-matrix-ldap-registration-proxy.md b/docs/configuring-playbook-matrix-ldap-registration-proxy.md index 5f58ead69..ca52c4266 100644 --- a/docs/configuring-playbook-matrix-ldap-registration-proxy.md +++ b/docs/configuring-playbook-matrix-ldap-registration-proxy.md @@ -32,6 +32,14 @@ matrix_ldap_registration_proxy_systemd_wanted_services_list_custom: - matrix-synapse.service ``` +### Extending the configuration + +There are some additional things you may wish to configure about the component. + +Take a look at: + +- `roles/custom/matrix-ldap-registration-proxy/defaults/main.yml` for some variables that you can customize via your `vars.yml` file + ## Installing After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: From c4b4deeef6b6c93809c55851a6288ed3002b7221 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara <acioustick@noreply.codeberg.org> Date: Sun, 26 Jan 2025 14:46:28 +0900 Subject: [PATCH 2/4] Update docs/configuring-playbook-matrix-ldap-registration-proxy.md: add the common section "Troubleshooting" Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> --- docs/configuring-playbook-matrix-ldap-registration-proxy.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/configuring-playbook-matrix-ldap-registration-proxy.md b/docs/configuring-playbook-matrix-ldap-registration-proxy.md index ca52c4266..235267f0b 100644 --- a/docs/configuring-playbook-matrix-ldap-registration-proxy.md +++ b/docs/configuring-playbook-matrix-ldap-registration-proxy.md @@ -52,3 +52,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all` `just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too. + +## Troubleshooting + +As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-ldap-registration-proxy`. From 049fb1d65850df789a92f5825be1d96eca59c26f Mon Sep 17 00:00:00 2001 From: Suguru Hirahara <acioustick@noreply.codeberg.org> Date: Sun, 26 Jan 2025 14:44:30 +0900 Subject: [PATCH 3/4] Update docs/configuring-playbook-matrix-ldap-registration-proxy.md: introductory sections Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> --- docs/configuring-playbook-matrix-ldap-registration-proxy.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/configuring-playbook-matrix-ldap-registration-proxy.md b/docs/configuring-playbook-matrix-ldap-registration-proxy.md index 235267f0b..90078d367 100644 --- a/docs/configuring-playbook-matrix-ldap-registration-proxy.md +++ b/docs/configuring-playbook-matrix-ldap-registration-proxy.md @@ -4,11 +4,13 @@ The playbook can install and configure [matrix-ldap-registration-proxy](https:// This proxy handles Matrix registration requests and forwards them to LDAP. +See the project's [documentation](https://gitlab.com/activism.international/matrix_ldap_registration_proxy/-/blob/main/README.md) to learn what it does and why it might be useful to you. + **Note**: This does support the full Matrix specification for registrations. It only provide a very coarse implementation of a basic password registration. -## Quickstart +## Adjusting the playbook configuration -Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: +To enable the component, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your needs): ```yaml matrix_ldap_registration_proxy_enabled: true From 63ced228c63860f4e481c1fdbe434e84ce2388a4 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara <acioustick@noreply.codeberg.org> Date: Sun, 26 Jan 2025 15:32:00 +0900 Subject: [PATCH 4/4] Update docs/configuring-playbook-matrix-ldap-registration-proxy.md: change placeholders Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> --- ...onfiguring-playbook-matrix-ldap-registration-proxy.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/configuring-playbook-matrix-ldap-registration-proxy.md b/docs/configuring-playbook-matrix-ldap-registration-proxy.md index 90078d367..29e825a92 100644 --- a/docs/configuring-playbook-matrix-ldap-registration-proxy.md +++ b/docs/configuring-playbook-matrix-ldap-registration-proxy.md @@ -14,11 +14,12 @@ To enable the component, add the following configuration to your `inventory/host ```yaml matrix_ldap_registration_proxy_enabled: true + # LDAP credentials -matrix_ldap_registration_proxy_ldap_uri: <URI> -matrix_ldap_registration_proxy_ldap_base_dn: <DN> -matrix_ldap_registration_proxy_ldap_user: <USER> -matrix_ldap_registration_proxy_ldap_password: <password> +matrix_ldap_registration_proxy_ldap_uri: YOUR_URI_HERE +matrix_ldap_registration_proxy_ldap_base_dn: YOUR_DN_HERE +matrix_ldap_registration_proxy_ldap_user: YOUR_USER_HERE +matrix_ldap_registration_proxy_ldap_password: YOUR_PASSWORD_HERE ``` If you already use the [synapse external password provider via LDAP](configuring-playbook-ldap-auth.md) (that is, you have `matrix_synapse_ext_password_provider_ldap_enabled: true` and other options in your configuration) you can use the following values as configuration: