overmind
/
matrix-docker-ansible-deploy
огледало од https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Креирај огранак 0
Код Дискусије 0 Издања 0 Вики Activity
Matrix Docker Ansible eploy
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
9880 Комити
13 Гране
36 MiB
 
 
Дрво: 9970603f15
Гране Ознаке
${ item.name }
Create branch ${ searchTerm }
from '9970603f15'
${ noResults }
matrix-docker-ansible-deploy/roles/custom/matrix-static-files/defaults/main.yml

471 lines
32 KiB
Датотека Blame Историја 

  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.36.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. matrix_static_files_container_image_force_pull: "{{ matrix_static_files_container_image.endswith(':latest') }}"

  39. 

  40. matrix_static_files_container_network: "{{ matrix_static_files_identifier }}"

  41. 

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

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

  44. matrix_static_files_container_additional_networks: []

  45. 

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

  47. #

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

  49. matrix_static_files_container_http_host_bind_port: ''

  50. 

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

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

  53. #

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

  55. matrix_static_files_container_labels_traefik_enabled: true

  56. matrix_static_files_container_labels_traefik_docker_network: "{{ matrix_static_files_container_network }}"

  57. matrix_static_files_container_labels_traefik_entrypoints: web-secure

  58. matrix_static_files_container_labels_traefik_tls_certResolver: default  # noqa var-naming

  59. 

  60. # Controls whether labels will be added that expose the well-known public endpoint on the Matrix domain.

  61. matrix_static_files_container_labels_well_known_matrix_endpoint_enabled: true

  62. matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_hostname: ''

  63. matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_path_prefix: /.well-known/matrix

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

  65. matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_priority: 0

  66. matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_entrypoints: "{{ matrix_static_files_container_labels_traefik_entrypoints }}"

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

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

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

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

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

  72. matrix_static_files_container_labels_well_known_matrix_endpoint_middleware_compress_enabled: true

  73. matrix_static_files_container_labels_well_known_matrix_endpoint_middleware_compress_minResponseBodyBytes: 100  # noqa var-naming

  74. 

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

  76. #

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

  78. #

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

  80. #

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

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

  83. #

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

  85. matrix_static_files_container_labels_base_domain_enabled: false

  86. matrix_static_files_container_labels_base_domain_traefik_hostname: ''

  87. matrix_static_files_container_labels_base_domain_traefik_path_prefix: /

  88. 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 %}"

  89. matrix_static_files_container_labels_base_domain_traefik_priority: 0

  90. matrix_static_files_container_labels_base_domain_traefik_entrypoints: "{{ matrix_static_files_container_labels_traefik_entrypoints }}"

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

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

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

  94. matrix_static_files_container_labels_base_domain_root_path_redirection_enabled: false

  95. 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 }}(\\?.*)?$"

  96. matrix_static_files_container_labels_base_domain_root_path_redirection_url: ""

  97. 

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

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

  100. #

  101. # Example:

  102. # matrix_static_files_container_labels_additional_labels: |

  103. #   my.label=1

  104. #   another.label="here"

  105. matrix_static_files_container_labels_additional_labels: ''

  106. 

  107. # Controls the SERVER_PORT environment variable.

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

  109. matrix_static_files_environment_variable_server_port: 8080

  110. 

  111. # Controls the SERVER_LOG_LEVEL environment variable.

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

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

  114. matrix_static_files_environment_variable_server_log_level: error

  115. 

  116. # Controls the SERVER_LOG_REMOTE_ADDRESS environment variable.

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

  118. matrix_static_files_environment_variable_server_log_remote_address: false

  119. 

  120. # Controls the SERVER_CONFIG_FILE environment variable.

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

  122. matrix_static_files_environment_variable_server_config_file: /config/config.toml

  123. 

  124. # Additional environment variables.

  125. matrix_static_files_environment_variables_additional_variables: ''

  126. 

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

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

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

  130. matrix_static_files_files_cache_time_hours: 4

  131. 

  132. 

  133. ########################################################################

  134. #                                                                      #

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

  136. #                                                                      #

  137. ########################################################################

  138. 

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

  140. matrix_static_files_file_matrix_client_property_m_homeserver_base_url: "{{ matrix_homeserver_url }}"

  141. 

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

  143. matrix_static_files_file_matrix_client_property_m_identity_server_base_url: "{{ matrix_identity_server_url }}"

  144. 

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

  146. matrix_static_files_file_matrix_client_property_m_integrations_managers_api_url: "{{ matrix_integration_manager_rest_url }}"

  147. 

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

  149. matrix_static_files_file_matrix_client_property_m_integrations_managers_ui_url: "{{ matrix_integration_manager_ui_url }}"

  150. 

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

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

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

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

  155. matrix_static_files_file_matrix_client_property_io_element_jitsi_preferred_domain: ""

  156. 

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

  158. matrix_static_files_file_matrix_client_property_org_matrix_msc2965_authentication_enabled: false

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

  160. matrix_static_files_file_matrix_client_property_org_matrix_msc2965_authentication_issuer: ""

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

  162. matrix_static_files_file_matrix_client_property_org_matrix_msc2965_authentication_account: ""

  163. 

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

  165. matrix_static_files_file_matrix_client_property_org_matrix_msc3575_proxy_url: ""

  166. 

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

  168. matrix_static_files_file_matrix_client_property_m_tile_server_entries_enabled: false

  169. 

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

  171. matrix_static_files_file_matrix_client_property_m_tile_server_map_style_url: ""

  172. 

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

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

  175. # `matrix_static_files_file_matrix_client_property_io_element_e2ee_default`

  176. # `matrix_static_files_file_matrix_client_property_io_element_e2ee_secure_backup_required`

  177. # `matrix_static_files_file_matrix_client_property_io_element_e2ee_secure_backup_setup_methods`

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

  179. 

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

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

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

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

  184. matrix_static_files_file_matrix_client_property_io_element_e2ee_default: true

  185. 

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

  187. # which instructs Element clients whether they should require a secure backup set up before they can be used.

  188. # Setting this to true will update `/.well-known/matrix/client` and tell Element clients require a secure backup.

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

  190. matrix_static_files_file_matrix_client_property_io_element_e2ee_secure_backup_required: false

  191. 

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

  193. # which instructs Element clients which backup methods from ["key", "passphrase"] should be used.

  194. # When an empty list is provided, Element clients default to using both.

  195. # Setting this to other than empty will update `/.well-known/matrix/client` and tell Element clients which method to use.

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

  197. matrix_static_files_file_matrix_client_property_io_element_e2ee_secure_backup_setup_methods: []

  198. 

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

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

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

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

  203. matrix_static_files_file_matrix_client_property_io_element_e2ee_force_disable: false

  204. 

  205. # Controls whether `cc.etke.synapse-admin`-related entries should be added to the client well-known.

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

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

  208. 

  209. # Controls the cc.etke.synapse-admin property in the /.well-known/matrix/client file.

  210. # See `matrix_static_files_file_matrix_client_property_cc_etke_synapse_admin_entries_enabled`

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

  212. matrix_static_files_file_matrix_client_property_cc_etke_synapse_admin_auto: {}

  213. matrix_static_files_file_matrix_client_property_cc_etke_synapse_admin_custom: {}

  214. 

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

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

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

  218. 

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

  220. # See `matrix_static_files_file_matrix_client_property_org_matrix_msc4143_rtc_foci_enabled`

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

  222. matrix_static_files_file_matrix_client_property_org_matrix_msc4143_rtc_foci_auto: {}

  223. matrix_static_files_file_matrix_client_property_org_matrix_msc4143_rtc_foci_custom: {}

  224. 

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

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

  227. #

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

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

  230. matrix_static_files_file_matrix_client_configuration_json: "{{ lookup('template', 'templates/public/.well-known/matrix/client.j2') }}"

  231. 

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

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

  234. #

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

  236. #

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

  238. # completely redefining `matrix_static_files_file_matrix_client_configuration_json`.

  239. #

  240. # Example configuration extension follows:

  241. #

  242. # matrix_static_files_file_matrix_client_configuration_extension_json: |

  243. #   {

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

  245. #     "m.yet_another": 3

  246. #   }

  247. matrix_static_files_file_matrix_client_configuration_extension_json: '{}'

  248. 

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

  250. 

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

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

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

  254. 

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

  256. #                                                                      #

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

  258. #                                                                      #

  259. ########################################################################

  260. 

  261. 

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

  263. #                                                                      #

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

  265. #                                                                      #

  266. ########################################################################

  267. 

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

  269. #

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

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

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

  273. # Matrix domain (`matrix_server_fqn_matrix`).

  274. matrix_static_files_file_matrix_server_enabled: true

  275. 

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

  277. matrix_static_files_file_matrix_server_property_m_server: ''

  278. 

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

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

  281. #

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

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

  284. matrix_static_files_file_matrix_server_configuration_json: "{{ lookup('template', 'templates/public/.well-known/matrix/server.j2') }}"

  285. 

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

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

  288. #

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

  290. #

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

  292. # completely redefining `matrix_static_files_file_matrix_server_configuration_json`.

  293. #

  294. # Example configuration extension follows:

  295. #

  296. # matrix_static_files_file_matrix_server_configuration_extension_json: |

  297. #   {

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

  299. #     "m.yet_another": 3

  300. #   }

  301. matrix_static_files_file_matrix_server_configuration_extension_json: '{}'

  302. 

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

  304. 

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

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

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

  308. 

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

  310. #                                                                      #

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

  312. #                                                                      #

  313. ########################################################################

  314. 

  315. 

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

  317. #                                                                      #

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

  319. #                                                                      #

  320. ########################################################################

  321. 

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

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

  324. #

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

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

  327. matrix_static_files_file_matrix_support_enabled: false

  328. 

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

  330. matrix_static_files_file_matrix_support_property_m_contacts: []

  331. 

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

  333. matrix_static_files_file_matrix_support_property_m_support_page: ""

  334. 

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

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

  337. #

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

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

  340. matrix_static_files_file_matrix_support_configuration_json: "{{ lookup('template', 'templates/public/.well-known/matrix/support.j2') }}"

  341. 

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

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

  344. #

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

  346. #

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

  348. # completely redefining `matrix_static_files_file_matrix_support_configuration_json`.

  349. #

  350. # Example configuration extension follows:

  351. #

  352. # matrix_static_files_file_matrix_support_configuration_extension_json: |

  353. #   {

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

  355. #     "m.yet_another": 3

  356. #   }

  357. matrix_static_files_file_matrix_support_configuration_extension_json: '{}'

  358. 

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

  360. 

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

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

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

  364. 

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

  366. #                                                                      #

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

  368. #                                                                      #

  369. ########################################################################

  370. 

  371. 

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

  373. #                                                                      #

  374. # Related to /.well-known/element/element.json                         #

  375. #                                                                      #

  376. ########################################################################

  377. 

  378. # Controls whether a `/.well-known/element/element.json` file is generated and used at all.

  379. matrix_static_files_file_element_element_json_enabled: true

  380. 

  381. # Controls the call.widget_url property in the /.well-known/element/element.json file

  382. matrix_static_files_file_element_element_json_property_call_widget_url: ''

  383. 

  384. # Default /.well-known/element/element.json configuration template which covers the generic use case.

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

  386. #

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

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

  389. matrix_static_files_file_element_element_json_configuration_json: "{{ lookup('template', 'templates/public/.well-known/element/element.json.j2') }}"

  390. 

  391. # Your custom JSON configuration for /.well-known/element/element.json should go to `matrix_static_files_file_element_element_json_configuration_extension_json`.

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

  393. #

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

  395. #

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

  397. # completely redefining `matrix_static_files_file_matrix_support_configuration_json`.

  398. #

  399. # Example configuration extension follows:

  400. #

  401. # matrix_static_files_file_element_element_json_configuration_extension_json: |

  402. #   {

  403. #     "call": {

  404. #       "url": "value"

  405. #     }

  406. #   }

  407. matrix_static_files_file_element_element_json_configuration_extension_json: '{}'

  408. 

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

  410. 

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

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

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

  414. 

  415. ########################################################################

  416. #                                                                      #

  417. # /Related to /.well-known/element/element.json                        #

  418. #                                                                      #

  419. ########################################################################

  420. 

  421. 

  422. ########################################################################

  423. #                                                                      #

  424. # Related to index.html                                                #

  425. #                                                                      #

  426. ########################################################################

  427. 

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

  429. # in the public directory (matrix_static_files_public_path).

  430. #

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

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

  433. #

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

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

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

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

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

  439. #

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

  441. matrix_static_files_file_index_html_enabled: "{{ matrix_static_files_container_labels_base_domain_enabled }}"

  442. 

  443. matrix_static_files_file_index_html_template: |-

  444.   <!doctype html>

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

  446.   <html>

  447.     <body>

  448.       Hello from {{ matrix_static_files_container_labels_base_domain_traefik_hostname }}!

  449.     </body>

  450.   </html>

  451. 

  452. ########################################################################

  453. #                                                                      #

  454. # /Related to /index.html                                               #

  455. #                                                                      #

  456. ########################################################################

  457. 

  458. matrix_static_files_scheme: https

  459. 

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

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

  462. 

  463. matrix_static_files_self_check_hostname_matrix: ''

  464. matrix_static_files_self_check_hostname_identity: ''

  465. 

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

  467. #

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

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

  470. matrix_static_files_self_check_well_known_matrix_client_follow_redirects: none