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.
 
 

373 linhas
24 KiB

  1. # SPDX-FileCopyrightText: 2022 - 2023 MDAD project contributors
  2. # SPDX-FileCopyrightText: 2022 - 2025 Slavi Pantaleev
  3. # SPDX-FileCopyrightText: 2022 Aaron Raimist
  4. # SPDX-FileCopyrightText: 2022 Darren Rambaud
  5. # SPDX-FileCopyrightText: 2022 Jip J. Dekker
  6. # SPDX-FileCopyrightText: 2022 Marko Weltzer
  7. # SPDX-FileCopyrightText: 2022 Nikita Chernyi
  8. # SPDX-FileCopyrightText: 2022 Shaleen Jain
  9. # SPDX-FileCopyrightText: 2023 Isaiah Becker-Mayer
  10. # SPDX-FileCopyrightText: 2023 Samuel Meenzen
  11. # SPDX-FileCopyrightText: 2024 Suguru Hirahara
  12. #
  13. # SPDX-License-Identifier: AGPL-3.0-or-later
  14. ---
  15. # Dendrite is a second-generation Matrix homeserver currently in Beta
  16. # Project source code URL: https://github.com/matrix-org/dendrite
  17. matrix_dendrite_enabled: true
  18. matrix_dendrite_hostname: ''
  19. matrix_dendrite_container_image_self_build: false
  20. matrix_dendrite_container_image_self_build_repo: "https://github.com/matrix-org/dendrite.git"
  21. matrix_dendrite_container_image_path: "matrixdotorg/dendrite-monolith"
  22. matrix_dendrite_container_image: "{{ matrix_dendrite_container_image_registry_prefix }}{{ matrix_dendrite_container_image_path }}:{{ matrix_dendrite_container_image_tag }}"
  23. matrix_dendrite_container_image_registry_prefix: "{{ 'localhost/' if matrix_dendrite_container_image_self_build else matrix_dendrite_container_image_registry_prefix_upstream }}"
  24. matrix_dendrite_container_image_registry_prefix_upstream: "{{ matrix_dendrite_container_image_registry_prefix_upstream_default }}"
  25. matrix_dendrite_container_image_registry_prefix_upstream_default: docker.io/
  26. # renovate: datasource=docker depName=matrixdotorg/dendrite-monolith
  27. matrix_dendrite_container_image_tag: "v0.15.2"
  28. matrix_dendrite_base_path: "{{ matrix_base_data_path }}/dendrite"
  29. matrix_dendrite_config_dir_path: "{{ matrix_dendrite_base_path }}/config"
  30. matrix_dendrite_storage_path: "{{ matrix_dendrite_base_path }}/storage"
  31. matrix_dendrite_media_store_path: "{{ matrix_dendrite_storage_path }}/media-store"
  32. matrix_dendrite_nats_storage_path: "{{ matrix_dendrite_base_path }}/nats"
  33. matrix_dendrite_bin_path: "{{ matrix_dendrite_base_path }}/bin"
  34. matrix_dendrite_ext_path: "{{ matrix_dendrite_base_path }}/ext"
  35. matrix_dendrite_container_src_files_path: "{{ matrix_dendrite_base_path }}/docker-src"
  36. # By default, we make Dendrite only serve HTTP (not HTTPS).
  37. # HTTPS is usually served at the reverse-proxy side.
  38. #
  39. # To enable HTTPS serving by Dendrite (directly):
  40. # - `matrix_dendrite_https_bind_port` must be set
  41. # - `-tls-cert` and `-tls-key` must be passed to Dendrite via `matrix_dendrite_process_extra_arguments`
  42. # - the TLS certificate files must be mounted into the container using `matrix_dendrite_container_additional_volumes`
  43. matrix_dendrite_http_bind_port: 8008
  44. matrix_dendrite_https_bind_port: ~
  45. # This is passed as an `-http-bind-address` flag to the Dendrite server in the container
  46. matrix_dendrite_http_bind_address: "{{ (':' + matrix_dendrite_http_bind_port | string) if matrix_dendrite_http_bind_port else '' }}"
  47. # This is passed as an `-https-bind-address` flag to the Dendrite server in the container
  48. matrix_dendrite_https_bind_address: "{{ (':' + matrix_dendrite_https_bind_port | string) if matrix_dendrite_https_bind_port else '' }}"
  49. # The base container network. It will be auto-created by this role if it doesn't exist already.
  50. matrix_dendrite_container_network: ""
  51. # A list of additional container networks that the container would be connected to.
  52. # The role does not create these networks, so make sure they already exist.
  53. # Use this to expose this container to another reverse proxy, which runs in a different container network.
  54. matrix_dendrite_container_additional_networks: "{{ matrix_dendrite_container_additional_networks_auto + matrix_dendrite_container_additional_networks_custom }}"
  55. matrix_dendrite_container_additional_networks_auto: []
  56. matrix_dendrite_container_additional_networks_custom: []
  57. # Controls whether the matrix-dendrite container exposes the HTTP port (tcp/{{ matrix_dendrite_http_bind_port }} in the container).
  58. #
  59. # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8008"), or empty string to not expose.
  60. matrix_dendrite_container_http_host_bind_address: ""
  61. # Controls whether the matrix-dendrite container exposes the HTTPS port (tcp/{{ matrix_dendrite_https_bind_port }} in the container).
  62. #
  63. # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8448"), or empty string to not expose.
  64. matrix_dendrite_container_https_host_bind_address: ""
  65. # matrix_dendrite_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container.
  66. # See `../templates/labels.j2` for details.
  67. #
  68. # To inject your own other container labels, see `matrix_dendrite_container_labels_additional_labels`.
  69. matrix_dendrite_container_labels_traefik_enabled: true
  70. matrix_dendrite_container_labels_traefik_docker_network: "{{ matrix_dendrite_container_network }}"
  71. matrix_dendrite_container_labels_traefik_entrypoints: web-secure
  72. matrix_dendrite_container_labels_traefik_tls_certResolver: default # noqa var-naming
  73. # Controls whether labels will be added for handling the root (/) path on a public Traefik entrypoint.
  74. matrix_dendrite_container_labels_public_client_root_enabled: true
  75. matrix_dendrite_container_labels_public_client_root_traefik_hostname: "{{ matrix_dendrite_hostname }}"
  76. matrix_dendrite_container_labels_public_client_root_traefik_rule: "Host(`{{ matrix_dendrite_container_labels_public_client_root_traefik_hostname }}`) && Path(`/`)"
  77. matrix_dendrite_container_labels_public_client_root_traefik_priority: 0
  78. matrix_dendrite_container_labels_public_client_root_traefik_entrypoints: "{{ matrix_dendrite_container_labels_traefik_entrypoints }}"
  79. matrix_dendrite_container_labels_public_client_root_traefik_tls: "{{ matrix_dendrite_container_labels_public_client_root_traefik_entrypoints != 'web' }}"
  80. matrix_dendrite_container_labels_public_client_root_traefik_tls_certResolver: "{{ matrix_dendrite_container_labels_traefik_tls_certResolver }}" # noqa var-naming
  81. matrix_dendrite_container_labels_public_client_root_redirection_enabled: false
  82. matrix_dendrite_container_labels_public_client_root_redirection_url: ""
  83. # Controls whether labels will be added that expose the Client-Server API on a public Traefik entrypoint.
  84. matrix_dendrite_container_labels_public_client_api_enabled: true
  85. matrix_dendrite_container_labels_public_client_api_traefik_hostname: "{{ matrix_dendrite_hostname }}"
  86. matrix_dendrite_container_labels_public_client_api_traefik_path_prefix: /_matrix
  87. matrix_dendrite_container_labels_public_client_api_traefik_rule: "Host(`{{ matrix_dendrite_container_labels_public_client_api_traefik_hostname }}`) && PathPrefix(`{{ matrix_dendrite_container_labels_public_client_api_traefik_path_prefix }}`)"
  88. matrix_dendrite_container_labels_public_client_api_traefik_priority: 0
  89. matrix_dendrite_container_labels_public_client_api_traefik_entrypoints: "{{ matrix_dendrite_container_labels_traefik_entrypoints }}"
  90. matrix_dendrite_container_labels_public_client_api_traefik_tls: "{{ matrix_dendrite_container_labels_public_client_api_traefik_entrypoints != 'web' }}"
  91. matrix_dendrite_container_labels_public_client_api_traefik_tls_certResolver: "{{ matrix_dendrite_container_labels_traefik_tls_certResolver }}" # noqa var-naming
  92. # Controls whether labels will be added that expose the Client-Server API on the internal Traefik entrypoint.
  93. # This is similar to `matrix_dendrite_container_labels_public_client_api_enabled`, but the entrypoint and intent is different.
  94. matrix_dendrite_container_labels_internal_client_api_enabled: false
  95. matrix_dendrite_container_labels_internal_client_api_traefik_path_prefix: "{{ matrix_dendrite_container_labels_public_client_api_traefik_path_prefix }}"
  96. matrix_dendrite_container_labels_internal_client_api_traefik_rule: "PathPrefix(`{{ matrix_dendrite_container_labels_internal_client_api_traefik_path_prefix }}`)"
  97. matrix_dendrite_container_labels_internal_client_api_traefik_priority: "{{ matrix_dendrite_container_labels_public_client_api_traefik_priority }}"
  98. matrix_dendrite_container_labels_internal_client_api_traefik_entrypoints: ""
  99. # Controls whether labels will be added that expose the /_synapse/admin paths on a public Traefik entrypoint.
  100. # Following these recommendations (https://github.com/element-hq/synapse/blob/master/docs/reverse_proxy.md), by default, we don't.
  101. # Dendrite exposes some admin APIs under a Synapse-specific prefix.
  102. # See: https://matrix-org.github.io/dendrite/administration/adminapi
  103. matrix_dendrite_container_labels_public_client_synapse_admin_api_enabled: false
  104. matrix_dendrite_container_labels_public_client_synapse_admin_api_traefik_hostname: "{{ matrix_dendrite_hostname }}"
  105. matrix_dendrite_container_labels_public_client_synapse_admin_api_traefik_path_prefix: /_synapse/admin
  106. matrix_dendrite_container_labels_public_client_synapse_admin_api_traefik_rule: "Host(`{{ matrix_dendrite_container_labels_public_client_synapse_admin_api_traefik_hostname }}`) && PathPrefix(`{{ matrix_dendrite_container_labels_public_client_synapse_admin_api_traefik_path_prefix }}`)"
  107. matrix_dendrite_container_labels_public_client_synapse_admin_api_traefik_priority: 0
  108. matrix_dendrite_container_labels_public_client_synapse_admin_api_traefik_entrypoints: "{{ matrix_dendrite_container_labels_traefik_entrypoints }}"
  109. matrix_dendrite_container_labels_public_client_synapse_admin_api_traefik_tls: "{{ matrix_dendrite_container_labels_public_client_synapse_admin_api_traefik_entrypoints != 'web' }}"
  110. matrix_dendrite_container_labels_public_client_synapse_admin_api_traefik_tls_certResolver: "{{ matrix_dendrite_container_labels_traefik_tls_certResolver }}" # noqa var-naming
  111. # Controls whether labels will be added that expose the /_dendrite/admin paths on a public Traefik entrypoint.
  112. # See: https://matrix-org.github.io/dendrite/administration/adminapi
  113. matrix_dendrite_container_labels_public_client_dendrite_admin_api_enabled: false
  114. matrix_dendrite_container_labels_public_client_dendrite_admin_api_traefik_hostname: "{{ matrix_dendrite_hostname }}"
  115. matrix_dendrite_container_labels_public_client_dendrite_admin_api_traefik_path_prefix: /_dendrite/admin
  116. matrix_dendrite_container_labels_public_client_dendrite_admin_api_traefik_rule: "Host(`{{ matrix_dendrite_container_labels_public_client_dendrite_admin_api_traefik_hostname }}`) && PathPrefix(`{{ matrix_dendrite_container_labels_public_client_dendrite_admin_api_traefik_path_prefix }}`)"
  117. matrix_dendrite_container_labels_public_client_dendrite_admin_api_traefik_priority: 0
  118. matrix_dendrite_container_labels_public_client_dendrite_admin_api_traefik_entrypoints: "{{ matrix_dendrite_container_labels_traefik_entrypoints }}"
  119. matrix_dendrite_container_labels_public_client_dendrite_admin_api_traefik_tls: "{{ matrix_dendrite_container_labels_public_client_dendrite_admin_api_traefik_entrypoints != 'web' }}"
  120. matrix_dendrite_container_labels_public_client_dendrite_admin_api_traefik_tls_certResolver: "{{ matrix_dendrite_container_labels_traefik_tls_certResolver }}" # noqa var-naming
  121. # Controls whether labels will be added that expose the Server-Server API (Federation API) on a public Traefik entrypoint.
  122. matrix_dendrite_container_labels_public_federation_api_enabled: "{{ matrix_dendrite_federation_enabled }}"
  123. matrix_dendrite_container_labels_public_federation_api_traefik_hostname: "{{ matrix_dendrite_hostname }}"
  124. matrix_dendrite_container_labels_public_federation_api_traefik_path_prefix: /_matrix
  125. matrix_dendrite_container_labels_public_federation_api_traefik_rule: "Host(`{{ matrix_dendrite_container_labels_public_federation_api_traefik_hostname }}`) && PathPrefix(`{{ matrix_dendrite_container_labels_public_federation_api_traefik_path_prefix }}`)"
  126. matrix_dendrite_container_labels_public_federation_api_traefik_priority: 0
  127. matrix_dendrite_container_labels_public_federation_api_traefik_entrypoints: ''
  128. # TLS is force-enabled here, because the spec (https://spec.matrix.org/v1.9/server-server-api/#tls) says that the federation API must use HTTPS.
  129. matrix_dendrite_container_labels_public_federation_api_traefik_tls: true
  130. matrix_dendrite_container_labels_public_federation_api_traefik_tls_certResolver: "{{ matrix_dendrite_container_labels_traefik_tls_certResolver }}" # noqa var-naming
  131. # Controls whether labels will be added that expose Dendrite's metrics on a public Traefik entrypoint.
  132. matrix_dendrite_container_labels_public_metrics_enabled: "{{ matrix_dendrite_metrics_enabled and matrix_dendrite_metrics_proxying_enabled }}"
  133. matrix_dendrite_container_labels_public_metrics_traefik_rule: "Host(`{{ matrix_dendrite_metrics_proxying_hostname }}`) && PathPrefix(`{{ matrix_dendrite_metrics_proxying_path_prefix }}`)"
  134. matrix_dendrite_container_labels_public_metrics_traefik_priority: 0
  135. matrix_dendrite_container_labels_public_metrics_traefik_entrypoints: "{{ matrix_dendrite_container_labels_traefik_entrypoints }}"
  136. matrix_dendrite_container_labels_public_metrics_traefik_tls: "{{ matrix_dendrite_container_labels_public_metrics_traefik_entrypoints != 'web' }}"
  137. matrix_dendrite_container_labels_public_metrics_traefik_tls_certResolver: "{{ matrix_dendrite_container_labels_traefik_tls_certResolver }}" # noqa var-naming
  138. matrix_dendrite_container_labels_public_metrics_middleware_basic_auth_enabled: false
  139. # See: https://doc.traefik.io/traefik/middlewares/http/basicauth/#users
  140. matrix_dendrite_container_labels_public_metrics_middleware_basic_auth_users: ''
  141. # matrix_dendrite_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file.
  142. # See `../templates/labels.j2` for details.
  143. #
  144. # Example:
  145. # matrix_dendrite_container_labels_additional_labels: |
  146. # my.label=1
  147. # another.label="here"
  148. matrix_dendrite_container_labels_additional_labels: ''
  149. # A list of extra arguments to pass to the container (`docker run` command)
  150. # Also see `matrix_dendrite_container_arguments`
  151. matrix_dendrite_container_extra_arguments: []
  152. # matrix_dendrite_container_extra_arguments_auto is a list of extra arguments to pass to the container.
  153. # This list is managed by the playbook. You're not meant to override this variable.
  154. # If you'd like to inject your own arguments, see `matrix_dendrite_container_extra_arguments`.
  155. matrix_dendrite_container_extra_arguments_auto: []
  156. # matrix_dendrite_container_arguments holds the final list of extra arguments to pass to the container.
  157. # You're not meant to override this variable.
  158. # If you'd like to inject your own arguments, see `matrix_dendrite_container_extra_arguments`.
  159. matrix_dendrite_container_arguments: "{{ matrix_dendrite_container_extra_arguments + matrix_dendrite_container_extra_arguments_auto }}"
  160. # A list of extra arguments to pass to the container process (`dendrite-monolith` command)
  161. # Example:
  162. # matrix_dendrite_process_extra_arguments:
  163. # - "-tls-cert /some/path.crt"
  164. # - "-tls-key /some/path.pem"
  165. matrix_dendrite_process_extra_arguments: []
  166. # List of systemd services that matrix-dendrite.service depends on
  167. matrix_dendrite_systemd_required_services_list: "{{ matrix_dendrite_systemd_required_services_list_default + matrix_dendrite_systemd_required_services_list_auto + matrix_dendrite_systemd_required_services_list_custom }}"
  168. matrix_dendrite_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
  169. matrix_dendrite_systemd_required_services_list_auto: []
  170. matrix_dendrite_systemd_required_services_list_custom: []
  171. # List of systemd services that matrix-dendrite.service wants
  172. matrix_dendrite_systemd_wanted_services_list: "{{ matrix_dendrite_systemd_wanted_services_list_default + matrix_dendrite_systemd_wanted_services_list_auto + matrix_dendrite_systemd_wanted_services_list_custom }}"
  173. matrix_dendrite_systemd_wanted_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
  174. matrix_dendrite_systemd_wanted_services_list_auto: []
  175. matrix_dendrite_systemd_wanted_services_list_custom: []
  176. # Controls how long to sleep for after starting the matrix-dendrite container.
  177. #
  178. # Delaying, so that the homeserver can manage to fully start and various services
  179. # that depend on it (`matrix_dendrite_systemd_required_services_list` and `matrix_dendrite_systemd_wanted_services_list`)
  180. # may only start after the homeserver is up and running.
  181. #
  182. # This can be set to 0 to remove the delay.
  183. matrix_dendrite_systemd_service_post_start_delay_seconds: 3
  184. # Specifies which template files to use when configuring Dendrite.
  185. # If you'd like to have your own different configuration, feel free to copy and paste
  186. # the original files into your inventory (e.g. in `inventory/host_vars/matrix.example.com/`)
  187. # and then change the specific host's `vars.yml` file like this:
  188. # matrix_dendrite_template_dendrite_config: "{{ playbook_dir }}/inventory/host_vars/matrix.example.com/dendrite.yaml.j2"
  189. matrix_dendrite_template_dendrite_config: "{{ role_path }}/templates/dendrite.yaml.j2"
  190. matrix_dendrite_client_api_registration_shared_secret: ""
  191. matrix_dendrite_allow_guest_access: false
  192. matrix_dendrite_max_file_size_bytes: 10485760
  193. # Controls which HTTP header (e.g. 'X-Forwarded-For', 'X-Real-IP') to inspect to find the real remote IP address of the client.
  194. # This is likely required if Dendrite is running behind a reverse proxy server.
  195. matrix_dendrite_sync_api_real_ip_header: "X-Forwarded-For"
  196. # The tmpfs at /tmp needs to be large enough to handle multiple concurrent file uploads.
  197. matrix_dendrite_tmp_directory_size_mb: 500
  198. # Rate limits
  199. matrix_dendrite_client_api_rate_limiting_enabled: true
  200. matrix_dendrite_client_api_rate_limiting_threshold: 20
  201. matrix_dendrite_client_api_rate_limiting_cooloff_ms: 500
  202. # Controls whether people with access to the homeserver can register by themselves.
  203. matrix_dendrite_client_api_registration_disabled: true
  204. # Controls whether guest accounts are disabled
  205. matrix_dendrite_guests_disabled: true
  206. # reCAPTCHA API for validating registration attempts
  207. matrix_dendrite_client_api_enable_registration_captcha: false
  208. matrix_dendrite_client_api_recaptcha_public_key: ""
  209. matrix_dendrite_client_api_recaptcha_private_key: ""
  210. matrix_dendrite_client_api_recaptcha_siteverify_api: ""
  211. matrix_dendrite_client_api_recaptcha_api_js_url: ""
  212. matrix_dendrite_client_api_recaptcha_form_field: ""
  213. matrix_dendrite_client_api_recaptcha_sitekey_class: ""
  214. # A list of additional "volumes" to mount in the container.
  215. # This list gets populated dynamically based on Dendrite extensions that have been enabled.
  216. # Contains definition objects like this: `{"src": "/outside", "dst": "/inside", "options": "ro"}
  217. # Note: internally, this uses the `--mount` flag for mounting the specified volumes.
  218. matrix_dendrite_container_additional_volumes: []
  219. # A list of appservice config files (in-container filesystem paths).
  220. # This list gets populated dynamically based on Dendrite extensions that have been enabled.
  221. # You may wish to use this together with `matrix_dendrite_container_additional_volumes` or `matrix_dendrite_container_extra_arguments`.
  222. # Also see `matrix_dendrite_app_service_config_files_final`
  223. matrix_dendrite_app_service_config_files: []
  224. # matrix_dendrite_app_service_config_files_auto is a list of appservice config files.
  225. # This list is managed by the playbook. You're not meant to override this variable.
  226. # If you'd like to inject your own arguments, see `matrix_dendrite_app_service_config_files`.
  227. matrix_dendrite_app_service_config_files_auto: []
  228. # matrix_dendrite_app_service_config_files_final holds the final list of config files to pass to the container.
  229. # You're not meant to override this variable.
  230. # If you'd like to inject your own arguments, see `matrix_dendrite_app_service_config_files`.
  231. matrix_dendrite_app_service_config_files_final: "{{ matrix_dendrite_app_service_config_files + matrix_dendrite_app_service_config_files_auto }}"
  232. # Enable exposure of metrics
  233. matrix_dendrite_metrics_enabled: false
  234. matrix_dendrite_metrics_username: ""
  235. matrix_dendrite_metrics_password: ""
  236. # Controls whether metrics should be exposed on a public URL.
  237. matrix_dendrite_metrics_proxying_enabled: false
  238. matrix_dendrite_metrics_proxying_hostname: "{{ matrix_dendrite_hostname }}"
  239. matrix_dendrite_metrics_proxying_path_prefix: /metrics/dendrite
  240. # Postgres database information
  241. matrix_dendrite_database_str: "postgresql://{{ matrix_dendrite_database_user }}:{{ matrix_dendrite_database_password }}@{{ matrix_dendrite_database_hostname }}"
  242. matrix_dendrite_database_hostname: ""
  243. matrix_dendrite_database_user: "dendrite"
  244. matrix_dendrite_database_password: "itsasecret"
  245. matrix_dendrite_database_sslmode: disable
  246. matrix_dendrite_federation_api_database: "dendrite_federationapi"
  247. matrix_dendrite_key_server_database: "dendrite_keyserver"
  248. matrix_dendrite_media_api_database: "dendrite_mediaapi"
  249. matrix_dendrite_room_database: "dendrite_room"
  250. matrix_dendrite_sync_api_database: "dendrite_syncapi"
  251. matrix_dendrite_user_api_database: "dendrite_userapi"
  252. matrix_dendrite_push_server_database: "dendrite_pushserver"
  253. matrix_dendrite_relay_api_database: "dendrite_relayapi"
  254. matrix_dendrite_mscs_database: "dendrite_mscs"
  255. matrix_dendrite_client_api_turn_uris: []
  256. matrix_dendrite_client_api_turn_shared_secret: ""
  257. matrix_dendrite_client_api_turn_username: ""
  258. matrix_dendrite_client_api_turn_password: ""
  259. matrix_dendrite_client_api_turn_allow_guests: false
  260. matrix_dendrite_disable_tls_validation: false
  261. matrix_dendrite_trusted_id_servers:
  262. - "matrix.org"
  263. - "vector.im"
  264. # Controls whether Dendrite will federate at all.
  265. # Disable this to completely isolate your server from the rest of the Matrix network.
  266. matrix_dendrite_federation_enabled: true
  267. # Controls whether the self-check feature should validate SSL certificates.
  268. matrix_dendrite_self_check_validate_certificates: true
  269. # Default Dendrite configuration template which covers the generic use case.
  270. # You can customize it by controlling the various variables inside it.
  271. #
  272. # For a more advanced customization, you can extend the default (see `matrix_dendrite_configuration_extension_yaml`)
  273. # or completely replace this variable with your own template.
  274. matrix_dendrite_configuration_yaml: "{{ lookup('template', matrix_dendrite_template_dendrite_config) }}"
  275. matrix_dendrite_configuration_extension_yaml: |
  276. # Your custom YAML configuration for Dendrite goes here.
  277. # This configuration extends the default starting configuration (`matrix_dendrite_configuration_yaml`).
  278. #
  279. # You can override individual variables from the default configuration, or introduce new ones.
  280. #
  281. # If you need something more special, you can take full control by
  282. # completely redefining `matrix_dendrite_configuration_yaml`.
  283. #
  284. # Example configuration extension follows:
  285. #
  286. # server_notices:
  287. # system_mxid_localpart: notices
  288. # system_mxid_display_name: "Server Notices"
  289. # system_mxid_avatar_url: "mxc://example.com/oumMVlgDnLYFaPVkExemNVVZ"
  290. # room_name: "Server Notices"
  291. matrix_dendrite_configuration_extension: "{{ matrix_dendrite_configuration_extension_yaml | from_yaml if matrix_dendrite_configuration_extension_yaml | from_yaml is mapping else {} }}"
  292. # Holds the final Dendrite configuration (a combination of the default and its extension).
  293. # You most likely don't need to touch this variable. Instead, see `matrix_dendrite_configuration_yaml`.
  294. matrix_dendrite_configuration: "{{ matrix_dendrite_configuration_yaml | from_yaml | combine(matrix_dendrite_configuration_extension, recursive=True) }}"
  295. matrix_dendrite_user_api_auto_join_rooms: []
  296. # statistics reporting configuration. These statistics contain the server
  297. # name, number of active users and some information on your deployment config.
  298. matrix_dendrite_report_stats: false
  299. # Controls whether thumbnails for media content are generated dynamically
  300. matrix_dendrite_media_api_dynamic_thumbnails: false
  301. matrix_dendrite_media_api_max_thumbnail_generators: 10
  302. # Controls whether the full-text search engine is enabled
  303. matrix_dendrite_sync_api_search_enabled: false
  304. # matrix_dendrite_restart_necessary controls whether the service
  305. # will be restarted (when true) or merely started (when false) by the
  306. # systemd service manager role (when conditional restart is enabled).
  307. #
  308. # This value is automatically computed during installation based on whether
  309. # any configuration files, the systemd service file, or the container image changed.
  310. # The default of `false` means "no restart needed" — appropriate when the role's
  311. # installation tasks haven't run (e.g., due to --tags skipping them).
  312. matrix_dendrite_restart_necessary: false