5
0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2026-07-19 08:09:36 +00:00

Rename matrix_mautrix_signal_* variables to matrix_bridge_mautrix_signal_*

Part of adopting a uniform naming policy for bridge variables,
where the variable prefix matches the role directory name.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Slavi Pantaleev
2026-07-16 14:54:12 +03:00
parent ca301ffde0
commit bb225546bd
11 changed files with 332 additions and 332 deletions
@@ -2,7 +2,7 @@
# Network-specific config options
network:
# Displayname template for Signal users.
displayname_template: {{ matrix_mautrix_signal_network_displayname_template | to_json }}
displayname_template: {{ matrix_bridge_mautrix_signal_network_displayname_template | to_json }}
# Should avatars from the user's contact list be used? This is not safe on multi-user instances.
use_contact_avatars: false
# Should the bridge request the user's contact list from the phone on startup?
@@ -14,20 +14,20 @@ network:
# Default device name that shows up in the Signal app.
device_name: mautrix-signal
# Avatar image for the Note to Self room.
note_to_self_avatar: {{ matrix_mautrix_signal_network_note_to_self_avatar | to_json }}
note_to_self_avatar: {{ matrix_bridge_mautrix_signal_network_note_to_self_avatar | to_json }}
# Format for generating URLs from location messages for sending to Signal.
# Google Maps: 'https://www.google.com/maps/place/%[1]s,%[2]s'
# OpenStreetMap: 'https://www.openstreetmap.org/?mlat=%[1]s&mlon=%[2]s'
location_format: 'https://www.google.com/maps/place/%[1]s,%[2]s'
# Should polls be sent using unstable MSC3381 event types?
extev_polls: {{ matrix_mautrix_signal_extev_polls | to_json }}
extev_polls: {{ matrix_bridge_mautrix_signal_extev_polls | to_json }}
# Config options that affect the central bridge module.
bridge:
# The prefix for commands. Only required in non-management rooms.
command_prefix: {{ matrix_mautrix_signal_command_prefix | to_json }}
command_prefix: {{ matrix_bridge_mautrix_signal_command_prefix | to_json }}
# Should the bridge create a space for each login containing the rooms that account is in?
personal_filtering_spaces: {{ matrix_mautrix_signal_bridge_personal_filtering_spaces | to_json }}
personal_filtering_spaces: {{ matrix_bridge_mautrix_signal_bridge_personal_filtering_spaces | to_json }}
# Whether the bridge should set names and avatars explicitly for DM portals.
# This is only necessary when using clients that don't support MSC4171.
private_chat_portal_meta: true
@@ -70,10 +70,10 @@ bridge:
relay:
# Whether relay mode should be allowed. If allowed, the set-relay command can be used to turn any
# authenticated user into a relaybot for that chat.
enabled: {{ matrix_mautrix_signal_bridge_relay_enabled | to_json }}
enabled: {{ matrix_bridge_mautrix_signal_bridge_relay_enabled | to_json }}
# Should only admins be allowed to set themselves as relay users?
# If true, non-admins can only set users listed in default_relays as relays in a room.
admin_only: {{ matrix_mautrix_signal_bridge_relay_admin_only | to_json }}
admin_only: {{ matrix_bridge_mautrix_signal_bridge_relay_admin_only | to_json }}
# List of user login IDs which anyone can set as a relay, as long as the relay user is in the room.
default_relays: []
# The formats to use when sending messages via the relaybot.
@@ -111,18 +111,18 @@ bridge:
# * - All Matrix users
# domain - All users on that homeserver
# mxid - Specific user
permissions: {{ matrix_mautrix_signal_bridge_permissions | to_json }}
permissions: {{ matrix_bridge_mautrix_signal_bridge_permissions | to_json }}
# Config for the bridge's database.
database:
# The database type. "sqlite3-fk-wal" and "postgres" are supported.
type: {{ matrix_mautrix_signal_appservice_database_type | to_json }}
type: {{ matrix_bridge_mautrix_signal_appservice_database_type | to_json }}
# The database URI.
# SQLite: A raw file path is supported, but `file:<path>?_txlock=immediate` is recommended.
# https://github.com/mattn/go-sqlite3#connection-string
# Postgres: Connection string. For example, postgres://user:password@host/database?sslmode=disable
# To connect via Unix socket, use something like postgres:///dbname?host=/var/run/postgresql
uri: {{ matrix_mautrix_signal_appservice_database_uri | to_json }}
uri: {{ matrix_bridge_mautrix_signal_appservice_database_uri | to_json }}
# Maximum number of connections.
max_open_conns: 20
max_idle_conns: 2
@@ -136,9 +136,9 @@ homeserver:
# The address that this appservice can use to connect to the homeserver.
# Local addresses without HTTPS are generally recommended when the bridge is running on the same machine,
# but https also works if they run on different machines.
address: {{ matrix_mautrix_signal_homeserver_address | to_json }}
address: {{ matrix_bridge_mautrix_signal_homeserver_address | to_json }}
# The domain of the homeserver (also known as server_name, used for MXIDs, etc).
domain: {{ matrix_mautrix_signal_homeserver_domain | to_json }}
domain: {{ matrix_bridge_mautrix_signal_homeserver_domain | to_json }}
# What software is the homeserver running?
# Standard Matrix homeservers like Synapse, Dendrite and Conduit should just use "standard" here.
@@ -154,7 +154,7 @@ homeserver:
# The bridge will use the appservice as_token to authorize requests.
message_send_checkpoint_endpoint: null
# Does the homeserver support https://github.com/matrix-org/matrix-spec-proposals/pull/2246?
async_media: {{ matrix_mautrix_signal_homeserver_async_media | to_json }}
async_media: {{ matrix_bridge_mautrix_signal_homeserver_async_media | to_json }}
# Should the bridge use a websocket for connecting to the homeserver?
# The server side is currently not documented anywhere and is only implemented by mautrix-wsproxy,
@@ -167,11 +167,11 @@ homeserver:
# Changing these values requires regeneration of the registration (except when noted otherwise)
appservice:
# The address that the homeserver can use to connect to this appservice.
address: {{ matrix_mautrix_signal_appservice_address | to_json }}
address: {{ matrix_bridge_mautrix_signal_appservice_address | to_json }}
# A public address that external services can use to reach this appservice.
# This value doesn't affect the registration file.
public_address: {{ matrix_mautrix_signal_bridge_public_address | to_json }}
public_address: {{ matrix_bridge_mautrix_signal_bridge_public_address | to_json }}
# The hostname and port where this appservice should listen.
# For Docker, you generally have to change the hostname to 0.0.0.0.
@@ -183,7 +183,7 @@ appservice:
# Appservice bot details.
bot:
# Username of the appservice bot.
username: {{ matrix_mautrix_signal_appservice_bot_username | to_json }}
username: {{ matrix_bridge_mautrix_signal_appservice_bot_username | to_json }}
# Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty
# to leave display name/avatar as-is.
displayname: signal bridge bot
@@ -198,8 +198,8 @@ appservice:
async_transactions: false
# Authentication tokens for AS <-> HS communication. Autogenerated; do not modify.
as_token: {{ matrix_mautrix_signal_appservice_token | to_json }}
hs_token: {{ matrix_mautrix_signal_homeserver_token | to_json }}
as_token: {{ matrix_bridge_mautrix_signal_appservice_token | to_json }}
hs_token: {{ matrix_bridge_mautrix_signal_homeserver_token | to_json }}
# Localpart template of MXIDs for remote users.
# {{ '{{.}}' }} is replaced with the internal ID of the Signal user.
@@ -217,7 +217,7 @@ matrix:
sync_direct_chat_list: false
# Whether created rooms should have federation enabled. If false, created portal rooms
# will never be federated. Changing this option requires recreating rooms.
federate_rooms: {{ matrix_mautrix_signal_federate_rooms | to_json }}
federate_rooms: {{ matrix_bridge_mautrix_signal_federate_rooms | to_json }}
# Settings for provisioning API
provisioning:
@@ -225,7 +225,7 @@ provisioning:
prefix: /_matrix/provision
# Shared secret for authentication. If set to "generate" or null, a random secret will be generated,
# or if set to "disable", the provisioning API will be disabled.
shared_secret: {{ matrix_mautrix_signal_provisioning_shared_secret | to_json }}
shared_secret: {{ matrix_bridge_mautrix_signal_provisioning_shared_secret | to_json }}
# Whether to allow provisioning API requests to be authed using Matrix access tokens.
# This follows the same rules as double puppeting to determine which server to contact to check the token,
# which means that by default, it only works for users on the same server as the bridge.
@@ -241,7 +241,7 @@ public_media:
enabled: false
# A key for signing public media URLs.
# If set to "generate", a random key will be generated.
signing_key: {{ matrix_mautrix_signal_public_media_signing_key | to_json }}
signing_key: {{ matrix_bridge_mautrix_signal_public_media_signing_key | to_json }}
# Number of seconds that public media URLs are valid for.
# If set to 0, URLs will never expire.
expiry: 0
@@ -275,18 +275,18 @@ direct_media:
# See https://docs.mau.fi/bridges/general/backfill.html for more details.
backfill:
# Whether to do backfilling at all.
enabled: {{ matrix_mautrix_signal_backfill_enabled | to_json }}
enabled: {{ matrix_bridge_mautrix_signal_backfill_enabled | to_json }}
# Maximum number of messages to backfill in empty rooms.
max_initial_messages: {{ matrix_mautrix_signal_backfill_max_initial_messages | to_json }}
max_initial_messages: {{ matrix_bridge_mautrix_signal_backfill_max_initial_messages | to_json }}
# Maximum number of missed messages to backfill after bridge restarts.
max_catchup_messages: {{ matrix_mautrix_signal_backfill_max_catchup_messages | to_json }}
max_catchup_messages: {{ matrix_bridge_mautrix_signal_backfill_max_catchup_messages | to_json }}
# If a backfilled chat is older than this number of hours,
# mark it as read even if it's unread on the remote network.
unread_hours_threshold: {{ matrix_mautrix_signal_backfill_unread_hours_threshold| to_json }}
unread_hours_threshold: {{ matrix_bridge_mautrix_signal_backfill_unread_hours_threshold| to_json }}
# Settings for backfilling threads within other backfills.
threads:
# Maximum number of messages to backfill in a new thread.
max_initial_messages: {{ matrix_mautrix_signal_backfill_threads_max_initial_messages | to_json }}
max_initial_messages: {{ matrix_bridge_mautrix_signal_backfill_threads_max_initial_messages | to_json }}
# Settings for the backwards backfill queue. This only applies when connecting to
# Beeper as standard Matrix servers don't support inserting messages into history.
queue:
@@ -314,16 +314,16 @@ double_puppet:
allow_discovery: false
# Shared secrets for automatic double puppeting.
# See https://docs.mau.fi/bridges/general/double-puppeting.html for instructions.
secrets: {{ matrix_mautrix_signal_double_puppet_secrets | to_json }}
secrets: {{ matrix_bridge_mautrix_signal_double_puppet_secrets | to_json }}
# End-to-bridge encryption support options.
#
# See https://docs.mau.fi/bridges/general/end-to-bridge-encryption.html for more info.
encryption:
# Whether to enable encryption at all. If false, the bridge will not function in encrypted rooms.
allow: {{ matrix_mautrix_signal_bridge_encryption_allow | to_json }}
allow: {{ matrix_bridge_mautrix_signal_bridge_encryption_allow | to_json }}
# Whether to force-enable encryption in all bridged rooms.
default: {{ matrix_mautrix_signal_bridge_encryption_default | to_json }}
default: {{ matrix_bridge_mautrix_signal_bridge_encryption_default | to_json }}
# Whether to require all messages to be encrypted and drop any unencrypted messages.
require: false
# Whether to use MSC2409/MSC3202 instead of /sync long polling for receiving encryption-related data.
@@ -333,13 +333,13 @@ encryption:
# Requires the homeserver to support MSC4190 and the device masquerading parts of MSC3202.
# Only relevant when using end-to-bridge encryption, required when using encryption with next-gen auth (MSC3861).
# Changing this option requires updating the appservice registration file.
msc4190: {{ matrix_mautrix_signal_msc4190_enabled | to_json }}
msc4190: {{ matrix_bridge_mautrix_signal_msc4190_enabled | to_json }}
# Whether to enable self-signing for bridges (Only the bridge bot uses this for now)
# Requires msc4190 to replace keys on reset
self_sign: {{ matrix_mautrix_signal_self_sign_enabled | to_json }}
self_sign: {{ matrix_bridge_mautrix_signal_self_sign_enabled | to_json }}
# Enable key sharing? If enabled, key requests for rooms where users are in will be fulfilled.
# You must use a client that supports requesting keys from other users to use this feature.
allow_key_sharing: {{ matrix_mautrix_signal_bridge_encryption_key_sharing_allow | to_json }}
allow_key_sharing: {{ matrix_bridge_mautrix_signal_bridge_encryption_key_sharing_allow | to_json }}
# Pickle key for encrypting encryption keys in the bridge database.
# If set to generate, a random key will be generated.
pickle_key: mautrix.bridge.e2ee
@@ -401,7 +401,7 @@ encryption:
# Logging config. See https://github.com/tulir/zeroconfig for details.
logging:
min_level: {{ matrix_mautrix_signal_logging_level | to_json }}
min_level: {{ matrix_bridge_mautrix_signal_logging_level | to_json }}
writers:
- type: stdout
format: pretty-colored
@@ -4,39 +4,39 @@ SPDX-FileCopyrightText: 2024 Slavi Pantaleev
SPDX-License-Identifier: AGPL-3.0-or-later
#}
{% if matrix_mautrix_signal_container_labels_traefik_enabled %}
{% if matrix_bridge_mautrix_signal_container_labels_traefik_enabled %}
traefik.enable=true
{% if matrix_mautrix_signal_container_labels_traefik_docker_network %}
traefik.docker.network={{ matrix_mautrix_signal_container_labels_traefik_docker_network }}
{% if matrix_bridge_mautrix_signal_container_labels_traefik_docker_network %}
traefik.docker.network={{ matrix_bridge_mautrix_signal_container_labels_traefik_docker_network }}
{% endif %}
traefik.http.services.matrix-mautrix-signal-metrics.loadbalancer.server.port=8000
{% if matrix_mautrix_signal_container_labels_metrics_enabled %}
{% if matrix_bridge_mautrix_signal_container_labels_metrics_enabled %}
############################################################
# #
# Metrics #
# #
############################################################
{% if matrix_mautrix_signal_container_labels_metrics_middleware_basic_auth_enabled %}
traefik.http.middlewares.matrix-mautrix-signal-metrics-basic-auth.basicauth.users={{ matrix_mautrix_signal_container_labels_metrics_middleware_basic_auth_users }}
{% if matrix_bridge_mautrix_signal_container_labels_metrics_middleware_basic_auth_enabled %}
traefik.http.middlewares.matrix-mautrix-signal-metrics-basic-auth.basicauth.users={{ matrix_bridge_mautrix_signal_container_labels_metrics_middleware_basic_auth_users }}
traefik.http.routers.matrix-mautrix-signal-metrics.middlewares=matrix-mautrix-signal-metrics-basic-auth
{% endif %}
traefik.http.routers.matrix-mautrix-signal-metrics.rule={{ matrix_mautrix_signal_container_labels_metrics_traefik_rule }}
traefik.http.routers.matrix-mautrix-signal-metrics.rule={{ matrix_bridge_mautrix_signal_container_labels_metrics_traefik_rule }}
{% if matrix_mautrix_signal_container_labels_metrics_traefik_priority | int > 0 %}
traefik.http.routers.matrix-mautrix-signal-metrics.priority={{ matrix_mautrix_signal_container_labels_metrics_traefik_priority }}
{% if matrix_bridge_mautrix_signal_container_labels_metrics_traefik_priority | int > 0 %}
traefik.http.routers.matrix-mautrix-signal-metrics.priority={{ matrix_bridge_mautrix_signal_container_labels_metrics_traefik_priority }}
{% endif %}
traefik.http.routers.matrix-mautrix-signal-metrics.service=matrix-mautrix-signal-metrics
traefik.http.routers.matrix-mautrix-signal-metrics.entrypoints={{ matrix_mautrix_signal_container_labels_metrics_traefik_entrypoints }}
traefik.http.routers.matrix-mautrix-signal-metrics.entrypoints={{ matrix_bridge_mautrix_signal_container_labels_metrics_traefik_entrypoints }}
traefik.http.routers.matrix-mautrix-signal-metrics.tls={{ matrix_mautrix_signal_container_labels_metrics_traefik_tls | to_json }}
{% if matrix_mautrix_signal_container_labels_metrics_traefik_tls %}
traefik.http.routers.matrix-mautrix-signal-metrics.tls.certResolver={{ matrix_mautrix_signal_container_labels_metrics_traefik_tls_certResolver }}
traefik.http.routers.matrix-mautrix-signal-metrics.tls={{ matrix_bridge_mautrix_signal_container_labels_metrics_traefik_tls | to_json }}
{% if matrix_bridge_mautrix_signal_container_labels_metrics_traefik_tls %}
traefik.http.routers.matrix-mautrix-signal-metrics.tls.certResolver={{ matrix_bridge_mautrix_signal_container_labels_metrics_traefik_tls_certResolver }}
{% endif %}
############################################################
@@ -46,7 +46,7 @@ traefik.http.routers.matrix-mautrix-signal-metrics.tls.certResolver={{ matrix_ma
############################################################
{% endif %}
{% if matrix_mautrix_signal_container_labels_exposure_enabled %}
{% if matrix_bridge_mautrix_signal_container_labels_exposure_enabled %}
############################################################
# #
# Bridge API exposure #
@@ -55,21 +55,21 @@ traefik.http.routers.matrix-mautrix-signal-metrics.tls.certResolver={{ matrix_ma
traefik.http.services.matrix-mautrix-signal-exposure.loadbalancer.server.port=8080
traefik.http.middlewares.matrix-mautrix-signal-exposure-strip-prefix.stripprefix.prefixes={{ matrix_mautrix_signal_exposure_path_prefix }}
traefik.http.middlewares.matrix-mautrix-signal-exposure-strip-prefix.stripprefix.prefixes={{ matrix_bridge_mautrix_signal_exposure_path_prefix }}
traefik.http.routers.matrix-mautrix-signal-exposure.middlewares=matrix-mautrix-signal-exposure-strip-prefix
traefik.http.routers.matrix-mautrix-signal-exposure.rule={{ matrix_mautrix_signal_container_labels_exposure_traefik_rule }}
traefik.http.routers.matrix-mautrix-signal-exposure.rule={{ matrix_bridge_mautrix_signal_container_labels_exposure_traefik_rule }}
{% if matrix_mautrix_signal_container_labels_exposure_traefik_priority | int > 0 %}
traefik.http.routers.matrix-mautrix-signal-exposure.priority={{ matrix_mautrix_signal_container_labels_exposure_traefik_priority }}
{% if matrix_bridge_mautrix_signal_container_labels_exposure_traefik_priority | int > 0 %}
traefik.http.routers.matrix-mautrix-signal-exposure.priority={{ matrix_bridge_mautrix_signal_container_labels_exposure_traefik_priority }}
{% endif %}
traefik.http.routers.matrix-mautrix-signal-exposure.service=matrix-mautrix-signal-exposure
traefik.http.routers.matrix-mautrix-signal-exposure.entrypoints={{ matrix_mautrix_signal_container_labels_exposure_traefik_entrypoints }}
traefik.http.routers.matrix-mautrix-signal-exposure.entrypoints={{ matrix_bridge_mautrix_signal_container_labels_exposure_traefik_entrypoints }}
traefik.http.routers.matrix-mautrix-signal-exposure.tls={{ matrix_mautrix_signal_container_labels_exposure_traefik_tls | to_json }}
{% if matrix_mautrix_signal_container_labels_exposure_traefik_tls %}
traefik.http.routers.matrix-mautrix-signal-exposure.tls.certResolver={{ matrix_mautrix_signal_container_labels_exposure_traefik_tls_certResolver }}
traefik.http.routers.matrix-mautrix-signal-exposure.tls={{ matrix_bridge_mautrix_signal_container_labels_exposure_traefik_tls | to_json }}
{% if matrix_bridge_mautrix_signal_container_labels_exposure_traefik_tls %}
traefik.http.routers.matrix-mautrix-signal-exposure.tls.certResolver={{ matrix_bridge_mautrix_signal_container_labels_exposure_traefik_tls_certResolver }}
{% endif %}
############################################################
@@ -82,4 +82,4 @@ traefik.http.routers.matrix-mautrix-signal-exposure.tls.certResolver={{ matrix_m
{% endif %}
{{ matrix_mautrix_signal_container_labels_additional_labels }}
{{ matrix_bridge_mautrix_signal_container_labels_additional_labels }}
@@ -1,11 +1,11 @@
#jinja2: lstrip_blocks: True
[Unit]
Description=Matrix Mautrix Signal bridge
{% for service in matrix_mautrix_signal_systemd_required_services_list %}
{% for service in matrix_bridge_mautrix_signal_systemd_required_services_list %}
Requires={{ service }}
After={{ service }}
{% endfor %}
{% for service in matrix_mautrix_signal_systemd_wanted_services_list %}
{% for service in matrix_bridge_mautrix_signal_systemd_wanted_services_list %}
Wants={{ service }}
{% endfor %}
DefaultDependencies=no
@@ -22,19 +22,19 @@ ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} create \
--log-driver=none \
--user={{ matrix_user_uid }}:{{ matrix_user_gid }} \
--cap-drop=ALL \
--network={{ matrix_mautrix_signal_container_network }} \
--mount type=bind,src={{ matrix_mautrix_signal_config_path }},dst=/config,ro \
--mount type=bind,src={{ matrix_mautrix_signal_data_path }},dst=/data \
--label-file={{ matrix_mautrix_signal_base_path }}/labels \
--network={{ matrix_bridge_mautrix_signal_container_network }} \
--mount type=bind,src={{ matrix_bridge_mautrix_signal_config_path }},dst=/config,ro \
--mount type=bind,src={{ matrix_bridge_mautrix_signal_data_path }},dst=/data \
--label-file={{ matrix_bridge_mautrix_signal_base_path }}/labels \
--workdir=/data \
{% for arg in matrix_mautrix_signal_container_extra_arguments %}
{% for arg in matrix_bridge_mautrix_signal_container_extra_arguments %}
{{ arg }} \
{% endfor %}
{{ matrix_mautrix_signal_container_image }} \
{{ matrix_bridge_mautrix_signal_container_image }} \
/usr/bin/mautrix-signal -c /config/config.yaml -r /config/registration.yaml --no-update
{% if matrix_mautrix_signal_container_network != 'host' %}
{% for network in matrix_mautrix_signal_container_additional_networks %}
{% if matrix_bridge_mautrix_signal_container_network != 'host' %}
{% for network in matrix_bridge_mautrix_signal_container_additional_networks %}
ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} network connect {{ network }} matrix-mautrix-signal
{% endfor %}
{% endif %}