Matrix Docker Ansible eploy
Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.
 
 

486 lignes
34 KiB

  1. # SPDX-FileCopyrightText: 2024 - 2025 Slavi Pantaleev
  2. # SPDX-FileCopyrightText: 2024 Suguru Hirahara
  3. #
  4. # SPDX-License-Identifier: AGPL-3.0-or-later
  5. ---
  6. # matrix-static-files is a role which generates and serves `/.well-known/matrix` files for the purposes of Matrix Delegation.
  7. # It also exposes some variables which allow this role to be used for serving additional files.
  8. matrix_static_files_enabled: true
  9. matrix_static_files_identifier: matrix-static-files
  10. # renovate: datasource=docker depName=joseluisq/static-web-server
  11. matrix_static_files_version: 2.36.0
  12. matrix_static_files_base_path: "{{ matrix_base_data_path }}/{{ 'static-files' if matrix_static_files_identifier == 'matrix-static-files' else matrix_static_files_identifier }}"
  13. matrix_static_files_config_path: "{{ matrix_static_files_base_path }}/config"
  14. matrix_static_files_public_path: "{{ matrix_static_files_base_path }}/public"
  15. matrix_static_files_public_well_known_path: "{{ matrix_static_files_public_path }}/.well-known"
  16. matrix_static_files_public_well_known_matrix_path: "{{ matrix_static_files_public_well_known_path }}/matrix"
  17. matrix_static_files_public_well_known_element_path: "{{ matrix_static_files_public_well_known_path }}/element"
  18. # List of systemd services that matrix-static-files.service depends on
  19. matrix_static_files_systemd_required_services_list: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
  20. # List of systemd services that matrix-static-files.service wants
  21. matrix_static_files_systemd_wanted_services_list: "{{ matrix_static_files_systemd_wanted_services_list_auto + matrix_static_files_systemd_wanted_services_list_custom }}"
  22. matrix_static_files_systemd_wanted_services_list_auto: []
  23. matrix_static_files_systemd_wanted_services_list_custom: []
  24. matrix_static_files_container_image: "{{ matrix_static_files_container_image_registry_prefix }}joseluisq/static-web-server:{{ matrix_static_files_container_image_tag }}"
  25. matrix_static_files_container_image_registry_prefix: "{{ matrix_static_files_container_image_registry_prefix_upstream }}"
  26. matrix_static_files_container_image_registry_prefix_upstream: "{{ matrix_static_files_container_image_registry_prefix_upstream_default }}"
  27. matrix_static_files_container_image_registry_prefix_upstream_default: "docker.io/"
  28. matrix_static_files_container_image_tag: "{{ 'latest' if matrix_static_files_version == 'latest' else (matrix_static_files_version + '-alpine') }}"
  29. matrix_static_files_container_image_force_pull: "{{ matrix_static_files_container_image.endswith(':latest') }}"
  30. matrix_static_files_container_network: "{{ matrix_static_files_identifier }}"
  31. # A list of additional container networks that matrix-static-files would be connected to.
  32. # The playbook does not create these networks, so make sure they already exist.
  33. matrix_static_files_container_additional_networks: []
  34. # Controls whether the matrix-static-files container exposes its HTTP port (tcp/8080 in the container).
  35. #
  36. # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8080"), or empty string to not expose.
  37. matrix_static_files_container_http_host_bind_port: ''
  38. # matrix_static_files_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container.
  39. # See `../templates/labels.j2` for details.
  40. #
  41. # To inject your own other container labels, see `matrix_static_files_container_labels_additional_labels`.
  42. matrix_static_files_container_labels_traefik_enabled: true
  43. matrix_static_files_container_labels_traefik_docker_network: "{{ matrix_static_files_container_network }}"
  44. matrix_static_files_container_labels_traefik_entrypoints: web-secure
  45. matrix_static_files_container_labels_traefik_tls_certResolver: default # noqa var-naming
  46. # Controls whether labels will be added that expose the `/.well-known/matrix` endpoint on the Matrix domain.
  47. matrix_static_files_container_labels_well_known_matrix_endpoint_enabled: true
  48. matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_hostname: ''
  49. matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_path_prefix: /.well-known/matrix
  50. matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_rule: "Host(`{{ matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_hostname }}`) && PathPrefix(`{{ matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_path_prefix }}`)"
  51. matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_priority: 0
  52. matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_entrypoints: "{{ matrix_static_files_container_labels_traefik_entrypoints }}"
  53. matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_tls: "{{ matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_entrypoints != 'web' }}"
  54. matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_tls_certResolver: "{{ matrix_static_files_container_labels_traefik_tls_certResolver }}" # noqa var-naming
  55. # Controls whether the compress middleware (https://doc.traefik.io/traefik/middlewares/http/compress/) will be enabled for this router.
  56. # The web-server only compresses known file types and our /.well-known/matrix/* files have no file extension.
  57. # As such, they are not being compressed there and we compress them at the Traefik level.
  58. matrix_static_files_container_labels_well_known_matrix_endpoint_middleware_compress_enabled: true
  59. matrix_static_files_container_labels_well_known_matrix_endpoint_middleware_compress_minResponseBodyBytes: 100 # noqa var-naming
  60. # Controls whether labels will be added that expose the `/.well-known/element` endpoint on the Matrix domain.
  61. matrix_static_files_container_labels_well_known_element_endpoint_enabled: true
  62. matrix_static_files_container_labels_well_known_element_endpoint_traefik_hostname: ''
  63. matrix_static_files_container_labels_well_known_element_endpoint_traefik_path_prefix: /.well-known/element
  64. matrix_static_files_container_labels_well_known_element_endpoint_traefik_rule: "Host(`{{ matrix_static_files_container_labels_well_known_element_endpoint_traefik_hostname }}`) && PathPrefix(`{{ matrix_static_files_container_labels_well_known_element_endpoint_traefik_path_prefix }}`)"
  65. matrix_static_files_container_labels_well_known_element_endpoint_traefik_priority: 0
  66. matrix_static_files_container_labels_well_known_element_endpoint_traefik_entrypoints: "{{ matrix_static_files_container_labels_traefik_entrypoints }}"
  67. matrix_static_files_container_labels_well_known_element_endpoint_traefik_tls: "{{ matrix_static_files_container_labels_well_known_element_endpoint_traefik_entrypoints != 'web' }}"
  68. matrix_static_files_container_labels_well_known_element_endpoint_traefik_tls_certResolver: "{{ matrix_static_files_container_labels_traefik_tls_certResolver }}" # noqa var-naming
  69. # Controls whether the compress middleware (https://doc.traefik.io/traefik/middlewares/http/compress/) will be enabled for this router.
  70. # The web-server only compresses known file types and our /.well-known/matrix/* files have no file extension.
  71. # As such, they are not being compressed there and we compress them at the Traefik level.
  72. matrix_static_files_container_labels_well_known_element_endpoint_middleware_compress_enabled: true
  73. matrix_static_files_container_labels_well_known_element_endpoint_middleware_compress_minResponseBodyBytes: 100 # noqa var-naming
  74. # Controls whether labels will be added that serve the base domain.
  75. #
  76. # This is similar to `matrix_static_files_container_labels_well_known_matrix_endpoint_*`, but does more.
  77. #
  78. # It's useful when you'd like to avoid setting up `/.well-known/matrix` redirects and can afford to point the base domain to the Matrix server.
  79. #
  80. # By default, these labels are configured to handle all paths for the provided base domain
  81. # (see `matrix_static_files_container_labels_base_domain_traefik_path_prefix`), not just the `/.well-known/matrix` prefix.
  82. #
  83. # By default, an index.html page is also served (see `matrix_static_files_file_index_html_enabled`).
  84. matrix_static_files_container_labels_base_domain_enabled: false
  85. matrix_static_files_container_labels_base_domain_traefik_hostname: ''
  86. matrix_static_files_container_labels_base_domain_traefik_path_prefix: /
  87. matrix_static_files_container_labels_base_domain_traefik_rule: "Host(`{{ matrix_static_files_container_labels_base_domain_traefik_hostname }}`){% if matrix_static_files_container_labels_base_domain_traefik_path_prefix != '/' %} && PathPrefix(`{{ matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_path_prefix }}`){% endif %}"
  88. matrix_static_files_container_labels_base_domain_traefik_priority: 0
  89. matrix_static_files_container_labels_base_domain_traefik_entrypoints: "{{ matrix_static_files_container_labels_traefik_entrypoints }}"
  90. matrix_static_files_container_labels_base_domain_traefik_tls: "{{ matrix_static_files_container_labels_base_domain_traefik_entrypoints != 'web' }}"
  91. matrix_static_files_container_labels_base_domain_traefik_tls_certResolver: "{{ matrix_static_files_container_labels_traefik_tls_certResolver }}" # noqa var-naming
  92. # Controls whether the root path (/) at the base domain would respond with a redirect to some URL.
  93. matrix_static_files_container_labels_base_domain_root_path_redirection_enabled: false
  94. matrix_static_files_container_labels_base_domain_root_path_redirection_regex: "^{{ matrix_static_files_scheme }}://{{ matrix_static_files_container_labels_base_domain_traefik_hostname }}{{ matrix_static_files_container_labels_base_domain_traefik_path_prefix }}(\\?.*)?$"
  95. matrix_static_files_container_labels_base_domain_root_path_redirection_url: ""
  96. # matrix_static_files_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file.
  97. # See `../templates/labels.j2` for details.
  98. #
  99. # Example:
  100. # matrix_static_files_container_labels_additional_labels: |
  101. # my.label=1
  102. # another.label="here"
  103. matrix_static_files_container_labels_additional_labels: ''
  104. # Controls the SERVER_PORT environment variable.
  105. # See: https://static-web-server.net/configuration/environment-variables/
  106. matrix_static_files_environment_variable_server_port: 8080
  107. # Controls the SERVER_LOG_LEVEL environment variable.
  108. # See: https://static-web-server.net/configuration/environment-variables/
  109. # Valid values: error, warn, info, debug or trace
  110. matrix_static_files_environment_variable_server_log_level: error
  111. # Controls the SERVER_LOG_REMOTE_ADDRESS environment variable.
  112. # See: https://static-web-server.net/configuration/environment-variables/
  113. matrix_static_files_environment_variable_server_log_remote_address: false
  114. # Controls the SERVER_CONFIG_FILE environment variable.
  115. # See: https://static-web-server.net/configuration/environment-variables/
  116. matrix_static_files_environment_variable_server_config_file: /config/config.toml
  117. # Additional environment variables.
  118. matrix_static_files_environment_variables_additional_variables: ''
  119. # Controls the caching time (max-age property of the `Cache-Control` HTTP header) for all `/.well-known/matrix/*` files.
  120. # We use a somewhat long expires value is to prevent outages in case this is unreachable due to network failure
  121. # or due to the base domain's server completely dying.
  122. matrix_static_files_files_cache_time_hours: 4
  123. ########################################################################
  124. # #
  125. # Related to /.well-known/matrix/client #
  126. # #
  127. ########################################################################
  128. # Controls the m.homeserver/base_url property in the /.well-known/matrix/client file
  129. matrix_static_files_file_matrix_client_property_m_homeserver_base_url: "{{ matrix_homeserver_url }}"
  130. # Controls the m.identity_server/base_url property in the /.well-known/matrix/client file
  131. matrix_static_files_file_matrix_client_property_m_identity_server_base_url: "{{ matrix_identity_server_url }}"
  132. # Controls the m.integrations/managers/0/api_url property in the /.well-known/matrix/client file
  133. matrix_static_files_file_matrix_client_property_m_integrations_managers_api_url: "{{ matrix_integration_manager_rest_url }}"
  134. # Controls the m.integrations/managers/0/ui_url property in the /.well-known/matrix/client file
  135. matrix_static_files_file_matrix_client_property_m_integrations_managers_ui_url: "{{ matrix_integration_manager_ui_url }}"
  136. # Controls the io.element.jitsi/preferredDomain property in the /.well-known/matrix/client file
  137. # This specifies the domain name where a Jitsi server is self-hosted.
  138. # If set, `/.well-known/matrix/client` will suggest Element clients to use that Jitsi server.
  139. # See: https://github.com/element-hq/element-web/blob/develop/docs/jitsi.md#configuring-element-to-use-your-self-hosted-jitsi-server
  140. matrix_static_files_file_matrix_client_property_io_element_jitsi_preferred_domain: ""
  141. # Controls if the org.matrix.msc3575.authentication section of the /.well-known/matrix/client file is enabled.
  142. matrix_static_files_file_matrix_client_property_org_matrix_msc2965_authentication_enabled: false
  143. # Controls the org.matrix.msc2965.authentication/issuer property in the /.well-known/matrix/client file
  144. matrix_static_files_file_matrix_client_property_org_matrix_msc2965_authentication_issuer: ""
  145. # Controls the org.matrix.msc2965.authentication/account property in the /.well-known/matrix/client file
  146. matrix_static_files_file_matrix_client_property_org_matrix_msc2965_authentication_account: ""
  147. # Controls the org.matrix.msc3575.proxy/url (sliding sync) property in the /.well-known/matrix/client file
  148. matrix_static_files_file_matrix_client_property_org_matrix_msc3575_proxy_url: ""
  149. # Controls whether the m.tile_server configuration is added to the /.well-known/matrix/client file
  150. matrix_static_files_file_matrix_client_property_m_tile_server_entries_enabled: false
  151. # Controls the m.tile_server/map_style_url property in the /.well-known/matrix/client file
  152. matrix_static_files_file_matrix_client_property_m_tile_server_map_style_url: ""
  153. # Controls whether Element related entries (io.element.e2ee) should be added to the client well-known.
  154. # By default if any of the following change from their default this would be set to true:
  155. # `matrix_static_files_file_matrix_client_property_io_element_e2ee_default`
  156. # `matrix_static_files_file_matrix_client_property_io_element_e2ee_secure_backup_required`
  157. # `matrix_static_files_file_matrix_client_property_io_element_e2ee_secure_backup_setup_methods`
  158. matrix_static_files_file_matrix_client_property_io_element_e2ee_entries_enabled: "{{ not matrix_static_files_file_matrix_client_property_io_element_e2ee_default or matrix_static_files_file_matrix_client_property_io_element_e2ee_secure_backup_required or matrix_static_files_file_matrix_client_property_io_element_e2ee_secure_backup_setup_methods | length > 0 }}"
  159. # Controls the io.element.e2ee/default property in the /.well-known/matrix/client file,
  160. # which instructs Element clients whether they should use End-to-End Encryption by default.
  161. # Setting this to false will update `/.well-known/matrix/client` and tell Element clients to avoid E2EE.
  162. # See: https://github.com/element-hq/element-web/blob/develop/docs/e2ee.md
  163. matrix_static_files_file_matrix_client_property_io_element_e2ee_default: true
  164. # Controls the io.element.e2ee/secure_backup_required property in the /.well-known/matrix/client file,
  165. # which instructs Element clients whether they should require a secure backup set up before they can be used.
  166. # Setting this to true will update `/.well-known/matrix/client` and tell Element clients require a secure backup.
  167. # See: https://github.com/element-hq/element-web/blob/develop/docs/e2ee.md
  168. matrix_static_files_file_matrix_client_property_io_element_e2ee_secure_backup_required: false
  169. # Controls the io.element.e2ee/secure_backup_setup_methods property in the /.well-known/matrix/client file,
  170. # which instructs Element clients which backup methods from ["key", "passphrase"] should be used.
  171. # When an empty list is provided, Element clients default to using both.
  172. # Setting this to other than empty will update `/.well-known/matrix/client` and tell Element clients which method to use.
  173. # See: https://github.com/element-hq/element-web/blob/develop/docs/e2ee.md
  174. matrix_static_files_file_matrix_client_property_io_element_e2ee_secure_backup_setup_methods: []
  175. # Controls the io.element.e2ee/force_disable property in the /.well-known/matrix/client file,
  176. # which can be set to `true` to instruct Element clients whether to disable End-to-End Encryption by default
  177. # and to not show encryption related-settings in room settings.
  178. # See: https://github.com/element-hq/element-web/blob/develop/docs/e2ee.md
  179. matrix_static_files_file_matrix_client_property_io_element_e2ee_force_disable: false
  180. # Controls whether `cc.etke.synapse-admin`-related entries should be added to the client well-known.
  181. # By default, if there are entries in `matrix_static_files_file_matrix_client_property_cc_etke_synapse_admin`, we show them (by enabling this).
  182. matrix_static_files_file_matrix_client_property_cc_etke_synapse_admin_enabled: "{{ matrix_static_files_file_matrix_client_property_cc_etke_synapse_admin | default({}) | dict2items | length > 0 }}"
  183. # Controls the cc.etke.synapse-admin property in the /.well-known/matrix/client file.
  184. # See `matrix_static_files_file_matrix_client_property_cc_etke_synapse_admin_entries_enabled`
  185. matrix_static_files_file_matrix_client_property_cc_etke_synapse_admin: "{{ matrix_static_files_file_matrix_client_property_cc_etke_synapse_admin_auto | combine(matrix_static_files_file_matrix_client_property_cc_etke_synapse_admin_custom, recursive=True) }}"
  186. matrix_static_files_file_matrix_client_property_cc_etke_synapse_admin_auto: {}
  187. matrix_static_files_file_matrix_client_property_cc_etke_synapse_admin_custom: {}
  188. # Controls whether `org.matrix.msc4143.rtc_foci`-related entries should be added to the client well-known.
  189. # By default, if there are entries in `matrix_static_files_file_matrix_client_property_org_matrix_msc4143_rtc_foci`, we show them (by enabling this).
  190. matrix_static_files_file_matrix_client_property_org_matrix_msc4143_rtc_foci_enabled: "{{ matrix_static_files_file_matrix_client_property_org_matrix_msc4143_rtc_foci | default({}) | dict2items | length > 0 }}"
  191. # Controls the org.matrix.msc4143.rtc_foci property in the /.well-known/matrix/client file.
  192. # See `matrix_static_files_file_matrix_client_property_org_matrix_msc4143_rtc_foci_enabled`
  193. matrix_static_files_file_matrix_client_property_org_matrix_msc4143_rtc_foci: "{{ matrix_static_files_file_matrix_client_property_org_matrix_msc4143_rtc_foci_auto+ matrix_static_files_file_matrix_client_property_org_matrix_msc4143_rtc_foci_custom }}"
  194. matrix_static_files_file_matrix_client_property_org_matrix_msc4143_rtc_foci_auto: []
  195. matrix_static_files_file_matrix_client_property_org_matrix_msc4143_rtc_foci_custom: []
  196. # Default /.well-known/matrix/client configuration template which covers the generic use case.
  197. # You can customize it by controlling the various variables inside it.
  198. #
  199. # For a more advanced customization, you can extend the default (see `matrix_static_files_file_matrix_client_configuration_extension_json`)
  200. # or completely replace this variable with your own template.
  201. matrix_static_files_file_matrix_client_configuration_json: "{{ lookup('template', 'templates/public/.well-known/matrix/client.j2') }}"
  202. # Your custom JSON configuration for /.well-known/matrix/client should go to `matrix_static_files_file_matrix_client_configuration_extension_json`.
  203. # This configuration extends the default starting configuration (`matrix_static_files_file_matrix_client_configuration_extension_json`).
  204. #
  205. # You can override individual variables from the default configuration, or introduce new ones.
  206. #
  207. # If you need something more special, you can take full control by
  208. # completely redefining `matrix_static_files_file_matrix_client_configuration_json`.
  209. #
  210. # Example configuration extension follows:
  211. #
  212. # matrix_static_files_file_matrix_client_configuration_extension_json: |
  213. # {
  214. # "m.another": "value",
  215. # "m.yet_another": 3
  216. # }
  217. matrix_static_files_file_matrix_client_configuration_extension_json: '{}'
  218. matrix_static_files_file_matrix_client_configuration_extension: "{{ matrix_static_files_file_matrix_client_configuration_extension_json | from_json if matrix_static_files_file_matrix_client_configuration_extension_json | from_json is mapping else {} }}"
  219. # Holds the final /.well-known/matrix/client configuration (a combination of the default and its extension).
  220. # You most likely don't need to touch this variable. Instead, see `matrix_static_files_file_matrix_client_configuration_json` or `matrix_static_files_file_matrix_client_configuration_extension_json`.
  221. matrix_static_files_file_matrix_client_configuration: "{{ matrix_static_files_file_matrix_client_configuration_json | combine(matrix_static_files_file_matrix_client_configuration_extension, recursive=True) }}"
  222. ########################################################################
  223. # #
  224. # /Related to /.well-known/matrix/client #
  225. # #
  226. ########################################################################
  227. ########################################################################
  228. # #
  229. # Related to /.well-known/matrix/server #
  230. # #
  231. ########################################################################
  232. # Controls whether a `/.well-known/matrix/server` file is generated and used at all.
  233. #
  234. # If you wish to rely on DNS SRV records only, you can disable this.
  235. # Using DNS SRV records implies that you'll be handling Matrix Federation API traffic (tcp/8448)
  236. # using certificates for the base domain (`matrix_domain`) and not for the
  237. # Matrix domain (`matrix_server_fqn_matrix`).
  238. matrix_static_files_file_matrix_server_enabled: true
  239. # Controls the m.server property in the /.well-known/matrix/server file
  240. matrix_static_files_file_matrix_server_property_m_server: ''
  241. # Default /.well-known/matrix/server configuration template which covers the generic use case.
  242. # You can customize it by controlling the various variables inside it.
  243. #
  244. # For a more advanced customization, you can extend the default (see `matrix_static_files_file_matrix_server_configuration_extension_json`)
  245. # or completely replace this variable with your own template.
  246. matrix_static_files_file_matrix_server_configuration_json: "{{ lookup('template', 'templates/public/.well-known/matrix/server.j2') }}"
  247. # Your custom JSON configuration for /.well-known/matrix/server should go to `matrix_static_files_file_matrix_server_configuration_extension_json`.
  248. # This configuration extends the default starting configuration (`matrix_static_files_file_matrix_server_configuration_extension_json`).
  249. #
  250. # You can override individual variables from the default configuration, or introduce new ones.
  251. #
  252. # If you need something more special, you can take full control by
  253. # completely redefining `matrix_static_files_file_matrix_server_configuration_json`.
  254. #
  255. # Example configuration extension follows:
  256. #
  257. # matrix_static_files_file_matrix_server_configuration_extension_json: |
  258. # {
  259. # "m.another": "value",
  260. # "m.yet_another": 3
  261. # }
  262. matrix_static_files_file_matrix_server_configuration_extension_json: '{}'
  263. matrix_static_files_file_matrix_server_configuration_extension: "{{ matrix_static_files_file_matrix_server_configuration_extension_json | from_json if matrix_static_files_file_matrix_server_configuration_extension_json | from_json is mapping else {} }}"
  264. # Holds the final /.well-known/matrix/server configuration (a combination of the default and its extension).
  265. # You most likely don't need to touch this variable. Instead, see `matrix_static_files_file_matrix_server_configuration_json` or `matrix_static_files_file_matrix_server_configuration_extension_json`.
  266. matrix_static_files_file_matrix_server_configuration: "{{ matrix_static_files_file_matrix_server_configuration_json | combine(matrix_static_files_file_matrix_server_configuration_extension, recursive=True) }}"
  267. ########################################################################
  268. # #
  269. # /Related to /.well-known/matrix/server #
  270. # #
  271. ########################################################################
  272. ########################################################################
  273. # #
  274. # Related to /.well-known/matrix/support #
  275. # #
  276. ########################################################################
  277. # Controls whether a `/.well-known/matrix/support` file is generated and used at all.
  278. # For details about this file, see the spec: https://github.com/matrix-org/matrix-spec-proposals/pull/1929
  279. #
  280. # This is not enabled by default, as for it to be useful, other information is necessary.
  281. # See `matrix_static_files_file_matrix_support_property_m_contacts`, `matrix_static_files_file_matrix_support_property_m_support_page`, etc.
  282. matrix_static_files_file_matrix_support_enabled: false
  283. # Controls the m.contacts property in the /.well-known/matrix/support file
  284. matrix_static_files_file_matrix_support_property_m_contacts: []
  285. # Controls the m.support_page property in the /.well-known/matrix/support file
  286. matrix_static_files_file_matrix_support_property_m_support_page: ""
  287. # Default /.well-known/matrix/support configuration template which covers the generic use case.
  288. # You can customize it by controlling the various variables inside it.
  289. #
  290. # For a more advanced customization, you can extend the default (see `matrix_static_files_file_matrix_support_configuration_extension_json`)
  291. # or completely replace this variable with your own template.
  292. matrix_static_files_file_matrix_support_configuration_json: "{{ lookup('template', 'templates/public/.well-known/matrix/support.j2') }}"
  293. # Your custom JSON configuration for /.well-known/matrix/support should go to `matrix_static_files_file_matrix_support_configuration_extension_json`.
  294. # This configuration extends the default starting configuration (`matrix_static_files_file_matrix_support_configuration_extension_json`).
  295. #
  296. # You can override individual variables from the default configuration, or introduce new ones.
  297. #
  298. # If you need something more special, you can take full control by
  299. # completely redefining `matrix_static_files_file_matrix_support_configuration_json`.
  300. #
  301. # Example configuration extension follows:
  302. #
  303. # matrix_static_files_file_matrix_support_configuration_extension_json: |
  304. # {
  305. # "m.another": "value",
  306. # "m.yet_another": 3
  307. # }
  308. matrix_static_files_file_matrix_support_configuration_extension_json: '{}'
  309. matrix_static_files_file_matrix_support_configuration_extension: "{{ matrix_static_files_file_matrix_support_configuration_extension_json | from_json if matrix_static_files_file_matrix_support_configuration_extension_json | from_json is mapping else {} }}"
  310. # Holds the final /.well-known/matrix/support configuration (a combination of the default and its extension).
  311. # You most likely don't need to touch this variable. Instead, see `matrix_static_files_file_matrix_support_configuration_json` or `matrix_static_files_file_matrix_support_configuration_extension_json`.
  312. matrix_static_files_file_matrix_support_configuration: "{{ matrix_static_files_file_matrix_support_configuration_json | combine(matrix_static_files_file_matrix_support_configuration_extension, recursive=True) }}"
  313. ########################################################################
  314. # #
  315. # /Related to /.well-known/matrix/support #
  316. # #
  317. ########################################################################
  318. ########################################################################
  319. # #
  320. # Related to /.well-known/element/element.json #
  321. # #
  322. ########################################################################
  323. # Controls whether a `/.well-known/element/element.json` file is generated and used at all.
  324. matrix_static_files_file_element_element_json_enabled: true
  325. # Controls the call.widget_url property in the /.well-known/element/element.json file
  326. matrix_static_files_file_element_element_json_property_call_widget_url: ''
  327. # Default /.well-known/element/element.json configuration template which covers the generic use case.
  328. # You can customize it by controlling the various variables inside it.
  329. #
  330. # For a more advanced customization, you can extend the default (see `matrix_static_files_file_matrix_support_configuration_extension_json`)
  331. # or completely replace this variable with your own template.
  332. matrix_static_files_file_element_element_json_configuration_json: "{{ lookup('template', 'templates/public/.well-known/element/element.json.j2') }}"
  333. # Your custom JSON configuration for /.well-known/element/element.json should go to `matrix_static_files_file_element_element_json_configuration_extension_json`.
  334. # This configuration extends the default starting configuration (`matrix_static_files_file_matrix_support_configuration_extension_json`).
  335. #
  336. # You can override individual variables from the default configuration, or introduce new ones.
  337. #
  338. # If you need something more special, you can take full control by
  339. # completely redefining `matrix_static_files_file_matrix_support_configuration_json`.
  340. #
  341. # Example configuration extension follows:
  342. #
  343. # matrix_static_files_file_element_element_json_configuration_extension_json: |
  344. # {
  345. # "call": {
  346. # "url": "value"
  347. # }
  348. # }
  349. matrix_static_files_file_element_element_json_configuration_extension_json: '{}'
  350. matrix_static_files_file_element_element_json_configuration_extension: "{{ matrix_static_files_file_element_element_json_configuration_extension_json | from_json if matrix_static_files_file_element_element_json_configuration_extension_json | from_json is mapping else {} }}"
  351. # Holds the final /.well-known/matrix/support configuration (a combination of the default and its extension).
  352. # You most likely don't need to touch this variable. Instead, see `matrix_static_files_file_element_element_json_configuration_json` or `matrix_static_files_file_element_element_json_configuration_extension_json`.
  353. matrix_static_files_file_element_element_json_configuration: "{{ matrix_static_files_file_element_element_json_configuration_json | combine(matrix_static_files_file_element_element_json_configuration_extension, recursive=True) }}"
  354. ########################################################################
  355. # #
  356. # /Related to /.well-known/element/element.json #
  357. # #
  358. ########################################################################
  359. ########################################################################
  360. # #
  361. # Related to index.html #
  362. # #
  363. ########################################################################
  364. # Controls whether `matrix_static_files_file_index_html_template` would be dumped to an `index.html` file
  365. # in the public directory (matrix_static_files_public_path).
  366. #
  367. # This is useful if you have enabled serving of the base domain (matrix_static_files_container_labels_base_domain_enabled)
  368. # and wish to serve more than just the `/.well-known/matrix` files from it.
  369. #
  370. # You can also use the auxiliary role (https://github.com/mother-of-all-self-hosting/ansible-role-aux) to create files in
  371. # the public directory (matrix_static_files_public_path) by yourself.
  372. # If you're disabling this but are preparing some HTML files by yourself,
  373. # consider explicitly disabling `matrix_static_files_container_labels_base_domain_root_path_redirection_enabled` as well.
  374. # The default behavior when this is disabled is to enable root-path-redirection.
  375. #
  376. # Because you may wish to manage these static files yourself, disabling this variable will intentionally not delete an already existing `index.html` file.
  377. matrix_static_files_file_index_html_enabled: "{{ matrix_static_files_container_labels_base_domain_enabled }}"
  378. matrix_static_files_file_index_html_template: |-
  379. <!doctype html>
  380. <meta charset="utf-8" />
  381. <html>
  382. <body>
  383. Hello from {{ matrix_static_files_container_labels_base_domain_traefik_hostname }}!
  384. </body>
  385. </html>
  386. ########################################################################
  387. # #
  388. # /Related to /index.html #
  389. # #
  390. ########################################################################
  391. matrix_static_files_scheme: https
  392. # Controls whether the self-check feature should validate SSL certificates.
  393. matrix_static_files_self_check_validate_certificates: "{{ matrix_static_files_scheme == 'https' }}"
  394. matrix_static_files_self_check_hostname_matrix: ''
  395. matrix_static_files_self_check_hostname_identity: ''
  396. # Controls whether redirects will be followed when checking the `/.well-known/matrix/client` resource.
  397. #
  398. # As per the spec (https://matrix.org/docs/spec/client_server/r0.6.0#well-known-uri), it shouldn't be,
  399. # so we default to not following redirects as well.
  400. matrix_static_files_self_check_well_known_matrix_client_follow_redirects: none