Matrix Docker Ansible eploy
Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.

904 строки
36 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-bridge-mx-puppet-instagram
  292. #
  293. ######################################################################
  294. # We don't enable bridges by default.
  295. matrix_mx_puppet_instagram_enabled: false
  296. matrix_mx_puppet_instagram_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  297. matrix_mx_puppet_instagram_systemd_required_services_list: |
  298. {{
  299. ['docker.service']
  300. +
  301. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  302. }}
  303. matrix_mx_puppet_instagram_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxig.as.tok') | to_uuid }}"
  304. matrix_mx_puppet_instagram_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxig.hs.tok') | to_uuid }}"
  305. matrix_mx_puppet_instagram_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
  306. ######################################################################
  307. #
  308. # /matrix-bridge-mx-puppet-instagram
  309. #
  310. ######################################################################
  311. ######################################################################
  312. #
  313. # matrix-corporal
  314. #
  315. ######################################################################
  316. matrix_corporal_enabled: false
  317. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-corporal over the container network.
  318. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  319. # matrix-corporal's web-server ports to the local host.
  320. matrix_corporal_container_http_gateway_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:41080' }}"
  321. matrix_corporal_container_http_api_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:41081' }}"
  322. matrix_corporal_systemd_required_services_list: |
  323. {{
  324. (['docker.service'])
  325. +
  326. (['matrix-synapse.service'])
  327. }}
  328. matrix_corporal_matrix_homeserver_api_endpoint: "http://matrix-synapse:8008"
  329. matrix_corporal_matrix_auth_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret }}"
  330. matrix_corporal_matrix_registration_shared_secret: "{{ matrix_synapse_registration_shared_secret }}"
  331. ######################################################################
  332. #
  333. # /matrix-corporal
  334. #
  335. ######################################################################
  336. ######################################################################
  337. #
  338. # matrix-coturn
  339. #
  340. ######################################################################
  341. matrix_coturn_enabled: true
  342. matrix_coturn_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  343. matrix_coturn_turn_external_ip_address: "{{ ansible_host }}"
  344. matrix_coturn_tls_enabled: true
  345. matrix_coturn_tls_cert_path: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_server_fqn_matrix }}/fullchain.pem"
  346. matrix_coturn_tls_key_path: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_server_fqn_matrix }}/privkey.pem"
  347. matrix_coturn_container_additional_volumes:
  348. - src: "{{ matrix_ssl_config_dir_path }}"
  349. dst: "{{ matrix_ssl_config_dir_path }}"
  350. options: ro
  351. ######################################################################
  352. #
  353. # /matrix-coturn
  354. #
  355. ######################################################################
  356. ######################################################################
  357. #
  358. # matrix-dimension
  359. #
  360. ######################################################################
  361. matrix_dimension_enabled: false
  362. # Normally, matrix-nginx-proxy is enabled and nginx can reach Dimension over the container network.
  363. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  364. # the Dimension HTTP port to the local host.
  365. matrix_dimension_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8184' }}"
  366. matrix_integration_manager_rest_url: "{{ matrix_dimension_integrations_rest_url if matrix_dimension_enabled else None }}"
  367. matrix_integration_manager_ui_url: "{{ matrix_dimension_integrations_ui_url if matrix_dimension_enabled else None }}"
  368. matrix_dimension_homeserver_federationUrl: "http://matrix-synapse:{{ 8048 if matrix_synapse_federation_enabled|bool else 8008 }}"
  369. ######################################################################
  370. #
  371. # /matrix-dimension
  372. #
  373. ######################################################################
  374. ######################################################################
  375. #
  376. # matrix-email2matrix
  377. #
  378. ######################################################################
  379. matrix_email2matrix_enabled: false
  380. ######################################################################
  381. #
  382. # /matrix-email2matrix
  383. #
  384. ######################################################################
  385. ######################################################################
  386. #
  387. # matrix-jitsi
  388. #
  389. ######################################################################
  390. matrix_jitsi_enabled: false
  391. # Normally, matrix-nginx-proxy is enabled and nginx can reach jitsi/web over the container network.
  392. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  393. # the Jitsi HTTP port to the local host.
  394. matrix_jitsi_web_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:12080' }}"
  395. matrix_jitsi_jibri_xmpp_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'jibri') | to_uuid }}"
  396. matrix_jitsi_jicofo_auth_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'jicofo') | to_uuid }}"
  397. matrix_jitsi_jvb_auth_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'jvb') | to_uuid }}"
  398. matrix_jitsi_web_stun_servers: |
  399. {{
  400. [
  401. 'stun:' + matrix_server_fqn_matrix + ':5349',
  402. 'stun:' + matrix_server_fqn_matrix + ':3478',
  403. ]
  404. if matrix_coturn_enabled
  405. else [ 'stun:meet-jit-si-turnrelay.jitsi.net:443']
  406. }}
  407. ######################################################################
  408. #
  409. # /matrix-jitsi
  410. #
  411. ######################################################################
  412. ######################################################################
  413. #
  414. # matrix-mailer
  415. #
  416. ######################################################################
  417. # By default, this playbook sets up an exim mailer server (running in a container).
  418. # This is so that Synapse can send email reminders for unread messages.
  419. # Other services (like ma1sd), also use the mailer.
  420. matrix_mailer_enabled: true
  421. matrix_mailer_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  422. ######################################################################
  423. #
  424. # /matrix-mailer
  425. #
  426. ######################################################################
  427. ######################################################################
  428. #
  429. # matrix-ma1sd
  430. #
  431. ######################################################################
  432. # By default, this playbook installs the ma1sd identity server on the same domain as Synapse (`matrix_server_fqn_matrix`).
  433. # If you wish to use the public identity servers (matrix.org, vector.im) instead of your own you may wish to disable this.
  434. matrix_ma1sd_enabled: true
  435. # There's no prebuilt ma1sd image for the `arm32` architecture.
  436. # We're relying on self-building there.
  437. matrix_ma1sd_architecture: "{{
  438. {
  439. 'amd64': 'amd64',
  440. 'arm32': 'arm32',
  441. 'arm64': 'arm64',
  442. }[matrix_architecture]
  443. }}"
  444. matrix_ma1sd_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  445. # Normally, matrix-nginx-proxy is enabled and nginx can reach ma1sd over the container network.
  446. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  447. # ma1sd's web-server port.
  448. matrix_ma1sd_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8090' }}"
  449. # We enable Synapse integration via its Postgres database by default.
  450. # When using another Identity store, you might wish to disable this and define
  451. # your own configuration in `matrix_ma1sd_configuration_extension_yaml`.
  452. matrix_ma1sd_synapsesql_enabled: true
  453. matrix_ma1sd_synapsesql_type: postgresql
  454. matrix_ma1sd_synapsesql_connection: //{{ matrix_synapse_database_host }}/{{ matrix_synapse_database_database }}?user={{ matrix_synapse_database_user | urlencode() }}&password={{ matrix_synapse_database_password | urlencode() }}
  455. matrix_ma1sd_dns_overwrite_enabled: true
  456. matrix_ma1sd_dns_overwrite_homeserver_client_name: "{{ matrix_server_fqn_matrix }}"
  457. matrix_ma1sd_dns_overwrite_homeserver_client_value: "http://{{ 'matrix-corporal:41080' if matrix_corporal_enabled else 'matrix-synapse:8008' }}"
  458. # By default, we send mail through the `matrix-mailer` service.
  459. matrix_ma1sd_threepid_medium_email_identity_from: "{{ matrix_mailer_sender_address }}"
  460. matrix_ma1sd_threepid_medium_email_connectors_smtp_host: "matrix-mailer"
  461. matrix_ma1sd_threepid_medium_email_connectors_smtp_port: 8025
  462. matrix_ma1sd_threepid_medium_email_connectors_smtp_tls: 0
  463. matrix_ma1sd_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else false }}"
  464. matrix_ma1sd_systemd_wanted_services_list: |
  465. {{
  466. (['matrix-corporal.service'] if matrix_corporal_enabled else ['matrix-synapse.service'])
  467. +
  468. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  469. +
  470. (['matrix-mailer.service'] if matrix_mailer_enabled else [])
  471. }}
  472. ######################################################################
  473. #
  474. # /matrix-ma1sd
  475. #
  476. ######################################################################
  477. ######################################################################
  478. #
  479. # matrix-nginx-proxy
  480. #
  481. ######################################################################
  482. # By default, this playbook sets up a reverse-proxy nginx proxy server on TCP ports 80, 443 and 8448.
  483. # This is fine if you're dedicating the whole server to Matrix.
  484. # If that's not the case, you may wish to disable this and take care of proxying yourself.
  485. matrix_nginx_proxy_enabled: true
  486. matrix_nginx_proxy_proxy_matrix_client_api_addr_with_container: "{{ 'matrix-corporal:41080' if matrix_corporal_enabled else 'matrix-synapse:8008' }}"
  487. 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' }}"
  488. matrix_nginx_proxy_proxy_matrix_client_api_client_max_body_size_mb: "{{ matrix_synapse_max_upload_size_mb }}"
  489. matrix_nginx_proxy_proxy_matrix_enabled: true
  490. matrix_nginx_proxy_proxy_riot_enabled: "{{ matrix_riot_web_enabled }}"
  491. matrix_nginx_proxy_proxy_dimension_enabled: "{{ matrix_dimension_enabled }}"
  492. matrix_nginx_proxy_proxy_jitsi_enabled: "{{ matrix_jitsi_enabled }}"
  493. matrix_nginx_proxy_proxy_matrix_corporal_api_enabled: "{{ matrix_corporal_enabled and matrix_corporal_http_api_enabled }}"
  494. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_with_container: "matrix-corporal:41081"
  495. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_sans_container: "127.0.0.1:41081"
  496. matrix_nginx_proxy_proxy_matrix_identity_api_enabled: "{{ matrix_ma1sd_enabled }}"
  497. matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container: "matrix-ma1sd:8090"
  498. matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container: "127.0.0.1:8090"
  499. # By default, we do TLS termination for the Matrix Federation API (port 8448) at matrix-nginx-proxy.
  500. matrix_nginx_proxy_proxy_matrix_federation_api_enabled: true
  501. matrix_nginx_proxy_proxy_matrix_federation_api_addr_with_container: "matrix-synapse:8048"
  502. matrix_nginx_proxy_proxy_matrix_federation_api_addr_sans_container: "127.0.0.1:8048"
  503. matrix_nginx_proxy_container_federation_host_bind_port: "{{ matrix_federation_public_port }}"
  504. matrix_nginx_proxy_proxy_synapse_metrics: "{{ matrix_synapse_metrics_enabled }}"
  505. matrix_nginx_proxy_proxy_synapse_metrics_addr_with_container: "matrix-synapse:{{ matrix_synapse_metrics_port }}"
  506. matrix_nginx_proxy_proxy_synapse_metrics_addr_sans_container: "127.0.0.1:{{ matrix_synapse_metrics_port }}"
  507. matrix_nginx_proxy_proxy_matrix_user_directory_search_enabled: "{{ matrix_ma1sd_enabled }}"
  508. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_with_container: "{{ matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container }}"
  509. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_sans_container: "{{ matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container }}"
  510. matrix_nginx_proxy_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else false }}"
  511. matrix_nginx_proxy_systemd_wanted_services_list: |
  512. {{
  513. (['matrix-synapse.service'])
  514. +
  515. (['matrix-corporal.service'] if matrix_corporal_enabled else [])
  516. +
  517. (['matrix-ma1sd.service'] if matrix_ma1sd_enabled else [])
  518. +
  519. (['matrix-riot-web.service'] if matrix_riot_web_enabled else [])
  520. }}
  521. matrix_ssl_domains_to_obtain_certificates_for: |
  522. {{
  523. ([matrix_server_fqn_matrix])
  524. +
  525. ([matrix_server_fqn_riot] if matrix_riot_web_enabled else [])
  526. +
  527. ([matrix_server_fqn_dimension] if matrix_dimension_enabled else [])
  528. +
  529. ([matrix_server_fqn_jitsi] if matrix_jitsi_enabled else [])
  530. +
  531. ([matrix_domain] if matrix_nginx_proxy_base_domain_serving_enabled else [])
  532. }}
  533. matrix_ssl_architecture: "{{
  534. {
  535. 'amd64': 'amd64',
  536. 'arm32': 'arm32v6',
  537. 'arm64': 'arm64v8',
  538. }[matrix_architecture]
  539. }}"
  540. ######################################################################
  541. #
  542. # /matrix-nginx-proxy
  543. #
  544. ######################################################################
  545. ######################################################################
  546. #
  547. # matrix-postgres
  548. #
  549. ######################################################################
  550. matrix_postgres_enabled: true
  551. matrix_postgres_connection_hostname: "matrix-postgres"
  552. matrix_postgres_connection_username: "synapse"
  553. matrix_postgres_connection_password: "synapse-password"
  554. matrix_postgres_db_name: "homeserver"
  555. ######################################################################
  556. #
  557. # /matrix-postgres
  558. #
  559. ######################################################################
  560. ######################################################################
  561. #
  562. # matrix-riot-web
  563. #
  564. ######################################################################
  565. # By default, this playbook installs the Riot.IM web UI on the `matrix_server_fqn_riot` domain.
  566. # If you wish to connect to your Matrix server by other means, you may wish to disable this.
  567. matrix_riot_web_enabled: true
  568. matrix_riot_web_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  569. # Normally, matrix-nginx-proxy is enabled and nginx can reach riot-web over the container network.
  570. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  571. # the riot-web HTTP port to the local host.
  572. matrix_riot_web_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8765' }}"
  573. matrix_riot_web_default_hs_url: "{{ matrix_homeserver_url }}"
  574. matrix_riot_web_default_is_url: "{{ matrix_identity_server_url }}"
  575. # Use Dimension if enabled, otherwise fall back to Scalar
  576. matrix_riot_web_integrations_ui_url: "{{ matrix_dimension_integrations_ui_url if matrix_dimension_enabled else 'https://scalar.vector.im/' }}"
  577. matrix_riot_web_integrations_rest_url: "{{ matrix_dimension_integrations_rest_url if matrix_dimension_enabled else 'https://scalar.vector.im/api' }}"
  578. matrix_riot_web_integrations_widgets_urls: "{{ matrix_dimension_integrations_widgets_urls if matrix_dimension_enabled else ['https://scalar.vector.im/api'] }}"
  579. 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' }}"
  580. matrix_riot_web_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else false }}"
  581. matrix_riot_web_registration_enabled: "{{ matrix_synapse_enable_registration }}"
  582. matrix_riot_web_enable_presence_by_hs_url: |
  583. {{
  584. none
  585. if matrix_synapse_use_presence
  586. else {matrix_riot_web_default_hs_url: false}
  587. }}
  588. matrix_riot_web_welcome_user_id: ~
  589. matrix_riot_web_jitsi_preferredDomain: "{{ matrix_server_fqn_jitsi if matrix_jitsi_enabled else '' }}"
  590. ######################################################################
  591. #
  592. # /matrix-riot-web
  593. #
  594. ######################################################################
  595. ######################################################################
  596. #
  597. # matrix-synapse
  598. #
  599. ######################################################################
  600. matrix_synapse_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  601. # When ma1sd is enabled, we can use it instead of the default public Identity servers.
  602. matrix_synapse_trusted_third_party_id_servers: "{{ [matrix_server_fqn_matrix] if matrix_ma1sd_enabled else matrix_synapse_id_servers_public }}"
  603. # When ma1sd is enabled, we can use it to validate email addresses and phone numbers.
  604. # 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.
  605. matrix_synapse_account_threepid_delegates_email: "{{ 'http://matrix-ma1sd:8090' if matrix_ma1sd_enabled else '' }}"
  606. matrix_synapse_account_threepid_delegates_msisdn: "{{ 'http://matrix-ma1sd:8090' if matrix_ma1sd_enabled else '' }}"
  607. # Normally, matrix-nginx-proxy is enabled and nginx can reach Synapse over the container network.
  608. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it,
  609. # you can expose Synapse's ports to the host.
  610. #
  611. # For exposing the Matrix Client API's port (plain HTTP) to the local host.
  612. matrix_synapse_container_client_api_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8008' }}"
  613. #
  614. # For exposing the Matrix Federation API's plain port (plain HTTP) to the local host.
  615. matrix_synapse_container_federation_api_plain_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8048' }}"
  616. #
  617. # For exposing the Matrix Federation API's TLS port (HTTPS) to the internet on all network interfaces.
  618. 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 '' }}"
  619. #
  620. # For exposing the Synapse Metrics API's port (plain HTTP) to the local host.
  621. 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 '' }}"
  622. #
  623. # For exposing the Synapse Manhole port (plain HTTP) to the local host.
  624. matrix_synapse_container_manhole_api_host_bind_port: "{{ '127.0.0.1:9000' if matrix_synapse_manhole_enabled else '' }}"
  625. matrix_synapse_database_host: "{{ matrix_postgres_connection_hostname }}"
  626. matrix_synapse_database_user: "{{ matrix_postgres_connection_username }}"
  627. matrix_synapse_database_password: "{{ matrix_postgres_connection_password }}"
  628. matrix_synapse_database_database: "{{ matrix_postgres_db_name }}"
  629. # We do not enable TLS in Synapse by default.
  630. # TLS is handled by the matrix-nginx-proxy, which proxies the requests to Synapse.
  631. matrix_synapse_tls_federation_listener_enabled: false
  632. matrix_synapse_tls_certificate_path: ~
  633. matrix_synapse_tls_private_key_path: ~
  634. matrix_synapse_http_listener_resource_names: |
  635. {{
  636. ["client"]
  637. +
  638. ( ["openid"] if matrix_dimension_enabled and not matrix_synapse_federation_enabled else [] )
  639. }}
  640. matrix_synapse_email_enabled: "{{ matrix_mailer_enabled }}"
  641. matrix_synapse_email_smtp_host: "matrix-mailer"
  642. matrix_synapse_email_smtp_port: 8025
  643. matrix_synapse_email_smtp_require_transport_security: false
  644. matrix_synapse_email_notif_from: "Matrix <{{ matrix_mailer_sender_address }}>"
  645. # Even if TURN doesn't support TLS (it does by default),
  646. # it doesn't hurt to try a secure connection anyway.
  647. matrix_synapse_turn_uris: |
  648. {{
  649. [
  650. 'turns:' + matrix_server_fqn_matrix + '?transport=udp',
  651. 'turns:' + matrix_server_fqn_matrix + '?transport=tcp',
  652. 'turn:' + matrix_server_fqn_matrix + '?transport=udp',
  653. 'turn:' + matrix_server_fqn_matrix + '?transport=tcp',
  654. ]
  655. if matrix_coturn_enabled
  656. else []
  657. }}
  658. matrix_synapse_turn_shared_secret: "{{ matrix_coturn_turn_static_auth_secret if matrix_coturn_enabled else '' }}"
  659. matrix_synapse_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else false }}"
  660. matrix_synapse_systemd_required_services_list: |
  661. {{
  662. (['docker.service'])
  663. +
  664. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  665. +
  666. (['matrix-goofys'] if matrix_s3_media_store_enabled else [])
  667. }}
  668. matrix_synapse_systemd_wanted_services_list: |
  669. {{
  670. (['matrix-coturn.service'] if matrix_coturn_enabled else [])
  671. +
  672. (['matrix-mailer.service'] if matrix_mailer_enabled else [])
  673. }}
  674. ######################################################################
  675. #
  676. # /matrix-synapse
  677. #
  678. ######################################################################