Matrix Docker Ansible eploy
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

242 lines
14 KiB

  1. # SPDX-FileCopyrightText: 2022 - 2023 Samuel Meenzen
  2. # SPDX-FileCopyrightText: 2022 - 2024 MDAD project contributors
  3. # SPDX-FileCopyrightText: 2022 - 2025 Slavi Pantaleev
  4. # SPDX-FileCopyrightText: 2023 Nikita Chernyi
  5. # SPDX-FileCopyrightText: 2025 Suguru Hirahara
  6. #
  7. # SPDX-License-Identifier: AGPL-3.0-or-later
  8. ---
  9. # mautrix-discord is a Matrix <-> Discord bridge
  10. # Project source code URL: https://github.com/mautrix/discord
  11. matrix_mautrix_discord_enabled: true
  12. matrix_mautrix_discord_hostname: ""
  13. matrix_mautrix_discord_path_prefix: /
  14. matrix_mautrix_discord_scheme: https
  15. matrix_mautrix_discord_container_image_self_build: false
  16. matrix_mautrix_discord_container_image_self_build_repo: "https://mau.dev/mautrix/discord.git"
  17. matrix_mautrix_discord_container_image_self_build_branch: "{{ 'main' if matrix_mautrix_discord_version == 'latest' else matrix_mautrix_discord_version }}"
  18. # renovate: datasource=docker depName=dock.mau.dev/mautrix/discord
  19. matrix_mautrix_discord_version: v0.7.3
  20. # See: https://mau.dev/mautrix/discord/container_registry
  21. matrix_mautrix_discord_docker_image: "{{ matrix_mautrix_discord_docker_image_registry_prefix }}mautrix/discord:{{ matrix_mautrix_discord_version }}"
  22. matrix_mautrix_discord_docker_image_registry_prefix: "{{ 'localhost/' if matrix_mautrix_discord_container_image_self_build else matrix_mautrix_discord_docker_image_registry_prefix_upstream }}"
  23. matrix_mautrix_discord_docker_image_registry_prefix_upstream: "{{ matrix_mautrix_discord_docker_image_registry_prefix_upstream_default }}"
  24. matrix_mautrix_discord_docker_image_registry_prefix_upstream_default: "dock.mau.dev/"
  25. matrix_mautrix_discord_docker_image_force_pull: "{{ matrix_mautrix_discord_docker_image.endswith(':latest') }}"
  26. matrix_mautrix_discord_base_path: "{{ matrix_base_data_path }}/mautrix-discord"
  27. matrix_mautrix_discord_config_path: "{{ matrix_mautrix_discord_base_path }}/config"
  28. matrix_mautrix_discord_data_path: "{{ matrix_mautrix_discord_base_path }}/data"
  29. matrix_mautrix_discord_docker_src_files_path: "{{ matrix_mautrix_discord_base_path }}/docker-src"
  30. matrix_mautrix_discord_homeserver_address: ""
  31. matrix_mautrix_discord_homeserver_domain: "{{ matrix_domain }}"
  32. matrix_mautrix_discord_appservice_address: "http://matrix-mautrix-discord:8080"
  33. matrix_mautrix_discord_bridge_command_prefix: "!discord"
  34. # Publicly accessible base URL that Discord can use to reach the bridge, used for avatars in relay mode.
  35. # If not set, avatars will not be bridged. Only the /mautrix-discord/avatar/{server}/{id}/{hash} endpoint is used on this address.
  36. # This should not have a trailing slash, the endpoint above will be appended to the provided address.
  37. 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 '' }}"
  38. # A random key used to sign the avatar URLs. The bridge will only accept requests with a valid signature.
  39. matrix_mautrix_discord_bridge_avatar_proxy_key: ''
  40. # Localpart template of MXIDs for Discord users.
  41. # {{ '{{.}}' }} is replaced with the internal ID of the Discord user.
  42. matrix_mautrix_discord_bridge_username_template: "{% raw %}discord_{{.}}{% endraw %}"
  43. # Displayname template for Discord users. This is also used as the room name in DMs if private_chat_portal_meta is enabled.
  44. matrix_mautrix_discord_bridge_displayname_template: "{% raw %}{{or .GlobalName .Username}}{{if .Bot}} (bot){{end}}{% endraw %}"
  45. # Displayname template for Discord channels (bridged as rooms, or spaces when type=4).
  46. matrix_mautrix_discord_bridge_channel_name_template: "{% raw %}{{if or (eq .Type 3) (eq .Type 4)}}{{.Name}}{{else}}#{{.Name}}{{end}}{% endraw %}"
  47. # Displayname template for Discord guilds (bridged as spaces).
  48. matrix_mautrix_discord_bridge_guild_name_template: "{% raw %}{{.Name}}{% endraw %}"
  49. matrix_mautrix_discord_bridge_permissions: |
  50. {{
  51. {'*': 'relay', matrix_mautrix_discord_homeserver_domain: 'user'}
  52. | combine({matrix_admin: 'admin'} if matrix_admin else {})
  53. }}
  54. matrix_mautrix_discord_container_network: ''
  55. matrix_mautrix_discord_container_additional_networks: "{{ matrix_mautrix_discord_container_additional_networks_auto + matrix_mautrix_discord_container_additional_networks_custom }}"
  56. matrix_mautrix_discord_container_additional_networks_auto: []
  57. matrix_mautrix_discord_container_additional_networks_custom: []
  58. # matrix_mautrix_discord_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container.
  59. # See `../templates/labels.j2` for details.
  60. #
  61. # To inject your own other container labels, see `matrix_mautrix_discord_container_labels_additional_labels`.
  62. matrix_mautrix_discord_container_labels_traefik_enabled: true
  63. matrix_mautrix_discord_container_labels_traefik_docker_network: "{{ matrix_mautrix_discord_container_network }}"
  64. matrix_mautrix_discord_container_labels_traefik_hostname: "{{ matrix_mautrix_discord_hostname }}"
  65. # The path prefix must either be `/` or not end with a slash (e.g. `/matrix-alertmanager-receiver`).
  66. matrix_mautrix_discord_container_labels_traefik_path_prefix: "{{ matrix_mautrix_discord_path_prefix }}"
  67. matrix_mautrix_discord_container_labels_traefik_entrypoints: web-secure
  68. matrix_mautrix_discord_container_labels_traefik_tls_certResolver: default # noqa var-naming
  69. # Controls whether labels will be added that expose the bridge's avatar proxy (`/mautrix-discord/avatar/{server}/{id}/{hash}`).
  70. # See: matrix_mautrix_discord_bridge_public_address
  71. matrix_mautrix_discord_container_labels_avatar_proxy_enabled: "{{ matrix_mautrix_discord_bridge_public_address != '' }}"
  72. matrix_mautrix_discord_container_labels_avatar_proxy_hostname: "{{ matrix_mautrix_discord_container_labels_traefik_hostname }}"
  73. 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"
  74. 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 }}`)"
  75. matrix_mautrix_discord_container_labels_avatar_proxy_traefik_priority: 0
  76. matrix_mautrix_discord_container_labels_avatar_proxy_traefik_entrypoints: "{{ matrix_mautrix_discord_container_labels_traefik_entrypoints }}"
  77. matrix_mautrix_discord_container_labels_avatar_proxy_traefik_tls: "{{ matrix_mautrix_discord_container_labels_avatar_proxy_traefik_entrypoints != 'web' }}"
  78. matrix_mautrix_discord_container_labels_avatar_proxy_traefik_tls_certResolver: "{{ matrix_mautrix_discord_container_labels_traefik_tls_certResolver }}" # noqa var-naming
  79. # matrix_mautrix_discord_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file.
  80. # See `../templates/labels.j2` for details.
  81. #
  82. # Example:
  83. # matrix_mautrix_discord_container_labels_additional_labels: |
  84. # my.label=1
  85. # another.label="here"
  86. matrix_mautrix_discord_container_labels_additional_labels: ''
  87. # A list of extra arguments to pass to the container
  88. matrix_mautrix_discord_container_extra_arguments: []
  89. # List of systemd services that matrix-mautrix-discord.service depends on.
  90. 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 }}"
  91. matrix_mautrix_discord_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
  92. matrix_mautrix_discord_systemd_required_services_list_auto: []
  93. matrix_mautrix_discord_systemd_required_services_list_custom: []
  94. # List of systemd services that matrix-mautrix-discord.service wants
  95. matrix_mautrix_discord_systemd_wanted_services_list: []
  96. matrix_mautrix_discord_appservice_token: ''
  97. matrix_mautrix_discord_homeserver_token: ''
  98. matrix_mautrix_discord_appservice_bot_username: discordbot
  99. matrix_mautrix_discord_appservice_bot_displayname: Discord bridge bot
  100. matrix_mautrix_discord_appservice_bot_avatar: mxc://maunium.net/nIdEykemnwdisvHbpxflpDlC
  101. matrix_mautrix_discord_provisioning_shared_secret: disable
  102. # Minimum severity of journal log messages.
  103. # Valid values: fatal, error, warn, info, debug, trace
  104. matrix_mautrix_discord_logging_level: 'warn'
  105. # Whether or not created rooms should have federation enabled.
  106. # If false, created portal rooms will never be federated.
  107. matrix_mautrix_discord_federate_rooms: true
  108. # Database-related configuration fields.
  109. #
  110. # To use SQLite, stick to these defaults.
  111. #
  112. # To use Postgres:
  113. # - change the engine (`matrix_mautrix_discord_database_engine: 'postgres'`)
  114. # - adjust your database credentials via the `matrix_mautrix_discord_database_*` variables
  115. matrix_mautrix_discord_database_engine: 'sqlite'
  116. matrix_mautrix_discord_sqlite_database_path_local: "{{ matrix_mautrix_discord_data_path }}/mautrix-discord.db"
  117. matrix_mautrix_discord_sqlite_database_path_in_container: "/data/mautrix-discord.db"
  118. matrix_mautrix_discord_database_username: 'matrix_mautrix_discord'
  119. matrix_mautrix_discord_database_password: 'some-password'
  120. matrix_mautrix_discord_database_hostname: ''
  121. matrix_mautrix_discord_database_port: 5432
  122. matrix_mautrix_discord_database_name: 'matrix_mautrix_discord'
  123. matrix_mautrix_discord_database_sslmode: disable
  124. 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 }}'
  125. matrix_mautrix_discord_appservice_database_type: "{{
  126. {
  127. 'sqlite': 'sqlite3',
  128. 'postgres':'postgres',
  129. }[matrix_mautrix_discord_database_engine]
  130. }}"
  131. matrix_mautrix_discord_appservice_database_uri: "{{
  132. {
  133. 'sqlite': matrix_mautrix_discord_sqlite_database_path_in_container,
  134. 'postgres': matrix_mautrix_discord_database_connection_string,
  135. }[matrix_mautrix_discord_database_engine]
  136. }}"
  137. 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) }}"
  138. matrix_mautrix_discord_bridge_login_shared_secret_map_auto: {}
  139. matrix_mautrix_discord_bridge_login_shared_secret_map_custom: {}
  140. # Servers to always allow double puppeting from
  141. 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) }}"
  142. matrix_mautrix_discord_bridge_double_puppet_server_map_default: |-
  143. {{
  144. {}
  145. | combine({
  146. matrix_beeper_linkedin_homeserver_domain: matrix_beeper_linkedin_homeserver_address
  147. })
  148. }}
  149. matrix_mautrix_discord_bridge_double_puppet_server_map_auto: {}
  150. matrix_mautrix_discord_bridge_double_puppet_server_map_custom: {}
  151. # Default mautrix-discord configuration template which covers the generic use case.
  152. # You can customize it by controlling the various variables inside it.
  153. #
  154. # For a more advanced customization, you can extend the default (see `matrix_mautrix_discord_configuration_extension_yaml`)
  155. # or completely replace this variable with your own template.
  156. matrix_mautrix_discord_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"
  157. matrix_mautrix_discord_configuration_extension_yaml: |
  158. # Your custom YAML configuration goes here.
  159. # This configuration extends the default starting configuration (`matrix_mautrix_discord_configuration_yaml`).
  160. #
  161. # You can override individual variables from the default configuration, or introduce new ones.
  162. #
  163. # If you need something more special, you can take full control by
  164. # completely redefining `matrix_mautrix_discord_configuration_yaml`.
  165. 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 {} }}"
  166. # Holds the final configuration (a combination of the default and its extension).
  167. # You most likely don't need to touch this variable. Instead, see `matrix_mautrix_discord_configuration_yaml`.
  168. matrix_mautrix_discord_configuration: "{{ matrix_mautrix_discord_configuration_yaml | from_yaml | combine(matrix_mautrix_discord_configuration_extension, recursive=True) }}"
  169. matrix_mautrix_discord_registration_yaml: |
  170. id: discord
  171. url: {{ matrix_mautrix_discord_appservice_address }}
  172. as_token: "{{ matrix_mautrix_discord_appservice_token }}"
  173. hs_token: "{{ matrix_mautrix_discord_homeserver_token }}"
  174. # See https://github.com/mautrix/signal/issues/43
  175. sender_localpart: _bot_{{ matrix_mautrix_discord_appservice_bot_username }}
  176. rate_limited: false
  177. namespaces:
  178. users:
  179. - regex: '^@discord_[0-9]+:{{ matrix_mautrix_discord_homeserver_domain | regex_escape }}$'
  180. exclusive: true
  181. - exclusive: true
  182. regex: '^@{{ matrix_mautrix_discord_appservice_bot_username | regex_escape }}:{{ matrix_mautrix_discord_homeserver_domain | regex_escape }}$'
  183. de.sorunome.msc2409.push_ephemeral: true
  184. receive_ephemeral: true
  185. matrix_mautrix_discord_registration: "{{ matrix_mautrix_discord_registration_yaml | from_yaml }}"
  186. # Enable End-to-bridge encryption
  187. matrix_mautrix_discord_bridge_encryption_allow: "{{ matrix_bridges_encryption_enabled }}"
  188. matrix_mautrix_discord_bridge_encryption_default: "{{ matrix_bridges_encryption_default }}"
  189. matrix_mautrix_discord_bridge_encryption_require: false
  190. matrix_mautrix_discord_bridge_encryption_appservice: false
  191. matrix_mautrix_discord_bridge_encryption_plaintext_mentions: false
  192. matrix_mautrix_discord_bridge_encryption_key_sharing_allow: "{{ matrix_mautrix_discord_bridge_encryption_allow }}"
  193. # On Conduit versions before 0.5.0 this option prevented users from joining spaces created by the bridge.
  194. # Setting this to false fixed the issue.
  195. matrix_mautrix_discord_bridge_restricted_rooms: true