overmind
/
matrix-docker-ansible-deploy
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Fork 0
Code Issues 0 Releases 0 Wiki Activity
Matrix Docker Ansible eploy
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
9500 Commits
12 Branches
416 MiB
 
 
Tree: ee75543aa7
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'ee75543aa7'
${ noResults }
matrix-docker-ansible-deploy/roles/custom/matrix-synapse-reverse-prox.../templates/nginx/conf.d/matrix-synapse-reverse-prox...

333 lines
18 KiB
Raw Blame History 

  1. #jinja2: lstrip_blocks: "True"

  2. 

  3. {% set room_workers = matrix_synapse_reverse_proxy_companion_synapse_workers_list | selectattr('type', 'equalto', 'room_worker') | list %}

  4. {% set sync_workers = matrix_synapse_reverse_proxy_companion_synapse_workers_list | selectattr('type', 'equalto', 'sync_worker') | list %}

  5. {% set client_reader_workers = matrix_synapse_reverse_proxy_companion_synapse_workers_list | selectattr('type', 'equalto', 'client_reader') | list %}

  6. {% set federation_reader_workers = matrix_synapse_reverse_proxy_companion_synapse_workers_list | selectattr('type', 'equalto', 'federation_reader') | list %}

  7. {% set generic_workers = matrix_synapse_reverse_proxy_companion_synapse_workers_list | selectattr('type', 'equalto', 'generic_worker') | list %}

  8. {% set stream_writer_typing_stream_workers = matrix_synapse_reverse_proxy_companion_synapse_workers_list | selectattr('type', 'equalto', 'stream_writer') | selectattr('stream_writer_stream', 'equalto', 'typing') | list %}

  9. {% set stream_writer_to_device_stream_workers = matrix_synapse_reverse_proxy_companion_synapse_workers_list | selectattr('type', 'equalto', 'stream_writer') | selectattr('stream_writer_stream', 'equalto', 'to_device') | list %}

  10. {% set stream_writer_account_data_stream_workers = matrix_synapse_reverse_proxy_companion_synapse_workers_list | selectattr('type', 'equalto', 'stream_writer') | selectattr('stream_writer_stream', 'equalto', 'account_data') | list %}

  11. {% set stream_writer_receipts_stream_workers = matrix_synapse_reverse_proxy_companion_synapse_workers_list | selectattr('type', 'equalto', 'stream_writer') | selectattr('stream_writer_stream', 'equalto', 'receipts') | list %}

  12. {% set stream_writer_presence_stream_workers = matrix_synapse_reverse_proxy_companion_synapse_workers_list | selectattr('type', 'equalto', 'stream_writer') | selectattr('stream_writer_stream', 'equalto', 'presence') | list %}

  13. {% set media_repository_workers = matrix_synapse_reverse_proxy_companion_synapse_workers_list | selectattr('type', 'equalto', 'media_repository') | list %}

  14. {% set user_dir_workers = matrix_synapse_reverse_proxy_companion_synapse_workers_list | selectattr('type', 'equalto', 'user_dir') | list %}

  15. 

  16. {% macro render_worker_upstream(name, workers, load_balance) %}

  17. {% if workers | length > 0 %}

  18. 	upstream {{ name }} {

  19. 		{{ load_balance }}

  20. 		keepalive {{ ((workers | length) * 2) | string }};

  21. 		{% for worker in workers %}

  22. 			server "{{ worker.name }}:{{ worker.port }}";

  23. 		{% endfor %}

  24. 	}

  25. {% endif %}

  26. {% endmacro %}

  27. 

  28. {% macro render_locations_to_upstream(locations, upstream_name) %}

  29. 	{% for location in locations %}

  30. 	location ~ {{ location }} {

  31. 		proxy_pass http://{{ upstream_name }}$request_uri;

  32. 		proxy_set_header Host $host;

  33. 		proxy_http_version 1.1;

  34. 		proxy_set_header Connection "";

  35. 	}

  36. 	{% endfor %}

  37. {% endmacro %}

  38. 

  39. {% if matrix_synapse_reverse_proxy_companion_synapse_workers_enabled %}

  40. 

  41. # Maps from https://tcpipuk.github.io/synapse/deployment/nginx.html#mapsconf

  42. # Client username from access token

  43. map $arg_access_token $accesstoken_from_urlparam {

  44.   default                    $arg_access_token;

  45.   "~syt_(?<username>.*?)_.*" $username;

  46. }

  47. # Client username from MXID

  48. map $http_authorization $mxid_localpart {

  49.   default                           $http_authorization;

  50.   "~Bearer syt_(?<username>.*?)_.*" $username;

  51.   ""                                $accesstoken_from_urlparam;

  52. }

  53. # Whether to upgrade HTTP connection

  54. map $http_upgrade $connection_upgrade {

  55.   default upgrade;

  56.   '' close;

  57. }

  58. #Extract room name from URI

  59. map $request_uri $room_name {

  60.   ~^/_matrix/(client|federation)/.*?(?:%21|!)(?<room>[A-Za-z0-9._=\-\/]+)(?::|%3A)[A-Za-z0-9._=\-\/]+ $room;

  61. }

  62. # End maps

  63. 

  64. 	{% if matrix_synapse_reverse_proxy_companion_synapse_cache_enabled %}

  65.     	proxy_cache_path  {{ matrix_synapse_reverse_proxy_companion_synapse_cache_path }} levels=1:2 keys_zone={{ matrix_synapse_reverse_proxy_companion_synapse_cache_keys_zone_name }}:{{ matrix_synapse_reverse_proxy_companion_synapse_cache_keys_zone_size }} inactive={{ matrix_synapse_reverse_proxy_companion_synapse_cache_inactive_time }} max_size={{ matrix_synapse_reverse_proxy_companion_synapse_cache_max_size_mb }}m;

  66. 	{% endif %}

  67. 	# Round Robin "upstream" pools for workers

  68. 

  69. 	{{ render_worker_upstream('room_workers_upstream', room_workers, 'hash $room_name consistent;') }}

  70. 	{{ render_worker_upstream('sync_workers_upstream', sync_workers, 'hash $mxid_localpart consistent;') }}

  71. 	{{ render_worker_upstream('client_reader_workers_upstream', client_reader_workers, 'least_conn;') }}

  72. 	{{ render_worker_upstream('federation_reader_workers_upstream', federation_reader_workers, 'hash $http_x_forwarded_for;') }}

  73. 

  74. 	{{ render_worker_upstream('generic_workers_upstream', generic_workers, 'hash $http_x_forwarded_for;') }}

  75. 

  76. 	{{ render_worker_upstream('stream_writer_typing_stream_workers_upstream', stream_writer_typing_stream_workers, '') }}

  77. 	{{ render_worker_upstream('stream_writer_to_device_stream_workers_upstream', stream_writer_to_device_stream_workers, '') }}

  78. 	{{ render_worker_upstream('stream_writer_account_data_stream_workers_upstream', stream_writer_account_data_stream_workers, '') }}

  79. 	{{ render_worker_upstream('stream_writer_receipts_stream_workers_upstream', stream_writer_receipts_stream_workers, '') }}

  80. 	{{ render_worker_upstream('stream_writer_presence_stream_workers_upstream', stream_writer_presence_stream_workers, '') }}

  81. 

  82. 	{{ render_worker_upstream('media_repository_workers_upstream', media_repository_workers, 'least_conn;') }}

  83. 

  84. 	{{ render_worker_upstream('user_dir_workers_upstream', user_dir_workers, '') }}

  85. {% endif %}

  86. 

  87. server {

  88. 	listen 8008;

  89. 	server_name {{ matrix_synapse_reverse_proxy_companion_hostname }};

  90. 

  91. 	server_tokens off;

  92. 	root /dev/null;

  93. 

  94. 	{% if matrix_synapse_reverse_proxy_companion_synapse_workers_enabled %}

  95. 		# Client-server overrides — These locations must go to the main Synapse process

  96. 		location ~ {{ matrix_synapse_reverse_proxy_companion_client_server_main_override_locations_regex }} {

  97. 			{# FIXME: This block was copied from the main Synapse fallback below.  It would be better to have it in one place and avoid duplication. #}

  98. 			{# Use the embedded DNS resolver in Docker containers to discover the service #}

  99. 			resolver {{ matrix_synapse_reverse_proxy_companion_http_level_resolver }} valid=5s;

  100. 			set $backend "{{ matrix_synapse_reverse_proxy_companion_client_api_addr }}";

  101. 			proxy_pass http://$backend;

  102. 

  103. 			proxy_set_header Host $host;

  104. 

  105. 			client_body_buffer_size 25M;

  106. 			client_max_body_size {{ matrix_synapse_reverse_proxy_companion_client_api_client_max_body_size_mb }}M;

  107. 			proxy_max_temp_file_size 0;

  108. 		}

  109. 

  110. 		# Client-server SSO overrides — These locations must go to the main Synapse process

  111. 		location ~ {{ matrix_synapse_reverse_proxy_companion_client_server_sso_override_locations_regex }} {

  112. 			{# FIXME: This block was copied from the main Synapse fallback below.  It would be better to have it in one place and avoid duplication. #}

  113. 			{# Use the embedded DNS resolver in Docker containers to discover the service #}

  114. 			resolver {{ matrix_synapse_reverse_proxy_companion_http_level_resolver }} valid=5s;

  115. 			set $backend "{{ matrix_synapse_reverse_proxy_companion_client_api_addr }}";

  116. 			proxy_pass http://$backend;

  117. 

  118. 			proxy_set_header Host $host;

  119. 

  120. 			client_body_buffer_size 25M;

  121. 			client_max_body_size {{ matrix_synapse_reverse_proxy_companion_client_api_client_max_body_size_mb }}M;

  122. 			proxy_max_temp_file_size 0;

  123. 		}

  124. 

  125. 		# QR code login (`rendezvous`) locations need to go to the same Synapse process.

  126. 		# It doesn't necessarily need to be the main process, but it needs to be consistent.

  127. 		# For simplicity, we'll send them to the main process though.

  128. 		location ~ {{ matrix_synapse_reverse_proxy_companion_client_server_qr_code_login_locations_regex }} {

  129. 			{# FIXME: This block was copied from the main Synapse fallback below.  It would be better to have it in one place and avoid duplication. #}

  130. 			{# Use the embedded DNS resolver in Docker containers to discover the service #}

  131. 			resolver {{ matrix_synapse_reverse_proxy_companion_http_level_resolver }} valid=5s;

  132. 			set $backend "{{ matrix_synapse_reverse_proxy_companion_client_api_addr }}";

  133. 			proxy_pass http://$backend;

  134. 

  135. 			proxy_set_header Host $host;

  136. 

  137. 			client_body_buffer_size 25M;

  138. 			client_max_body_size {{ matrix_synapse_reverse_proxy_companion_client_api_client_max_body_size_mb }}M;

  139. 			proxy_max_temp_file_size 0;

  140. 		}

  141. 

  142. 		{# Workers redirects BEGIN #}

  143. 

  144. 		{% if generic_workers | length > 0 %}

  145. 			# https://matrix-org.github.io/synapse/latest/workers.html#synapseappgeneric_worker

  146. 			{{ render_locations_to_upstream(matrix_synapse_reverse_proxy_companion_synapse_generic_worker_client_server_locations, 'generic_workers_upstream') }}

  147. 		{% endif %}

  148. 

  149. 		{% if stream_writer_typing_stream_workers | length > 0 %}

  150. 			# https://matrix-org.github.io/synapse/latest/workers.html#the-typing-stream

  151. 			{{ render_locations_to_upstream(matrix_synapse_reverse_proxy_companion_synapse_stream_writer_typing_stream_worker_client_server_locations, 'stream_writer_typing_stream_workers_upstream') }}

  152. 		{% endif %}

  153. 

  154. 		{% if stream_writer_to_device_stream_workers | length > 0 %}

  155. 			# https://matrix-org.github.io/synapse/latest/workers.html#the-to_device-stream

  156. 			{{ render_locations_to_upstream(matrix_synapse_reverse_proxy_companion_synapse_stream_writer_to_device_stream_worker_client_server_locations, 'stream_writer_to_device_stream_workers_upstream') }}

  157. 		{% endif %}

  158. 

  159. 		{% if stream_writer_account_data_stream_workers | length > 0 %}

  160. 			# https://matrix-org.github.io/synapse/latest/workers.html#the-account_data-stream

  161. 			{{ render_locations_to_upstream(matrix_synapse_reverse_proxy_companion_synapse_stream_writer_account_data_stream_worker_client_server_locations, 'stream_writer_account_data_stream_workers_upstream') }}

  162. 		{% endif %}

  163. 

  164. 		{% if stream_writer_receipts_stream_workers | length > 0 %}

  165. 			# https://matrix-org.github.io/synapse/latest/workers.html#the-receipts-stream

  166. 			{{ render_locations_to_upstream(matrix_synapse_reverse_proxy_companion_synapse_stream_writer_receipts_stream_worker_client_server_locations, 'stream_writer_receipts_stream_workers_upstream') }}

  167. 		{% endif %}

  168. 

  169. 		{% if stream_writer_presence_stream_workers | length > 0 %}

  170. 			# https://matrix-org.github.io/synapse/latest/workers.html#the-presence-stream

  171. 			{{ render_locations_to_upstream(matrix_synapse_reverse_proxy_companion_synapse_stream_writer_presence_stream_worker_client_server_locations, 'stream_writer_presence_stream_workers_upstream') }}

  172. 		{% endif %}

  173. 

  174. 		{% if room_workers | length > 0 %}

  175. 			# room workers

  176. 			# https://tcpipuk.github.io/synapse/deployment/workers.html

  177. 			# https://tcpipuk.github.io/synapse/deployment/nginx.html#locationsconf

  178. 			{{ render_locations_to_upstream(matrix_synapse_reverse_proxy_companion_synapse_room_worker_client_server_locations, 'room_workers_upstream') }}

  179. 		{% endif %}

  180. 

  181. 		{% if sync_workers | length > 0 %}

  182. 			# sync workers

  183. 			# https://tcpipuk.github.io/synapse/deployment/workers.html

  184. 			# https://tcpipuk.github.io/synapse/deployment/nginx.html#locationsconf

  185. 			{{ render_locations_to_upstream(matrix_synapse_reverse_proxy_companion_synapse_sync_worker_client_server_locations, 'sync_workers_upstream') }}

  186. 		{% endif %}

  187. 

  188. 		{% if client_reader_workers | length > 0 %}

  189. 			# client_reader workers

  190. 			# https://tcpipuk.github.io/synapse/deployment/workers.html

  191. 			# https://tcpipuk.github.io/synapse/deployment/nginx.html#locationsconf

  192. 			{{ render_locations_to_upstream(matrix_synapse_reverse_proxy_companion_synapse_client_reader_client_server_locations, 'client_reader_workers_upstream') }}

  193. 		{% endif %}

  194. 

  195. 		{% if media_repository_workers | length > 0 %}

  196. 			# https://matrix-org.github.io/synapse/latest/workers.html#synapseappmedia_repository

  197. 			{% for location in matrix_synapse_reverse_proxy_companion_synapse_media_repository_locations %}

  198. 			location ~ {{ location }} {

  199. 				proxy_pass http://media_repository_workers_upstream$request_uri;

  200. 				proxy_set_header Host $host;

  201. 

  202. 				client_body_buffer_size 25M;

  203. 				client_max_body_size {{ matrix_synapse_reverse_proxy_companion_client_api_client_max_body_size_mb }}M;

  204. 				proxy_max_temp_file_size 0;

  205. 

  206. 				{% if matrix_synapse_reverse_proxy_companion_synapse_cache_enabled %}

  207. 					proxy_buffering        on;

  208. 					proxy_cache            {{ matrix_synapse_reverse_proxy_companion_synapse_cache_keys_zone_name }};

  209. 					proxy_cache_valid      any {{ matrix_synapse_reverse_proxy_companion_synapse_cache_proxy_cache_valid_time }};

  210. 					proxy_force_ranges on;

  211. 					add_header X-Cache-Status $upstream_cache_status;

  212. 				{% endif %}

  213. 			}

  214. 			{% endfor %}

  215. 		{% endif %}

  216. 

  217. 		{% if user_dir_workers | length > 0 %}

  218. 			# https://matrix-org.github.io/synapse/latest/workers.html#updating-the-user-directory

  219. 			{{ render_locations_to_upstream(matrix_synapse_reverse_proxy_companion_synapse_user_dir_locations, 'user_dir_workers_upstream') }}

  220. 		{% endif %}

  221. 		{# Workers redirects END #}

  222. 	{% endif %}

  223. 

  224. 	{% for configuration_block in matrix_synapse_reverse_proxy_companion_synapse_client_api_additional_server_configuration_blocks %}

  225. 		{{- configuration_block }}

  226. 	{% endfor %}

  227. 

  228. 	{# Everything else just goes to the API server ##}

  229. 	location / {

  230. 		{# Use the embedded DNS resolver in Docker containers to discover the service #}

  231. 		resolver {{ matrix_synapse_reverse_proxy_companion_http_level_resolver }} valid=5s;

  232. 		set $backend "{{ matrix_synapse_reverse_proxy_companion_client_api_addr }}";

  233. 		proxy_pass http://$backend;

  234. 

  235. 		proxy_set_header Host $host;

  236. 

  237. 		client_body_buffer_size 25M;

  238. 		client_max_body_size {{ matrix_synapse_reverse_proxy_companion_client_api_client_max_body_size_mb }}M;

  239. 		proxy_max_temp_file_size 0;

  240. 	}

  241. }

  242. 

  243. {% if matrix_synapse_reverse_proxy_companion_federation_api_enabled %}

  244. server {

  245. 	listen 8048;

  246. 	server_name {{ matrix_synapse_reverse_proxy_companion_hostname }};

  247. 

  248. 	server_tokens off;

  249. 

  250. 	root /dev/null;

  251. 

  252. 	{% if matrix_synapse_reverse_proxy_companion_synapse_workers_enabled %}

  253. 		# Federation overrides — These locations must go to the main Synapse process

  254. 		location ~ {{ matrix_synapse_reverse_proxy_companion_federation_override_locations_regex }} {

  255. 			{# FIXME: This block was copied from the fallback location below.  It would be better to have it in one place and avoid duplication. #}

  256. 			{# Use the embedded DNS resolver in Docker containers to discover the service #}

  257. 			resolver {{ matrix_synapse_reverse_proxy_companion_http_level_resolver }} valid=5s;

  258. 			set $backend "{{ matrix_synapse_reverse_proxy_companion_federation_api_addr }}";

  259. 			proxy_pass http://$backend;

  260. 

  261. 			proxy_set_header Host $host;

  262. 

  263. 			client_body_buffer_size 25M;

  264. 			client_max_body_size {{ matrix_synapse_reverse_proxy_companion_federation_api_client_max_body_size_mb }}M;

  265. 			proxy_max_temp_file_size 0;

  266. 		}

  267. 

  268. 		{% if room_workers | length > 0 %}

  269. 			# https://tcpipuk.github.io/synapse/deployment/workers.html

  270. 			{{ render_locations_to_upstream(matrix_synapse_reverse_proxy_companion_synapse_room_worker_federation_locations, 'room_workers_upstream') }}

  271. 		{% endif %}

  272. 

  273. 		{% if generic_workers | length > 0 %}

  274. 			# https://matrix-org.github.io/synapse/latest/workers.html#synapseappgeneric_worker

  275. 			{{ render_locations_to_upstream(matrix_synapse_reverse_proxy_companion_synapse_generic_worker_federation_locations, 'generic_workers_upstream') }}

  276. 		{% endif %}

  277. 

  278. 		{% if media_repository_workers | length > 0 %}

  279. 			# https://matrix-org.github.io/synapse/latest/workers.html#synapseappmedia_repository

  280. 			{% for location in matrix_synapse_reverse_proxy_companion_synapse_media_repository_locations %}

  281. 			location ~ {{ location }} {

  282. 				proxy_pass http://media_repository_workers_upstream$request_uri;

  283. 				proxy_set_header Host $host;

  284. 

  285. 				client_body_buffer_size 25M;

  286. 				client_max_body_size {{ matrix_synapse_reverse_proxy_companion_federation_api_client_max_body_size_mb }}M;

  287. 				proxy_max_temp_file_size 0;

  288. 

  289. 				{% if matrix_synapse_reverse_proxy_companion_synapse_cache_enabled %}

  290. 					proxy_buffering        on;

  291. 					proxy_cache            {{ matrix_synapse_reverse_proxy_companion_synapse_cache_keys_zone_name }};

  292. 					proxy_cache_valid      any  {{ matrix_synapse_reverse_proxy_companion_synapse_cache_proxy_cache_valid_time }};

  293. 					proxy_force_ranges on;

  294. 					add_header X-Cache-Status $upstream_cache_status;

  295. 				{% endif %}

  296. 			}

  297. 			{% endfor %}

  298. 		{% endif %}

  299. 

  300. 		{#

  301. 			This is last, because we'd like more-specific requests (e.g. `/_matrix/federation/v1/media/` that may be handled by a media repository worker, if enabled)

  302. 			to be routed to more specialized workers via their respective `locations` defined earlier (above).

  303. 

  304. 			As https://nginx.org/en/docs/http/ngx_http_core_module.html#location says about location matching:

  305. 			> .. Then regular expressions are checked, in the order of their appearance in the configuration file.

  306. 

  307. 			See: https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3918

  308. 		#}

  309. 		{% if federation_reader_workers | length > 0 %}

  310. 			# https://tcpipuk.github.io/synapse/deployment/workers.html

  311. 			{{ render_locations_to_upstream(matrix_synapse_reverse_proxy_companion_synapse_federation_reader_federation_locations, 'federation_reader_workers_upstream') }}

  312. 		{% endif %}

  313. 	{% endif %}

  314. 

  315. 	{% for configuration_block in matrix_synapse_reverse_proxy_companion_synapse_federation_api_additional_server_configuration_blocks %}

  316. 		{{- configuration_block }}

  317. 	{% endfor %}

  318. 

  319. 	location / {

  320. 		{# Use the embedded DNS resolver in Docker containers to discover the service #}

  321. 		resolver {{ matrix_synapse_reverse_proxy_companion_http_level_resolver }} valid=5s;

  322. 		set $backend "{{ matrix_synapse_reverse_proxy_companion_federation_api_addr }}";

  323. 		proxy_pass http://$backend;

  324. 

  325. 		proxy_set_header Host $host;

  326. 

  327. 		client_body_buffer_size 25M;

  328. 		client_max_body_size {{ matrix_synapse_reverse_proxy_companion_federation_api_client_max_body_size_mb }}M;

  329. 		proxy_max_temp_file_size 0;

  330. 	}

  331. }

  332. {% endif %}