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.

1959 lines
84 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. matrix_container_global_registry_prefix: "docker.io/"
  11. ######################################################################
  12. #
  13. # matrix-base
  14. #
  15. ######################################################################
  16. matrix_identity_server_url: "{{ ('https://' + matrix_server_fqn_matrix) if matrix_ma1sd_enabled else None }}"
  17. # If Synapse workers are enabled and matrix-nginx-proxy is disabled, certain APIs may not work over 'http://matrix-synapse:8008'.
  18. # This is because we explicitly disable them for the main Synapse process.
  19. matrix_homeserver_container_url: "{{ 'http://matrix-nginx-proxy:12080' if matrix_nginx_proxy_enabled else 'http://matrix-synapse:8008' }}"
  20. ######################################################################
  21. #
  22. # /matrix-base
  23. #
  24. ######################################################################
  25. ######################################################################
  26. #
  27. # matrix-awx
  28. #
  29. ######################################################################
  30. # We don't enable AWX support by default.
  31. matrix_awx_enabled: false
  32. matrix_nginx_proxy_data_path: "{{ '/chroot/website' if (matrix_awx_enabled and not matrix_nginx_proxy_base_domain_homepage_enabled) else (matrix_nginx_proxy_base_path + '/data') }}"
  33. matrix_nginx_proxy_data_path_in_container: "{{ '/nginx-data/matrix-domain' if (matrix_awx_enabled and not matrix_nginx_proxy_base_domain_homepage_enabled) else '/nginx-data' }}"
  34. matrix_nginx_proxy_data_path_extension: "{{ '' if (matrix_awx_enabled and not matrix_nginx_proxy_base_domain_homepage_enabled) else '/matrix-domain' }}"
  35. matrix_nginx_proxy_base_domain_create_directory: "{{ not matrix_awx_enabled }}"
  36. ######################################################################
  37. #
  38. # /matrix-awx
  39. #
  40. ######################################################################
  41. ######################################################################
  42. #
  43. # matrix-bridge-appservice-discord
  44. #
  45. ######################################################################
  46. # We don't enable bridges by default.
  47. matrix_appservice_discord_enabled: false
  48. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-discord over the container network.
  49. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  50. # matrix-appservice-discord's client-server port to the local host.
  51. matrix_appservice_discord_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9005' }}"
  52. # If the homeserver disables presence, it's likely better (less wasteful) to also disable presence on the bridge side.
  53. matrix_appservice_discord_bridge_disablePresence: "{{ not matrix_synapse_presence_enabled }}"
  54. matrix_appservice_discord_systemd_required_services_list: |
  55. {{
  56. ['docker.service']
  57. +
  58. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  59. +
  60. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  61. +
  62. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  63. }}
  64. matrix_appservice_discord_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'discord.as.token') | to_uuid }}"
  65. matrix_appservice_discord_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'discord.hs.token') | to_uuid }}"
  66. # We only make this use Postgres if our own Postgres server is enabled.
  67. # It's only then (for now) that we can automatically create the necessary database and user for this service.
  68. matrix_appservice_discord_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  69. matrix_appservice_discord_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'as.discord.db') | to_uuid }}"
  70. ######################################################################
  71. #
  72. # /matrix-bridge-appservice-discord
  73. #
  74. ######################################################################
  75. ######################################################################
  76. #
  77. # matrix-appservice-webhooks
  78. #
  79. ######################################################################
  80. # We don't enable bridges by default.
  81. matrix_appservice_webhooks_enabled: false
  82. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-webhooks over the container network.
  83. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  84. # matrix-appservice-webhooks' client-server port to the local host.
  85. matrix_appservice_webhooks_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else ('127.0.0.1:' ~ matrix_appservice_webhooks_matrix_port) }}"
  86. matrix_appservice_webhooks_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'webhook.as.token') | to_uuid }}"
  87. matrix_appservice_webhooks_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'webhook.hs.token') | to_uuid }}"
  88. matrix_appservice_webhooks_id_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'webhook.id.token') | to_uuid }}"
  89. matrix_appservice_webhooks_systemd_required_services_list: |
  90. {{
  91. ['docker.service']
  92. +
  93. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  94. +
  95. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  96. }}
  97. ######################################################################
  98. #
  99. # /matrix-appservice-webhooks
  100. #
  101. ######################################################################
  102. ######################################################################
  103. #
  104. # matrix-appservice-slack
  105. #
  106. ######################################################################
  107. # We don't enable bridges by default.
  108. matrix_appservice_slack_enabled: false
  109. matrix_appservice_slack_container_self_build: "{{ matrix_architecture != 'amd64' }}"
  110. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-slack over the container network.
  111. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  112. # matrix-appservice-slack's client-server port to the local host.
  113. matrix_appservice_slack_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else ('127.0.0.1:' ~ matrix_appservice_slack_slack_port) }}"
  114. matrix_appservice_slack_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'slack.as.token') | to_uuid }}"
  115. matrix_appservice_slack_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'slack.hs.token') | to_uuid }}"
  116. matrix_appservice_slack_id_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'slack.id.token') | to_uuid }}"
  117. matrix_appservice_slack_systemd_required_services_list: |
  118. {{
  119. ['docker.service']
  120. +
  121. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  122. +
  123. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  124. }}
  125. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  126. matrix_appservice_slack_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'nedb' }}"
  127. matrix_appservice_slack_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'as.slack.db') | to_uuid }}"
  128. ######################################################################
  129. #
  130. # /matrix-bridge-appservice-slack
  131. #
  132. ######################################################################
  133. ######################################################################
  134. #
  135. # matrix-bridge-appservice-irc
  136. #
  137. ######################################################################
  138. # We don't enable bridges by default.
  139. matrix_appservice_irc_enabled: false
  140. matrix_appservice_irc_container_self_build: "{{ matrix_architecture != 'amd64' }}"
  141. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-irc over the container network.
  142. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  143. # matrix-appservice-irc's client-server port to the local host.
  144. matrix_appservice_irc_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9999' }}"
  145. # The IRC bridge docs say that if homeserver presence is disabled, it's better to also disable
  146. # IRC bridge presence, for performance reasons.
  147. matrix_appservice_irc_homeserver_enablePresence: "{{ matrix_synapse_presence_enabled }}"
  148. matrix_appservice_irc_systemd_required_services_list: |
  149. {{
  150. ['docker.service']
  151. +
  152. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  153. +
  154. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  155. }}
  156. matrix_appservice_irc_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'irc.as.token') | to_uuid }}"
  157. matrix_appservice_irc_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'irc.hs.token') | to_uuid }}"
  158. matrix_appservice_irc_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'nedb' }}"
  159. matrix_appservice_irc_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'as.irc.db') | to_uuid }}"
  160. ######################################################################
  161. #
  162. # /matrix-bridge-appservice-irc
  163. #
  164. ######################################################################
  165. ######################################################################
  166. #
  167. # matrix-bridge-beeper-linkedin
  168. #
  169. ######################################################################
  170. # We don't enable bridges by default.
  171. matrix_beeper_linkedin_enabled: false
  172. matrix_beeper_linkedin_systemd_required_services_list: |
  173. {{
  174. ['docker.service']
  175. +
  176. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  177. +
  178. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  179. +
  180. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  181. }}
  182. matrix_beeper_linkedin_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'linked.as.token') | to_uuid }}"
  183. matrix_beeper_linkedin_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'linked.hs.token') | to_uuid }}"
  184. matrix_beeper_linkedin_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
  185. matrix_beeper_linkedin_bridge_presence: "{{ matrix_synapse_presence_enabled if matrix_synapse_enabled else true }}"
  186. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  187. matrix_beeper_linkedin_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  188. matrix_beeper_linkedin_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'maulinkedin.db') | to_uuid }}"
  189. ######################################################################
  190. #
  191. # /matrix-bridge-beeper-linkedin
  192. #
  193. ######################################################################
  194. ######################################################################
  195. #
  196. # matrix-bridge-mautrix-facebook
  197. #
  198. ######################################################################
  199. # We don't enable bridges by default.
  200. matrix_mautrix_facebook_enabled: false
  201. matrix_mautrix_facebook_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  202. matrix_mautrix_facebook_systemd_required_services_list: |
  203. {{
  204. ['docker.service']
  205. +
  206. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  207. +
  208. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  209. +
  210. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  211. }}
  212. matrix_mautrix_facebook_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'fb.as.token') | to_uuid }}"
  213. matrix_mautrix_facebook_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'fb.hs.token') | to_uuid }}"
  214. 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 '' }}"
  215. matrix_mautrix_facebook_bridge_presence: "{{ matrix_synapse_presence_enabled if matrix_synapse_enabled else true }}"
  216. # We'd like to force-set people with external Postgres to SQLite, so the bridge role can complain
  217. # and point them to a migration path.
  218. matrix_mautrix_facebook_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  219. matrix_mautrix_facebook_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mau.fb.db') | to_uuid }}"
  220. ######################################################################
  221. #
  222. # /matrix-bridge-mautrix-facebook
  223. #
  224. ######################################################################
  225. ######################################################################
  226. #
  227. # matrix-bridge-mautrix-hangouts
  228. #
  229. ######################################################################
  230. # We don't enable bridges by default.
  231. matrix_mautrix_hangouts_enabled: false
  232. matrix_mautrix_hangouts_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  233. matrix_mautrix_hangouts_systemd_required_services_list: |
  234. {{
  235. ['docker.service']
  236. +
  237. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  238. +
  239. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  240. +
  241. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  242. }}
  243. matrix_mautrix_hangouts_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'ho.as.token') | to_uuid }}"
  244. matrix_mautrix_hangouts_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'ho.hs.token') | to_uuid }}"
  245. matrix_mautrix_hangouts_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9007' }}"
  246. 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 '' }}"
  247. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  248. matrix_mautrix_hangouts_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  249. matrix_mautrix_hangouts_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mau.hangouts.db') | to_uuid }}"
  250. ######################################################################
  251. #
  252. # /matrix-bridge-mautrix-hangouts
  253. #
  254. ######################################################################
  255. ######################################################################
  256. #
  257. # matrix-bridge-mautrix-instagram
  258. #
  259. ######################################################################
  260. # We don't enable bridges by default.
  261. matrix_mautrix_instagram_enabled: false
  262. matrix_mautrix_instagram_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  263. matrix_mautrix_instagram_systemd_required_services_list: |
  264. {{
  265. ['docker.service']
  266. +
  267. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  268. +
  269. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  270. +
  271. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  272. }}
  273. matrix_mautrix_instagram_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'ig.as.token') | to_uuid }}"
  274. matrix_mautrix_instagram_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'ig.hs.token') | to_uuid }}"
  275. matrix_mautrix_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 '' }}"
  276. matrix_mautrix_instagram_bridge_presence: "{{ matrix_synapse_presence_enabled if matrix_synapse_enabled else true }}"
  277. # We'd like to force-set people with external Postgres to SQLite, so the bridge role can complain
  278. # and point them to a migration path.
  279. matrix_mautrix_instagram_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  280. matrix_mautrix_instagram_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mau.ig.db') | to_uuid }}"
  281. ######################################################################
  282. #
  283. # /matrix-bridge-mautrix-instagram
  284. #
  285. ######################################################################
  286. ######################################################################
  287. #
  288. # matrix-bridge-mautrix-signal
  289. #
  290. ######################################################################
  291. # We don't enable bridges by default.
  292. matrix_mautrix_signal_enabled: false
  293. matrix_mautrix_signal_systemd_required_services_list: |
  294. {{
  295. ['docker.service']
  296. +
  297. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  298. +
  299. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  300. +
  301. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  302. +
  303. ['matrix-mautrix-signal-daemon.service']
  304. }}
  305. matrix_mautrix_signal_homeserver_domain: '{{ matrix_domain }}'
  306. matrix_mautrix_signal_homeserver_address: "{{ matrix_homeserver_container_url }}"
  307. matrix_mautrix_signal_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'si.hs.token') | to_uuid }}"
  308. matrix_mautrix_signal_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'si.as.token') | to_uuid }}"
  309. matrix_mautrix_signal_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
  310. matrix_mautrix_signal_database_engine: 'postgres'
  311. matrix_mautrix_signal_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mau.signal.db') | to_uuid }}"
  312. matrix_mautrix_signal_container_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  313. matrix_mautrix_signal_daemon_container_self_build: "{{ matrix_architecture != 'amd64' }}"
  314. ######################################################################
  315. #
  316. # /matrix-bridge-mautrix-signal
  317. #
  318. ######################################################################
  319. ######################################################################
  320. #
  321. # matrix-bridge-mautrix-telegram
  322. #
  323. ######################################################################
  324. # We don't enable bridges by default.
  325. matrix_mautrix_telegram_enabled: false
  326. # Images are multi-arch (amd64 and arm64, but not arm32).
  327. matrix_mautrix_telegram_container_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  328. matrix_telegram_lottieconverter_container_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  329. matrix_telegram_lottieconverter_container_self_build_mask_arch: "{{ matrix_architecture != 'amd64' }}"
  330. matrix_mautrix_telegram_systemd_required_services_list: |
  331. {{
  332. ['docker.service']
  333. +
  334. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  335. +
  336. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  337. +
  338. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  339. }}
  340. matrix_mautrix_telegram_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'telegr.as.token') | to_uuid }}"
  341. matrix_mautrix_telegram_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'telegr.hs.token') | to_uuid }}"
  342. matrix_mautrix_telegram_public_endpoint: "/{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'telegram') | to_uuid }}"
  343. matrix_mautrix_telegram_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9006' }}"
  344. 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 '' }}"
  345. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  346. matrix_mautrix_telegram_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  347. matrix_mautrix_telegram_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mau.telegram.db') | to_uuid }}"
  348. ######################################################################
  349. #
  350. # /matrix-bridge-mautrix-telegram
  351. #
  352. ######################################################################
  353. ######################################################################
  354. #
  355. # matrix-bridge-mautrix-whatsapp
  356. #
  357. ######################################################################
  358. # We don't enable bridges by default.
  359. matrix_mautrix_whatsapp_enabled: false
  360. matrix_mautrix_whatsapp_systemd_required_services_list: |
  361. {{
  362. ['docker.service']
  363. +
  364. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  365. +
  366. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  367. +
  368. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  369. }}
  370. matrix_mautrix_whatsapp_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'whats.as.token') | to_uuid }}"
  371. matrix_mautrix_whatsapp_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'whats.hs.token') | to_uuid }}"
  372. 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 '' }}"
  373. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  374. matrix_mautrix_whatsapp_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  375. matrix_mautrix_whatsapp_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mauwhatsapp.db') | to_uuid }}"
  376. ######################################################################
  377. #
  378. # /matrix-bridge-mautrix-whatsapp
  379. #
  380. ######################################################################
  381. ######################################################################
  382. #
  383. # matrix-sms-bridge
  384. #
  385. ######################################################################
  386. # We don't enable bridges by default.
  387. matrix_sms_bridge_enabled: false
  388. matrix_sms_bridge_systemd_required_services_list: |
  389. {{
  390. ['docker.service']
  391. +
  392. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  393. +
  394. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  395. }}
  396. matrix_sms_bridge_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'sms.as.token') | to_uuid }}"
  397. matrix_sms_bridge_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'sms.hs.token') | to_uuid }}"
  398. ######################################################################
  399. #
  400. # /matrix-sms-bridge
  401. #
  402. ######################################################################
  403. ######################################################################
  404. #
  405. # matrix-bridge-heisenbridge
  406. #
  407. ######################################################################
  408. # We don't enable bridges by default.
  409. matrix_heisenbridge_enabled: false
  410. matrix_heisenbridge_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'heisen.as.tok') | to_uuid }}"
  411. matrix_heisenbridge_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'heisen.hs.tok') | to_uuid }}"
  412. matrix_heisenbridge_systemd_wanted_services_list: |
  413. {{
  414. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  415. +
  416. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  417. }}
  418. ######################################################################
  419. #
  420. # /matrix-bridge-heisenbridge
  421. #
  422. ######################################################################
  423. ######################################################################
  424. #
  425. # matrix-bridge-mx-puppet-skype
  426. #
  427. ######################################################################
  428. # We don't enable bridges by default.
  429. matrix_mx_puppet_skype_enabled: false
  430. matrix_mx_puppet_skype_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  431. matrix_mx_puppet_skype_systemd_required_services_list: |
  432. {{
  433. ['docker.service']
  434. +
  435. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  436. +
  437. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  438. +
  439. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  440. }}
  441. matrix_mx_puppet_skype_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'skype.as.tok') | to_uuid }}"
  442. matrix_mx_puppet_skype_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'skype.hs.tok') | to_uuid }}"
  443. 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 '' }}"
  444. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  445. matrix_mx_puppet_skype_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  446. matrix_mx_puppet_skype_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxpup.skype.db') | to_uuid }}"
  447. ######################################################################
  448. #
  449. # /matrix-bridge-mx-puppet-skype
  450. #
  451. ######################################################################
  452. ######################################################################
  453. #
  454. # matrix-bridge-mx-puppet-slack
  455. #
  456. ######################################################################
  457. # We don't enable bridges by default.
  458. matrix_mx_puppet_slack_enabled: false
  459. matrix_mx_puppet_slack_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  460. matrix_mx_puppet_slack_systemd_required_services_list: |
  461. {{
  462. ['docker.service']
  463. +
  464. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  465. +
  466. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  467. +
  468. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  469. }}
  470. matrix_mx_puppet_slack_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxslk.as.tok') | to_uuid }}"
  471. matrix_mx_puppet_slack_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxslk.hs.tok') | to_uuid }}"
  472. 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 '' }}"
  473. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  474. matrix_mx_puppet_slack_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  475. matrix_mx_puppet_slack_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxpup.slack.db') | to_uuid }}"
  476. ######################################################################
  477. #
  478. # /matrix-bridge-mx-puppet-slack
  479. #
  480. ######################################################################
  481. ######################################################################
  482. #
  483. # matrix-bridge-mx-puppet-twitter
  484. #
  485. ######################################################################
  486. # We don't enable bridges by default.
  487. matrix_mx_puppet_twitter_enabled: false
  488. matrix_mx_puppet_twitter_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  489. matrix_mx_puppet_twitter_systemd_required_services_list: |
  490. {{
  491. ['docker.service']
  492. +
  493. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  494. +
  495. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  496. +
  497. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  498. }}
  499. matrix_mx_puppet_twitter_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxtwt.as.tok') | to_uuid }}"
  500. matrix_mx_puppet_twitter_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxtwt.hs.tok') | to_uuid }}"
  501. matrix_mx_puppet_twitter_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
  502. matrix_mx_puppet_twitter_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else ('127.0.0.1:' ~ matrix_mx_puppet_twitter_appservice_port) }}"
  503. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  504. matrix_mx_puppet_twitter_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  505. matrix_mx_puppet_twitter_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxpup.twitter.db') | to_uuid }}"
  506. ######################################################################
  507. #
  508. # /matrix-bridge-mx-puppet-twitter
  509. #
  510. ######################################################################
  511. ######################################################################
  512. #
  513. # matrix-bridge-mx-puppet-instagram
  514. #
  515. ######################################################################
  516. # We don't enable bridges by default.
  517. matrix_mx_puppet_instagram_enabled: false
  518. matrix_mx_puppet_instagram_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  519. matrix_mx_puppet_instagram_systemd_required_services_list: |
  520. {{
  521. ['docker.service']
  522. +
  523. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  524. +
  525. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  526. +
  527. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  528. }}
  529. matrix_mx_puppet_instagram_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxig.as.tok') | to_uuid }}"
  530. matrix_mx_puppet_instagram_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxig.hs.tok') | to_uuid }}"
  531. 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 '' }}"
  532. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  533. matrix_mx_puppet_instagram_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  534. matrix_mx_puppet_instagram_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxpup.ig.db') | to_uuid }}"
  535. ######################################################################
  536. #
  537. # /matrix-bridge-mx-puppet-instagram
  538. #
  539. ######################################################################
  540. ######################################################################
  541. #
  542. # matrix-bridge-mx-puppet-discord
  543. #
  544. ######################################################################
  545. # We don't enable bridges by default.
  546. matrix_mx_puppet_discord_enabled: false
  547. matrix_mx_puppet_discord_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  548. matrix_mx_puppet_discord_systemd_required_services_list: |
  549. {{
  550. ['docker.service']
  551. +
  552. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  553. +
  554. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  555. +
  556. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  557. }}
  558. matrix_mx_puppet_discord_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxdsc.as.tok') | to_uuid }}"
  559. matrix_mx_puppet_discord_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxdsc.hs.tok') | to_uuid }}"
  560. matrix_mx_puppet_discord_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
  561. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  562. matrix_mx_puppet_discord_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  563. matrix_mx_puppet_discord_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxpup.dsc.db') | to_uuid }}"
  564. ######################################################################
  565. #
  566. # /matrix-bridge-mx-puppet-discord
  567. #
  568. ######################################################################
  569. ######################################################################
  570. #
  571. # matrix-bridge-mx-puppet-steam
  572. #
  573. ######################################################################
  574. # We don't enable bridges by default.
  575. matrix_mx_puppet_steam_enabled: false
  576. matrix_mx_puppet_steam_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  577. matrix_mx_puppet_steam_systemd_required_services_list: |
  578. {{
  579. ['docker.service']
  580. +
  581. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  582. +
  583. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  584. +
  585. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  586. }}
  587. matrix_mx_puppet_steam_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxste.as.tok') | to_uuid }}"
  588. matrix_mx_puppet_steam_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxste.hs.tok') | to_uuid }}"
  589. matrix_mx_puppet_steam_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
  590. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  591. matrix_mx_puppet_steam_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  592. matrix_mx_puppet_steam_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxpup.steam.db') | to_uuid }}"
  593. ######################################################################
  594. #
  595. # /matrix-bridge-mx-puppet-steam
  596. #
  597. ######################################################################
  598. ######################################################################
  599. #
  600. # matrix-bridge-mx-puppet-groupme
  601. #
  602. ######################################################################
  603. # We don't enable bridges by default.
  604. matrix_mx_puppet_groupme_enabled: false
  605. matrix_mx_puppet_groupme_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  606. matrix_mx_puppet_groupme_systemd_required_services_list: |
  607. {{
  608. ['docker.service']
  609. +
  610. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  611. +
  612. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  613. +
  614. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  615. }}
  616. matrix_mx_puppet_groupme_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxgro.as.tok') | to_uuid }}"
  617. matrix_mx_puppet_groupme_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxgro.hs.tok') | to_uuid }}"
  618. matrix_mx_puppet_groupme_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
  619. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  620. matrix_mx_puppet_groupme_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  621. matrix_mx_puppet_groupme_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxpup.groupme.db') | to_uuid }}"
  622. ######################################################################
  623. #
  624. # /matrix-bridge-mx-puppet-groupme
  625. #
  626. ######################################################################
  627. ######################################################################
  628. #
  629. # matrix-bot-matrix-reminder-bot
  630. #
  631. ######################################################################
  632. # We don't enable bots by default.
  633. matrix_bot_matrix_reminder_bot_enabled: false
  634. matrix_bot_matrix_reminder_bot_systemd_required_services_list: |
  635. {{
  636. ['docker.service']
  637. +
  638. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  639. +
  640. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  641. +
  642. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  643. }}
  644. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  645. matrix_bot_matrix_reminder_bot_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  646. matrix_bot_matrix_reminder_bot_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'reminder.bot.db') | to_uuid }}"
  647. matrix_bot_matrix_reminder_bot_container_self_build: "{{ matrix_architecture != 'amd64' }}"
  648. ######################################################################
  649. #
  650. # /matrix-bot-matrix-reminder-bot
  651. #
  652. ######################################################################
  653. ######################################################################
  654. #
  655. # matrix-bot-go-neb
  656. #
  657. ######################################################################
  658. # We don't enable bots by default.
  659. matrix_bot_go_neb_enabled: false
  660. matrix_bot_go_neb_systemd_required_services_list: |
  661. {{
  662. ['docker.service']
  663. +
  664. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  665. +
  666. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  667. }}
  668. matrix_bot_go_neb_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:4050' }}"
  669. ######################################################################
  670. #
  671. # /matrix-bot-go-neb
  672. #
  673. ######################################################################
  674. ######################################################################
  675. #
  676. # matrix-bot-mjolnir
  677. #
  678. ######################################################################
  679. # We don't enable bots by default.
  680. matrix_bot_mjolnir_enabled: false
  681. matrix_bot_mjolnir_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  682. matrix_bot_mjolnir_systemd_required_services_list: |
  683. {{
  684. ['docker.service']
  685. +
  686. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  687. +
  688. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  689. +
  690. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  691. }}
  692. ######################################################################
  693. #
  694. # /matrix-bot-mjolnir
  695. #
  696. ######################################################################
  697. ######################################################################
  698. #
  699. # matrix-corporal
  700. #
  701. ######################################################################
  702. matrix_corporal_enabled: false
  703. matrix_corporal_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  704. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-corporal over the container network.
  705. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  706. # matrix-corporal's web-server ports to the local host.
  707. matrix_corporal_container_http_gateway_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:41080' }}"
  708. matrix_corporal_container_http_api_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:41081' }}"
  709. matrix_corporal_systemd_required_services_list: |
  710. {{
  711. (['docker.service'])
  712. +
  713. (['matrix-synapse.service'])
  714. }}
  715. # This goes to Synapse's vhost
  716. matrix_corporal_matrix_homeserver_api_endpoint: "{{ matrix_homeserver_container_url }}"
  717. matrix_corporal_matrix_auth_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret }}"
  718. # This is only useful if there's REST auth provider to make use of it.
  719. matrix_corporal_http_gateway_internal_rest_auth_enabled: "{{ matrix_synapse_ext_password_provider_rest_auth_enabled }}"
  720. matrix_corporal_matrix_registration_shared_secret: "{{ matrix_synapse_registration_shared_secret }}"
  721. ######################################################################
  722. #
  723. # /matrix-corporal
  724. #
  725. ######################################################################
  726. ######################################################################
  727. #
  728. # matrix-coturn
  729. #
  730. ######################################################################
  731. matrix_coturn_enabled: true
  732. matrix_coturn_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  733. matrix_coturn_turn_external_ip_address: "{{ ansible_host }}"
  734. matrix_coturn_tls_enabled: "{{ matrix_ssl_retrieval_method != 'none' }}"
  735. matrix_coturn_tls_cert_path: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_server_fqn_matrix }}/fullchain.pem"
  736. matrix_coturn_tls_key_path: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_server_fqn_matrix }}/privkey.pem"
  737. matrix_coturn_container_additional_volumes: |
  738. {{
  739. ([] if matrix_ssl_retrieval_method == 'none' else [
  740. {
  741. 'src': matrix_ssl_config_dir_path,
  742. 'dst': matrix_ssl_config_dir_path,
  743. 'options': 'ro',
  744. }
  745. ])
  746. }}
  747. ######################################################################
  748. #
  749. # /matrix-coturn
  750. #
  751. ######################################################################
  752. ######################################################################
  753. #
  754. # matrix-dimension
  755. #
  756. ######################################################################
  757. matrix_dimension_enabled: false
  758. # Normally, matrix-nginx-proxy is enabled and nginx can reach Dimension over the container network.
  759. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  760. # the Dimension HTTP port to the local host.
  761. matrix_dimension_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8184' }}"
  762. matrix_integration_manager_rest_url: "{{ matrix_dimension_integrations_rest_url if matrix_dimension_enabled else None }}"
  763. matrix_integration_manager_ui_url: "{{ matrix_dimension_integrations_ui_url if matrix_dimension_enabled else None }}"
  764. matrix_dimension_systemd_required_services_list: |
  765. {{
  766. ['docker.service']
  767. +
  768. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  769. +
  770. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  771. +
  772. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  773. }}
  774. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  775. matrix_dimension_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  776. matrix_dimension_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'dimension.db') | to_uuid }}"
  777. ######################################################################
  778. #
  779. # /matrix-dimension
  780. #
  781. ######################################################################
  782. ######################################################################
  783. #
  784. # matrix-etherpad
  785. #
  786. ######################################################################
  787. matrix_etherpad_enabled: false
  788. matrix_etherpad_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9001' }}"
  789. matrix_etherpad_systemd_required_services_list: |
  790. {{
  791. ['docker.service']
  792. +
  793. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  794. }}
  795. matrix_etherpad_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'etherpad.db') | to_uuid }}"
  796. ######################################################################
  797. #
  798. # /matrix-etherpad
  799. #
  800. ######################################################################
  801. ######################################################################
  802. #
  803. # matrix-dynamic-dns
  804. #
  805. ######################################################################
  806. matrix_dynamic_dns_enabled: false
  807. ######################################################################
  808. #
  809. # /matrix-dynamic-dns
  810. #
  811. ######################################################################
  812. ######################################################################
  813. #
  814. # matrix-email2matrix
  815. #
  816. ######################################################################
  817. matrix_email2matrix_enabled: false
  818. matrix_email2matrix_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  819. ######################################################################
  820. #
  821. # /matrix-email2matrix
  822. #
  823. ######################################################################
  824. ######################################################################
  825. #
  826. # matrix-jitsi
  827. #
  828. ######################################################################
  829. matrix_jitsi_enabled: false
  830. # Normally, matrix-nginx-proxy is enabled and nginx can reach jitsi/web over the container network.
  831. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  832. # the Jitsi HTTP port to the local host.
  833. matrix_jitsi_web_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:13080' }}"
  834. matrix_jitsi_jvb_container_colibri_ws_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:13090' }}"
  835. matrix_jitsi_prosody_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:5280' }}"
  836. matrix_jitsi_jibri_xmpp_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'jibri') | to_uuid }}"
  837. matrix_jitsi_jicofo_auth_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'jicofo') | to_uuid }}"
  838. matrix_jitsi_jvb_auth_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'jvb') | to_uuid }}"
  839. matrix_jitsi_web_stun_servers: |
  840. {{
  841. [
  842. 'stun:' + matrix_server_fqn_matrix + ':5349',
  843. 'stun:' + matrix_server_fqn_matrix + ':3478',
  844. ]
  845. if matrix_coturn_enabled
  846. else [ 'stun:meet-jit-si-turnrelay.jitsi.net:443']
  847. }}
  848. # If the self-hosted Etherpad instance is available, it will also show up in Jitsi conferences,
  849. # unless explicitly disabled by setting `matrix_jitsi_etherpad_enabled` to false.
  850. # Falls back to the scalar.vector.im etherpad in case someone sets `matrix_jitsi_etherpad_enabled` to true,
  851. # while also setting `matrix_etherpad_enabled` to false.
  852. matrix_jitsi_etherpad_enabled: "{{ matrix_etherpad_enabled }}"
  853. matrix_jitsi_etherpad_base: "{{ matrix_etherpad_base_url if matrix_etherpad_enabled else 'https://scalar.vector.im/etherpad' }}"
  854. ######################################################################
  855. #
  856. # /matrix-jitsi
  857. #
  858. ######################################################################
  859. ######################################################################
  860. #
  861. # matrix-mailer
  862. #
  863. ######################################################################
  864. # By default, this playbook sets up an exim mailer server (running in a container).
  865. # This is so that Synapse can send email reminders for unread messages.
  866. # Other services (like ma1sd), also use the mailer.
  867. matrix_mailer_enabled: true
  868. matrix_mailer_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  869. ######################################################################
  870. #
  871. # /matrix-mailer
  872. #
  873. ######################################################################
  874. ######################################################################
  875. #
  876. # matrix-ma1sd
  877. #
  878. ######################################################################
  879. # By default, this playbook installs the ma1sd identity server on the same domain as Synapse (`matrix_server_fqn_matrix`).
  880. # If you wish to use the public identity servers (matrix.org, vector.im) instead of your own you may wish to disable this.
  881. matrix_ma1sd_enabled: true
  882. matrix_ma1sd_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  883. # Normally, matrix-nginx-proxy is enabled and nginx can reach ma1sd over the container network.
  884. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  885. # ma1sd's web-server port.
  886. matrix_ma1sd_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8090' }}"
  887. # We enable Synapse integration via its Postgres database by default.
  888. # When using another Identity store, you might wish to disable this and define
  889. # your own configuration in `matrix_ma1sd_configuration_extension_yaml`.
  890. matrix_ma1sd_synapsesql_enabled: true
  891. matrix_ma1sd_synapsesql_type: postgresql
  892. matrix_ma1sd_synapsesql_connection: //{{ matrix_synapse_database_host }}/{{ matrix_synapse_database_database }}?user={{ matrix_synapse_database_user | urlencode() }}&password={{ matrix_synapse_database_password | urlencode() }}
  893. matrix_ma1sd_dns_overwrite_enabled: true
  894. matrix_ma1sd_dns_overwrite_homeserver_client_name: "{{ matrix_server_fqn_matrix }}"
  895. # The `matrix_ma1sd_dns_overwrite_homeserver_client_value` value when matrix_nginx_proxy_enabled is false covers the general case,
  896. # but may be inaccurate if matrix-corporal is enabled.
  897. matrix_ma1sd_dns_overwrite_homeserver_client_value: "{{ ('http://' + matrix_nginx_proxy_proxy_matrix_client_api_addr_with_container) if matrix_nginx_proxy_enabled else matrix_homeserver_container_url }}"
  898. # By default, we send mail through the `matrix-mailer` service.
  899. matrix_ma1sd_threepid_medium_email_identity_from: "{{ matrix_mailer_sender_address }}"
  900. matrix_ma1sd_threepid_medium_email_connectors_smtp_host: "matrix-mailer"
  901. matrix_ma1sd_threepid_medium_email_connectors_smtp_port: 8025
  902. matrix_ma1sd_threepid_medium_email_connectors_smtp_tls: 0
  903. matrix_ma1sd_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  904. matrix_ma1sd_systemd_required_services_list: |
  905. {{
  906. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  907. }}
  908. matrix_ma1sd_systemd_wanted_services_list: |
  909. {{
  910. (['matrix-corporal.service'] if matrix_corporal_enabled else ['matrix-synapse.service'])
  911. +
  912. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  913. +
  914. (['matrix-mailer.service'] if matrix_mailer_enabled else [])
  915. }}
  916. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  917. matrix_ma1sd_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  918. matrix_ma1sd_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'ma1sd.db') | to_uuid }}"
  919. ######################################################################
  920. #
  921. # /matrix-ma1sd
  922. #
  923. ######################################################################
  924. ######################################################################
  925. #
  926. # matrix-nginx-proxy
  927. #
  928. ######################################################################
  929. # By default, this playbook sets up a reverse-proxy nginx proxy server on TCP ports 80, 443 and 8448.
  930. # This is fine if you're dedicating the whole server to Matrix.
  931. # If that's not the case, you may wish to disable this and take care of proxying yourself.
  932. matrix_nginx_proxy_enabled: true
  933. matrix_nginx_proxy_proxy_matrix_client_api_addr_with_container: "{{ 'matrix-corporal:41080' if matrix_corporal_enabled else 'matrix-nginx-proxy:12080' }}"
  934. matrix_nginx_proxy_proxy_matrix_client_api_addr_sans_container: "{{ '127.0.0.1:41080' if matrix_corporal_enabled else '127.0.0.1:12080' }}"
  935. matrix_nginx_proxy_proxy_matrix_client_api_client_max_body_size_mb: "{{ matrix_synapse_max_upload_size_mb }}"
  936. matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_synapse_admin_api_enabled: "{{ matrix_synapse_admin_enabled }}"
  937. matrix_nginx_proxy_proxy_matrix_client_redirect_root_uri_to_domain: "{{ matrix_server_fqn_element if matrix_client_element_enabled else '' }}"
  938. matrix_nginx_proxy_proxy_matrix_enabled: true
  939. matrix_nginx_proxy_proxy_element_enabled: "{{ matrix_client_element_enabled }}"
  940. matrix_nginx_proxy_proxy_hydrogen_enabled: "{{ matrix_client_hydrogen_enabled }}"
  941. matrix_nginx_proxy_proxy_dimension_enabled: "{{ matrix_dimension_enabled }}"
  942. matrix_nginx_proxy_proxy_bot_go_neb_enabled: "{{ matrix_bot_go_neb_enabled }}"
  943. matrix_nginx_proxy_proxy_jitsi_enabled: "{{ matrix_jitsi_enabled }}"
  944. matrix_nginx_proxy_proxy_grafana_enabled: "{{ matrix_grafana_enabled }}"
  945. matrix_nginx_proxy_proxy_sygnal_enabled: "{{ matrix_sygnal_enabled }}"
  946. matrix_nginx_proxy_proxy_matrix_corporal_api_enabled: "{{ matrix_corporal_enabled and matrix_corporal_http_api_enabled }}"
  947. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_with_container: "matrix-corporal:41081"
  948. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_sans_container: "127.0.0.1:41081"
  949. matrix_nginx_proxy_proxy_matrix_identity_api_enabled: "{{ matrix_ma1sd_enabled }}"
  950. matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container: "matrix-ma1sd:8090"
  951. matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container: "127.0.0.1:8090"
  952. # By default, we do TLS termination for the Matrix Federation API (port 8448) at matrix-nginx-proxy.
  953. # Unless this is handled there OR Synapse's federation listener port is disabled, we'll reverse-proxy.
  954. matrix_nginx_proxy_proxy_matrix_federation_api_enabled: "{{ matrix_synapse_federation_port_enabled and not matrix_synapse_tls_federation_listener_enabled }}"
  955. matrix_nginx_proxy_proxy_matrix_federation_api_addr_with_container: "matrix-nginx-proxy:12088"
  956. matrix_nginx_proxy_proxy_matrix_federation_api_addr_sans_container: "127.0.0.1:12088"
  957. # Settings controlling matrix-synapse-proxy.conf
  958. matrix_nginx_proxy_proxy_synapse_enabled: "{{ matrix_synapse_enabled }}"
  959. # When matrix-nginx-proxy is disabled, the actual port number that the vhost uses may begin to matter.
  960. matrix_nginx_proxy_proxy_matrix_federation_port: "{{ matrix_federation_public_port }}"
  961. matrix_nginx_proxy_container_federation_host_bind_port: "{{ matrix_federation_public_port }}"
  962. # This used to be hooked to `matrix_synapse_metrics_enabled`, but we don't do it anymore.
  963. # The fact that someone wishes to enable Synapse metrics does not necessarily mean they want to make them public.
  964. # A local Prometheus can consume them over the container network.
  965. matrix_nginx_proxy_proxy_synapse_metrics: false
  966. matrix_nginx_proxy_proxy_synapse_metrics_addr_with_container: "matrix-synapse:{{ matrix_synapse_metrics_port }}"
  967. matrix_nginx_proxy_proxy_synapse_metrics_addr_sans_container: "127.0.0.1:{{ matrix_synapse_metrics_port }}"
  968. matrix_nginx_proxy_proxy_matrix_user_directory_search_enabled: "{{ matrix_ma1sd_enabled }}"
  969. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_with_container: "{{ matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container }}"
  970. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_sans_container: "{{ matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container }}"
  971. matrix_nginx_proxy_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  972. # OCSP stapling does not make sense when self-signed certificates are used.
  973. # See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1073
  974. # and https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1074
  975. matrix_nginx_proxy_ocsp_stapling_enabled: "{{ matrix_ssl_retrieval_method != 'self-signed' }}"
  976. matrix_nginx_proxy_synapse_presence_disabled: "{{ not matrix_synapse_presence_enabled }}"
  977. matrix_nginx_proxy_synapse_workers_enabled: "{{ matrix_synapse_workers_enabled }}"
  978. matrix_nginx_proxy_synapse_workers_list: "{{ matrix_synapse_workers_enabled_list }}"
  979. matrix_nginx_proxy_synapse_generic_worker_client_server_locations: "{{ matrix_synapse_workers_generic_worker_client_server_endpoints }}"
  980. matrix_nginx_proxy_synapse_generic_worker_federation_locations: "{{ matrix_synapse_workers_generic_worker_federation_endpoints }}"
  981. matrix_nginx_proxy_synapse_media_repository_locations: "{{matrix_synapse_workers_media_repository_endpoints|default([]) }}"
  982. matrix_nginx_proxy_synapse_user_dir_locations: "{{ matrix_synapse_workers_user_dir_endpoints|default([]) }}"
  983. matrix_nginx_proxy_synapse_frontend_proxy_locations: "{{ matrix_synapse_workers_frontend_proxy_endpoints|default([]) }}"
  984. matrix_nginx_proxy_systemd_wanted_services_list: |
  985. {{
  986. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  987. +
  988. (['matrix-corporal.service'] if matrix_corporal_enabled else [])
  989. +
  990. (['matrix-ma1sd.service'] if matrix_ma1sd_enabled else [])
  991. +
  992. (['matrix-client-element.service'] if matrix_client_element_enabled else [])
  993. }}
  994. matrix_ssl_domains_to_obtain_certificates_for: |
  995. {{
  996. ([matrix_server_fqn_matrix])
  997. +
  998. ([matrix_server_fqn_element] if matrix_client_element_enabled else [])
  999. +
  1000. ([matrix_nginx_proxy_proxy_riot_compat_redirect_hostname] if matrix_nginx_proxy_proxy_riot_compat_redirect_enabled else [])
  1001. +
  1002. ([matrix_server_fqn_hydrogen] if matrix_client_hydrogen_enabled else [])
  1003. +
  1004. ([matrix_server_fqn_dimension] if matrix_dimension_enabled else [])
  1005. +
  1006. ([matrix_server_fqn_bot_go_neb] if matrix_bot_go_neb_enabled else [])
  1007. +
  1008. ([matrix_server_fqn_jitsi] if matrix_jitsi_enabled else [])
  1009. +
  1010. ([matrix_server_fqn_grafana] if matrix_grafana_enabled else [])
  1011. +
  1012. ([matrix_server_fqn_sygnal] if matrix_sygnal_enabled else [])
  1013. +
  1014. ([matrix_domain] if matrix_nginx_proxy_base_domain_serving_enabled else [])
  1015. +
  1016. matrix_ssl_additional_domains_to_obtain_certificates_for
  1017. }}
  1018. matrix_ssl_architecture: "{{
  1019. {
  1020. 'amd64': 'amd64',
  1021. 'arm32': 'arm32v6',
  1022. 'arm64': 'arm64v8',
  1023. }[matrix_architecture]
  1024. }}"
  1025. matrix_ssl_pre_obtaining_required_service_name: "{{ 'matrix-dynamic-dns' if matrix_dynamic_dns_enabled else '' }}"
  1026. ######################################################################
  1027. #
  1028. # /matrix-nginx-proxy
  1029. #
  1030. ######################################################################
  1031. ######################################################################
  1032. #
  1033. # matrix-postgres
  1034. #
  1035. ######################################################################
  1036. matrix_postgres_enabled: true
  1037. matrix_postgres_architecture: "{{ matrix_architecture }}"
  1038. # We unset this if internal Postgres disabled, which will cascade to some other variables
  1039. # and tell users they need to set it (either here or in those variables).
  1040. matrix_postgres_connection_hostname: "{{ 'matrix-postgres' if matrix_postgres_enabled else '' }}"
  1041. matrix_postgres_pgloader_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1042. matrix_postgres_additional_databases: |
  1043. {{
  1044. ([{
  1045. 'name': matrix_synapse_database_database,
  1046. 'username': matrix_synapse_database_user,
  1047. 'password': matrix_synapse_database_password,
  1048. }] if (matrix_synapse_enabled and matrix_synapse_database_database != matrix_postgres_db_name and matrix_synapse_database_host == 'matrix-postgres') else [])
  1049. +
  1050. ([{
  1051. 'name': matrix_ma1sd_database_name,
  1052. 'username': matrix_ma1sd_database_username,
  1053. 'password': matrix_ma1sd_database_password,
  1054. }] if (matrix_ma1sd_enabled and matrix_ma1sd_database_engine == 'postgres' and matrix_ma1sd_database_hostname == 'matrix-postgres') else [])
  1055. +
  1056. ([{
  1057. 'name': matrix_bot_matrix_reminder_bot_database_name,
  1058. 'username': matrix_bot_matrix_reminder_bot_database_username,
  1059. 'password': matrix_bot_matrix_reminder_bot_database_password,
  1060. }] if (matrix_bot_matrix_reminder_bot_enabled and matrix_bot_matrix_reminder_bot_database_engine == 'postgres' and matrix_bot_matrix_reminder_bot_database_hostname == 'matrix-postgres') else [])
  1061. +
  1062. ([{
  1063. 'name': matrix_registration_database_name,
  1064. 'username': matrix_registration_database_username,
  1065. 'password': matrix_registration_database_password,
  1066. }] if (matrix_registration_enabled and matrix_registration_database_engine == 'postgres' and matrix_registration_database_hostname == 'matrix-postgres') else [])
  1067. +
  1068. ([{
  1069. 'name': matrix_appservice_discord_database_name,
  1070. 'username': matrix_appservice_discord_database_username,
  1071. 'password': matrix_appservice_discord_database_password,
  1072. }] if (matrix_appservice_discord_enabled and matrix_appservice_discord_database_engine == 'postgres' and matrix_appservice_discord_database_hostname == 'matrix-postgres') else [])
  1073. +
  1074. ([{
  1075. 'name': matrix_appservice_slack_database_name,
  1076. 'username': matrix_appservice_slack_database_username,
  1077. 'password': matrix_appservice_slack_database_password,
  1078. }] if (matrix_appservice_slack_enabled and matrix_appservice_slack_database_engine == 'postgres' and matrix_appservice_slack_database_hostname == 'matrix-postgres') else [])
  1079. +
  1080. ([{
  1081. 'name': matrix_appservice_irc_database_name,
  1082. 'username': matrix_appservice_irc_database_username,
  1083. 'password': matrix_appservice_irc_database_password,
  1084. }] if (matrix_appservice_irc_enabled and matrix_appservice_irc_database_engine == 'postgres' and matrix_appservice_irc_database_hostname == 'matrix-postgres') else [])
  1085. +
  1086. ([{
  1087. 'name': matrix_beeper_linkedin_database_name,
  1088. 'username': matrix_beeper_linkedin_database_username,
  1089. 'password': matrix_beeper_linkedin_database_password,
  1090. }] if (matrix_beeper_linkedin_enabled and matrix_beeper_linkedin_database_engine == 'postgres' and matrix_beeper_linkedin_database_hostname == 'matrix-postgres') else [])
  1091. +
  1092. ([{
  1093. 'name': matrix_mautrix_facebook_database_name,
  1094. 'username': matrix_mautrix_facebook_database_username,
  1095. 'password': matrix_mautrix_facebook_database_password,
  1096. }] if (matrix_mautrix_facebook_enabled and matrix_mautrix_facebook_database_engine == 'postgres' and matrix_mautrix_facebook_database_hostname == 'matrix-postgres') else [])
  1097. +
  1098. ([{
  1099. 'name': matrix_mautrix_hangouts_database_name,
  1100. 'username': matrix_mautrix_hangouts_database_username,
  1101. 'password': matrix_mautrix_hangouts_database_password,
  1102. }] if (matrix_mautrix_hangouts_enabled and matrix_mautrix_hangouts_database_engine == 'postgres' and matrix_mautrix_hangouts_database_hostname == 'matrix-postgres') else [])
  1103. +
  1104. ([{
  1105. 'name': matrix_mautrix_instagram_database_name,
  1106. 'username': matrix_mautrix_instagram_database_username,
  1107. 'password': matrix_mautrix_instagram_database_password,
  1108. }] if (matrix_mautrix_instagram_enabled and matrix_mautrix_instagram_database_engine == 'postgres' and matrix_mautrix_instagram_database_hostname == 'matrix-postgres') else [])
  1109. +
  1110. ([{
  1111. 'name': matrix_mautrix_signal_database_name,
  1112. 'username': matrix_mautrix_signal_database_username,
  1113. 'password': matrix_mautrix_signal_database_password,
  1114. }] if (matrix_mautrix_signal_enabled and matrix_mautrix_signal_database_engine == 'postgres' and matrix_mautrix_signal_database_hostname == 'matrix-postgres') else [])
  1115. +
  1116. ([{
  1117. 'name': matrix_mautrix_telegram_database_name,
  1118. 'username': matrix_mautrix_telegram_database_username,
  1119. 'password': matrix_mautrix_telegram_database_password,
  1120. }] if (matrix_mautrix_telegram_enabled and matrix_mautrix_telegram_database_engine == 'postgres' and matrix_mautrix_telegram_database_hostname == 'matrix-postgres') else [])
  1121. +
  1122. ([{
  1123. 'name': matrix_mautrix_whatsapp_database_name,
  1124. 'username': matrix_mautrix_whatsapp_database_username,
  1125. 'password': matrix_mautrix_whatsapp_database_password,
  1126. }] if (matrix_mautrix_whatsapp_enabled and matrix_mautrix_whatsapp_database_engine == 'postgres' and matrix_mautrix_whatsapp_database_hostname == 'matrix-postgres') else [])
  1127. +
  1128. ([{
  1129. 'name': matrix_mx_puppet_skype_database_name,
  1130. 'username': matrix_mx_puppet_skype_database_username,
  1131. 'password': matrix_mx_puppet_skype_database_password,
  1132. }] if (matrix_mx_puppet_skype_enabled and matrix_mx_puppet_skype_database_engine == 'postgres' and matrix_mx_puppet_skype_database_hostname == 'matrix-postgres') else [])
  1133. +
  1134. ([{
  1135. 'name': matrix_mx_puppet_slack_database_name,
  1136. 'username': matrix_mx_puppet_slack_database_username,
  1137. 'password': matrix_mx_puppet_slack_database_password,
  1138. }] if (matrix_mx_puppet_slack_enabled and matrix_mx_puppet_slack_database_engine == 'postgres' and matrix_mx_puppet_slack_database_hostname == 'matrix-postgres') else [])
  1139. +
  1140. ([{
  1141. 'name': matrix_mx_puppet_twitter_database_name,
  1142. 'username': matrix_mx_puppet_twitter_database_username,
  1143. 'password': matrix_mx_puppet_twitter_database_password,
  1144. }] if (matrix_mx_puppet_twitter_enabled and matrix_mx_puppet_twitter_database_engine == 'postgres' and matrix_mx_puppet_twitter_database_hostname == 'matrix-postgres') else [])
  1145. +
  1146. ([{
  1147. 'name': matrix_mx_puppet_instagram_database_name,
  1148. 'username': matrix_mx_puppet_instagram_database_username,
  1149. 'password': matrix_mx_puppet_instagram_database_password,
  1150. }] if (matrix_mx_puppet_instagram_enabled and matrix_mx_puppet_instagram_database_engine == 'postgres' and matrix_mx_puppet_instagram_database_hostname == 'matrix-postgres') else [])
  1151. +
  1152. ([{
  1153. 'name': matrix_mx_puppet_discord_database_name,
  1154. 'username': matrix_mx_puppet_discord_database_username,
  1155. 'password': matrix_mx_puppet_discord_database_password,
  1156. }] if (matrix_mx_puppet_discord_enabled and matrix_mx_puppet_discord_database_engine == 'postgres' and matrix_mx_puppet_discord_database_hostname == 'matrix-postgres') else [])
  1157. +
  1158. ([{
  1159. 'name': matrix_mx_puppet_steam_database_name,
  1160. 'username': matrix_mx_puppet_steam_database_username,
  1161. 'password': matrix_mx_puppet_steam_database_password,
  1162. }] if (matrix_mx_puppet_steam_enabled and matrix_mx_puppet_steam_database_engine == 'postgres' and matrix_mx_puppet_steam_database_hostname == 'matrix-postgres') else [])
  1163. +
  1164. ([{
  1165. 'name': matrix_mx_puppet_groupme_database_name,
  1166. 'username': matrix_mx_puppet_groupme_database_username,
  1167. 'password': matrix_mx_puppet_groupme_database_password,
  1168. }] if (matrix_mx_puppet_groupme_enabled and matrix_mx_puppet_groupme_database_engine == 'postgres' and matrix_mx_puppet_groupme_database_hostname == 'matrix-postgres') else [])
  1169. +
  1170. ([{
  1171. 'name': matrix_dimension_database_name,
  1172. 'username': matrix_dimension_database_username,
  1173. 'password': matrix_dimension_database_password,
  1174. }] if (matrix_dimension_enabled and matrix_dimension_database_engine == 'postgres' and matrix_dimension_database_hostname == 'matrix-postgres') else [])
  1175. +
  1176. ([{
  1177. 'name': matrix_etherpad_database_name,
  1178. 'username': matrix_etherpad_database_username,
  1179. 'password': matrix_etherpad_database_password,
  1180. }] if (matrix_etherpad_enabled and matrix_etherpad_database_engine == 'postgres' and matrix_etherpad_database_hostname == 'matrix-postgres') else [])
  1181. +
  1182. ([{
  1183. 'name': matrix_sygnal_database_name,
  1184. 'username': matrix_sygnal_database_username,
  1185. 'password': matrix_sygnal_database_password,
  1186. }] if (matrix_sygnal_enabled and matrix_sygnal_database_engine == 'postgres' and matrix_sygnal_database_hostname == 'matrix-postgres') else [])
  1187. +
  1188. ([{
  1189. 'name': matrix_prometheus_postgres_exporter_database_name,
  1190. 'username': matrix_prometheus_postgres_exporter_database_username,
  1191. 'password': matrix_prometheus_postgres_exporter_database_password,
  1192. }] if (matrix_prometheus_postgres_exporter_enabled and matrix_prometheus_postgres_exporter_database_hostname == 'matrix-postgres') else [])
  1193. }}
  1194. matrix_postgres_import_roles_to_ignore: |
  1195. {{
  1196. [matrix_postgres_connection_username]
  1197. +
  1198. matrix_postgres_additional_databases|map(attribute='username')|list
  1199. }}
  1200. matrix_postgres_import_databases_to_ignore: |
  1201. {{
  1202. [matrix_postgres_db_name]
  1203. +
  1204. matrix_postgres_additional_databases|map(attribute='name')|list
  1205. }}
  1206. ######################################################################
  1207. #
  1208. # /matrix-postgres
  1209. #
  1210. ######################################################################
  1211. ######################################################################
  1212. #
  1213. # matrix-sygnal
  1214. #
  1215. ######################################################################
  1216. # Most people don't need their own push-server, because they also need their own app to utilize it from.
  1217. matrix_sygnal_enabled: false
  1218. # If someone instals Prometheus via the playbook, they most likely wish to monitor Sygnal.
  1219. matrix_sygnal_metrics_prometheus_enabled: "{{ matrix_prometheus_enabled }}"
  1220. matrix_sygnal_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:6000' }}"
  1221. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  1222. matrix_sygnal_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  1223. matrix_sygnal_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'sygnal') | to_uuid }}"
  1224. ######################################################################
  1225. #
  1226. # /matrix-sygnal
  1227. #
  1228. ######################################################################
  1229. ######################################################################
  1230. #
  1231. # matrix-redis
  1232. #
  1233. ######################################################################
  1234. matrix_redis_enabled: "{{ matrix_synapse_workers_enabled }}"
  1235. ######################################################################
  1236. #
  1237. # /matrix-redis
  1238. #
  1239. ######################################################################
  1240. ######################################################################
  1241. #
  1242. # matrix-client-element
  1243. #
  1244. ######################################################################
  1245. # By default, this playbook installs the Element web UI on the `matrix_server_fqn_element` domain.
  1246. # If you wish to connect to your Matrix server by other means, you may wish to disable this.
  1247. matrix_client_element_enabled: true
  1248. matrix_client_element_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1249. # Normally, matrix-nginx-proxy is enabled and nginx can reach Element over the container network.
  1250. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1251. # the Element HTTP port to the local host.
  1252. matrix_client_element_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8765' }}"
  1253. matrix_client_element_default_hs_url: "{{ matrix_homeserver_url }}"
  1254. matrix_client_element_default_is_url: "{{ matrix_identity_server_url }}"
  1255. # Use Dimension if enabled, otherwise fall back to Scalar
  1256. matrix_client_element_integrations_ui_url: "{{ matrix_dimension_integrations_ui_url if matrix_dimension_enabled else 'https://scalar.vector.im/' }}"
  1257. matrix_client_element_integrations_rest_url: "{{ matrix_dimension_integrations_rest_url if matrix_dimension_enabled else 'https://scalar.vector.im/api' }}"
  1258. matrix_client_element_integrations_widgets_urls: "{{ matrix_dimension_integrations_widgets_urls if matrix_dimension_enabled else ['https://scalar.vector.im/api'] }}"
  1259. matrix_client_element_integrations_jitsi_widget_url: "{{ matrix_dimension_integrations_jitsi_widget_url if matrix_dimension_enabled else 'https://scalar.vector.im/api/widgets/jitsi.html' }}"
  1260. matrix_client_element_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1261. matrix_client_element_registration_enabled: "{{ matrix_synapse_enable_registration }}"
  1262. matrix_client_element_enable_presence_by_hs_url: |
  1263. {{
  1264. none
  1265. if matrix_synapse_presence_enabled
  1266. else {matrix_client_element_default_hs_url: false}
  1267. }}
  1268. matrix_client_element_welcome_user_id: ~
  1269. matrix_client_element_jitsi_preferredDomain: "{{ matrix_server_fqn_jitsi if matrix_jitsi_enabled else '' }}"
  1270. ######################################################################
  1271. #
  1272. # /matrix-client-element
  1273. #
  1274. ######################################################################
  1275. ######################################################################
  1276. #
  1277. # matrix-client-hydrogen
  1278. #
  1279. ######################################################################
  1280. matrix_client_hydrogen_enabled: false
  1281. # Normally, matrix-nginx-proxy is enabled and nginx can reach Hydrogen over the container network.
  1282. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1283. # the HTTP port to the local host.
  1284. matrix_client_hydrogen_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8768' }}"
  1285. matrix_client_hydrogen_default_hs_url: "{{ matrix_homeserver_url }}"
  1286. matrix_client_hydrogen_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1287. ######################################################################
  1288. #
  1289. # /matrix-client-hydrogen
  1290. #
  1291. ######################################################################
  1292. ######################################################################
  1293. #
  1294. # matrix-synapse
  1295. #
  1296. ######################################################################
  1297. matrix_synapse_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  1298. # When ma1sd is enabled, we can use it to validate email addresses and phone numbers.
  1299. # 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.
  1300. matrix_synapse_account_threepid_delegates_email: "{{ 'http://matrix-ma1sd:8090' if matrix_ma1sd_enabled else '' }}"
  1301. matrix_synapse_account_threepid_delegates_msisdn: "{{ 'http://matrix-ma1sd:8090' if matrix_ma1sd_enabled else '' }}"
  1302. # Normally, matrix-nginx-proxy is enabled and nginx can reach Synapse over the container network.
  1303. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it,
  1304. # you can expose Synapse's ports to the host.
  1305. #
  1306. # For exposing the Matrix Client API's port (plain HTTP) to the local host.
  1307. matrix_synapse_container_client_api_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8008' }}"
  1308. #
  1309. # For exposing the Matrix Federation API's plain port (plain HTTP) to the local host.
  1310. matrix_synapse_container_federation_api_plain_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8048' }}"
  1311. #
  1312. # For exposing the Matrix Federation API's TLS port (HTTPS) to the internet on all network interfaces.
  1313. 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 '' }}"
  1314. #
  1315. # For exposing the Synapse Metrics API's port (plain HTTP) to the local host.
  1316. 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 '' }}"
  1317. #
  1318. # For exposing the Synapse Manhole port (plain HTTP) to the local host.
  1319. matrix_synapse_container_manhole_api_host_bind_port: "{{ '127.0.0.1:9000' if matrix_synapse_manhole_enabled else '' }}"
  1320. #
  1321. # For exposing the Synapse worker (and metrics) ports to the local host.
  1322. matrix_synapse_workers_container_host_bind_address: "{{ '127.0.0.1' if (matrix_synapse_workers_enabled and not matrix_nginx_proxy_enabled) else '' }}"
  1323. matrix_synapse_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'synapse.db') | to_uuid }}"
  1324. # We do not enable TLS in Synapse by default.
  1325. # TLS is handled by the matrix-nginx-proxy, which proxies the requests to Synapse.
  1326. matrix_synapse_tls_federation_listener_enabled: false
  1327. matrix_synapse_tls_certificate_path: ~
  1328. matrix_synapse_tls_private_key_path: ~
  1329. matrix_synapse_federation_port_openid_resource_required: "{{ not matrix_synapse_federation_enabled and (matrix_dimension_enabled or matrix_ma1sd_enabled) }}"
  1330. # If someone instals Prometheus via the playbook, they most likely wish to monitor Synapse.
  1331. matrix_synapse_metrics_enabled: "{{ matrix_prometheus_enabled }}"
  1332. matrix_synapse_email_enabled: "{{ matrix_mailer_enabled }}"
  1333. matrix_synapse_email_smtp_host: "matrix-mailer"
  1334. matrix_synapse_email_smtp_port: 8025
  1335. matrix_synapse_email_smtp_require_transport_security: false
  1336. matrix_synapse_email_notif_from: "Matrix <{{ matrix_mailer_sender_address }}>"
  1337. # Even if TURN doesn't support TLS (it does by default),
  1338. # it doesn't hurt to try a secure connection anyway.
  1339. #
  1340. # When Let's Encrypt certificates are used (the default case),
  1341. # we don't enable `turns` endpoints, because WebRTC in Element can't talk to them.
  1342. # Learn more here: https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1145
  1343. matrix_synapse_turn_uris: |
  1344. {{
  1345. []
  1346. +
  1347. [
  1348. 'turns:' + matrix_server_fqn_matrix + '?transport=udp',
  1349. 'turns:' + matrix_server_fqn_matrix + '?transport=tcp',
  1350. ] if matrix_coturn_enabled and matrix_coturn_tls_enabled and matrix_ssl_retrieval_method != 'lets-encrypt' else []
  1351. +
  1352. [
  1353. 'turn:' + matrix_server_fqn_matrix + '?transport=udp',
  1354. 'turn:' + matrix_server_fqn_matrix + '?transport=tcp',
  1355. ] if matrix_coturn_enabled else []
  1356. }}
  1357. matrix_synapse_turn_shared_secret: "{{ matrix_coturn_turn_static_auth_secret if matrix_coturn_enabled else '' }}"
  1358. matrix_synapse_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1359. matrix_synapse_systemd_required_services_list: |
  1360. {{
  1361. (['docker.service'])
  1362. +
  1363. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1364. +
  1365. (['matrix-goofys'] if matrix_s3_media_store_enabled else [])
  1366. }}
  1367. matrix_synapse_systemd_wanted_services_list: |
  1368. {{
  1369. (['matrix-coturn.service'] if matrix_coturn_enabled else [])
  1370. +
  1371. (['matrix-mailer.service'] if matrix_mailer_enabled else [])
  1372. }}
  1373. # Synapse workers (used for parallel load-scaling) need Redis for IPC.
  1374. matrix_synapse_redis_enabled: "{{ matrix_redis_enabled }}"
  1375. matrix_synapse_redis_host: "{{ 'matrix-redis' if matrix_redis_enabled else '' }}"
  1376. matrix_synapse_redis_password: "{{ matrix_redis_connection_password if matrix_redis_enabled else '' }}"
  1377. ######################################################################
  1378. #
  1379. # /matrix-synapse
  1380. #
  1381. ######################################################################
  1382. ######################################################################
  1383. #
  1384. # matrix-synapse-admin
  1385. #
  1386. ######################################################################
  1387. matrix_synapse_admin_enabled: false
  1388. # Normally, matrix-nginx-proxy is enabled and nginx can reach Synapse Admin over the container network.
  1389. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1390. # Synapse Admin's HTTP port to the local host.
  1391. matrix_synapse_admin_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8766' }}"
  1392. matrix_synapse_admin_container_self_build: "{{ matrix_architecture != 'amd64' }}"
  1393. ######################################################################
  1394. #
  1395. # /matrix-synapse-admin
  1396. #
  1397. ######################################################################
  1398. ######################################################################
  1399. #
  1400. # matrix-prometheus-node-exporter
  1401. #
  1402. ######################################################################
  1403. matrix_prometheus_node_exporter_enabled: false
  1404. ######################################################################
  1405. #
  1406. # /matrix-prometheus-node-exporter
  1407. #
  1408. ######################################################################
  1409. ######################################################################
  1410. #
  1411. # matrix-prometheus
  1412. #
  1413. ######################################################################
  1414. matrix_prometheus_enabled: false
  1415. # Normally, matrix-nginx-proxy is enabled and nginx can reach Prometheus over the container network.
  1416. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1417. # Prometheus' HTTP port to the local host.
  1418. matrix_prometheus_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9090' }}"
  1419. matrix_prometheus_scraper_synapse_enabled: "{{ matrix_synapse_enabled and matrix_synapse_metrics_enabled }}"
  1420. matrix_prometheus_scraper_synapse_targets: ['matrix-synapse:{{ matrix_synapse_metrics_port }}']
  1421. matrix_prometheus_scraper_synapse_workers_enabled_list: "{{ matrix_synapse_workers_enabled_list }}"
  1422. matrix_prometheus_scraper_synapse_rules_synapse_tag: "{{ matrix_synapse_docker_image_tag }}"
  1423. matrix_prometheus_scraper_node_enabled: "{{ matrix_prometheus_node_exporter_enabled }}"
  1424. matrix_prometheus_scraper_node_targets: "{{ ['matrix-prometheus-node-exporter:9100'] if matrix_prometheus_node_exporter_enabled else [] }}"
  1425. matrix_prometheus_scraper_postgres_enabled: "{{ matrix_prometheus_postgres_exporter_enabled }}"
  1426. matrix_prometheus_scraper_postgres_targets: "{{ ['matrix-prometheus-postgres-exporter:'+ matrix_prometheus_postgres_exporter_port|string] if matrix_prometheus_scraper_postgres_enabled else [] }}"
  1427. ######################################################################
  1428. #
  1429. # /matrix-prometheus
  1430. #
  1431. ######################################################################
  1432. ######################################################################
  1433. #
  1434. # matrix-prometheus-postgres-exporter
  1435. #
  1436. ######################################################################
  1437. matrix_prometheus_postgres_exporter_enabled: false
  1438. matrix_prometheus_postgres_exporter_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'prometheus.pg.db') | to_uuid }}"
  1439. matrix_prometheus_postgres_exporter_systemd_required_services_list: |
  1440. {{
  1441. ['docker.service']
  1442. +
  1443. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1444. }}
  1445. ######################################################################
  1446. #
  1447. # /matrix-prometheus-postgres-exporter
  1448. #
  1449. ######################################################################
  1450. ######################################################################
  1451. #
  1452. # matrix-grafana
  1453. #
  1454. ######################################################################
  1455. matrix_grafana_enabled: false
  1456. # Normally, matrix-nginx-proxy is enabled and nginx can reach Grafana over the container network.
  1457. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1458. # Grafana's HTTP port to the local host.
  1459. matrix_grafana_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:3000' }}"
  1460. matrix_grafana_dashboard_download_urls_all: |
  1461. {{
  1462. matrix_grafana_dashboard_download_urls
  1463. +
  1464. (matrix_prometheus_postgres_exporter_dashboard_urls if matrix_prometheus_postgres_exporter_enabled else [])
  1465. }}
  1466. ######################################################################
  1467. #
  1468. # /matrix-grafana
  1469. #
  1470. ######################################################################
  1471. ######################################################################
  1472. #
  1473. # matrix-registration
  1474. #
  1475. ######################################################################
  1476. matrix_registration_enabled: false
  1477. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-registration over the container network.
  1478. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1479. # matrix-registration's HTTP port to the local host.
  1480. matrix_registration_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8767' }}"
  1481. matrix_registration_riot_instance: "{{ ('https://' + matrix_server_fqn_element) if matrix_client_element_enabled else 'https://riot.im/app/' }}"
  1482. matrix_registration_shared_secret: "{{ matrix_synapse_registration_shared_secret if matrix_synapse_enabled else '' }}"
  1483. matrix_registration_server_location: "{{ matrix_homeserver_container_url }}"
  1484. matrix_registration_api_validate_certs: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1485. matrix_registration_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1486. matrix_registration_systemd_required_services_list: |
  1487. {{
  1488. ['docker.service']
  1489. +
  1490. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1491. }}
  1492. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  1493. matrix_registration_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  1494. matrix_registration_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mx.registr.db') | to_uuid }}"
  1495. ######################################################################
  1496. #
  1497. # /matrix-registration
  1498. #
  1499. ######################################################################
  1500. ######################################################################
  1501. #
  1502. # matrix-postgres-backup
  1503. #
  1504. ######################################################################
  1505. matrix_postgres_backup_connection_hostname: "{{ matrix_postgres_connection_hostname }}"
  1506. matrix_postgres_backup_connection_port: "{{ matrix_postgres_connection_port }}"
  1507. matrix_postgres_backup_connection_username: "{{ matrix_postgres_connection_username }}"
  1508. matrix_postgres_backup_connection_password: "{{ matrix_postgres_connection_password }}"
  1509. matrix_postgres_backup_postgres_data_path: "{{ matrix_postgres_data_path if matrix_postgres_enabled else '' }}"
  1510. # the default matrix synapse databse is not always part of the matrix_postgres_additional_databases variable thus we have to add it if the default database is used
  1511. matrix_postgres_backup_databases: |
  1512. {{
  1513. (([{
  1514. 'name': matrix_synapse_database_database
  1515. }] if (matrix_synapse_enabled and matrix_synapse_database_database == matrix_postgres_db_name and matrix_synapse_database_host == 'matrix-postgres') else [])
  1516. +
  1517. matrix_postgres_additional_databases)|map(attribute='name')|list
  1518. }}
  1519. ######################################################################
  1520. #
  1521. # /matrix-postgres-backup
  1522. #
  1523. ######################################################################