Matrix Docker Ansible eploy
25'ten fazla konu seçemezsiniz Konular bir harf veya rakamla başlamalı, kısa çizgiler ('-') içerebilir ve en fazla 35 karakter uzunluğunda olabilir.
 
 

419 satır
29 KiB

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