Matrix Docker Ansible eploy
Non puoi selezionare più di 25 argomenti Gli argomenti devono iniziare con una lettera o un numero, possono includere trattini ('-') e possono essere lunghi fino a 35 caratteri.
 
 

725 righe
46 KiB

  1. ---
  2. # Project source code URL: https://github.com/nginx/nginx
  3. matrix_nginx_proxy_enabled: true
  4. # renovate: datasource=docker depName=nginx
  5. matrix_nginx_proxy_version: 1.25.3-alpine
  6. # We use an official nginx image, which we fix-up to run unprivileged.
  7. # An alternative would be an `nginxinc/nginx-unprivileged` image, but
  8. # that is frequently out of date.
  9. matrix_nginx_proxy_docker_image: "{{ matrix_container_global_registry_prefix }}nginx:{{ matrix_nginx_proxy_version }}"
  10. matrix_nginx_proxy_docker_image_force_pull: "{{ matrix_nginx_proxy_docker_image.endswith(':latest') }}"
  11. matrix_nginx_proxy_base_path: "{{ matrix_base_data_path }}/nginx-proxy"
  12. matrix_nginx_proxy_data_path: "{{ matrix_nginx_proxy_base_path }}/data"
  13. matrix_nginx_proxy_data_path_in_container: "/nginx-data"
  14. matrix_nginx_proxy_data_path_extension: "/matrix-domain"
  15. matrix_nginx_proxy_confd_path: "{{ matrix_nginx_proxy_base_path }}/conf.d"
  16. # List of systemd services that matrix-nginx-proxy.service depends on
  17. matrix_nginx_proxy_systemd_required_services_list: ['docker.service']
  18. # List of systemd services that matrix-nginx-proxy.service wants
  19. matrix_nginx_proxy_systemd_wanted_services_list: []
  20. # The base container network.
  21. # Also see: matrix_nginx_proxy_container_additional_networks
  22. matrix_nginx_proxy_container_network: "{{ matrix_docker_network }}"
  23. # A list of additional container networks that matrix-nginx-proxy would be connected to.
  24. # The playbook does not create these networks, so make sure they already exist.
  25. #
  26. # Use this to expose matrix-nginx-proxy to another reverse proxy, which runs in a different container network,
  27. # without exposing all other Matrix services to that other reverse-proxy.
  28. #
  29. # For background, see: https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1498
  30. matrix_nginx_proxy_container_additional_networks: []
  31. # A list of additional "volumes" to mount in the container.
  32. # This list gets populated dynamically at runtime. You can provide a different default value,
  33. # if you wish to mount your own files into the container.
  34. # Contains definition objects like this: `{"src": "/outside", "dst": "/inside", "options": "rw|ro|slave|.."}
  35. matrix_nginx_proxy_container_additional_volumes: []
  36. # matrix_nginx_proxy_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container.
  37. # See `../templates/labels.j2` for details.
  38. #
  39. # To inject your own other container labels, see `matrix_nginx_proxy_container_labels_additional_labels`.
  40. matrix_nginx_proxy_container_labels_traefik_enabled: false
  41. matrix_nginx_proxy_container_labels_traefik_docker_network: "{{ matrix_nginx_proxy_container_network }}"
  42. matrix_nginx_proxy_container_labels_traefik_entrypoints: web-secure
  43. matrix_nginx_proxy_container_labels_traefik_tls_certResolver: default # noqa var-naming
  44. matrix_nginx_proxy_container_labels_traefik_proxy_base_domain_enabled: "{{ matrix_nginx_proxy_base_domain_serving_enabled }}"
  45. matrix_nginx_proxy_container_labels_traefik_proxy_base_domain_hostname: "{{ matrix_nginx_proxy_base_domain_hostname }}"
  46. matrix_nginx_proxy_container_labels_traefik_proxy_base_domain_tls: "{{ matrix_nginx_proxy_container_labels_traefik_entrypoints != 'web' }}"
  47. matrix_nginx_proxy_container_labels_traefik_proxy_base_domain_rule: "Host(`{{ matrix_nginx_proxy_container_labels_traefik_proxy_base_domain_hostname }}`)"
  48. matrix_nginx_proxy_container_labels_traefik_proxy_matrix_enabled: false
  49. matrix_nginx_proxy_container_labels_traefik_proxy_matrix_tls: "{{ matrix_nginx_proxy_container_labels_traefik_entrypoints != 'web' }}"
  50. matrix_nginx_proxy_container_labels_traefik_proxy_matrix_client_hostname: "{{ matrix_server_fqn_matrix }}"
  51. matrix_nginx_proxy_container_labels_traefik_proxy_matrix_client_rule: "Host(`{{ matrix_nginx_proxy_container_labels_traefik_proxy_matrix_client_hostname }}`)"
  52. matrix_nginx_proxy_container_labels_traefik_proxy_matrix_federation_hostname: "{{ matrix_server_fqn_matrix }}"
  53. matrix_nginx_proxy_container_labels_traefik_proxy_matrix_federation_rule: "Host(`{{ matrix_nginx_proxy_container_labels_traefik_proxy_matrix_federation_hostname }}`)"
  54. matrix_nginx_proxy_container_labels_traefik_proxy_matrix_federation_entrypoint: "{{ matrix_federation_traefik_entrypoint }}"
  55. matrix_nginx_proxy_container_labels_traefik_proxy_matrix_federation_entrypoints: "{{ matrix_nginx_proxy_container_labels_traefik_proxy_matrix_federation_entrypoint }}"
  56. # matrix_nginx_proxy_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file.
  57. # See `../templates/labels.j2` for details.
  58. #
  59. # Example:
  60. # matrix_nginx_proxy_container_labels_additional_labels: |
  61. # my.label=1
  62. # another.label="here"
  63. matrix_nginx_proxy_container_labels_additional_labels: ''
  64. # A list of extra arguments to pass to the container
  65. matrix_nginx_proxy_container_extra_arguments: []
  66. # Controls whether matrix-nginx-proxy serves its vhosts over HTTPS or HTTP.
  67. #
  68. # If enabled:
  69. # - SSL certificates would be expected to be available (see `matrix_ssl_retrieval_method`)
  70. # - the HTTP vhost would be made a redirect to the HTTPS vhost
  71. #
  72. # If not enabled:
  73. # - you don't need any SSL certificates (you can set `matrix_ssl_retrieval_method: none`)
  74. # - naturally, there's no HTTPS vhost
  75. # - services are served directly from the HTTP vhost
  76. matrix_nginx_proxy_https_enabled: true
  77. # Controls whether matrix-nginx-proxy trusts an upstream server's X-Forwarded-Proto header
  78. #
  79. # Required if you disable HTTPS for the container (see `matrix_nginx_proxy_https_enabled`) and have an upstream server handle it instead.
  80. matrix_nginx_proxy_trust_forwarded_proto: false
  81. matrix_nginx_proxy_x_forwarded_proto_value: "{{ '$http_x_forwarded_proto' if matrix_nginx_proxy_trust_forwarded_proto else '$scheme' }}"
  82. # Controls whether the matrix-nginx-proxy container exposes its HTTP port (tcp/8080 in the container).
  83. #
  84. # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:80"), or empty string to not expose.
  85. matrix_nginx_proxy_container_http_host_bind_port: '80'
  86. # Controls whether the matrix-nginx-proxy container exposes its HTTPS port (tcp/8443 in the container).
  87. #
  88. # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:443"), or empty string to not expose.
  89. #
  90. # This only makes sense and applies if `matrix_nginx_proxy_https_enabled` is set to `true`.
  91. # Otherwise, there are no HTTPS vhosts to expose.
  92. matrix_nginx_proxy_container_https_host_bind_port: '443'
  93. # Controls whether the matrix-nginx-proxy container exposes the Matrix Federation port (tcp/8448 in the container).
  94. #
  95. # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8448"), or empty string to not expose.
  96. #
  97. # This only makes sense and applies if `matrix_nginx_proxy_proxy_matrix_federation_api_enabled` is set to `true`.
  98. # Otherwise, there is no Matrix Federation port to expose.
  99. #
  100. # This port can take HTTP or HTTPS traffic, depending on `matrix_nginx_proxy_https_enabled`.
  101. # When HTTPS is disabled, you'd likely want to only expose the port locally, and front it with another HTTPS-enabled reverse-proxy.
  102. matrix_nginx_proxy_container_federation_host_bind_port: '8448'
  103. # Controls whether matrix-nginx-proxy should serve the base domain.
  104. #
  105. # This is useful for when you only have your Matrix server, but you need to serve
  106. # to serve `/.well-known/matrix/*` files from the base domain for the needs of
  107. # Server-Discovery (Federation) and for Client-Discovery.
  108. #
  109. # Besides serving these Matrix files, a homepage would be served with content
  110. # as specified in the `matrix_nginx_proxy_base_domain_homepage_template` variable.
  111. # You can also put additional files to use for this webpage
  112. # in the `{{ matrix_nginx_proxy_data_path }}/matrix-domain` (`/matrix/nginx-proxy/data/matrix-domain`) directory.
  113. matrix_nginx_proxy_base_domain_serving_enabled: false
  114. # Controls whether the base domain directory and default index.html file are created.
  115. matrix_nginx_proxy_base_domain_create_directory: true
  116. matrix_nginx_proxy_base_domain_hostname: "{{ matrix_domain }}"
  117. # Controls whether `matrix_nginx_proxy_base_domain_homepage_template` would be dumped to an `index.html` file
  118. # in the `/matrix/nginx-proxy/data/matrix-domain` directory.
  119. #
  120. # If you would instead like to serve a static website by yourself, you can disable this.
  121. # When disabled, you're expected to put website files in `/matrix/nginx-proxy/data/matrix-domain` manually
  122. # and can expect that the playbook won't intefere with the `index.html` file.
  123. matrix_nginx_proxy_base_domain_homepage_enabled: true
  124. matrix_nginx_proxy_base_domain_homepage_template: |-
  125. <!doctype html>
  126. <meta charset="utf-8" />
  127. <html>
  128. <body>
  129. Hello from {{ matrix_domain }}!
  130. </body>
  131. </html>
  132. # Option to disable the access log
  133. matrix_nginx_proxy_access_log_enabled: true
  134. # Controls whether proxying the riot domain should be done.
  135. matrix_nginx_proxy_proxy_riot_compat_redirect_enabled: false
  136. matrix_nginx_proxy_proxy_riot_compat_redirect_hostname: "riot.{{ matrix_domain }}"
  137. # Controls whether proxying for Synapse should be done.
  138. matrix_nginx_proxy_proxy_synapse_enabled: false
  139. matrix_nginx_proxy_proxy_synapse_hostname: "matrix-nginx-proxy"
  140. matrix_nginx_proxy_proxy_synapse_federation_api_enabled: "{{ matrix_nginx_proxy_proxy_matrix_federation_api_enabled }}"
  141. # The addresses where the Matrix Client API is, when using Synapse.
  142. matrix_nginx_proxy_proxy_synapse_client_api_addr_with_container: ""
  143. matrix_nginx_proxy_proxy_synapse_client_api_addr_sans_container: ""
  144. # The addresses where the Federation API is, when using Synapse.
  145. matrix_nginx_proxy_proxy_synapse_federation_api_addr_with_container: ""
  146. matrix_nginx_proxy_proxy_synapse_federation_api_addr_sans_container: ""
  147. # A list of strings containing additional configuration blocks to add to the Synapse's server configuration (matrix-synapse.conf).
  148. matrix_nginx_proxy_proxy_synapse_additional_server_configuration_blocks: []
  149. # Controls whether proxying for Dendrite should be done.
  150. matrix_nginx_proxy_proxy_dendrite_enabled: false
  151. matrix_nginx_proxy_proxy_dendrite_hostname: "matrix-nginx-proxy"
  152. matrix_nginx_proxy_proxy_dendrite_federation_api_enabled: "{{ matrix_nginx_proxy_proxy_matrix_federation_api_enabled }}"
  153. # Controls whether the Client API server (usually at matrix.DOMAIN:443) should explicitly reject `/_matrix/federation` endpoints.
  154. # Normally, Dendrite Monolith serves both APIs (Client & Federation) at the same port, so we can serve federation at `matrix.DOMAIN:443` too.
  155. matrix_nginx_proxy_proxy_dendrite_block_federation_api_on_client_port: true
  156. # The addresses where the Matrix Client API is, when using Dendrite.
  157. matrix_nginx_proxy_proxy_dendrite_client_api_addr_with_container: ""
  158. matrix_nginx_proxy_proxy_dendrite_client_api_addr_sans_container: ""
  159. # A list of strings containing additional configuration blocks to add to the Dendrite's server configuration (matrix-dendrite.conf).
  160. matrix_nginx_proxy_proxy_dendrite_additional_server_configuration_blocks: []
  161. # Controls whether proxying for Conduit should be done.
  162. matrix_nginx_proxy_proxy_conduit_enabled: false
  163. matrix_nginx_proxy_proxy_conduit_hostname: "matrix-nginx-proxy"
  164. matrix_nginx_proxy_proxy_conduit_federation_api_enabled: "{{ matrix_nginx_proxy_proxy_matrix_federation_api_enabled }}"
  165. # Controls whether the Client API server (usually at matrix.DOMAIN:443) should explicitly reject `/_matrix/federation` endpoints.
  166. matrix_nginx_proxy_proxy_conduit_block_federation_api_on_client_port: true
  167. # The addresses where the Matrix Client API is, when using Conduit.
  168. matrix_nginx_proxy_proxy_conduit_client_api_addr_with_container: ""
  169. matrix_nginx_proxy_proxy_conduit_client_api_addr_sans_container: ""
  170. # The addresses where the Federation API is, when using Conduit.
  171. matrix_nginx_proxy_proxy_conduit_federation_api_addr_with_container: ""
  172. matrix_nginx_proxy_proxy_conduit_federation_api_addr_sans_container: ""
  173. # A list of strings containing additional configuration blocks to add to the Conduit's server configuration (matrix-conduit.conf).
  174. matrix_nginx_proxy_proxy_conduit_additional_server_configuration_blocks: []
  175. # Controls whether proxying the Element domain should be done.
  176. matrix_nginx_proxy_proxy_element_enabled: false
  177. matrix_nginx_proxy_proxy_element_hostname: "{{ matrix_server_fqn_element }}"
  178. # Controls whether proxying the Hydrogen domain should be done.
  179. matrix_nginx_proxy_proxy_hydrogen_enabled: false
  180. matrix_nginx_proxy_proxy_hydrogen_hostname: "{{ matrix_server_fqn_hydrogen }}"
  181. # Controls whether proxying the Cinny domain should be done.
  182. matrix_nginx_proxy_proxy_cinny_enabled: false
  183. matrix_nginx_proxy_proxy_cinny_hostname: "{{ matrix_server_fqn_cinny }}"
  184. # Controls whether proxying the schildichat domain should be done.
  185. matrix_nginx_proxy_proxy_schildichat_enabled: false
  186. matrix_nginx_proxy_proxy_schildichat_hostname: "{{ matrix_server_fqn_schildichat }}"
  187. # Controls whether proxying the buscarron domain should be done.
  188. matrix_nginx_proxy_proxy_buscarron_enabled: false
  189. matrix_nginx_proxy_proxy_buscarron_hostname: "{{ matrix_server_fqn_buscarron }}"
  190. # Controls whether proxying the matrix domain should be done.
  191. matrix_nginx_proxy_proxy_matrix_enabled: false
  192. matrix_nginx_proxy_proxy_matrix_hostname: "{{ matrix_server_fqn_matrix }}"
  193. matrix_nginx_proxy_proxy_matrix_federation_hostname: "{{ matrix_nginx_proxy_proxy_matrix_hostname }}"
  194. # The port name used for federation in the nginx configuration.
  195. # This is not necessarily the port that it's actually on,
  196. # as port-mapping happens (`-p ..`) for the `matrix-nginx-proxy` container.
  197. matrix_nginx_proxy_proxy_matrix_federation_port: 8448
  198. # Controls whether proxying the dimension domain should be done.
  199. matrix_nginx_proxy_proxy_dimension_enabled: false
  200. matrix_nginx_proxy_proxy_dimension_hostname: "{{ matrix_server_fqn_dimension }}"
  201. # Controls whether proxying the rageshake domain should be done.
  202. matrix_nginx_proxy_proxy_rageshake_enabled: false
  203. matrix_nginx_proxy_proxy_rageshake_hostname: "{{ matrix_server_fqn_rageshake }}"
  204. # Controls whether proxying the etherpad domain should be done.
  205. matrix_nginx_proxy_proxy_etherpad_enabled: false
  206. matrix_nginx_proxy_proxy_etherpad_hostname: "{{ matrix_server_fqn_etherpad }}"
  207. # Controls whether proxying the goneb domain should be done.
  208. matrix_nginx_proxy_proxy_bot_go_neb_enabled: false
  209. matrix_nginx_proxy_proxy_bot_go_neb_hostname: "{{ matrix_server_fqn_bot_go_neb }}"
  210. # Controls whether proxying the jitsi domain should be done.
  211. matrix_nginx_proxy_proxy_jitsi_enabled: false
  212. matrix_nginx_proxy_proxy_jitsi_hostname: "{{ matrix_server_fqn_jitsi }}"
  213. # Controls whether proxying the grafana domain should be done.
  214. matrix_nginx_proxy_proxy_grafana_enabled: false
  215. matrix_nginx_proxy_proxy_grafana_hostname: "{{ matrix_server_fqn_grafana }}"
  216. # Controls whether proxying the sygnal domain should be done.
  217. matrix_nginx_proxy_proxy_sygnal_enabled: false
  218. matrix_nginx_proxy_proxy_sygnal_hostname: "{{ matrix_server_fqn_sygnal }}"
  219. # Controls whether proxying the mautrix wsproxy should be done.
  220. matrix_nginx_proxy_proxy_mautrix_wsproxy_enabled: false
  221. matrix_nginx_proxy_proxy_mautrix_wsproxy_hostname: "{{ matrix_server_fqn_mautrix_wsproxy }}"
  222. # Controls whether proxying the ntfy domain should be done.
  223. matrix_nginx_proxy_proxy_ntfy_enabled: false
  224. matrix_nginx_proxy_proxy_ntfy_hostname: "{{ matrix_server_fqn_ntfy }}"
  225. # Controls whether proxying for (Prometheus) metrics (`/metrics/*`) for the various services should be done (on the matrix domain)
  226. # If the internal Prometheus server (`matrix-prometheus` role) is used, proxying is not necessary, since Prometheus can access each container directly.
  227. # This is only useful when an external Prometheus will be collecting metrics.
  228. #
  229. # To control what kind of metrics are exposed under `/metrics/` (e.g `/metrics/node-exporter`, `/metrics/postgres-exporter`, etc.),
  230. # use `matrix_SERVICE_metrics_proxying_enabled` variables in each respective role.
  231. # Roles inject themselves into the matrix-nginx-proxy configuration.
  232. #
  233. # To protect the metrics endpoints, see `matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_enabled`
  234. matrix_nginx_proxy_proxy_matrix_metrics_enabled: false
  235. # Controls whether Basic Auth is enabled for all `/metrics/*` endpoints.
  236. #
  237. # You can provide the Basic Auth credentials in 2 ways:
  238. # 1. A single username/password pair using `matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_username` and `matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_password`
  239. # 2. Using raw content (`htpasswd`-generated file) provided in `matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_raw_content`
  240. matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_enabled: false
  241. # `matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_username` and `matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_password` specify
  242. # the Basic Auth username/password for protecting `/metrics/*` endpoints.
  243. # Alternatively, use `matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_raw_content`.
  244. matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_username: ""
  245. matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_password: ""
  246. # `matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_raw_content` value will be written verbatim to the htpasswd file protecting `/metrics/*` endpoints.
  247. # Use this when a single username/password is not enough and you'd like to get more control over credentials.
  248. #
  249. # Read the manpage at `man 1 htpasswd` to learn more, then encrypt your password, and paste the encrypted value here.
  250. # e.g. `htpasswd -c mypass.htpasswd prometheus` and enter `mysecurepw` when prompted yields `prometheus:$apr1$wZhqsn.U$7LC3kMmjUbjNAZjyMyvYv/`
  251. # The whole thing is needed here. matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_raw_content: "prometheus:$apr1$wZhqsn.U$7LC3kMmjUbjNAZjyMyvYv/"
  252. matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_raw_content: ""
  253. # Specifies the path to the htpasswd file holding the htpasswd credentials for protecting `/metrics/*` endpoints
  254. # This is not meant to be modified.
  255. matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_path: "{{ matrix_nginx_proxy_data_path_in_container if matrix_nginx_proxy_enabled else matrix_nginx_proxy_data_path }}/matrix-metrics-htpasswd"
  256. # Specifies the Apache container image to use
  257. # when `matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_username` and `matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_password` are provided.
  258. # This image provides the `htpasswd` tool which we use for generating the htpasswd file protecting `/metrics/*`.
  259. # To avoid using this, use `matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_raw_content` instead of supplying username/password.
  260. # Learn more in: `roles/custom/matrix-nginx-proxy/tasks/nginx-proxy/setup_metrics_auth.yml`.
  261. matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_apache_container_image: "{{ matrix_container_global_registry_prefix }}httpd:{{ matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_apache_container_image_tag }}"
  262. # renovate: datasource=docker depName=httpd
  263. matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_apache_container_image_tag: "2.4.54-alpine3.16"
  264. matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_apache_container_force_pull: "{{ matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_apache_container_image_tag.endswith(':latest') }}"
  265. # A list of strings containing additional configuration blocks to add to the `location /metrics` configuration (matrix-domain.conf).
  266. # Do not modify `matrix_nginx_proxy_proxy_matrix_metrics_additional_location_configuration_blocks` and `matrix_nginx_proxy_proxy_matrix_metrics_additional_system_location_configuration_blocks`.
  267. # If you'd like to inject your own configuration blocks, use `matrix_nginx_proxy_proxy_matrix_metrics_additional_user_location_configuration_blocks`.
  268. matrix_nginx_proxy_proxy_matrix_metrics_additional_location_configuration_blocks: "{{ matrix_nginx_proxy_proxy_matrix_metrics_additional_system_location_configuration_blocks + matrix_nginx_proxy_proxy_matrix_metrics_additional_user_location_configuration_blocks }}"
  269. matrix_nginx_proxy_proxy_matrix_metrics_additional_system_location_configuration_blocks: []
  270. matrix_nginx_proxy_proxy_matrix_metrics_additional_user_location_configuration_blocks: []
  271. # Controls whether proxying for the matrix-corporal API (`/_matrix/corporal`) should be done (on the matrix domain)
  272. matrix_nginx_proxy_proxy_matrix_corporal_api_enabled: false
  273. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_with_container: "matrix-corporal:41081"
  274. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_sans_container: "127.0.0.1:41081"
  275. # Controls whether proxying for the User Directory Search API (`/_matrix/client/r0/user_directory/search`) should be done (on the matrix domain).
  276. # This can be used to forward the API endpoint to another service, augmenting the functionality of Synapse's own User Directory Search.
  277. # To learn more, see: https://github.com/ma1uta/ma1sd/blob/master/docs/features/directory.md
  278. matrix_nginx_proxy_proxy_matrix_user_directory_search_enabled: false
  279. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_with_container: "matrix-ma1sd:{{ matrix_ma1sd_container_port }}"
  280. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_sans_container: "127.0.0.1:{{ matrix_ma1sd_container_port }}"
  281. # Controls whether the user directory search API will be URL-rewritten (/_matrix/client/v3/user_directory/search -> /_matrix/client/r0/user_directory/search).
  282. # This is to assist identity servers which only handle the r0 endpoints.
  283. # The v3 endpoints are the same (spec-wise), so they can usually be redirected without downsides.
  284. # If this is disabled, API requests will be forwarded as-is, without any URL rewriting.
  285. matrix_nginx_proxy_proxy_matrix_user_directory_search_v3_to_r0_redirect_enabled: true
  286. # Controls whether proxying for 3PID-based registration (`/_matrix/client/r0/register/(email|msisdn)/requestToken`) should be done (on the matrix domain).
  287. # This allows another service to control registrations involving 3PIDs.
  288. # To learn more, see: https://github.com/ma1uta/ma1sd/blob/master/docs/features/registration.md
  289. matrix_nginx_proxy_proxy_matrix_3pid_registration_enabled: false
  290. matrix_nginx_proxy_proxy_matrix_3pid_registration_addr_with_container: "matrix-ma1sd:{{ matrix_ma1sd_container_port }}"
  291. matrix_nginx_proxy_proxy_matrix_3pid_registration_addr_sans_container: "127.0.0.1:{{ matrix_ma1sd_container_port }}"
  292. # Controls whether the user directory search API will be URL-rewritten (/_matrix/client/v3/register/(email|msisdn)/requestToken -> /_matrix/client/r0/register/(email|msisdn)/requestToken).
  293. # This is to assist identity servers which only handle the r0 endpoints.
  294. # The v3 endpoints are the same (spec-wise), so they can usually be redirected without downsides.
  295. # If this is disabled, API requests will be forwarded as-is, without any URL rewriting.
  296. matrix_nginx_proxy_proxy_matrix_3pid_registration_v3_to_r0_redirect_enabled: true
  297. # Controls whether proxying for the Identity API (`/_matrix/identity`) should be done (on the matrix domain)
  298. matrix_nginx_proxy_proxy_matrix_identity_api_enabled: false
  299. matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container: "matrix-ma1sd:{{ matrix_ma1sd_container_port }}"
  300. matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container: "127.0.0.1:{{ matrix_ma1sd_container_port }}"
  301. # Controls whether proxying for the media repo (`/_matrix/media`) should be done (on the matrix domain)
  302. matrix_nginx_proxy_proxy_media_repo_enabled: false
  303. matrix_nginx_proxy_proxy_media_repo_addr_with_container: "matrix-media-repo:{{ matrix_media_repo_port }}"
  304. matrix_nginx_proxy_proxy_media_repo_addr_sans_container: "127.0.0.1:{{ matrix_media_repo_port }}"
  305. # The addresses where the Matrix Client API is.
  306. # Certain extensions (like matrix-corporal) may override this in order to capture all traffic.
  307. matrix_nginx_proxy_proxy_matrix_client_api_addr_with_container: "matrix-nginx-proxy:12080"
  308. matrix_nginx_proxy_proxy_matrix_client_api_addr_sans_container: "127.0.0.1:12080"
  309. # This needs to be equal or higher than the maximum upload size accepted by Synapse.
  310. matrix_nginx_proxy_proxy_matrix_client_api_client_max_body_size_mb: 50
  311. # Tells whether `/_synapse/client` is forwarded to the Matrix Client API server.
  312. matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_synapse_client_api_enabled: true
  313. # Tells whether `/_synapse/oidc` is forwarded to the Matrix Client API server.
  314. # Enable this if you need OpenID Connect authentication support.
  315. matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_synapse_oidc_api_enabled: false
  316. # Tells whether `/_synapse/admin` is forwarded to the Matrix Client API server.
  317. # Following these recommendations (https://github.com/matrix-org/synapse/blob/master/docs/reverse_proxy.md), by default, we don't.
  318. matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_synapse_admin_api_enabled: false
  319. # `matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_prefixes` holds
  320. # the location prefixes that get forwarded to the Matrix Client API server.
  321. # These locations get combined into a regex like this `^(/_matrix|/_synapse/client)`.
  322. matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_prefix_regexes: |
  323. {{
  324. (['/_matrix'])
  325. +
  326. (['/_synapse/client'] if matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_synapse_client_api_enabled else [])
  327. +
  328. (['/_synapse/oidc'] if matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_synapse_oidc_api_enabled else [])
  329. +
  330. (['/_synapse/admin'] if matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_synapse_admin_api_enabled else [])
  331. }}
  332. # Specifies where requests for the root URI (`/`) on the `matrix.` domain should be redirected.
  333. # If this has an empty value, they're just passed to the homeserver, which serves a static page.
  334. # If you'd like to make `https://matrix.DOMAIN` redirect to `https://element.DOMAIN` (or something of that sort), specify the domain name here.
  335. # Example value: `element.DOMAIN` (or `{{ matrix_server_fqn_element }}`).
  336. matrix_nginx_proxy_proxy_matrix_client_redirect_root_uri_to_domain: ""
  337. # Controls whether proxying for the Matrix Federation API should be done.
  338. matrix_nginx_proxy_proxy_matrix_federation_api_enabled: false
  339. matrix_nginx_proxy_proxy_matrix_federation_api_addr_with_container: "matrix-nginx-proxy:12088"
  340. matrix_nginx_proxy_proxy_matrix_federation_api_addr_sans_container: "127.0.0.1:12088"
  341. matrix_nginx_proxy_proxy_matrix_federation_api_client_max_body_size_mb: "{{ (matrix_nginx_proxy_proxy_matrix_client_api_client_max_body_size_mb | int) * 3 }}"
  342. matrix_nginx_proxy_proxy_matrix_federation_api_ssl_certificate: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_nginx_proxy_proxy_matrix_hostname }}/fullchain.pem"
  343. matrix_nginx_proxy_proxy_matrix_federation_api_ssl_certificate_key: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_nginx_proxy_proxy_matrix_hostname }}/privkey.pem"
  344. matrix_nginx_proxy_proxy_matrix_federation_api_ssl_trusted_certificate: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_nginx_proxy_proxy_matrix_hostname }}/chain.pem"
  345. # The tmpfs at /tmp needs to be large enough to handle multiple concurrent file uploads.
  346. matrix_nginx_proxy_tmp_directory_size_mb: "{{ (matrix_nginx_proxy_proxy_matrix_federation_api_client_max_body_size_mb | int) * 50 }}"
  347. matrix_nginx_proxy_tmp_cache_directory_size_mb: "{{ (matrix_nginx_proxy_synapse_cache_max_size_mb | int) * 2 }}"
  348. # A list of strings containing additional configuration blocks to add to the nginx server configuration (nginx.conf).
  349. # for big matrixservers to enlarge the number of open files to prevent timeouts
  350. # matrix_nginx_proxy_proxy_additional_configuration_blocks:
  351. # - 'worker_rlimit_nofile 30000;'
  352. matrix_nginx_proxy_proxy_additional_configuration_blocks: []
  353. # A list of strings containing additional configuration blocks to add to the nginx event server configuration (nginx.conf).
  354. matrix_nginx_proxy_proxy_event_additional_configuration_blocks: []
  355. # A list of strings containing additional configuration blocks to add to the nginx http's server configuration (nginx-http.conf).
  356. matrix_nginx_proxy_proxy_http_additional_server_configuration_blocks: []
  357. # A list of strings containing additional configuration blocks to add to the base matrix server configuration (matrix-domain.conf).
  358. matrix_nginx_proxy_proxy_matrix_additional_server_configuration_blocks: []
  359. # A list of strings containing additional configuration blocks to add to Riot's server configuration (matrix-riot-web.conf).
  360. matrix_nginx_proxy_proxy_riot_additional_server_configuration_blocks: []
  361. # A list of strings containing additional configuration blocks to add to Element's server configuration (matrix-client-element.conf).
  362. matrix_nginx_proxy_proxy_element_additional_server_configuration_blocks: []
  363. # A list of strings containing additional configuration blocks to add to Hydrogen's server configuration (matrix-client-hydrogen.conf).
  364. matrix_nginx_proxy_proxy_hydrogen_additional_server_configuration_blocks: []
  365. # A list of strings containing additional configuration blocks to add to Cinny's server configuration (matrix-client-cinny.conf).
  366. matrix_nginx_proxy_proxy_cinny_additional_server_configuration_blocks: []
  367. # A list of strings containing additional configuration blocks to add to schildichat's server configuration (matrix-client-schildichat.conf).
  368. matrix_nginx_proxy_proxy_schildichat_additional_server_configuration_blocks: []
  369. # A list of strings containing additional configuration blocks to add to buscarron's server configuration (matrix-bot-buscarron.conf).
  370. matrix_nginx_proxy_proxy_buscarron_additional_server_configuration_blocks: []
  371. # A list of strings containing additional configuration blocks to add to Dimension's server configuration (matrix-dimension.conf).
  372. matrix_nginx_proxy_proxy_dimension_additional_server_configuration_blocks: []
  373. # A list of strings containing additional configuration blocks to add to Rageshake's server configuration (matrix-rageshake.conf).
  374. matrix_nginx_proxy_proxy_rageshake_additional_server_configuration_blocks: []
  375. # A list of strings containing additional configuration blocks to add to etherpad's server configuration (matrix-etherpad.conf).
  376. matrix_nginx_proxy_proxy_etherpad_additional_server_configuration_blocks: []
  377. # A list of strings containing additional configuration blocks to add to GoNEB's server configuration (matrix-bot-go-neb.conf).
  378. matrix_nginx_proxy_proxy_bot_go_neb_additional_server_configuration_blocks: []
  379. # A list of strings containing additional configuration blocks to add to Jitsi's server configuration (matrix-jitsi.conf).
  380. matrix_nginx_proxy_proxy_jitsi_additional_server_configuration_blocks: []
  381. # A list of strings containing additional configuration blocks to add to Grafana's server configuration (matrix-grafana.conf).
  382. matrix_nginx_proxy_proxy_grafana_additional_server_configuration_blocks: []
  383. # A list of strings containing additional configuration blocks to add to Sygnal's server configuration (matrix-sygnal.conf).
  384. matrix_nginx_proxy_proxy_sygnal_additional_server_configuration_blocks: []
  385. # A list of strings containing additional configuration blocks to add to mautrix wsproxy server configuration (matrix-mautrix-wsproxy.conf).
  386. matrix_nginx_proxy_proxy_mautrix_wsproxy_additional_server_configuration_blocks: []
  387. # A list of strings containing additional configuration blocks to add to ntfy's server configuration (matrix-ntfy.conf).
  388. matrix_nginx_proxy_proxy_ntfy_additional_server_configuration_blocks: []
  389. # A list of strings containing additional configuration blocks to add to the base domain server configuration (matrix-base-domain.conf).
  390. matrix_nginx_proxy_proxy_domain_additional_server_configuration_blocks: []
  391. # To increase request timeout in NGINX using proxy_read_timeout, proxy_connect_timeout, proxy_send_timeout, send_timeout directives
  392. # Nginx Default: proxy_connect_timeout 60s; #Defines a timeout for establishing a connection with a proxied server
  393. # Nginx Default: proxy_send_timeout 60s; #Sets a timeout for transmitting a request to the proxied server.
  394. # Nginx Default: proxy_read_timeout 60s; #Defines a timeout for reading a response from the proxied server.
  395. # Nginx Default: send_timeout 60s; #Sets a timeout for transmitting a response to the client.
  396. #
  397. # For more information visit:
  398. # http://nginx.org/en/docs/http/ngx_http_proxy_module.html
  399. # http://nginx.org/en/docs/http/ngx_http_core_module.html#send_timeout
  400. # https://www.nginx.com/resources/wiki/start/topics/examples/fullexample2/
  401. #
  402. # Here we are sticking with nginx default values change this value carefully.
  403. matrix_nginx_proxy_connect_timeout: 60
  404. matrix_nginx_proxy_send_timeout: 60
  405. matrix_nginx_proxy_read_timeout: 60
  406. matrix_nginx_send_timeout: 60
  407. # Controls whether to send a "Permissions-Policy interest-cohort=();" header along with all responses for all vhosts meant to be accessed by users.
  408. #
  409. # Learn more about what it is here:
  410. # - https://www.eff.org/deeplinks/2021/03/googles-floc-terrible-idea
  411. # - https://paramdeo.com/blog/opting-your-website-out-of-googles-floc-network
  412. # - https://amifloced.org/
  413. #
  414. # Of course, a better solution is to just stop using browsers (like Chrome), which participate in such tracking practices.
  415. matrix_nginx_proxy_floc_optout_enabled: true
  416. # HSTS Preloading Enable
  417. #
  418. # In its strongest and recommended form, the [HSTS policy](https://www.chromium.org/hsts) includes all subdomains, and
  419. # indicates a willingness to be “preloaded” into browsers:
  420. # `Strict-Transport-Security: max-age=31536000; includeSubDomains; preload`
  421. # For more information visit:
  422. # - https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security
  423. # - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security
  424. # - https://hstspreload.org/#opt-in
  425. matrix_nginx_proxy_hsts_preload_enabled: false
  426. # X-XSS-Protection Enable
  427. # Stops pages from loading when they detect reflected cross-site scripting (XSS) attacks.
  428. # Note: Not applicable for grafana
  429. #
  430. # Learn more about it is here:
  431. # - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection
  432. # - https://portswigger.net/web-security/cross-site-scripting/reflected
  433. matrix_nginx_proxy_xss_protection: "1; mode=block"
  434. # Specifies the SSL configuration that should be used for the SSL protocols and ciphers
  435. # This is based on the Mozilla Server Side TLS Recommended configurations.
  436. #
  437. # The posible values are:
  438. # - "modern" - For Modern clients that support TLS 1.3, with no need for backwards compatibility
  439. # - "intermediate" - Recommended configuration for a general-purpose server
  440. # - "old" - Services accessed by very old clients or libraries, such as Internet Explorer 8 (Windows XP), Java 6, or OpenSSL 0.9.8
  441. #
  442. # For more information visit:
  443. # - https://wiki.mozilla.org/Security/Server_Side_TLS#Recommended_configurations
  444. # - https://ssl-config.mozilla.org/#server=nginx
  445. matrix_nginx_proxy_ssl_preset: "intermediate"
  446. # Presets are taken from Mozilla's Server Side TLS Recommended configurations
  447. # DO NOT modify these values and use `matrix_nginx_proxy_ssl_protocols`, `matrix_nginx_proxy_ssl_ciphers` and `matrix_nginx_proxy_ssl_ciphers`
  448. # if you wish to use something more custom.
  449. matrix_nginx_proxy_ssl_presets:
  450. modern:
  451. protocols: TLSv1.3
  452. ciphers: ""
  453. prefer_server_ciphers: "off"
  454. intermediate:
  455. protocols: TLSv1.2 TLSv1.3
  456. ciphers: ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384
  457. prefer_server_ciphers: "off"
  458. old:
  459. protocols: TLSv1 TLSv1.1 TLSv1.2 TLSv1.3
  460. ciphers: ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:DHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES256-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:DES-CBC3-SHA
  461. prefer_server_ciphers: "on"
  462. # Specifies which *SSL protocols* to use when serving all the various vhosts.
  463. matrix_nginx_proxy_ssl_protocols: "{{ matrix_nginx_proxy_ssl_presets[matrix_nginx_proxy_ssl_preset]['protocols'] }}"
  464. # Specifies whether to prefer *the client’s choice or the server’s choice* when negotiating ciphers.
  465. matrix_nginx_proxy_ssl_prefer_server_ciphers: "{{ matrix_nginx_proxy_ssl_presets[matrix_nginx_proxy_ssl_preset]['prefer_server_ciphers'] }}"
  466. # Specifies which *SSL Cipher suites* to use when serving all the various vhosts.
  467. # To see the full list for suportes ciphers run `openssl ciphers` on your server
  468. matrix_nginx_proxy_ssl_ciphers: "{{ matrix_nginx_proxy_ssl_presets[matrix_nginx_proxy_ssl_preset]['ciphers'] }}"
  469. # Specifies what to use for the X-Forwarded-For variable.
  470. # If you're fronting the nginx reverse-proxy with additional reverse-proxy servers,
  471. # you may wish to set this to '$proxy_add_x_forwarded_for' instead.
  472. matrix_nginx_proxy_x_forwarded_for: '$remote_addr'
  473. # Controls whether the self-check feature should validate SSL certificates.
  474. matrix_nginx_proxy_self_check_validate_certificates: true
  475. # Controls whether redirects will be followed when checking the `/.well-known/matrix/client` resource.
  476. #
  477. # As per the spec (https://matrix.org/docs/spec/client_server/r0.6.0#well-known-uri), it shouldn't be,
  478. # so we default to not following redirects as well.
  479. matrix_nginx_proxy_self_check_well_known_matrix_client_follow_redirects: none
  480. # For OCSP purposes, we need to define a resolver at the `server{}` level or `http{}` level (we do the latter).
  481. #
  482. # Otherwise, we get warnings like this:
  483. # > [warn] 22#22: no resolver defined to resolve r3.o.lencr.org while requesting certificate status, responder: r3.o.lencr.org, certificate: "/matrix/ssl/config/live/.../fullchain.pem"
  484. #
  485. # We point it to the internal Docker resolver, which likely delegates to nameservers defined in `/etc/resolv.conf`.
  486. #
  487. # When nginx proxy is disabled, our configuration is likely used by non-containerized nginx, so can't use the internal Docker resolver.
  488. # Pointing `resolver` to some public DNS server might be an option, but for now we impose DNS servers on people.
  489. # It might also be that no such warnings occur when not running in a container.
  490. matrix_nginx_proxy_http_level_resolver: "{{ '127.0.0.11' if matrix_nginx_proxy_enabled else '' }}"
  491. # By default, this playbook automatically retrieves and auto-renews
  492. # free SSL certificates from Let's Encrypt.
  493. #
  494. # The following retrieval methods are supported:
  495. # - "lets-encrypt" - the playbook obtains free SSL certificates from Let's Encrypt
  496. # - "self-signed" - the playbook generates and self-signs certificates
  497. # - "manually-managed" - lets you manage certificates by yourself (manually; see below)
  498. # - "none" - like "manually-managed", but doesn't care if you don't drop certificates in the location it expects
  499. #
  500. # If you decide to manage certificates by yourself (`matrix_ssl_retrieval_method: manually-managed`),
  501. # you'd need to drop them into the directory specified by `matrix_ssl_config_dir_path`
  502. # obeying the following hierarchy:
  503. # - <matrix_ssl_config_dir_path>/live/<domain>/fullchain.pem
  504. # - <matrix_ssl_config_dir_path>/live/<domain>/privkey.pem
  505. # where <domain> refers to the domains that you need (usually `matrix_server_fqn_matrix` and `matrix_server_fqn_element`).
  506. #
  507. # The "none" type (`matrix_ssl_retrieval_method: none`), simply means that no certificate retrieval will happen.
  508. # It's useful for when you've disabled the nginx proxy (`matrix_nginx_proxy_enabled: false`)
  509. # and you'll be using another reverse-proxy server (like Apache) with your own certificates, managed by yourself.
  510. # It's also useful if you're using `matrix_nginx_proxy_https_enabled: false` to make this nginx proxy serve
  511. # plain HTTP traffic only (usually, on the loopback interface only) and you'd be terminating SSL using another reverse-proxy.
  512. matrix_ssl_retrieval_method: "lets-encrypt"
  513. matrix_ssl_architecture: "amd64"
  514. # The full list of domains that this role will obtain certificates for.
  515. # This variable is likely redefined outside of the role, to include the domains that are necessary (depending on the services that are enabled).
  516. # To add additional domain names, consider using `matrix_ssl_additional_domains_to_obtain_certificates_for` instead.
  517. matrix_ssl_domains_to_obtain_certificates_for: "{{ matrix_ssl_additional_domains_to_obtain_certificates_for }}"
  518. # A list of additional domain names to obtain certificates for.
  519. matrix_ssl_additional_domains_to_obtain_certificates_for: []
  520. # Controls whether to obtain production or staging certificates from Let's Encrypt.
  521. # If you'd like to use another ACME Certificate Authority server (not Let's Encrypt), use `matrix_ssl_lets_encrypt_server`
  522. matrix_ssl_lets_encrypt_staging: false
  523. # Controls from which Certificate Authority server to retrieve the SSL certificates (passed as a `--server` flag to Certbot).
  524. # By default, we use the Let's Encrypt production environment (use `matrix_ssl_lets_encrypt_staging` for using the staging environment).
  525. # Learn more here: https://eff-certbot.readthedocs.io/en/stable/using.html#changing-the-acme-server
  526. matrix_ssl_lets_encrypt_server: ''
  527. matrix_ssl_lets_encrypt_certbot_docker_image: "{{ matrix_container_global_registry_prefix }}certbot/certbot:{{ matrix_ssl_architecture }}-v2.0.0"
  528. matrix_ssl_lets_encrypt_certbot_docker_image_force_pull: "{{ matrix_ssl_lets_encrypt_certbot_docker_image.endswith(':latest') }}"
  529. matrix_ssl_lets_encrypt_certbot_standalone_http_port: 2402
  530. matrix_ssl_lets_encrypt_support_email: ~
  531. # Tells which interface and port the Let's Encrypt (certbot) container should try to bind to
  532. # when it tries to obtain initial certificates in standalone mode.
  533. #
  534. # This should normally be a public interface and port.
  535. # If you'd like to not bind on all IP addresses, specify one explicitly (e.g. `a.b.c.d:80`)
  536. matrix_ssl_lets_encrypt_container_standalone_http_host_bind_port: '80'
  537. # Specify key type of the private key algorithm.
  538. # Learn more here: https://eff-certbot.readthedocs.io/en/stable/using.html#rsa-and-ecdsa-keys
  539. matrix_ssl_lets_encrypt_key_type: ecdsa
  540. matrix_ssl_base_path: "{{ matrix_base_data_path }}/ssl"
  541. matrix_ssl_config_dir_path: "{{ matrix_ssl_base_path }}/config"
  542. matrix_ssl_log_dir_path: "{{ matrix_ssl_base_path }}/log"
  543. matrix_ssl_bin_dir_path: "{{ matrix_ssl_base_path }}/bin"
  544. # If you'd like to start some service before a certificate is obtained, specify it here.
  545. # This could be something like `matrix-dynamic-dns`, etc.
  546. matrix_ssl_pre_obtaining_required_service_name: ~
  547. matrix_ssl_pre_obtaining_required_service_start_wait_time_seconds: 60
  548. # matrix_ssl_orphaned_renewal_configs_purging_enabled controls whether the playbook will delete Let's Encryption renewal configuration files (`/matrix/ssl/config/renewal/*.conf)
  549. # for domains that are not part of the `matrix_ssl_domains_to_obtain_certificates_for` list.
  550. #
  551. # As the `matrix_ssl_domains_to_obtain_certificates_for` list changes over time, the playbook obtains certificates for various domains
  552. # and sets up "renewal" configuration files to keep these certificates fresh.
  553. # When a domain disappears from the `matrix_ssl_domains_to_obtain_certificates_for` list (because its associated service had gotten disabled),
  554. # the certificate files and renewal configuration still remain in the filesystem and certbot may try to renewal the certificate for this domain.
  555. # If there's no DNS record for this domain or it doesn't point to this server anymore, the `matrix-ssl-lets-encrypt-certificates-renew.service` systemd service
  556. # won't be able to renew the certificate and will generate an error.
  557. #
  558. # With `matrix_ssl_orphaned_renewal_configs_purging_enabled` enabled, orphaned renewal configurations will be purged on each playbook run.
  559. # Some other leftover files will still remain, but we don't bother purging them because they don't cause troubles.
  560. matrix_ssl_orphaned_renewal_configs_purging_enabled: true
  561. # Nginx Optimize SSL Session
  562. #
  563. # ssl_session_cache:
  564. # - Creating a cache of TLS connection parameters reduces the number of handshakes
  565. # and thus can improve the performance of application.
  566. # - Default session cache is not optimal as it can be used by only one worker process
  567. # and can cause memory fragmentation. It is much better to use shared cache.
  568. # - Learn More: https://nginx.org/en/docs/http/ngx_http_ssl_module.html
  569. #
  570. # ssl_session_timeout:
  571. # - Nginx by default it is set to 5 minutes which is very low.
  572. # should be like 4h or 1d but will require you to increase the size of cache.
  573. # - Learn More:
  574. # https://github.com/certbot/certbot/issues/6903
  575. # https://github.com/mozilla/server-side-tls/issues/198
  576. #
  577. # ssl_session_tickets:
  578. # - In case of session tickets, information about session is given to the client.
  579. # Enabling this improve performance also make Perfect Forward Secrecy useless.
  580. # - If you would instead like to use ssl_session_tickets by yourself, you can set
  581. # matrix_nginx_proxy_ssl_session_tickets_off false.
  582. # - Learn More: https://github.com/mozilla/server-side-tls/issues/135
  583. #
  584. # Presets are taken from Mozilla's Server Side TLS Recommended configurations
  585. matrix_nginx_proxy_ssl_session_cache: "shared:MozSSL:10m"
  586. matrix_nginx_proxy_ssl_session_timeout: "1d"
  587. matrix_nginx_proxy_ssl_session_tickets_off: true
  588. # OCSP Stapling eliminating the need for clients to contact the CA, with the aim of improving both security and performance.
  589. # OCSP stapling can provide a performance boost of up to 30%
  590. # nginx web server supports OCSP stapling since version 1.3.7.
  591. #
  592. # *warning* Nginx is lazy loading OCSP responses, which means that for the first few web requests it is unable to add the OCSP response.
  593. # set matrix_nginx_proxy_ocsp_stapling_enabled false to disable OCSP Stapling
  594. #
  595. # Learn more about what it is here:
  596. # - https://en.wikipedia.org/wiki/OCSP_stapling
  597. # - https://blog.cloudflare.com/high-reliability-ocsp-stapling/
  598. # - https://blog.mozilla.org/security/2013/07/29/ocsp-stapling-in-firefox/
  599. matrix_nginx_proxy_ocsp_stapling_enabled: true
  600. # nginx status page configurations.
  601. matrix_nginx_proxy_proxy_matrix_nginx_status_enabled: false
  602. matrix_nginx_proxy_proxy_matrix_nginx_status_allowed_addresses: ['{{ ansible_default_ipv4.address }}']
  603. # The amount of worker processes and connections
  604. # Consider increasing these when you are expecting high amounts of traffic
  605. # http://nginx.org/en/docs/ngx_core_module.html#worker_connections
  606. matrix_nginx_proxy_worker_processes: auto
  607. matrix_nginx_proxy_worker_connections: 1024