2022-02-05 21:32:54 +01:00
---
2020-01-09 17:00:03 +01:00
# matrix-appservice-webhooks is a Matrix <-> webhook bridge
2022-07-16 22:59:21 +02:00
# Project source code URL: https://github.com/redoonetworks/matrix-appservice-webhooks
2020-01-09 17:00:03 +01:00
matrix_appservice_webhooks_enabled : true
2024-01-07 11:48:30 +01:00
matrix_appservice_webhooks_scheme : https
matrix_appservice_webhooks_hostname : ''
matrix_appservice_webhooks_path_prefix : /appservice-webhooks
2021-10-01 15:37:37 +02:00
matrix_appservice_webhooks_container_image_self_build : false
2021-12-09 18:31:40 +01:00
matrix_appservice_webhooks_container_image_self_build_repo : "https://github.com/redoonetworks/matrix-appservice-webhooks"
2021-10-01 15:37:37 +02:00
matrix_appservice_webhooks_container_image_self_build_repo_version : "{{ 'master' if matrix_appservice_webhooks_version == 'latest' else matrix_appservice_webhooks_version }}"
matrix_appservice_webhooks_container_image_self_build_repo_dockerfile_path : "Dockerfile"
2022-01-15 18:36:10 +01:00
matrix_appservice_webhooks_version : v1.0.3-01
2021-12-09 18:31:40 +01:00
matrix_appservice_webhooks_docker_image : "{{ matrix_appservice_webhooks_docker_image_name_prefix }}redoonetworks/matrix-appservice-webhooks:{{ matrix_appservice_webhooks_version }}"
2021-10-01 15:37:37 +02:00
matrix_appservice_webhooks_docker_image_name_prefix : "{{ 'localhost/' if matrix_appservice_webhooks_container_image_self_build else matrix_container_global_registry_prefix }}"
2020-01-09 17:00:03 +01:00
matrix_appservice_webhooks_docker_image_force_pull : "{{ matrix_appservice_webhooks_docker_image.endswith(':latest') }}"
matrix_appservice_webhooks_base_path : "{{ matrix_base_data_path }}/appservice-webhooks"
matrix_appservice_webhooks_config_path : "{{ matrix_appservice_webhooks_base_path }}/config"
matrix_appservice_webhooks_data_path : "{{ matrix_appservice_webhooks_base_path }}/data"
2021-10-01 15:37:37 +02:00
matrix_appservice_webhooks_docker_src_files_path : "{{ matrix_appservice_webhooks_base_path }}/docker-src"
2020-01-09 17:00:03 +01:00
2020-01-13 17:29:19 +01:00
# If nginx-proxy is disabled, the bridge itself expects its endpoint to be on its own domain (e.g. "localhost:6789")
2024-01-07 11:48:30 +01:00
matrix_appservice_webhooks_public_endpoint : "{{ matrix_appservice_webhooks_path_prefix }}"
matrix_appservice_webhooks_inbound_uri_prefix : "{{ matrix_appservice_webhooks_scheme }}://{{ matrix_appservice_webhooks_hostname }}{{ matrix_appservice_webhooks_public_endpoint }}"
2020-01-09 17:00:03 +01:00
matrix_appservice_webhooks_bot_name : 'webhookbot'
2022-03-02 21:28:52 +01:00
matrix_appservice_webhooks_user_prefix : '_webhook_'
2020-01-09 17:00:03 +01:00
# Controls the webhooks_PORT and MATRIX_PORT of the installation
matrix_appservice_webhooks_matrix_port : 6789
2020-03-03 11:38:21 +01:00
# Controls whether the appservice-webhooks container exposes its HTTP port (tcp/6789 in the container).
2020-01-09 17:00:03 +01:00
#
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:9999"), or empty string to not expose.
matrix_appservice_webhooks_container_http_host_bind_port : ''
2024-01-07 11:48:30 +01:00
matrix_appservice_webhooks_container_network : ""
matrix_appservice_webhooks_container_additional_networks : "{{ matrix_appservice_webhooks_container_additional_networks_auto + matrix_appservice_webhooks_container_additional_networks_custom }}"
matrix_appservice_webhooks_container_additional_networks_auto : [ ]
matrix_appservice_webhooks_container_additional_networks_custom : [ ]
# matrix_appservice_webhooks_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_appservice_webhooks_container_labels_additional_labels`.
matrix_appservice_webhooks_container_labels_traefik_enabled : true
matrix_appservice_webhooks_container_labels_traefik_docker_network : "{{ matrix_appservice_webhooks_container_network }}"
matrix_appservice_webhooks_container_labels_traefik_entrypoints : web-secure
matrix_appservice_webhooks_container_labels_traefik_tls_certResolver : default # noqa var-naming
# Controls whether labels will be added that expose matrix-appservice-webhook's public endpoints
matrix_appservice_webhooks_container_labels_public_endpoint_enabled : true
matrix_appservice_webhooks_container_labels_public_endpoint_hostname : "{{ matrix_appservice_webhooks_hostname }}"
matrix_appservice_webhooks_container_labels_public_endpoint_prefix : "{{ matrix_appservice_webhooks_path_prefix }}"
matrix_appservice_webhooks_container_labels_public_endpoint_traefik_rule : "Host(`{{ matrix_appservice_webhooks_container_labels_public_endpoint_hostname }}`) && PathPrefix(`{{ matrix_appservice_webhooks_path_prefix }}`)"
matrix_appservice_webhooks_container_labels_public_endpoint_traefik_priority : 0
matrix_appservice_webhooks_container_labels_public_endpoint_traefik_entrypoints : "{{ matrix_appservice_webhooks_container_labels_traefik_entrypoints }}"
matrix_appservice_webhooks_container_labels_public_endpoint_traefik_tls : "{{ matrix_appservice_webhooks_container_labels_public_endpoint_traefik_entrypoints != 'web' }}"
matrix_appservice_webhooks_container_labels_public_endpoint_traefik_tls_certResolver : "{{ matrix_appservice_webhooks_container_labels_traefik_tls_certResolver }}" # noqa var-naming
# matrix_appservice_webhooks_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_appservice_webhooks_container_labels_additional_labels: |
# my.label=1
# another.label="here"
matrix_appservice_webhooks_container_labels_additional_labels : ''
2020-01-09 17:00:03 +01:00
# A list of extra arguments to pass to the container
matrix_appservice_webhooks_container_extra_arguments : [ ]
# List of systemd services that matrix-appservice-webhooks.service depends on.
2024-01-07 11:48:30 +01:00
matrix_appservice_webhooks_systemd_required_services_list : "{{ matrix_appservice_webhooks_systemd_required_services_list_default + matrix_appservice_webhooks_systemd_required_services_list_auto + matrix_appservice_webhooks_systemd_required_services_list_custom }}"
matrix_appservice_webhooks_systemd_required_services_list_default : [ 'docker.service' ]
matrix_appservice_webhooks_systemd_required_services_list_auto : [ ]
matrix_appservice_webhooks_systemd_required_services_list_custom : [ ]
2020-01-09 17:00:03 +01:00
# List of systemd services that matrix-appservice-webhooks.service wants
matrix_appservice_webhooks_systemd_wanted_services_list : [ ]
2024-01-07 11:48:30 +01:00
matrix_appservice_webhooks_homeserver_media_url : "{{ matrix_server_fqn_matrix }}"
matrix_appservice_webhooks_homeserver_url : ""
matrix_appservice_webhooks_homeserver_domain : "{{ matrix_domain }}"
matrix_appservice_webhooks_appservice_url : 'http://matrix-appservice-webhooks'
2020-01-09 17:00:03 +01:00
matrix_appservice_webhooks_appservice_token : ''
matrix_appservice_webhooks_homeserver_token : ''
matrix_appservice_webhooks_id_token : ''
2020-01-10 12:38:37 +01:00
matrix_appservice_webhooks_api_secret : ''
2020-01-09 17:00:03 +01:00
2020-01-13 17:29:46 +01:00
# Logging information (info and verbose is available) default is: info
2020-01-10 12:40:55 +01:00
matrix_appservice_webhooks_log_level : 'info'
2020-06-03 08:33:28 +02:00
matrix_appservice_webhooks_configuration_yaml : "{{ lookup('template', 'templates/config.yaml.j2') }}"
2020-01-09 17:00:03 +01:00
matrix_appservice_webhooks_configuration_extension_yaml : |
#
2022-07-18 10:22:05 +02:00
matrix_appservice_webhooks_configuration_extension : "{{ matrix_appservice_webhooks_configuration_extension_yaml | from_yaml if matrix_appservice_webhooks_configuration_extension_yaml | from_yaml else {} }}"
2020-01-09 17:00:03 +01:00
2022-07-18 11:28:39 +02:00
matrix_appservice_webhooks_configuration : "{{ matrix_appservice_webhooks_configuration_yaml | from_yaml | combine(matrix_appservice_webhooks_configuration_extension, recursive=True) }}"
2020-01-09 17:00:03 +01:00
matrix_appservice_webhooks_registration_yaml : |
id : "{{ matrix_appservice_webhooks_id_token }}"
hs_token : "{{ matrix_appservice_webhooks_homeserver_token }}"
as_token : "{{ matrix_appservice_webhooks_appservice_token }}"
namespaces :
users :
- exclusive : true
2020-01-15 19:15:42 +01:00
regex : '^@{{ matrix_appservice_webhooks_user_prefix | regex_escape }}.*:{{ matrix_domain | regex_escape }}$'
2020-01-09 17:00:03 +01:00
aliases : [ ]
rooms : [ ]
url : "{{ matrix_appservice_webhooks_appservice_url }}:{{ matrix_appservice_webhooks_matrix_port }}"
sender_localpart : _webhook
rate_limited : false
protocols : null
2022-07-18 10:22:05 +02:00
matrix_appservice_webhooks_registration : "{{ matrix_appservice_webhooks_registration_yaml | from_yaml }}"