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.
 
 

866 line
34 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 not in ['amd64', '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 not in ['amd64', '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_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9007' }}"
  175. 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 '' }}"
  176. ######################################################################
  177. #
  178. # /matrix-bridge-mautrix-hangouts
  179. #
  180. ######################################################################
  181. ######################################################################
  182. #
  183. # matrix-bridge-mautrix-telegram
  184. #
  185. ######################################################################
  186. # We don't enable bridges by default.
  187. matrix_mautrix_telegram_enabled: false
  188. matrix_mautrix_telegram_systemd_required_services_list: |
  189. {{
  190. ['docker.service']
  191. +
  192. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  193. }}
  194. matrix_mautrix_telegram_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'telegr.as.token') | to_uuid }}"
  195. matrix_mautrix_telegram_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'telegr.hs.token') | to_uuid }}"
  196. matrix_mautrix_telegram_public_endpoint: "/{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'telegram') | to_uuid }}"
  197. matrix_mautrix_telegram_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9006' }}"
  198. 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 '' }}"
  199. ######################################################################
  200. #
  201. # /matrix-bridge-mautrix-telegram
  202. #
  203. ######################################################################
  204. ######################################################################
  205. #
  206. # matrix-bridge-mautrix-whatsapp
  207. #
  208. ######################################################################
  209. # We don't enable bridges by default.
  210. matrix_mautrix_whatsapp_enabled: false
  211. matrix_mautrix_whatsapp_systemd_required_services_list: |
  212. {{
  213. ['docker.service']
  214. +
  215. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  216. }}
  217. matrix_mautrix_whatsapp_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'whats.as.token') | to_uuid }}"
  218. matrix_mautrix_whatsapp_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'whats.hs.token') | to_uuid }}"
  219. 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 '' }}"
  220. ######################################################################
  221. #
  222. # /matrix-bridge-mautrix-whatsapp
  223. #
  224. ######################################################################
  225. ######################################################################
  226. #
  227. # matrix-sms-bridge
  228. #
  229. ######################################################################
  230. # We don't enable bridges by default.
  231. matrix_sms_bridge_enabled: false
  232. matrix_sms_bridge_systemd_required_services_list: |
  233. {{
  234. ['docker.service']
  235. +
  236. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  237. }}
  238. matrix_sms_bridge_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'sms.as.token') | to_uuid }}"
  239. matrix_sms_bridge_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'sms.hs.token') | to_uuid }}"
  240. ######################################################################
  241. #
  242. # /matrix-sms-bridge
  243. #
  244. ######################################################################
  245. ######################################################################
  246. #
  247. # matrix-bridge-mx-puppet-skype
  248. #
  249. ######################################################################
  250. # We don't enable bridges by default.
  251. matrix_mx_puppet_skype_enabled: false
  252. matrix_mx_puppet_skype_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  253. matrix_mx_puppet_skype_systemd_required_services_list: |
  254. {{
  255. ['docker.service']
  256. +
  257. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  258. }}
  259. matrix_mx_puppet_skype_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'skype.as.tok') | to_uuid }}"
  260. matrix_mx_puppet_skype_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'skype.hs.tok') | to_uuid }}"
  261. 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 '' }}"
  262. ######################################################################
  263. #
  264. # /matrix-bridge-mx-puppet-skype
  265. #
  266. ######################################################################
  267. ######################################################################
  268. #
  269. # matrix-bridge-mx-puppet-slack
  270. #
  271. ######################################################################
  272. # We don't enable bridges by default.
  273. matrix_mx_puppet_slack_enabled: false
  274. matrix_mx_puppet_slack_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  275. matrix_mx_puppet_slack_systemd_required_services_list: |
  276. {{
  277. ['docker.service']
  278. +
  279. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  280. }}
  281. matrix_mx_puppet_slack_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxslk.as.tok') | to_uuid }}"
  282. matrix_mx_puppet_slack_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxslk.hs.tok') | to_uuid }}"
  283. matrix_mx_puppet_slack_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
  284. ######################################################################
  285. #
  286. # /matrix-bridge-mx-puppet-slack
  287. #
  288. ######################################################################
  289. ######################################################################
  290. #
  291. # matrix-corporal
  292. #
  293. ######################################################################
  294. matrix_corporal_enabled: false
  295. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-corporal over the container network.
  296. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  297. # matrix-corporal's web-server ports to the local host.
  298. matrix_corporal_container_http_gateway_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:41080' }}"
  299. matrix_corporal_container_http_api_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:41081' }}"
  300. matrix_corporal_systemd_required_services_list: |
  301. {{
  302. (['docker.service'])
  303. +
  304. (['matrix-synapse.service'])
  305. }}
  306. matrix_corporal_matrix_homeserver_api_endpoint: "http://matrix-synapse:8008"
  307. matrix_corporal_matrix_auth_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret }}"
  308. matrix_corporal_matrix_registration_shared_secret: "{{ matrix_synapse_registration_shared_secret }}"
  309. ######################################################################
  310. #
  311. # /matrix-corporal
  312. #
  313. ######################################################################
  314. ######################################################################
  315. #
  316. # matrix-coturn
  317. #
  318. ######################################################################
  319. matrix_coturn_enabled: true
  320. matrix_coturn_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  321. matrix_coturn_turn_external_ip_address: "{{ ansible_host }}"
  322. matrix_coturn_tls_enabled: true
  323. matrix_coturn_tls_cert_path: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_server_fqn_matrix }}/fullchain.pem"
  324. matrix_coturn_tls_key_path: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_server_fqn_matrix }}/privkey.pem"
  325. matrix_coturn_container_additional_volumes:
  326. - src: "{{ matrix_ssl_config_dir_path }}"
  327. dst: "{{ matrix_ssl_config_dir_path }}"
  328. options: ro
  329. ######################################################################
  330. #
  331. # /matrix-coturn
  332. #
  333. ######################################################################
  334. ######################################################################
  335. #
  336. # matrix-dimension
  337. #
  338. ######################################################################
  339. matrix_dimension_enabled: false
  340. # Normally, matrix-nginx-proxy is enabled and nginx can reach Dimension over the container network.
  341. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  342. # the Dimension HTTP port to the local host.
  343. matrix_dimension_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8184' }}"
  344. matrix_integration_manager_rest_url: "{{ matrix_dimension_integrations_rest_url if matrix_dimension_enabled else None }}"
  345. matrix_integration_manager_ui_url: "{{ matrix_dimension_integrations_ui_url if matrix_dimension_enabled else None }}"
  346. matrix_dimension_homeserver_federationUrl: "http://matrix-synapse:{{ 8048 if matrix_synapse_federation_enabled|bool else 8008 }}"
  347. ######################################################################
  348. #
  349. # /matrix-dimension
  350. #
  351. ######################################################################
  352. ######################################################################
  353. #
  354. # matrix-email2matrix
  355. #
  356. ######################################################################
  357. matrix_email2matrix_enabled: false
  358. ######################################################################
  359. #
  360. # /matrix-email2matrix
  361. #
  362. ######################################################################
  363. ######################################################################
  364. #
  365. # matrix-jitsi
  366. #
  367. ######################################################################
  368. matrix_jitsi_enabled: false
  369. # Normally, matrix-nginx-proxy is enabled and nginx can reach jitsi/web over the container network.
  370. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  371. # the Jitsi HTTP port to the local host.
  372. matrix_jitsi_web_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:12080' }}"
  373. matrix_jitsi_jibri_xmpp_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'jibri') | to_uuid }}"
  374. matrix_jitsi_jicofo_auth_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'jicofo') | to_uuid }}"
  375. matrix_jitsi_jvb_auth_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'jvb') | to_uuid }}"
  376. matrix_jitsi_web_stun_servers: |
  377. {{
  378. [
  379. 'stun:' + matrix_server_fqn_matrix + ':5349',
  380. 'stun:' + matrix_server_fqn_matrix + ':3478',
  381. ]
  382. if matrix_coturn_enabled
  383. else [ 'stun:meet-jit-si-turnrelay.jitsi.net:443']
  384. }}
  385. ######################################################################
  386. #
  387. # /matrix-jitsi
  388. #
  389. ######################################################################
  390. ######################################################################
  391. #
  392. # matrix-mailer
  393. #
  394. ######################################################################
  395. # By default, this playbook sets up an exim mailer server (running in a container).
  396. # This is so that Synapse can send email reminders for unread messages.
  397. # Other services (like ma1sd), also use the mailer.
  398. matrix_mailer_enabled: true
  399. matrix_mailer_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  400. ######################################################################
  401. #
  402. # /matrix-mailer
  403. #
  404. ######################################################################
  405. ######################################################################
  406. #
  407. # matrix-ma1sd
  408. #
  409. ######################################################################
  410. # By default, this playbook installs the ma1sd identity server on the same domain as Synapse (`matrix_server_fqn_matrix`).
  411. # If you wish to use the public identity servers (matrix.org, vector.im) instead of your own you may wish to disable this.
  412. matrix_ma1sd_enabled: true
  413. matrix_ma1sd_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  414. # Normally, matrix-nginx-proxy is enabled and nginx can reach ma1sd over the container network.
  415. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  416. # ma1sd's web-server port.
  417. matrix_ma1sd_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8090' }}"
  418. # We enable Synapse integration via its Postgres database by default.
  419. # When using another Identity store, you might wish to disable this and define
  420. # your own configuration in `matrix_ma1sd_configuration_extension_yaml`.
  421. matrix_ma1sd_synapsesql_enabled: true
  422. matrix_ma1sd_synapsesql_type: postgresql
  423. matrix_ma1sd_synapsesql_connection: //{{ matrix_synapse_database_host }}/{{ matrix_synapse_database_database }}?user={{ matrix_synapse_database_user | urlencode() }}&password={{ matrix_synapse_database_password | urlencode() }}
  424. matrix_ma1sd_dns_overwrite_enabled: true
  425. matrix_ma1sd_dns_overwrite_homeserver_client_name: "{{ matrix_server_fqn_matrix }}"
  426. matrix_ma1sd_dns_overwrite_homeserver_client_value: "http://{{ 'matrix-corporal:41080' if matrix_corporal_enabled else 'matrix-synapse:8008' }}"
  427. # By default, we send mail through the `matrix-mailer` service.
  428. matrix_ma1sd_threepid_medium_email_identity_from: "{{ matrix_mailer_sender_address }}"
  429. matrix_ma1sd_threepid_medium_email_connectors_smtp_host: "matrix-mailer"
  430. matrix_ma1sd_threepid_medium_email_connectors_smtp_port: 8025
  431. matrix_ma1sd_threepid_medium_email_connectors_smtp_tls: 0
  432. matrix_ma1sd_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else false }}"
  433. matrix_ma1sd_systemd_wanted_services_list: |
  434. {{
  435. (['matrix-corporal.service'] if matrix_corporal_enabled else ['matrix-synapse.service'])
  436. +
  437. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  438. +
  439. (['matrix-mailer.service'] if matrix_mailer_enabled else [])
  440. }}
  441. ######################################################################
  442. #
  443. # /matrix-ma1sd
  444. #
  445. ######################################################################
  446. ######################################################################
  447. #
  448. # matrix-nginx-proxy
  449. #
  450. ######################################################################
  451. # By default, this playbook sets up a reverse-proxy nginx proxy server on TCP ports 80, 443 and 8448.
  452. # This is fine if you're dedicating the whole server to Matrix.
  453. # If that's not the case, you may wish to disable this and take care of proxying yourself.
  454. matrix_nginx_proxy_enabled: true
  455. matrix_nginx_proxy_proxy_matrix_client_api_addr_with_container: "{{ 'matrix-corporal:41080' if matrix_corporal_enabled else 'matrix-synapse:8008' }}"
  456. 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' }}"
  457. matrix_nginx_proxy_proxy_matrix_client_api_client_max_body_size_mb: "{{ matrix_synapse_max_upload_size_mb }}"
  458. matrix_nginx_proxy_proxy_matrix_enabled: true
  459. matrix_nginx_proxy_proxy_riot_enabled: "{{ matrix_riot_web_enabled }}"
  460. matrix_nginx_proxy_proxy_dimension_enabled: "{{ matrix_dimension_enabled }}"
  461. matrix_nginx_proxy_proxy_jitsi_enabled: "{{ matrix_jitsi_enabled }}"
  462. matrix_nginx_proxy_proxy_matrix_corporal_api_enabled: "{{ matrix_corporal_enabled and matrix_corporal_http_api_enabled }}"
  463. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_with_container: "matrix-corporal:41081"
  464. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_sans_container: "127.0.0.1:41081"
  465. matrix_nginx_proxy_proxy_matrix_identity_api_enabled: "{{ matrix_ma1sd_enabled }}"
  466. matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container: "matrix-ma1sd:8090"
  467. matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container: "127.0.0.1:8090"
  468. # By default, we do TLS termination for the Matrix Federation API (port 8448) at matrix-nginx-proxy.
  469. matrix_nginx_proxy_proxy_matrix_federation_api_enabled: true
  470. matrix_nginx_proxy_proxy_matrix_federation_api_addr_with_container: "matrix-synapse:8048"
  471. matrix_nginx_proxy_proxy_matrix_federation_api_addr_sans_container: "127.0.0.1:8048"
  472. matrix_nginx_proxy_container_federation_host_bind_port: "{{ matrix_federation_public_port }}"
  473. matrix_nginx_proxy_proxy_synapse_metrics: "{{ matrix_synapse_metrics_enabled }}"
  474. matrix_nginx_proxy_proxy_synapse_metrics_addr_with_container: "matrix-synapse:{{ matrix_synapse_metrics_port }}"
  475. matrix_nginx_proxy_proxy_synapse_metrics_addr_sans_container: "127.0.0.1:{{ matrix_synapse_metrics_port }}"
  476. # Not proxying the user directory search to the identity server by default anymore,
  477. # because it currently leaks data.
  478. # See: https://github.com/ma1uta/ma1sd/issues/44
  479. matrix_nginx_proxy_proxy_matrix_user_directory_search_enabled: false
  480. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_with_container: "{{ matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container }}"
  481. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_sans_container: "{{ matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container }}"
  482. matrix_nginx_proxy_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else false }}"
  483. matrix_nginx_proxy_systemd_wanted_services_list: |
  484. {{
  485. (['matrix-synapse.service'])
  486. +
  487. (['matrix-corporal.service'] if matrix_corporal_enabled else [])
  488. +
  489. (['matrix-ma1sd.service'] if matrix_ma1sd_enabled else [])
  490. +
  491. (['matrix-riot-web.service'] if matrix_riot_web_enabled else [])
  492. }}
  493. matrix_ssl_domains_to_obtain_certificates_for: |
  494. {{
  495. ([matrix_server_fqn_matrix])
  496. +
  497. ([matrix_server_fqn_riot] if matrix_riot_web_enabled else [])
  498. +
  499. ([matrix_server_fqn_dimension] if matrix_dimension_enabled else [])
  500. +
  501. ([matrix_server_fqn_jitsi] if matrix_jitsi_enabled else [])
  502. +
  503. ([matrix_domain] if matrix_nginx_proxy_base_domain_serving_enabled else [])
  504. }}
  505. matrix_ssl_architecture: "{{
  506. {
  507. 'amd64': 'amd64',
  508. 'arm32': 'arm32v6',
  509. 'arm64': 'arm64v8',
  510. }[matrix_architecture]
  511. }}"
  512. ######################################################################
  513. #
  514. # /matrix-nginx-proxy
  515. #
  516. ######################################################################
  517. ######################################################################
  518. #
  519. # matrix-postgres
  520. #
  521. ######################################################################
  522. matrix_postgres_enabled: true
  523. matrix_postgres_connection_hostname: "matrix-postgres"
  524. matrix_postgres_connection_username: "synapse"
  525. matrix_postgres_connection_password: "synapse-password"
  526. matrix_postgres_db_name: "homeserver"
  527. ######################################################################
  528. #
  529. # /matrix-postgres
  530. #
  531. ######################################################################
  532. ######################################################################
  533. #
  534. # matrix-riot-web
  535. #
  536. ######################################################################
  537. # By default, this playbook installs the Riot.IM web UI on the `matrix_server_fqn_riot` domain.
  538. # If you wish to connect to your Matrix server by other means, you may wish to disable this.
  539. matrix_riot_web_enabled: true
  540. matrix_riot_web_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  541. # Normally, matrix-nginx-proxy is enabled and nginx can reach riot-web over the container network.
  542. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  543. # the riot-web HTTP port to the local host.
  544. matrix_riot_web_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8765' }}"
  545. matrix_riot_web_default_hs_url: "{{ matrix_homeserver_url }}"
  546. matrix_riot_web_default_is_url: "{{ matrix_identity_server_url }}"
  547. # Use Dimension if enabled, otherwise fall back to Scalar
  548. matrix_riot_web_integrations_ui_url: "{{ matrix_dimension_integrations_ui_url if matrix_dimension_enabled else 'https://scalar.vector.im/' }}"
  549. matrix_riot_web_integrations_rest_url: "{{ matrix_dimension_integrations_rest_url if matrix_dimension_enabled else 'https://scalar.vector.im/api' }}"
  550. matrix_riot_web_integrations_widgets_urls: "{{ matrix_dimension_integrations_widgets_urls if matrix_dimension_enabled else ['https://scalar.vector.im/api'] }}"
  551. 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' }}"
  552. matrix_riot_web_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else false }}"
  553. matrix_riot_web_registration_enabled: "{{ matrix_synapse_enable_registration }}"
  554. matrix_riot_web_enable_presence_by_hs_url: |
  555. {{
  556. none
  557. if matrix_synapse_use_presence
  558. else {matrix_riot_web_default_hs_url: false}
  559. }}
  560. matrix_riot_web_welcome_user_id: ~
  561. matrix_riot_web_jitsi_preferredDomain: "{{ matrix_server_fqn_jitsi if matrix_jitsi_enabled else '' }}"
  562. ######################################################################
  563. #
  564. # /matrix-riot-web
  565. #
  566. ######################################################################
  567. ######################################################################
  568. #
  569. # matrix-synapse
  570. #
  571. ######################################################################
  572. matrix_synapse_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  573. # When ma1sd is enabled, we can use it instead of the default public Identity servers.
  574. matrix_synapse_trusted_third_party_id_servers: "{{ [matrix_server_fqn_matrix] if matrix_ma1sd_enabled else matrix_synapse_id_servers_public }}"
  575. # When ma1sd is enabled, we can use it to validate email addresses and phone numbers.
  576. # 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.
  577. matrix_synapse_account_threepid_delegates_email: "{{ 'http://matrix-ma1sd:8090' if matrix_ma1sd_enabled else '' }}"
  578. matrix_synapse_account_threepid_delegates_msisdn: "{{ 'http://matrix-ma1sd:8090' if matrix_ma1sd_enabled else '' }}"
  579. # Normally, matrix-nginx-proxy is enabled and nginx can reach Synapse over the container network.
  580. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it,
  581. # you can expose Synapse's ports to the host.
  582. #
  583. # For exposing the Matrix Client API's port (plain HTTP) to the local host.
  584. matrix_synapse_container_client_api_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8008' }}"
  585. #
  586. # For exposing the Matrix Federation API's plain port (plain HTTP) to the local host.
  587. matrix_synapse_container_federation_api_plain_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8048' }}"
  588. #
  589. # For exposing the Matrix Federation API's TLS port (HTTPS) to the internet on all network interfaces.
  590. matrix_synapse_container_federation_api_tls_host_bind_port: "{{ matrix_federation_public_port if (matrix_synapse_federation_enabled and matrix_synapse_tls_federation_listener_enabled) else '' }}"
  591. #
  592. # For exposing the Synapse Metrics API's port (plain HTTP) to the local host.
  593. 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 '' }}"
  594. #
  595. # For exposing the Synapse Manhole port (plain HTTP) to the local host.
  596. matrix_synapse_container_manhole_api_host_bind_port: "{{ '127.0.0.1:9000' if matrix_synapse_manhole_enabled else '' }}"
  597. matrix_synapse_database_host: "{{ matrix_postgres_connection_hostname }}"
  598. matrix_synapse_database_user: "{{ matrix_postgres_connection_username }}"
  599. matrix_synapse_database_password: "{{ matrix_postgres_connection_password }}"
  600. matrix_synapse_database_database: "{{ matrix_postgres_db_name }}"
  601. # We do not enable TLS in Synapse by default.
  602. # TLS is handled by the matrix-nginx-proxy, which proxies the requests to Synapse.
  603. matrix_synapse_tls_federation_listener_enabled: false
  604. matrix_synapse_tls_certificate_path: ~
  605. matrix_synapse_tls_private_key_path: ~
  606. matrix_synapse_http_listener_resource_names: |
  607. {{
  608. ["client"]
  609. +
  610. ( ["openid"] if matrix_dimension_enabled and not matrix_synapse_federation_enabled else [] )
  611. }}
  612. matrix_synapse_email_enabled: "{{ matrix_mailer_enabled }}"
  613. matrix_synapse_email_smtp_host: "matrix-mailer"
  614. matrix_synapse_email_smtp_port: 8025
  615. matrix_synapse_email_smtp_require_transport_security: false
  616. matrix_synapse_email_notif_from: "Matrix <{{ matrix_mailer_sender_address }}>"
  617. # Even if TURN doesn't support TLS (it does by default),
  618. # it doesn't hurt to try a secure connection anyway.
  619. matrix_synapse_turn_uris: |
  620. {{
  621. [
  622. 'turns:' + matrix_server_fqn_matrix + '?transport=udp',
  623. 'turns:' + matrix_server_fqn_matrix + '?transport=tcp',
  624. 'turn:' + matrix_server_fqn_matrix + '?transport=udp',
  625. 'turn:' + matrix_server_fqn_matrix + '?transport=tcp',
  626. ]
  627. if matrix_coturn_enabled
  628. else []
  629. }}
  630. matrix_synapse_turn_shared_secret: "{{ matrix_coturn_turn_static_auth_secret if matrix_coturn_enabled else '' }}"
  631. matrix_synapse_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else false }}"
  632. matrix_synapse_systemd_required_services_list: |
  633. {{
  634. (['docker.service'])
  635. +
  636. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  637. +
  638. (['matrix-goofys'] if matrix_s3_media_store_enabled else [])
  639. }}
  640. matrix_synapse_systemd_wanted_services_list: |
  641. {{
  642. (['matrix-coturn.service'] if matrix_coturn_enabled else [])
  643. +
  644. (['matrix-mailer.service'] if matrix_mailer_enabled else [])
  645. }}
  646. ######################################################################
  647. #
  648. # /matrix-synapse
  649. #
  650. ######################################################################