overmind
/
matrix-docker-ansible-deploy
şunun yansıması https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Çatalla 0
Kod Konular 0 Sürümler 0 Wiki Aktivite
Matrix Docker Ansible eploy
25'ten fazla konu seçemezsiniz Konular bir harf veya rakamla başlamalı, kısa çizgiler ('-') içerebilir ve en fazla 35 karakter uzunluğunda olabilir.
7274 İşleme
13 Dallar
36 MiB
 
 
Ağaç: 042c74f90c
Dallar Biçim İmleri
${ item.name }
${ searchTerm } dalı oluştur
'042c74f90c'den
${ noResults }
matrix-docker-ansible-deploy/roles/custom/matrix-synapse-reverse-prox.../defaults/main.yml

224 satır
19 KiB
Ham Suçlama Geçmiş 

  1. ---

  2. 

  3. # matrix-synapse-reverse-proxy-companion is a role which brings up a containerized nginx webserver which helps with reverse-proxying to Synapse when workers are enabled.

  4. #

  5. # When Synapse is NOT running in worker-mode, reverse-proxying is relatively simple (everything goes to `matrix-synapse:XXXX`).

  6. # In such cases, using this reverse-proxy companion is possible, but unnecessary - it's one more service in the stack, which also impacts performance a bit.

  7. #

  8. # When Synapse workers are enabled, however, the reverse-proxying configuration is much more complicated - certain requests need to go to certain workers, etc.

  9. # matrix-synapse-reverse-proxy-companion is the central place services that need to reach Synapse could be pointed to.

  10. 

  11. matrix_synapse_reverse_proxy_companion_enabled: true

  12. 

  13. # renovate: datasource=docker depName=nginx

  14. matrix_synapse_reverse_proxy_companion_version: 1.25.3-alpine

  15. 

  16. matrix_synapse_reverse_proxy_companion_base_path: "{{ matrix_synapse_base_path }}/reverse-proxy-companion"

  17. matrix_synapse_reverse_proxy_companion_confd_path: "{{ matrix_synapse_reverse_proxy_companion_base_path }}/conf.d"

  18. 

  19. # List of systemd services that matrix-synapse-reverse-proxy-companion.service depends on

  20. matrix_synapse_reverse_proxy_companion_systemd_required_services_list: "{{ matrix_synapse_reverse_proxy_companion_systemd_required_services_list_default + matrix_synapse_reverse_proxy_companion_systemd_required_services_list_auto + matrix_synapse_reverse_proxy_companion_systemd_required_services_list_custom }}"

  21. matrix_synapse_reverse_proxy_companion_systemd_required_services_list_default: ['docker.service']

  22. matrix_synapse_reverse_proxy_companion_systemd_required_services_list_auto: []

  23. matrix_synapse_reverse_proxy_companion_systemd_required_services_list_custom: []

  24. 

  25. # List of systemd services that matrix-synapse-reverse-proxy-companion.service wants

  26. matrix_synapse_reverse_proxy_companion_systemd_wanted_services_list: ['matrix-synapse.service']

  27. 

  28. # We use an official nginx image, which we fix-up to run unprivileged.

  29. # An alternative would be an `nginxinc/nginx-unprivileged` image, but

  30. # that is frequently out of date.

  31. matrix_synapse_reverse_proxy_companion_container_image: "{{ matrix_container_global_registry_prefix }}nginx:{{ matrix_synapse_reverse_proxy_companion_version }}"

  32. matrix_synapse_reverse_proxy_companion_container_image_force_pull: "{{ matrix_synapse_reverse_proxy_companion_container_image.endswith(':latest') }}"

  33. 

  34. matrix_synapse_reverse_proxy_companion_container_network: ""

  35. 

  36. # A list of additional container networks that matrix-synapse-reverse-proxy-companion would be connected to.

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

  38. matrix_synapse_reverse_proxy_companion_container_additional_networks: []

  39. 

  40. # Controls whether the matrix-synapse-reverse-proxy-companion container exposes its HTTP Client-Server API port (tcp/8008 in the container).

  41. #

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

  43. matrix_synapse_reverse_proxy_companion_container_client_api_host_bind_port: ''

  44. 

  45. # Controls whether the matrix-synapse-reverse-proxy-companion container exposes its HTTP Federation (Server-Server) API port (tcp/8048 in the container).

  46. #

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

  48. matrix_synapse_reverse_proxy_companion_container_federation_api_host_bind_port: ''

  49. 

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

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

  52. #

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

  54. matrix_synapse_reverse_proxy_companion_container_labels_traefik_enabled: true

  55. matrix_synapse_reverse_proxy_companion_container_labels_traefik_docker_network: "{{ matrix_synapse_reverse_proxy_companion_container_network }}"

  56. matrix_synapse_reverse_proxy_companion_container_labels_traefik_entrypoints: web-secure

  57. matrix_synapse_reverse_proxy_companion_container_labels_traefik_tls_certResolver: default  # noqa var-naming

  58. matrix_synapse_reverse_proxy_companion_container_labels_traefik_hostname: ''

  59. 

  60. # Controls whether labels will be added that expose the Client-Server API on a public Traefik entrypoint.

  61. matrix_synapse_reverse_proxy_companion_container_labels_public_client_api_enabled: true

  62. matrix_synapse_reverse_proxy_companion_container_labels_public_client_api_traefik_hostname: "{{ matrix_synapse_reverse_proxy_companion_container_labels_traefik_hostname }}"

  63. matrix_synapse_reverse_proxy_companion_container_labels_public_client_api_traefik_path_prefix: /_matrix

  64. matrix_synapse_reverse_proxy_companion_container_labels_public_client_api_traefik_rule: "Host(`{{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_api_traefik_hostname }}`) && PathPrefix(`{{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_api_traefik_path_prefix }}`)"

  65. matrix_synapse_reverse_proxy_companion_container_labels_public_client_api_traefik_priority: 0

  66. matrix_synapse_reverse_proxy_companion_container_labels_public_client_api_traefik_entrypoints: "{{ matrix_synapse_reverse_proxy_companion_container_labels_traefik_entrypoints }}"

  67. matrix_synapse_reverse_proxy_companion_container_labels_public_client_api_traefik_tls: "{{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_api_traefik_entrypoints != 'web' }}"

  68. matrix_synapse_reverse_proxy_companion_container_labels_public_client_api_traefik_tls_certResolver: "{{ matrix_synapse_reverse_proxy_companion_container_labels_traefik_tls_certResolver }}"  # noqa var-naming

  69. 

  70. # Controls whether labels will be added that expose the Client-Server API on the internal Traefik entrypoint.

  71. # This is similar to `matrix_synapse_container_labels_public_client_api_enabled`, but the entrypoint and intent is different.

  72. matrix_synapse_reverse_proxy_companion_container_labels_internal_client_api_enabled: false

  73. matrix_synapse_reverse_proxy_companion_container_labels_internal_client_api_traefik_path_prefix: "{{ matrix_synapse_container_labels_public_client_api_traefik_path_prefix }}"

  74. matrix_synapse_reverse_proxy_companion_container_labels_internal_client_api_traefik_rule: "PathPrefix(`{{ matrix_synapse_reverse_proxy_companion_container_labels_internal_client_api_traefik_path_prefix }}`)"

  75. matrix_synapse_reverse_proxy_companion_container_labels_internal_client_api_traefik_priority: "{{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_api_traefik_priority }}"

  76. matrix_synapse_reverse_proxy_companion_container_labels_internal_client_api_traefik_entrypoints: ""

  77. 

  78. # Controls whether labels will be added that expose the /_synapse/client paths

  79. matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_client_api_enabled: true

  80. matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_client_api_traefik_hostname: "{{ matrix_synapse_reverse_proxy_companion_container_labels_traefik_hostname }}"

  81. matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_client_api_traefik_path_prefix: /_synapse/client

  82. matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_client_api_traefik_rule: "Host(`{{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_client_api_traefik_hostname }}`) && PathPrefix(`{{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_client_api_traefik_path_prefix }}`)"

  83. matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_client_api_traefik_priority: 0

  84. matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_client_api_traefik_entrypoints: "{{ matrix_synapse_reverse_proxy_companion_container_labels_traefik_entrypoints }}"

  85. matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_client_api_traefik_tls: "{{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_client_api_traefik_entrypoints != 'web' }}"

  86. matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_client_api_traefik_tls_certResolver: "{{ matrix_synapse_reverse_proxy_companion_container_labels_traefik_tls_certResolver }}"  # noqa var-naming

  87. 

  88. # Controls whether labels will be added that expose the /_synapse/admin paths

  89. # Following these recommendations (https://github.com/element-hq/synapse/blob/master/docs/reverse_proxy.md), by default, we don't.

  90. matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_admin_api_enabled: false

  91. matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_admin_api_traefik_hostname: "{{ matrix_synapse_reverse_proxy_companion_container_labels_traefik_hostname }}"

  92. matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_admin_api_traefik_path_prefix: /_synapse/admin

  93. matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_admin_api_traefik_rule: "Host(`{{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_admin_api_traefik_hostname }}`) && PathPrefix(`{{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_admin_api_traefik_path_prefix }}`)"

  94. matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_admin_api_traefik_priority: 0

  95. matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_admin_api_traefik_entrypoints: "{{ matrix_synapse_reverse_proxy_companion_container_labels_traefik_entrypoints }}"

  96. matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_admin_api_traefik_tls: "{{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_admin_api_traefik_entrypoints != 'web' }}"

  97. matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_admin_api_traefik_tls_certResolver: "{{ matrix_synapse_reverse_proxy_companion_container_labels_traefik_tls_certResolver }}"  # noqa var-naming

  98. 

  99. # Controls whether labels will be added that expose the Server-Server API (Federation API).

  100. matrix_synapse_reverse_proxy_companion_container_labels_public_federation_api_enabled: "{{ matrix_synapse_reverse_proxy_companion_federation_api_enabled }}"

  101. matrix_synapse_reverse_proxy_companion_container_labels_public_federation_api_traefik_hostname: "{{ matrix_synapse_reverse_proxy_companion_container_labels_traefik_hostname }}"

  102. matrix_synapse_reverse_proxy_companion_container_labels_public_federation_api_traefik_path_prefix: /_matrix

  103. matrix_synapse_reverse_proxy_companion_container_labels_public_federation_api_traefik_rule: "Host(`{{ matrix_synapse_reverse_proxy_companion_container_labels_public_federation_api_traefik_hostname }}`) && PathPrefix(`{{ matrix_synapse_reverse_proxy_companion_container_labels_public_federation_api_traefik_path_prefix }}`)"

  104. matrix_synapse_reverse_proxy_companion_container_labels_public_federation_api_traefik_priority: 0

  105. matrix_synapse_reverse_proxy_companion_container_labels_public_federation_api_traefik_entrypoints: ''

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

  107. matrix_synapse_reverse_proxy_companion_container_labels_public_federation_api_traefik_tls: true

  108. matrix_synapse_reverse_proxy_companion_container_labels_public_federation_api_traefik_tls_certResolver: "{{ matrix_synapse_reverse_proxy_companion_container_labels_traefik_tls_certResolver }}"  # noqa var-naming

  109. 

  110. # matrix_synapse_reverse_proxy_companion_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file.

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

  112. #

  113. # Example:

  114. # matrix_synapse_reverse_proxy_companion_container_labels_additional_labels: |

  115. #   my.label=1

  116. #   another.label="here"

  117. matrix_synapse_reverse_proxy_companion_container_labels_additional_labels: ''

  118. 

  119. # The amount of worker processes and connections

  120. # Consider increasing these when you are expecting high amounts of traffic

  121. # http://nginx.org/en/docs/ngx_core_module.html#worker_connections

  122. matrix_synapse_reverse_proxy_companion_worker_processes: auto

  123. matrix_synapse_reverse_proxy_companion_worker_connections: 1024

  124. 

  125. # Option to disable the access log

  126. matrix_synapse_reverse_proxy_companion_access_log_enabled: true

  127. 

  128. # Controls whether to send access logs to a remote syslog-compatible server

  129. matrix_synapse_reverse_proxy_companion_access_log_syslog_integration_enabled: false

  130. matrix_synapse_reverse_proxy_companion_access_log_syslog_integration_server_port: ''

  131. # This is intentionally different. The maximum allowed length is 32 characters and dashes are not allowed.

  132. matrix_synapse_reverse_proxy_companion_access_log_syslog_integration_tag: matrix_synapse_rev_proxy_comp

  133. 

  134. # The tmpfs at /tmp needs to be large enough to handle multiple concurrent file uploads.

  135. matrix_synapse_reverse_proxy_companion_tmp_directory_size_mb: "{{ (matrix_synapse_reverse_proxy_companion_federation_api_client_max_body_size_mb | int) * 50 }}"

  136. matrix_synapse_reverse_proxy_companion_tmp_cache_directory_size_mb: "{{ (matrix_synapse_reverse_proxy_companion_synapse_cache_max_size_mb | int) * 2 }}"

  137. 

  138. # A list of strings containing additional configuration blocks to add to the nginx server configuration (nginx.conf).

  139. # for big matrixservers to enlarge the number of open files to prevent timeouts

  140. # matrix_synapse_reverse_proxy_companion_additional_configuration_blocks:

  141. #  - 'worker_rlimit_nofile 30000;'

  142. matrix_synapse_reverse_proxy_companion_additional_configuration_blocks: []

  143. 

  144. # A list of strings containing additional configuration blocks to add to the nginx event server configuration (nginx.conf).

  145. matrix_synapse_reverse_proxy_companion_event_additional_configuration_blocks: []

  146. 

  147. # A list of strings containing additional configuration blocks to add to the nginx http's server configuration (nginx-http.conf).

  148. matrix_synapse_reverse_proxy_companion_http_additional_server_configuration_blocks: []

  149. 

  150. # To increase request timeout in NGINX using proxy_read_timeout, proxy_connect_timeout, proxy_send_timeout, send_timeout directives

  151. # Nginx Default: proxy_connect_timeout 60s;   #Defines a timeout for establishing a connection with a proxied server

  152. # Nginx Default: proxy_send_timeout 60s;      #Sets a timeout for transmitting a request to the proxied server.

  153. # Nginx Default: proxy_read_timeout 60s;      #Defines a timeout for reading a response from the proxied server.

  154. # Nginx Default: send_timeout 60s;            #Sets a timeout for transmitting a response to the client.

  155. #

  156. # For more information visit:

  157. # http://nginx.org/en/docs/http/ngx_http_proxy_module.html

  158. # http://nginx.org/en/docs/http/ngx_http_core_module.html#send_timeout

  159. # https://www.nginx.com/resources/wiki/start/topics/examples/fullexample2/

  160. #

  161. # Here we are sticking with nginx default values change this value carefully.

  162. matrix_synapse_reverse_proxy_companion_proxy_connect_timeout: 60

  163. matrix_synapse_reverse_proxy_companion_proxy_send_timeout: 60

  164. matrix_synapse_reverse_proxy_companion_proxy_read_timeout: 60

  165. matrix_synapse_reverse_proxy_companion_send_timeout: 60

  166. 

  167. # For OCSP purposes, we need to define a resolver at the `server{}` level or `http{}` level (we do the latter).

  168. #

  169. # Otherwise, we get warnings like this:

  170. # > [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"

  171. #

  172. # We point it to the internal Docker resolver, which likely delegates to nameservers defined in `/etc/resolv.conf`.

  173. matrix_synapse_reverse_proxy_companion_http_level_resolver: 127.0.0.11

  174. 

  175. matrix_synapse_reverse_proxy_companion_hostname: "matrix-synapse-reverse-proxy-companion"

  176. 

  177. # matrix_synapse_reverse_proxy_companion_client_api_addr specifies the address where the Client-Server API is

  178. matrix_synapse_reverse_proxy_companion_client_api_addr: 'matrix-synapse:{{ matrix_synapse_container_client_api_port }}'

  179. # This needs to be equal or higher than the maximum upload size accepted by Synapse.

  180. matrix_synapse_reverse_proxy_companion_client_api_client_max_body_size_mb: 50

  181. 

  182. # matrix_synapse_reverse_proxy_companion_federation_api_enabled specifies whether reverse proxying for the Federation (Server-Server) API should be done

  183. matrix_synapse_reverse_proxy_companion_federation_api_enabled: true

  184. # matrix_synapse_reverse_proxy_companion_federation_api_addr specifies the address where the Federation (Server-Server) API is

  185. matrix_synapse_reverse_proxy_companion_federation_api_addr: 'matrix-synapse:{{ matrix_synapse_container_federation_api_plain_port }}'

  186. matrix_synapse_reverse_proxy_companion_federation_api_client_max_body_size_mb: "{{ (matrix_synapse_reverse_proxy_companion_client_api_client_max_body_size_mb | int) * 3 }}"

  187. 

  188. # A list of strings containing additional configuration blocks to add to the nginx vhost handling the Synapse Client-Server API

  189. matrix_synapse_reverse_proxy_companion_synapse_client_api_additional_server_configuration_blocks: []

  190. 

  191. # A list of strings containing additional configuration blocks to add to the nginx vhost handling the Synapse Federation (Server-Server) API

  192. matrix_synapse_reverse_proxy_companion_synapse_federation_api_additional_server_configuration_blocks: []

  193. 

  194. 

  195. # synapse worker activation and endpoint mappings

  196. matrix_synapse_reverse_proxy_companion_synapse_workers_enabled: false

  197. matrix_synapse_reverse_proxy_companion_synapse_workers_list: []

  198. matrix_synapse_reverse_proxy_companion_synapse_generic_worker_client_server_locations: []

  199. matrix_synapse_reverse_proxy_companion_synapse_generic_worker_federation_locations: []

  200. matrix_synapse_reverse_proxy_companion_synapse_stream_writer_typing_stream_worker_client_server_locations: []

  201. matrix_synapse_reverse_proxy_companion_synapse_stream_writer_to_device_stream_worker_client_server_locations: []

  202. matrix_synapse_reverse_proxy_companion_synapse_stream_writer_account_data_stream_worker_client_server_locations: []

  203. matrix_synapse_reverse_proxy_companion_synapse_stream_writer_receipts_stream_worker_client_server_locations: []

  204. matrix_synapse_reverse_proxy_companion_synapse_stream_writer_presence_stream_worker_client_server_locations: []

  205. matrix_synapse_reverse_proxy_companion_synapse_media_repository_locations: []

  206. matrix_synapse_reverse_proxy_companion_synapse_user_dir_locations: []

  207. 

  208. 

  209. # synapse content caching

  210. matrix_synapse_reverse_proxy_companion_synapse_cache_enabled: false

  211. matrix_synapse_reverse_proxy_companion_synapse_cache_path: /tmp/synapse-cache

  212. matrix_synapse_reverse_proxy_companion_synapse_cache_keys_zone_name: "STATIC"

  213. matrix_synapse_reverse_proxy_companion_synapse_cache_keys_zone_size: "10m"

  214. matrix_synapse_reverse_proxy_companion_synapse_cache_inactive_time: "48h"

  215. matrix_synapse_reverse_proxy_companion_synapse_cache_max_size_mb: 1024

  216. matrix_synapse_reverse_proxy_companion_synapse_cache_proxy_cache_valid_time: "24h"

  217. 

  218. 

  219. # Controls whether matrix-synapse-reverse-proxy-companion trusts an upstream server's X-Forwarded-Proto header.

  220. # The `matrix-synapse-reverse-proxy-companion` does not terminate SSL and always expects to be fronted by another reverse-proxy server.

  221. # As such, it trusts the protocol scheme forwarded by the upstream proxy.

  222. matrix_synapse_reverse_proxy_companion_trust_forwarded_proto: true

  223. matrix_synapse_reverse_proxy_companion_x_forwarded_proto_value: "{{ '$http_x_forwarded_proto' if matrix_synapse_reverse_proxy_companion_trust_forwarded_proto else '$scheme' }}"