Matrix Docker Ansible eploy
Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.

421 строка
28 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.41.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 serve the base domain.
  61. #
  62. # This is similar to `matrix_static_files_container_labels_well_known_matrix_endpoint_*`, but does more.
  63. #
  64. # 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.
  65. #
  66. # By default, these labels are configured to handle all paths for the provided base domain
  67. # (see `matrix_static_files_container_labels_base_domain_traefik_path_prefix`), not just the `/.well-known/matrix` prefix.
  68. #
  69. # By default, an index.html page is also served (see `matrix_static_files_file_index_html_enabled`).
  70. matrix_static_files_container_labels_base_domain_enabled: false
  71. matrix_static_files_container_labels_base_domain_traefik_hostname: ''
  72. matrix_static_files_container_labels_base_domain_traefik_path_prefix: /
  73. 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 %}"
  74. matrix_static_files_container_labels_base_domain_traefik_priority: 0
  75. matrix_static_files_container_labels_base_domain_traefik_entrypoints: "{{ matrix_static_files_container_labels_traefik_entrypoints }}"
  76. matrix_static_files_container_labels_base_domain_traefik_tls: "{{ matrix_static_files_container_labels_base_domain_traefik_entrypoints != 'web' }}"
  77. matrix_static_files_container_labels_base_domain_traefik_tls_certResolver: "{{ matrix_static_files_container_labels_traefik_tls_certResolver }}" # noqa var-naming
  78. # Controls whether the root path (/) at the base domain would respond with a redirect to some URL.
  79. matrix_static_files_container_labels_base_domain_root_path_redirection_enabled: false
  80. 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 }}(\\?.*)?$"
  81. matrix_static_files_container_labels_base_domain_root_path_redirection_url: ""
  82. # matrix_static_files_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file.
  83. # See `../templates/labels.j2` for details.
  84. #
  85. # Example:
  86. # matrix_static_files_container_labels_additional_labels: |
  87. # my.label=1
  88. # another.label="here"
  89. matrix_static_files_container_labels_additional_labels: ''
  90. # Controls the SERVER_PORT environment variable.
  91. # See: https://static-web-server.net/configuration/environment-variables/
  92. matrix_static_files_environment_variable_server_port: 8080
  93. # Controls the SERVER_LOG_LEVEL environment variable.
  94. # See: https://static-web-server.net/configuration/environment-variables/
  95. # Valid values: error, warn, info, debug or trace
  96. matrix_static_files_environment_variable_server_log_level: error
  97. # Controls the SERVER_LOG_REMOTE_ADDRESS environment variable.
  98. # See: https://static-web-server.net/configuration/environment-variables/
  99. matrix_static_files_environment_variable_server_log_remote_address: false
  100. # Controls the SERVER_CONFIG_FILE environment variable.
  101. # See: https://static-web-server.net/configuration/environment-variables/
  102. matrix_static_files_environment_variable_server_config_file: /config/config.toml
  103. # Controls the SERVER_IGNORE_HIDDEN_FILES environment variable.
  104. # See: https://static-web-server.net/configuration/environment-variables/
  105. matrix_static_files_environment_variable_server_ignore_hidden_files: false
  106. # Additional environment variables.
  107. matrix_static_files_environment_variables_additional_variables: ''
  108. # Controls the caching time (max-age property of the `Cache-Control` HTTP header) for all `/.well-known/matrix/*` files.
  109. # We use a somewhat long expires value is to prevent outages in case this is unreachable due to network failure
  110. # or due to the base domain's server completely dying.
  111. matrix_static_files_files_cache_time_hours: 4
  112. ########################################################################
  113. # #
  114. # Related to /.well-known/matrix/client #
  115. # #
  116. ########################################################################
  117. # Controls the m.homeserver/base_url property in the /.well-known/matrix/client file
  118. matrix_static_files_file_matrix_client_property_m_homeserver_base_url: "{{ matrix_homeserver_url }}"
  119. # Controls the m.identity_server/base_url property in the /.well-known/matrix/client file
  120. matrix_static_files_file_matrix_client_property_m_identity_server_base_url: "{{ matrix_identity_server_url }}"
  121. # Controls the m.integrations/managers/0/api_url property in the /.well-known/matrix/client file
  122. matrix_static_files_file_matrix_client_property_m_integrations_managers_api_url: "{{ matrix_integration_manager_rest_url }}"
  123. # Controls the m.integrations/managers/0/ui_url property in the /.well-known/matrix/client file
  124. matrix_static_files_file_matrix_client_property_m_integrations_managers_ui_url: "{{ matrix_integration_manager_ui_url }}"
  125. # Controls the io.element.jitsi/preferredDomain property in the /.well-known/matrix/client file
  126. # This specifies the domain name where a Jitsi server is self-hosted.
  127. # If set, `/.well-known/matrix/client` will suggest Element clients to use that Jitsi server.
  128. # See: https://github.com/element-hq/element-web/blob/develop/docs/jitsi.md#configuring-element-to-use-your-self-hosted-jitsi-server
  129. matrix_static_files_file_matrix_client_property_io_element_jitsi_preferred_domain: ""
  130. # Controls if the org.matrix.msc3575.authentication section of the /.well-known/matrix/client file is enabled.
  131. matrix_static_files_file_matrix_client_property_org_matrix_msc2965_authentication_enabled: false
  132. # Controls the org.matrix.msc2965.authentication/issuer property in the /.well-known/matrix/client file
  133. matrix_static_files_file_matrix_client_property_org_matrix_msc2965_authentication_issuer: ""
  134. # Controls the org.matrix.msc2965.authentication/account property in the /.well-known/matrix/client file
  135. matrix_static_files_file_matrix_client_property_org_matrix_msc2965_authentication_account: ""
  136. # Controls the org.matrix.msc3575.proxy/url (sliding sync) property in the /.well-known/matrix/client file
  137. matrix_static_files_file_matrix_client_property_org_matrix_msc3575_proxy_url: ""
  138. # Controls whether the m.tile_server configuration is added to the /.well-known/matrix/client file
  139. matrix_static_files_file_matrix_client_property_m_tile_server_entries_enabled: false
  140. # Controls the m.tile_server/map_style_url property in the /.well-known/matrix/client file
  141. matrix_static_files_file_matrix_client_property_m_tile_server_map_style_url: ""
  142. # Controls whether Element related entries (io.element.e2ee) should be added to the client well-known.
  143. # By default if any of the following change from their default this would be set to true:
  144. # - `matrix_static_files_file_matrix_client_property_io_element_e2ee_default`
  145. # - `matrix_static_files_file_matrix_client_property_io_element_e2ee_force_disable`
  146. 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_force_disable }}"
  147. # Controls the io.element.e2ee/default property in the /.well-known/matrix/client file,
  148. # which instructs Element clients whether they should use End-to-End Encryption by default.
  149. # Setting this to false will update `/.well-known/matrix/client` and tell Element clients to avoid E2EE.
  150. # See: https://github.com/element-hq/element-web/blob/develop/docs/e2ee.md
  151. matrix_static_files_file_matrix_client_property_io_element_e2ee_default: true
  152. # Controls the io.element.e2ee/force_disable property in the /.well-known/matrix/client file,
  153. # which can be set to `true` to instruct Element clients whether to disable End-to-End Encryption by default
  154. # and to not show encryption related-settings in room settings.
  155. # See: https://github.com/element-hq/element-web/blob/develop/docs/e2ee.md
  156. matrix_static_files_file_matrix_client_property_io_element_e2ee_force_disable: false
  157. # Controls whether `cc.etke.synapse-admin`-related entries should be added to the client well-known.
  158. # By default, if there are entries in `matrix_static_files_file_matrix_client_property_cc_etke_synapse_admin`, we show them (by enabling this).
  159. 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 }}"
  160. # Controls the cc.etke.synapse-admin property in the /.well-known/matrix/client file.
  161. # See `matrix_static_files_file_matrix_client_property_cc_etke_synapse_admin_entries_enabled`
  162. 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) }}"
  163. matrix_static_files_file_matrix_client_property_cc_etke_synapse_admin_auto: {}
  164. matrix_static_files_file_matrix_client_property_cc_etke_synapse_admin_custom: {}
  165. # Controls whether `org.matrix.msc4143.rtc_foci`-related entries should be added to the client well-known.
  166. # 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).
  167. 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 }}"
  168. # Controls the org.matrix.msc4143.rtc_foci property in the /.well-known/matrix/client file.
  169. # See `matrix_static_files_file_matrix_client_property_org_matrix_msc4143_rtc_foci_enabled`
  170. 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 }}"
  171. matrix_static_files_file_matrix_client_property_org_matrix_msc4143_rtc_foci_auto: []
  172. matrix_static_files_file_matrix_client_property_org_matrix_msc4143_rtc_foci_custom: []
  173. # Default /.well-known/matrix/client configuration template which covers the generic use case.
  174. # You can customize it by controlling the various variables inside it.
  175. #
  176. # For a more advanced customization, you can extend the default (see `matrix_static_files_file_matrix_client_configuration_extension_json`)
  177. # or completely replace this variable with your own template.
  178. matrix_static_files_file_matrix_client_configuration_json: "{{ lookup('template', 'templates/public/.well-known/matrix/client.j2', convert_data=False) | from_json }}"
  179. # Your custom JSON configuration for /.well-known/matrix/client should go to `matrix_static_files_file_matrix_client_configuration_extension_json`.
  180. # This configuration extends the default starting configuration (`matrix_static_files_file_matrix_client_configuration_extension_json`).
  181. #
  182. # You can override individual variables from the default configuration, or introduce new ones.
  183. #
  184. # If you need something more special, you can take full control by
  185. # completely redefining `matrix_static_files_file_matrix_client_configuration_json`.
  186. #
  187. # Example configuration extension follows:
  188. #
  189. # matrix_static_files_file_matrix_client_configuration_extension_json: |
  190. # {
  191. # "m.another": "value",
  192. # "m.yet_another": 3
  193. # }
  194. matrix_static_files_file_matrix_client_configuration_extension_json: '{}'
  195. 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 {} }}"
  196. # Holds the final /.well-known/matrix/client configuration (a combination of the default and its extension).
  197. # 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`.
  198. 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) }}"
  199. ########################################################################
  200. # #
  201. # /Related to /.well-known/matrix/client #
  202. # #
  203. ########################################################################
  204. ########################################################################
  205. # #
  206. # Related to /.well-known/matrix/server #
  207. # #
  208. ########################################################################
  209. # Controls whether a `/.well-known/matrix/server` file is generated and used at all.
  210. #
  211. # If you wish to rely on DNS SRV records only, you can disable this.
  212. # Using DNS SRV records implies that you'll be handling Matrix Federation API traffic (tcp/8448)
  213. # using certificates for the base domain (`matrix_domain`) and not for the
  214. # Matrix domain (`matrix_server_fqn_matrix`).
  215. matrix_static_files_file_matrix_server_enabled: true
  216. # Controls the m.server property in the /.well-known/matrix/server file
  217. matrix_static_files_file_matrix_server_property_m_server: ''
  218. # Default /.well-known/matrix/server configuration template which covers the generic use case.
  219. # You can customize it by controlling the various variables inside it.
  220. #
  221. # For a more advanced customization, you can extend the default (see `matrix_static_files_file_matrix_server_configuration_extension_json`)
  222. # or completely replace this variable with your own template.
  223. matrix_static_files_file_matrix_server_configuration_json: "{{ lookup('template', 'templates/public/.well-known/matrix/server.j2', convert_data=False) | from_json }}"
  224. # Your custom JSON configuration for /.well-known/matrix/server should go to `matrix_static_files_file_matrix_server_configuration_extension_json`.
  225. # This configuration extends the default starting configuration (`matrix_static_files_file_matrix_server_configuration_extension_json`).
  226. #
  227. # You can override individual variables from the default configuration, or introduce new ones.
  228. #
  229. # If you need something more special, you can take full control by
  230. # completely redefining `matrix_static_files_file_matrix_server_configuration_json`.
  231. #
  232. # Example configuration extension follows:
  233. #
  234. # matrix_static_files_file_matrix_server_configuration_extension_json: |
  235. # {
  236. # "m.another": "value",
  237. # "m.yet_another": 3
  238. # }
  239. matrix_static_files_file_matrix_server_configuration_extension_json: '{}'
  240. 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 {} }}"
  241. # Holds the final /.well-known/matrix/server configuration (a combination of the default and its extension).
  242. # 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`.
  243. 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) }}"
  244. ########################################################################
  245. # #
  246. # /Related to /.well-known/matrix/server #
  247. # #
  248. ########################################################################
  249. ########################################################################
  250. # #
  251. # Related to /.well-known/matrix/support #
  252. # #
  253. ########################################################################
  254. # Controls whether a `/.well-known/matrix/support` file is generated and used at all.
  255. # For details about this file, see the spec: https://github.com/matrix-org/matrix-spec-proposals/pull/1929
  256. #
  257. # This is not enabled by default, as for it to be useful, other information is necessary.
  258. # See `matrix_static_files_file_matrix_support_property_m_contacts`, `matrix_static_files_file_matrix_support_property_m_support_page`, etc.
  259. matrix_static_files_file_matrix_support_enabled: false
  260. # Controls the m.contacts property in the /.well-known/matrix/support file
  261. matrix_static_files_file_matrix_support_property_m_contacts: []
  262. # Controls the m.support_page property in the /.well-known/matrix/support file
  263. matrix_static_files_file_matrix_support_property_m_support_page: ""
  264. # Default /.well-known/matrix/support configuration template which covers the generic use case.
  265. # You can customize it by controlling the various variables inside it.
  266. #
  267. # For a more advanced customization, you can extend the default (see `matrix_static_files_file_matrix_support_configuration_extension_json`)
  268. # or completely replace this variable with your own template.
  269. matrix_static_files_file_matrix_support_configuration_json: "{{ lookup('template', 'templates/public/.well-known/matrix/support.j2', convert_data=False) | from_json }}"
  270. # Your custom JSON configuration for /.well-known/matrix/support should go to `matrix_static_files_file_matrix_support_configuration_extension_json`.
  271. # This configuration extends the default starting configuration (`matrix_static_files_file_matrix_support_configuration_extension_json`).
  272. #
  273. # You can override individual variables from the default configuration, or introduce new ones.
  274. #
  275. # If you need something more special, you can take full control by
  276. # completely redefining `matrix_static_files_file_matrix_support_configuration_json`.
  277. #
  278. # Example configuration extension follows:
  279. #
  280. # matrix_static_files_file_matrix_support_configuration_extension_json: |
  281. # {
  282. # "m.another": "value",
  283. # "m.yet_another": 3
  284. # }
  285. matrix_static_files_file_matrix_support_configuration_extension_json: '{}'
  286. 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 {} }}"
  287. # Holds the final /.well-known/matrix/support configuration (a combination of the default and its extension).
  288. # 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`.
  289. 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) }}"
  290. ########################################################################
  291. # #
  292. # /Related to /.well-known/matrix/support #
  293. # #
  294. ########################################################################
  295. ########################################################################
  296. # #
  297. # Related to index.html #
  298. # #
  299. ########################################################################
  300. # Controls whether `matrix_static_files_file_index_html_template` would be dumped to an `index.html` file
  301. # in the public directory (matrix_static_files_public_path).
  302. #
  303. # This is useful if you have enabled serving of the base domain (matrix_static_files_container_labels_base_domain_enabled)
  304. # and wish to serve more than just the `/.well-known/matrix` files from it.
  305. #
  306. # You can also use the auxiliary role (https://github.com/mother-of-all-self-hosting/ansible-role-aux) to create files in
  307. # the public directory (matrix_static_files_public_path) by yourself.
  308. # If you're disabling this but are preparing some HTML files by yourself,
  309. # consider explicitly disabling `matrix_static_files_container_labels_base_domain_root_path_redirection_enabled` as well.
  310. # The default behavior when this is disabled is to enable root-path-redirection.
  311. #
  312. # Because you may wish to manage these static files yourself, disabling this variable will intentionally not delete an already existing `index.html` file.
  313. matrix_static_files_file_index_html_enabled: "{{ matrix_static_files_container_labels_base_domain_enabled }}"
  314. matrix_static_files_file_index_html_template: |-
  315. <!doctype html>
  316. <meta charset="utf-8" />
  317. <html>
  318. <body>
  319. Hello from {{ matrix_static_files_container_labels_base_domain_traefik_hostname }}!
  320. </body>
  321. </html>
  322. ########################################################################
  323. # #
  324. # /Related to /index.html #
  325. # #
  326. ########################################################################
  327. matrix_static_files_scheme: https
  328. # Controls whether the self-check feature should validate SSL certificates.
  329. matrix_static_files_self_check_validate_certificates: "{{ matrix_static_files_scheme == 'https' }}"
  330. matrix_static_files_self_check_hostname_matrix: ''
  331. matrix_static_files_self_check_hostname_identity: ''
  332. # Controls whether redirects will be followed when checking the `/.well-known/matrix/client` resource.
  333. #
  334. # As per the spec (https://matrix.org/docs/spec/client_server/r0.6.0#well-known-uri), it shouldn't be,
  335. # so we default to not following redirects as well.
  336. matrix_static_files_self_check_well_known_matrix_client_follow_redirects: none
  337. # matrix_static_files_restart_necessary controls whether the service
  338. # will be restarted (when true) or merely started (when false) by the
  339. # systemd service manager role (when conditional restart is enabled).
  340. #
  341. # This value is automatically computed during installation based on whether
  342. # any configuration files, the systemd service file, or the container image changed.
  343. # The default of `false` means "no restart needed" — appropriate when the role's
  344. # installation tasks haven't run (e.g., due to --tags skipping them).
  345. matrix_static_files_restart_necessary: false