matrix-docker-ansible-deploy/docs/configuring-playbook-matrix-ldap-registration-proxy.md
Julian-Samuel Gebühr 2fa0ddcf53 TODO: Check if ths documentation is correct
Signed-off-by: Julian-Samuel Gebühr <julian-samuel@gebuehr.net>
2022-09-16 19:25:00 +02:00

1.1 KiB

Setting up matrix-ldap-registration-proxy (optional)

The playbook can install and configure matrix-ldap-registration-proxy for you.

This proxy handles Matrix registration requests and forwards them to LDAP.

Please note: This does support the full Matrix specification for registrations. It only provide a very coarse implementation of a basic password registration.

Quickstart

Add the following configuration to your inventory/host_vars/matrix.DOMAIN/vars.yml file:

matrix_ldap_registration_proxy_enabled: true

That is enough if you use the synapse external password provider via LDAP. If you want to use your own credentials add the following to your inventory/host_vars/matrix.DOMAIN/vars.yml:

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>

TODO: is the block above correct? Else indicate that it can only be used with the LDAP password provider for Synapse