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.
 
 

250 lines
16 KiB

  1. # SPDX-FileCopyrightText: 2026 MDAD project contributors
  2. # SPDX-FileCopyrightText: 2026 Nikita Chernyi
  3. #
  4. # SPDX-License-Identifier: AGPL-3.0-or-later
  5. ---
  6. # mautrix-linkedin is a Matrix <-> LinkedIn bridge
  7. # Project source code URL: https://github.com/mautrix/linkedin
  8. matrix_bridge_mautrix_linkedin_enabled: true
  9. matrix_bridge_mautrix_linkedin_container_image_self_build: false
  10. matrix_bridge_mautrix_linkedin_container_image_self_build_repo: "https://github.com/mautrix/linkedin.git"
  11. matrix_bridge_mautrix_linkedin_container_image_self_build_branch: "{{ 'main' if matrix_bridge_mautrix_linkedin_version == 'latest' else matrix_bridge_mautrix_linkedin_version }}"
  12. # renovate: datasource=docker depName=dock.mau.dev/mautrix/linkedin
  13. matrix_bridge_mautrix_linkedin_version: v0.2604.0
  14. # See: https://mau.dev/mautrix/linkedin/container_registry
  15. matrix_bridge_mautrix_linkedin_container_image: "{{ matrix_bridge_mautrix_linkedin_container_image_registry_prefix }}mautrix/linkedin:{{ matrix_bridge_mautrix_linkedin_version }}"
  16. matrix_bridge_mautrix_linkedin_container_image_registry_prefix: "{{ 'localhost/' if matrix_bridge_mautrix_linkedin_container_image_self_build else matrix_bridge_mautrix_linkedin_container_image_registry_prefix_upstream }}"
  17. matrix_bridge_mautrix_linkedin_container_image_registry_prefix_upstream: "{{ matrix_bridge_mautrix_linkedin_container_image_registry_prefix_upstream_default }}"
  18. matrix_bridge_mautrix_linkedin_container_image_registry_prefix_upstream_default: "dock.mau.dev/"
  19. matrix_bridge_mautrix_linkedin_base_path: "{{ matrix_base_data_path }}/mautrix-linkedin"
  20. matrix_bridge_mautrix_linkedin_config_path: "{{ matrix_bridge_mautrix_linkedin_base_path }}/config"
  21. matrix_bridge_mautrix_linkedin_data_path: "{{ matrix_bridge_mautrix_linkedin_base_path }}/data"
  22. matrix_bridge_mautrix_linkedin_container_src_files_path: "{{ matrix_bridge_mautrix_linkedin_base_path }}/docker-src"
  23. matrix_bridge_mautrix_linkedin_homeserver_address: ""
  24. # Whether asynchronous uploads via MSC2246 should be enabled for media.
  25. # Requires a homeserver that supports MSC2246 (https://github.com/matrix-org/matrix-spec-proposals/pull/2246).
  26. matrix_bridge_mautrix_linkedin_homeserver_async_media: false
  27. matrix_bridge_mautrix_linkedin_homeserver_domain: "{{ matrix_domain }}"
  28. matrix_bridge_mautrix_linkedin_appservice_address: "http://matrix-mautrix-linkedin:8080"
  29. # Scheme of the bridge's public address (see `matrix_bridge_mautrix_linkedin_bridge_public_address`).
  30. matrix_bridge_mautrix_linkedin_scheme: https
  31. # The public base URL at which this bridge's HTTP API is reachable from outside (when exposed).
  32. # Used for the provisioning API's external-server (OpenID) flow and for public media links.
  33. matrix_bridge_mautrix_linkedin_bridge_public_address: "{{ (matrix_bridge_mautrix_linkedin_scheme + '://' + matrix_bridge_mautrix_linkedin_exposure_hostname + matrix_bridge_mautrix_linkedin_exposure_path_prefix) if matrix_bridge_mautrix_linkedin_exposure_enabled else '' }}"
  34. matrix_bridge_mautrix_linkedin_msc4190_enabled: "{{ matrix_bridges_msc4190_enabled }}"
  35. matrix_bridge_mautrix_linkedin_self_sign_enabled: "{{ matrix_bridges_self_sign_enabled }}"
  36. matrix_bridge_mautrix_linkedin_backfill_enabled: true
  37. matrix_bridge_mautrix_linkedin_backfill_max_initial_messages: 50
  38. matrix_bridge_mautrix_linkedin_backfill_max_catchup_messages: 500
  39. matrix_bridge_mautrix_linkedin_backfill_unread_hours_threshold: 720
  40. matrix_bridge_mautrix_linkedin_backfill_threads_max_initial_messages: 50
  41. matrix_bridge_mautrix_linkedin_command_prefix: "!li"
  42. matrix_bridge_mautrix_linkedin_container_network: ""
  43. matrix_bridge_mautrix_linkedin_container_additional_networks: "{{ matrix_bridge_mautrix_linkedin_container_additional_networks_auto + matrix_bridge_mautrix_linkedin_container_additional_networks_custom }}"
  44. matrix_bridge_mautrix_linkedin_container_additional_networks_auto: []
  45. matrix_bridge_mautrix_linkedin_container_additional_networks_custom: []
  46. # matrix_bridge_mautrix_linkedin_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container.
  47. # See `../templates/labels.j2` for details.
  48. #
  49. # To inject your own other container labels, see `matrix_bridge_mautrix_linkedin_container_labels_additional_labels`.
  50. matrix_bridge_mautrix_linkedin_container_labels_traefik_enabled: true
  51. matrix_bridge_mautrix_linkedin_container_labels_traefik_docker_network: "{{ matrix_bridge_mautrix_linkedin_container_network }}"
  52. matrix_bridge_mautrix_linkedin_container_labels_traefik_entrypoints: web-secure
  53. matrix_bridge_mautrix_linkedin_container_labels_traefik_tls_certResolver: default # noqa var-naming
  54. # Controls whether labels will be added that expose mautrix-linkedin' metrics
  55. matrix_bridge_mautrix_linkedin_container_labels_metrics_enabled: "{{ matrix_bridge_mautrix_linkedin_metrics_enabled and matrix_bridge_mautrix_linkedin_metrics_proxying_enabled }}"
  56. matrix_bridge_mautrix_linkedin_container_labels_metrics_traefik_rule: "Host(`{{ matrix_bridge_mautrix_linkedin_metrics_proxying_hostname }}`) && PathPrefix(`{{ matrix_bridge_mautrix_linkedin_metrics_proxying_path_prefix }}`)"
  57. matrix_bridge_mautrix_linkedin_container_labels_metrics_traefik_priority: 0
  58. matrix_bridge_mautrix_linkedin_container_labels_metrics_traefik_entrypoints: "{{ matrix_bridge_mautrix_linkedin_container_labels_traefik_entrypoints }}"
  59. matrix_bridge_mautrix_linkedin_container_labels_metrics_traefik_tls: "{{ matrix_bridge_mautrix_linkedin_container_labels_metrics_traefik_entrypoints != 'web' }}"
  60. matrix_bridge_mautrix_linkedin_container_labels_metrics_traefik_tls_certResolver: "{{ matrix_bridge_mautrix_linkedin_container_labels_traefik_tls_certResolver }}" # noqa var-naming
  61. matrix_bridge_mautrix_linkedin_container_labels_metrics_middleware_basic_auth_enabled: false
  62. # See: https://doc.traefik.io/traefik/middlewares/http/basicauth/#users
  63. matrix_bridge_mautrix_linkedin_container_labels_metrics_middleware_basic_auth_users: ''
  64. # Controls whether labels will be added that expose mautrix-linkedin' HTTP API
  65. # (used by tools like mautrix-manager for bridge login) at `https://<hostname><path_prefix>`.
  66. matrix_bridge_mautrix_linkedin_container_labels_exposure_enabled: "{{ matrix_bridge_mautrix_linkedin_exposure_enabled }}"
  67. matrix_bridge_mautrix_linkedin_container_labels_exposure_traefik_rule: "Host(`{{ matrix_bridge_mautrix_linkedin_exposure_hostname }}`) && PathPrefix(`{{ matrix_bridge_mautrix_linkedin_exposure_path_prefix }}`)"
  68. matrix_bridge_mautrix_linkedin_container_labels_exposure_traefik_priority: 0
  69. matrix_bridge_mautrix_linkedin_container_labels_exposure_traefik_entrypoints: "{{ matrix_bridge_mautrix_linkedin_container_labels_traefik_entrypoints }}"
  70. matrix_bridge_mautrix_linkedin_container_labels_exposure_traefik_tls: "{{ matrix_bridge_mautrix_linkedin_container_labels_exposure_traefik_entrypoints != 'web' }}"
  71. matrix_bridge_mautrix_linkedin_container_labels_exposure_traefik_tls_certResolver: "{{ matrix_bridge_mautrix_linkedin_container_labels_traefik_tls_certResolver }}" # noqa var-naming
  72. # matrix_bridge_mautrix_linkedin_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file.
  73. # See `../templates/labels.j2` for details.
  74. #
  75. # Example:
  76. # matrix_bridge_mautrix_linkedin_container_labels_additional_labels: |
  77. # my.label=1
  78. # another.label="here"
  79. matrix_bridge_mautrix_linkedin_container_labels_additional_labels: ''
  80. # A list of extra arguments to pass to the container
  81. matrix_bridge_mautrix_linkedin_container_extra_arguments: []
  82. # List of systemd services that matrix-mautrix-linkedin.service depends on.
  83. matrix_bridge_mautrix_linkedin_systemd_required_services_list: "{{ matrix_bridge_mautrix_linkedin_systemd_required_services_list_default + matrix_bridge_mautrix_linkedin_systemd_required_services_list_auto + matrix_bridge_mautrix_linkedin_systemd_required_services_list_custom }}"
  84. matrix_bridge_mautrix_linkedin_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
  85. matrix_bridge_mautrix_linkedin_systemd_required_services_list_auto: []
  86. matrix_bridge_mautrix_linkedin_systemd_required_services_list_custom: []
  87. # List of systemd services that matrix-mautrix-linkedin.service wants
  88. matrix_bridge_mautrix_linkedin_systemd_wanted_services_list: []
  89. matrix_bridge_mautrix_linkedin_appservice_token: ''
  90. matrix_bridge_mautrix_linkedin_homeserver_token: ''
  91. matrix_bridge_mautrix_linkedin_appservice_bot_username: linkedinbot
  92. # Minimum severity of journal log messages.
  93. # Valid values: fatal, error, warn, info, debug, trace
  94. matrix_bridge_mautrix_linkedin_logging_level: 'warn'
  95. # Whether or not created rooms should have federation enabled.
  96. # If false, created portal rooms will never be federated.
  97. matrix_bridge_mautrix_linkedin_federate_rooms: true
  98. # Whether or not metrics endpoint should be enabled.
  99. # Enabling them is usually enough for a local (in-container) Prometheus to consume them.
  100. # If metrics need to be consumed by another (external) Prometheus server, consider exposing them via `matrix_bridge_mautrix_linkedin_metrics_proxying_enabled`.
  101. matrix_bridge_mautrix_linkedin_metrics_enabled: false
  102. # Controls whether metrics should be proxied (exposed) on a public URL.
  103. matrix_bridge_mautrix_linkedin_metrics_proxying_enabled: false
  104. matrix_bridge_mautrix_linkedin_metrics_proxying_hostname: ''
  105. matrix_bridge_mautrix_linkedin_metrics_proxying_path_prefix: ''
  106. # Controls whether mautrix-linkedin' HTTP API is exposed publicly (used by tools like mautrix-manager for bridge login).
  107. matrix_bridge_mautrix_linkedin_exposure_enabled: false
  108. matrix_bridge_mautrix_linkedin_exposure_hostname: ''
  109. matrix_bridge_mautrix_linkedin_exposure_path_prefix: ''
  110. # Database-related configuration fields.
  111. #
  112. # To use SQLite, stick to these defaults.
  113. #
  114. # To use Postgres:
  115. # - change the engine (`matrix_bridge_mautrix_linkedin_database_engine: 'postgres'`)
  116. # - adjust your database credentials via the `matrix_bridge_mautrix_linkedin_database_*` variables
  117. matrix_bridge_mautrix_linkedin_database_engine: 'sqlite'
  118. matrix_bridge_mautrix_linkedin_sqlite_database_path_local: "{{ matrix_bridge_mautrix_linkedin_data_path }}/mautrix-linkedin.db"
  119. matrix_bridge_mautrix_linkedin_sqlite_database_path_in_container: "/data/mautrix-linkedin.db"
  120. matrix_bridge_mautrix_linkedin_database_username: 'matrix_mautrix_linkedin'
  121. matrix_bridge_mautrix_linkedin_database_password: 'some-password'
  122. matrix_bridge_mautrix_linkedin_database_hostname: ''
  123. matrix_bridge_mautrix_linkedin_database_port: 5432
  124. matrix_bridge_mautrix_linkedin_database_name: 'matrix_mautrix_linkedin'
  125. matrix_bridge_mautrix_linkedin_database_sslmode: disable
  126. matrix_bridge_mautrix_linkedin_database_connection_string: 'postgresql://{{ matrix_bridge_mautrix_linkedin_database_username }}:{{ matrix_bridge_mautrix_linkedin_database_password }}@{{ matrix_bridge_mautrix_linkedin_database_hostname }}:{{ matrix_bridge_mautrix_linkedin_database_port }}/{{ matrix_bridge_mautrix_linkedin_database_name }}?sslmode={{ matrix_bridge_mautrix_linkedin_database_sslmode }}'
  127. matrix_bridge_mautrix_linkedin_appservice_database_type: "{{ {
  128. 'sqlite': 'sqlite3',
  129. 'postgres': 'postgres',
  130. }[matrix_bridge_mautrix_linkedin_database_engine] }}"
  131. matrix_bridge_mautrix_linkedin_appservice_database_uri: "{{ {
  132. 'sqlite': matrix_bridge_mautrix_linkedin_sqlite_database_path_in_container,
  133. 'postgres': matrix_bridge_mautrix_linkedin_database_connection_string,
  134. }[matrix_bridge_mautrix_linkedin_database_engine] }}"
  135. matrix_bridge_mautrix_linkedin_double_puppet_secrets: "{{ matrix_bridge_mautrix_linkedin_double_puppet_secrets_auto | combine(matrix_bridge_mautrix_linkedin_double_puppet_secrets_custom) }}"
  136. matrix_bridge_mautrix_linkedin_double_puppet_secrets_auto: {}
  137. matrix_bridge_mautrix_linkedin_double_puppet_secrets_custom: {}
  138. # Enable End-to-bridge encryption
  139. matrix_bridge_mautrix_linkedin_bridge_encryption_allow: "{{ matrix_bridges_encryption_enabled }}"
  140. matrix_bridge_mautrix_linkedin_bridge_encryption_default: "{{ matrix_bridges_encryption_default }}"
  141. matrix_bridge_mautrix_linkedin_bridge_encryption_require: false
  142. matrix_bridge_mautrix_linkedin_bridge_encryption_appservice: false
  143. matrix_bridge_mautrix_linkedin_bridge_encryption_key_sharing_allow: "{{ matrix_bridge_mautrix_linkedin_bridge_encryption_allow }}"
  144. matrix_bridge_mautrix_linkedin_bridge_encryption_pickle_key: mautrix.bridge.e2ee
  145. matrix_bridge_mautrix_linkedin_network_displayname_template: "{% raw %}{{ with .Organization }}{{ . }}{{ else }}{{ .FirstName }} {{ .LastName }}{{ end }}{% endraw %} (LinkedIn)"
  146. matrix_bridge_mautrix_linkedin_appservice_username_template: "{% raw %}linkedin_{{.}}{% endraw %}"
  147. matrix_bridge_mautrix_linkedin_public_media_signing_key: ''
  148. # Shared secret for authentication of provisioning API requests.
  149. # If set to "disable", the provisioning API will be disabled.
  150. matrix_bridge_mautrix_linkedin_provisioning_shared_secret: disable
  151. matrix_bridge_mautrix_linkedin_bridge_personal_filtering_spaces: true
  152. matrix_bridge_mautrix_linkedin_bridge_permissions: |
  153. {{
  154. {'*': 'relay', matrix_bridge_mautrix_linkedin_homeserver_domain: 'user'}
  155. | combine({matrix_admin: 'admin'} if matrix_admin else {})
  156. }}
  157. # Default mautrix-linkedin configuration template which covers the generic use case.
  158. # You can customize it by controlling the various variables inside it.
  159. #
  160. # For a more advanced customization, you can extend the default (see `matrix_bridge_mautrix_linkedin_configuration_extension_yaml`)
  161. # or completely replace this variable with your own template.
  162. matrix_bridge_mautrix_linkedin_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"
  163. matrix_bridge_mautrix_linkedin_configuration_extension_yaml: |
  164. # Your custom YAML configuration goes here.
  165. # This configuration extends the default starting configuration (`matrix_bridge_mautrix_linkedin_configuration_yaml`).
  166. #
  167. # You can override individual variables from the default configuration, or introduce new ones.
  168. #
  169. # If you need something more special, you can take full control by
  170. # completely redefining `matrix_bridge_mautrix_linkedin_configuration_yaml`.
  171. matrix_bridge_mautrix_linkedin_configuration_extension: "{{ matrix_bridge_mautrix_linkedin_configuration_extension_yaml | from_yaml if matrix_bridge_mautrix_linkedin_configuration_extension_yaml | from_yaml is mapping else {} }}"
  172. # Holds the final configuration (a combination of the default and its extension).
  173. # You most likely don't need to touch this variable. Instead, see `matrix_bridge_mautrix_linkedin_configuration_yaml`.
  174. matrix_bridge_mautrix_linkedin_configuration: "{{ matrix_bridge_mautrix_linkedin_configuration_yaml | from_yaml | combine(matrix_bridge_mautrix_linkedin_configuration_extension, recursive=True) }}"
  175. matrix_bridge_mautrix_linkedin_registration_yaml: |
  176. id: linkedin
  177. url: {{ matrix_bridge_mautrix_linkedin_appservice_address }}
  178. as_token: "{{ matrix_bridge_mautrix_linkedin_appservice_token }}"
  179. hs_token: "{{ matrix_bridge_mautrix_linkedin_homeserver_token }}"
  180. # See https://github.com/mautrix/signal/issues/43
  181. sender_localpart: _bot_{{ matrix_bridge_mautrix_linkedin_appservice_bot_username }}
  182. rate_limited: false
  183. namespaces:
  184. users:
  185. - regex: '^@linkedin_.+:{{ matrix_bridge_mautrix_linkedin_homeserver_domain | regex_escape }}$'
  186. exclusive: true
  187. - exclusive: true
  188. regex: '^@{{ matrix_bridge_mautrix_linkedin_appservice_bot_username | regex_escape }}:{{ matrix_bridge_mautrix_linkedin_homeserver_domain | regex_escape }}$'
  189. de.sorunome.msc2409.push_ephemeral: true
  190. receive_ephemeral: true
  191. io.element.msc4190: {{ matrix_bridge_mautrix_linkedin_msc4190_enabled | to_json }}
  192. matrix_bridge_mautrix_linkedin_registration: "{{ matrix_bridge_mautrix_linkedin_registration_yaml | from_yaml }}"
  193. # matrix_bridge_mautrix_linkedin_restart_necessary controls whether the service
  194. # will be restarted (when true) or merely started (when false) by the
  195. # systemd service manager role (when conditional restart is enabled).
  196. #
  197. # This value is automatically computed during installation based on whether
  198. # any configuration files, the systemd service file, or the container image changed.
  199. # The default of `false` means "no restart needed", appropriate when the role's
  200. # installation tasks haven't run (e.g., due to --tags skipping them).
  201. matrix_bridge_mautrix_linkedin_restart_necessary: false