Matrix Docker Ansible eploy
Não pode escolher mais do que 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.
 
 

657 linhas
39 KiB

  1. # SPDX-FileCopyrightText: 2024 - 2025 Slavi Pantaleev
  2. # SPDX-FileCopyrightText: 2025 Suguru Hirahara
  3. #
  4. # SPDX-License-Identifier: AGPL-3.0-or-later
  5. ---
  6. # matrix-authentication-service (MAS) is an OAuth 2.0 and OpenID Provider server for Matrix.
  7. # Project source code URL: https://github.com/element-hq/matrix-authentication-service
  8. matrix_authentication_service_enabled: true
  9. matrix_authentication_service_hostname: ''
  10. # Controls the path prefix for the authentication service.
  11. # This value must either be `/` or not end with a slash (e.g. `/auth`).
  12. matrix_authentication_service_path_prefix: /
  13. matrix_authentication_service_container_image_self_build: false
  14. matrix_authentication_service_container_repo: "https://github.com/element-hq/matrix-authentication-service.git"
  15. matrix_authentication_service_container_repo_version: "{{ 'main' if matrix_authentication_service_version == 'latest' else ('v' + matrix_authentication_service_version) }}"
  16. matrix_authentication_service_container_src_files_path: "{{ matrix_base_data_path }}/matrix-authentication-service/container-src"
  17. # renovate: datasource=docker depName=ghcr.io/element-hq/matrix-authentication-service
  18. matrix_authentication_service_version: 1.3.0
  19. matrix_authentication_service_container_image_registry_prefix: "{{ 'localhost/' if matrix_authentication_service_container_image_self_build else matrix_authentication_service_container_image_registry_prefix_upstream }}"
  20. matrix_authentication_service_container_image_registry_prefix_upstream: "{{ matrix_authentication_service_container_image_registry_prefix_upstream_default }}"
  21. matrix_authentication_service_container_image_registry_prefix_upstream_default: "ghcr.io/"
  22. matrix_authentication_service_container_image: "{{ matrix_authentication_service_container_image_registry_prefix }}element-hq/matrix-authentication-service:{{ matrix_authentication_service_version }}"
  23. matrix_authentication_service_container_image_force_pull: "{{ matrix_authentication_service_container_image.endswith(':latest') }}"
  24. matrix_authentication_service_base_path: "{{ matrix_base_data_path }}/matrix-authentication-service"
  25. matrix_authentication_service_bin_path: "{{ matrix_authentication_service_base_path }}/bin"
  26. matrix_authentication_service_config_path: "{{ matrix_authentication_service_base_path }}/config"
  27. matrix_authentication_service_data_path: "{{ matrix_authentication_service_base_path }}/data"
  28. matrix_authentication_service_data_keys_path: "{{ matrix_authentication_service_data_path }}/keys"
  29. matrix_authentication_service_uid: "{{ matrix_user_uid }}"
  30. matrix_authentication_service_gid: "{{ matrix_user_gid }}"
  31. matrix_authentication_service_container_network: ""
  32. matrix_authentication_service_container_additional_networks: "{{ matrix_authentication_service_container_additional_networks_auto + matrix_authentication_service_container_additional_networks_custom }}"
  33. matrix_authentication_service_container_additional_networks_auto: []
  34. matrix_authentication_service_container_additional_networks_custom: []
  35. # A list of extra arguments to pass to the container
  36. matrix_authentication_service_container_extra_arguments: []
  37. # List of systemd services that matrix-authentication-service.service depends on
  38. matrix_authentication_service_systemd_required_services_list: "{{ matrix_authentication_service_systemd_required_services_list_default + matrix_authentication_service_systemd_required_services_list_auto + matrix_authentication_service_systemd_required_services_list_custom }}"
  39. matrix_authentication_service_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
  40. matrix_authentication_service_systemd_required_services_list_auto: []
  41. matrix_authentication_service_systemd_required_services_list_custom: []
  42. # List of systemd services that matrix-authentication-service.service wants
  43. matrix_authentication_service_systemd_wanted_services_list: "{{ matrix_authentication_service_systemd_wanted_services_list_auto + matrix_authentication_service_systemd_wanted_services_list_custom }}"
  44. matrix_authentication_service_systemd_wanted_services_list_auto: []
  45. matrix_authentication_service_systemd_wanted_services_list_custom: []
  46. ########################################################################################
  47. # #
  48. # Key management #
  49. # #
  50. ########################################################################################
  51. # Controls whether the playbook will manage the secrets keys for you.
  52. #
  53. # See:
  54. # - matrix_authentication_service_config_secrets_keys
  55. # - matrix_authentication_service_key_management_*
  56. matrix_authentication_service_key_management_enabled: true
  57. matrix_authentication_service_key_management_list: "{{ matrix_authentication_service_key_management_list_default + matrix_authentication_service_key_management_list_custom }}"
  58. matrix_authentication_service_key_management_list_default: |-
  59. {{
  60. (
  61. ([
  62. {
  63. "config": {
  64. "kid": matrix_authentication_service_key_management_rsa_2048_key_id,
  65. "key_file": ("/keys/" + matrix_authentication_service_key_management_rsa_2048_key_file),
  66. },
  67. "key_file": matrix_authentication_service_key_management_rsa_2048_key_file,
  68. "generation_command": matrix_authentication_service_key_management_rsa_2048_generation_command,
  69. }
  70. ] if matrix_authentication_service_key_management_rsa_2048_enabled else [])
  71. +
  72. ([
  73. {
  74. "config": {
  75. "kid": matrix_authentication_service_key_management_ecdsa_p256_key_id,
  76. "key_file": ("/keys/" + matrix_authentication_service_key_management_ecdsa_p256_key_file),
  77. },
  78. "key_file": matrix_authentication_service_key_management_ecdsa_p256_key_file,
  79. "generation_command": matrix_authentication_service_key_management_ecdsa_p256_generation_command,
  80. }
  81. ] if matrix_authentication_service_key_management_ecdsa_p256_enabled else [])
  82. +
  83. ([
  84. {
  85. "config": {
  86. "kid": matrix_authentication_service_key_management_ecdsa_p384_key_id,
  87. "key_file": ("/keys/" + matrix_authentication_service_key_management_ecdsa_p384_key_file),
  88. },
  89. "key_file": matrix_authentication_service_key_management_ecdsa_p384_key_file,
  90. "generation_command": matrix_authentication_service_key_management_ecdsa_p384_generation_command,
  91. }
  92. ] if matrix_authentication_service_key_management_ecdsa_p384_enabled else [])
  93. +
  94. ([
  95. {
  96. "config": {
  97. "kid": matrix_authentication_service_key_management_ecdsa_k256_key_id,
  98. "key_file": ("/keys/" + matrix_authentication_service_key_management_ecdsa_k256_key_file),
  99. },
  100. "key_file": matrix_authentication_service_key_management_ecdsa_k256_key_file,
  101. "generation_command": matrix_authentication_service_key_management_ecdsa_k256_generation_command,
  102. }
  103. ] if matrix_authentication_service_key_management_ecdsa_k256_enabled else [])
  104. )
  105. if matrix_authentication_service_key_management_enabled
  106. else []
  107. }}
  108. matrix_authentication_service_key_management_list_custom: []
  109. matrix_authentication_service_key_management_rsa_2048_enabled: true
  110. matrix_authentication_service_key_management_rsa_2048_key_id: default-rsa
  111. matrix_authentication_service_key_management_rsa_2048_key_file: rsa-2048.priv.pem
  112. matrix_authentication_service_key_management_rsa_2048_generation_command: "openssl genpkey -algorithm RSA -out __KEY_FILE_PATH__ -pkeyopt rsa_keygen_bits:2048"
  113. matrix_authentication_service_key_management_ecdsa_p256_enabled: true
  114. matrix_authentication_service_key_management_ecdsa_p256_key_id: default-ecdsa-p256
  115. matrix_authentication_service_key_management_ecdsa_p256_key_file: ecdsa-p256.priv.pem
  116. matrix_authentication_service_key_management_ecdsa_p256_generation_command: "openssl genpkey -algorithm EC -pkeyopt ec_paramgen_curve:prime256v1 -out __KEY_FILE_PATH__ -outform PEM"
  117. matrix_authentication_service_key_management_ecdsa_p384_enabled: true
  118. matrix_authentication_service_key_management_ecdsa_p384_key_id: default-ecdsa-p384
  119. matrix_authentication_service_key_management_ecdsa_p384_key_file: ecdsa-p384.priv.pem
  120. matrix_authentication_service_key_management_ecdsa_p384_generation_command: "openssl genpkey -algorithm EC -pkeyopt ec_paramgen_curve:secp384r1 -out __KEY_FILE_PATH__ -outform PEM"
  121. matrix_authentication_service_key_management_ecdsa_k256_enabled: true
  122. matrix_authentication_service_key_management_ecdsa_k256_key_id: default-ecdsa-k256
  123. matrix_authentication_service_key_management_ecdsa_k256_key_file: ecdsa-k256.priv.pem
  124. matrix_authentication_service_key_management_ecdsa_k256_generation_command: "openssl genpkey -algorithm EC -pkeyopt ec_paramgen_curve:secp256k1 -out __KEY_FILE_PATH__ -outform PEM"
  125. ########################################################################################
  126. # #
  127. # /Key management #
  128. # #
  129. ########################################################################################
  130. ########################################################################################
  131. # #
  132. # Email configuration #
  133. # #
  134. ########################################################################################
  135. # Controls the `email.from` configuration setting.
  136. matrix_authentication_service_config_email_from: '"{{ matrix_authentication_service_config_email_from_name }}" <{{ matrix_authentication_service_config_email_from_address }}>'
  137. matrix_authentication_service_config_email_from_name: 'Matrix Authentication Service'
  138. matrix_authentication_service_config_email_from_address: "matrix@{{ matrix_domain }}"
  139. # Controls the `email.reply_to` configuration setting.
  140. matrix_authentication_service_config_email_reply_to: '"{{ matrix_authentication_service_config_email_reply_to_name }}" <{{ matrix_authentication_service_config_email_reply_to_address }}>'
  141. matrix_authentication_service_config_email_reply_to_name: "{{ matrix_authentication_service_config_email_from_name }}"
  142. matrix_authentication_service_config_email_reply_to_address: "{{ matrix_authentication_service_config_email_from_address }}"
  143. # Controls the `email.transport` configuration setting.
  144. #
  145. # Valid values: blackhole, smtp, aws_ses
  146. # Upstream reports that `sendmail` is supported as well,
  147. # but this is not true when running it in a container image due to the `sendmail` binary not being included.
  148. matrix_authentication_service_config_email_transport: blackhole
  149. # Controls the `email.mode` configuration setting for SMTP.
  150. # Valid values: plain, tls, starttls
  151. matrix_authentication_service_config_email_mode: plain
  152. # Controls the `email.hostname` configuration setting for SMTP.
  153. matrix_authentication_service_config_email_hostname: ""
  154. # Controls the `email.port` configuration setting for SMTP.
  155. matrix_authentication_service_config_email_port: 587
  156. # Controls the `email.username` configuration setting for SMTP.
  157. matrix_authentication_service_config_email_username: ""
  158. # Controls the `email.password` configuration setting for SMTP.
  159. matrix_authentication_service_config_email_password: ""
  160. ########################################################################################
  161. # #
  162. # /Email configuration #
  163. # #
  164. ########################################################################################
  165. ########################################################################################
  166. # #
  167. # Account configuration #
  168. # #
  169. ########################################################################################
  170. # Controls the `account.email_change_allowed` configuration setting.
  171. #
  172. # Whether users are allowed to change their email addresses.
  173. matrix_authentication_service_config_account_email_change_allowed: true
  174. # Controls the `account.displayname_change_allowed` configuration setting.
  175. #
  176. # Whether users are allowed to change their display names.
  177. # This should be in sync with the policy in the homeserver configuration.
  178. matrix_authentication_service_config_account_displayname_change_allowed: true
  179. # Controls the `account.password_registration_enabled` configuration setting.
  180. #
  181. # Whether to enable self-service password registration.
  182. # This has no effect if password login is disabled.
  183. matrix_authentication_service_config_account_password_registration_enabled: false
  184. # Controls the `account.password_change_allowed` configuration setting.
  185. #
  186. # Whether users are allowed to change their passwords.
  187. # This has no effect if password login is disabled.
  188. matrix_authentication_service_config_account_password_change_allowed: true
  189. # Controls the `account.password_recovery_enabled` configuration setting.
  190. #
  191. # Whether email-based password recovery is enabled.
  192. # This has no effect if password login is disabled.
  193. matrix_authentication_service_config_account_password_recovery_enabled: false
  194. # Controls the `account.account_deactivation_allowed` configuration setting.
  195. #
  196. # Whether users are allowed to delete their own account
  197. matrix_authentication_service_config_account_account_deactivation_allowed: true
  198. # Controls the `account.login_with_email_allowed` configuration setting.
  199. #
  200. # Whether users can log in with their email address.
  201. # This has no effect if password login is disabled.
  202. matrix_authentication_service_config_account_login_with_email_allowed: false
  203. # Controls the `account.registration_token_required` configuration setting.
  204. #
  205. # Whether registration tokens are required for password registrations.
  206. # When enabled, users must provide a valid registration token during password
  207. # registration. This has no effect if password registration is disabled.
  208. matrix_authentication_service_config_account_registration_token_required: false
  209. ########################################################################################
  210. # #
  211. # /Account configuration #
  212. # #
  213. ########################################################################################
  214. ########################################################################################
  215. # #
  216. # Database configuration #
  217. # #
  218. ########################################################################################
  219. # Controls the `database.username` configuration setting.
  220. matrix_authentication_service_config_database_username: 'matrix_authentication_service'
  221. # Controls the `database.password` configuration setting.
  222. matrix_authentication_service_config_database_password: ''
  223. # Controls the `database.host` configuration setting.
  224. matrix_authentication_service_config_database_host: ''
  225. # Controls the `database.port` configuration setting.
  226. matrix_authentication_service_config_database_port: 5432
  227. # Controls the `database.database` configuration setting.
  228. matrix_authentication_service_config_database_database: 'matrix_authentication_service'
  229. # Controls the `database.ssl_mode` configuration setting.
  230. matrix_authentication_service_config_database_ssl_mode: disable
  231. # Controls the `database.max_connections` configuration setting.
  232. matrix_authentication_service_config_database_max_connections: 10
  233. # Controls the `database.min_connections` configuration setting.
  234. matrix_authentication_service_config_database_min_connections: 0
  235. # Controls the `database.connect_timeout` configuration setting.
  236. matrix_authentication_service_config_database_connect_timeout: 30
  237. # Controls the `database.idle_timeout` configuration setting.
  238. matrix_authentication_service_config_database_idle_timeout: 600
  239. # Controls the `database.max_lifetime` configuration setting.
  240. matrix_authentication_service_config_database_max_lifetime: 1800
  241. ########################################################################################
  242. # #
  243. # /Database configuration #
  244. # #
  245. ########################################################################################
  246. ########################################################################################
  247. # #
  248. # Secrets configuration #
  249. # #
  250. ########################################################################################
  251. # Controls the `secrets.encryption` configuration setting.
  252. matrix_authentication_service_config_secrets_encryption: ''
  253. # Controls the `secrets.keys` configuration setting.
  254. matrix_authentication_service_config_secrets_keys: |-
  255. {{
  256. matrix_authentication_service_key_management_list | map(attribute='config') | list
  257. if matrix_authentication_service_key_management_enabled
  258. else []
  259. }}
  260. ########################################################################################
  261. # #
  262. # /Secrets configuration #
  263. # #
  264. ########################################################################################
  265. ########################################################################################
  266. # #
  267. # HTTP configuration #
  268. # #
  269. ########################################################################################
  270. # Controls the resources exposed by the `web` HTTP listener.
  271. matrix_authentication_service_config_http_listener_web_resources: "{{ matrix_authentication_service_config_http_listener_web_resources_default + matrix_authentication_service_config_http_listener_web_resources_auto + matrix_authentication_service_config_http_listener_web_resources_custom }}"
  272. matrix_authentication_service_config_http_listener_web_resources_default: |-
  273. {{
  274. [
  275. {'name': 'discovery'},
  276. {'name': 'human'},
  277. {'name': 'oauth'},
  278. {'name': 'compat'},
  279. {'name': 'graphql'},
  280. {'name': 'assets'},
  281. ]
  282. +
  283. ([{'name': 'adminapi'}] if matrix_authentication_service_admin_api_enabled else [])
  284. }}
  285. matrix_authentication_service_config_http_listener_web_resources_auto: []
  286. matrix_authentication_service_config_http_listener_web_resources_custom: []
  287. # Controls the `http.public_base` configuration setting.
  288. matrix_authentication_service_config_http_public_base: "https://{{ matrix_authentication_service_hostname }}{{ '/' if matrix_authentication_service_path_prefix == '/' else (matrix_authentication_service_path_prefix + '/') }}"
  289. # Controls the `http.issuer` configuration setting.
  290. matrix_authentication_service_config_http_issuer: "{{ matrix_authentication_service_config_http_public_base }}"
  291. # Controls the `http.trusted_proxies` configuration setting.
  292. matrix_authentication_service_config_http_trusted_proxies:
  293. - 192.168.0.0/16
  294. - 172.16.0.0/12
  295. - 10.0.0.0/10
  296. - 127.0.0.1/8
  297. - fd00::/8
  298. - ::1/128
  299. ########################################################################################
  300. # #
  301. # /HTTP configuration #
  302. # #
  303. ########################################################################################
  304. ########################################################################################
  305. # #
  306. # Matrix configuration #
  307. # #
  308. ########################################################################################
  309. # Controls the `matrix.homeserver` configuration setting.
  310. # The homeserver name, as per the `server_name` in the Synapse configuration file.
  311. matrix_authentication_service_config_matrix_homeserver: ""
  312. # Controls the `matrix.endpoint` configuration setting.
  313. # URL to which the homeserver is accessible from the service.
  314. matrix_authentication_service_config_matrix_endpoint: ""
  315. # Controls the `matrix.secret` configuration setting.
  316. matrix_authentication_service_config_matrix_secret: ""
  317. ########################################################################################
  318. # #
  319. # /Matrix configuration #
  320. # #
  321. ########################################################################################
  322. ########################################################################################
  323. # #
  324. # Passwords configuration #
  325. # #
  326. ########################################################################################
  327. # Controls the `passwords.enabled` configuration setting.
  328. # Whether to enable the password database.
  329. # If disabled, users will only be able to log in using upstream OIDC providers.
  330. matrix_authentication_service_config_passwords_enabled: true
  331. # Controls the `passwords.schemes` configuration setting.
  332. # List of password hashing schemes being used.
  333. # Only change this if you know what you're doing.
  334. matrix_authentication_service_config_passwords_schemes:
  335. - version: 1
  336. algorithm: argon2id
  337. # Controls the `passwords.minimum_complexity` configuration setting.
  338. # Minimum complexity required for passwords, estimated by the zxcvbn algorithm.
  339. # Must be between 0 and 4. Default is 3.
  340. # See https://github.com/dropbox/zxcvbn#usage for more information.
  341. matrix_authentication_service_config_passwords_minimum_complexity: 3
  342. ########################################################################################
  343. # #
  344. # /Passwords configuration #
  345. # #
  346. ########################################################################################
  347. ########################################################################################
  348. # #
  349. # Clients configuration #
  350. # #
  351. ########################################################################################
  352. # Controls the `clients` configuration setting.
  353. # List of clients to be used by the authentication service.
  354. #
  355. # See:
  356. # - https://element-hq.github.io/matrix-authentication-service/reference/configuration.html#clients
  357. # - https://element-hq.github.io/matrix-authentication-service/setup/homeserver.html#provision-a-client-for-the-homeserver-to-use
  358. #
  359. # To define your own, use `matrix_authentication_service_config_clients_custom`.
  360. matrix_authentication_service_config_clients: "{{ matrix_authentication_service_config_clients_auto + matrix_authentication_service_config_clients_custom }}"
  361. matrix_authentication_service_config_clients_auto: []
  362. matrix_authentication_service_config_clients_custom: []
  363. ########################################################################################
  364. # #
  365. # /Clients configuration #
  366. # #
  367. ########################################################################################
  368. ########################################################################################
  369. # #
  370. # Upstream OAuth2 configuration #
  371. # #
  372. ########################################################################################
  373. # Controls the `upstream_oauth2.providers` configuration setting.
  374. # See:
  375. # - https://element-hq.github.io/matrix-authentication-service/reference/configuration.html#upstream_oauth2providers
  376. matrix_authentication_service_config_upstream_oauth2_providers: []
  377. ########################################################################################
  378. # #
  379. # /Upstream OAuth2 configuration #
  380. # #
  381. ########################################################################################
  382. # Holds the final Matrix Authentication Service configuration (a combination of the default and its extension).
  383. # You most likely don't need to touch this variable. Instead, see `matrix_authentication_service_configuration_yaml` or `matrix_authentication_service_configuration_extension_yaml`.
  384. matrix_authentication_service_configuration: "{{ matrix_authentication_service_configuration_yaml | from_yaml | combine(matrix_authentication_service_configuration_extension, recursive=True) }}"
  385. # Default Matrix Authentication Service configuration template which covers the generic use case.
  386. # You can customize it by controlling the various variables inside it.
  387. #
  388. # For a more advanced customization, you can extend the default (see `matrix_authentication_service_configuration_extension_yaml`)
  389. # or completely replace this variable with your own template.
  390. matrix_authentication_service_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"
  391. matrix_authentication_service_configuration_extension_yaml: |
  392. # Your custom YAML configuration for Matrix Authentication Service goes here.
  393. # This configuration extends the default starting configuration (`matrix_authentication_service_configuration_yaml`).
  394. #
  395. # You can override individual variables from the default configuration, or introduce new ones.
  396. #
  397. # If you need something more special, you can take full control by
  398. # completely redefining `matrix_authentication_service_configuration_yaml`.
  399. #
  400. # Example configuration extension follows:
  401. #
  402. # user:
  403. # password: something
  404. matrix_authentication_service_configuration_extension: "{{ matrix_authentication_service_configuration_extension_yaml | from_yaml if matrix_authentication_service_configuration_extension_yaml | from_yaml is mapping else {} }}"
  405. # Additional environment variables to pass to the Matrix Authentication Service container.
  406. #
  407. # Environment variables take priority over settings in the configuration file.
  408. #
  409. # Example:
  410. # matrix_authentication_service_environment_variables_extension: |
  411. # KEY=value
  412. matrix_authentication_service_environment_variables_extension: ''
  413. ########################################################################################
  414. # #
  415. # Labels #
  416. # #
  417. ########################################################################################
  418. # matrix_authentication_service_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container.
  419. # See `../templates/labels.j2` for details.
  420. #
  421. # To inject your own other container labels, see `matrix_authentication_service_container_labels_additional_labels`.
  422. matrix_authentication_service_container_labels_traefik_enabled: true
  423. matrix_authentication_service_container_labels_traefik_docker_network: "{{ matrix_authentication_service_container_network }}"
  424. matrix_authentication_service_container_labels_traefik_entrypoints: web-secure
  425. matrix_authentication_service_container_labels_traefik_tls_certResolver: default # noqa var-naming
  426. matrix_authentication_service_container_labels_public_main_hostname: "{{ matrix_authentication_service_hostname }}"
  427. # The path prefix must either be `/` or not end with a slash (e.g. `/auth`).
  428. matrix_authentication_service_container_labels_public_main_path_prefix: "{{ matrix_authentication_service_path_prefix }}"
  429. matrix_authentication_service_container_labels_public_main_rule: "Host(`{{ matrix_authentication_service_container_labels_public_main_hostname }}`){% if matrix_authentication_service_container_labels_public_main_path_prefix != '/' %} && PathPrefix(`{{ matrix_authentication_service_container_labels_public_main_path_prefix }}`){% endif %}"
  430. matrix_authentication_service_container_labels_public_main_priority: 0
  431. matrix_authentication_service_container_labels_public_main_entrypoints: "{{ matrix_authentication_service_container_labels_traefik_entrypoints }}"
  432. matrix_authentication_service_container_labels_public_main_tls: "{{ matrix_authentication_service_container_labels_public_main_entrypoints != 'web' }}"
  433. matrix_authentication_service_container_labels_public_main_tls_certResolver: "{{ matrix_authentication_service_container_labels_traefik_tls_certResolver }}" # noqa var-naming
  434. # Controls whether labels will be added to expose the compatibility layer publicly.
  435. #
  436. # The service exposes a compatibility layer to allow legacy clients to authenticate using the service.
  437. # This works by exposing a few Matrix endpoints that should be proxied to the service.
  438. # The following Matrix Client-Server API endpoints need to be handled by the authentication service:
  439. # - /_matrix/client/*/login
  440. # - /_matrix/client/*/logout
  441. # - /_matrix/client/*/refresh
  442. #
  443. # See:
  444. # - https://element-hq.github.io/matrix-authentication-service/setup/homeserver.html#set-up-the-compatibility-layer
  445. # - https://element-hq.github.io/matrix-authentication-service/setup/reverse-proxy.html#compatibility-layer
  446. #
  447. # Regardless of whether this is enabled, it may or may not take effect due to the value of other variables.
  448. # See `matrix_authentication_service_container_labels_traefik_enabled`.
  449. matrix_authentication_service_container_labels_public_compatibility_layer_enabled: false
  450. matrix_authentication_service_container_labels_public_compatibility_layer_hostname: ""
  451. matrix_authentication_service_container_labels_public_compatibility_layer_path_regexp: "^/_matrix/client/(?P<version>([^/]+))/(?P<endpoint>(login|logout|refresh))"
  452. matrix_authentication_service_container_labels_public_compatibility_layer_rule: "Host(`{{ matrix_authentication_service_container_labels_public_compatibility_layer_hostname }}`) && PathRegexp(`{{ matrix_authentication_service_container_labels_public_compatibility_layer_path_regexp }}`)"
  453. matrix_authentication_service_container_labels_public_compatibility_layer_priority: 0
  454. matrix_authentication_service_container_labels_public_compatibility_layer_entrypoints: "{{ matrix_authentication_service_container_labels_traefik_entrypoints }}"
  455. matrix_authentication_service_container_labels_public_compatibility_layer_tls: "{{ matrix_authentication_service_container_labels_public_compatibility_layer_entrypoints != 'web' }}"
  456. matrix_authentication_service_container_labels_public_compatibility_layer_tls_certResolver: "{{ matrix_authentication_service_container_labels_traefik_tls_certResolver }}" # noqa var-naming
  457. # Controls whether labels will be added to expose the compatibility layer on the internal Traefik entrypoint.
  458. # This is similar to `matrix_authentication_service_container_labels_public_compatibility_layer_enabled`, but the entrypoint and intent is different.
  459. # Regardless of whether this is enabled, it may or may not take effect due to the value of other variables.
  460. # See `matrix_authentication_service_container_labels_traefik_enabled`
  461. matrix_authentication_service_container_labels_internal_compatibility_layer_enabled: false
  462. matrix_authentication_service_container_labels_internal_compatibility_layer_path_regexp: "{{ matrix_authentication_service_container_labels_public_compatibility_layer_path_regexp }}"
  463. matrix_authentication_service_container_labels_internal_compatibility_layer_rule: "PathRegexp(`{{ matrix_authentication_service_container_labels_internal_compatibility_layer_path_regexp }}`)"
  464. matrix_authentication_service_container_labels_internal_compatibility_layer_priority: 0
  465. matrix_authentication_service_container_labels_internal_compatibility_layer_entrypoints: ""
  466. # Controls which additional headers to attach to all HTTP responses.
  467. # To add your own headers, use `matrix_authentication_service_container_labels_traefik_additional_response_headers_custom`
  468. matrix_authentication_service_container_labels_traefik_additional_response_headers: "{{ matrix_authentication_service_container_labels_traefik_additional_response_headers_auto | combine(matrix_authentication_service_container_labels_traefik_additional_response_headers_custom) }}"
  469. matrix_authentication_service_container_labels_traefik_additional_response_headers_auto: {}
  470. matrix_authentication_service_container_labels_traefik_additional_response_headers_custom: {}
  471. # matrix_authentication_service_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file.
  472. # See `../templates/labels.j2` for details.
  473. #
  474. # Example:
  475. # matrix_authentication_service_container_labels_additional_labels: |
  476. # my.label=1
  477. # another.label="here"
  478. matrix_authentication_service_container_labels_additional_labels: ''
  479. ########################################################################################
  480. # #
  481. # /Labels #
  482. # #
  483. ########################################################################################
  484. ########################################################################################
  485. # #
  486. # syn2mas configuration #
  487. # #
  488. ########################################################################################
  489. matrix_authentication_service_syn2mas_start_wait_time_seconds: 5
  490. # The syn2mas sub-command to run.
  491. # Valid values: migrate, check
  492. matrix_authentication_service_syn2mas_subcommand: migrate
  493. # Whether to pass a `--dry-run` flag to the 'migrate' sub-command.
  494. # See `matrix_authentication_service_syn2mas_subcommand`
  495. matrix_authentication_service_syn2mas_migrate_dry_run: false
  496. # Path to Synapse's homeserver.yaml configuration file.
  497. matrix_authentication_service_syn2mas_synapse_homeserver_config_path: ""
  498. matrix_authentication_service_syn2mas_container_network: "{{ matrix_authentication_service_container_network }}"
  499. # Additional options passed to the syn2mas sub-command (e.g. `mas-cli syn2mas [OPTIONS] migrate|check`).
  500. # Also see: `matrix_authentication_service_syn2mas_subcommand_extra_options`
  501. #
  502. # Example:
  503. # matrix_authentication_service_syn2mas_command_extra_options:
  504. # - "--something"
  505. matrix_authentication_service_syn2mas_command_extra_options: []
  506. # Additional options passed to the syn2mas sub-command (e.g. `mas-cli syn2mas migrate|check [OPTIONS]`).
  507. # Also see: `matrix_authentication_service_syn2mas_command_extra_options`
  508. #
  509. # Example:
  510. # matrix_authentication_service_syn2mas_subcommand_extra_options:
  511. # - "--dry-run"
  512. matrix_authentication_service_syn2mas_subcommand_extra_options: []
  513. ########################################################################################
  514. # #
  515. # /syn2mas configuration #
  516. # #
  517. ########################################################################################
  518. ########################################################################################
  519. # #
  520. # Misc #
  521. # #
  522. ########################################################################################
  523. # Controls whether a migration from a homeserver user database to Matrix Authentication Service is in progress.
  524. #
  525. # When this is set to `true`, the playbook will:
  526. #
  527. # - disable the integration between the homeserver and Matrix Authentication Service
  528. # - avoid setting up the "compatibility layer" (that is, avoid installing container labels that capture login endpoints like `/_matrix/client/*/login`, etc.)
  529. matrix_authentication_service_migration_in_progress: false
  530. # Controls whether the admin API is enabled.
  531. # Ref: https://element-hq.github.io/matrix-authentication-service/topics/admin-api.html#enabling-the-api
  532. matrix_authentication_service_admin_api_enabled: false
  533. ########################################################################################
  534. # #
  535. # /Misc #
  536. # #
  537. ########################################################################################