2022-02-05 22:32:54 +02:00
---
2020-10-25 22:01:25 +02:00
# mautrix-signal is a Matrix <-> Signal bridge
2021-08-09 11:19:12 +02:00
# See: https://github.com/mautrix/signal
2020-10-22 23:29:34 +02:00
2020-10-24 12:15:03 +02:00
matrix_mautrix_signal_enabled : true
2020-10-22 23:29:34 +02:00
2022-01-07 12:18:45 +02:00
matrix_mautrix_signal_container_image_self_build : false
2021-08-09 11:19:12 +02:00
matrix_mautrix_signal_docker_repo : "https://mau.dev/mautrix/signal.git"
2021-07-14 03:04:15 +02:00
matrix_mautrix_signal_docker_src_files_path : "{{ matrix_base_data_path }}/mautrix-signal/docker-src"
2022-02-22 13:33:55 +02:00
matrix_mautrix_signal_version : v0.2.3
matrix_mautrix_signal_daemon_version : 0.17 .0
2021-08-09 11:19:12 +02:00
# See: https://mau.dev/mautrix/signal/container_registry
matrix_mautrix_signal_docker_image : "dock.mau.dev/mautrix/signal:{{ matrix_mautrix_signal_version }}"
2020-10-22 23:29:34 +02:00
matrix_mautrix_signal_docker_image_force_pull : "{{ matrix_mautrix_signal_docker_image.endswith(':latest') }}"
2022-01-07 12:18:45 +02:00
matrix_mautrix_signal_daemon_container_image_self_build : false
2021-07-16 13:27:36 +02:00
matrix_mautrix_signal_daemon_docker_repo : "https://mau.dev/maunium/signald.git"
matrix_mautrix_signal_daemon_docker_src_files_path : "{{ matrix_base_data_path }}/mautrix-signald/docker-src"
2021-12-11 18:16:41 +02:00
matrix_mautrix_signal_daemon_docker_image : "docker.io/signald/signald:{{ matrix_mautrix_signal_daemon_version }}"
2020-10-22 23:29:34 +02:00
matrix_mautrix_signal_daemon_docker_image_force_pull : "{{ matrix_mautrix_signal_daemon_docker_image.endswith(':latest') }}"
2020-10-25 21:46:57 +02:00
matrix_mautrix_signal_base_path : "{{ matrix_base_data_path }}/mautrix-signal"
matrix_mautrix_signal_config_path : "{{ matrix_mautrix_signal_base_path }}/bridge"
2020-10-22 23:29:34 +02:00
matrix_mautrix_signal_daemon_path : "{{ matrix_mautrix_signal_base_path }}/signald"
2020-10-25 21:45:24 +02:00
matrix_mautrix_signal_homeserver_address : ''
matrix_mautrix_signal_homeserver_domain : ''
2020-10-22 23:29:34 +02:00
matrix_mautrix_signal_appservice_address : 'http://matrix-mautrix-signal:29328'
2020-10-25 22:01:25 +02:00
# Controls whether the matrix-mautrix-signal container exposes its port (tcp/29328 in the container).
2020-10-22 23:29:34 +02:00
#
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:9006"), or empty string to not expose.
matrix_mautrix_signal_container_http_host_bind_port : ''
# A list of extra arguments to pass to the container
matrix_mautrix_signal_container_extra_arguments : [ ]
# List of systemd services that matrix-mautrix-signal.service depends on.
2021-01-03 07:46:55 +02:00
matrix_mautrix_signal_systemd_required_services_list :
2020-10-25 21:46:32 +02:00
- 'docker.service'
- 'matrix-mautrix-signal-daemon.service'
2020-10-22 23:29:34 +02:00
2020-10-24 12:15:03 +02:00
# List of systemd services that matrix-mautrix-signal.service wants
2020-10-22 23:29:34 +02:00
matrix_mautrix_signal_systemd_wanted_services_list : [ ]
2021-01-03 08:16:49 +02:00
# List of systemd services that matrix-mautrix-signal-daemon.service depends on.
matrix_mautrix_signal_daemon_systemd_required_services_list : [ 'docker.service' ]
# List of systemd services that matrix-mautrix-signal-daemon.service wants
matrix_mautrix_signal_daemon_systemd_wanted_services_list : [ ]
2020-10-22 23:29:34 +02:00
matrix_mautrix_signal_appservice_token : ''
matrix_mautrix_signal_homeserver_token : ''
2021-01-27 15:43:33 +02:00
matrix_mautrix_signal_appservice_bot_username : signalbot
2021-01-02 01:39:11 +02:00
# Database-related configuration fields
#
2021-01-03 07:46:55 +02:00
# This bridge only supports postgres.
2021-01-02 01:39:11 +02:00
#
matrix_mautrix_signal_database_engine : 'postgres'
matrix_mautrix_signal_database_username : 'matrix_mautrix_signal'
matrix_mautrix_signal_database_password : 'some-password'
matrix_mautrix_signal_database_hostname : 'matrix-postgres'
matrix_mautrix_signal_database_port : 5432
matrix_mautrix_signal_database_name : 'matrix_mautrix_signal'
2020-10-22 23:29:34 +02:00
2021-01-03 07:46:55 +02:00
matrix_mautrix_signal_database_connection_string : 'postgres://{{ matrix_mautrix_signal_database_username }}:{{ matrix_mautrix_signal_database_password }}@{{ matrix_mautrix_signal_database_hostname }}:{{ matrix_mautrix_signal_database_port }}/{{ matrix_mautrix_signal_database_name }}'
2020-10-22 23:29:34 +02:00
2021-01-03 07:46:55 +02:00
matrix_mautrix_signal_appservice_database : "{{
2021-08-15 08:42:21 +02:00
{
'postgres' : matrix_mautrix_signal_database_connection_string,
}[ matrix_mautrix_signal_database_engine]
2021-01-03 07:46:55 +02:00
}}"
2020-10-22 23:29:34 +02:00
# Can be set to enable automatic double-puppeting via Shared Secret Auth (https://github.com/devture/matrix-synapse-shared-secret-auth).
matrix_mautrix_signal_login_shared_secret : ''
2021-08-13 17:48:05 +02:00
# Enable bridge relay bot functionality
matrix_mautrix_signal_relaybot_enabled : false
2021-08-16 18:24:12 +02:00
# Permissions for using the bridge.
# Permitted values:
# relay - Allowed to be relayed through the bridge, no access to commands.
# user - Use the bridge with puppeting.
# admin - Use and administrate the bridge.
# Permitted keys:
# * - All Matrix users
# domain - All users on that homeserver
# mxid - Specific user
matrix_mautrix_signal_bridge_permissions : |
'*' : relay
'{{ matrix_mautrix_signal_homeserver_domain }}' : user
2020-10-22 23:29:34 +02:00
# Default configuration template which covers the generic use case.
# You can customize it by controlling the various variables inside it.
#
2020-10-25 22:01:25 +02:00
# For a more advanced customization, you can extend the default (see `matrix_mautrix_signal_configuration_extension_yaml`)
2020-10-22 23:29:34 +02:00
# or completely replace this variable with your own template.
matrix_mautrix_signal_configuration_yaml : "{{ lookup('template', 'templates/config.yaml.j2') }}"
matrix_mautrix_signal_configuration_extension_yaml : |
# Your custom YAML configuration goes here.
2020-10-25 22:01:25 +02:00
# This configuration extends the default starting configuration (`matrix_mautrix_signal_configuration_yaml`).
2020-10-22 23:29:34 +02:00
#
# 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
2020-10-25 22:01:25 +02:00
# completely redefining `matrix_mautrix_signal_configuration_yaml`.
2020-10-22 23:29:34 +02:00
matrix_mautrix_signal_configuration_extension : "{{ matrix_mautrix_signal_configuration_extension_yaml|from_yaml if matrix_mautrix_signal_configuration_extension_yaml|from_yaml is mapping else {} }}"
# Holds the final configuration (a combination of the default and its extension).
2020-10-25 22:01:25 +02:00
# You most likely don't need to touch this variable. Instead, see `matrix_mautrix_signal_configuration_yaml`.
2020-10-22 23:29:34 +02:00
matrix_mautrix_signal_configuration : "{{ matrix_mautrix_signal_configuration_yaml|from_yaml|combine(matrix_mautrix_signal_configuration_extension, recursive=True) }}"
2020-10-25 21:16:24 +02:00
matrix_mautrix_signal_registration_yaml : "{{ lookup('template', 'templates/registration.yaml.j2') }}"
2020-10-22 23:29:34 +02:00
matrix_mautrix_signal_registration : "{{ matrix_mautrix_signal_registration_yaml|from_yaml }}"
2021-01-02 01:55:55 +02:00
2021-01-03 07:46:55 +02:00
matrix_mautrix_signal_log_level : 'DEBUG'