Matrix Docker Ansible eploy
Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.
 
 

522 rader
30 KiB

  1. matrix_nginx_proxy_enabled: true
  2. matrix_nginx_proxy_version: 1.21.4-alpine
  3. # We use an official nginx image, which we fix-up to run unprivileged.
  4. # An alternative would be an `nginxinc/nginx-unprivileged` image, but
  5. # that is frequently out of date.
  6. matrix_nginx_proxy_docker_image: "{{ matrix_container_global_registry_prefix }}nginx:{{ matrix_nginx_proxy_version }}"
  7. matrix_nginx_proxy_docker_image_force_pull: "{{ matrix_nginx_proxy_docker_image.endswith(':latest') }}"
  8. matrix_nginx_proxy_base_path: "{{ matrix_base_data_path }}/nginx-proxy"
  9. matrix_nginx_proxy_data_path: "{{ matrix_nginx_proxy_base_path }}/data"
  10. matrix_nginx_proxy_data_path_in_container: "/nginx-data"
  11. matrix_nginx_proxy_data_path_extension: "/matrix_domain"
  12. matrix_nginx_proxy_confd_path: "{{ matrix_nginx_proxy_base_path }}/conf.d"
  13. # List of systemd services that matrix-nginx-proxy.service depends on
  14. matrix_nginx_proxy_systemd_required_services_list: ['docker.service']
  15. # List of systemd services that matrix-nginx-proxy.service wants
  16. matrix_nginx_proxy_systemd_wanted_services_list: []
  17. # A list of additional "volumes" to mount in the container.
  18. # This list gets populated dynamically at runtime. You can provide a different default value,
  19. # if you wish to mount your own files into the container.
  20. # Contains definition objects like this: `{"src": "/outside", "dst": "/inside", "options": "rw|ro|slave|.."}
  21. matrix_nginx_proxy_container_additional_volumes: []
  22. # A list of extra arguments to pass to the container
  23. matrix_nginx_proxy_container_extra_arguments: []
  24. # Controls whether matrix-nginx-proxy serves its vhosts over HTTPS or HTTP.
  25. #
  26. # If enabled:
  27. # - SSL certificates would be expected to be available (see `matrix_ssl_retrieval_method`)
  28. # - the HTTP vhost would be made a redirect to the HTTPS vhost
  29. #
  30. # If not enabled:
  31. # - you don't need any SSL certificates (you can set `matrix_ssl_retrieval_method: none`)
  32. # - naturally, there's no HTTPS vhost
  33. # - services are served directly from the HTTP vhost
  34. matrix_nginx_proxy_https_enabled: true
  35. # Controls whether matrix-nginx-proxy trusts an upstream server's X-Forwarded-Proto header
  36. #
  37. # Required if you disable HTTPS for the container (see `matrix_nginx_proxy_https_enabled`) and have an upstream server handle it instead.
  38. matrix_nginx_proxy_trust_forwarded_proto: false
  39. matrix_nginx_proxy_x_forwarded_proto_value: "{{ '$http_x_forwarded_proto' if matrix_nginx_proxy_trust_forwarded_proto else '$scheme' }}"
  40. # Controls whether the matrix-nginx-proxy container exposes its HTTP port (tcp/8080 in the container).
  41. #
  42. # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:80"), or empty string to not expose.
  43. matrix_nginx_proxy_container_http_host_bind_port: '80'
  44. # Controls whether the matrix-nginx-proxy container exposes its HTTPS port (tcp/8443 in the container).
  45. #
  46. # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:443"), or empty string to not expose.
  47. #
  48. # This only makes sense and applies if `matrix_nginx_proxy_https_enabled` is set to `true`.
  49. # Otherwise, there are no HTTPS vhosts to expose.
  50. matrix_nginx_proxy_container_https_host_bind_port: '443'
  51. # Controls whether the matrix-nginx-proxy container exposes the Matrix Federation port (tcp/8448 in the container).
  52. #
  53. # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8448"), or empty string to not expose.
  54. #
  55. # This only makes sense and applies if `matrix_nginx_proxy_proxy_matrix_federation_api_enabled` is set to `true`.
  56. # Otherwise, there is no Matrix Federation port to expose.
  57. #
  58. # This port can take HTTP or HTTPS traffic, depending on `matrix_nginx_proxy_https_enabled`.
  59. # When HTTPS is disabled, you'd likely want to only expose the port locally, and front it with another HTTPS-enabled reverse-proxy.
  60. matrix_nginx_proxy_container_federation_host_bind_port: '8448'
  61. # Controls whether matrix-nginx-proxy should serve the base domain.
  62. #
  63. # This is useful for when you only have your Matrix server, but you need to serve
  64. # to serve `/.well-known/matrix/*` files from the base domain for the needs of
  65. # Server-Discovery (Federation) and for Client-Discovery.
  66. #
  67. # Besides serving these Matrix files, a homepage would be served with content
  68. # as specified in the `matrix_nginx_proxy_base_domain_homepage_template` variable.
  69. # You can also put additional files to use for this webpage
  70. # in the `{{ matrix_nginx_proxy_data_path }}/matrix-domain` (`/matrix/nginx-proxy/data/matrix-domain`) directory.
  71. matrix_nginx_proxy_base_domain_serving_enabled: false
  72. # Controls whether the base domain directory and default index.html file are created.
  73. matrix_nginx_proxy_base_domain_create_directory: true
  74. matrix_nginx_proxy_base_domain_hostname: "{{ matrix_domain }}"
  75. # Controls whether `matrix_nginx_proxy_base_domain_homepage_template` would be dumped to an `index.html` file
  76. # in the `/matrix/nginx-proxy/data/matrix-domain` directory.
  77. #
  78. # If you would instead like to serve a static website by yourself, you can disable this.
  79. # When disabled, you're expected to put website files in `/matrix/nginx-proxy/data/matrix-domain` manually
  80. # and can expect that the playbook won't intefere with the `index.html` file.
  81. matrix_nginx_proxy_base_domain_homepage_enabled: true
  82. matrix_nginx_proxy_base_domain_homepage_template: |-
  83. <!doctype html>
  84. <meta charset="utf-8" />
  85. <html>
  86. <body>
  87. Hello from {{ matrix_domain }}!
  88. </body>
  89. </html>
  90. # Option to disable the access log
  91. matrix_nginx_proxy_access_log_enabled: true
  92. # Controls whether proxying the riot domain should be done.
  93. matrix_nginx_proxy_proxy_riot_compat_redirect_enabled: false
  94. matrix_nginx_proxy_proxy_riot_compat_redirect_hostname: "riot.{{ matrix_domain }}"
  95. # Controls whether proxying the Synapse domain should be done.
  96. matrix_nginx_proxy_proxy_synapse_enabled: false
  97. matrix_nginx_proxy_proxy_synapse_hostname: "matrix-nginx-proxy"
  98. matrix_nginx_proxy_proxy_synapse_federation_api_enabled: "{{ matrix_nginx_proxy_proxy_matrix_federation_api_enabled }}"
  99. # The addresses where the Federation API is, when using Synapse.
  100. matrix_nginx_proxy_proxy_synapse_federation_api_addr_with_container: ""
  101. matrix_nginx_proxy_proxy_synapse_federation_api_addr_sans_container: ""
  102. # Controls whether proxying the Element domain should be done.
  103. matrix_nginx_proxy_proxy_element_enabled: false
  104. matrix_nginx_proxy_proxy_element_hostname: "{{ matrix_server_fqn_element }}"
  105. # Controls whether proxying the Hydrogen domain should be done.
  106. matrix_nginx_proxy_proxy_hydrogen_enabled: false
  107. matrix_nginx_proxy_proxy_hydrogen_hostname: "{{ matrix_server_fqn_hydrogen }}"
  108. # Controls whether proxying the matrix domain should be done.
  109. matrix_nginx_proxy_proxy_matrix_enabled: false
  110. matrix_nginx_proxy_proxy_matrix_hostname: "{{ matrix_server_fqn_matrix }}"
  111. matrix_nginx_proxy_proxy_matrix_federation_hostname: "{{ matrix_nginx_proxy_proxy_matrix_hostname }}"
  112. # The port name used for federation in the nginx configuration.
  113. # This is not necessarily the port that it's actually on,
  114. # as port-mapping happens (`-p ..`) for the `matrix-nginx-proxy` container.
  115. matrix_nginx_proxy_proxy_matrix_federation_port: 8448
  116. # Controls whether proxying the dimension domain should be done.
  117. matrix_nginx_proxy_proxy_dimension_enabled: false
  118. matrix_nginx_proxy_proxy_dimension_hostname: "{{ matrix_server_fqn_dimension }}"
  119. # Controls whether proxying the goneb domain should be done.
  120. matrix_nginx_proxy_proxy_bot_go_neb_enabled: false
  121. matrix_nginx_proxy_proxy_bot_go_neb_hostname: "{{ matrix_server_fqn_bot_go_neb }}"
  122. # Controls whether proxying the jitsi domain should be done.
  123. matrix_nginx_proxy_proxy_jitsi_enabled: false
  124. matrix_nginx_proxy_proxy_jitsi_hostname: "{{ matrix_server_fqn_jitsi }}"
  125. # Controls whether proxying the grafana domain should be done.
  126. matrix_nginx_proxy_proxy_grafana_enabled: false
  127. matrix_nginx_proxy_proxy_grafana_hostname: "{{ matrix_server_fqn_grafana }}"
  128. # Controls whether proxying the sygnal domain should be done.
  129. matrix_nginx_proxy_proxy_sygnal_enabled: false
  130. matrix_nginx_proxy_proxy_sygnal_hostname: "{{ matrix_server_fqn_sygnal }}"
  131. # Controls whether proxying for the matrix-corporal API (`/_matrix/corporal`) should be done (on the matrix domain)
  132. matrix_nginx_proxy_proxy_matrix_corporal_api_enabled: false
  133. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_with_container: "matrix-corporal:41081"
  134. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_sans_container: "127.0.0.1:41081"
  135. # Controls whether proxying for the User Directory Search API (`/_matrix/client/r0/user_directory/search`) should be done (on the matrix domain).
  136. # This can be used to forward the API endpoint to another service, augmenting the functionality of Synapse's own User Directory Search.
  137. # To learn more, see: https://github.com/ma1uta/ma1sd/blob/master/docs/features/directory.md
  138. matrix_nginx_proxy_proxy_matrix_user_directory_search_enabled: false
  139. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_with_container: "matrix-ma1sd:{{ matrix_ma1sd_container_port }}"
  140. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_sans_container: "127.0.0.1:{{ matrix_ma1sd_container_port }}"
  141. # Controls whether proxying for 3PID-based registration (`/_matrix/client/r0/register/(email|msisdn)/requestToken`) should be done (on the matrix domain).
  142. # This allows another service to control registrations involving 3PIDs.
  143. # To learn more, see: https://github.com/ma1uta/ma1sd/blob/master/docs/features/registration.md
  144. matrix_nginx_proxy_proxy_matrix_3pid_registration_enabled: false
  145. matrix_nginx_proxy_proxy_matrix_3pid_registration_addr_with_container: "matrix-ma1sd:{{ matrix_ma1sd_container_port }}"
  146. matrix_nginx_proxy_proxy_matrix_3pid_registration_addr_sans_container: "127.0.0.1:{{ matrix_ma1sd_container_port }}"
  147. # Controls whether proxying for the Identity API (`/_matrix/identity`) should be done (on the matrix domain)
  148. matrix_nginx_proxy_proxy_matrix_identity_api_enabled: false
  149. matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container: "matrix-ma1sd:{{ matrix_ma1sd_container_port }}"
  150. matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container: "127.0.0.1:{{ matrix_ma1sd_container_port }}"
  151. # Controls whether proxying for metrics (`/_synapse/metrics`) should be done (on the matrix domain)
  152. matrix_nginx_proxy_proxy_synapse_metrics: false
  153. matrix_nginx_proxy_synapse_workers_enabled_list: []
  154. matrix_nginx_proxy_proxy_synapse_metrics_basic_auth_enabled: false
  155. # The following value will be written verbatim to the htpasswd file that stores the password for nginx to check against and needs to be encoded appropriately.
  156. # Read the manpage at `man 1 htpasswd` to learn more, then encrypt your password, and paste the encrypted value here.
  157. # e.g. `htpasswd -c mypass.htpasswd prometheus` and enter `mysecurepw` when prompted yields `prometheus:$apr1$wZhqsn.U$7LC3kMmjUbjNAZjyMyvYv/`
  158. # The part after `prometheus:` is needed here. matrix_nginx_proxy_proxy_synapse_metrics_basic_auth_key: "$apr1$wZhqsn.U$7LC3kMmjUbjNAZjyMyvYv/"
  159. matrix_nginx_proxy_proxy_synapse_metrics_basic_auth_key: ""
  160. # The addresses where the Matrix Client API is.
  161. # Certain extensions (like matrix-corporal) may override this in order to capture all traffic.
  162. matrix_nginx_proxy_proxy_matrix_client_api_addr_with_container: "matrix-nginx-proxy:12080"
  163. matrix_nginx_proxy_proxy_matrix_client_api_addr_sans_container: "127.0.0.1:12080"
  164. # The addresses where the Matrix Client API is, when using Synapse.
  165. matrix_nginx_proxy_proxy_synapse_client_api_addr_with_container: "matrix-synapse:8008"
  166. matrix_nginx_proxy_proxy_synapse_client_api_addr_sans_container: "127.0.0.1:8008"
  167. # This needs to be equal or higher than the maximum upload size accepted by Synapse.
  168. matrix_nginx_proxy_proxy_matrix_client_api_client_max_body_size_mb: 50
  169. # Tells whether `/_synapse/client` is forwarded to the Matrix Client API server.
  170. matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_synapse_client_api_enabled: true
  171. # Tells whether `/_synapse/oidc` is forwarded to the Matrix Client API server.
  172. # Enable this if you need OpenID Connect authentication support.
  173. matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_synapse_oidc_api_enabled: false
  174. # Tells whether `/_synapse/admin` is forwarded to the Matrix Client API server.
  175. # Following these recommendations (https://github.com/matrix-org/synapse/blob/master/docs/reverse_proxy.md), by default, we don't.
  176. matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_synapse_admin_api_enabled: false
  177. # `matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_prefixes` holds
  178. # the location prefixes that get forwarded to the Matrix Client API server.
  179. # These locations get combined into a regex like this `^(/_matrix|/_synapse/client)`.
  180. matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_prefix_regexes: |
  181. {{
  182. (['/_matrix'])
  183. +
  184. (['/_synapse/client'] if matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_synapse_client_api_enabled else [])
  185. +
  186. (['/_synapse/oidc'] if matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_synapse_oidc_api_enabled else [])
  187. +
  188. (['/_synapse/admin'] if matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_synapse_admin_api_enabled else [])
  189. +
  190. (['/_synapse.*/metrics'] if matrix_nginx_proxy_proxy_synapse_metrics else [])
  191. }}
  192. # Specifies where requests for the root URI (`/`) on the `matrix.` domain should be redirected.
  193. # If this has an empty value, they're just passed to the homeserver, which serves a static page.
  194. # If you'd like to make `https://matrix.DOMAIN` redirect to `https://element.DOMAIN` (or something of that sort), specify the domain name here.
  195. # Example value: `element.DOMAIN` (or `{{ matrix_server_fqn_element }}`).
  196. matrix_nginx_proxy_proxy_matrix_client_redirect_root_uri_to_domain: ""
  197. # Controls whether proxying for the Matrix Federation API should be done.
  198. matrix_nginx_proxy_proxy_matrix_federation_api_enabled: false
  199. matrix_nginx_proxy_proxy_matrix_federation_api_addr_with_container: "matrix-nginx-proxy:12088"
  200. matrix_nginx_proxy_proxy_matrix_federation_api_addr_sans_container: "localhost:12088"
  201. 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 }}"
  202. matrix_nginx_proxy_proxy_matrix_federation_api_ssl_certificate: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_nginx_proxy_proxy_matrix_hostname }}/fullchain.pem"
  203. matrix_nginx_proxy_proxy_matrix_federation_api_ssl_certificate_key: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_nginx_proxy_proxy_matrix_hostname }}/privkey.pem"
  204. matrix_nginx_proxy_proxy_matrix_federation_api_ssl_trusted_certificate: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_nginx_proxy_proxy_matrix_hostname }}/chain.pem"
  205. # The tmpfs at /tmp needs to be large enough to handle multiple concurrent file uploads.
  206. matrix_nginx_proxy_tmp_directory_size_mb: "{{ (matrix_nginx_proxy_proxy_matrix_federation_api_client_max_body_size_mb | int) * 50 }}"
  207. # A list of strings containing additional configuration blocks to add to the nginx server configuration (nginx.conf).
  208. # for big matrixservers to enlarge the number of open files to prevent timeouts
  209. # matrix_nginx_proxy_proxy_additional_configuration_blocks:
  210. # - 'worker_rlimit_nofile 30000;'
  211. matrix_nginx_proxy_proxy_additional_configuration_blocks: []
  212. # A list of strings containing additional configuration blocks to add to the nginx event server configuration (nginx.conf).
  213. matrix_nginx_proxy_proxy_event_additional_configuration_blocks: []
  214. # A list of strings containing additional configuration blocks to add to the nginx http's server configuration (nginx-http.conf).
  215. matrix_nginx_proxy_proxy_http_additional_server_configuration_blocks: []
  216. # A list of strings containing additional configuration blocks to add to the base matrix server configuration (matrix-domain.conf).
  217. matrix_nginx_proxy_proxy_matrix_additional_server_configuration_blocks: []
  218. # A list of strings containing additional configuration blocks to add to the synapse's server configuration (matrix-synapse.conf).
  219. matrix_nginx_proxy_proxy_synapse_additional_server_configuration_blocks: []
  220. # A list of strings containing additional configuration blocks to add to Riot's server configuration (matrix-riot-web.conf).
  221. matrix_nginx_proxy_proxy_riot_additional_server_configuration_blocks: []
  222. # A list of strings containing additional configuration blocks to add to Element's server configuration (matrix-client-element.conf).
  223. matrix_nginx_proxy_proxy_element_additional_server_configuration_blocks: []
  224. # A list of strings containing additional configuration blocks to add to Element's server configuration (matrix-client-element.conf).
  225. matrix_nginx_proxy_proxy_hydrogen_additional_server_configuration_blocks: []
  226. # A list of strings containing additional configuration blocks to add to Dimension's server configuration (matrix-dimension.conf).
  227. matrix_nginx_proxy_proxy_dimension_additional_server_configuration_blocks: []
  228. # A list of strings containing additional configuration blocks to add to GoNEB's server configuration (matrix-bot-go-neb.conf).
  229. matrix_nginx_proxy_proxy_bot_go_neb_additional_server_configuration_blocks: []
  230. # A list of strings containing additional configuration blocks to add to Jitsi's server configuration (matrix-jitsi.conf).
  231. matrix_nginx_proxy_proxy_jitsi_additional_server_configuration_blocks: []
  232. # A list of strings containing additional configuration blocks to add to Grafana's server configuration (matrix-grafana.conf).
  233. matrix_nginx_proxy_proxy_grafana_additional_server_configuration_blocks: []
  234. # A list of strings containing additional configuration blocks to add to Sygnal's server configuration (matrix-sygnal.conf).
  235. matrix_nginx_proxy_proxy_sygnal_additional_server_configuration_blocks: []
  236. # A list of strings containing additional configuration blocks to add to the base domain server configuration (matrix-base-domain.conf).
  237. matrix_nginx_proxy_proxy_domain_additional_server_configuration_blocks: []
  238. # To increase request timeout in NGINX using proxy_read_timeout, proxy_connect_timeout, proxy_send_timeout, send_timeout directives
  239. # Nginx Default: proxy_connect_timeout 60s; #Defines a timeout for establishing a connection with a proxied server
  240. # Nginx Default: proxy_send_timeout 60s; #Sets a timeout for transmitting a request to the proxied server.
  241. # Nginx Default: proxy_read_timeout 60s; #Defines a timeout for reading a response from the proxied server.
  242. # Nginx Default: send_timeout 60s; #Sets a timeout for transmitting a response to the client.
  243. #
  244. # For more information visit:
  245. # http://nginx.org/en/docs/http/ngx_http_proxy_module.html
  246. # http://nginx.org/en/docs/http/ngx_http_core_module.html#send_timeout
  247. # https://www.nginx.com/resources/wiki/start/topics/examples/fullexample2/
  248. #
  249. # Here we are sticking with nginx default values change this value carefully.
  250. matrix_nginx_proxy_connect_timeout: 60
  251. matrix_nginx_proxy_send_timeout: 60
  252. matrix_nginx_proxy_read_timeout: 60
  253. matrix_nginx_send_timeout: 60
  254. # Controls whether to send a "Permissions-Policy interest-cohort=();" header along with all responses for all vhosts meant to be accessed by users.
  255. #
  256. # Learn more about what it is here:
  257. # - https://www.eff.org/deeplinks/2021/03/googles-floc-terrible-idea
  258. # - https://paramdeo.com/blog/opting-your-website-out-of-googles-floc-network
  259. # - https://amifloced.org/
  260. #
  261. # Of course, a better solution is to just stop using browsers (like Chrome), which participate in such tracking practices.
  262. matrix_nginx_proxy_floc_optout_enabled: true
  263. # HSTS Preloading Enable
  264. #
  265. # In its strongest and recommended form, the [HSTS policy](https://www.chromium.org/hsts) includes all subdomains, and
  266. # indicates a willingness to be “preloaded” into browsers:
  267. # `Strict-Transport-Security: max-age=31536000; includeSubDomains; preload`
  268. # For more information visit:
  269. # - https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security
  270. # - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security
  271. # - https://hstspreload.org/#opt-in
  272. matrix_nginx_proxy_hsts_preload_enabled: false
  273. # X-XSS-Protection Enable
  274. # Stops pages from loading when they detect reflected cross-site scripting (XSS) attacks.
  275. # Note: Not applicable for grafana
  276. #
  277. # Learn more about it is here:
  278. # - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection
  279. # - https://portswigger.net/web-security/cross-site-scripting/reflected
  280. matrix_nginx_proxy_xss_protection: "1; mode=block"
  281. # Specifies the SSL configuration that should be used for the SSL protocols and ciphers
  282. # This is based on the Mozilla Server Side TLS Recommended configurations.
  283. #
  284. # The posible values are:
  285. # - "modern" - For Modern clients that support TLS 1.3, with no need for backwards compatibility
  286. # - "intermediate" - Recommended configuration for a general-purpose server
  287. # - "old" - Services accessed by very old clients or libraries, such as Internet Explorer 8 (Windows XP), Java 6, or OpenSSL 0.9.8
  288. #
  289. # For more information visit:
  290. # - https://wiki.mozilla.org/Security/Server_Side_TLS#Recommended_configurations
  291. # - https://ssl-config.mozilla.org/#server=nginx
  292. matrix_nginx_proxy_ssl_preset: "intermediate"
  293. # Presets are taken from Mozilla's Server Side TLS Recommended configurations
  294. # DO NOT modify these values and use `matrix_nginx_proxy_ssl_protocols`, `matrix_nginx_proxy_ssl_ciphers` and `matrix_nginx_proxy_ssl_ciphers`
  295. # if you wish to use something more custom.
  296. matrix_nginx_proxy_ssl_presets:
  297. modern:
  298. protocols: TLSv1.3
  299. ciphers: ""
  300. prefer_server_ciphers: "off"
  301. intermediate:
  302. protocols: TLSv1.2 TLSv1.3
  303. 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
  304. prefer_server_ciphers: "off"
  305. old:
  306. protocols: TLSv1 TLSv1.1 TLSv1.2 TLSv1.3
  307. 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
  308. prefer_server_ciphers: "on"
  309. # Specifies which *SSL protocols* to use when serving all the various vhosts.
  310. matrix_nginx_proxy_ssl_protocols: "{{ matrix_nginx_proxy_ssl_presets[matrix_nginx_proxy_ssl_preset]['protocols'] }}"
  311. # Specifies whether to prefer *the client’s choice or the server’s choice* when negotiating ciphers.
  312. matrix_nginx_proxy_ssl_prefer_server_ciphers: "{{ matrix_nginx_proxy_ssl_presets[matrix_nginx_proxy_ssl_preset]['prefer_server_ciphers'] }}"
  313. # Specifies which *SSL Cipher suites* to use when serving all the various vhosts.
  314. # To see the full list for suportes ciphers run `openssl ciphers` on your server
  315. matrix_nginx_proxy_ssl_ciphers: "{{ matrix_nginx_proxy_ssl_presets[matrix_nginx_proxy_ssl_preset]['ciphers'] }}"
  316. # Controls whether the self-check feature should validate SSL certificates.
  317. matrix_nginx_proxy_self_check_validate_certificates: true
  318. # Controls whether redirects will be followed when checking the `/.well-known/matrix/client` resource.
  319. #
  320. # As per the spec (https://matrix.org/docs/spec/client_server/r0.6.0#well-known-uri), it shouldn't be,
  321. # so we default to not following redirects as well.
  322. matrix_nginx_proxy_self_check_well_known_matrix_client_follow_redirects: none
  323. # For OCSP purposes, we need to define a resolver at the `server{}` level or `http{}` level (we do the latter).
  324. #
  325. # Otherwise, we get warnings like this:
  326. # > [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"
  327. #
  328. # We point it to the internal Docker resolver, which likely delegates to nameservers defined in `/etc/resolv.conf`.
  329. #
  330. # When nginx proxy is disabled, our configuration is likely used by non-containerized nginx, so can't use the internal Docker resolver.
  331. # Pointing `resolver` to some public DNS server might be an option, but for now we impose DNS servers on people.
  332. # It might also be that no such warnings occur when not running in a container.
  333. matrix_nginx_proxy_http_level_resolver: "{{ '127.0.0.11' if matrix_nginx_proxy_enabled else '' }}"
  334. # By default, this playbook automatically retrieves and auto-renews
  335. # free SSL certificates from Let's Encrypt.
  336. #
  337. # The following retrieval methods are supported:
  338. # - "lets-encrypt" - the playbook obtains free SSL certificates from Let's Encrypt
  339. # - "self-signed" - the playbook generates and self-signs certificates
  340. # - "manually-managed" - lets you manage certificates by yourself (manually; see below)
  341. # - "none" - like "manually-managed", but doesn't care if you don't drop certificates in the location it expects
  342. #
  343. # If you decide to manage certificates by yourself (`matrix_ssl_retrieval_method: manually-managed`),
  344. # you'd need to drop them into the directory specified by `matrix_ssl_config_dir_path`
  345. # obeying the following hierarchy:
  346. # - <matrix_ssl_config_dir_path>/live/<domain>/fullchain.pem
  347. # - <matrix_ssl_config_dir_path>/live/<domain>/privkey.pem
  348. # where <domain> refers to the domains that you need (usually `matrix_server_fqn_matrix` and `matrix_server_fqn_element`).
  349. #
  350. # The "none" type (`matrix_ssl_retrieval_method: none`), simply means that no certificate retrieval will happen.
  351. # It's useful for when you've disabled the nginx proxy (`matrix_nginx_proxy_enabled: false`)
  352. # and you'll be using another reverse-proxy server (like Apache) with your own certificates, managed by yourself.
  353. # It's also useful if you're using `matrix_nginx_proxy_https_enabled: false` to make this nginx proxy serve
  354. # plain HTTP traffic only (usually, on the loopback interface only) and you'd be terminating SSL using another reverse-proxy.
  355. matrix_ssl_retrieval_method: "lets-encrypt"
  356. matrix_ssl_architecture: "amd64"
  357. # The full list of domains that this role will obtain certificates for.
  358. # This variable is likely redefined outside of the role, to include the domains that are necessary (depending on the services that are enabled).
  359. # To add additional domain names, consider using `matrix_ssl_additional_domains_to_obtain_certificates_for` instead.
  360. matrix_ssl_domains_to_obtain_certificates_for: "{{ matrix_ssl_additional_domains_to_obtain_certificates_for }}"
  361. # A list of additional domain names to obtain certificates for.
  362. matrix_ssl_additional_domains_to_obtain_certificates_for: []
  363. # Controls whether to obtain production or staging certificates from Let's Encrypt.
  364. matrix_ssl_lets_encrypt_staging: false
  365. matrix_ssl_lets_encrypt_certbot_docker_image: "{{ matrix_container_global_registry_prefix }}certbot/certbot:{{ matrix_ssl_architecture }}-v1.21.0"
  366. matrix_ssl_lets_encrypt_certbot_docker_image_force_pull: "{{ matrix_ssl_lets_encrypt_certbot_docker_image.endswith(':latest') }}"
  367. matrix_ssl_lets_encrypt_certbot_standalone_http_port: 2402
  368. matrix_ssl_lets_encrypt_support_email: ~
  369. # Tells which interface and port the Let's Encrypt (certbot) container should try to bind to
  370. # when it tries to obtain initial certificates in standalone mode.
  371. #
  372. # This should normally be a public interface and port.
  373. # If you'd like to not bind on all IP addresses, specify one explicitly (e.g. `a.b.c.d:80`)
  374. matrix_ssl_lets_encrypt_container_standalone_http_host_bind_port: '80'
  375. matrix_ssl_base_path: "{{ matrix_base_data_path }}/ssl"
  376. matrix_ssl_config_dir_path: "{{ matrix_ssl_base_path }}/config"
  377. matrix_ssl_log_dir_path: "{{ matrix_ssl_base_path }}/log"
  378. # If you'd like to start some service before a certificate is obtained, specify it here.
  379. # This could be something like `matrix-dynamic-dns`, etc.
  380. matrix_ssl_pre_obtaining_required_service_name: ~
  381. matrix_ssl_pre_obtaining_required_service_start_wait_time_seconds: 60
  382. # Nginx Optimize SSL Session
  383. #
  384. # ssl_session_cache:
  385. # - Creating a cache of TLS connection parameters reduces the number of handshakes
  386. # and thus can improve the performance of application.
  387. # - Default session cache is not optimal as it can be used by only one worker process
  388. # and can cause memory fragmentation. It is much better to use shared cache.
  389. # - Learn More: https://nginx.org/en/docs/http/ngx_http_ssl_module.html
  390. #
  391. # ssl_session_timeout:
  392. # - Nginx by default it is set to 5 minutes which is very low.
  393. # should be like 4h or 1d but will require you to increase the size of cache.
  394. # - Learn More:
  395. # https://github.com/certbot/certbot/issues/6903
  396. # https://github.com/mozilla/server-side-tls/issues/198
  397. #
  398. # ssl_session_tickets:
  399. # - In case of session tickets, information about session is given to the client.
  400. # Enabling this improve performance also make Perfect Forward Secrecy useless.
  401. # - If you would instead like to use ssl_session_tickets by yourself, you can set
  402. # matrix_nginx_proxy_ssl_session_tickets_off false.
  403. # - Learn More: https://github.com/mozilla/server-side-tls/issues/135
  404. #
  405. # Presets are taken from Mozilla's Server Side TLS Recommended configurations
  406. matrix_nginx_proxy_ssl_session_cache: "shared:MozSSL:10m"
  407. matrix_nginx_proxy_ssl_session_timeout: "1d"
  408. matrix_nginx_proxy_ssl_session_tickets_off: true
  409. # OCSP Stapling eliminating the need for clients to contact the CA, with the aim of improving both security and performance.
  410. # OCSP stapling can provide a performance boost of up to 30%
  411. # nginx web server supports OCSP stapling since version 1.3.7.
  412. #
  413. # *warning* Nginx is lazy loading OCSP responses, which means that for the first few web requests it is unable to add the OCSP response.
  414. # set matrix_nginx_proxy_ocsp_stapling_enabled false to disable OCSP Stapling
  415. #
  416. # Learn more about what it is here:
  417. # - https://en.wikipedia.org/wiki/OCSP_stapling
  418. # - https://blog.cloudflare.com/high-reliability-ocsp-stapling/
  419. # - https://blog.mozilla.org/security/2013/07/29/ocsp-stapling-in-firefox/
  420. matrix_nginx_proxy_ocsp_stapling_enabled: true
  421. # nginx status page configurations.
  422. matrix_nginx_proxy_proxy_matrix_nginx_status_enabled: false
  423. matrix_nginx_proxy_proxy_matrix_nginx_status_allowed_addresses: ['{{ ansible_default_ipv4.address }}']
  424. # synapse worker activation and endpoint mappings
  425. matrix_nginx_proxy_synapse_workers_enabled: false
  426. matrix_nginx_proxy_synapse_workers_list: []
  427. matrix_nginx_proxy_synapse_generic_worker_client_server_locations: []
  428. matrix_nginx_proxy_synapse_generic_worker_federation_locations: []
  429. matrix_nginx_proxy_synapse_media_repository_locations: []
  430. matrix_nginx_proxy_synapse_user_dir_locations: []
  431. matrix_nginx_proxy_synapse_frontend_proxy_locations: []
  432. # The amount of worker processes and connections
  433. # Consider increasing these when you are expecting high amounts of traffic
  434. # http://nginx.org/en/docs/ngx_core_module.html#worker_connections
  435. matrix_nginx_proxy_worker_processes: 1
  436. matrix_nginx_proxy_worker_connections: 1024