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.
 
 
 

319 lines
20 KiB

  1. # SPDX-FileCopyrightText: 2024 - 2025 Slavi Pantaleev
  2. # SPDX-FileCopyrightText: 2024 MDAD project contributors
  3. # SPDX-FileCopyrightText: 2024 Nikita Chernyi
  4. # SPDX-FileCopyrightText: 2024 Suguru Hirahara
  5. #
  6. # SPDX-License-Identifier: AGPL-3.0-or-later
  7. ---
  8. # mautrix-meta is a Matrix <-> Facebook/Messenger/Instagram bridge
  9. # Project source code URL: https://github.com/mautrix/meta
  10. #
  11. # WARNING: this bridge role is used for both Messenger and Instagram.
  12. # This Messenger role acts as a source and auto-generates matrix-bridge-mautrix-meta-instagram
  13. # thanks to `just rebuild-mautrix-meta-instagram` (`bin/rebuild-mautrix-meta-instagram.sh`).
  14. # If you'd like to make changes to the Instagram role, consider making your changes to the Messenger role instead.
  15. matrix_bridge_mautrix_meta_messenger_enabled: true
  16. matrix_bridge_mautrix_meta_messenger_identifier: matrix-mautrix-meta-messenger
  17. # renovate: datasource=docker depName=dock.mau.dev/mautrix/meta
  18. matrix_bridge_mautrix_meta_messenger_version: v0.2607.0
  19. matrix_bridge_mautrix_meta_messenger_base_path: "{{ matrix_base_data_path }}/mautrix-meta-messenger"
  20. matrix_bridge_mautrix_meta_messenger_config_path: "{{ matrix_bridge_mautrix_meta_messenger_base_path }}/config"
  21. matrix_bridge_mautrix_meta_messenger_data_path: "{{ matrix_bridge_mautrix_meta_messenger_base_path }}/data"
  22. matrix_bridge_mautrix_meta_messenger_container_src_files_path: "{{ matrix_bridge_mautrix_meta_messenger_base_path }}/container-src"
  23. matrix_bridge_mautrix_meta_messenger_container_image_self_build: false
  24. matrix_bridge_mautrix_meta_messenger_container_image_self_build_repo: "https://github.com/mautrix/meta.git"
  25. matrix_bridge_mautrix_meta_messenger_container_image: "{{ matrix_bridge_mautrix_meta_messenger_container_image_registry_prefix }}mautrix/meta:{{ matrix_bridge_mautrix_meta_messenger_container_image_tag }}"
  26. matrix_bridge_mautrix_meta_messenger_container_image_registry_prefix: "{{ 'localhost/' if matrix_bridge_mautrix_meta_messenger_container_image_self_build else matrix_bridge_mautrix_meta_messenger_container_image_registry_prefix_upstream }}"
  27. matrix_bridge_mautrix_meta_messenger_container_image_registry_prefix_upstream: "{{ matrix_bridge_mautrix_meta_messenger_container_image_registry_prefix_upstream_default }}"
  28. matrix_bridge_mautrix_meta_messenger_container_image_registry_prefix_upstream_default: "dock.mau.dev/"
  29. # Prebuilt container images for specific commit hashes are tagged with an architecture suffix (e.g. `HASH-amd64`).
  30. matrix_bridge_mautrix_meta_messenger_container_image_tag: "{{ matrix_bridge_mautrix_meta_messenger_version }}{{ ('-' ~ matrix_architecture) if (matrix_bridge_mautrix_meta_messenger_version | length == 40) else '' }}"
  31. matrix_bridge_mautrix_meta_messenger_container_network: ""
  32. matrix_bridge_mautrix_meta_messenger_container_additional_networks: "{{ matrix_bridge_mautrix_meta_messenger_container_additional_networks_auto + matrix_bridge_mautrix_meta_messenger_container_additional_networks_custom }}"
  33. matrix_bridge_mautrix_meta_messenger_container_additional_networks_auto: []
  34. matrix_bridge_mautrix_meta_messenger_container_additional_networks_custom: []
  35. # matrix_bridge_mautrix_meta_messenger_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container.
  36. # See `../templates/labels.j2` for details.
  37. #
  38. # To inject your own other container labels, see `matrix_bridge_mautrix_meta_messenger_container_labels_additional_labels`.
  39. matrix_bridge_mautrix_meta_messenger_container_labels_traefik_enabled: true
  40. matrix_bridge_mautrix_meta_messenger_container_labels_traefik_docker_network: "{{ matrix_bridge_mautrix_meta_messenger_container_network }}"
  41. matrix_bridge_mautrix_meta_messenger_container_labels_traefik_entrypoints: web-secure
  42. matrix_bridge_mautrix_meta_messenger_container_labels_traefik_tls_certResolver: default # noqa var-naming
  43. # Controls whether labels will be added that expose mautrix-meta-messenger's HTTP API
  44. # (used by tools like mautrix-manager for bridge login) at `https://<hostname><path_prefix>`.
  45. matrix_bridge_mautrix_meta_messenger_container_labels_exposure_enabled: "{{ matrix_bridge_mautrix_meta_messenger_exposure_enabled }}"
  46. matrix_bridge_mautrix_meta_messenger_container_labels_exposure_traefik_rule: "Host(`{{ matrix_bridge_mautrix_meta_messenger_exposure_hostname }}`) && PathPrefix(`{{ matrix_bridge_mautrix_meta_messenger_exposure_path_prefix }}`)"
  47. matrix_bridge_mautrix_meta_messenger_container_labels_exposure_traefik_priority: 0
  48. matrix_bridge_mautrix_meta_messenger_container_labels_exposure_traefik_entrypoints: "{{ matrix_bridge_mautrix_meta_messenger_container_labels_traefik_entrypoints }}"
  49. matrix_bridge_mautrix_meta_messenger_container_labels_exposure_traefik_tls: "{{ matrix_bridge_mautrix_meta_messenger_container_labels_exposure_traefik_entrypoints != 'web' }}"
  50. matrix_bridge_mautrix_meta_messenger_container_labels_exposure_traefik_tls_certResolver: "{{ matrix_bridge_mautrix_meta_messenger_container_labels_traefik_tls_certResolver }}" # noqa var-naming
  51. # matrix_bridge_mautrix_meta_messenger_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file.
  52. # See `../templates/labels.j2` for details.
  53. #
  54. # Example:
  55. # matrix_bridge_mautrix_meta_messenger_container_labels_additional_labels: |
  56. # my.label=1
  57. # another.label="here"
  58. matrix_bridge_mautrix_meta_messenger_container_labels_additional_labels: ''
  59. # A list of extra arguments to pass to the container
  60. matrix_bridge_mautrix_meta_messenger_container_extra_arguments: []
  61. # List of systemd services that the systemd service depends on.
  62. matrix_bridge_mautrix_meta_messenger_systemd_required_services_list: "{{ matrix_bridge_mautrix_meta_messenger_systemd_required_services_list_default + matrix_bridge_mautrix_meta_messenger_systemd_required_services_list_auto + matrix_bridge_mautrix_meta_messenger_systemd_required_services_list_custom }}"
  63. matrix_bridge_mautrix_meta_messenger_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
  64. matrix_bridge_mautrix_meta_messenger_systemd_required_services_list_auto: []
  65. matrix_bridge_mautrix_meta_messenger_systemd_required_services_list_custom: []
  66. # List of systemd services that the systemd service wants
  67. matrix_bridge_mautrix_meta_messenger_systemd_wanted_services_list: []
  68. # Controls whether the bridge container exposes its HTTP port.
  69. #
  70. # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:29319"), or empty string to not expose.
  71. matrix_bridge_mautrix_meta_messenger_container_http_host_bind_port: ''
  72. # Database-related configuration fields
  73. matrix_bridge_mautrix_meta_messenger_database_engine: sqlite3-fk-wal
  74. matrix_bridge_mautrix_meta_messenger_sqlite_database_path_local: "{{ matrix_bridge_mautrix_meta_messenger_data_path }}/mautrix-meta.db"
  75. matrix_bridge_mautrix_meta_messenger_sqlite_database_path_in_container: "/data/mautrix-meta.db"
  76. matrix_bridge_mautrix_meta_messenger_database_suffix: |-
  77. {{
  78. ({
  79. 'facebook': '_facebook',
  80. 'facebook-tor': '_facebook',
  81. 'messenger': '_messenger',
  82. 'instagram': '_instagram',
  83. })[matrix_bridge_mautrix_meta_messenger_meta_mode]
  84. }}
  85. matrix_bridge_mautrix_meta_messenger_database_username: "matrix_mautrix_meta{{ matrix_bridge_mautrix_meta_messenger_database_suffix }}"
  86. matrix_bridge_mautrix_meta_messenger_database_password: ''
  87. matrix_bridge_mautrix_meta_messenger_database_hostname: ''
  88. matrix_bridge_mautrix_meta_messenger_database_port: 5432
  89. matrix_bridge_mautrix_meta_messenger_database_name: "matrix_mautrix_meta{{ matrix_bridge_mautrix_meta_messenger_database_suffix }}"
  90. matrix_bridge_mautrix_meta_messenger_database_sslmode: disable
  91. matrix_bridge_mautrix_meta_messenger_database_connection_string: 'postgres://{{ matrix_bridge_mautrix_meta_messenger_database_username }}:{{ matrix_bridge_mautrix_meta_messenger_database_password }}@{{ matrix_bridge_mautrix_meta_messenger_database_hostname }}:{{ matrix_bridge_mautrix_meta_messenger_database_port }}/{{ matrix_bridge_mautrix_meta_messenger_database_name }}?sslmode={{ matrix_bridge_mautrix_meta_messenger_database_sslmode }}'
  92. matrix_bridge_mautrix_meta_messenger_homeserver_address: ""
  93. matrix_bridge_mautrix_meta_messenger_homeserver_domain: '{{ matrix_domain }}'
  94. # Whether asynchronous uploads via MSC2246 should be enabled for media.
  95. # Requires a homeserver that supports MSC2246 (https://github.com/matrix-org/matrix-spec-proposals/pull/2246).
  96. matrix_bridge_mautrix_meta_messenger_homeserver_async_media: false
  97. matrix_bridge_mautrix_meta_messenger_homeserver_token: ''
  98. matrix_bridge_mautrix_meta_messenger_appservice_address: "http://{{ matrix_bridge_mautrix_meta_messenger_identifier }}:29319"
  99. # Scheme of the bridge's public address (see `matrix_bridge_mautrix_meta_messenger_bridge_public_address`).
  100. matrix_bridge_mautrix_meta_messenger_scheme: https
  101. # The public base URL at which this bridge's HTTP API is reachable from outside (when exposed).
  102. # Used for the provisioning API's external-server (OpenID) flow and for public media links.
  103. matrix_bridge_mautrix_meta_messenger_bridge_public_address: "{{ (matrix_bridge_mautrix_meta_messenger_scheme + '://' + matrix_bridge_mautrix_meta_messenger_exposure_hostname + matrix_bridge_mautrix_meta_messenger_exposure_path_prefix) if matrix_bridge_mautrix_meta_messenger_exposure_enabled else '' }}"
  104. matrix_bridge_mautrix_meta_messenger_appservice_id: "{{ matrix_bridge_mautrix_meta_messenger_meta_mode }}"
  105. matrix_bridge_mautrix_meta_messenger_msc4190_enabled: "{{ matrix_bridges_msc4190_enabled }}"
  106. matrix_bridge_mautrix_meta_messenger_self_sign_enabled: "{{ matrix_bridges_self_sign_enabled }}"
  107. # For Facebook/Messenger, we use the same `@messengerbot:example.com` username regardless of how bridging happens for multiple reasons:
  108. # - it's consistent - regardless of how bridging happens, the bridged service is actually Messenger
  109. # - it's easy for users - you may change the mode, but the bot is always at `@messengerbot:example.com`
  110. # - it doesn't conflict with mautrix-facebook which uses `@facebookbot:example.com`
  111. # - `matrix_bridge_mautrix_meta_messenger_appservice_avatar` only has icons for Messenger and Instagram, not Facebook
  112. matrix_bridge_mautrix_meta_messenger_appservice_username_prefix: |-
  113. {{
  114. ({
  115. 'facebook': 'messenger',
  116. 'facebook-tor': 'messenger',
  117. 'messenger': 'messenger',
  118. 'instagram': 'instagram',
  119. })[matrix_bridge_mautrix_meta_messenger_meta_mode]
  120. }}
  121. matrix_bridge_mautrix_meta_messenger_appservice_username: "{{ matrix_bridge_mautrix_meta_messenger_appservice_username_prefix }}bot"
  122. matrix_bridge_mautrix_meta_messenger_appservice_displayname: "{{ matrix_bridge_mautrix_meta_messenger_meta_mode | capitalize }} bridge bot"
  123. matrix_bridge_mautrix_meta_messenger_appservice_avatar: "{{ 'mxc://maunium.net/JxjlbZUlCPULEeHZSwleUXQv' if matrix_bridge_mautrix_meta_messenger_meta_mode == 'instagram' else 'mxc://maunium.net/ygtkteZsXnGJLJHRchUwYWak' }}"
  124. matrix_bridge_mautrix_meta_messenger_appservice_database_type: "{{ matrix_bridge_mautrix_meta_messenger_database_engine }}"
  125. matrix_bridge_mautrix_meta_messenger_appservice_database_uri: |-
  126. {{
  127. {
  128. 'sqlite3-fk-wal': ('sqlite:///' + matrix_bridge_mautrix_meta_messenger_sqlite_database_path_in_container),
  129. 'postgres': matrix_bridge_mautrix_meta_messenger_database_connection_string,
  130. }[matrix_bridge_mautrix_meta_messenger_database_engine]
  131. }}
  132. matrix_bridge_mautrix_meta_messenger_appservice_token: ''
  133. # Controls which service this bridge is for.
  134. # Valid options:
  135. # * facebook - connect to FB Messenger via facebook.com
  136. # * facebook-tor - connect to FB Messenger via facebookwkhpilnemxj7asaniu7vnjjbiltxjqhye3mhbshg7kx5tfyd.onion
  137. # (note: does not currently proxy media downloads)
  138. # * messenger - connect to FB Messenger via messenger.com (can be used with the facebook side deactivated)
  139. # * instagram - connect to Instagram DMs via instagram.com
  140. matrix_bridge_mautrix_meta_messenger_meta_mode: messenger
  141. # When in `instagram` mode (see `matrix_bridge_mautrix_meta_messenger_meta_mode`), should the bridge connect to WhatsApp servers for encrypted chats?
  142. matrix_bridge_mautrix_meta_messenger_meta_ig_e2ee: false
  143. matrix_bridge_mautrix_meta_messenger_provisioning_shared_secret: disable
  144. # Controls whether mautrix-meta-messenger's HTTP API is exposed publicly (used by tools like mautrix-manager for bridge login).
  145. matrix_bridge_mautrix_meta_messenger_exposure_enabled: false
  146. matrix_bridge_mautrix_meta_messenger_exposure_hostname: ''
  147. matrix_bridge_mautrix_meta_messenger_exposure_path_prefix: ''
  148. matrix_bridge_mautrix_meta_messenger_bridge_username_prefix: |-
  149. {{
  150. ({
  151. 'facebook': 'facebook_',
  152. 'facebook-tor': 'facebook_',
  153. 'messenger': 'messenger_',
  154. 'instagram': 'instagram_',
  155. })[matrix_bridge_mautrix_meta_messenger_meta_mode]
  156. }}
  157. # Localpart template of MXIDs for FB/IG users.
  158. # {{.}} is replaced with the internal ID of the FB/IG user.
  159. # Changing this may require that you change the regex in the appservice.
  160. matrix_bridge_mautrix_meta_messenger_bridge_username_template: "{{ matrix_bridge_mautrix_meta_messenger_bridge_username_prefix + '{{.}}' }}"
  161. matrix_bridge_mautrix_meta_messenger_bridge_displayname_suffix: |-
  162. {{
  163. ({
  164. 'facebook': '(FB)',
  165. 'facebook-tor': '(FB)',
  166. 'messenger': '(FB)',
  167. 'instagram': '(IG)',
  168. })[matrix_bridge_mautrix_meta_messenger_meta_mode]
  169. }}
  170. matrix_bridge_mautrix_meta_messenger_bridge_displayname_template: '{% raw %}{{or .DisplayName .Username "Unknown user"}}{% endraw %}{{ (" " ~ matrix_bridge_mautrix_meta_messenger_bridge_displayname_suffix) if matrix_bridge_mautrix_meta_messenger_bridge_displayname_suffix else "" }}'
  171. # The prefix for commands. Only required in non-management rooms.
  172. matrix_bridge_mautrix_meta_messenger_bridge_command_prefix: |-
  173. {{
  174. ({
  175. 'facebook': '!fb',
  176. 'facebook-tor': '!fb',
  177. 'messenger': '!fb',
  178. 'instagram': '!ig',
  179. })[matrix_bridge_mautrix_meta_messenger_meta_mode]
  180. }}
  181. # Whether or not created rooms should have federation enabled.
  182. # If false, created portal rooms will never be federated.
  183. matrix_bridge_mautrix_meta_messenger_bridge_federate_rooms: true
  184. # Should the bridge create a space for each logged-in user and add bridged rooms to it?
  185. # Users who logged in before turning this on should run `!meta sync-space` to create and fill the space for the first time.
  186. matrix_bridge_mautrix_meta_messenger_bridge_personal_filtering_spaces: true
  187. # Enable End-to-bridge encryption
  188. matrix_bridge_mautrix_meta_messenger_bridge_encryption_allow: "{{ matrix_bridges_encryption_enabled }}"
  189. matrix_bridge_mautrix_meta_messenger_bridge_encryption_default: "{{ matrix_bridges_encryption_default }}"
  190. matrix_bridge_mautrix_meta_messenger_bridge_encryption_allow_key_sharing: "{{ matrix_bridge_mautrix_meta_messenger_bridge_encryption_allow }}"
  191. matrix_bridge_mautrix_meta_messenger_bridge_encryption_appservice: false
  192. matrix_bridge_mautrix_meta_messenger_bridge_encryption_require: false
  193. matrix_bridge_mautrix_meta_messenger_double_puppet_secrets: "{{ matrix_bridge_mautrix_meta_messenger_double_puppet_secrets_auto | combine(matrix_bridge_mautrix_meta_messenger_double_puppet_secrets_custom) }}"
  194. matrix_bridge_mautrix_meta_messenger_double_puppet_secrets_auto: {}
  195. matrix_bridge_mautrix_meta_messenger_double_puppet_secrets_custom: {}
  196. matrix_bridge_mautrix_meta_messenger_bridge_permissions: "{{ matrix_bridge_mautrix_meta_messenger_bridge_permissions_default | combine(matrix_bridge_mautrix_meta_messenger_bridge_permissions_custom) }}"
  197. matrix_bridge_mautrix_meta_messenger_bridge_permissions_default: |-
  198. {{
  199. {'*': 'relay', matrix_bridge_mautrix_meta_messenger_homeserver_domain: 'user'}
  200. | combine({matrix_admin: 'admin'} if matrix_admin else {})
  201. }}
  202. matrix_bridge_mautrix_meta_messenger_bridge_permissions_custom: {}
  203. # Enable bridge relay bot functionality
  204. matrix_bridge_mautrix_meta_messenger_bridge_relay_enabled: "{{ matrix_bridges_relay_enabled }}"
  205. matrix_bridge_mautrix_meta_messenger_bridge_relay_admin_only: true
  206. matrix_bridge_mautrix_meta_messenger_bridge_relay_default_relays: []
  207. matrix_bridge_mautrix_meta_messenger_backfill_enabled: true
  208. matrix_bridge_mautrix_meta_messenger_backfill_max_initial_messages: 50
  209. matrix_bridge_mautrix_meta_messenger_backfill_max_catchup_messages: 500
  210. matrix_bridge_mautrix_meta_messenger_backfill_unread_hours_threshold: 720
  211. matrix_bridge_mautrix_meta_messenger_backfill_threads_max_initial_messages: 50
  212. matrix_bridge_mautrix_meta_messenger_public_media_signing_key: ''
  213. # Specifies the default log level.
  214. # This bridge uses zerolog, so valid levels are: panic, fatal, error, warn, info, debug, trace
  215. matrix_bridge_mautrix_meta_messenger_logging_min_level: warn
  216. # Default configuration template which covers the generic use case.
  217. # You can customize it by controlling the various variables inside it.
  218. #
  219. # For a more advanced customization, you can extend the default (see `matrix_bridge_mautrix_meta_messenger_configuration_extension_yaml`)
  220. # or completely replace this variable with your own template.
  221. matrix_bridge_mautrix_meta_messenger_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"
  222. matrix_bridge_mautrix_meta_messenger_configuration_extension_yaml: |
  223. # Your custom YAML configuration goes here.
  224. # This configuration extends the default starting configuration (`matrix_bridge_mautrix_meta_messenger_configuration_yaml`).
  225. #
  226. # You can override individual variables from the default configuration, or introduce new ones.
  227. #
  228. # If you need something more special, you can take full control by
  229. # completely redefining `matrix_bridge_mautrix_meta_messenger_configuration_yaml`.
  230. matrix_bridge_mautrix_meta_messenger_configuration_extension: "{{ matrix_bridge_mautrix_meta_messenger_configuration_extension_yaml | from_yaml if matrix_bridge_mautrix_meta_messenger_configuration_extension_yaml | from_yaml is mapping else {} }}"
  231. # Holds the final configuration (a combination of the default and its extension).
  232. # You most likely don't need to touch this variable. Instead, see `matrix_bridge_mautrix_meta_messenger_configuration_yaml`.
  233. matrix_bridge_mautrix_meta_messenger_configuration: "{{ matrix_bridge_mautrix_meta_messenger_configuration_yaml | from_yaml | combine(matrix_bridge_mautrix_meta_messenger_configuration_extension, recursive=True) }}"
  234. matrix_bridge_mautrix_meta_messenger_registration_yaml: |
  235. id: {{ matrix_bridge_mautrix_meta_messenger_appservice_id | to_json }}
  236. as_token: {{ matrix_bridge_mautrix_meta_messenger_appservice_token | to_json }}
  237. hs_token: {{ matrix_bridge_mautrix_meta_messenger_homeserver_token | to_json }}
  238. namespaces:
  239. users:
  240. - exclusive: true
  241. regex: '^@{{ matrix_bridge_mautrix_meta_messenger_bridge_username_prefix | regex_escape }}.+:{{ matrix_bridge_mautrix_meta_messenger_homeserver_domain | regex_escape }}$'
  242. - exclusive: true
  243. regex: '^@{{ matrix_bridge_mautrix_meta_messenger_appservice_username | regex_escape }}:{{ matrix_bridge_mautrix_meta_messenger_homeserver_domain | regex_escape }}$'
  244. url: {{ matrix_bridge_mautrix_meta_messenger_appservice_address }}
  245. sender_localpart: _bot_{{ matrix_bridge_mautrix_meta_messenger_appservice_username }}
  246. rate_limited: false
  247. de.sorunome.msc2409.push_ephemeral: true
  248. receive_ephemeral: true
  249. io.element.msc4190: {{ matrix_bridge_mautrix_meta_messenger_msc4190_enabled | to_json }}
  250. matrix_bridge_mautrix_meta_messenger_registration: "{{ matrix_bridge_mautrix_meta_messenger_registration_yaml | from_yaml }}"
  251. # matrix_bridge_mautrix_meta_messenger_restart_necessary controls whether the service
  252. # will be restarted (when true) or merely started (when false) by the
  253. # systemd service manager role (when conditional restart is enabled).
  254. #
  255. # This value is automatically computed during installation based on whether
  256. # any configuration files, the systemd service file, or the container image changed.
  257. # The default of `false` means "no restart needed" — appropriate when the role's
  258. # installation tasks haven't run (e.g., due to --tags skipping them).
  259. matrix_bridge_mautrix_meta_messenger_restart_necessary: false