2022-08-21 09:04:47 +00:00
---
# matrix_ldap_registration_proxy - Want to build a large-scale Matrix server using external registration on LDAP?
# Project source code URL: https://gitlab.com/activism.international/matrix_ldap_registration_proxy
2022-09-04 06:53:26 +00:00
matrix_ldap_registration_proxy_enabled : true
2022-08-21 09:04:47 +00:00
2024-01-09 09:26:46 +00:00
matrix_ldap_registration_proxy_hostname : ''
2022-09-29 16:00:14 +00:00
matrix_ldap_registration_proxy_docker_image : matrix_ldap_registration_proxy
2022-08-21 09:04:47 +00:00
matrix_ldap_registration_proxy_container_image_self_build_repo : "https://gitlab.com/activism.international/matrix_ldap_registration_proxy.git"
matrix_ldap_registration_proxy_container_image_self_build_branch : "{{ matrix_ldap_registration_proxy_version }}"
matrix_ldap_registration_proxy_version : "296246afc6a9b3105e67fcf6621cf05ebc74b873"
matrix_ldap_registration_proxy_base_path : "{{ matrix_base_data_path }}/matrix_ldap_registration_proxy"
# We need the docker src directory to be named matrix_ldap_registration_proxy.
matrix_ldap_registration_proxy_docker_src_files_path : "{{ matrix_ldap_registration_proxy_base_path }}/docker-src/matrix_ldap_registration_proxy"
matrix_ldap_registration_proxy_config_path : "{{ matrix_ldap_registration_proxy_base_path }}/config"
2022-09-04 06:56:03 +00:00
matrix_ldap_registration_proxy_ldap_uri : ""
matrix_ldap_registration_proxy_ldap_base_dn : ""
matrix_ldap_registration_proxy_ldap_user : ""
matrix_ldap_registration_proxy_ldap_password : ""
2022-08-21 09:04:47 +00:00
matrix_ldap_registration_proxy_matrix_server_name : "{{ matrix_domain }}"
2024-01-09 09:26:46 +00:00
matrix_ldap_registration_proxy_matrix_server_url : ""
2022-09-29 16:00:14 +00:00
2022-08-21 09:04:47 +00:00
# Controls whether the self-check feature should validate SSL certificates.
matrix_matrix_ldap_registration_proxy_self_check_validate_certificates : true
2024-01-09 09:26:46 +00:00
matrix_ldap_registration_listen_port : 8080
# Controls whether the matrix_ldap_registration_proxy container exposes its HTTP port (tcp/{{ matrix_ldap_registration_listen_port }} in the container).
2022-08-21 09:04:47 +00:00
#
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8080"), or empty string to not expose.
2022-09-29 16:00:14 +00:00
matrix_ldap_registration_proxy_container_http_host_bind_port : ''
2022-08-21 09:04:47 +00:00
2024-01-09 09:26:46 +00:00
matrix_ldap_registration_proxy_container_network : ""
matrix_ldap_registration_proxy_container_additional_networks : "{{ matrix_ldap_registration_proxy_container_additional_networks_auto + matrix_ldap_registration_proxy_container_additional_networks_custom }}"
matrix_ldap_registration_proxy_container_additional_networks_auto : [ ]
matrix_ldap_registration_proxy_container_additional_networks_custom : [ ]
2022-09-16 17:16:45 +00:00
2024-01-09 09:26:46 +00:00
# matrix_ldap_registration_proxy_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container.
# See `../templates/labels.j2` for details.
#
# To inject your own other container labels, see `matrix_ldap_registration_proxy_container_labels_additional_labels`.
matrix_ldap_registration_proxy_container_labels_traefik_enabled : true
matrix_ldap_registration_proxy_container_labels_traefik_docker_network : "{{ matrix_ldap_registration_proxy_container_network }}"
matrix_ldap_registration_proxy_container_labels_traefik_entrypoints : web-secure
matrix_ldap_registration_proxy_container_labels_traefik_tls_certResolver : default # noqa var-naming
2024-01-09 11:16:20 +00:00
# Controls whether labels will be added that expose ldap-registration-proxy's registration endpoint (matrix_ldap_registration_proxy_container_labels_registration_endpoint_path)
2024-01-09 09:26:46 +00:00
matrix_ldap_registration_proxy_container_labels_registration_endpoint_enabled : true
matrix_ldap_registration_proxy_container_labels_registration_endpoint_hostname : "{{ matrix_ldap_registration_proxy_hostname }}"
2024-01-09 11:16:20 +00:00
matrix_ldap_registration_proxy_container_labels_registration_endpoint_path : "/_matrix/client/{version:(r0|v3)}/register"
matrix_ldap_registration_proxy_container_labels_registration_endpoint_traefik_rule : "Host(`{{ matrix_ldap_registration_proxy_container_labels_registration_endpoint_hostname }}`) && Path(`{{ matrix_ldap_registration_proxy_container_labels_registration_endpoint_path }}`)"
2024-01-09 09:26:46 +00:00
matrix_ldap_registration_proxy_container_labels_registration_endpoint_traefik_priority : 0
matrix_ldap_registration_proxy_container_labels_registration_endpoint_traefik_entrypoints : "{{ matrix_ldap_registration_proxy_container_labels_traefik_entrypoints }}"
matrix_ldap_registration_proxy_container_labels_registration_endpoint_traefik_tls : "{{ matrix_ldap_registration_proxy_container_labels_registration_endpoint_traefik_entrypoints != 'web' }}"
matrix_ldap_registration_proxy_container_labels_registration_endpoint_traefik_tls_certResolver : "{{ matrix_ldap_registration_proxy_container_labels_traefik_tls_certResolver }}" # noqa var-naming
2022-09-04 17:38:27 +00:00
2024-01-09 09:26:46 +00:00
# matrix_ldap_registration_proxy_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file.
# See `../templates/labels.j2` for details.
#
# Example:
# matrix_ldap_registration_proxy_container_labels_additional_labels: |
# my.label=1
# another.label="here"
matrix_ldap_registration_proxy_container_labels_additional_labels : ''
2022-09-04 17:38:27 +00:00
2022-08-21 09:04:47 +00:00
# A list of extra arguments to pass to the container
matrix_ldap_registration_proxy_container_extra_arguments : [ ]
2024-01-09 09:26:46 +00:00
# List of systemd services that matrix-ldap-registration-proxy.service depends on.
matrix_ldap_registration_proxy_systemd_required_services_list : "{{ matrix_ldap_registration_proxy_systemd_required_services_list_default + matrix_ldap_registration_proxy_systemd_required_services_list_auto + matrix_ldap_registration_proxy_systemd_required_services_list_custom }}"
matrix_ldap_registration_proxy_systemd_required_services_list_default : [ 'docker.service' ]
matrix_ldap_registration_proxy_systemd_required_services_list_auto : [ ]
matrix_ldap_registration_proxy_systemd_required_services_list_custom : [ ]
2022-08-21 09:04:47 +00:00
2024-01-09 09:26:46 +00:00
# List of systemd services that matrix-ldap-registration-proxy.service wants
2024-01-09 09:51:15 +00:00
matrix_ldap_registration_proxy_systemd_wanted_services_list : "{{ matrix_ldap_registration_proxy_systemd_wanted_services_list_default + matrix_ldap_registration_proxy_systemd_wanted_services_list_auto + matrix_ldap_registration_proxy_systemd_wanted_services_list_custom }}"
matrix_ldap_registration_proxy_systemd_wanted_services_list_default : [ 'docker.service' ]
matrix_ldap_registration_proxy_systemd_wanted_services_list_auto : [ ]
matrix_ldap_registration_proxy_systemd_wanted_services_list_custom : [ ]
2022-08-21 09:04:47 +00:00
2022-09-04 07:09:09 +00:00
# Additional environment variables to pass to the LDAP proxy environment variables.
#
# Example:
# matrix_ldap_registration_proxy_env_variables_extension: |
# KEY=value
matrix_ldap_registration_proxy_env_variables_extension : ''