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.

1410 lines
60 KiB

  1. ---
  2. # This variables file wires together the various components (roles) used by the playbook.
  3. #
  4. # Roles used by playbook are pretty minimal and kept independent of one another as much as possible.
  5. # To deliver a turnkey fully-featured Matrix server, this playbook needs
  6. # to connect them all together. It does so by overriding role variables.
  7. #
  8. # You can also override ANY variable (seen here or in any given role),
  9. # by re-defining it in your own configuration file (`inventory/host_vars/matrix.<your-domain>`).
  10. ######################################################################
  11. #
  12. # matrix-base
  13. #
  14. ######################################################################
  15. matrix_identity_server_url: "{{ ('https://' + matrix_server_fqn_matrix) if matrix_ma1sd_enabled else None }}"
  16. ######################################################################
  17. #
  18. # /matrix-base
  19. #
  20. ######################################################################
  21. ######################################################################
  22. #
  23. # matrix-bridge-appservice-discord
  24. #
  25. ######################################################################
  26. # We don't enable bridges by default.
  27. matrix_appservice_discord_enabled: false
  28. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-discord over the container network.
  29. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  30. # matrix-appservice-discord's client-server port to the local host.
  31. matrix_appservice_discord_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9005' }}"
  32. # If the homeserver disables presence, it's likely better (less wasteful) to also disable presence on the bridge side.
  33. matrix_appservice_discord_bridge_disablePresence: "{{ matrix_synapse_use_presence }}"
  34. matrix_appservice_discord_systemd_required_services_list: |
  35. {{
  36. ['docker.service']
  37. +
  38. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  39. +
  40. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  41. }}
  42. matrix_appservice_discord_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'discord.as.token') | to_uuid }}"
  43. matrix_appservice_discord_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'discord.hs.token') | to_uuid }}"
  44. # We only make this use Postgres if our own Postgres server is enabled.
  45. # It's only then (for now) that we can automatically create the necessary database and user for this service.
  46. matrix_appservice_discord_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  47. matrix_appservice_discord_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'as.discord.db') | to_uuid }}"
  48. ######################################################################
  49. #
  50. # /matrix-bridge-appservice-discord
  51. #
  52. ######################################################################
  53. ######################################################################
  54. #
  55. # matrix-appservice-webhooks
  56. #
  57. ######################################################################
  58. # We don't enable bridges by default.
  59. matrix_appservice_webhooks_enabled: false
  60. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-webhooks over the container network.
  61. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  62. # matrix-appservice-webhooks' client-server port to the local host.
  63. matrix_appservice_webhooks_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else ('127.0.0.1:' ~ matrix_appservice_webhooks_matrix_port) }}"
  64. matrix_appservice_webhooks_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'webhook.as.token') | to_uuid }}"
  65. matrix_appservice_webhooks_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'webhook.hs.token') | to_uuid }}"
  66. matrix_appservice_webhooks_id_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'webhook.id.token') | to_uuid }}"
  67. matrix_appservice_webhooks_systemd_required_services_list: |
  68. {{
  69. ['docker.service']
  70. +
  71. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  72. }}
  73. ######################################################################
  74. #
  75. # /matrix-appservice-webhooks
  76. #
  77. ######################################################################
  78. ######################################################################
  79. #
  80. # matrix-appservice-slack
  81. #
  82. ######################################################################
  83. # We don't enable bridges by default.
  84. matrix_appservice_slack_enabled: false
  85. matrix_appservice_slack_container_self_build: "{{ matrix_architecture != 'amd64' }}"
  86. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-slack over the container network.
  87. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  88. # matrix-appservice-slack's client-server port to the local host.
  89. matrix_appservice_slack_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else ('127.0.0.1:' ~ matrix_appservice_slack_slack_port) }}"
  90. matrix_appservice_slack_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'slack.as.token') | to_uuid }}"
  91. matrix_appservice_slack_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'slack.hs.token') | to_uuid }}"
  92. matrix_appservice_slack_id_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'slack.id.token') | to_uuid }}"
  93. matrix_appservice_slack_systemd_required_services_list: |
  94. {{
  95. ['docker.service']
  96. +
  97. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  98. }}
  99. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  100. matrix_appservice_slack_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'nedb' }}"
  101. matrix_appservice_slack_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'as.slack.db') | to_uuid }}"
  102. ######################################################################
  103. #
  104. # /matrix-bridge-appservice-slack
  105. #
  106. ######################################################################
  107. ######################################################################
  108. #
  109. # matrix-bridge-appservice-irc
  110. #
  111. ######################################################################
  112. # We don't enable bridges by default.
  113. matrix_appservice_irc_enabled: false
  114. matrix_appservice_irc_container_self_build: "{{ matrix_architecture != 'amd64' }}"
  115. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-irc over the container network.
  116. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  117. # matrix-appservice-irc's client-server port to the local host.
  118. matrix_appservice_irc_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9999' }}"
  119. # The IRC bridge docs say that if homeserver presence is disabled, it's better to also disable
  120. # IRC bridge presence, for performance reasons.
  121. matrix_appservice_irc_homeserver_enablePresence: "{{ matrix_synapse_use_presence }}"
  122. matrix_appservice_irc_systemd_required_services_list: |
  123. {{
  124. ['docker.service']
  125. +
  126. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  127. }}
  128. matrix_appservice_irc_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'irc.as.token') | to_uuid }}"
  129. matrix_appservice_irc_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'irc.hs.token') | to_uuid }}"
  130. matrix_appservice_irc_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'nedb' }}"
  131. matrix_appservice_irc_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'as.irc.db') | to_uuid }}"
  132. ######################################################################
  133. #
  134. # /matrix-bridge-appservice-irc
  135. #
  136. ######################################################################
  137. ######################################################################
  138. #
  139. # matrix-bridge-mautrix-facebook
  140. #
  141. ######################################################################
  142. # We don't enable bridges by default.
  143. matrix_mautrix_facebook_enabled: false
  144. matrix_mautrix_facebook_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  145. matrix_mautrix_facebook_systemd_required_services_list: |
  146. {{
  147. ['docker.service']
  148. +
  149. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  150. +
  151. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  152. }}
  153. matrix_mautrix_facebook_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'fb.as.token') | to_uuid }}"
  154. matrix_mautrix_facebook_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'fb.hs.token') | to_uuid }}"
  155. 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 '' }}"
  156. matrix_mautrix_facebook_bridge_presence: "{{ matrix_synapse_use_presence if matrix_synapse_enabled else true }}"
  157. # We'd like to force-set people with external Postgres to SQLite, so the bridge role can complain
  158. # and point them to a migration path.
  159. matrix_mautrix_facebook_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  160. matrix_mautrix_facebook_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mau.fb.db') | to_uuid }}"
  161. ######################################################################
  162. #
  163. # /matrix-bridge-mautrix-facebook
  164. #
  165. ######################################################################
  166. ######################################################################
  167. #
  168. # matrix-bridge-mautrix-hangouts
  169. #
  170. ######################################################################
  171. # We don't enable bridges by default.
  172. matrix_mautrix_hangouts_enabled: false
  173. matrix_mautrix_hangouts_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  174. matrix_mautrix_hangouts_systemd_required_services_list: |
  175. {{
  176. ['docker.service']
  177. +
  178. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  179. +
  180. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  181. }}
  182. matrix_mautrix_hangouts_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'ho.as.token') | to_uuid }}"
  183. matrix_mautrix_hangouts_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'ho.hs.token') | to_uuid }}"
  184. matrix_mautrix_hangouts_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9007' }}"
  185. 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 '' }}"
  186. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  187. matrix_mautrix_hangouts_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  188. matrix_mautrix_hangouts_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mau.hangouts.db') | to_uuid }}"
  189. ######################################################################
  190. #
  191. # /matrix-bridge-mautrix-hangouts
  192. #
  193. ######################################################################
  194. ######################################################################
  195. #
  196. # matrix-bridge-mautrix-signal
  197. #
  198. ######################################################################
  199. # We don't enable bridges by default.
  200. matrix_mautrix_signal_enabled: false
  201. matrix_mautrix_signal_systemd_required_services_list: |
  202. {{
  203. ['docker.service']
  204. +
  205. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  206. +
  207. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  208. +
  209. ['matrix-mautrix-signal-daemon.service']
  210. }}
  211. matrix_mautrix_signal_homeserver_domain: '{{ matrix_domain }}'
  212. matrix_mautrix_signal_homeserver_address: "{{ 'http://matrix-synapse:8008' if matrix_synapse_enabled else '' }}"
  213. matrix_mautrix_signal_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'si.hs.token') | to_uuid }}"
  214. matrix_mautrix_signal_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'si.as.token') | to_uuid }}"
  215. 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 '' }}"
  216. matrix_mautrix_signal_database_engine: 'postgres'
  217. matrix_mautrix_signal_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mau.signal.db') | to_uuid }}"
  218. ######################################################################
  219. #
  220. # /matrix-bridge-mautrix-signal
  221. #
  222. ######################################################################
  223. ######################################################################
  224. #
  225. # matrix-bridge-mautrix-telegram
  226. #
  227. ######################################################################
  228. # We don't enable bridges by default.
  229. matrix_mautrix_telegram_enabled: false
  230. # Images are multi-arch (amd64 and arm64, but not arm32).
  231. matrix_mautrix_telegram_container_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  232. matrix_mautrix_telegram_systemd_required_services_list: |
  233. {{
  234. ['docker.service']
  235. +
  236. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  237. +
  238. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  239. }}
  240. matrix_mautrix_telegram_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'telegr.as.token') | to_uuid }}"
  241. matrix_mautrix_telegram_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'telegr.hs.token') | to_uuid }}"
  242. matrix_mautrix_telegram_public_endpoint: "/{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'telegram') | to_uuid }}"
  243. matrix_mautrix_telegram_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9006' }}"
  244. 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 '' }}"
  245. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  246. matrix_mautrix_telegram_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  247. matrix_mautrix_telegram_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mau.telegram.db') | to_uuid }}"
  248. ######################################################################
  249. #
  250. # /matrix-bridge-mautrix-telegram
  251. #
  252. ######################################################################
  253. ######################################################################
  254. #
  255. # matrix-bridge-mautrix-whatsapp
  256. #
  257. ######################################################################
  258. # We don't enable bridges by default.
  259. matrix_mautrix_whatsapp_enabled: false
  260. matrix_mautrix_whatsapp_systemd_required_services_list: |
  261. {{
  262. ['docker.service']
  263. +
  264. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  265. +
  266. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  267. }}
  268. matrix_mautrix_whatsapp_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'whats.as.token') | to_uuid }}"
  269. matrix_mautrix_whatsapp_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'whats.hs.token') | to_uuid }}"
  270. 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 '' }}"
  271. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  272. matrix_mautrix_whatsapp_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  273. matrix_mautrix_whatsapp_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mauwhatsapp.db') | to_uuid }}"
  274. ######################################################################
  275. #
  276. # /matrix-bridge-mautrix-whatsapp
  277. #
  278. ######################################################################
  279. ######################################################################
  280. #
  281. # matrix-sms-bridge
  282. #
  283. ######################################################################
  284. # We don't enable bridges by default.
  285. matrix_sms_bridge_enabled: false
  286. matrix_sms_bridge_systemd_required_services_list: |
  287. {{
  288. ['docker.service']
  289. +
  290. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  291. }}
  292. matrix_sms_bridge_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'sms.as.token') | to_uuid }}"
  293. matrix_sms_bridge_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'sms.hs.token') | to_uuid }}"
  294. ######################################################################
  295. #
  296. # /matrix-sms-bridge
  297. #
  298. ######################################################################
  299. ######################################################################
  300. #
  301. # matrix-bridge-mx-puppet-skype
  302. #
  303. ######################################################################
  304. # We don't enable bridges by default.
  305. matrix_mx_puppet_skype_enabled: false
  306. matrix_mx_puppet_skype_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  307. matrix_mx_puppet_skype_systemd_required_services_list: |
  308. {{
  309. ['docker.service']
  310. +
  311. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  312. +
  313. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  314. }}
  315. matrix_mx_puppet_skype_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'skype.as.tok') | to_uuid }}"
  316. matrix_mx_puppet_skype_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'skype.hs.tok') | to_uuid }}"
  317. 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 '' }}"
  318. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  319. matrix_mx_puppet_skype_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  320. matrix_mx_puppet_skype_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxpup.skype.db') | to_uuid }}"
  321. ######################################################################
  322. #
  323. # /matrix-bridge-mx-puppet-skype
  324. #
  325. ######################################################################
  326. ######################################################################
  327. #
  328. # matrix-bridge-mx-puppet-slack
  329. #
  330. ######################################################################
  331. # We don't enable bridges by default.
  332. matrix_mx_puppet_slack_enabled: false
  333. matrix_mx_puppet_slack_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  334. matrix_mx_puppet_slack_systemd_required_services_list: |
  335. {{
  336. ['docker.service']
  337. +
  338. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  339. +
  340. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  341. }}
  342. matrix_mx_puppet_slack_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxslk.as.tok') | to_uuid }}"
  343. matrix_mx_puppet_slack_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxslk.hs.tok') | to_uuid }}"
  344. 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 '' }}"
  345. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  346. matrix_mx_puppet_slack_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  347. matrix_mx_puppet_slack_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxpup.slack.db') | to_uuid }}"
  348. ######################################################################
  349. #
  350. # /matrix-bridge-mx-puppet-slack
  351. #
  352. ######################################################################
  353. ######################################################################
  354. #
  355. # matrix-bridge-mx-puppet-twitter
  356. #
  357. ######################################################################
  358. # We don't enable bridges by default.
  359. matrix_mx_puppet_twitter_enabled: false
  360. matrix_mx_puppet_twitter_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  361. matrix_mx_puppet_twitter_systemd_required_services_list: |
  362. {{
  363. ['docker.service']
  364. +
  365. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  366. +
  367. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  368. }}
  369. matrix_mx_puppet_twitter_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxtwt.as.tok') | to_uuid }}"
  370. matrix_mx_puppet_twitter_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxtwt.hs.tok') | to_uuid }}"
  371. 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 '' }}"
  372. 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) }}"
  373. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  374. matrix_mx_puppet_twitter_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  375. matrix_mx_puppet_twitter_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxpup.twitter.db') | to_uuid }}"
  376. ######################################################################
  377. #
  378. # /matrix-bridge-mx-puppet-twitter
  379. #
  380. ######################################################################
  381. ######################################################################
  382. #
  383. # matrix-bridge-mx-puppet-instagram
  384. #
  385. ######################################################################
  386. # We don't enable bridges by default.
  387. matrix_mx_puppet_instagram_enabled: false
  388. matrix_mx_puppet_instagram_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  389. matrix_mx_puppet_instagram_systemd_required_services_list: |
  390. {{
  391. ['docker.service']
  392. +
  393. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  394. +
  395. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  396. }}
  397. matrix_mx_puppet_instagram_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxig.as.tok') | to_uuid }}"
  398. matrix_mx_puppet_instagram_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxig.hs.tok') | to_uuid }}"
  399. 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 '' }}"
  400. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  401. matrix_mx_puppet_instagram_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  402. matrix_mx_puppet_instagram_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxpup.ig.db') | to_uuid }}"
  403. ######################################################################
  404. #
  405. # /matrix-bridge-mx-puppet-instagram
  406. #
  407. ######################################################################
  408. ######################################################################
  409. #
  410. # matrix-bridge-mx-puppet-discord
  411. #
  412. ######################################################################
  413. # We don't enable bridges by default.
  414. matrix_mx_puppet_discord_enabled: false
  415. matrix_mx_puppet_discord_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  416. matrix_mx_puppet_discord_systemd_required_services_list: |
  417. {{
  418. ['docker.service']
  419. +
  420. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  421. +
  422. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  423. }}
  424. matrix_mx_puppet_discord_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxdsc.as.tok') | to_uuid }}"
  425. matrix_mx_puppet_discord_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxdsc.hs.tok') | to_uuid }}"
  426. 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 '' }}"
  427. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  428. matrix_mx_puppet_discord_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  429. matrix_mx_puppet_discord_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxpup.dsc.db') | to_uuid }}"
  430. ######################################################################
  431. #
  432. # /matrix-bridge-mx-puppet-discord
  433. #
  434. ######################################################################
  435. ######################################################################
  436. #
  437. # matrix-bridge-mx-puppet-steam
  438. #
  439. ######################################################################
  440. # We don't enable bridges by default.
  441. matrix_mx_puppet_steam_enabled: false
  442. matrix_mx_puppet_steam_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  443. matrix_mx_puppet_steam_systemd_required_services_list: |
  444. {{
  445. ['docker.service']
  446. +
  447. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  448. +
  449. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  450. }}
  451. matrix_mx_puppet_steam_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxste.as.tok') | to_uuid }}"
  452. matrix_mx_puppet_steam_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxste.hs.tok') | to_uuid }}"
  453. 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 '' }}"
  454. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  455. matrix_mx_puppet_steam_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  456. matrix_mx_puppet_steam_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxpup.steam.db') | to_uuid }}"
  457. ######################################################################
  458. #
  459. # /matrix-bridge-mx-puppet-steam
  460. #
  461. ######################################################################
  462. ######################################################################
  463. #
  464. # matrix-bot-matrix-reminder-bot
  465. #
  466. ######################################################################
  467. # We don't enable bots by default.
  468. matrix_bot_matrix_reminder_bot_enabled: false
  469. matrix_bot_matrix_reminder_bot_systemd_required_services_list: |
  470. {{
  471. ['docker.service']
  472. +
  473. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  474. }}
  475. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  476. matrix_bot_matrix_reminder_bot_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  477. matrix_bot_matrix_reminder_bot_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'reminder.bot.db') | to_uuid }}"
  478. ######################################################################
  479. #
  480. # /matrix-bot-matrix-reminder-bot
  481. #
  482. ######################################################################
  483. ######################################################################
  484. #
  485. # matrix-corporal
  486. #
  487. ######################################################################
  488. matrix_corporal_enabled: false
  489. matrix_corporal_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  490. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-corporal over the container network.
  491. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  492. # matrix-corporal's web-server ports to the local host.
  493. matrix_corporal_container_http_gateway_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:41080' }}"
  494. matrix_corporal_container_http_api_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:41081' }}"
  495. matrix_corporal_systemd_required_services_list: |
  496. {{
  497. (['docker.service'])
  498. +
  499. (['matrix-synapse.service'])
  500. }}
  501. matrix_corporal_matrix_homeserver_api_endpoint: "http://matrix-synapse:8008"
  502. matrix_corporal_matrix_auth_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret }}"
  503. # This is only useful if there's REST auth provider to make use of it.
  504. matrix_corporal_http_gateway_internal_rest_auth_enabled: "{{ matrix_synapse_ext_password_provider_rest_auth_enabled }}"
  505. matrix_corporal_matrix_registration_shared_secret: "{{ matrix_synapse_registration_shared_secret }}"
  506. ######################################################################
  507. #
  508. # /matrix-corporal
  509. #
  510. ######################################################################
  511. ######################################################################
  512. #
  513. # matrix-coturn
  514. #
  515. ######################################################################
  516. matrix_coturn_enabled: true
  517. matrix_coturn_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  518. matrix_coturn_turn_external_ip_address: "{{ ansible_host }}"
  519. matrix_coturn_tls_enabled: "{{ matrix_ssl_retrieval_method != 'none' }}"
  520. matrix_coturn_tls_cert_path: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_server_fqn_matrix }}/fullchain.pem"
  521. matrix_coturn_tls_key_path: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_server_fqn_matrix }}/privkey.pem"
  522. matrix_coturn_container_additional_volumes: |
  523. {{
  524. ([] if matrix_ssl_retrieval_method == 'none' else [
  525. {
  526. 'src': matrix_ssl_config_dir_path,
  527. 'dst': matrix_ssl_config_dir_path,
  528. 'options': 'ro',
  529. }
  530. ])
  531. }}
  532. ######################################################################
  533. #
  534. # /matrix-coturn
  535. #
  536. ######################################################################
  537. ######################################################################
  538. #
  539. # matrix-dimension
  540. #
  541. ######################################################################
  542. matrix_dimension_enabled: false
  543. # Normally, matrix-nginx-proxy is enabled and nginx can reach Dimension over the container network.
  544. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  545. # the Dimension HTTP port to the local host.
  546. matrix_dimension_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8184' }}"
  547. matrix_integration_manager_rest_url: "{{ matrix_dimension_integrations_rest_url if matrix_dimension_enabled else None }}"
  548. matrix_integration_manager_ui_url: "{{ matrix_dimension_integrations_ui_url if matrix_dimension_enabled else None }}"
  549. matrix_dimension_systemd_required_services_list: |
  550. {{
  551. ['docker.service']
  552. +
  553. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  554. }}
  555. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  556. matrix_dimension_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  557. matrix_dimension_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'dimension.db') | to_uuid }}"
  558. ######################################################################
  559. #
  560. # /matrix-dimension
  561. #
  562. ######################################################################
  563. ######################################################################
  564. #
  565. # matrix-etherpad
  566. #
  567. ######################################################################
  568. matrix_etherpad_enabled: false
  569. matrix_etherpad_systemd_required_services_list: |
  570. {{
  571. ['docker.service']
  572. +
  573. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  574. }}
  575. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  576. matrix_etherpad_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  577. matrix_etherpad_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'etherpad.db') | to_uuid }}"
  578. ######################################################################
  579. #
  580. # /matrix-etherpad
  581. #
  582. ######################################################################
  583. ######################################################################
  584. #
  585. # matrix-dynamic-dns
  586. #
  587. ######################################################################
  588. matrix_dynamic_dns_enabled: false
  589. ######################################################################
  590. #
  591. # /matrix-dynamic-dns
  592. #
  593. ######################################################################
  594. ######################################################################
  595. #
  596. # matrix-email2matrix
  597. #
  598. ######################################################################
  599. matrix_email2matrix_enabled: false
  600. ######################################################################
  601. #
  602. # /matrix-email2matrix
  603. #
  604. ######################################################################
  605. ######################################################################
  606. #
  607. # matrix-jitsi
  608. #
  609. ######################################################################
  610. matrix_jitsi_enabled: false
  611. # Normally, matrix-nginx-proxy is enabled and nginx can reach jitsi/web over the container network.
  612. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  613. # the Jitsi HTTP port to the local host.
  614. matrix_jitsi_web_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:12080' }}"
  615. matrix_jitsi_jvb_container_colibri_ws_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:12090' }}"
  616. matrix_jitsi_jibri_xmpp_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'jibri') | to_uuid }}"
  617. matrix_jitsi_jicofo_auth_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'jicofo') | to_uuid }}"
  618. matrix_jitsi_jvb_auth_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'jvb') | to_uuid }}"
  619. matrix_jitsi_web_stun_servers: |
  620. {{
  621. [
  622. 'stun:' + matrix_server_fqn_matrix + ':5349',
  623. 'stun:' + matrix_server_fqn_matrix + ':3478',
  624. ]
  625. if matrix_coturn_enabled
  626. else [ 'stun:meet-jit-si-turnrelay.jitsi.net:443']
  627. }}
  628. # If the self-hosted Etherpad instance is available, it will also show up in Jitsi conferences,
  629. # unless explicitly disabled by setting `matrix_jitsi_etherpad_enabled` to false.
  630. # Falls back to the scalar.vector.im etherpad in case someone sets `matrix_jitsi_etherpad_enabled` to true,
  631. # while also setting `matrix_etherpad_enabled` to false.
  632. matrix_jitsi_etherpad_enabled: "{{ matrix_etherpad_enabled }}"
  633. matrix_jitsi_etherpad_base: "{{ matrix_etherpad_base_url if matrix_etherpad_enabled else 'https://scalar.vector.im/etherpad' }}"
  634. ######################################################################
  635. #
  636. # /matrix-jitsi
  637. #
  638. ######################################################################
  639. ######################################################################
  640. #
  641. # matrix-mailer
  642. #
  643. ######################################################################
  644. # By default, this playbook sets up an exim mailer server (running in a container).
  645. # This is so that Synapse can send email reminders for unread messages.
  646. # Other services (like ma1sd), also use the mailer.
  647. matrix_mailer_enabled: true
  648. matrix_mailer_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  649. ######################################################################
  650. #
  651. # /matrix-mailer
  652. #
  653. ######################################################################
  654. ######################################################################
  655. #
  656. # matrix-ma1sd
  657. #
  658. ######################################################################
  659. # By default, this playbook installs the ma1sd identity server on the same domain as Synapse (`matrix_server_fqn_matrix`).
  660. # If you wish to use the public identity servers (matrix.org, vector.im) instead of your own you may wish to disable this.
  661. matrix_ma1sd_enabled: true
  662. # There's no prebuilt ma1sd image for the `arm32` architecture.
  663. # We're relying on self-building there.
  664. matrix_ma1sd_architecture: "{{
  665. {
  666. 'amd64': 'amd64',
  667. 'arm32': 'arm32',
  668. 'arm64': 'arm64',
  669. }[matrix_architecture]
  670. }}"
  671. matrix_ma1sd_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  672. # Normally, matrix-nginx-proxy is enabled and nginx can reach ma1sd over the container network.
  673. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  674. # ma1sd's web-server port.
  675. matrix_ma1sd_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8090' }}"
  676. # We enable Synapse integration via its Postgres database by default.
  677. # When using another Identity store, you might wish to disable this and define
  678. # your own configuration in `matrix_ma1sd_configuration_extension_yaml`.
  679. matrix_ma1sd_synapsesql_enabled: true
  680. matrix_ma1sd_synapsesql_type: postgresql
  681. matrix_ma1sd_synapsesql_connection: //{{ matrix_synapse_database_host }}/{{ matrix_synapse_database_database }}?user={{ matrix_synapse_database_user | urlencode() }}&password={{ matrix_synapse_database_password | urlencode() }}
  682. matrix_ma1sd_dns_overwrite_enabled: true
  683. matrix_ma1sd_dns_overwrite_homeserver_client_name: "{{ matrix_server_fqn_matrix }}"
  684. matrix_ma1sd_dns_overwrite_homeserver_client_value: "http://{{ 'matrix-corporal:41080' if matrix_corporal_enabled else 'matrix-synapse:8008' }}"
  685. # By default, we send mail through the `matrix-mailer` service.
  686. matrix_ma1sd_threepid_medium_email_identity_from: "{{ matrix_mailer_sender_address }}"
  687. matrix_ma1sd_threepid_medium_email_connectors_smtp_host: "matrix-mailer"
  688. matrix_ma1sd_threepid_medium_email_connectors_smtp_port: 8025
  689. matrix_ma1sd_threepid_medium_email_connectors_smtp_tls: 0
  690. matrix_ma1sd_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  691. matrix_ma1sd_systemd_required_services_list: |
  692. {{
  693. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  694. }}
  695. matrix_ma1sd_systemd_wanted_services_list: |
  696. {{
  697. (['matrix-corporal.service'] if matrix_corporal_enabled else ['matrix-synapse.service'])
  698. +
  699. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  700. +
  701. (['matrix-mailer.service'] if matrix_mailer_enabled else [])
  702. }}
  703. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  704. matrix_ma1sd_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  705. matrix_ma1sd_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'ma1sd.db') | to_uuid }}"
  706. ######################################################################
  707. #
  708. # /matrix-ma1sd
  709. #
  710. ######################################################################
  711. ######################################################################
  712. #
  713. # matrix-nginx-proxy
  714. #
  715. ######################################################################
  716. # By default, this playbook sets up a reverse-proxy nginx proxy server on TCP ports 80, 443 and 8448.
  717. # This is fine if you're dedicating the whole server to Matrix.
  718. # If that's not the case, you may wish to disable this and take care of proxying yourself.
  719. matrix_nginx_proxy_enabled: true
  720. matrix_nginx_proxy_proxy_matrix_client_api_addr_with_container: "{{ 'matrix-corporal:41080' if matrix_corporal_enabled else 'matrix-synapse:8008' }}"
  721. matrix_nginx_proxy_proxy_matrix_client_api_addr_sans_container: "{{ '127.0.0.1:41080' if matrix_corporal_enabled else '127.0.0.1:8008' }}"
  722. matrix_nginx_proxy_proxy_matrix_client_api_client_max_body_size_mb: "{{ matrix_synapse_max_upload_size_mb }}"
  723. matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_synapse_admin_api_enabled: "{{ matrix_synapse_admin_enabled }}"
  724. matrix_nginx_proxy_proxy_matrix_client_redirect_root_uri_to_domain: "{{ matrix_server_fqn_element if matrix_client_element_enabled else '' }}"
  725. matrix_nginx_proxy_proxy_matrix_enabled: true
  726. matrix_nginx_proxy_proxy_element_enabled: "{{ matrix_client_element_enabled }}"
  727. matrix_nginx_proxy_proxy_dimension_enabled: "{{ matrix_dimension_enabled }}"
  728. matrix_nginx_proxy_proxy_jitsi_enabled: "{{ matrix_jitsi_enabled }}"
  729. matrix_nginx_proxy_proxy_matrix_corporal_api_enabled: "{{ matrix_corporal_enabled and matrix_corporal_http_api_enabled }}"
  730. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_with_container: "matrix-corporal:41081"
  731. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_sans_container: "127.0.0.1:41081"
  732. matrix_nginx_proxy_proxy_matrix_identity_api_enabled: "{{ matrix_ma1sd_enabled }}"
  733. matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container: "matrix-ma1sd:8090"
  734. matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container: "127.0.0.1:8090"
  735. # By default, we do TLS termination for the Matrix Federation API (port 8448) at matrix-nginx-proxy.
  736. # Unless this is handled there OR Synapse's federation listener port is disabled, we'll reverse-proxy.
  737. matrix_nginx_proxy_proxy_matrix_federation_api_enabled: "{{ matrix_synapse_federation_port_enabled and not matrix_synapse_tls_federation_listener_enabled }}"
  738. matrix_nginx_proxy_proxy_matrix_federation_api_addr_with_container: "matrix-synapse:8048"
  739. matrix_nginx_proxy_proxy_matrix_federation_api_addr_sans_container: "127.0.0.1:8048"
  740. matrix_nginx_proxy_container_federation_host_bind_port: "{{ matrix_federation_public_port }}"
  741. matrix_nginx_proxy_proxy_synapse_metrics: "{{ matrix_synapse_metrics_enabled }}"
  742. matrix_nginx_proxy_proxy_synapse_metrics_addr_with_container: "matrix-synapse:{{ matrix_synapse_metrics_port }}"
  743. matrix_nginx_proxy_proxy_synapse_metrics_addr_sans_container: "127.0.0.1:{{ matrix_synapse_metrics_port }}"
  744. matrix_nginx_proxy_proxy_matrix_user_directory_search_enabled: "{{ matrix_ma1sd_enabled }}"
  745. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_with_container: "{{ matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container }}"
  746. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_sans_container: "{{ matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container }}"
  747. matrix_nginx_proxy_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  748. matrix_nginx_proxy_systemd_wanted_services_list: |
  749. {{
  750. (['matrix-synapse.service'])
  751. +
  752. (['matrix-corporal.service'] if matrix_corporal_enabled else [])
  753. +
  754. (['matrix-ma1sd.service'] if matrix_ma1sd_enabled else [])
  755. +
  756. (['matrix-client-element.service'] if matrix_client_element_enabled else [])
  757. }}
  758. matrix_ssl_domains_to_obtain_certificates_for: |
  759. {{
  760. ([matrix_server_fqn_matrix])
  761. +
  762. ([matrix_server_fqn_element] if matrix_client_element_enabled else [])
  763. +
  764. ([matrix_nginx_proxy_proxy_riot_compat_redirect_hostname] if matrix_nginx_proxy_proxy_riot_compat_redirect_enabled else [])
  765. +
  766. ([matrix_server_fqn_dimension] if matrix_dimension_enabled else [])
  767. +
  768. ([matrix_server_fqn_jitsi] if matrix_jitsi_enabled else [])
  769. +
  770. ([matrix_domain] if matrix_nginx_proxy_base_domain_serving_enabled else [])
  771. }}
  772. matrix_ssl_architecture: "{{
  773. {
  774. 'amd64': 'amd64',
  775. 'arm32': 'arm32v6',
  776. 'arm64': 'arm64v8',
  777. }[matrix_architecture]
  778. }}"
  779. matrix_ssl_pre_obtaining_required_service_name: "{{ 'matrix-dynamic-dns' if matrix_dynamic_dns_enabled else '' }}"
  780. ######################################################################
  781. #
  782. # /matrix-nginx-proxy
  783. #
  784. ######################################################################
  785. ######################################################################
  786. #
  787. # matrix-postgres
  788. #
  789. ######################################################################
  790. matrix_postgres_enabled: true
  791. matrix_postgres_architecture: "{{ matrix_architecture }}"
  792. # We unset this if internal Postgres disabled, which will cascade to some other variables
  793. # and tell users they need to set it (either here or in those variables).
  794. matrix_postgres_connection_hostname: "{{ 'matrix-postgres' if matrix_postgres_enabled else '' }}"
  795. matrix_postgres_pgloader_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  796. matrix_postgres_additional_databases: |
  797. {{
  798. ([{
  799. 'name': matrix_synapse_database_database,
  800. 'username': matrix_synapse_database_user,
  801. 'password': matrix_synapse_database_password,
  802. }] if (matrix_synapse_enabled and matrix_synapse_database_database != matrix_postgres_db_name and matrix_synapse_database_host == 'matrix-postgres') else [])
  803. +
  804. ([{
  805. 'name': matrix_ma1sd_database_name,
  806. 'username': matrix_ma1sd_database_username,
  807. 'password': matrix_ma1sd_database_password,
  808. }] if (matrix_ma1sd_enabled and matrix_ma1sd_database_engine == 'postgres' and matrix_ma1sd_database_hostname == 'matrix-postgres') else [])
  809. +
  810. ([{
  811. 'name': matrix_bot_matrix_reminder_bot_database_name,
  812. 'username': matrix_bot_matrix_reminder_bot_database_username,
  813. 'password': matrix_bot_matrix_reminder_bot_database_password,
  814. }] 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 [])
  815. +
  816. ([{
  817. 'name': matrix_registration_database_name,
  818. 'username': matrix_registration_database_username,
  819. 'password': matrix_registration_database_password,
  820. }] if (matrix_registration_enabled and matrix_registration_database_engine == 'postgres' and matrix_registration_database_hostname == 'matrix-postgres') else [])
  821. +
  822. ([{
  823. 'name': matrix_appservice_discord_database_name,
  824. 'username': matrix_appservice_discord_database_username,
  825. 'password': matrix_appservice_discord_database_password,
  826. }] if (matrix_appservice_discord_enabled and matrix_appservice_discord_database_engine == 'postgres' and matrix_appservice_discord_database_hostname == 'matrix-postgres') else [])
  827. +
  828. ([{
  829. 'name': matrix_appservice_slack_database_name,
  830. 'username': matrix_appservice_slack_database_username,
  831. 'password': matrix_appservice_slack_database_password,
  832. }] if (matrix_appservice_slack_enabled and matrix_appservice_slack_database_engine == 'postgres' and matrix_appservice_slack_database_hostname == 'matrix-postgres') else [])
  833. +
  834. ([{
  835. 'name': matrix_appservice_irc_database_name,
  836. 'username': matrix_appservice_irc_database_username,
  837. 'password': matrix_appservice_irc_database_password,
  838. }] if (matrix_appservice_irc_enabled and matrix_appservice_irc_database_engine == 'postgres' and matrix_appservice_irc_database_hostname == 'matrix-postgres') else [])
  839. +
  840. ([{
  841. 'name': matrix_mautrix_facebook_database_name,
  842. 'username': matrix_mautrix_facebook_database_username,
  843. 'password': matrix_mautrix_facebook_database_password,
  844. }] if (matrix_mautrix_facebook_enabled and matrix_mautrix_facebook_database_engine == 'postgres' and matrix_mautrix_facebook_database_hostname == 'matrix-postgres') else [])
  845. +
  846. ([{
  847. 'name': matrix_mautrix_hangouts_database_name,
  848. 'username': matrix_mautrix_hangouts_database_username,
  849. 'password': matrix_mautrix_hangouts_database_password,
  850. }] if (matrix_mautrix_hangouts_enabled and matrix_mautrix_hangouts_database_engine == 'postgres' and matrix_mautrix_hangouts_database_hostname == 'matrix-postgres') else [])
  851. +
  852. ([{
  853. 'name': matrix_mautrix_signal_database_name,
  854. 'username': matrix_mautrix_signal_database_username,
  855. 'password': matrix_mautrix_signal_database_password,
  856. }] if (matrix_mautrix_signal_enabled and matrix_mautrix_signal_database_engine == 'postgres' and matrix_mautrix_signal_database_hostname == 'matrix-postgres') else [])
  857. +
  858. ([{
  859. 'name': matrix_mautrix_telegram_database_name,
  860. 'username': matrix_mautrix_telegram_database_username,
  861. 'password': matrix_mautrix_telegram_database_password,
  862. }] if (matrix_mautrix_telegram_enabled and matrix_mautrix_telegram_database_engine == 'postgres' and matrix_mautrix_telegram_database_hostname == 'matrix-postgres') else [])
  863. +
  864. ([{
  865. 'name': matrix_mautrix_whatsapp_database_name,
  866. 'username': matrix_mautrix_whatsapp_database_username,
  867. 'password': matrix_mautrix_whatsapp_database_password,
  868. }] if (matrix_mautrix_whatsapp_enabled and matrix_mautrix_whatsapp_database_engine == 'postgres' and matrix_mautrix_whatsapp_database_hostname == 'matrix-postgres') else [])
  869. +
  870. ([{
  871. 'name': matrix_mx_puppet_skype_database_name,
  872. 'username': matrix_mx_puppet_skype_database_username,
  873. 'password': matrix_mx_puppet_skype_database_password,
  874. }] if (matrix_mx_puppet_skype_enabled and matrix_mx_puppet_skype_database_engine == 'postgres' and matrix_mx_puppet_skype_database_hostname == 'matrix-postgres') else [])
  875. +
  876. ([{
  877. 'name': matrix_mx_puppet_slack_database_name,
  878. 'username': matrix_mx_puppet_slack_database_username,
  879. 'password': matrix_mx_puppet_slack_database_password,
  880. }] if (matrix_mx_puppet_slack_enabled and matrix_mx_puppet_slack_database_engine == 'postgres' and matrix_mx_puppet_slack_database_hostname == 'matrix-postgres') else [])
  881. +
  882. ([{
  883. 'name': matrix_mx_puppet_twitter_database_name,
  884. 'username': matrix_mx_puppet_twitter_database_username,
  885. 'password': matrix_mx_puppet_twitter_database_password,
  886. }] if (matrix_mx_puppet_twitter_enabled and matrix_mx_puppet_twitter_database_engine == 'postgres' and matrix_mx_puppet_twitter_database_hostname == 'matrix-postgres') else [])
  887. +
  888. ([{
  889. 'name': matrix_mx_puppet_instagram_database_name,
  890. 'username': matrix_mx_puppet_instagram_database_username,
  891. 'password': matrix_mx_puppet_instagram_database_password,
  892. }] if (matrix_mx_puppet_instagram_enabled and matrix_mx_puppet_instagram_database_engine == 'postgres' and matrix_mx_puppet_instagram_database_hostname == 'matrix-postgres') else [])
  893. +
  894. ([{
  895. 'name': matrix_mx_puppet_discord_database_name,
  896. 'username': matrix_mx_puppet_discord_database_username,
  897. 'password': matrix_mx_puppet_discord_database_password,
  898. }] if (matrix_mx_puppet_discord_enabled and matrix_mx_puppet_discord_database_engine == 'postgres' and matrix_mx_puppet_discord_database_hostname == 'matrix-postgres') else [])
  899. +
  900. ([{
  901. 'name': matrix_mx_puppet_steam_database_name,
  902. 'username': matrix_mx_puppet_steam_database_username,
  903. 'password': matrix_mx_puppet_steam_database_password,
  904. }] if (matrix_mx_puppet_steam_enabled and matrix_mx_puppet_steam_database_engine == 'postgres' and matrix_mx_puppet_steam_database_hostname == 'matrix-postgres') else [])
  905. +
  906. ([{
  907. 'name': matrix_dimension_database_name,
  908. 'username': matrix_dimension_database_username,
  909. 'password': matrix_dimension_database_password,
  910. }] if (matrix_dimension_enabled and matrix_dimension_database_engine == 'postgres' and matrix_dimension_database_hostname == 'matrix-postgres') else [])
  911. +
  912. ([{
  913. 'name': matrix_etherpad_database_name,
  914. 'username': matrix_etherpad_database_username,
  915. 'password': matrix_etherpad_database_password,
  916. }] if (matrix_etherpad_enabled and matrix_etherpad_database_engine == 'postgres' and matrix_etherpad_database_hostname == 'matrix-postgres') else [])
  917. }}
  918. matrix_postgres_import_roles_to_ignore: |
  919. {{
  920. [matrix_postgres_connection_username]
  921. +
  922. matrix_postgres_additional_databases|map(attribute='username')|list
  923. }}
  924. matrix_postgres_import_databases_to_ignore: |
  925. {{
  926. [matrix_postgres_db_name]
  927. +
  928. matrix_postgres_additional_databases|map(attribute='name')|list
  929. }}
  930. ######################################################################
  931. #
  932. # /matrix-postgres
  933. #
  934. ######################################################################
  935. ######################################################################
  936. #
  937. # matrix-client-element
  938. #
  939. ######################################################################
  940. # By default, this playbook installs the Element web UI on the `matrix_server_fqn_element` domain.
  941. # If you wish to connect to your Matrix server by other means, you may wish to disable this.
  942. matrix_client_element_enabled: true
  943. matrix_client_element_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  944. # Normally, matrix-nginx-proxy is enabled and nginx can reach Element over the container network.
  945. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  946. # the Element HTTP port to the local host.
  947. matrix_client_element_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8765' }}"
  948. matrix_client_element_default_hs_url: "{{ matrix_homeserver_url }}"
  949. matrix_client_element_default_is_url: "{{ matrix_identity_server_url }}"
  950. # Use Dimension if enabled, otherwise fall back to Scalar
  951. matrix_client_element_integrations_ui_url: "{{ matrix_dimension_integrations_ui_url if matrix_dimension_enabled else 'https://scalar.vector.im/' }}"
  952. matrix_client_element_integrations_rest_url: "{{ matrix_dimension_integrations_rest_url if matrix_dimension_enabled else 'https://scalar.vector.im/api' }}"
  953. matrix_client_element_integrations_widgets_urls: "{{ matrix_dimension_integrations_widgets_urls if matrix_dimension_enabled else ['https://scalar.vector.im/api'] }}"
  954. 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' }}"
  955. matrix_client_element_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  956. matrix_client_element_registration_enabled: "{{ matrix_synapse_enable_registration }}"
  957. matrix_client_element_enable_presence_by_hs_url: |
  958. {{
  959. none
  960. if matrix_synapse_use_presence
  961. else {matrix_client_element_default_hs_url: false}
  962. }}
  963. matrix_client_element_welcome_user_id: ~
  964. matrix_client_element_jitsi_preferredDomain: "{{ matrix_server_fqn_jitsi if matrix_jitsi_enabled else '' }}"
  965. ######################################################################
  966. #
  967. # /matrix-client-element
  968. #
  969. ######################################################################
  970. ######################################################################
  971. #
  972. # matrix-synapse
  973. #
  974. ######################################################################
  975. matrix_synapse_container_image_self_build: "{{ matrix_architecture not in ['arm32', 'arm64', 'amd64'] }}"
  976. # When ma1sd is enabled, we can use it to validate email addresses and phone numbers.
  977. # 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.
  978. matrix_synapse_account_threepid_delegates_email: "{{ 'http://matrix-ma1sd:8090' if matrix_ma1sd_enabled else '' }}"
  979. matrix_synapse_account_threepid_delegates_msisdn: "{{ 'http://matrix-ma1sd:8090' if matrix_ma1sd_enabled else '' }}"
  980. # Normally, matrix-nginx-proxy is enabled and nginx can reach Synapse over the container network.
  981. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it,
  982. # you can expose Synapse's ports to the host.
  983. #
  984. # For exposing the Matrix Client API's port (plain HTTP) to the local host.
  985. matrix_synapse_container_client_api_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8008' }}"
  986. #
  987. # For exposing the Matrix Federation API's plain port (plain HTTP) to the local host.
  988. matrix_synapse_container_federation_api_plain_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8048' }}"
  989. #
  990. # For exposing the Matrix Federation API's TLS port (HTTPS) to the internet on all network interfaces.
  991. 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 '' }}"
  992. #
  993. # For exposing the Synapse Metrics API's port (plain HTTP) to the local host.
  994. 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 '' }}"
  995. #
  996. # For exposing the Synapse Manhole port (plain HTTP) to the local host.
  997. matrix_synapse_container_manhole_api_host_bind_port: "{{ '127.0.0.1:9000' if matrix_synapse_manhole_enabled else '' }}"
  998. matrix_synapse_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'synapse.db') | to_uuid }}"
  999. # We do not enable TLS in Synapse by default.
  1000. # TLS is handled by the matrix-nginx-proxy, which proxies the requests to Synapse.
  1001. matrix_synapse_tls_federation_listener_enabled: false
  1002. matrix_synapse_tls_certificate_path: ~
  1003. matrix_synapse_tls_private_key_path: ~
  1004. matrix_synapse_federation_port_openid_resource_required: "{{ not matrix_synapse_federation_enabled and (matrix_dimension_enabled or matrix_ma1sd_enabled) }}"
  1005. matrix_synapse_email_enabled: "{{ matrix_mailer_enabled }}"
  1006. matrix_synapse_email_smtp_host: "matrix-mailer"
  1007. matrix_synapse_email_smtp_port: 8025
  1008. matrix_synapse_email_smtp_require_transport_security: false
  1009. matrix_synapse_email_notif_from: "Matrix <{{ matrix_mailer_sender_address }}>"
  1010. # Even if TURN doesn't support TLS (it does by default),
  1011. # it doesn't hurt to try a secure connection anyway.
  1012. matrix_synapse_turn_uris: |
  1013. {{
  1014. [
  1015. 'turns:' + matrix_server_fqn_matrix + '?transport=udp',
  1016. 'turns:' + matrix_server_fqn_matrix + '?transport=tcp',
  1017. 'turn:' + matrix_server_fqn_matrix + '?transport=udp',
  1018. 'turn:' + matrix_server_fqn_matrix + '?transport=tcp',
  1019. ]
  1020. if matrix_coturn_enabled
  1021. else []
  1022. }}
  1023. matrix_synapse_turn_shared_secret: "{{ matrix_coturn_turn_static_auth_secret if matrix_coturn_enabled else '' }}"
  1024. matrix_synapse_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1025. matrix_synapse_systemd_required_services_list: |
  1026. {{
  1027. (['docker.service'])
  1028. +
  1029. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1030. +
  1031. (['matrix-goofys'] if matrix_s3_media_store_enabled else [])
  1032. }}
  1033. matrix_synapse_systemd_wanted_services_list: |
  1034. {{
  1035. (['matrix-coturn.service'] if matrix_coturn_enabled else [])
  1036. +
  1037. (['matrix-mailer.service'] if matrix_mailer_enabled else [])
  1038. }}
  1039. ######################################################################
  1040. #
  1041. # /matrix-synapse
  1042. #
  1043. ######################################################################
  1044. ######################################################################
  1045. #
  1046. # matrix-synapse-admin
  1047. #
  1048. ######################################################################
  1049. matrix_synapse_admin_enabled: false
  1050. # Normally, matrix-nginx-proxy is enabled and nginx can reach Synapse Admin over the container network.
  1051. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1052. # Synapse Admin's HTTP port to the local host.
  1053. matrix_synapse_admin_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8766' }}"
  1054. matrix_synapse_admin_container_self_build: "{{ matrix_architecture != 'amd64' }}"
  1055. ######################################################################
  1056. #
  1057. # /matrix-synapse-admin
  1058. #
  1059. ######################################################################
  1060. ######################################################################
  1061. #
  1062. # matrix-registration
  1063. #
  1064. ######################################################################
  1065. matrix_registration_enabled: false
  1066. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-registration over the container network.
  1067. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1068. # matrix-registration's HTTP port to the local host.
  1069. matrix_registration_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8767' }}"
  1070. matrix_registration_riot_instance: "{{ ('https://' + matrix_server_fqn_element) if matrix_client_element_enabled else 'https://riot.im/app/' }}"
  1071. matrix_registration_shared_secret: "{{ matrix_synapse_registration_shared_secret if matrix_synapse_enabled else '' }}"
  1072. matrix_registration_server_location: "{{ 'http://matrix-synapse:8008' if matrix_synapse_enabled else '' }}"
  1073. matrix_registration_api_validate_certs: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1074. matrix_registration_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1075. matrix_registration_systemd_required_services_list: |
  1076. {{
  1077. ['docker.service']
  1078. +
  1079. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1080. }}
  1081. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  1082. matrix_registration_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  1083. matrix_registration_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mx.registr.db') | to_uuid }}"
  1084. ######################################################################
  1085. #
  1086. # /matrix-registration
  1087. #
  1088. ######################################################################