# matrix-corporal is a reconciliator and gateway for a managed Matrix server.
# See: https://github.com/devture/matrix-corporal
matrix_corporal_enabled : true
matrix_corporal_container_image_self_build : false
matrix_corporal_container_image_self_build_repo : "https://github.com/devture/matrix-corporal.git"
# 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 : ''
# A list of extra arguments to pass to the container
matrix_corporal_container_extra_arguments : [ ]
# List of systemd services that matrix-corporal.service depends on
matrix_corporal_systemd_required_services_list : [ 'docker.service' ]
matrix_corporal_version : 2.2 .3
matrix_corporal_docker_image : "{{ matrix_corporal_docker_image_name_prefix }}devture/matrix-corporal:{{ matrix_corporal_docker_image_tag }}"
matrix_corporal_docker_image_name_prefix : "{{ 'localhost/' if matrix_corporal_container_image_self_build else matrix_container_global_registry_prefix }}"
matrix_corporal_docker_image_tag : "{{ matrix_corporal_version }}" # for backward-compatibility
matrix_corporal_docker_image_force_pull : "{{ matrix_corporal_docker_image.endswith(':latest') }}"
matrix_corporal_base_path : "{{ matrix_base_data_path }}/corporal"
matrix_corporal_container_src_files_path : "{{ matrix_corporal_base_path }}/container-src"
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"
matrix_corporal_matrix_homeserver_domain_name : "{{ matrix_domain }}"
# Controls where matrix-corporal can reach your Synapse server (e.g. "http://matrix-synapse:{{ matrix_synapse_container_client_api_port }}").
# 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 : ""
matrix_corporal_matrix_timeout_milliseconds : 45000
matrix_corporal_reconciliation_retry_interval_milliseconds : 30000
matrix_corporal_corporal_user_id_local_part : "matrix-corporal"
matrix_corporal_http_gateway_timeout_milliseconds : 60000
# 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
matrix_corporal_http_api_enabled : false
matrix_corporal_http_api_auth_token : ""
matrix_corporal_http_api_timeout_milliseconds : 15000
# Matrix Corporal policy provider configuration (goes directly into the configuration's `PolicyProvider` value)
matrix_corporal_policy_provider_config : ""
matrix_corporal_debug : false
# 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 : '{}'
matrix_corporal_configuration_extension : "{{ matrix_corporal_configuration_extension_json|from_json if matrix_corporal_configuration_extension_json|from_json is mapping else {} }}"
# 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`.
matrix_corporal_configuration : "{{ matrix_corporal_configuration_default|combine(matrix_corporal_configuration_extension, recursive=True) }}"
