overmind
/
matrix-docker-ansible-deploy
zrcadlo https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Rozštěpit 0
Zdrojový kód Úkoly 0 Vydání 0 Wiki Aktivita
Matrix Docker Ansible eploy
Nelze vybrat více než 25 témat Téma musí začínat písmenem nebo číslem, může obsahovat pomlčky („-“) a může být dlouhé až 35 znaků.
10877 Revize
13 Větve
36 MiB
 
 
Strom: e72b0bc483
Větve Značky
${ item.name }
Vytvořit větev ${ searchTerm }
z „e72b0bc483“
${ noResults }
matrix-docker-ansible-deploy/roles/custom/matrix-bridge-mautrix-meta-.../defaults/main.yml

320 řádky
18 KiB
Surový Blame Historie 

  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. ---

  9. 

  10. # mautrix-meta is a Matrix <-> Facebook/Messenger/Instagram bridge

  11. # Project source code URL: https://github.com/mautrix/meta

  12. #

  13. # WARNING: this bridge role is used for both Messenger and Instagram.

  14. # This Messenger role acts as a source and auto-generates matrix-bridge-mautrix-meta-instagram

  15. # thanks to `just rebuild-mautrix-meta-instagram` (`bin/rebuild-mautrix-meta-instagram.sh`).

  16. # If you'd like to make changes to the Instagram role, consider making your changes to the Messenger role instead.

  17. 

  18. matrix_mautrix_meta_messenger_enabled: true

  19. 

  20. matrix_mautrix_meta_messenger_identifier: matrix-mautrix-meta-messenger

  21. 

  22. # renovate: datasource=docker depName=dock.mau.dev/mautrix/meta

  23. matrix_mautrix_meta_messenger_version: v0.2602.0

  24. 

  25. matrix_mautrix_meta_messenger_base_path: "{{ matrix_base_data_path }}/mautrix-meta-messenger"

  26. matrix_mautrix_meta_messenger_config_path: "{{ matrix_mautrix_meta_messenger_base_path }}/config"

  27. matrix_mautrix_meta_messenger_data_path: "{{ matrix_mautrix_meta_messenger_base_path }}/data"

  28. matrix_mautrix_meta_messenger_container_src_files_path: "{{ matrix_mautrix_meta_messenger_base_path }}/container-src"

  29. 

  30. matrix_mautrix_meta_messenger_container_image_self_build: false

  31. matrix_mautrix_meta_messenger_container_image_self_build_repo: "https://github.com/mautrix/meta.git"

  32. 

  33. matrix_mautrix_meta_messenger_container_image: "{{ matrix_mautrix_meta_messenger_container_image_registry_prefix }}mautrix/meta:{{ matrix_mautrix_meta_messenger_container_image_tag }}"

  34. matrix_mautrix_meta_messenger_container_image_registry_prefix: "{{ 'localhost/' if matrix_mautrix_meta_messenger_container_image_self_build else matrix_mautrix_meta_messenger_container_image_registry_prefix_upstream }}"

  35. matrix_mautrix_meta_messenger_container_image_registry_prefix_upstream: "{{ matrix_mautrix_meta_messenger_container_image_registry_prefix_upstream_default }}"

  36. matrix_mautrix_meta_messenger_container_image_registry_prefix_upstream_default: "dock.mau.dev/"

  37. # Prebuilt container images for specific commit hashes are tagged with an architecture suffix (e.g. `HASH-amd64`).

  38. matrix_mautrix_meta_messenger_container_image_tag: "{{ matrix_mautrix_meta_messenger_version }}{{ ('-' ~ matrix_architecture) if (matrix_mautrix_meta_messenger_version | length == 40) else '' }}"

  39. matrix_mautrix_meta_messenger_container_image_force_pull: "{{ matrix_mautrix_meta_messenger_container_image.endswith(':latest') }}"

  40. 

  41. matrix_mautrix_meta_messenger_container_network: ""

  42. 

  43. matrix_mautrix_meta_messenger_container_additional_networks: "{{ matrix_mautrix_meta_messenger_container_additional_networks_auto + matrix_mautrix_meta_messenger_container_additional_networks_custom }}"

  44. matrix_mautrix_meta_messenger_container_additional_networks_auto: []

  45. matrix_mautrix_meta_messenger_container_additional_networks_custom: []

  46. 

  47. # matrix_mautrix_meta_messenger_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container.

  48. # See `../templates/labels.j2` for details.

  49. #

  50. # To inject your own other container labels, see `matrix_mautrix_meta_messenger_container_labels_additional_labels`.

  51. matrix_mautrix_meta_messenger_container_labels_traefik_enabled: true

  52. matrix_mautrix_meta_messenger_container_labels_traefik_docker_network: "{{ matrix_mautrix_meta_messenger_container_network }}"

  53. matrix_mautrix_meta_messenger_container_labels_traefik_entrypoints: web-secure

  54. matrix_mautrix_meta_messenger_container_labels_traefik_tls_certResolver: default  # noqa var-naming

  55. 

  56. # Controls whether labels will be added that expose the bridge's metrics

  57. matrix_mautrix_meta_messenger_container_labels_metrics_enabled: "{{ matrix_mautrix_meta_messenger_metrics_enabled and matrix_mautrix_meta_messenger_metrics_proxying_enabled }}"

  58. matrix_mautrix_meta_messenger_container_labels_metrics_traefik_rule: "Host(`{{ matrix_mautrix_meta_messenger_metrics_proxying_hostname }}`) && PathPrefix(`{{ matrix_mautrix_meta_messenger_metrics_proxying_path_prefix }}`)"

  59. matrix_mautrix_meta_messenger_container_labels_metrics_traefik_priority: 0

  60. matrix_mautrix_meta_messenger_container_labels_metrics_traefik_entrypoints: "{{ matrix_mautrix_meta_messenger_container_labels_traefik_entrypoints }}"

  61. matrix_mautrix_meta_messenger_container_labels_metrics_traefik_tls: "{{ matrix_mautrix_meta_messenger_container_labels_metrics_traefik_entrypoints != 'web' }}"

  62. matrix_mautrix_meta_messenger_container_labels_metrics_traefik_tls_certResolver: "{{ matrix_mautrix_meta_messenger_container_labels_traefik_tls_certResolver }}"  # noqa var-naming

  63. matrix_mautrix_meta_messenger_container_labels_metrics_middleware_basic_auth_enabled: false

  64. # See: https://doc.traefik.io/traefik/middlewares/http/basicauth/#users

  65. matrix_mautrix_meta_messenger_container_labels_metrics_middleware_basic_auth_users: ''

  66. 

  67. # matrix_mautrix_meta_messenger_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file.

  68. # See `../templates/labels.j2` for details.

  69. #

  70. # Example:

  71. # matrix_mautrix_meta_messenger_container_labels_additional_labels: |

  72. #   my.label=1

  73. #   another.label="here"

  74. matrix_mautrix_meta_messenger_container_labels_additional_labels: ''

  75. 

  76. # A list of extra arguments to pass to the container

  77. matrix_mautrix_meta_messenger_container_extra_arguments: []

  78. 

  79. # List of systemd services that the systemd service depends on.

  80. matrix_mautrix_meta_messenger_systemd_required_services_list: "{{ matrix_mautrix_meta_messenger_systemd_required_services_list_default + matrix_mautrix_meta_messenger_systemd_required_services_list_auto + matrix_mautrix_meta_messenger_systemd_required_services_list_custom }}"

  81. matrix_mautrix_meta_messenger_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"

  82. matrix_mautrix_meta_messenger_systemd_required_services_list_auto: []

  83. matrix_mautrix_meta_messenger_systemd_required_services_list_custom: []

  84. 

  85. # List of systemd services that the systemd service wants

  86. matrix_mautrix_meta_messenger_systemd_wanted_services_list: []

  87. 

  88. # Controls whether the bridge container exposes its HTTP port.

  89. #

  90. # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:29319"), or empty string to not expose.

  91. matrix_mautrix_meta_messenger_container_http_host_bind_port: ''

  92. 

  93. # Database-related configuration fields

  94. matrix_mautrix_meta_messenger_database_engine: sqlite3-fk-wal

  95. 

  96. matrix_mautrix_meta_messenger_sqlite_database_path_local: "{{ matrix_mautrix_meta_messenger_data_path }}/mautrix-meta.db"

  97. matrix_mautrix_meta_messenger_sqlite_database_path_in_container: "/data/mautrix-meta.db"

  98. 

  99. matrix_mautrix_meta_messenger_database_suffix: |-

  100.   {{

  101.     ({

  102.       'facebook': '_facebook',

  103.       'facebook-tor': '_facebook',

  104.       'messenger': '_messenger',

  105.       'instagram': '_instagram',

  106.     })[matrix_mautrix_meta_messenger_meta_mode]

  107.   }}

  108. 

  109. matrix_mautrix_meta_messenger_database_username: "matrix_mautrix_meta{{ matrix_mautrix_meta_messenger_database_suffix }}"

  110. matrix_mautrix_meta_messenger_database_password: ''

  111. matrix_mautrix_meta_messenger_database_hostname: ''

  112. matrix_mautrix_meta_messenger_database_port: 5432

  113. matrix_mautrix_meta_messenger_database_name: "matrix_mautrix_meta{{ matrix_mautrix_meta_messenger_database_suffix }}"

  114. matrix_mautrix_meta_messenger_database_sslmode: disable

  115. 

  116. matrix_mautrix_meta_messenger_database_connection_string: 'postgres://{{ matrix_mautrix_meta_messenger_database_username }}:{{ matrix_mautrix_meta_messenger_database_password }}@{{ matrix_mautrix_meta_messenger_database_hostname }}:{{ matrix_mautrix_meta_messenger_database_port }}/{{ matrix_mautrix_meta_messenger_database_name }}?sslmode={{ matrix_mautrix_meta_messenger_database_sslmode }}'

  117. 

  118. matrix_mautrix_meta_messenger_homeserver_address: ""

  119. matrix_mautrix_meta_messenger_homeserver_domain: '{{ matrix_domain }}'

  120. # Whether asynchronous uploads via MSC2246 should be enabled for media.

  121. # Requires a homeserver that supports MSC2246 (https://github.com/matrix-org/matrix-spec-proposals/pull/2246).

  122. matrix_mautrix_meta_messenger_homeserver_async_media: false

  123. matrix_mautrix_meta_messenger_homeserver_token: ''

  124. 

  125. matrix_mautrix_meta_messenger_appservice_address: "http://{{ matrix_mautrix_meta_messenger_identifier }}:29319"

  126. 

  127. matrix_mautrix_meta_messenger_appservice_id: "{{ matrix_mautrix_meta_messenger_meta_mode }}"

  128. 

  129. matrix_mautrix_meta_messenger_msc4190_enabled: "{{ matrix_bridges_msc4190_enabled }}"

  130. matrix_mautrix_meta_messenger_self_sign_enabled: "{{ matrix_bridges_self_sign_enabled }}"

  131. 

  132. # For Facebook/Messenger, we use the same `@messengerbot:example.com` username regardless of how bridging happens for multiple reasons:

  133. # - it's consistent - regardless of how bridging happens, the bridged service is actually Messenger

  134. # - it's easy for users - you may change the mode, but the bot is always at `@messengerbot:example.com`

  135. # - it doesn't conflict with mautrix-facebook which uses `@facebookbot:example.com`

  136. # - `matrix_mautrix_meta_messenger_appservice_avatar` only has icons for Messenger and Instagram, not Facebook

  137. matrix_mautrix_meta_messenger_appservice_username_prefix: |-

  138.   {{

  139.     ({

  140.       'facebook': 'messenger',

  141.       'facebook-tor': 'messenger',

  142.       'messenger': 'messenger',

  143.       'instagram': 'instagram',

  144.     })[matrix_mautrix_meta_messenger_meta_mode]

  145.   }}

  146. matrix_mautrix_meta_messenger_appservice_username: "{{ matrix_mautrix_meta_messenger_appservice_username_prefix }}bot"

  147. matrix_mautrix_meta_messenger_appservice_displayname: "{{ matrix_mautrix_meta_messenger_meta_mode | capitalize }} bridge bot"

  148. matrix_mautrix_meta_messenger_appservice_avatar: "{{ 'mxc://maunium.net/JxjlbZUlCPULEeHZSwleUXQv' if matrix_mautrix_meta_messenger_meta_mode == 'instagram' else 'mxc://maunium.net/ygtkteZsXnGJLJHRchUwYWak' }}"

  149. 

  150. matrix_mautrix_meta_messenger_appservice_database_type: "{{ matrix_mautrix_meta_messenger_database_engine }}"

  151. 

  152. matrix_mautrix_meta_messenger_appservice_database_uri: |-

  153.   {{

  154.     {

  155.       'sqlite3-fk-wal': ('sqlite:///' + matrix_mautrix_meta_messenger_sqlite_database_path_in_container),

  156.       'postgres': matrix_mautrix_meta_messenger_database_connection_string,

  157.     }[matrix_mautrix_meta_messenger_database_engine]

  158.   }}

  159. 

  160. matrix_mautrix_meta_messenger_appservice_token: ''

  161. 

  162. # Controls which service this bridge is for.

  163. # Valid options:

  164. # * facebook - connect to FB Messenger via facebook.com

  165. # * facebook-tor - connect to FB Messenger via facebookwkhpilnemxj7asaniu7vnjjbiltxjqhye3mhbshg7kx5tfyd.onion

  166. #                  (note: does not currently proxy media downloads)

  167. # * messenger - connect to FB Messenger via messenger.com (can be used with the facebook side deactivated)

  168. # * instagram - connect to Instagram DMs via instagram.com

  169. matrix_mautrix_meta_messenger_meta_mode: messenger

  170. 

  171. # When in `instagram` mode (see `matrix_mautrix_meta_messenger_meta_mode`), should the bridge connect to WhatsApp servers for encrypted chats?

  172. matrix_mautrix_meta_messenger_meta_ig_e2ee: false

  173. 

  174. matrix_mautrix_meta_messenger_provisioning_shared_secret: disable

  175. 

  176. # Whether or not metrics endpoint should be enabled.

  177. # Enabling them is usually enough for a local (in-container) Prometheus to consume them.

  178. # If metrics need to be consumed by another (external) Prometheus server, consider exposing them via `matrix_mautrix_meta_messenger_metrics_proxying_enabled`.

  179. matrix_mautrix_meta_messenger_metrics_enabled: false

  180. 

  181. # Controls whether metrics should be exposed on a public URL.

  182. matrix_mautrix_meta_messenger_metrics_proxying_enabled: false

  183. matrix_mautrix_meta_messenger_metrics_proxying_hostname: ''

  184. matrix_mautrix_meta_messenger_metrics_proxying_path_prefix: ''

  185. 

  186. matrix_mautrix_meta_messenger_bridge_username_prefix: |-

  187.   {{

  188.     ({

  189.       'facebook': 'facebook_',

  190.       'facebook-tor': 'facebook_',

  191.       'messenger': 'messenger_',

  192.       'instagram': 'instagram_',

  193.     })[matrix_mautrix_meta_messenger_meta_mode]

  194.   }}

  195. 

  196. # Localpart template of MXIDs for FB/IG users.

  197. # {{.}} is replaced with the internal ID of the FB/IG user.

  198. # Changing this may require that you change the regex in the appservice.

  199. matrix_mautrix_meta_messenger_bridge_username_template: "{{ matrix_mautrix_meta_messenger_bridge_username_prefix + '{{.}}' }}"

  200. 

  201. matrix_mautrix_meta_messenger_bridge_displayname_suffix: |-

  202.   {{

  203.     ({

  204.       'facebook': '(FB)',

  205.       'facebook-tor': '(FB)',

  206.       'messenger': '(FB)',

  207.       'instagram': '(IG)',

  208.     })[matrix_mautrix_meta_messenger_meta_mode]

  209.   }}

  210. 

  211. matrix_mautrix_meta_messenger_bridge_displayname_template: '{% raw %}{{or .DisplayName .Username "Unknown user"}}{% endraw %}{{ (" " ~ matrix_mautrix_meta_messenger_bridge_displayname_suffix) if matrix_mautrix_meta_messenger_bridge_displayname_suffix else "" }}'

  212. 

  213. # The prefix for commands. Only required in non-management rooms.

  214. matrix_mautrix_meta_messenger_bridge_command_prefix: |-

  215.   {{

  216.     ({

  217.       'facebook': '!fb',

  218.       'facebook-tor': '!fb',

  219.       'messenger': '!fb',

  220.       'instagram': '!ig',

  221.     })[matrix_mautrix_meta_messenger_meta_mode]

  222.   }}

  223. 

  224. # Whether or not created rooms should have federation enabled.

  225. # If false, created portal rooms will never be federated.

  226. matrix_mautrix_meta_messenger_bridge_federate_rooms: true

  227. 

  228. # Should the bridge create a space for each logged-in user and add bridged rooms to it?

  229. # Users who logged in before turning this on should run `!meta sync-space` to create and fill the space for the first time.

  230. matrix_mautrix_meta_messenger_bridge_personal_filtering_spaces: true

  231. 

  232. # Enable End-to-bridge encryption

  233. matrix_mautrix_meta_messenger_bridge_encryption_allow: "{{ matrix_bridges_encryption_enabled }}"

  234. matrix_mautrix_meta_messenger_bridge_encryption_default: "{{ matrix_bridges_encryption_default }}"

  235. matrix_mautrix_meta_messenger_bridge_encryption_allow_key_sharing: "{{ matrix_mautrix_meta_messenger_bridge_encryption_allow }}"

  236. matrix_mautrix_meta_messenger_bridge_encryption_appservice: false

  237. matrix_mautrix_meta_messenger_bridge_encryption_require: false

  238. 

  239. matrix_mautrix_meta_messenger_double_puppet_secrets: "{{ matrix_mautrix_meta_messenger_double_puppet_secrets_auto | combine(matrix_mautrix_meta_messenger_double_puppet_secrets_custom) }}"

  240. matrix_mautrix_meta_messenger_double_puppet_secrets_auto: {}

  241. matrix_mautrix_meta_messenger_double_puppet_secrets_custom: {}

  242. 

  243. matrix_mautrix_meta_messenger_bridge_permissions: "{{ matrix_mautrix_meta_messenger_bridge_permissions_default | combine(matrix_mautrix_meta_messenger_bridge_permissions_custom) }}"

  244. 

  245. matrix_mautrix_meta_messenger_bridge_permissions_default: |-

  246.   {{

  247.     {'*': 'relay', matrix_mautrix_meta_messenger_homeserver_domain: 'user'}

  248.     | combine({matrix_admin: 'admin'} if matrix_admin else {})

  249.   }}

  250. 

  251. matrix_mautrix_meta_messenger_bridge_permissions_custom: {}

  252. 

  253. # Enable bridge relay bot functionality

  254. matrix_mautrix_meta_messenger_bridge_relay_enabled: "{{ matrix_bridges_relay_enabled }}"

  255. matrix_mautrix_meta_messenger_bridge_relay_admin_only: true

  256. matrix_mautrix_meta_messenger_bridge_relay_default_relays: []

  257. 

  258. matrix_mautrix_meta_messenger_backfill_enabled: true

  259. matrix_mautrix_meta_messenger_backfill_max_initial_messages: 50

  260. matrix_mautrix_meta_messenger_backfill_max_catchup_messages: 500

  261. matrix_mautrix_meta_messenger_backfill_unread_hours_threshold: 720

  262. matrix_mautrix_meta_messenger_backfill_threads_max_initial_messages: 50

  263. 

  264. matrix_mautrix_meta_messenger_public_media_signing_key: ''

  265. 

  266. # Specifies the default log level.

  267. # This bridge uses zerolog, so valid levels are: panic, fatal, error, warn, info, debug, trace

  268. matrix_mautrix_meta_messenger_logging_min_level: warn

  269. 

  270. # Default configuration template which covers the generic use case.

  271. # You can customize it by controlling the various variables inside it.

  272. #

  273. # For a more advanced customization, you can extend the default (see `matrix_mautrix_meta_messenger_configuration_extension_yaml`)

  274. # or completely replace this variable with your own template.

  275. matrix_mautrix_meta_messenger_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"

  276. 

  277. matrix_mautrix_meta_messenger_configuration_extension_yaml: |

  278.   # Your custom YAML configuration goes here.

  279.   # This configuration extends the default starting configuration (`matrix_mautrix_meta_messenger_configuration_yaml`).

  280.   #

  281.   # You can override individual variables from the default configuration, or introduce new ones.

  282.   #

  283.   # If you need something more special, you can take full control by

  284.   # completely redefining `matrix_mautrix_meta_messenger_configuration_yaml`.

  285. 

  286. matrix_mautrix_meta_messenger_configuration_extension: "{{ matrix_mautrix_meta_messenger_configuration_extension_yaml | from_yaml if matrix_mautrix_meta_messenger_configuration_extension_yaml | from_yaml is mapping else {} }}"

  287. 

  288. # Holds the final configuration (a combination of the default and its extension).

  289. # You most likely don't need to touch this variable. Instead, see `matrix_mautrix_meta_messenger_configuration_yaml`.

  290. matrix_mautrix_meta_messenger_configuration: "{{ matrix_mautrix_meta_messenger_configuration_yaml | from_yaml | combine(matrix_mautrix_meta_messenger_configuration_extension, recursive=True) }}"

  291. 

  292. matrix_mautrix_meta_messenger_registration_yaml: |

  293.   id: {{ matrix_mautrix_meta_messenger_appservice_id | to_json }}

  294.   as_token: {{ matrix_mautrix_meta_messenger_appservice_token | to_json }}

  295.   hs_token: {{ matrix_mautrix_meta_messenger_homeserver_token | to_json }}

  296.   namespaces:

  297.     users:

  298.     - exclusive: true

  299.       regex: '^@{{ matrix_mautrix_meta_messenger_bridge_username_prefix }}.+:{{ matrix_mautrix_meta_messenger_homeserver_domain | regex_escape }}$'

  300.     - exclusive: true

  301.       regex: '^@{{ matrix_mautrix_meta_messenger_appservice_username | regex_escape }}:{{ matrix_mautrix_meta_messenger_homeserver_domain | regex_escape }}$'

  302.   url: {{ matrix_mautrix_meta_messenger_appservice_address }}

  303.   sender_localpart: _bot_{{ matrix_mautrix_meta_messenger_appservice_username }}

  304.   rate_limited: false

  305.   de.sorunome.msc2409.push_ephemeral: true

  306.   receive_ephemeral: true

  307.   io.element.msc4190: {{ matrix_mautrix_meta_messenger_msc4190_enabled | to_json }}

  308. 

  309. matrix_mautrix_meta_messenger_registration: "{{ matrix_mautrix_meta_messenger_registration_yaml | from_yaml }}"

  310. 

  311. # matrix_mautrix_meta_messenger_restart_necessary controls whether the service

  312. # will be restarted (when true) or merely started (when false) by the

  313. # systemd service manager role (when conditional restart is enabled).

  314. #

  315. # This value is automatically computed during installation based on whether

  316. # any configuration files, the systemd service file, or the container image changed.

  317. # The default of `false` means "no restart needed" — appropriate when the role's

  318. # installation tasks haven't run (e.g., due to --tags skipping them).

  319. matrix_mautrix_meta_messenger_restart_necessary: false