Matrix Docker Ansible eploy
Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.
 
 

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