Matrix Docker Ansible eploy
25개 이상의 토픽을 선택하실 수 없습니다. Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

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