Matrix Docker Ansible eploy
Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.
 
 

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