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.
 
 

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