Matrix Docker Ansible eploy
Non puoi selezionare più di 25 argomenti Gli argomenti devono iniziare con una lettera o un numero, possono includere trattini ('-') e possono essere lunghi fino a 35 caratteri.
 
 

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