2022-02-05 20:32:54 +00:00
---
2019-01-16 16:05:48 +00:00
# matrix-corporal is a reconciliator and gateway for a managed Matrix server.
2022-07-16 20:59:21 +00:00
# Project source code URL: https://github.com/devture/matrix-corporal
2019-01-12 15:53:00 +00:00
2019-01-16 16:05:48 +00:00
matrix_corporal_enabled : true
2023-12-23 07:33:56 +00:00
# renovate: datasource=docker depName=devture/matrix-corporal
2024-11-29 07:48:35 +00:00
matrix_corporal_version : 3.1 .1
2023-12-23 07:33:56 +00:00
2020-12-03 23:48:08 +00:00
matrix_corporal_container_image_self_build : false
matrix_corporal_container_image_self_build_repo : "https://github.com/devture/matrix-corporal.git"
2019-05-24 22:41:04 +00:00
# Controls whether the matrix-corporal container exposes its gateway HTTP port (tcp/41080 in the container).
#
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:41080"), or empty string to not expose.
matrix_corporal_container_http_gateway_host_bind_port : ''
# Controls whether the matrix-corporal container exposes its API HTTP port (tcp/41081 in the container).
#
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:41081"), or empty string to not expose.
matrix_corporal_container_http_api_host_bind_port : ''
2019-01-16 16:05:48 +00:00
2019-04-30 14:35:18 +00:00
# A list of extra arguments to pass to the container
matrix_corporal_container_extra_arguments : [ ]
2023-12-23 07:33:56 +00:00
# The base container network. It will be auto-created by this role if it doesn't exist already.
2024-01-13 13:28:21 +00:00
matrix_corporal_container_network : ""
2023-12-23 07:33:56 +00:00
# A list of additional container networks that the container would be connected to.
# The role does not create these networks, so make sure they already exist.
# Use this to expose this container to another reverse proxy, which runs in a different container network.
matrix_corporal_container_additional_networks : "{{ matrix_corporal_container_additional_networks_auto + matrix_corporal_container_additional_networks_custom }}"
matrix_corporal_container_additional_networks_auto : [ ]
matrix_corporal_container_additional_networks_custom : [ ]
2023-12-23 08:36:20 +00:00
# matrix_corporal_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_corporal_container_labels_additional_labels`.
matrix_corporal_container_labels_traefik_enabled : true
matrix_corporal_container_labels_traefik_docker_network : "{{ matrix_corporal_container_network }}"
matrix_corporal_container_labels_traefik_entrypoints : web-secure
matrix_corporal_container_labels_traefik_tls : "{{ matrix_corporal_container_labels_traefik_entrypoints != 'web' }}"
matrix_corporal_container_labels_traefik_tls_certResolver : default # noqa var-naming
2024-01-13 13:28:21 +00:00
# Controls whether labels will be added that expose matrix-corporal's HTTP API (/_matrix/corporal).
# Because we also capture all of `/_matrix` for the Client-Server API below (see `matrix_corporal_container_labels_matrix_client_api_*`)
# and we explicitly set a higher priority on it (to ensure we capture it instead of the homeserver),
# we also need to tweak the priority of this router, to avoid its requests going to the other one.
2023-12-23 08:36:20 +00:00
matrix_corporal_container_labels_api_enabled : "{{ matrix_corporal_http_api_enabled }}"
matrix_corporal_container_labels_api_traefik_rule : "Host(`{{ matrix_corporal_matrix_homeserver_api_domain_name }}`) && PathPrefix(`/_matrix/corporal`)"
2024-01-13 13:28:21 +00:00
matrix_corporal_container_labels_api_traefik_priority : "{{ matrix_corporal_container_labels_matrix_client_api_traefik_priority + 500 }}"
2023-12-23 08:36:20 +00:00
matrix_corporal_container_labels_api_traefik_entrypoints : "{{ matrix_corporal_container_labels_traefik_entrypoints }}"
matrix_corporal_container_labels_api_traefik_tls : "{{ matrix_corporal_container_labels_traefik_tls }}"
matrix_corporal_container_labels_api_traefik_tls_certResolver : "{{ matrix_corporal_container_labels_traefik_tls_certResolver }}" # noqa var-naming
2024-01-13 13:28:21 +00:00
# Controls whether labels will be added that expose the Matrix Client-Server API (/_matrix).
# By default, we try to capture these requests with higher priority than the running homeserver,
# so that matrix-corporal can do its job of firewalling, etc.
matrix_corporal_container_labels_matrix_client_api_enabled : true
matrix_corporal_container_labels_matrix_client_api_traefik_hostname : "{{ matrix_corporal_matrix_homeserver_api_domain_name }}"
matrix_corporal_container_labels_matrix_client_api_traefik_path_prefix : /_matrix
matrix_corporal_container_labels_matrix_client_api_traefik_rule : "Host(`{{ matrix_corporal_container_labels_matrix_client_api_traefik_hostname }}`) && PathPrefix(`{{ matrix_corporal_container_labels_matrix_client_api_traefik_path_prefix }}`)"
matrix_corporal_container_labels_matrix_client_api_traefik_priority : 500
matrix_corporal_container_labels_matrix_client_api_traefik_entrypoints : "{{ matrix_corporal_container_labels_traefik_entrypoints }}"
matrix_corporal_container_labels_matrix_client_api_traefik_tls : "{{ matrix_corporal_container_labels_matrix_client_api_traefik_entrypoints != 'web' }}"
matrix_corporal_container_labels_matrix_client_api_traefik_tls_certResolver : "{{ matrix_corporal_container_labels_traefik_tls_certResolver }}" # noqa var-naming
2023-12-23 08:36:20 +00:00
# matrix_corporal_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_corporal_container_labels_additional_labels: |
# my.label=1
# another.label="here"
matrix_corporal_container_labels_additional_labels : ''
2019-01-16 16:05:48 +00:00
# List of systemd services that matrix-corporal.service depends on
2024-01-13 13:28:21 +00:00
matrix_corporal_systemd_required_services_list : "{{ matrix_corporal_systemd_required_services_list_default + matrix_corporal_systemd_required_services_list_auto + matrix_corporal_systemd_required_services_list_custom }}"
2024-06-04 10:14:34 +00:00
matrix_corporal_systemd_required_services_list_default : "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
2024-01-13 13:28:21 +00:00
matrix_corporal_systemd_required_services_list_auto : [ ]
matrix_corporal_systemd_required_services_list_custom : [ ]
2020-12-03 23:48:08 +00:00
matrix_corporal_docker_image : "{{ matrix_corporal_docker_image_name_prefix }}devture/matrix-corporal:{{ matrix_corporal_docker_image_tag }}"
2021-04-12 12:39:16 +00:00
matrix_corporal_docker_image_name_prefix : "{{ 'localhost/' if matrix_corporal_container_image_self_build else matrix_container_global_registry_prefix }}"
2022-02-05 20:32:54 +00:00
matrix_corporal_docker_image_tag : "{{ matrix_corporal_version }}" # for backward-compatibility
2019-06-10 11:23:51 +00:00
matrix_corporal_docker_image_force_pull : "{{ matrix_corporal_docker_image.endswith(':latest') }}"
2019-01-12 15:53:00 +00:00
matrix_corporal_base_path : "{{ matrix_base_data_path }}/corporal"
2020-12-03 23:48:08 +00:00
matrix_corporal_container_src_files_path : "{{ matrix_corporal_base_path }}/container-src"
2019-01-12 15:53:00 +00:00
matrix_corporal_config_dir_path : "{{ matrix_corporal_base_path }}/config"
matrix_corporal_cache_dir_path : "{{ matrix_corporal_base_path }}/cache"
matrix_corporal_var_dir_path : "{{ matrix_corporal_base_path }}/var"
2024-05-25 13:14:26 +00:00
matrix_corporal_matrix_homeserver_scheme : https
2019-02-28 09:51:09 +00:00
matrix_corporal_matrix_homeserver_domain_name : "{{ matrix_domain }}"
2023-12-23 08:36:20 +00:00
matrix_corporal_matrix_homeserver_api_domain_name : "{{ matrix_server_fqn_matrix }}"
2019-01-16 16:05:48 +00:00
2022-11-20 14:43:30 +00:00
# Controls where matrix-corporal can reach your Synapse server (e.g. "http://matrix-synapse-reverse-proxy-companion:{{ matrix_synapse_container_client_api_port }}").
2019-01-16 16:05:48 +00:00
# If Synapse runs on the same machine, you may need to add its service to `matrix_corporal_systemd_required_services_list`.
matrix_corporal_matrix_homeserver_api_endpoint : ""
# The shared secret between matrix-corporal and Synapse's shared-secret-auth password provider module.
# To use matrix-corporal, the shared-secret-auth password provider needs to be enabled and the secret needs to be identical.
matrix_corporal_matrix_auth_shared_secret : ""
# The shared secret for registering users with Synapse.
# Needs to be identical to Synapse's `registration_shared_secret` setting.
matrix_corporal_matrix_registration_shared_secret : ""
2019-01-12 15:53:00 +00:00
matrix_corporal_matrix_timeout_milliseconds : 45000
matrix_corporal_reconciliation_retry_interval_milliseconds : 30000
2021-01-16 21:47:14 +00:00
matrix_corporal_corporal_user_id_local_part : "matrix-corporal"
2019-01-12 15:53:00 +00:00
2020-03-24 14:41:24 +00:00
matrix_corporal_http_gateway_timeout_milliseconds : 60000
2021-01-16 21:47:14 +00:00
# If enabled, matrix-corporal exposes a `POST /_matrix/corporal/_matrix-internal/identity/v1/check_credentials` API
# on the gateway (Client-Server API) server.
# This API can then be used together with the REST Auth password provider by pointing it to matrix-corporal (e.g. `http://matrix-corporal:41080/_matrix/corporal`).
# Doing so allows Interactive Authentication to work.
matrix_corporal_http_gateway_internal_rest_auth_enabled : false
2019-01-12 15:53:00 +00:00
matrix_corporal_http_api_enabled : false
matrix_corporal_http_api_auth_token : ""
2020-03-24 14:41:24 +00:00
matrix_corporal_http_api_timeout_milliseconds : 15000
2019-01-12 15:53:00 +00:00
# Matrix Corporal policy provider configuration (goes directly into the configuration's `PolicyProvider` value)
matrix_corporal_policy_provider_config : ""
2019-01-25 14:58:20 +00:00
matrix_corporal_debug : false
2019-08-25 07:58:30 +00:00
# Default Corporal configuration template which covers the generic use case.
# You can customize it by controlling the various variables inside it.
#
# For a more advanced customization, you can extend the default (see `matrix_corporal_configuration_extension_json`)
# or completely replace this variable with your own template.
#
# The side-effect of this lookup is that Ansible would even parse the JSON for us, returning a dict.
# This is unlike what it does when looking up YAML template files (no automatic parsing there).
matrix_corporal_configuration_default : "{{ lookup('template', 'templates/config.json.j2') }}"
# Your custom JSON configuration for Corporal should go to `matrix_corporal_configuration_extension_json`.
# This configuration extends the default starting configuration (`matrix_corporal_configuration_default`).
#
# You can override individual variables from the default configuration, or introduce new ones.
#
# If you need something more special, you can take full control by
# completely redefining `matrix_corporal_configuration_default`.
#
# Example configuration extension follows:
#
# matrix_corporal_configuration_extension_json: |
# {
# "Matrix": {
# "TimeoutMilliseconds": 60000
# }
# }
matrix_corporal_configuration_extension_json : '{}'
2022-07-18 09:28:39 +00:00
matrix_corporal_configuration_extension : "{{ matrix_corporal_configuration_extension_json | from_json if matrix_corporal_configuration_extension_json | from_json is mapping else {} }}"
2019-08-25 07:58:30 +00:00
# Holds the final Corporal configuration (a combination of the default and its extension).
# You most likely don't need to touch this variable. Instead, see `matrix_corporal_configuration_default`.
2022-07-18 09:28:39 +00:00
matrix_corporal_configuration : "{{ matrix_corporal_configuration_default | combine(matrix_corporal_configuration_extension, recursive=True) }}"
2024-01-13 13:28:21 +00:00
2024-05-25 13:14:26 +00:00
matrix_corporal_self_check_matrix_client_api_url_endpoint_public : "{{ matrix_corporal_matrix_homeserver_scheme }}://{{ matrix_corporal_matrix_homeserver_api_domain_name }}/_matrix/client/corporal"
matrix_corporal_self_check_corporal_api_url_endpoint_public : "{{ matrix_corporal_matrix_homeserver_scheme }}://{{ matrix_corporal_matrix_homeserver_api_domain_name }}/_matrix/corporal/policy"