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.
 
 

787 satır
32 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. matrix_riot_jitsi_preferredDomain: "{{ matrix_server_fqn_jitsi if matrix_jitsi_enabled else '' }}"
  17. ######################################################################
  18. #
  19. # /matrix-base
  20. #
  21. ######################################################################
  22. ######################################################################
  23. #
  24. # matrix-architecture
  25. #
  26. ######################################################################
  27. matrix_architecture: "amd64"
  28. ######################################################################
  29. #
  30. # /matrix-architecture
  31. #
  32. ######################################################################
  33. ######################################################################
  34. #
  35. # matrix-bridge-appservice-discord
  36. #
  37. ######################################################################
  38. # We don't enable bridges by default.
  39. matrix_appservice_discord_enabled: false
  40. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-discord over the container network.
  41. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  42. # matrix-appservice-discord's client-server port to the local host.
  43. matrix_appservice_discord_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9005' }}"
  44. # If the homeserver disables presence, it's likely better (less wasteful) to also disable presence on the bridge side.
  45. matrix_appservice_discord_bridge_disablePresence: "{{ matrix_synapse_use_presence }}"
  46. matrix_appservice_discord_systemd_required_services_list: |
  47. {{
  48. ['docker.service']
  49. +
  50. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  51. }}
  52. matrix_appservice_discord_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'discord.as.token') | to_uuid }}"
  53. matrix_appservice_discord_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'discord.hs.token') | to_uuid }}"
  54. ######################################################################
  55. #
  56. # /matrix-bridge-appservice-discord
  57. #
  58. ######################################################################
  59. ######################################################################
  60. #
  61. # matrix-appservice-webhooks
  62. #
  63. ######################################################################
  64. # We don't enable bridges by default.
  65. matrix_appservice_webhooks_enabled: false
  66. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-webhooks over the container network.
  67. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  68. # matrix-appservice-webhooks' client-server port to the local host.
  69. matrix_appservice_webhooks_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:{{ matrix_appservice_webhooks_matrix_port }}' }}"
  70. matrix_appservice_webhooks_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'webhook.as.token') | to_uuid }}"
  71. matrix_appservice_webhooks_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'webhook.hs.token') | to_uuid }}"
  72. matrix_appservice_webhooks_id_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'webhook.id.token') | to_uuid }}"
  73. matrix_appservice_webhooks_systemd_required_services_list: |
  74. {{
  75. ['docker.service']
  76. +
  77. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  78. }}
  79. ######################################################################
  80. #
  81. # /matrix-appservice-webhooks
  82. #
  83. ######################################################################
  84. ######################################################################
  85. #
  86. # matrix-appservice-slack
  87. #
  88. ######################################################################
  89. # We don't enable bridges by default.
  90. matrix_appservice_slack_enabled: false
  91. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-slack over the container network.
  92. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  93. # matrix-appservice-slack's client-server port to the local host.
  94. matrix_appservice_slack_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else ('127.0.0.1:' ~ matrix_appservice_slack_slack_port) }}"
  95. matrix_appservice_slack_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'slack.as.token') | to_uuid }}"
  96. matrix_appservice_slack_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'slack.hs.token') | to_uuid }}"
  97. matrix_appservice_slack_id_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'slack.id.token') | to_uuid }}"
  98. matrix_appservice_slack_systemd_required_services_list: |
  99. {{
  100. ['docker.service']
  101. +
  102. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  103. }}
  104. ######################################################################
  105. #
  106. # /matrix-bridge-appservice-slack
  107. #
  108. ######################################################################
  109. ######################################################################
  110. #
  111. # matrix-bridge-appservice-irc
  112. #
  113. ######################################################################
  114. # We don't enable bridges by default.
  115. matrix_appservice_irc_enabled: false
  116. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-irc over the container network.
  117. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  118. # matrix-appservice-irc's client-server port to the local host.
  119. matrix_appservice_irc_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9999' }}"
  120. # The IRC bridge docs say that if homeserver presence is disabled, it's better to also disable
  121. # IRC bridge presence, for performance reasons.
  122. matrix_appservice_irc_homeserver_enablePresence: "{{ matrix_synapse_use_presence }}"
  123. matrix_appservice_irc_systemd_required_services_list: |
  124. {{
  125. ['docker.service']
  126. +
  127. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  128. }}
  129. matrix_appservice_irc_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'irc.as.token') | to_uuid }}"
  130. matrix_appservice_irc_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'irc.hs.token') | to_uuid }}"
  131. ######################################################################
  132. #
  133. # /matrix-bridge-appservice-irc
  134. #
  135. ######################################################################
  136. ######################################################################
  137. #
  138. # matrix-bridge-mautrix-facebook
  139. #
  140. ######################################################################
  141. # We don't enable bridges by default.
  142. matrix_mautrix_facebook_enabled: false
  143. matrix_mautrix_facebook_container_image_self_build: "{{ (matrix_architecture != 'amd64') and (matrix_architecture != 'arm64') }}"
  144. matrix_mautrix_facebook_systemd_required_services_list: |
  145. {{
  146. ['docker.service']
  147. +
  148. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  149. }}
  150. matrix_mautrix_facebook_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'fb.as.token') | to_uuid }}"
  151. matrix_mautrix_facebook_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'fb.hs.token') | to_uuid }}"
  152. 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 '' }}"
  153. ######################################################################
  154. #
  155. # /matrix-bridge-mautrix-facebook
  156. #
  157. ######################################################################
  158. ######################################################################
  159. #
  160. # matrix-bridge-mautrix-hangouts
  161. #
  162. ######################################################################
  163. # We don't enable bridges by default.
  164. matrix_mautrix_hangouts_enabled: false
  165. matrix_mautrix_hangouts_container_image_self_build: "{{ (matrix_architecture != 'amd64') and (matrix_architecture != 'arm64') }}"
  166. matrix_mautrix_hangouts_systemd_required_services_list: |
  167. {{
  168. ['docker.service']
  169. +
  170. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  171. }}
  172. matrix_mautrix_hangouts_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'ho.as.token') | to_uuid }}"
  173. matrix_mautrix_hangouts_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'ho.hs.token') | to_uuid }}"
  174. 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 '' }}"
  175. ######################################################################
  176. #
  177. # /matrix-bridge-mautrix-hangouts
  178. #
  179. ######################################################################
  180. ######################################################################
  181. #
  182. # matrix-bridge-mautrix-telegram
  183. #
  184. ######################################################################
  185. # We don't enable bridges by default.
  186. matrix_mautrix_telegram_enabled: false
  187. matrix_mautrix_telegram_systemd_required_services_list: |
  188. {{
  189. ['docker.service']
  190. +
  191. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  192. }}
  193. matrix_mautrix_telegram_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'telegr.as.token') | to_uuid }}"
  194. matrix_mautrix_telegram_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'telegr.hs.token') | to_uuid }}"
  195. matrix_mautrix_telegram_public_endpoint: "/{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'telegram') | to_uuid }}"
  196. matrix_mautrix_telegram_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9006' }}"
  197. 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 '' }}"
  198. ######################################################################
  199. #
  200. # /matrix-bridge-mautrix-telegram
  201. #
  202. ######################################################################
  203. ######################################################################
  204. #
  205. # matrix-bridge-mautrix-whatsapp
  206. #
  207. ######################################################################
  208. # We don't enable bridges by default.
  209. matrix_mautrix_whatsapp_enabled: false
  210. matrix_mautrix_whatsapp_systemd_required_services_list: |
  211. {{
  212. ['docker.service']
  213. +
  214. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  215. }}
  216. matrix_mautrix_whatsapp_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'whats.as.token') | to_uuid }}"
  217. matrix_mautrix_whatsapp_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'whats.hs.token') | to_uuid }}"
  218. 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 '' }}"
  219. ######################################################################
  220. #
  221. # /matrix-bridge-mautrix-whatsapp
  222. #
  223. ######################################################################
  224. ######################################################################
  225. #
  226. # matrix-bridge-mx-puppet-skype
  227. #
  228. ######################################################################
  229. # We don't enable bridges by default.
  230. matrix_mx_puppet_skype_enabled: false
  231. matrix_mx_puppet_skype_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  232. matrix_mx_puppet_skype_systemd_required_services_list: |
  233. {{
  234. ['docker.service']
  235. +
  236. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  237. }}
  238. matrix_mx_puppet_skype_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'skype.as.tok') | to_uuid }}"
  239. matrix_mx_puppet_skype_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'skype.hs.tok') | to_uuid }}"
  240. matrix_mx_puppet_skype_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
  241. ######################################################################
  242. #
  243. # /matrix-bridge-mx-puppet-skype
  244. #
  245. ######################################################################
  246. ######################################################################
  247. #
  248. # matrix-corporal
  249. #
  250. ######################################################################
  251. matrix_corporal_enabled: false
  252. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-corporal over the container network.
  253. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  254. # matrix-corporal's web-server ports to the local host.
  255. matrix_corporal_container_http_gateway_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:41080' }}"
  256. matrix_corporal_container_http_api_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:41081' }}"
  257. matrix_corporal_systemd_required_services_list: |
  258. {{
  259. (['docker.service'])
  260. +
  261. (['matrix-synapse.service'])
  262. }}
  263. matrix_corporal_matrix_homeserver_api_endpoint: "http://matrix-synapse:8008"
  264. matrix_corporal_matrix_auth_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret }}"
  265. matrix_corporal_matrix_registration_shared_secret: "{{ matrix_synapse_registration_shared_secret }}"
  266. ######################################################################
  267. #
  268. # /matrix-corporal
  269. #
  270. ######################################################################
  271. ######################################################################
  272. #
  273. # matrix-coturn
  274. #
  275. ######################################################################
  276. matrix_coturn_enabled: true
  277. matrix_coturn_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  278. matrix_coturn_turn_external_ip_address: "{{ ansible_host }}"
  279. matrix_coturn_tls_enabled: true
  280. matrix_coturn_tls_cert_path: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_server_fqn_matrix }}/fullchain.pem"
  281. matrix_coturn_tls_key_path: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_server_fqn_matrix }}/privkey.pem"
  282. matrix_coturn_container_additional_volumes:
  283. - src: "{{ matrix_ssl_config_dir_path }}"
  284. dst: "{{ matrix_ssl_config_dir_path }}"
  285. options: ro
  286. ######################################################################
  287. #
  288. # /matrix-coturn
  289. #
  290. ######################################################################
  291. ######################################################################
  292. #
  293. # matrix-dimension
  294. #
  295. ######################################################################
  296. matrix_dimension_enabled: false
  297. # Normally, matrix-nginx-proxy is enabled and nginx can reach Dimension over the container network.
  298. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  299. # the Dimension HTTP port to the local host.
  300. matrix_dimension_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8184' }}"
  301. matrix_integration_manager_rest_url: "{{ matrix_dimension_integrations_rest_url if matrix_dimension_enabled else None }}"
  302. matrix_integration_manager_ui_url: "{{ matrix_dimension_integrations_ui_url if matrix_dimension_enabled else None }}"
  303. ######################################################################
  304. #
  305. # /matrix-dimension
  306. #
  307. ######################################################################
  308. ######################################################################
  309. #
  310. # matrix-email2matrix
  311. #
  312. ######################################################################
  313. matrix_email2matrix_enabled: false
  314. ######################################################################
  315. #
  316. # /matrix-email2matrix
  317. #
  318. ######################################################################
  319. ######################################################################
  320. #
  321. # matrix-jitsi
  322. #
  323. ######################################################################
  324. matrix_jitsi_enabled: false
  325. # Normally, matrix-nginx-proxy is enabled and nginx can reach jitsi/web over the container network.
  326. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  327. # the Jitsi HTTP port to the local host.
  328. matrix_jitsi_web_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:12080' }}"
  329. matrix_jitsi_jibri_xmpp_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'jibri') | to_uuid }}"
  330. matrix_jitsi_jicofo_auth_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'jicofo') | to_uuid }}"
  331. matrix_jitsi_jvb_auth_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'jvb') | to_uuid }}"
  332. matrix_jitsi_web_stun_servers: |
  333. {{
  334. [
  335. 'stun:' + matrix_server_fqn_matrix + ':5349',
  336. 'stun:' + matrix_server_fqn_matrix + ':3478',
  337. ]
  338. if matrix_coturn_enabled
  339. else [ 'stun:meet-jit-si-turnrelay.jitsi.net:443']
  340. }}
  341. ######################################################################
  342. #
  343. # /matrix-jitsi
  344. #
  345. ######################################################################
  346. ######################################################################
  347. #
  348. # matrix-mailer
  349. #
  350. ######################################################################
  351. # By default, this playbook sets up a postfix mailer server (running in a container).
  352. # This is so that Synapse can send email reminders for unread messages.
  353. # Other services (like ma1sd), also use the mailer.
  354. matrix_mailer_enabled: true
  355. ######################################################################
  356. #
  357. # /matrix-mailer
  358. #
  359. ######################################################################
  360. ######################################################################
  361. #
  362. # matrix-ma1sd
  363. #
  364. ######################################################################
  365. # By default, this playbook installs the ma1sd identity server on the same domain as Synapse (`matrix_server_fqn_matrix`).
  366. # If you wish to use the public identity servers (matrix.org, vector.im) instead of your own you may wish to disable this.
  367. matrix_ma1sd_enabled: true
  368. matrix_ma1sd_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  369. # Normally, matrix-nginx-proxy is enabled and nginx can reach ma1sd over the container network.
  370. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  371. # ma1sd's web-server port.
  372. matrix_ma1sd_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8090' }}"
  373. # We enable Synapse integration via its Postgres database by default.
  374. # When using another Identity store, you might wish to disable this and define
  375. # your own configuration in `matrix_ma1sd_configuration_extension_yaml`.
  376. matrix_ma1sd_synapsesql_enabled: true
  377. matrix_ma1sd_synapsesql_type: postgresql
  378. matrix_ma1sd_synapsesql_connection: //{{ matrix_synapse_database_host }}/{{ matrix_synapse_database_database }}?user={{ matrix_synapse_database_user | urlencode() }}&password={{ matrix_synapse_database_password | urlencode() }}
  379. matrix_ma1sd_dns_overwrite_enabled: true
  380. matrix_ma1sd_dns_overwrite_homeserver_client_name: "{{ matrix_server_fqn_matrix }}"
  381. matrix_ma1sd_dns_overwrite_homeserver_client_value: "http://{{ 'matrix-corporal:41080' if matrix_corporal_enabled else 'matrix-synapse:8008' }}"
  382. # By default, we send mail through the `matrix-mailer` service.
  383. matrix_ma1sd_threepid_medium_email_identity_from: "{{ matrix_mailer_sender_address }}"
  384. matrix_ma1sd_threepid_medium_email_connectors_smtp_host: "matrix-mailer"
  385. matrix_ma1sd_threepid_medium_email_connectors_smtp_port: 8025
  386. matrix_ma1sd_threepid_medium_email_connectors_smtp_tls: 0
  387. matrix_ma1sd_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else false }}"
  388. matrix_ma1sd_systemd_wanted_services_list: |
  389. {{
  390. (['matrix-corporal.service'] if matrix_corporal_enabled else ['matrix-synapse.service'])
  391. +
  392. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  393. +
  394. (['matrix-mailer.service'] if matrix_mailer_enabled else [])
  395. }}
  396. ######################################################################
  397. #
  398. # /matrix-ma1sd
  399. #
  400. ######################################################################
  401. ######################################################################
  402. #
  403. # matrix-nginx-proxy
  404. #
  405. ######################################################################
  406. # By default, this playbook sets up a reverse-proxy nginx proxy server on TCP ports 80, 443 and 8448.
  407. # This is fine if you're dedicating the whole server to Matrix.
  408. # If that's not the case, you may wish to disable this and take care of proxying yourself.
  409. matrix_nginx_proxy_enabled: true
  410. matrix_nginx_proxy_proxy_matrix_client_api_addr_with_container: "{{ 'matrix-corporal:41080' if matrix_corporal_enabled else 'matrix-synapse:8008' }}"
  411. 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' }}"
  412. matrix_nginx_proxy_proxy_matrix_client_api_client_max_body_size_mb: "{{ matrix_synapse_max_upload_size_mb }}"
  413. matrix_nginx_proxy_proxy_matrix_enabled: true
  414. matrix_nginx_proxy_proxy_riot_enabled: "{{ matrix_riot_web_enabled }}"
  415. matrix_nginx_proxy_proxy_dimension_enabled: "{{ matrix_dimension_enabled }}"
  416. matrix_nginx_proxy_proxy_jitsi_enabled: "{{ matrix_jitsi_enabled }}"
  417. matrix_nginx_proxy_proxy_matrix_corporal_api_enabled: "{{ matrix_corporal_enabled and matrix_corporal_http_api_enabled }}"
  418. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_with_container: "matrix-corporal:41081"
  419. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_sans_container: "127.0.0.1:41081"
  420. matrix_nginx_proxy_proxy_matrix_identity_api_enabled: "{{ matrix_ma1sd_enabled }}"
  421. matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container: "matrix-ma1sd:8090"
  422. matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container: "127.0.0.1:8090"
  423. # By default, we do TLS termination for the Matrix Federation API (port 8448) at matrix-nginx-proxy.
  424. matrix_nginx_proxy_proxy_matrix_federation_api_enabled: true
  425. matrix_nginx_proxy_proxy_matrix_federation_api_addr_with_container: "matrix-synapse:8048"
  426. matrix_nginx_proxy_proxy_matrix_federation_api_addr_sans_container: "127.0.0.1:8048"
  427. matrix_nginx_proxy_proxy_synapse_metrics: "{{ matrix_synapse_metrics_enabled }}"
  428. matrix_nginx_proxy_proxy_synapse_metrics_addr_with_container: "matrix-synapse:{{ matrix_synapse_metrics_port }}"
  429. matrix_nginx_proxy_proxy_synapse_metrics_addr_sans_container: "127.0.0.1:{{ matrix_synapse_metrics_port }}"
  430. matrix_nginx_proxy_proxy_matrix_user_directory_search_enabled: "{{ matrix_ma1sd_enabled }}"
  431. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_with_container: "{{ matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container }}"
  432. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_sans_container: "{{ matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container }}"
  433. matrix_nginx_proxy_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else false }}"
  434. matrix_nginx_proxy_systemd_wanted_services_list: |
  435. {{
  436. (['matrix-synapse.service'])
  437. +
  438. (['matrix-corporal.service'] if matrix_corporal_enabled else [])
  439. +
  440. (['matrix-ma1sd.service'] if matrix_ma1sd_enabled else [])
  441. +
  442. (['matrix-riot-web.service'] if matrix_riot_web_enabled else [])
  443. }}
  444. matrix_ssl_domains_to_obtain_certificates_for: |
  445. {{
  446. ([matrix_server_fqn_matrix])
  447. +
  448. ([matrix_server_fqn_riot] if matrix_riot_web_enabled else [])
  449. +
  450. ([matrix_server_fqn_dimension] if matrix_dimension_enabled else [])
  451. +
  452. ([matrix_server_fqn_jitsi] if matrix_jitsi_enabled else [])
  453. +
  454. ([matrix_domain] if matrix_nginx_proxy_base_domain_serving_enabled else [])
  455. }}
  456. matrix_ssl_architecture: "{{ matrix_architecture }}"
  457. ######################################################################
  458. #
  459. # /matrix-nginx-proxy
  460. #
  461. ######################################################################
  462. ######################################################################
  463. #
  464. # matrix-postgres
  465. #
  466. ######################################################################
  467. matrix_postgres_enabled: true
  468. matrix_postgres_connection_hostname: "matrix-postgres"
  469. matrix_postgres_connection_username: "synapse"
  470. matrix_postgres_connection_password: "synapse-password"
  471. matrix_postgres_db_name: "homeserver"
  472. ######################################################################
  473. #
  474. # /matrix-postgres
  475. #
  476. ######################################################################
  477. ######################################################################
  478. #
  479. # matrix-riot-web
  480. #
  481. ######################################################################
  482. # By default, this playbook installs the Riot.IM web UI on the `matrix_server_fqn_riot` domain.
  483. # If you wish to connect to your Matrix server by other means, you may wish to disable this.
  484. matrix_riot_web_enabled: true
  485. matrix_riot_web_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  486. # Normally, matrix-nginx-proxy is enabled and nginx can reach riot-web over the container network.
  487. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  488. # the riot-web HTTP port to the local host.
  489. matrix_riot_web_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8765' }}"
  490. matrix_riot_web_default_hs_url: "{{ matrix_homeserver_url }}"
  491. matrix_riot_web_default_is_url: "{{ matrix_identity_server_url }}"
  492. # Use Dimension if enabled, otherwise fall back to Scalar
  493. matrix_riot_web_integrations_ui_url: "{{ matrix_dimension_integrations_ui_url if matrix_dimension_enabled else 'https://scalar.vector.im/' }}"
  494. matrix_riot_web_integrations_rest_url: "{{ matrix_dimension_integrations_rest_url if matrix_dimension_enabled else 'https://scalar.vector.im/api' }}"
  495. matrix_riot_web_integrations_widgets_urls: "{{ matrix_dimension_integrations_widgets_urls if matrix_dimension_enabled else ['https://scalar.vector.im/api'] }}"
  496. 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' }}"
  497. matrix_riot_web_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else false }}"
  498. matrix_riot_web_registration_enabled: "{{ matrix_synapse_enable_registration }}"
  499. matrix_riot_web_enable_presence_by_hs_url: |
  500. {{
  501. none
  502. if matrix_synapse_use_presence
  503. else {matrix_riot_web_default_hs_url: false}
  504. }}
  505. matrix_riot_web_welcome_user_id: ~
  506. matrix_riot_web_jitsi_preferredDomain: "{{ matrix_server_fqn_jitsi if matrix_jitsi_enabled else '' }}"
  507. ######################################################################
  508. #
  509. # /matrix-riot-web
  510. #
  511. ######################################################################
  512. ######################################################################
  513. #
  514. # matrix-synapse
  515. #
  516. ######################################################################
  517. matrix_synapse_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  518. # When ma1sd is enabled, we can use it instead of the default public Identity servers.
  519. matrix_synapse_trusted_third_party_id_servers: "{{ [matrix_server_fqn_matrix] if matrix_ma1sd_enabled else matrix_synapse_id_servers_public }}"
  520. # When ma1sd is enabled, we can use it to validate email addresses and phone numbers.
  521. # Synapse can validate email addresses by itself as well, but it's probably not what we want by default when we have an identity server.
  522. matrix_synapse_account_threepid_delegates_email: "{{ 'http://matrix-ma1sd:8090' if matrix_ma1sd_enabled else '' }}"
  523. matrix_synapse_account_threepid_delegates_msisdn: "{{ 'http://matrix-ma1sd:8090' if matrix_ma1sd_enabled else '' }}"
  524. # Normally, matrix-nginx-proxy is enabled and nginx can reach Synapse over the container network.
  525. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it,
  526. # you can expose Synapse's ports to the host.
  527. #
  528. # For exposing the Matrix Client API's port (plain HTTP) to the local host.
  529. matrix_synapse_container_client_api_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8008' }}"
  530. #
  531. # For exposing the Matrix Federation API's plain port (plain HTTP) to the local host.
  532. matrix_synapse_container_federation_api_plain_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8048' }}"
  533. #
  534. # For exposing the Matrix Federation API's TLS port (HTTPS) to the internet on all network interfaces.
  535. matrix_synapse_container_federation_api_tls_host_bind_port: "{{ '8448' if (matrix_synapse_federation_enabled and matrix_synapse_tls_federation_listener_enabled) else '' }}"
  536. #
  537. # For exposing the Synapse Metrics API's port (plain HTTP) to the local host.
  538. 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 '' }}"
  539. #
  540. # For exposing the Synapse Manhole port (plain HTTP) to the local host.
  541. matrix_synapse_container_manhole_api_host_bind_port: "{{ '127.0.0.1:9000' if matrix_synapse_manhole_enabled else '' }}"
  542. matrix_synapse_database_host: "{{ matrix_postgres_connection_hostname }}"
  543. matrix_synapse_database_user: "{{ matrix_postgres_connection_username }}"
  544. matrix_synapse_database_password: "{{ matrix_postgres_connection_password }}"
  545. matrix_synapse_database_database: "{{ matrix_postgres_db_name }}"
  546. # We do not enable TLS in Synapse by default.
  547. # TLS is handled by the matrix-nginx-proxy, which proxies the requests to Synapse.
  548. matrix_synapse_tls_federation_listener_enabled: false
  549. matrix_synapse_tls_certificate_path: ~
  550. matrix_synapse_tls_private_key_path: ~
  551. matrix_synapse_email_enabled: "{{ matrix_mailer_enabled }}"
  552. matrix_synapse_email_smtp_host: "matrix-mailer"
  553. matrix_synapse_email_smtp_port: 8025
  554. matrix_synapse_email_smtp_require_transport_security: false
  555. matrix_synapse_email_notif_from: "Matrix <{{ matrix_mailer_sender_address }}>"
  556. # Even if TURN doesn't support TLS (it does by default),
  557. # it doesn't hurt to try a secure connection anyway.
  558. matrix_synapse_turn_uris: |
  559. {{
  560. [
  561. 'turns:' + matrix_server_fqn_matrix + '?transport=udp',
  562. 'turns:' + matrix_server_fqn_matrix + '?transport=tcp',
  563. 'turn:' + matrix_server_fqn_matrix + '?transport=udp',
  564. 'turn:' + matrix_server_fqn_matrix + '?transport=tcp',
  565. ]
  566. if matrix_coturn_enabled
  567. else []
  568. }}
  569. matrix_synapse_turn_shared_secret: "{{ matrix_coturn_turn_static_auth_secret if matrix_coturn_enabled else '' }}"
  570. matrix_synapse_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else false }}"
  571. matrix_synapse_systemd_required_services_list: |
  572. {{
  573. (['docker.service'])
  574. +
  575. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  576. +
  577. (['matrix-goofys'] if matrix_s3_media_store_enabled else [])
  578. }}
  579. matrix_synapse_systemd_wanted_services_list: |
  580. {{
  581. (['matrix-coturn.service'] if matrix_coturn_enabled else [])
  582. +
  583. (['matrix-mailer.service'] if matrix_mailer_enabled else [])
  584. }}
  585. ######################################################################
  586. #
  587. # /matrix-synapse
  588. #
  589. ######################################################################