Matrix Docker Ansible eploy
Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.
 
 

738 lignes
30 KiB

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