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.
 
 

1906 righe
80 KiB

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