overmind
/
matrix-docker-ansible-deploy
espelho de https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Derivar 0
Código Questões 0 Lançamentos 0 Wiki Trabalho
Matrix Docker Ansible eploy
Não pode escolher mais do que 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.
11807 Cometimentos
13 Ramos
3.0 GiB
 
 
Ramo: master
Ramos Etiquetas
${ item.name }
Criar ramo ${ searchTerm }
de 'master'
${ noResults }
matrix-docker-ansible-deploy/roles/custom/matrix-static-files/defaults/main.yml

480 linhas
32 KiB
Em bruto Ligação permanente Responsabilidade Histórico 

  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. ---

  7. 

  8. # matrix-static-files is a role which generates and serves `/.well-known/matrix` files for the purposes of Matrix Delegation.

  9. # It also exposes some variables which allow this role to be used for serving additional files.

  10. 

  11. matrix_static_files_enabled: true

  12. 

  13. matrix_static_files_identifier: matrix-static-files

  14. 

  15. # renovate: datasource=docker depName=joseluisq/static-web-server

  16. matrix_static_files_version: 2.44.0

  17. 

  18. matrix_static_files_base_path: "{{ matrix_base_data_path }}/{{ 'static-files' if matrix_static_files_identifier == 'matrix-static-files' else matrix_static_files_identifier }}"

  19. matrix_static_files_config_path: "{{ matrix_static_files_base_path }}/config"

  20. matrix_static_files_public_path: "{{ matrix_static_files_base_path }}/public"

  21. matrix_static_files_public_well_known_path: "{{ matrix_static_files_public_path }}/.well-known"

  22. matrix_static_files_public_well_known_matrix_path: "{{ matrix_static_files_public_well_known_path }}/matrix"

  23. matrix_static_files_public_well_known_element_path: "{{ matrix_static_files_public_well_known_path }}/element"

  24. 

  25. # List of systemd services that matrix-static-files.service depends on

  26. matrix_static_files_systemd_required_services_list: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"

  27. 

  28. # List of systemd services that matrix-static-files.service wants

  29. matrix_static_files_systemd_wanted_services_list: "{{ matrix_static_files_systemd_wanted_services_list_auto + matrix_static_files_systemd_wanted_services_list_custom }}"

  30. matrix_static_files_systemd_wanted_services_list_auto: []

  31. matrix_static_files_systemd_wanted_services_list_custom: []

  32. 

  33. matrix_static_files_container_image: "{{ matrix_static_files_container_image_registry_prefix }}joseluisq/static-web-server:{{ matrix_static_files_container_image_tag }}"

  34. matrix_static_files_container_image_registry_prefix: "{{ matrix_static_files_container_image_registry_prefix_upstream }}"

  35. matrix_static_files_container_image_registry_prefix_upstream: "{{ matrix_static_files_container_image_registry_prefix_upstream_default }}"

  36. matrix_static_files_container_image_registry_prefix_upstream_default: "docker.io/"

  37. matrix_static_files_container_image_tag: "{{ 'latest' if matrix_static_files_version == 'latest' else (matrix_static_files_version + '-alpine') }}"

  38. 

  39. matrix_static_files_container_network: "{{ matrix_static_files_identifier }}"

  40. 

  41. # A list of additional container networks that matrix-static-files would be connected to.

  42. # The playbook does not create these networks, so make sure they already exist.

  43. matrix_static_files_container_additional_networks: []

  44. 

  45. # Controls whether the matrix-static-files container exposes its HTTP port (tcp/8080 in the container).

  46. #

  47. # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8080"), or empty string to not expose.

  48. matrix_static_files_container_http_host_bind_port: ''

  49. 

  50. # matrix_static_files_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container.

  51. # See `../templates/labels.j2` for details.

  52. #

  53. # To inject your own other container labels, see `matrix_static_files_container_labels_additional_labels`.

  54. matrix_static_files_container_labels_traefik_enabled: true

  55. matrix_static_files_container_labels_traefik_docker_network: "{{ matrix_static_files_container_network }}"

  56. matrix_static_files_container_labels_traefik_entrypoints: web-secure

  57. matrix_static_files_container_labels_traefik_tls_certResolver: default  # noqa var-naming

  58. 

  59. # Controls whether labels will be added that expose the `/.well-known/matrix` endpoint on the Matrix domain.

  60. matrix_static_files_container_labels_well_known_matrix_endpoint_enabled: true

  61. matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_hostname: ''

  62. matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_path_prefix: /.well-known/matrix

  63. 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 }}`)"

  64. matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_priority: 0

  65. matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_entrypoints: "{{ matrix_static_files_container_labels_traefik_entrypoints }}"

  66. matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_tls: "{{ matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_entrypoints != 'web' }}"

  67. matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_tls_certResolver: "{{ matrix_static_files_container_labels_traefik_tls_certResolver }}"  # noqa var-naming

  68. # Controls whether the compress middleware (https://doc.traefik.io/traefik/middlewares/http/compress/) will be enabled for this router.

  69. # The web-server only compresses known file types and our /.well-known/matrix/* files have no file extension.

  70. # As such, they are not being compressed there and we compress them at the Traefik level.

  71. matrix_static_files_container_labels_well_known_matrix_endpoint_middleware_compress_enabled: true

  72. matrix_static_files_container_labels_well_known_matrix_endpoint_middleware_compress_minResponseBodyBytes: 100  # noqa var-naming

  73. 

  74. # Controls whether labels will be added that serve the base domain.

  75. #

  76. # This is similar to `matrix_static_files_container_labels_well_known_matrix_endpoint_*`, but does more.

  77. #

  78. # It's useful when you'd like to avoid setting up `/.well-known/matrix` redirects and can afford to point the base domain to the Matrix server.

  79. #

  80. # By default, these labels are configured to handle all paths for the provided base domain

  81. # (see `matrix_static_files_container_labels_base_domain_traefik_path_prefix`), not just the `/.well-known/matrix` prefix.

  82. #

  83. # By default, an index.html page is also served (see `matrix_static_files_file_index_html_enabled`).

  84. matrix_static_files_container_labels_base_domain_enabled: false

  85. matrix_static_files_container_labels_base_domain_traefik_hostname: ''

  86. matrix_static_files_container_labels_base_domain_traefik_path_prefix: /

  87. matrix_static_files_container_labels_base_domain_traefik_rule: "Host(`{{ matrix_static_files_container_labels_base_domain_traefik_hostname }}`){% if matrix_static_files_container_labels_base_domain_traefik_path_prefix != '/' %} && PathPrefix(`{{ matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_path_prefix }}`){% endif %}"

  88. matrix_static_files_container_labels_base_domain_traefik_priority: 0

  89. matrix_static_files_container_labels_base_domain_traefik_entrypoints: "{{ matrix_static_files_container_labels_traefik_entrypoints }}"

  90. matrix_static_files_container_labels_base_domain_traefik_tls: "{{ matrix_static_files_container_labels_base_domain_traefik_entrypoints != 'web' }}"

  91. matrix_static_files_container_labels_base_domain_traefik_tls_certResolver: "{{ matrix_static_files_container_labels_traefik_tls_certResolver }}"  # noqa var-naming

  92. # Controls whether the root path (/) at the base domain would respond with a redirect to some URL.

  93. matrix_static_files_container_labels_base_domain_root_path_redirection_enabled: false

  94. matrix_static_files_container_labels_base_domain_root_path_redirection_regex: "^{{ matrix_static_files_scheme }}://{{ matrix_static_files_container_labels_base_domain_traefik_hostname }}{{ matrix_static_files_container_labels_base_domain_traefik_path_prefix }}(\\?.*)?$"

  95. matrix_static_files_container_labels_base_domain_root_path_redirection_url: ""

  96. 

  97. # matrix_static_files_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file.

  98. # See `../templates/labels.j2` for details.

  99. #

  100. # Example:

  101. # matrix_static_files_container_labels_additional_labels: |

  102. #   my.label=1

  103. #   another.label="here"

  104. matrix_static_files_container_labels_additional_labels: ''

  105. 

  106. # Controls the SERVER_PORT environment variable.

  107. # See: https://static-web-server.net/configuration/environment-variables/

  108. matrix_static_files_environment_variable_server_port: 8080

  109. 

  110. # Controls the SERVER_LOG_LEVEL environment variable.

  111. # See: https://static-web-server.net/configuration/environment-variables/

  112. # Valid values: error, warn, info, debug or trace

  113. matrix_static_files_environment_variable_server_log_level: error

  114. 

  115. # Controls the SERVER_LOG_REMOTE_ADDRESS environment variable.

  116. # See: https://static-web-server.net/configuration/environment-variables/

  117. matrix_static_files_environment_variable_server_log_remote_address: false

  118. 

  119. # Controls the SERVER_CONFIG_FILE environment variable.

  120. # See: https://static-web-server.net/configuration/environment-variables/

  121. matrix_static_files_environment_variable_server_config_file: /config/config.toml

  122. 

  123. # Controls the SERVER_IGNORE_HIDDEN_FILES environment variable.

  124. # See: https://static-web-server.net/configuration/environment-variables/

  125. matrix_static_files_environment_variable_server_ignore_hidden_files: false

  126. 

  127. # Additional environment variables.

  128. matrix_static_files_environment_variables_additional_variables: ''

  129. 

  130. # Controls the caching time (max-age property of the `Cache-Control` HTTP header) for all `/.well-known/matrix/*` files.

  131. # We use a somewhat long expires value is to prevent outages in case this is unreachable due to network failure

  132. # or due to the base domain's server completely dying.

  133. matrix_static_files_files_cache_time_hours: 4

  134. 

  135. 

  136. ########################################################################

  137. #                                                                      #

  138. # Related to /.well-known/matrix/client                                #

  139. #                                                                      #

  140. ########################################################################

  141. 

  142. # Controls the m.homeserver/base_url property in the /.well-known/matrix/client file

  143. matrix_static_files_file_matrix_client_property_m_homeserver_base_url: "{{ matrix_homeserver_url }}"

  144. 

  145. # Controls the m.identity_server/base_url property in the /.well-known/matrix/client file

  146. matrix_static_files_file_matrix_client_property_m_identity_server_base_url: "{{ matrix_identity_server_url }}"

  147. 

  148. # Controls the m.integrations/managers/0/api_url property in the /.well-known/matrix/client file

  149. matrix_static_files_file_matrix_client_property_m_integrations_managers_api_url: "{{ matrix_integration_manager_rest_url }}"

  150. 

  151. # Controls the m.integrations/managers/0/ui_url property in the /.well-known/matrix/client file

  152. matrix_static_files_file_matrix_client_property_m_integrations_managers_ui_url: "{{ matrix_integration_manager_ui_url }}"

  153. 

  154. # Controls the io.element.jitsi/preferredDomain property in the /.well-known/matrix/client file

  155. # This specifies the domain name where a Jitsi server is self-hosted.

  156. # If set, `/.well-known/matrix/client` will suggest Element clients to use that Jitsi server.

  157. # See: https://github.com/element-hq/element-web/blob/develop/docs/jitsi.md#configuring-element-to-use-your-self-hosted-jitsi-server

  158. matrix_static_files_file_matrix_client_property_io_element_jitsi_preferred_domain: ""

  159. 

  160. # Controls if the org.matrix.msc3575.authentication section of the /.well-known/matrix/client file is enabled.

  161. matrix_static_files_file_matrix_client_property_org_matrix_msc2965_authentication_enabled: false

  162. # Controls the org.matrix.msc2965.authentication/issuer property in the /.well-known/matrix/client file

  163. matrix_static_files_file_matrix_client_property_org_matrix_msc2965_authentication_issuer: ""

  164. # Controls the org.matrix.msc2965.authentication/account property in the /.well-known/matrix/client file

  165. matrix_static_files_file_matrix_client_property_org_matrix_msc2965_authentication_account: ""

  166. 

  167. # Controls the org.matrix.msc3575.proxy/url (sliding sync) property in the /.well-known/matrix/client file

  168. matrix_static_files_file_matrix_client_property_org_matrix_msc3575_proxy_url: ""

  169. 

  170. # Controls whether the m.tile_server configuration is added to the /.well-known/matrix/client file

  171. matrix_static_files_file_matrix_client_property_m_tile_server_entries_enabled: false

  172. 

  173. # Controls the m.tile_server/map_style_url property in the /.well-known/matrix/client file

  174. matrix_static_files_file_matrix_client_property_m_tile_server_map_style_url: ""

  175. 

  176. # Controls whether Element related entries (io.element.e2ee) should be added to the client well-known.

  177. # By default if any of the following change from their default this would be set to true:

  178. # - `matrix_static_files_file_matrix_client_property_io_element_e2ee_default`

  179. # - `matrix_static_files_file_matrix_client_property_io_element_e2ee_force_disable`

  180. 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 }}"

  181. 

  182. # Controls the io.element.e2ee/default property in the /.well-known/matrix/client file,

  183. # which instructs Element clients whether they should use End-to-End Encryption by default.

  184. # Setting this to false will update `/.well-known/matrix/client` and tell Element clients to avoid E2EE.

  185. # See: https://github.com/element-hq/element-web/blob/develop/docs/e2ee.md

  186. matrix_static_files_file_matrix_client_property_io_element_e2ee_default: true

  187. 

  188. # Controls the io.element.e2ee/force_disable property in the /.well-known/matrix/client file,

  189. # which can be set to `true` to instruct Element clients whether to disable End-to-End Encryption by default

  190. # and to not show encryption related-settings in room settings.

  191. # See: https://github.com/element-hq/element-web/blob/develop/docs/e2ee.md

  192. matrix_static_files_file_matrix_client_property_io_element_e2ee_force_disable: false

  193. 

  194. # Controls whether `cc.etke.ketesa`-related entries should be added to the client well-known.

  195. # By default, if there are entries in `matrix_static_files_file_matrix_client_property_cc_etke_ketesa`, we show them (by enabling this).

  196. matrix_static_files_file_matrix_client_property_cc_etke_ketesa_enabled: "{{ matrix_static_files_file_matrix_client_property_cc_etke_ketesa | default({}) | dict2items | length > 0 }}"

  197. 

  198. # Controls the cc.etke.ketesa property in the /.well-known/matrix/client file.

  199. matrix_static_files_file_matrix_client_property_cc_etke_ketesa: "{{ matrix_static_files_file_matrix_client_property_cc_etke_ketesa_auto | combine(matrix_static_files_file_matrix_client_property_cc_etke_ketesa_custom, recursive=True) }}"

  200. matrix_static_files_file_matrix_client_property_cc_etke_ketesa_auto: {}

  201. matrix_static_files_file_matrix_client_property_cc_etke_ketesa_custom: {}

  202. 

  203. 

  204. # The `org.matrix.msc4143.rtc_foci` property has been dropped from MSC4143 in favor of the homeserver's own RTC transports API,

  205. # but remains the only way to reach clients which cannot consult that API.

  206. # Element Call running as a widget (which is how Element Web and Element Desktop invoke it) is one such client,

  207. # because a widget holds no access token of its own and the API requires authentication.

  208. # Newer Element Call versions ask their host client for the transports over the widget API (MSC4515) instead,

  209. # so this property can go away once such versions are widely deployed.

  210. #

  211. # Controls whether `org.matrix.msc4143.rtc_foci`-related entries should be added to the client well-known.

  212. # 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).

  213. 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 }}"

  214. 

  215. # Controls the org.matrix.msc4143.rtc_foci property in the /.well-known/matrix/client file.

  216. # See `matrix_static_files_file_matrix_client_property_org_matrix_msc4143_rtc_foci_enabled`

  217. 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 }}"

  218. matrix_static_files_file_matrix_client_property_org_matrix_msc4143_rtc_foci_auto: []

  219. matrix_static_files_file_matrix_client_property_org_matrix_msc4143_rtc_foci_custom: []

  220. 

  221. # Default /.well-known/matrix/client configuration template which covers the generic use case.

  222. # You can customize it by controlling the various variables inside it.

  223. #

  224. # For a more advanced customization, you can extend the default (see `matrix_static_files_file_matrix_client_configuration_extension_json`)

  225. # or completely replace this variable with your own template.

  226. matrix_static_files_file_matrix_client_configuration_json: "{{ lookup('template', 'templates/public/.well-known/matrix/client.j2', convert_data=False) | from_json }}"

  227. 

  228. # Your custom JSON configuration for /.well-known/matrix/client should go to `matrix_static_files_file_matrix_client_configuration_extension_json`.

  229. # This configuration extends the default starting configuration (`matrix_static_files_file_matrix_client_configuration_extension_json`).

  230. #

  231. # You can override individual variables from the default configuration, or introduce new ones.

  232. #

  233. # If you need something more special, you can take full control by

  234. # completely redefining `matrix_static_files_file_matrix_client_configuration_json`.

  235. #

  236. # Example configuration extension follows:

  237. #

  238. # matrix_static_files_file_matrix_client_configuration_extension_json: |

  239. #   {

  240. #     "m.another": "value",

  241. #     "m.yet_another": 3

  242. #   }

  243. matrix_static_files_file_matrix_client_configuration_extension_json: '{}'

  244. 

  245. 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 {} }}"

  246. 

  247. # Holds the final /.well-known/matrix/client configuration (a combination of the default and its extension).

  248. # 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`.

  249. 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) }}"

  250. 

  251. ########################################################################

  252. #                                                                      #

  253. # /Related to /.well-known/matrix/client                               #

  254. #                                                                      #

  255. ########################################################################

  256. 

  257. 

  258. ########################################################################

  259. #                                                                      #

  260. # Related to /.well-known/matrix/server                                #

  261. #                                                                      #

  262. ########################################################################

  263. 

  264. # Controls whether a `/.well-known/matrix/server` file is generated and used at all.

  265. #

  266. # If you wish to rely on DNS SRV records only, you can disable this.

  267. # Using DNS SRV records implies that you'll be handling Matrix Federation API traffic (tcp/8448)

  268. # using certificates for the base domain (`matrix_domain`) and not for the

  269. # Matrix domain (`matrix_server_fqn_matrix`).

  270. matrix_static_files_file_matrix_server_enabled: true

  271. 

  272. # Controls the m.server property in the /.well-known/matrix/server file

  273. matrix_static_files_file_matrix_server_property_m_server: ''

  274. 

  275. # Default /.well-known/matrix/server configuration template which covers the generic use case.

  276. # You can customize it by controlling the various variables inside it.

  277. #

  278. # For a more advanced customization, you can extend the default (see `matrix_static_files_file_matrix_server_configuration_extension_json`)

  279. # or completely replace this variable with your own template.

  280. matrix_static_files_file_matrix_server_configuration_json: "{{ lookup('template', 'templates/public/.well-known/matrix/server.j2', convert_data=False) | from_json }}"

  281. 

  282. # Your custom JSON configuration for /.well-known/matrix/server should go to `matrix_static_files_file_matrix_server_configuration_extension_json`.

  283. # This configuration extends the default starting configuration (`matrix_static_files_file_matrix_server_configuration_extension_json`).

  284. #

  285. # You can override individual variables from the default configuration, or introduce new ones.

  286. #

  287. # If you need something more special, you can take full control by

  288. # completely redefining `matrix_static_files_file_matrix_server_configuration_json`.

  289. #

  290. # Example configuration extension follows:

  291. #

  292. # matrix_static_files_file_matrix_server_configuration_extension_json: |

  293. #   {

  294. #     "m.another": "value",

  295. #     "m.yet_another": 3

  296. #   }

  297. matrix_static_files_file_matrix_server_configuration_extension_json: '{}'

  298. 

  299. 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 {} }}"

  300. 

  301. # Holds the final /.well-known/matrix/server configuration (a combination of the default and its extension).

  302. # 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`.

  303. 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) }}"

  304. 

  305. ########################################################################

  306. #                                                                      #

  307. # /Related to /.well-known/matrix/server                               #

  308. #                                                                      #

  309. ########################################################################

  310. 

  311. 

  312. ########################################################################

  313. #                                                                      #

  314. # Related to /.well-known/matrix/support                               #

  315. #                                                                      #

  316. ########################################################################

  317. 

  318. # Controls whether a `/.well-known/matrix/support` file is generated and used at all.

  319. # For details about this file, see the spec: https://github.com/matrix-org/matrix-spec-proposals/pull/1929

  320. #

  321. # This is not enabled by default, as for it to be useful, other information is necessary.

  322. # See `matrix_static_files_file_matrix_support_property_m_contacts`, `matrix_static_files_file_matrix_support_property_m_support_page`, etc.

  323. matrix_static_files_file_matrix_support_enabled: false

  324. 

  325. # Controls the m.contacts property in the /.well-known/matrix/support file

  326. matrix_static_files_file_matrix_support_property_m_contacts: []

  327. 

  328. # Controls the m.support_page property in the /.well-known/matrix/support file

  329. matrix_static_files_file_matrix_support_property_m_support_page: ""

  330. 

  331. # Default /.well-known/matrix/support configuration template which covers the generic use case.

  332. # You can customize it by controlling the various variables inside it.

  333. #

  334. # For a more advanced customization, you can extend the default (see `matrix_static_files_file_matrix_support_configuration_extension_json`)

  335. # or completely replace this variable with your own template.

  336. matrix_static_files_file_matrix_support_configuration_json: "{{ lookup('template', 'templates/public/.well-known/matrix/support.j2', convert_data=False) | from_json }}"

  337. 

  338. # Your custom JSON configuration for /.well-known/matrix/support should go to `matrix_static_files_file_matrix_support_configuration_extension_json`.

  339. # This configuration extends the default starting configuration (`matrix_static_files_file_matrix_support_configuration_extension_json`).

  340. #

  341. # You can override individual variables from the default configuration, or introduce new ones.

  342. #

  343. # If you need something more special, you can take full control by

  344. # completely redefining `matrix_static_files_file_matrix_support_configuration_json`.

  345. #

  346. # Example configuration extension follows:

  347. #

  348. # matrix_static_files_file_matrix_support_configuration_extension_json: |

  349. #   {

  350. #     "m.another": "value",

  351. #     "m.yet_another": 3

  352. #   }

  353. matrix_static_files_file_matrix_support_configuration_extension_json: '{}'

  354. 

  355. 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 {} }}"

  356. 

  357. # Holds the final /.well-known/matrix/support configuration (a combination of the default and its extension).

  358. # 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`.

  359. 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) }}"

  360. 

  361. ########################################################################

  362. #                                                                      #

  363. # /Related to /.well-known/matrix/support                              #

  364. #                                                                      #

  365. ########################################################################

  366. 

  367. 

  368. ########################################################################

  369. #                                                                      #

  370. # Related to /.well-known/matrix/mautrix                               #

  371. #                                                                      #

  372. ########################################################################

  373. 

  374. # Controls whether a `/.well-known/matrix/mautrix` file is generated and used at all.

  375. # This file allows tools like Mautrix Manager (https://github.com/mautrix/manager) to auto-discover the bridges hosted on this server.

  376. # By default, it's enabled only when there's something to advertise (see `matrix_static_files_file_matrix_mautrix_property_fi_mau_bridges`).

  377. matrix_static_files_file_matrix_mautrix_enabled: "{{ matrix_static_files_file_matrix_mautrix_property_fi_mau_bridges | length > 0 }}"

  378. 

  379. # Controls the fi.mau.bridges property in the /.well-known/matrix/mautrix file.

  380. # This is a list of base URLs for bridges hosted on (and connected to) this server.

  381. matrix_static_files_file_matrix_mautrix_property_fi_mau_bridges: "{{ matrix_static_files_file_matrix_mautrix_property_fi_mau_bridges_auto + matrix_static_files_file_matrix_mautrix_property_fi_mau_bridges_custom }}"

  382. matrix_static_files_file_matrix_mautrix_property_fi_mau_bridges_auto: []

  383. matrix_static_files_file_matrix_mautrix_property_fi_mau_bridges_custom: []

  384. 

  385. # Default /.well-known/matrix/mautrix configuration template which covers the generic use case.

  386. # You can customize it by controlling the various variables inside it.

  387. #

  388. # For a more advanced customization, you can extend the default (see `matrix_static_files_file_matrix_mautrix_configuration_extension_json`)

  389. # or completely replace this variable with your own template.

  390. matrix_static_files_file_matrix_mautrix_configuration_json: "{{ lookup('template', 'templates/public/.well-known/matrix/mautrix.j2', convert_data=False) | from_json }}"

  391. 

  392. # Your custom JSON configuration for /.well-known/matrix/mautrix should go to `matrix_static_files_file_matrix_mautrix_configuration_extension_json`.

  393. # This configuration extends the default starting configuration (`matrix_static_files_file_matrix_mautrix_configuration_extension_json`).

  394. #

  395. # You can override individual variables from the default configuration, or introduce new ones.

  396. #

  397. # If you need something more special, you can take full control by

  398. # completely redefining `matrix_static_files_file_matrix_mautrix_configuration_json`.

  399. #

  400. # Example configuration extension follows:

  401. #

  402. # matrix_static_files_file_matrix_mautrix_configuration_extension_json: |

  403. #   {

  404. #     "fi.mau.external_bridge_servers": ["https://bridges.example.com"]

  405. #   }

  406. matrix_static_files_file_matrix_mautrix_configuration_extension_json: '{}'

  407. 

  408. matrix_static_files_file_matrix_mautrix_configuration_extension: "{{ matrix_static_files_file_matrix_mautrix_configuration_extension_json | from_json if matrix_static_files_file_matrix_mautrix_configuration_extension_json | from_json is mapping else {} }}"

  409. 

  410. # Holds the final /.well-known/matrix/mautrix configuration (a combination of the default and its extension).

  411. # You most likely don't need to touch this variable. Instead, see `matrix_static_files_file_matrix_mautrix_configuration_json` or `matrix_static_files_file_matrix_mautrix_configuration_extension_json`.

  412. matrix_static_files_file_matrix_mautrix_configuration: "{{ matrix_static_files_file_matrix_mautrix_configuration_json | combine(matrix_static_files_file_matrix_mautrix_configuration_extension, recursive=True) }}"

  413. 

  414. ########################################################################

  415. #                                                                      #

  416. # /Related to /.well-known/matrix/mautrix                              #

  417. #                                                                      #

  418. ########################################################################

  419. 

  420. 

  421. ########################################################################

  422. #                                                                      #

  423. # Related to index.html                                                #

  424. #                                                                      #

  425. ########################################################################

  426. 

  427. # Controls whether `matrix_static_files_file_index_html_template` would be dumped to an `index.html` file

  428. # in the public directory (matrix_static_files_public_path).

  429. #

  430. # This is useful if you have enabled serving of the base domain (matrix_static_files_container_labels_base_domain_enabled)

  431. # and wish to serve more than just the `/.well-known/matrix` files from it.

  432. #

  433. # You can also use the auxiliary role (https://github.com/mother-of-all-self-hosting/ansible-role-aux) to create files in

  434. # the public directory (matrix_static_files_public_path) by yourself.

  435. # If you're disabling this but are preparing some HTML files by yourself,

  436. # consider explicitly disabling `matrix_static_files_container_labels_base_domain_root_path_redirection_enabled` as well.

  437. # The default behavior when this is disabled is to enable root-path-redirection.

  438. #

  439. # Because you may wish to manage these static files yourself, disabling this variable will intentionally not delete an already existing `index.html` file.

  440. matrix_static_files_file_index_html_enabled: "{{ matrix_static_files_container_labels_base_domain_enabled }}"

  441. 

  442. matrix_static_files_file_index_html_template: |-

  443.   <!doctype html>

  444.   <meta charset="utf-8" />

  445.   <html>

  446.     <body>

  447.       Hello from {{ matrix_static_files_container_labels_base_domain_traefik_hostname }}!

  448.     </body>

  449.   </html>

  450. 

  451. ########################################################################

  452. #                                                                      #

  453. # /Related to /index.html                                               #

  454. #                                                                      #

  455. ########################################################################

  456. 

  457. matrix_static_files_scheme: https

  458. 

  459. # Controls whether the self-check feature should validate SSL certificates.

  460. matrix_static_files_self_check_validate_certificates: "{{ matrix_static_files_scheme == 'https' }}"

  461. 

  462. matrix_static_files_self_check_hostname_matrix: ''

  463. matrix_static_files_self_check_hostname_identity: ''

  464. 

  465. # Controls whether redirects will be followed when checking the `/.well-known/matrix/client` resource.

  466. #

  467. # As per the spec (https://matrix.org/docs/spec/client_server/r0.6.0#well-known-uri), it shouldn't be,

  468. # so we default to not following redirects as well.

  469. matrix_static_files_self_check_well_known_matrix_client_follow_redirects: none

  470. 

  471. # matrix_static_files_restart_necessary controls whether the service

  472. # will be restarted (when true) or merely started (when false) by the

  473. # systemd service manager role (when conditional restart is enabled).

  474. #

  475. # This value is automatically computed during installation based on whether

  476. # any configuration files, the systemd service file, or the container image changed.

  477. # The default of `false` means "no restart needed" — appropriate when the role's

  478. # installation tasks haven't run (e.g., due to --tags skipping them).

  479. matrix_static_files_restart_necessary: false