Matrix Docker Ansible eploy
No puede seleccionar más de 25 temas Los temas deben comenzar con una letra o número, pueden incluir guiones ('-') y pueden tener hasta 35 caracteres de largo.
 
 

648 líneas
26 KiB

  1. ---
  2. # This variables file wires together the various components (roles) used by the playbook.
  3. #
  4. # Roles used by playbook are pretty minimal and kept independent of one another as much as possible.
  5. # To deliver a turnkey fully-featured Matrix server, this playbook needs
  6. # to connect them all together. It does so by overriding role variables.
  7. #
  8. # You can also override ANY variable (seen here or in any given role),
  9. # by re-defining it in your own configuration file (`inventory/host_vars/matrix.<your-domain>`).
  10. ######################################################################
  11. #
  12. # matrix-base
  13. #
  14. ######################################################################
  15. matrix_identity_server_url: "{{ 'https://' + matrix_synapse_trusted_third_party_id_servers[0] if matrix_synapse_trusted_third_party_id_servers|length > 0 else None }}"
  16. ######################################################################
  17. #
  18. # /matrix-base
  19. #
  20. ######################################################################
  21. ######################################################################
  22. #
  23. # matrix-bridge-appservice-discord
  24. #
  25. ######################################################################
  26. # We don't enable bridges by default.
  27. matrix_appservice_discord_enabled: false
  28. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-discord over the container network.
  29. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  30. # matrix-appservice-discord's client-server port to the local host.
  31. matrix_appservice_discord_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9005' }}"
  32. # If the homeserver disables presence, it's likely better (less wasteful) to also disable presence on the bridge side.
  33. matrix_appservice_discord_bridge_disablePresence: "{{ matrix_synapse_use_presence }}"
  34. matrix_appservice_discord_systemd_required_services_list: |
  35. {{
  36. ['docker.service']
  37. +
  38. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  39. }}
  40. matrix_appservice_discord_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'discord.as.token') | to_uuid }}"
  41. matrix_appservice_discord_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'discord.hs.token') | to_uuid }}"
  42. ######################################################################
  43. #
  44. # /matrix-bridge-appservice-discord
  45. #
  46. ######################################################################
  47. ######################################################################
  48. #
  49. # matrix-appservice-slack
  50. #
  51. ######################################################################
  52. # We don't enable bridges by default.
  53. matrix_appservice_slack_enabled: false
  54. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-slack over the container network.
  55. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  56. # matrix-appservice-slack's client-server port to the local host.
  57. matrix_appservice_slack_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:{{ matrix_appservice_slack_slack_port }}' }}"
  58. matrix_appservice_slack_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'slack-appservice-token') | to_uuid }}"
  59. matrix_appservice_slack_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'slack-homeserver-token') | to_uuid }}"
  60. matrix_appservice_slack_id_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'slack-id-token') | to_uuid }}"
  61. matrix_appservice_slack_systemd_required_services_list: |
  62. {{
  63. ['docker.service']
  64. +
  65. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  66. }}
  67. ######################################################################
  68. #
  69. # /matrix-bridge-appservice-slack
  70. #
  71. ######################################################################
  72. ######################################################################
  73. #
  74. # matrix-bridge-appservice-irc
  75. #
  76. ######################################################################
  77. # We don't enable bridges by default.
  78. matrix_appservice_irc_enabled: false
  79. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-irc over the container network.
  80. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  81. # matrix-appservice-irc's client-server port to the local host.
  82. matrix_appservice_irc_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9999' }}"
  83. # The IRC bridge docs say that if homeserver presence is disabled, it's better to also disable
  84. # IRC bridge presence, for performance reasons.
  85. matrix_appservice_irc_homeserver_enablePresence: "{{ matrix_synapse_use_presence }}"
  86. matrix_appservice_irc_systemd_required_services_list: |
  87. {{
  88. ['docker.service']
  89. +
  90. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  91. }}
  92. matrix_appservice_irc_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'irc.as.token') | to_uuid }}"
  93. matrix_appservice_irc_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'irc.hs.token') | to_uuid }}"
  94. ######################################################################
  95. #
  96. # /matrix-bridge-appservice-irc
  97. #
  98. ######################################################################
  99. ######################################################################
  100. #
  101. # matrix-bridge-mautrix-facebook
  102. #
  103. ######################################################################
  104. # We don't enable bridges by default.
  105. matrix_mautrix_facebook_enabled: false
  106. matrix_mautrix_facebook_systemd_required_services_list: |
  107. {{
  108. ['docker.service']
  109. +
  110. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  111. }}
  112. matrix_mautrix_facebook_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'fb.as.token') | to_uuid }}"
  113. matrix_mautrix_facebook_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'fb.hs.token') | to_uuid }}"
  114. matrix_mautrix_facebook_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
  115. ######################################################################
  116. #
  117. # /matrix-bridge-mautrix-facebook
  118. #
  119. ######################################################################
  120. ######################################################################
  121. #
  122. # matrix-bridge-mautrix-hangouts
  123. #
  124. ######################################################################
  125. # We don't enable bridges by default.
  126. matrix_mautrix_hangouts_enabled: false
  127. matrix_mautrix_hangouts_systemd_required_services_list: |
  128. {{
  129. ['docker.service']
  130. +
  131. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  132. }}
  133. matrix_mautrix_hangouts_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'ho.as.token') | to_uuid }}"
  134. matrix_mautrix_hangouts_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'ho.hs.token') | to_uuid }}"
  135. matrix_mautrix_hangouts_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
  136. ######################################################################
  137. #
  138. # /matrix-bridge-mautrix-hangouts
  139. #
  140. ######################################################################
  141. ######################################################################
  142. #
  143. # matrix-bridge-mautrix-telegram
  144. #
  145. ######################################################################
  146. # We don't enable bridges by default.
  147. matrix_mautrix_telegram_enabled: false
  148. matrix_mautrix_telegram_systemd_required_services_list: |
  149. {{
  150. ['docker.service']
  151. +
  152. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  153. }}
  154. matrix_mautrix_telegram_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'telegr.as.token') | to_uuid }}"
  155. matrix_mautrix_telegram_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'telegr.hs.token') | to_uuid }}"
  156. matrix_mautrix_telegram_public_endpoint: "/{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'telegram') | to_uuid }}"
  157. matrix_mautrix_telegram_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9006' }}"
  158. matrix_mautrix_telegram_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
  159. ######################################################################
  160. #
  161. # /matrix-bridge-mautrix-telegram
  162. #
  163. ######################################################################
  164. ######################################################################
  165. #
  166. # matrix-bridge-mautrix-whatsapp
  167. #
  168. ######################################################################
  169. # We don't enable bridges by default.
  170. matrix_mautrix_whatsapp_enabled: false
  171. matrix_mautrix_whatsapp_systemd_required_services_list: |
  172. {{
  173. ['docker.service']
  174. +
  175. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  176. }}
  177. matrix_mautrix_whatsapp_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'whats.as.token') | to_uuid }}"
  178. matrix_mautrix_whatsapp_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'whats.hs.token') | to_uuid }}"
  179. matrix_mautrix_whatsapp_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
  180. ######################################################################
  181. #
  182. # /matrix-bridge-mautrix-whatsapp
  183. #
  184. ######################################################################
  185. ######################################################################
  186. #
  187. # matrix-corporal
  188. #
  189. ######################################################################
  190. matrix_corporal_enabled: false
  191. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-corporal over the container network.
  192. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  193. # matrix-corporal's web-server ports to the local host.
  194. matrix_corporal_container_http_gateway_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:41080' }}"
  195. matrix_corporal_container_http_api_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:41081' }}"
  196. matrix_corporal_systemd_required_services_list: |
  197. {{
  198. (['docker.service'])
  199. +
  200. (['matrix-synapse.service'])
  201. }}
  202. matrix_corporal_matrix_homeserver_api_endpoint: "http://matrix-synapse:8008"
  203. matrix_corporal_matrix_auth_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret }}"
  204. matrix_corporal_matrix_registration_shared_secret: "{{ matrix_synapse_registration_shared_secret }}"
  205. ######################################################################
  206. #
  207. # /matrix-corporal
  208. #
  209. ######################################################################
  210. ######################################################################
  211. #
  212. # matrix-coturn
  213. #
  214. ######################################################################
  215. matrix_coturn_enabled: true
  216. matrix_coturn_turn_external_ip_address: "{{ ansible_host }}"
  217. matrix_coturn_tls_enabled: true
  218. matrix_coturn_tls_cert_path: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_server_fqn_matrix }}/fullchain.pem"
  219. matrix_coturn_tls_key_path: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_server_fqn_matrix }}/privkey.pem"
  220. matrix_coturn_container_additional_volumes:
  221. - src: "{{ matrix_ssl_config_dir_path }}"
  222. dst: "{{ matrix_ssl_config_dir_path }}"
  223. options: ro
  224. ######################################################################
  225. #
  226. # /matrix-coturn
  227. #
  228. ######################################################################
  229. ######################################################################
  230. #
  231. # matrix-dimension
  232. #
  233. ######################################################################
  234. matrix_dimension_enabled: false
  235. # Normally, matrix-nginx-proxy is enabled and nginx can reach Dimension over the container network.
  236. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  237. # the Dimension HTTP port to the local host.
  238. matrix_dimension_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8184' }}"
  239. matrix_integration_manager_rest_url: "{{ matrix_dimension_integrations_rest_url if matrix_dimension_enabled else None }}"
  240. matrix_integration_manager_ui_url: "{{ matrix_dimension_integrations_ui_url if matrix_dimension_enabled else None }}"
  241. ######################################################################
  242. #
  243. # /matrix-dimension
  244. #
  245. ######################################################################
  246. ######################################################################
  247. #
  248. # matrix-email2matrix
  249. #
  250. ######################################################################
  251. matrix_email2matrix_enabled: false
  252. ######################################################################
  253. #
  254. # /matrix-email2matrix
  255. #
  256. ######################################################################
  257. ######################################################################
  258. #
  259. # matrix-mailer
  260. #
  261. ######################################################################
  262. # By default, this playbook sets up a postfix mailer server (running in a container).
  263. # This is so that Synapse can send email reminders for unread messages.
  264. # Other services (like mxisd), also use the mailer.
  265. matrix_mailer_enabled: true
  266. ######################################################################
  267. #
  268. # /matrix-mailer
  269. #
  270. ######################################################################
  271. ######################################################################
  272. #
  273. # matrix-mxisd
  274. #
  275. ######################################################################
  276. # By default, this playbook installs the mxisd identity server on the same domain as Synapse (`matrix_server_fqn_matrix`).
  277. # If you wish to use the public identity servers (matrix.org, vector.im) instead of your own you may wish to disable this.
  278. matrix_mxisd_enabled: true
  279. # Normally, matrix-nginx-proxy is enabled and nginx can reach mxisd over the container network.
  280. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  281. # mxisd's web-server port.
  282. matrix_mxisd_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8090' }}"
  283. # We enable Synapse integration via its Postgres database by default.
  284. # When using another Identity store, you might wish to disable this and define
  285. # your own configuration in `matrix_mxisd_configuration_extension_yaml`.
  286. matrix_mxisd_synapsesql_enabled: true
  287. matrix_mxisd_synapsesql_type: postgresql
  288. matrix_mxisd_synapsesql_connection: //{{ matrix_synapse_database_host }}/{{ matrix_synapse_database_database }}?user={{ matrix_synapse_database_user | urlencode() }}&password={{ matrix_synapse_database_password | urlencode() }}
  289. matrix_mxisd_dns_overwrite_enabled: true
  290. matrix_mxisd_dns_overwrite_homeserver_client_name: "{{ matrix_server_fqn_matrix }}"
  291. matrix_mxisd_dns_overwrite_homeserver_client_value: "http://{{ 'matrix-corporal:41080' if matrix_corporal_enabled else 'matrix-synapse:8008' }}"
  292. # By default, we send mail through the `matrix-mailer` service.
  293. matrix_mxisd_threepid_medium_email_identity_from: "{{ matrix_mailer_sender_address }}"
  294. matrix_mxisd_threepid_medium_email_connectors_smtp_host: "matrix-mailer"
  295. matrix_mxisd_threepid_medium_email_connectors_smtp_port: 8025
  296. matrix_mxisd_threepid_medium_email_connectors_smtp_tls: 0
  297. matrix_mxisd_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else false }}"
  298. matrix_mxisd_systemd_wanted_services_list: |
  299. {{
  300. (['matrix-corporal.service'] if matrix_corporal_enabled else ['matrix-synapse.service'])
  301. +
  302. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  303. +
  304. (['matrix-mailer.service'] if matrix_mailer_enabled else [])
  305. }}
  306. ######################################################################
  307. #
  308. # /matrix-mxisd
  309. #
  310. ######################################################################
  311. ######################################################################
  312. #
  313. # matrix-nginx-proxy
  314. #
  315. ######################################################################
  316. # By default, this playbook sets up a reverse-proxy nginx proxy server on TCP ports 80, 443 and 8448.
  317. # This is fine if you're dedicating the whole server to Matrix.
  318. # If that's not the case, you may wish to disable this and take care of proxying yourself.
  319. matrix_nginx_proxy_enabled: true
  320. matrix_nginx_proxy_proxy_matrix_client_api_addr_with_container: "{{ 'matrix-corporal:41080' if matrix_corporal_enabled else 'matrix-synapse:8008' }}"
  321. matrix_nginx_proxy_proxy_matrix_client_api_addr_sans_container: "{{ '127.0.0.1:41080' if matrix_corporal_enabled else '127.0.0.1:8008' }}"
  322. matrix_nginx_proxy_proxy_matrix_client_api_client_max_body_size_mb: "{{ matrix_synapse_max_upload_size_mb }}"
  323. matrix_nginx_proxy_proxy_matrix_enabled: true
  324. matrix_nginx_proxy_proxy_riot_enabled: "{{ matrix_riot_web_enabled }}"
  325. matrix_nginx_proxy_proxy_dimension_enabled: "{{ matrix_dimension_enabled }}"
  326. matrix_nginx_proxy_proxy_matrix_corporal_api_enabled: "{{ matrix_corporal_enabled and matrix_corporal_http_api_enabled }}"
  327. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_with_container: "matrix-corporal:41081"
  328. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_sans_container: "127.0.0.1:41081"
  329. matrix_nginx_proxy_proxy_matrix_identity_api_enabled: "{{ matrix_mxisd_enabled }}"
  330. matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container: "matrix-mxisd:8090"
  331. matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container: "127.0.0.1:8090"
  332. # By default, we do TLS termination for the Matrix Federation API (port 8448) at matrix-nginx-proxy.
  333. matrix_nginx_proxy_proxy_matrix_federation_api_enabled: true
  334. matrix_nginx_proxy_proxy_matrix_federation_api_addr_with_container: "matrix-synapse:8048"
  335. matrix_nginx_proxy_proxy_matrix_federation_api_addr_sans_container: "127.0.0.1:8048"
  336. matrix_nginx_proxy_proxy_synapse_metrics: "{{ matrix_synapse_metrics_enabled }}"
  337. matrix_nginx_proxy_proxy_synapse_metrics_addr_with_container: "matrix-synapse:{{ matrix_synapse_metrics_port }}"
  338. matrix_nginx_proxy_proxy_synapse_metrics_addr_sans_container: "127.0.0.1:{{ matrix_synapse_metrics_port }}"
  339. matrix_nginx_proxy_proxy_matrix_user_directory_search_enabled: "{{ matrix_mxisd_enabled }}"
  340. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_with_container: "{{ matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container }}"
  341. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_sans_container: "{{ matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container }}"
  342. matrix_nginx_proxy_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else false }}"
  343. matrix_nginx_proxy_systemd_wanted_services_list: |
  344. {{
  345. (['matrix-synapse.service'])
  346. +
  347. (['matrix-corporal.service'] if matrix_corporal_enabled else [])
  348. +
  349. (['matrix-mxisd.service'] if matrix_mxisd_enabled else [])
  350. +
  351. (['matrix-riot-web.service'] if matrix_riot_web_enabled else [])
  352. }}
  353. matrix_ssl_domains_to_obtain_certificates_for: |
  354. {{
  355. ([matrix_server_fqn_matrix])
  356. +
  357. ([matrix_server_fqn_riot] if matrix_riot_web_enabled else [])
  358. +
  359. ([matrix_server_fqn_dimension] if matrix_dimension_enabled else [])
  360. +
  361. ([matrix_domain] if matrix_nginx_proxy_base_domain_serving_enabled else [])
  362. }}
  363. ######################################################################
  364. #
  365. # /matrix-nginx-proxy
  366. #
  367. ######################################################################
  368. ######################################################################
  369. #
  370. # matrix-postgres
  371. #
  372. ######################################################################
  373. matrix_postgres_enabled: true
  374. matrix_postgres_connection_hostname: "matrix-postgres"
  375. matrix_postgres_connection_username: "synapse"
  376. matrix_postgres_connection_password: "synapse-password"
  377. matrix_postgres_db_name: "homeserver"
  378. ######################################################################
  379. #
  380. # /matrix-postgres
  381. #
  382. ######################################################################
  383. ######################################################################
  384. #
  385. # matrix-riot-web
  386. #
  387. ######################################################################
  388. # By default, this playbook installs the Riot.IM web UI on the `matrix_server_fqn_riot` domain.
  389. # If you wish to connect to your Matrix server by other means, you may wish to disable this.
  390. matrix_riot_web_enabled: true
  391. # Normally, matrix-nginx-proxy is enabled and nginx can reach riot-web over the container network.
  392. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  393. # the riot-web HTTP port to the local host.
  394. matrix_riot_web_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8765' }}"
  395. matrix_riot_web_default_hs_url: "{{ matrix_homeserver_url }}"
  396. matrix_riot_web_default_is_url: "{{ matrix_identity_server_url }}"
  397. # Use Dimension if enabled, otherwise fall back to Scalar
  398. matrix_riot_web_integrations_ui_url: "{{ matrix_dimension_integrations_ui_url if matrix_dimension_enabled else 'https://scalar.vector.im/' }}"
  399. matrix_riot_web_integrations_rest_url: "{{ matrix_dimension_integrations_rest_url if matrix_dimension_enabled else 'https://scalar.vector.im/api' }}"
  400. matrix_riot_web_integrations_widgets_urls: "{{ matrix_dimension_integrations_widgets_urls if matrix_dimension_enabled else ['https://scalar.vector.im/api'] }}"
  401. matrix_riot_web_integrations_jitsi_widget_url: "{{ matrix_dimension_integrations_jitsi_widget_url if matrix_dimension_enabled else 'https://scalar.vector.im/api/widgets/jitsi.html' }}"
  402. matrix_riot_web_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else false }}"
  403. matrix_riot_web_registration_enabled: "{{ matrix_synapse_enable_registration }}"
  404. matrix_riot_web_enable_presence_by_hs_url: |
  405. {{
  406. none
  407. if matrix_synapse_use_presence
  408. else {matrix_riot_web_default_hs_url: false}
  409. }}
  410. matrix_riot_web_welcome_user_id: ~
  411. ######################################################################
  412. #
  413. # /matrix-riot-web
  414. #
  415. ######################################################################
  416. ######################################################################
  417. #
  418. # matrix-synapse
  419. #
  420. ######################################################################
  421. # When mxisd is enabled, we can use it instead of the default public Identity servers.
  422. matrix_synapse_trusted_third_party_id_servers: "{{ [matrix_server_fqn_matrix] if matrix_mxisd_enabled else matrix_synapse_id_servers_public }}"
  423. # Normally, matrix-nginx-proxy is enabled and nginx can reach Synapse over the container network.
  424. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it,
  425. # you can expose Synapse's ports to the host.
  426. #
  427. # For exposing the Matrix Client API's port (plain HTTP) to the local host.
  428. matrix_synapse_container_client_api_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8008' }}"
  429. #
  430. # For exposing the Matrix Federation API's plain port (plain HTTP) to the local host.
  431. matrix_synapse_container_federation_api_plain_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8048' }}"
  432. #
  433. # For exposing the Matrix Federation API's TLS port (HTTPS) to the internet on all network interfaces.
  434. matrix_synapse_container_federation_api_tls_host_bind_port: "{{ '8448' if (matrix_synapse_federation_enabled and matrix_synapse_tls_federation_listener_enabled) else '' }}"
  435. #
  436. # For exposing the Synapse Metrics API's port (plain HTTP) to the local host.
  437. matrix_synapse_container_metrics_api_host_bind_port: "{{ '127.0.0.1:9100' if (matrix_synapse_metrics_enabled and not matrix_nginx_proxy_enabled) else '' }}"
  438. #
  439. # For exposing the Synapse Manhole port (plain HTTP) to the local host.
  440. matrix_synapse_container_manhole_api_host_bind_port: "{{ '127.0.0.1:9000' if matrix_synapse_manhole_enabled else '' }}"
  441. matrix_synapse_database_host: "{{ matrix_postgres_connection_hostname }}"
  442. matrix_synapse_database_user: "{{ matrix_postgres_connection_username }}"
  443. matrix_synapse_database_password: "{{ matrix_postgres_connection_password }}"
  444. matrix_synapse_database_database: "{{ matrix_postgres_db_name }}"
  445. # We do not enable TLS in Synapse by default.
  446. # TLS is handled by the matrix-nginx-proxy, which proxies the requests to Synapse.
  447. matrix_synapse_tls_federation_listener_enabled: false
  448. matrix_synapse_tls_certificate_path: ~
  449. matrix_synapse_tls_private_key_path: ~
  450. matrix_synapse_email_enabled: "{{ matrix_mailer_enabled }}"
  451. matrix_synapse_email_smtp_host: "matrix-mailer"
  452. matrix_synapse_email_smtp_port: 8025
  453. matrix_synapse_email_smtp_require_transport_security: false
  454. matrix_synapse_email_notif_from: "Matrix <{{ matrix_mailer_sender_address }}>"
  455. matrix_synapse_email_riot_base_url: "https://{{ matrix_server_fqn_riot }}"
  456. # Even if TURN doesn't support TLS (it does by default),
  457. # it doesn't hurt to try a secure connection anyway.
  458. matrix_synapse_turn_uris: |
  459. {{
  460. [
  461. 'turns:' + matrix_server_fqn_matrix + '?transport=udp',
  462. 'turns:' + matrix_server_fqn_matrix + '?transport=tcp',
  463. 'turn:' + matrix_server_fqn_matrix + '?transport=udp',
  464. 'turn:' + matrix_server_fqn_matrix + '?transport=tcp',
  465. ]
  466. if matrix_coturn_enabled
  467. else []
  468. }}
  469. matrix_synapse_turn_shared_secret: "{{ matrix_coturn_turn_static_auth_secret if matrix_coturn_enabled else '' }}"
  470. matrix_synapse_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else false }}"
  471. matrix_synapse_systemd_required_services_list: |
  472. {{
  473. (['docker.service'])
  474. +
  475. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  476. +
  477. (['matrix-goofys'] if matrix_s3_media_store_enabled else [])
  478. }}
  479. matrix_synapse_systemd_wanted_services_list: |
  480. {{
  481. (['matrix-coturn.service'] if matrix_coturn_enabled else [])
  482. +
  483. (['matrix-mailer.service'] if matrix_mailer_enabled else [])
  484. }}
  485. ######################################################################
  486. #
  487. # /matrix-synapse
  488. #
  489. ######################################################################