--- # mautrix-discord is a Matrix <-> Discord bridge # Project source code URL: https://github.com/mautrix/discord matrix_mautrix_discord_enabled: true matrix_mautrix_discord_hostname: "" matrix_mautrix_discord_path_prefix: / matrix_mautrix_discord_scheme: https matrix_mautrix_discord_container_image_self_build: false matrix_mautrix_discord_container_image_self_build_repo: "https://mau.dev/mautrix/discord.git" matrix_mautrix_discord_container_image_self_build_branch: "{{ 'main' if matrix_mautrix_discord_version == 'latest' else matrix_mautrix_discord_version }}" # renovate: datasource=docker depName=dock.mau.dev/mautrix/discord matrix_mautrix_discord_version: v0.7.2 # See: https://mau.dev/mautrix/discord/container_registry matrix_mautrix_discord_docker_image: "{{ matrix_mautrix_discord_docker_image_name_prefix }}mautrix/discord:{{ matrix_mautrix_discord_version }}" matrix_mautrix_discord_docker_image_name_prefix: "{{ 'localhost/' if matrix_mautrix_discord_container_image_self_build else 'dock.mau.dev/' }}" matrix_mautrix_discord_docker_image_force_pull: "{{ matrix_mautrix_discord_docker_image.endswith(':latest') }}" matrix_mautrix_discord_base_path: "{{ matrix_base_data_path }}/mautrix-discord" matrix_mautrix_discord_config_path: "{{ matrix_mautrix_discord_base_path }}/config" matrix_mautrix_discord_data_path: "{{ matrix_mautrix_discord_base_path }}/data" matrix_mautrix_discord_docker_src_files_path: "{{ matrix_mautrix_discord_base_path }}/docker-src" matrix_mautrix_discord_homeserver_address: "" matrix_mautrix_discord_homeserver_domain: "{{ matrix_domain }}" matrix_mautrix_discord_appservice_address: "http://matrix-mautrix-discord:8080" matrix_mautrix_discord_bridge_command_prefix: "!discord" # Publicly accessible base URL that Discord can use to reach the bridge, used for avatars in relay mode. # If not set, avatars will not be bridged. Only the /mautrix-discord/avatar/{server}/{id}/{hash} endpoint is used on this address. # This should not have a trailing slash, the endpoint above will be appended to the provided address. matrix_mautrix_discord_bridge_public_address: "{{ (matrix_mautrix_discord_scheme + '://' + matrix_mautrix_discord_hostname + (matrix_mautrix_discord_path_prefix if matrix_mautrix_discord_path_prefix != '/' else '')) if matrix_mautrix_discord_hostname else '' }}" # A random key used to sign the avatar URLs. The bridge will only accept requests with a valid signature. matrix_mautrix_discord_bridge_avatar_proxy_key: '' # Localpart template of MXIDs for Discord users. # {{ '{{.}}' }} is replaced with the internal ID of the Discord user. matrix_mautrix_discord_bridge_username_template: "{% raw %}discord_{{.}}{% endraw %}" # Displayname template for Discord users. This is also used as the room name in DMs if private_chat_portal_meta is enabled. matrix_mautrix_discord_bridge_displayname_template: "{% raw %}{{or .GlobalName .Username}}{{if .Bot}} (bot){{end}}{% endraw %}" # Displayname template for Discord channels (bridged as rooms, or spaces when type=4). matrix_mautrix_discord_bridge_channel_name_template: "{% raw %}{{if or (eq .Type 3) (eq .Type 4)}}{{.Name}}{{else}}#{{.Name}}{{end}}{% endraw %}" # Displayname template for Discord guilds (bridged as spaces). matrix_mautrix_discord_bridge_guild_name_template: "{% raw %}{{.Name}}{% endraw %}" matrix_mautrix_discord_bridge_permissions: | {{ {'*': 'relay', matrix_mautrix_discord_homeserver_domain: 'user'} | combine({matrix_admin: 'admin'} if matrix_admin else {}) }} matrix_mautrix_discord_container_network: '' matrix_mautrix_discord_container_additional_networks: "{{ matrix_mautrix_discord_container_additional_networks_auto + matrix_mautrix_discord_container_additional_networks_custom }}" matrix_mautrix_discord_container_additional_networks_auto: [] matrix_mautrix_discord_container_additional_networks_custom: [] # matrix_mautrix_discord_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_mautrix_discord_container_labels_additional_labels`. matrix_mautrix_discord_container_labels_traefik_enabled: true matrix_mautrix_discord_container_labels_traefik_docker_network: "{{ matrix_mautrix_discord_container_network }}" matrix_mautrix_discord_container_labels_traefik_hostname: "{{ matrix_mautrix_discord_hostname }}" # The path prefix must either be `/` or not end with a slash (e.g. `/matrix-alertmanager-receiver`). matrix_mautrix_discord_container_labels_traefik_path_prefix: "{{ matrix_mautrix_discord_path_prefix }}" matrix_mautrix_discord_container_labels_traefik_entrypoints: web-secure matrix_mautrix_discord_container_labels_traefik_tls_certResolver: default # noqa var-naming # Controls whether labels will be added that expose the bridge's avatar proxy (`/mautrix-discord/avatar/{server}/{id}/{hash}`). # See: matrix_mautrix_discord_bridge_public_address matrix_mautrix_discord_container_labels_avatar_proxy_enabled: "{{ matrix_mautrix_discord_bridge_public_address != '' }}" matrix_mautrix_discord_container_labels_avatar_proxy_hostname: "{{ matrix_mautrix_discord_container_labels_traefik_hostname }}" matrix_mautrix_discord_container_labels_avatar_proxy_path_prefix: "{{ matrix_mautrix_discord_container_labels_traefik_path_prefix if matrix_mautrix_discord_container_labels_traefik_path_prefix == '/' else (matrix_mautrix_discord_container_labels_traefik_path_prefix + '/') }}mautrix-discord/avatar" matrix_mautrix_discord_container_labels_avatar_proxy_traefik_rule: "Host(`{{ matrix_mautrix_discord_container_labels_traefik_hostname }}`) && PathPrefix(`{{ matrix_mautrix_discord_container_labels_avatar_proxy_path_prefix }}`)" matrix_mautrix_discord_container_labels_avatar_proxy_traefik_priority: 0 matrix_mautrix_discord_container_labels_avatar_proxy_traefik_entrypoints: "{{ matrix_mautrix_discord_container_labels_traefik_entrypoints }}" matrix_mautrix_discord_container_labels_avatar_proxy_traefik_tls: "{{ matrix_mautrix_discord_container_labels_avatar_proxy_traefik_entrypoints != 'web' }}" matrix_mautrix_discord_container_labels_avatar_proxy_traefik_tls_certResolver: "{{ matrix_mautrix_discord_container_labels_traefik_tls_certResolver }}" # noqa var-naming # matrix_mautrix_discord_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_mautrix_discord_container_labels_additional_labels: | # my.label=1 # another.label="here" matrix_mautrix_discord_container_labels_additional_labels: '' # A list of extra arguments to pass to the container matrix_mautrix_discord_container_extra_arguments: [] # List of systemd services that matrix-mautrix-discord.service depends on. matrix_mautrix_discord_systemd_required_services_list: "{{ matrix_mautrix_discord_systemd_required_services_list_default + matrix_mautrix_discord_systemd_required_services_list_auto + matrix_mautrix_discord_systemd_required_services_list_custom }}" matrix_mautrix_discord_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}" matrix_mautrix_discord_systemd_required_services_list_auto: [] matrix_mautrix_discord_systemd_required_services_list_custom: [] # List of systemd services that matrix-mautrix-discord.service wants matrix_mautrix_discord_systemd_wanted_services_list: [] matrix_mautrix_discord_appservice_token: '' matrix_mautrix_discord_homeserver_token: '' matrix_mautrix_discord_appservice_bot_username: discordbot matrix_mautrix_discord_appservice_bot_displayname: Discord bridge bot matrix_mautrix_discord_appservice_bot_avatar: mxc://maunium.net/nIdEykemnwdisvHbpxflpDlC matrix_mautrix_discord_provisioning_shared_secret: disable # Minimum severity of journal log messages. # Options: debug, info, warn, error, fatal matrix_mautrix_discord_logging_level: 'warn' # Whether or not created rooms should have federation enabled. # If false, created portal rooms will never be federated. matrix_mautrix_discord_federate_rooms: true # Database-related configuration fields. # # To use SQLite, stick to these defaults. # # To use Postgres: # - change the engine (`matrix_mautrix_discord_database_engine: 'postgres'`) # - adjust your database credentials via the `matrix_mautrix_discord_database_*` variables matrix_mautrix_discord_database_engine: 'sqlite' matrix_mautrix_discord_sqlite_database_path_local: "{{ matrix_mautrix_discord_data_path }}/mautrix-discord.db" matrix_mautrix_discord_sqlite_database_path_in_container: "/data/mautrix-discord.db" matrix_mautrix_discord_database_username: 'matrix_mautrix_discord' matrix_mautrix_discord_database_password: 'some-password' matrix_mautrix_discord_database_hostname: '' matrix_mautrix_discord_database_port: 5432 matrix_mautrix_discord_database_name: 'matrix_mautrix_discord' matrix_mautrix_discord_database_sslmode: disable matrix_mautrix_discord_database_connection_string: 'postgresql://{{ matrix_mautrix_discord_database_username }}:{{ matrix_mautrix_discord_database_password }}@{{ matrix_mautrix_discord_database_hostname }}:{{ matrix_mautrix_discord_database_port }}/{{ matrix_mautrix_discord_database_name }}?sslmode={{ matrix_mautrix_discord_database_sslmode }}' matrix_mautrix_discord_appservice_database_type: "{{ { 'sqlite': 'sqlite3', 'postgres':'postgres', }[matrix_mautrix_discord_database_engine] }}" matrix_mautrix_discord_appservice_database_uri: "{{ { 'sqlite': matrix_mautrix_discord_sqlite_database_path_in_container, 'postgres': matrix_mautrix_discord_database_connection_string, }[matrix_mautrix_discord_database_engine] }}" matrix_mautrix_discord_bridge_login_shared_secret_map: "{{ matrix_mautrix_discord_bridge_login_shared_secret_map_auto | combine(matrix_mautrix_discord_bridge_login_shared_secret_map_custom) }}" matrix_mautrix_discord_bridge_login_shared_secret_map_auto: {} matrix_mautrix_discord_bridge_login_shared_secret_map_custom: {} # Servers to always allow double puppeting from matrix_mautrix_discord_bridge_double_puppet_server_map: "{{ matrix_mautrix_discord_bridge_double_puppet_server_map_default | combine(matrix_mautrix_discord_bridge_double_puppet_server_map_auto) | combine(matrix_mautrix_discord_bridge_double_puppet_server_map_custom) }}" matrix_mautrix_discord_bridge_double_puppet_server_map_default: |- {{ {} | combine({ matrix_beeper_linkedin_homeserver_domain: matrix_beeper_linkedin_homeserver_address }) }} matrix_mautrix_discord_bridge_double_puppet_server_map_auto: {} matrix_mautrix_discord_bridge_double_puppet_server_map_custom: {} # Default mautrix-discord 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_mautrix_discord_configuration_extension_yaml`) # or completely replace this variable with your own template. matrix_mautrix_discord_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}" matrix_mautrix_discord_configuration_extension_yaml: | # Your custom YAML configuration goes here. # This configuration extends the default starting configuration (`matrix_mautrix_discord_configuration_yaml`). # # 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_mautrix_discord_configuration_yaml`. matrix_mautrix_discord_configuration_extension: "{{ matrix_mautrix_discord_configuration_extension_yaml | from_yaml if matrix_mautrix_discord_configuration_extension_yaml | from_yaml is mapping else {} }}" # Holds the final configuration (a combination of the default and its extension). # You most likely don't need to touch this variable. Instead, see `matrix_mautrix_discord_configuration_yaml`. matrix_mautrix_discord_configuration: "{{ matrix_mautrix_discord_configuration_yaml | from_yaml | combine(matrix_mautrix_discord_configuration_extension, recursive=True) }}" matrix_mautrix_discord_registration_yaml: | id: discord url: {{ matrix_mautrix_discord_appservice_address }} as_token: "{{ matrix_mautrix_discord_appservice_token }}" hs_token: "{{ matrix_mautrix_discord_homeserver_token }}" # See https://github.com/mautrix/signal/issues/43 sender_localpart: _bot_{{ matrix_mautrix_discord_appservice_bot_username }} rate_limited: false namespaces: users: - regex: '^@discord_[0-9]+:{{ matrix_mautrix_discord_homeserver_domain | regex_escape }}$' exclusive: true - exclusive: true regex: '^@{{ matrix_mautrix_discord_appservice_bot_username | regex_escape }}:{{ matrix_mautrix_discord_homeserver_domain | regex_escape }}$' de.sorunome.msc2409.push_ephemeral: true matrix_mautrix_discord_registration: "{{ matrix_mautrix_discord_registration_yaml | from_yaml }}" # Enable End-to-bridge encryption matrix_mautrix_discord_bridge_encryption_allow: "{{ matrix_bridges_encryption_enabled }}" matrix_mautrix_discord_bridge_encryption_default: "{{ matrix_bridges_encryption_default }}" matrix_mautrix_discord_bridge_encryption_require: false matrix_mautrix_discord_bridge_encryption_appservice: false matrix_mautrix_discord_bridge_encryption_plaintext_mentions: false matrix_mautrix_discord_bridge_encryption_key_sharing_allow: "{{ matrix_mautrix_discord_bridge_encryption_allow }}" # On Conduit versions before 0.5.0 this option prevented users from joining spaces created by the bridge. # Setting this to false fixed the issue. matrix_mautrix_discord_bridge_restricted_rooms: true