Matrix Docker Ansible eploy
Não pode escolher mais do que 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.
 
 

3062 linhas
140 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. # Playbook #
  13. # #
  14. ########################################################################
  15. # Controls whether to install Docker or not
  16. # Also see `devture_docker_sdk_for_python_installation_enabled`.
  17. matrix_playbook_docker_installation_enabled: true
  18. # This list is not exhaustive and final.
  19. # Synapse workers are still injected into the list at runtime.
  20. # Additional JVB workers (playbooks/jitsi_jvb.yml -- roles/custom/matrix-jitsi/tasks/init_additional_jvb.yml) override this variable at runtime as well.
  21. #
  22. # Priority levels are like this:
  23. # - core services (the homeserver) get a level of ~1000
  24. # - services that core services depend on (database, Redis, ntfy, etc.) get a lower level - between 500 and 1000
  25. # - reverse-proxying services get level 3000
  26. # - Matrix utility services (bridges, bots) get a level of 2000/2200, so that:
  27. # - they can start before the reverse-proxy
  28. # - so that, when the reverse-proxy is up (Matrix is up), all bots and bridges can be interacted with
  29. # - monitoring services (Prometheus, Grafana, ..) get a level of 4000 - they can start later than all-of-Matrix
  30. # - services which aren't time-sensitive (various crons and timers) get a level of 5000 - they can start later than all-of-Matrix
  31. matrix_systemd_services_list_auto: |
  32. {{
  33. ([{'name': 'matrix-backup-borg.timer', 'priority': 5000}] if matrix_backup_borg_enabled else [])
  34. +
  35. ([{'name': 'matrix-bot-buscarron.service', 'priority': 2200}] if matrix_bot_buscarron_enabled else [])
  36. +
  37. ([{'name': 'matrix-bot-go-neb.service', 'priority': 2200}] if matrix_bot_go_neb_enabled else [])
  38. +
  39. ([{'name': 'matrix-bot-honoroit.service', 'priority': 2200}] if matrix_bot_honoroit_enabled else [])
  40. +
  41. ([{'name': 'matrix-bot-matrix-registration-bot.service', 'priority': 2200}] if matrix_bot_matrix_registration_bot_enabled else [])
  42. +
  43. ([{'name': 'matrix-bot-matrix-reminder-bot.service', 'priority': 2200}] if matrix_bot_matrix_reminder_bot_enabled else [])
  44. +
  45. ([{'name': 'matrix-bot-maubot.service', 'priority': 2200}] if matrix_bot_maubot_enabled else [])
  46. +
  47. ([{'name': 'matrix-bot-mjolnir.service', 'priority': 2200}] if matrix_bot_mjolnir_enabled else [])
  48. +
  49. ([{'name': 'matrix-bot-postmoogle.service', 'priority': 2200}] if matrix_bot_postmoogle_enabled else [])
  50. +
  51. ([{'name': 'matrix-appservice-discord.service', 'priority': 2000}] if matrix_appservice_discord_enabled else [])
  52. +
  53. ([{'name': 'matrix-appservice-irc.service', 'priority': 2000}] if matrix_appservice_irc_enabled else [])
  54. +
  55. ([{'name': 'matrix-appservice-kakaotalk.service', 'priority': 2000}] if matrix_appservice_kakaotalk_enabled else [])
  56. +
  57. ([{'name': 'matrix-appservice-kakaotalk-node.service', 'priority': 1900}] if matrix_appservice_kakaotalk_enabled else [])
  58. +
  59. ([{'name': 'matrix-appservice-slack.service', 'priority': 2000}] if matrix_appservice_slack_enabled else [])
  60. +
  61. ([{'name': 'matrix-appservice-webhooks.service', 'priority': 2000}] if matrix_appservice_webhooks_enabled else [])
  62. +
  63. ([{'name': 'matrix-beeper-linkedin.service', 'priority': 2000}] if matrix_beeper_linkedin_enabled else [])
  64. +
  65. ([{'name': 'matrix-go-skype-bridge.service', 'priority': 2000}] if matrix_go_skype_bridge_enabled else [])
  66. +
  67. ([{'name': 'matrix-heisenbridge.service', 'priority': 2000}] if matrix_heisenbridge_enabled else [])
  68. +
  69. ([{'name': 'matrix-hookshot.service', 'priority': 2000}] if matrix_hookshot_enabled else [])
  70. +
  71. ([{'name': 'matrix-mautrix-discord.service', 'priority': 2000}] if matrix_mautrix_discord_enabled else [])
  72. +
  73. ([{'name': 'matrix-mautrix-facebook.service', 'priority': 2000}] if matrix_mautrix_facebook_enabled else [])
  74. +
  75. ([{'name': 'matrix-mautrix-googlechat.service', 'priority': 2000}] if matrix_mautrix_googlechat_enabled else [])
  76. +
  77. ([{'name': 'matrix-mautrix-hangouts.service', 'priority': 2000}] if matrix_mautrix_hangouts_enabled else [])
  78. +
  79. ([{'name': 'matrix-mautrix-instagram.service', 'priority': 2000}] if matrix_mautrix_instagram_enabled else [])
  80. +
  81. ([{'name': 'matrix-mautrix-signal.service', 'priority': 2000}] if matrix_mautrix_signal_enabled else [])
  82. +
  83. ([{'name': 'matrix-mautrix-signal-daemon.service', 'priority': 1900}] if matrix_mautrix_signal_enabled else [])
  84. +
  85. ([{'name': 'matrix-mautrix-telegram.service', 'priority': 2000}] if matrix_mautrix_telegram_enabled else [])
  86. +
  87. ([{'name': 'matrix-mautrix-twitter.service', 'priority': 2000}] if matrix_mautrix_twitter_enabled else [])
  88. +
  89. ([{'name': 'matrix-mautrix-whatsapp.service', 'priority': 2000}] if matrix_mautrix_whatsapp_enabled else [])
  90. +
  91. ([{'name': 'matrix-mx-puppet-discord.service', 'priority': 2000}] if matrix_mx_puppet_discord_enabled else [])
  92. +
  93. ([{'name': 'matrix-mx-puppet-groupme.service', 'priority': 2000}] if matrix_mx_puppet_groupme_enabled else [])
  94. +
  95. ([{'name': 'matrix-mx-puppet-instagram.service', 'priority': 2000}] if matrix_mx_puppet_instagram_enabled else [])
  96. +
  97. ([{'name': 'matrix-mx-puppet-slack.service', 'priority': 2000}] if matrix_mx_puppet_slack_enabled else [])
  98. +
  99. ([{'name': 'matrix-mx-puppet-steam.service', 'priority': 2000}] if matrix_mx_puppet_steam_enabled else [])
  100. +
  101. ([{'name': 'matrix-mx-puppet-twitter.service', 'priority': 2000}] if matrix_mx_puppet_twitter_enabled else [])
  102. +
  103. ([{'name': 'matrix-sms-bridge.service', 'priority': 2000}] if matrix_sms_bridge_enabled else [])
  104. +
  105. ([{'name': 'matrix-cactus-comments.service', 'priority': 2000}] if matrix_cactus_comments_enabled else [])
  106. +
  107. ([{'name': 'matrix-client-cinny.service', 'priority': 2000}] if matrix_client_cinny_enabled else [])
  108. +
  109. ([{'name': 'matrix-client-element.service', 'priority': 2000}] if matrix_client_element_enabled else [])
  110. +
  111. ([{'name': 'matrix-client-hydrogen.service', 'priority': 2000}] if matrix_client_hydrogen_enabled else [])
  112. +
  113. ([{'name': ('matrix-' + matrix_homeserver_implementation + '.service'), 'priority': 1000}])
  114. +
  115. ([{'name': 'matrix-corporal.service', 'priority': 1500}] if matrix_corporal_enabled else [])
  116. +
  117. ([{'name': 'matrix-coturn.service', 'priority': 4000}] if matrix_coturn_enabled else [])
  118. +
  119. ([{'name': 'matrix-coturn-reload.timer', 'priority': 5000}] if (matrix_coturn_enabled and matrix_coturn_tls_enabled) else [])
  120. +
  121. ([{'name': 'matrix-dimension.service', 'priority': 2500}] if matrix_dimension_enabled else [])
  122. +
  123. ([{'name': 'matrix-dynamic-dns.service', 'priority': 5000}] if matrix_dynamic_dns_enabled else [])
  124. +
  125. ([{'name': 'matrix-email2matrix.service', 'priority': 2000}] if matrix_email2matrix_enabled else [])
  126. +
  127. ([{'name': 'matrix-etherpad.service', 'priority': 4000}] if matrix_etherpad_enabled else [])
  128. +
  129. ([{'name': 'matrix-grafana.service', 'priority': 4000}] if matrix_grafana_enabled else [])
  130. +
  131. ([{'name': 'matrix-jitsi-web.service', 'priority': 4200}] if matrix_jitsi_enabled else [])
  132. +
  133. ([{'name': 'matrix-jitsi-prosody.service', 'priority': 4000}] if matrix_jitsi_enabled else [])
  134. +
  135. ([{'name': 'matrix-jitsi-jicofo.service', 'priority': 4100}] if matrix_jitsi_enabled else [])
  136. +
  137. ([{'name': 'matrix-jitsi-jvb.service', 'priority': 4100}] if matrix_jitsi_enabled else [])
  138. +
  139. ([{'name': 'matrix-ldap-registration-proxy.service', 'priority': 2000}] if matrix_ldap_registration_proxy_enabled else [])
  140. +
  141. ([{'name': 'matrix-ma1sd.service', 'priority': 2000}] if matrix_ma1sd_enabled else [])
  142. +
  143. ([{'name': 'matrix-mailer.service', 'priority': 2000}] if matrix_mailer_enabled else [])
  144. +
  145. ([{'name': 'matrix-nginx-proxy.service', 'priority': 3000}] if matrix_nginx_proxy_enabled else [])
  146. +
  147. (matrix_ssl_renewal_systemd_units_list | selectattr('applicable'))
  148. +
  149. ([{'name': 'matrix-ntfy.service', 'priority': 800}] if matrix_ntfy_enabled else [])
  150. +
  151. ([{'name': 'matrix-postgres.service', 'priority': 500}] if matrix_postgres_enabled else [])
  152. +
  153. ([{'name': 'matrix-postgres-backup.service', 'priority': 3000}] if matrix_postgres_backup_enabled else [])
  154. +
  155. ([{'name': 'matrix-prometheus.service', 'priority': 4000}] if matrix_prometheus_enabled else [])
  156. +
  157. ([{'name': 'matrix-prometheus-node-exporter.service', 'priority': 3900}] if matrix_prometheus_node_exporter_enabled else [])
  158. +
  159. ([{'name': 'matrix-prometheus-postgres-exporter.service', 'priority': 3900}] if matrix_prometheus_postgres_exporter_enabled else [])
  160. +
  161. ([{'name': 'matrix-redis', 'priority': 750}] if matrix_redis_enabled else [])
  162. +
  163. ([{'name': 'matrix-registration.service', 'priority': 4000}] if matrix_registration_enabled else [])
  164. +
  165. ([{'name': 'matrix-sygnal.service', 'priority': 800}] if matrix_sygnal_enabled else [])
  166. +
  167. ([{'name': 'matrix-goofys.service', 'priority': 800}] if matrix_s3_media_store_enabled else [])
  168. +
  169. ([{'name': 'matrix-synapse-s3-storage-provider-migrate.timer', 'priority': 5000}] if matrix_synapse_ext_synapse_s3_storage_provider_enabled else [])
  170. +
  171. ([{'name': 'matrix-synapse-admin.service', 'priority': 4000}] if matrix_synapse_admin_enabled else [])
  172. +
  173. ([{'name': 'matrix-synapse-reverse-proxy-companion.service', 'priority': 1500}] if matrix_synapse_reverse_proxy_companion_enabled else [])
  174. }}
  175. matrix_homeserver_app_service_config_files_auto: |
  176. {{
  177. (['--mount type=bind,src=' + matrix_appservice_discord_config_path + '/registration.yaml,dst=/matrix-appservice-discord-registration.yaml,ro'] if matrix_appservice_discord_enabled else [])
  178. +
  179. (['--mount type=bind,src=' + matrix_appservice_irc_config_path + '/registration.yaml,dst=/matrix-appservice-irc-registration.yaml,ro'] if matrix_appservice_irc_enabled else [])
  180. +
  181. (['--mount type=bind,src=' + matrix_appservice_kakaotalk_config_path + '/registration.yaml,dst=/matrix-appservice-kakaotalk-registration.yaml,ro'] if matrix_appservice_kakaotalk_enabled else [])
  182. +
  183. (['--mount type=bind,src=' + matrix_appservice_slack_config_path + '/slack-registration.yaml,dst=/matrix-appservice-slack-registration.yaml,ro'] if matrix_appservice_slack_enabled else [])
  184. +
  185. (['--mount type=bind,src=' + matrix_appservice_webhooks_config_path + '/webhooks-registration.yaml,dst=/matrix-appservice-webhooks-registration.yaml,ro'] if matrix_appservice_webhooks_enabled else [])
  186. +
  187. (['--mount type=bind,src=' + matrix_beeper_linkedin_config_path + '/registration.yaml,dst=/matrix-beeper-linkedin-registration.yaml,ro'] if matrix_beeper_linkedin_enabled else [])
  188. +
  189. (['--mount type=bind,src=' + matrix_go_skype_bridge_config_path + '/registration.yaml,dst=/matrix-go-skype-bridge-registration.yaml,ro'] if matrix_go_skype_bridge_enabled else [])
  190. +
  191. (['--mount type=bind,src=' + matrix_heisenbridge_base_path + '/registration.yaml,dst=/heisenbridge-registration.yaml,ro'] if matrix_heisenbridge_enabled else [])
  192. +
  193. (['--mount type=bind,src=' + matrix_hookshot_base_path + '/registration.yml,dst=/hookshot-registration.yml,ro'] if matrix_hookshot_enabled else [])
  194. +
  195. (['--mount type=bind,src=' + matrix_mautrix_discord_config_path + '/registration.yaml,dst=/matrix-mautrix-discord-registration.yaml,ro'] if matrix_mautrix_discord_enabled else [])
  196. +
  197. (['--mount type=bind,src=' + matrix_mautrix_facebook_config_path + '/registration.yaml,dst=/matrix-mautrix-facebook-registration.yaml,ro'] if matrix_mautrix_facebook_enabled else [])
  198. +
  199. (['--mount type=bind,src=' + matrix_mautrix_googlechat_config_path + '/registration.yaml,dst=/matrix-mautrix-googlechat-registration.yaml,ro'] if matrix_mautrix_googlechat_enabled else [])
  200. +
  201. (['--mount type=bind,src=' + matrix_mautrix_hangouts_config_path + '/registration.yaml,dst=/matrix-mautrix-hangouts-registration.yaml,ro'] if matrix_mautrix_hangouts_enabled else [])
  202. +
  203. (['--mount type=bind,src=' + matrix_mautrix_instagram_config_path + '/registration.yaml,dst=/matrix-mautrix-instagram-registration.yaml,ro'] if matrix_mautrix_instagram_enabled else [])
  204. +
  205. (['--mount type=bind,src=' + matrix_mautrix_signal_config_path + '/registration.yaml,dst=/matrix-mautrix-signal-registration.yaml,ro'] if matrix_mautrix_signal_enabled else [])
  206. +
  207. (['--mount type=bind,src=' + matrix_mautrix_telegram_config_path + '/registration.yaml,dst=/matrix-mautrix-telegram-registration.yaml,ro'] if matrix_mautrix_telegram_enabled else [])
  208. +
  209. (['--mount type=bind,src=' + matrix_mautrix_twitter_config_path + '/registration.yaml,dst=/matrix-mautrix-twitter-registration.yaml,ro'] if matrix_mautrix_twitter_enabled else [])
  210. +
  211. (['--mount type=bind,src=' + matrix_mautrix_whatsapp_config_path + '/registration.yaml,dst=/matrix-mautrix-whatsapp-registration.yaml,ro'] if matrix_mautrix_whatsapp_enabled else [])
  212. +
  213. (['--mount type=bind,src=' + matrix_mx_puppet_discord_config_path + '/registration.yaml,dst=/matrix-mx-puppet-discord-registration.yaml,ro'] if matrix_mx_puppet_discord_enabled else [])
  214. +
  215. (['--mount type=bind,src=' + matrix_mx_puppet_groupme_config_path + '/registration.yaml,dst=/matrix-mx-puppet-groupme-registration.yaml,ro'] if matrix_mx_puppet_groupme_enabled else [])
  216. +
  217. (['--mount type=bind,src=' + matrix_mx_puppet_instagram_config_path + '/registration.yaml,dst=/matrix-mx-puppet-instagram-registration.yaml,ro'] if matrix_mx_puppet_instagram_enabled else [])
  218. +
  219. (['--mount type=bind,src=' + matrix_mx_puppet_slack_config_path + '/registration.yaml,dst=/matrix-mx-puppet-slack-registration.yaml,ro'] if matrix_mx_puppet_slack_enabled else [])
  220. +
  221. (['--mount type=bind,src=' + matrix_mx_puppet_steam_config_path + '/registration.yaml,dst=/matrix-mx-puppet-steam-registration.yaml,ro'] if matrix_mx_puppet_steam_enabled else [])
  222. +
  223. (['--mount type=bind,src=' + matrix_mx_puppet_twitter_config_path + '/registration.yaml,dst=/matrix-mx-puppet-twitter-registration.yaml,ro'] if matrix_mx_puppet_twitter_enabled else [])
  224. +
  225. (['--mount type=bind,src=' + matrix_sms_bridge_config_path + '/registration.yaml,dst=/matrix-sms-bridge-registration.yaml,ro'] if matrix_sms_bridge_enabled else [])
  226. +
  227. (['--mount type=bind,src=' + matrix_cactus_comments_app_service_config_file + ',dst=/matrix-cactus-comments.yaml,ro'] if matrix_cactus_comments_enabled else [])
  228. }}
  229. matrix_homeserver_additional_config_files_auto: |
  230. {{
  231. (['/matrix-appservice-discord-registration.yaml'] if matrix_appservice_discord_enabled else [])
  232. +
  233. (['/matrix-appservice-irc-registration.yaml'] if matrix_appservice_irc_enabled else [])
  234. +
  235. (['/matrix-appservice-kakaotalk-registration.yaml'] if matrix_appservice_kakaotalk_enabled else [])
  236. +
  237. (['/matrix-appservice-slack-registration.yaml'] if matrix_appservice_slack_enabled else [])
  238. +
  239. (['/matrix-appservice-webhooks-registration.yaml'] if matrix_appservice_webhooks_enabled else [])
  240. +
  241. (['/matrix-beeper-linkedin-registration.yaml'] if matrix_beeper_linkedin_enabled else [])
  242. +
  243. (['/matrix-go-skype-bridge-registration.yaml'] if matrix_go_skype_bridge_enabled else [])
  244. +
  245. (['/heisenbridge-registration.yaml'] if matrix_heisenbridge_enabled else [])
  246. +
  247. (['/hookshot-registration.yml'] if matrix_hookshot_enabled else [])
  248. +
  249. (['/matrix-mautrix-discord-registration.yaml'] if matrix_mautrix_discord_enabled else [])
  250. +
  251. (['/matrix-mautrix-facebook-registration.yaml'] if matrix_mautrix_facebook_enabled else [])
  252. +
  253. (['/matrix-mautrix-googlechat-registration.yaml'] if matrix_mautrix_googlechat_enabled else [])
  254. +
  255. (['/matrix-mautrix-hangouts-registration.yaml'] if matrix_mautrix_hangouts_enabled else [])
  256. +
  257. (['/matrix-mautrix-instagram-registration.yaml'] if matrix_mautrix_instagram_enabled else [])
  258. +
  259. (['/matrix-mautrix-signal-registration.yaml'] if matrix_mautrix_signal_enabled else [])
  260. +
  261. (['/matrix-mautrix-telegram-registration.yaml'] if matrix_mautrix_telegram_enabled else [])
  262. +
  263. (['/matrix-mautrix-twitter-registration.yaml'] if matrix_mautrix_twitter_enabled else [])
  264. +
  265. (['/matrix-mautrix-whatsapp-registration.yaml'] if matrix_mautrix_whatsapp_enabled else [])
  266. +
  267. (['/matrix-mx-puppet-discord-registration.yaml'] if matrix_mx_puppet_discord_enabled else [])
  268. +
  269. (['/matrix-mx-puppet-groupme-registration.yaml'] if matrix_mx_puppet_groupme_enabled else [])
  270. +
  271. (['/matrix-mx-puppet-instagram-registration.yaml'] if matrix_mx_puppet_instagram_enabled else [])
  272. +
  273. (['/matrix-mx-puppet-slack-registration.yaml'] if matrix_mx_puppet_slack_enabled else [])
  274. +
  275. (['/matrix-mx-puppet-steam-registration.yaml'] if matrix_mx_puppet_steam_enabled else [])
  276. +
  277. (['/matrix-mx-puppet-twitter-registration.yaml'] if matrix_mx_puppet_twitter_enabled else [])
  278. +
  279. (['/matrix-sms-bridge-registration.yaml'] if matrix_sms_bridge_enabled else [])
  280. +
  281. (['/matrix-cactus-comments.yaml'] if matrix_cactus_comments_enabled else [])
  282. }}
  283. ########################################################################
  284. # #
  285. # /Playbook #
  286. # #
  287. ########################################################################
  288. ########################################################################
  289. # #
  290. # com.devture.ansible.role.timesync #
  291. # #
  292. ########################################################################
  293. # To completely disable installing systemd-timesyncd/ntpd, use `devture_timesync_installation_enabled: false`.
  294. ########################################################################
  295. # #
  296. # /com.devture.ansible.role.timesync #
  297. # #
  298. ########################################################################
  299. ######################################################################
  300. #
  301. # com.devture.ansible.role.playbook_state_preserver
  302. #
  303. ######################################################################
  304. # To completely disable this feature, use `devture_playbook_state_preserver_enabled: false`.
  305. devture_playbook_state_preserver_uid: "{{ matrix_user_uid }}"
  306. devture_playbook_state_preserver_gid: "{{ matrix_user_gid }}"
  307. devture_playbook_state_preserver_vars_preservation_dst: "{{ matrix_base_data_path }}/vars.yml"
  308. devture_playbook_state_preserver_commit_hash_preservation_dst: "{{ matrix_base_data_path }}/git_hash.yml"
  309. ######################################################################
  310. #
  311. # /com.devture.ansible.role.playbook_state_preserver
  312. #
  313. ######################################################################
  314. ######################################################################
  315. #
  316. # matrix-base
  317. #
  318. ######################################################################
  319. matrix_identity_server_url: "{{ ('https://' + matrix_server_fqn_matrix) if matrix_ma1sd_enabled else None }}"
  320. matrix_homeserver_container_url: |-
  321. {{
  322. 'http://matrix-nginx-proxy:12080' if matrix_nginx_proxy_enabled else {
  323. 'synapse': ('http://matrix-synapse-reverse-proxy-companion:8008' if matrix_synapse_reverse_proxy_companion_enabled else 'http://matrix-synapse:'+ matrix_synapse_container_client_api_port|string),
  324. 'dendrite': ('http://matrix-dendrite:' + matrix_dendrite_http_bind_port|string),
  325. 'conduit': ('http://matrix-conduit:' + matrix_conduit_port_number|string),
  326. }[matrix_homeserver_implementation]
  327. }}
  328. matrix_homeserver_container_federation_url: |-
  329. {{
  330. 'http://matrix-nginx-proxy:12088' if matrix_nginx_proxy_enabled else {
  331. 'synapse': ('http://matrix-synapse-reverse-proxy-companion:8048' if matrix_synapse_reverse_proxy_companion_enabled else 'http://matrix-synapse:'+ matrix_synapse_container_federation_api_plain_port|string),
  332. 'dendrite': ('http://matrix-dendrite:' + matrix_dendrite_http_bind_port|string),
  333. 'conduit': ('http://matrix-conduit:' + matrix_conduit_port_number|string),
  334. }[matrix_homeserver_implementation]
  335. }}
  336. matrix_integration_manager_rest_url: "{{ matrix_dimension_integrations_rest_url if matrix_dimension_enabled else None }}"
  337. matrix_integration_manager_ui_url: "{{ matrix_dimension_integrations_ui_url if matrix_dimension_enabled else None }}"
  338. ######################################################################
  339. #
  340. # /matrix-base
  341. #
  342. ######################################################################
  343. ######################################################################
  344. #
  345. # matrix-bridge-appservice-discord
  346. #
  347. ######################################################################
  348. # We don't enable bridges by default.
  349. matrix_appservice_discord_enabled: false
  350. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-discord over the container network.
  351. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  352. # matrix-appservice-discord's client-server port to the local host.
  353. matrix_appservice_discord_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9005' }}"
  354. # If the homeserver disables presence, it's likely better (less wasteful) to also disable presence on the bridge side.
  355. matrix_appservice_discord_bridge_disablePresence: "{{ not matrix_synapse_presence_enabled }}"
  356. matrix_appservice_discord_systemd_required_services_list: |
  357. {{
  358. ['docker.service']
  359. +
  360. ['matrix-' + matrix_homeserver_implementation + '.service']
  361. +
  362. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  363. +
  364. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  365. }}
  366. matrix_appservice_discord_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'discord.as.token') | to_uuid }}"
  367. matrix_appservice_discord_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'discord.hs.token') | to_uuid }}"
  368. # We only make this use Postgres if our own Postgres server is enabled.
  369. # It's only then (for now) that we can automatically create the necessary database and user for this service.
  370. matrix_appservice_discord_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  371. matrix_appservice_discord_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'as.discord.db') | to_uuid }}"
  372. ######################################################################
  373. #
  374. # /matrix-bridge-appservice-discord
  375. #
  376. ######################################################################
  377. ######################################################################
  378. #
  379. # matrix-appservice-webhooks
  380. #
  381. ######################################################################
  382. # We don't enable bridges by default.
  383. matrix_appservice_webhooks_enabled: false
  384. matrix_appservice_webhooks_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  385. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-webhooks over the container network.
  386. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  387. # matrix-appservice-webhooks' client-server port to the local host.
  388. matrix_appservice_webhooks_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else ('127.0.0.1:' ~ matrix_appservice_webhooks_matrix_port) }}"
  389. matrix_appservice_webhooks_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'webhook.as.token') | to_uuid }}"
  390. matrix_appservice_webhooks_homeserver_url: "{{ matrix_homeserver_container_url }}"
  391. matrix_appservice_webhooks_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'webhook.hs.token') | to_uuid }}"
  392. matrix_appservice_webhooks_id_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'webhook.id.token') | to_uuid }}"
  393. matrix_appservice_webhooks_systemd_required_services_list: |
  394. {{
  395. ['docker.service']
  396. +
  397. ['matrix-' + matrix_homeserver_implementation + '.service']
  398. +
  399. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  400. }}
  401. ######################################################################
  402. #
  403. # /matrix-appservice-webhooks
  404. #
  405. ######################################################################
  406. ######################################################################
  407. #
  408. # matrix-appservice-slack
  409. #
  410. ######################################################################
  411. # We don't enable bridges by default.
  412. matrix_appservice_slack_enabled: false
  413. matrix_appservice_slack_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  414. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-slack over the container network.
  415. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  416. # matrix-appservice-slack's client-server port to the local host.
  417. matrix_appservice_slack_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else ('127.0.0.1:' ~ matrix_appservice_slack_slack_port) }}"
  418. matrix_appservice_slack_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'slack.as.token') | to_uuid }}"
  419. matrix_appservice_slack_homeserver_url: "{{ matrix_homeserver_container_url }}"
  420. matrix_appservice_slack_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'slack.hs.token') | to_uuid }}"
  421. matrix_appservice_slack_id_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'slack.id.token') | to_uuid }}"
  422. matrix_appservice_slack_systemd_required_services_list: |
  423. {{
  424. ['docker.service']
  425. +
  426. ['matrix-' + matrix_homeserver_implementation + '.service']
  427. +
  428. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  429. }}
  430. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  431. matrix_appservice_slack_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'nedb' }}"
  432. matrix_appservice_slack_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'as.slack.db') | to_uuid }}"
  433. ######################################################################
  434. #
  435. # /matrix-bridge-appservice-slack
  436. #
  437. ######################################################################
  438. ######################################################################
  439. #
  440. # matrix-bridge-appservice-irc
  441. #
  442. ######################################################################
  443. # We don't enable bridges by default.
  444. matrix_appservice_irc_enabled: false
  445. matrix_appservice_irc_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  446. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-irc over the container network.
  447. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  448. # matrix-appservice-irc's client-server port to the local host.
  449. matrix_appservice_irc_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9999' }}"
  450. # The IRC bridge docs say that if homeserver presence is disabled, it's better to also disable
  451. # IRC bridge presence, for performance reasons.
  452. matrix_appservice_irc_homeserver_enablePresence: "{{ matrix_synapse_presence_enabled }}"
  453. matrix_appservice_irc_systemd_required_services_list: |
  454. {{
  455. ['docker.service']
  456. +
  457. ['matrix-' + matrix_homeserver_implementation + '.service']
  458. +
  459. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  460. }}
  461. matrix_appservice_irc_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'irc.as.token') | to_uuid }}"
  462. matrix_appservice_irc_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'irc.hs.token') | to_uuid }}"
  463. matrix_appservice_irc_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'nedb' }}"
  464. matrix_appservice_irc_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'as.irc.db') | to_uuid }}"
  465. ######################################################################
  466. #
  467. # /matrix-bridge-appservice-irc
  468. #
  469. ######################################################################
  470. ######################################################################
  471. #
  472. # matrix-bridge-appservice-kakaotalk
  473. #
  474. ######################################################################
  475. # We don't enable bridges by default.
  476. matrix_appservice_kakaotalk_enabled: false
  477. matrix_appservice_kakaotalk_systemd_required_services_list: |
  478. {{
  479. ['docker.service']
  480. +
  481. ['matrix-appservice-kakaotalk-node.service']
  482. +
  483. ['matrix-' + matrix_homeserver_implementation + '.service']
  484. +
  485. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  486. +
  487. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  488. }}
  489. matrix_appservice_kakaotalk_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'as.kakao.hs') | to_uuid }}"
  490. matrix_appservice_kakaotalk_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'as.kakao.hs') | to_uuid }}"
  491. matrix_appservice_kakaotalk_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
  492. matrix_appservice_kakaotalk_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  493. matrix_appservice_kakaotalk_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'as.kakao.db') | to_uuid }}"
  494. ######################################################################
  495. #
  496. # /matrix-bridge-appservice-kakaotalk
  497. #
  498. ######################################################################
  499. ######################################################################
  500. #
  501. # matrix-bridge-beeper-linkedin
  502. #
  503. ######################################################################
  504. # We don't enable bridges by default.
  505. matrix_beeper_linkedin_enabled: false
  506. matrix_beeper_linkedin_container_image_self_build: "{{ matrix_architecture not in ['amd64'] }}"
  507. matrix_beeper_linkedin_systemd_required_services_list: |
  508. {{
  509. ['docker.service']
  510. +
  511. ['matrix-' + matrix_homeserver_implementation + '.service']
  512. +
  513. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  514. +
  515. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  516. }}
  517. matrix_beeper_linkedin_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'linked.as.token') | to_uuid }}"
  518. matrix_beeper_linkedin_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'linked.hs.token') | to_uuid }}"
  519. matrix_beeper_linkedin_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
  520. matrix_beeper_linkedin_bridge_presence: "{{ matrix_synapse_presence_enabled if matrix_synapse_enabled else true }}"
  521. matrix_beeper_linkedin_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'maulinkedin.db') | to_uuid }}"
  522. ######################################################################
  523. #
  524. # /matrix-bridge-beeper-linkedin
  525. #
  526. ######################################################################
  527. ######################################################################
  528. #
  529. # matrix-bridge-go-skype-bridge
  530. #
  531. ######################################################################
  532. # We don't enable bridges by default.
  533. matrix_go_skype_bridge_enabled: false
  534. matrix_go_skype_bridge_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  535. matrix_go_skype_bridge_systemd_required_services_list: |
  536. {{
  537. ['docker.service']
  538. +
  539. ['matrix-' + matrix_homeserver_implementation + '.service']
  540. +
  541. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  542. +
  543. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  544. }}
  545. matrix_go_skype_bridge_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'skype.as.token') | to_uuid }}"
  546. matrix_go_skype_bridge_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'skype.hs.token') | to_uuid }}"
  547. matrix_go_skype_bridge_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
  548. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  549. matrix_go_skype_bridge_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  550. matrix_go_skype_bridge_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'goskype.db') | to_uuid }}"
  551. ######################################################################
  552. #
  553. # /matrix-bridge-go-skype-bridge
  554. #
  555. ######################################################################
  556. ######################################################################
  557. #
  558. # matrix-bridge-mautrix-facebook
  559. #
  560. ######################################################################
  561. # We don't enable bridges by default.
  562. matrix_mautrix_facebook_enabled: false
  563. matrix_mautrix_facebook_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  564. matrix_mautrix_facebook_systemd_required_services_list: |
  565. {{
  566. ['docker.service']
  567. +
  568. ['matrix-' + matrix_homeserver_implementation + '.service']
  569. +
  570. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  571. +
  572. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  573. }}
  574. matrix_mautrix_facebook_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'fb.as.token') | to_uuid }}"
  575. matrix_mautrix_facebook_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'fb.hs.token') | to_uuid }}"
  576. matrix_mautrix_facebook_public_endpoint: "/{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'facebook') | to_uuid }}"
  577. matrix_mautrix_facebook_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9008' }}"
  578. 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 '' }}"
  579. matrix_mautrix_facebook_bridge_presence: "{{ matrix_synapse_presence_enabled if matrix_synapse_enabled else true }}"
  580. # We'd like to force-set people with external Postgres to SQLite, so the bridge role can complain
  581. # and point them to a migration path.
  582. matrix_mautrix_facebook_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  583. matrix_mautrix_facebook_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mau.fb.db') | to_uuid }}"
  584. ######################################################################
  585. #
  586. # /matrix-bridge-mautrix-facebook
  587. #
  588. ######################################################################
  589. ######################################################################
  590. #
  591. # matrix-bridge-mautrix-hangouts
  592. #
  593. ######################################################################
  594. # We don't enable bridges by default.
  595. matrix_mautrix_hangouts_enabled: false
  596. matrix_mautrix_hangouts_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  597. matrix_mautrix_hangouts_systemd_required_services_list: |
  598. {{
  599. ['docker.service']
  600. +
  601. ['matrix-' + matrix_homeserver_implementation + '.service']
  602. +
  603. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  604. +
  605. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  606. }}
  607. matrix_mautrix_hangouts_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'ho.as.token') | to_uuid }}"
  608. matrix_mautrix_hangouts_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'ho.hs.token') | to_uuid }}"
  609. matrix_mautrix_hangouts_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9007' }}"
  610. 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 '' }}"
  611. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  612. matrix_mautrix_hangouts_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  613. matrix_mautrix_hangouts_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mau.hangouts.db') | to_uuid }}"
  614. ######################################################################
  615. #
  616. # /matrix-bridge-mautrix-hangouts
  617. #
  618. ######################################################################
  619. ######################################################################
  620. #
  621. # matrix-bridge-mautrix-googlechat
  622. #
  623. ######################################################################
  624. # We don't enable bridges by default.
  625. matrix_mautrix_googlechat_enabled: false
  626. matrix_mautrix_googlechat_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  627. matrix_mautrix_googlechat_systemd_required_services_list: |
  628. {{
  629. ['docker.service']
  630. +
  631. ['matrix-' + matrix_homeserver_implementation + '.service']
  632. +
  633. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  634. +
  635. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  636. }}
  637. matrix_mautrix_googlechat_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'gc.as.token') | to_uuid }}"
  638. matrix_mautrix_googlechat_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'gc.hs.token') | to_uuid }}"
  639. matrix_mautrix_googlechat_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9007' }}"
  640. matrix_mautrix_googlechat_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
  641. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  642. matrix_mautrix_googlechat_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  643. matrix_mautrix_googlechat_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mau.gc.db') | to_uuid }}"
  644. ######################################################################
  645. #
  646. # /matrix-bridge-mautrix-googlechat
  647. #
  648. ######################################################################
  649. ######################################################################
  650. #
  651. # matrix-bridge-mautrix-instagram
  652. #
  653. ######################################################################
  654. # We don't enable bridges by default.
  655. matrix_mautrix_instagram_enabled: false
  656. matrix_mautrix_instagram_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  657. matrix_mautrix_instagram_systemd_required_services_list: |
  658. {{
  659. ['docker.service']
  660. +
  661. ['matrix-' + matrix_homeserver_implementation + '.service']
  662. +
  663. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  664. +
  665. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  666. }}
  667. matrix_mautrix_instagram_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'ig.as.token') | to_uuid }}"
  668. matrix_mautrix_instagram_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'ig.hs.token') | to_uuid }}"
  669. 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 '' }}"
  670. matrix_mautrix_instagram_bridge_presence: "{{ matrix_synapse_presence_enabled if matrix_synapse_enabled else true }}"
  671. # We'd like to force-set people with external Postgres to SQLite, so the bridge role can complain
  672. # and point them to a migration path.
  673. matrix_mautrix_instagram_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  674. matrix_mautrix_instagram_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mau.ig.db') | to_uuid }}"
  675. ######################################################################
  676. #
  677. # /matrix-bridge-mautrix-instagram
  678. #
  679. ######################################################################
  680. ######################################################################
  681. #
  682. # matrix-bridge-mautrix-signal
  683. #
  684. ######################################################################
  685. # We don't enable bridges by default.
  686. matrix_mautrix_signal_enabled: false
  687. matrix_mautrix_signal_systemd_required_services_list: |
  688. {{
  689. ['docker.service']
  690. +
  691. ['matrix-' + matrix_homeserver_implementation + '.service']
  692. +
  693. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  694. +
  695. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  696. +
  697. ['matrix-mautrix-signal-daemon.service']
  698. }}
  699. matrix_mautrix_signal_homeserver_domain: '{{ matrix_domain }}'
  700. matrix_mautrix_signal_homeserver_address: "{{ matrix_homeserver_container_url }}"
  701. matrix_mautrix_signal_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'si.hs.token') | to_uuid }}"
  702. matrix_mautrix_signal_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'si.as.token') | to_uuid }}"
  703. 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 '' }}"
  704. matrix_mautrix_signal_database_engine: 'postgres'
  705. matrix_mautrix_signal_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mau.signal.db') | to_uuid }}"
  706. matrix_mautrix_signal_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  707. matrix_mautrix_signal_daemon_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  708. ######################################################################
  709. #
  710. # /matrix-bridge-mautrix-signal
  711. #
  712. ######################################################################
  713. ######################################################################
  714. #
  715. # matrix-bridge-mautrix-telegram
  716. #
  717. ######################################################################
  718. # We don't enable bridges by default.
  719. matrix_mautrix_telegram_enabled: false
  720. # Images are multi-arch (amd64 and arm64, but not arm32).
  721. matrix_mautrix_telegram_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  722. matrix_telegram_lottieconverter_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  723. matrix_telegram_lottieconverter_container_image_self_build_mask_arch: "{{ matrix_architecture != 'amd64' }}"
  724. matrix_mautrix_telegram_systemd_required_services_list: |
  725. {{
  726. ['docker.service']
  727. +
  728. ['matrix-' + matrix_homeserver_implementation + '.service']
  729. +
  730. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  731. +
  732. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  733. }}
  734. matrix_mautrix_telegram_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'telegr.as.token') | to_uuid }}"
  735. matrix_mautrix_telegram_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'telegr.hs.token') | to_uuid }}"
  736. matrix_mautrix_telegram_public_endpoint: "/{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'telegram') | to_uuid }}"
  737. matrix_mautrix_telegram_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9006' }}"
  738. 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 '' }}"
  739. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  740. matrix_mautrix_telegram_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  741. matrix_mautrix_telegram_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mau.telegram.db') | to_uuid }}"
  742. ######################################################################
  743. #
  744. # /matrix-bridge-mautrix-telegram
  745. #
  746. ######################################################################
  747. ######################################################################
  748. #
  749. # matrix-bridge-mautrix-twitter
  750. #
  751. ######################################################################
  752. # We don't enable bridges by default.
  753. matrix_mautrix_twitter_enabled: false
  754. matrix_mautrix_twitter_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  755. matrix_mautrix_twitter_systemd_required_services_list: |
  756. {{
  757. ['docker.service']
  758. +
  759. ['matrix-' + matrix_homeserver_implementation + '.service']
  760. +
  761. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  762. +
  763. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  764. }}
  765. matrix_mautrix_twitter_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'twt.as.token') | to_uuid }}"
  766. matrix_mautrix_twitter_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'twt.hs.token') | to_uuid }}"
  767. matrix_mautrix_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 '' }}"
  768. matrix_mautrix_twitter_database_hostname: "{{ 'matrix-postgres' if matrix_postgres_enabled else '' }}"
  769. matrix_mautrix_twitter_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mau.twt.db') | to_uuid if matrix_postgres_enabled else '' }}"
  770. ######################################################################
  771. #
  772. # /matrix-bridge-mautrix-twitter
  773. #
  774. ######################################################################
  775. ######################################################################
  776. #
  777. # matrix-bridge-mautrix-whatsapp
  778. #
  779. ######################################################################
  780. # We don't enable bridges by default.
  781. matrix_mautrix_whatsapp_enabled: false
  782. matrix_mautrix_whatsapp_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  783. matrix_mautrix_whatsapp_systemd_required_services_list: |
  784. {{
  785. ['docker.service']
  786. +
  787. ['matrix-' + matrix_homeserver_implementation + '.service']
  788. +
  789. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  790. +
  791. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  792. }}
  793. matrix_mautrix_whatsapp_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'whats.as.token') | to_uuid }}"
  794. matrix_mautrix_whatsapp_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'whats.hs.token') | to_uuid }}"
  795. 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 '' }}"
  796. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  797. matrix_mautrix_whatsapp_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  798. matrix_mautrix_whatsapp_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mauwhatsapp.db') | to_uuid }}"
  799. ######################################################################
  800. #
  801. # /matrix-bridge-mautrix-whatsapp
  802. #
  803. ######################################################################
  804. ######################################################################
  805. #
  806. # matrix-bridge-mautrix-discord
  807. #
  808. ######################################################################
  809. # We don't enable bridges by default.
  810. matrix_mautrix_discord_enabled: false
  811. matrix_mautrix_discord_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  812. matrix_mautrix_discord_systemd_required_services_list: |
  813. {{
  814. ['docker.service']
  815. +
  816. ['matrix-' + matrix_homeserver_implementation + '.service']
  817. +
  818. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  819. +
  820. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  821. }}
  822. matrix_mautrix_discord_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'maudisc.as.tok') | to_uuid }}"
  823. matrix_mautrix_discord_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'maudisc.hs.tok') | to_uuid }}"
  824. matrix_mautrix_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 '' }}"
  825. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  826. matrix_mautrix_discord_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  827. matrix_mautrix_discord_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'maudiscord.db') | to_uuid }}"
  828. # Enabling bridge.restricted_rooms for this bridge does not work well with Conduit, so we disable it by default.
  829. # This will be fixed in the upcoming `0.5.0` release of conduit.
  830. matrix_mautrix_discord_bridge_restricted_rooms: "{{ false if matrix_homeserver_implementation == 'conduit' else true }}"
  831. ######################################################################
  832. #
  833. # /matrix-bridge-mautrix-discord
  834. #
  835. ######################################################################
  836. ######################################################################
  837. #
  838. # matrix-sms-bridge
  839. #
  840. ######################################################################
  841. # We don't enable bridges by default.
  842. matrix_sms_bridge_enabled: false
  843. matrix_sms_bridge_systemd_required_services_list: |
  844. {{
  845. ['docker.service']
  846. +
  847. ['matrix-' + matrix_homeserver_implementation + '.service']
  848. +
  849. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  850. }}
  851. matrix_sms_bridge_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'sms.as.token') | to_uuid }}"
  852. matrix_sms_bridge_homeserver_port: "{{ matrix_synapse_container_client_api_port }}"
  853. matrix_sms_bridge_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'sms.hs.token') | to_uuid }}"
  854. ######################################################################
  855. #
  856. # /matrix-sms-bridge
  857. #
  858. ######################################################################
  859. ######################################################################
  860. #
  861. # matrix-bridge-heisenbridge
  862. #
  863. ######################################################################
  864. # We don't enable bridges by default.
  865. matrix_heisenbridge_enabled: false
  866. matrix_heisenbridge_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'heisen.as.tok') | to_uuid }}"
  867. matrix_heisenbridge_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'heisen.hs.tok') | to_uuid }}"
  868. matrix_heisenbridge_systemd_wanted_services_list: |
  869. {{
  870. ['matrix-' + matrix_homeserver_implementation + '.service']
  871. +
  872. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  873. }}
  874. ######################################################################
  875. #
  876. # /matrix-bridge-heisenbridge
  877. #
  878. ######################################################################
  879. ######################################################################
  880. #
  881. # matrix-bridge-hookshot
  882. #
  883. ######################################################################
  884. # We don't enable bridges by default.
  885. matrix_hookshot_enabled: false
  886. matrix_hookshot_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  887. matrix_hookshot_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'hookshot.as.tok') | to_uuid }}"
  888. matrix_hookshot_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'hookshot.hs.tok') | to_uuid }}"
  889. matrix_hookshot_systemd_wanted_services_list: |
  890. {{
  891. (['matrix-' + matrix_homeserver_implementation + '.service'])
  892. +
  893. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  894. }}
  895. matrix_hookshot_container_http_host_bind_ports_defaultmapping:
  896. - "127.0.0.1:{{ matrix_hookshot_appservice_port }}:{{ matrix_hookshot_appservice_port }}"
  897. - "127.0.0.1:{{ matrix_hookshot_metrics_port }}:{{ matrix_hookshot_metrics_port }}"
  898. - "127.0.0.1:{{ matrix_hookshot_webhook_port }}:{{ matrix_hookshot_webhook_port }}"
  899. - "127.0.0.1:{{ matrix_hookshot_provisioning_port }}:{{ matrix_hookshot_provisioning_port }}"
  900. matrix_hookshot_container_http_host_bind_ports: "{{ [] if matrix_nginx_proxy_enabled else matrix_hookshot_container_http_host_bind_ports_defaultmapping }}"
  901. matrix_hookshot_provisioning_enabled: "{{ matrix_hookshot_provisioning_secret and matrix_dimension_enabled }}"
  902. # We only enable metrics (locally, in the container network) for the bridge if Prometheus is enabled.
  903. #
  904. # People using an external Prometheus server will need to toggle all of these to be able to consume metrics remotely:
  905. # - `matrix_hookshot_metrics_enabled`
  906. # - `matrix_hookshot_metrics_proxying_enabled`
  907. # - `matrix_nginx_proxy_proxy_matrix_metrics_enabled`
  908. matrix_hookshot_metrics_enabled: "{{ matrix_prometheus_enabled }}"
  909. matrix_hookshot_urlprefix_port_enabled: "{{ matrix_nginx_proxy_container_https_host_bind_port == 443 if matrix_nginx_proxy_https_enabled else matrix_nginx_proxy_container_https_host_bind_port == 80 }}"
  910. matrix_hookshot_urlprefix_port: ":{{ matrix_nginx_proxy_container_https_host_bind_port if matrix_nginx_proxy_https_enabled else matrix_nginx_proxy_container_http_host_bind_port }}"
  911. matrix_hookshot_urlprefix: "http{{ 's' if matrix_nginx_proxy_https_enabled else '' }}://{{ matrix_server_fqn_matrix }}{{ matrix_hookshot_urlprefix_port if matrix_hookshot_urlprefix_port_enabled else '' }}"
  912. ######################################################################
  913. #
  914. # /matrix-bridge-hookshot
  915. #
  916. ######################################################################
  917. ######################################################################
  918. #
  919. # matrix-bridge-mx-puppet-slack
  920. #
  921. ######################################################################
  922. # We don't enable bridges by default.
  923. matrix_mx_puppet_slack_enabled: false
  924. matrix_mx_puppet_slack_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  925. matrix_mx_puppet_slack_systemd_required_services_list: |
  926. {{
  927. ['docker.service']
  928. +
  929. ['matrix-' + matrix_homeserver_implementation + '.service']
  930. +
  931. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  932. +
  933. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  934. }}
  935. matrix_mx_puppet_slack_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxslk.as.tok') | to_uuid }}"
  936. matrix_mx_puppet_slack_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxslk.hs.tok') | to_uuid }}"
  937. 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 '' }}"
  938. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  939. matrix_mx_puppet_slack_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  940. matrix_mx_puppet_slack_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.slack.db') | to_uuid }}"
  941. ######################################################################
  942. #
  943. # /matrix-bridge-mx-puppet-slack
  944. #
  945. ######################################################################
  946. ######################################################################
  947. #
  948. # matrix-bridge-mx-puppet-twitter
  949. #
  950. ######################################################################
  951. # We don't enable bridges by default.
  952. matrix_mx_puppet_twitter_enabled: false
  953. matrix_mx_puppet_twitter_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  954. matrix_mx_puppet_twitter_systemd_required_services_list: |
  955. {{
  956. ['docker.service']
  957. +
  958. ['matrix-' + matrix_homeserver_implementation + '.service']
  959. +
  960. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  961. +
  962. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  963. }}
  964. matrix_mx_puppet_twitter_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxtwt.as.tok') | to_uuid }}"
  965. matrix_mx_puppet_twitter_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxtwt.hs.tok') | to_uuid }}"
  966. 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 '' }}"
  967. 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) }}"
  968. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  969. matrix_mx_puppet_twitter_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  970. matrix_mx_puppet_twitter_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.twitter.db') | to_uuid }}"
  971. ######################################################################
  972. #
  973. # /matrix-bridge-mx-puppet-twitter
  974. #
  975. ######################################################################
  976. ######################################################################
  977. #
  978. # matrix-bridge-mx-puppet-instagram
  979. #
  980. ######################################################################
  981. # We don't enable bridges by default.
  982. matrix_mx_puppet_instagram_enabled: false
  983. matrix_mx_puppet_instagram_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  984. matrix_mx_puppet_instagram_systemd_required_services_list: |
  985. {{
  986. ['docker.service']
  987. +
  988. ['matrix-' + matrix_homeserver_implementation + '.service']
  989. +
  990. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  991. +
  992. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  993. }}
  994. matrix_mx_puppet_instagram_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxig.as.tok') | to_uuid }}"
  995. matrix_mx_puppet_instagram_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxig.hs.tok') | to_uuid }}"
  996. 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 '' }}"
  997. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  998. matrix_mx_puppet_instagram_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  999. matrix_mx_puppet_instagram_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.ig.db') | to_uuid }}"
  1000. ######################################################################
  1001. #
  1002. # /matrix-bridge-mx-puppet-instagram
  1003. #
  1004. ######################################################################
  1005. ######################################################################
  1006. #
  1007. # matrix-bridge-mx-puppet-discord
  1008. #
  1009. ######################################################################
  1010. # We don't enable bridges by default.
  1011. matrix_mx_puppet_discord_enabled: false
  1012. matrix_mx_puppet_discord_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1013. matrix_mx_puppet_discord_systemd_required_services_list: |
  1014. {{
  1015. ['docker.service']
  1016. +
  1017. ['matrix-' + matrix_homeserver_implementation + '.service']
  1018. +
  1019. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1020. +
  1021. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  1022. }}
  1023. matrix_mx_puppet_discord_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxdsc.as.tok') | to_uuid }}"
  1024. matrix_mx_puppet_discord_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxdsc.hs.tok') | to_uuid }}"
  1025. 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 '' }}"
  1026. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  1027. matrix_mx_puppet_discord_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  1028. matrix_mx_puppet_discord_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.dsc.db') | to_uuid }}"
  1029. ######################################################################
  1030. #
  1031. # /matrix-bridge-mx-puppet-discord
  1032. #
  1033. ######################################################################
  1034. ######################################################################
  1035. #
  1036. # matrix-bridge-mx-puppet-steam
  1037. #
  1038. ######################################################################
  1039. # We don't enable bridges by default.
  1040. matrix_mx_puppet_steam_enabled: false
  1041. matrix_mx_puppet_steam_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  1042. matrix_mx_puppet_steam_systemd_required_services_list: |
  1043. {{
  1044. ['docker.service']
  1045. +
  1046. ['matrix-' + matrix_homeserver_implementation + '.service']
  1047. +
  1048. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1049. +
  1050. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  1051. }}
  1052. matrix_mx_puppet_steam_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxste.as.tok') | to_uuid }}"
  1053. matrix_mx_puppet_steam_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxste.hs.tok') | to_uuid }}"
  1054. 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 '' }}"
  1055. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  1056. matrix_mx_puppet_steam_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  1057. matrix_mx_puppet_steam_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.steam.db') | to_uuid }}"
  1058. ######################################################################
  1059. #
  1060. # /matrix-bridge-mx-puppet-steam
  1061. #
  1062. ######################################################################
  1063. ######################################################################
  1064. #
  1065. # matrix-bridge-mx-puppet-groupme
  1066. #
  1067. ######################################################################
  1068. # We don't enable bridges by default.
  1069. matrix_mx_puppet_groupme_enabled: false
  1070. matrix_mx_puppet_groupme_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1071. matrix_mx_puppet_groupme_systemd_required_services_list: |
  1072. {{
  1073. ['docker.service']
  1074. +
  1075. ['matrix-' + matrix_homeserver_implementation + '.service']
  1076. +
  1077. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1078. +
  1079. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  1080. }}
  1081. matrix_mx_puppet_groupme_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxgro.as.tok') | to_uuid }}"
  1082. matrix_mx_puppet_groupme_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxgro.hs.tok') | to_uuid }}"
  1083. 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 '' }}"
  1084. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  1085. matrix_mx_puppet_groupme_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  1086. matrix_mx_puppet_groupme_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.groupme.db') | to_uuid }}"
  1087. ######################################################################
  1088. #
  1089. # /matrix-bridge-mx-puppet-groupme
  1090. #
  1091. ######################################################################
  1092. ######################################################################
  1093. #
  1094. # matrix-bot-matrix-reminder-bot
  1095. #
  1096. ######################################################################
  1097. # We don't enable bots by default.
  1098. matrix_bot_matrix_reminder_bot_enabled: false
  1099. matrix_bot_matrix_reminder_bot_systemd_required_services_list: |
  1100. {{
  1101. ['docker.service']
  1102. +
  1103. ['matrix-' + matrix_homeserver_implementation + '.service']
  1104. +
  1105. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1106. +
  1107. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  1108. }}
  1109. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  1110. matrix_bot_matrix_reminder_bot_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  1111. matrix_bot_matrix_reminder_bot_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'reminder.bot.db') | to_uuid }}"
  1112. matrix_bot_matrix_reminder_bot_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1113. ######################################################################
  1114. #
  1115. # /matrix-bot-matrix-reminder-bot
  1116. #
  1117. ######################################################################
  1118. ######################################################################
  1119. #
  1120. # matrix-bot-matrix-registration-bot
  1121. #
  1122. ######################################################################
  1123. # We don't enable bots by default.
  1124. matrix_bot_matrix_registration_bot_enabled: false
  1125. matrix_bot_matrix_registration_bot_container_image_self_build: "{{ matrix_architecture not in ['amd64'] }}"
  1126. matrix_bot_matrix_registration_bot_systemd_required_services_list: |
  1127. {{
  1128. ['docker.service']
  1129. +
  1130. ['matrix-' + matrix_homeserver_implementation + '.service']
  1131. +
  1132. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  1133. }}
  1134. ######################################################################
  1135. #
  1136. # /matrix-bot-matrix-registration-bot
  1137. #
  1138. ######################################################################
  1139. ######################################################################
  1140. #
  1141. # matrix-bot-maubot
  1142. #
  1143. ######################################################################
  1144. # We don't enable bots by default.
  1145. matrix_bot_maubot_enabled: false
  1146. matrix_bot_maubot_container_image_self_build: "{{ matrix_architecture not in ['amd64'] }}"
  1147. matrix_bot_maubot_systemd_required_services_list: |
  1148. {{
  1149. ['docker.service']
  1150. +
  1151. ['matrix-' + matrix_homeserver_implementation + '.service']
  1152. +
  1153. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1154. +
  1155. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  1156. }}
  1157. matrix_bot_maubot_registration_shared_secret: |-
  1158. {{
  1159. {
  1160. 'synapse': matrix_synapse_registration_shared_secret,
  1161. 'dendrite': matrix_dendrite_registration_shared_secret,
  1162. }[matrix_homeserver_implementation]
  1163. }}
  1164. matrix_bot_maubot_management_interface_http_bind_port: "{{ '' if matrix_nginx_proxy_enabled else ('127.0.0.1:' + matrix_bot_maubot_management_interface_port | string) }}"
  1165. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  1166. matrix_bot_maubot_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  1167. matrix_bot_maubot_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.dsc.db') | to_uuid }}"
  1168. ######################################################################
  1169. #
  1170. # /matrix-bot-maubot
  1171. #
  1172. ######################################################################
  1173. ######################################################################
  1174. #
  1175. # matrix-bot-honoroit
  1176. #
  1177. ######################################################################
  1178. # We don't enable bots by default.
  1179. matrix_bot_honoroit_enabled: false
  1180. matrix_bot_honoroit_systemd_required_services_list: |
  1181. {{
  1182. ['docker.service']
  1183. +
  1184. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1185. +
  1186. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  1187. +
  1188. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  1189. }}
  1190. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  1191. matrix_bot_honoroit_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  1192. matrix_bot_honoroit_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'honoroit.bot.db') | to_uuid }}"
  1193. matrix_bot_honoroit_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  1194. ######################################################################
  1195. #
  1196. # /matrix-bot-honoroit
  1197. #
  1198. ######################################################################
  1199. ######################################################################
  1200. #
  1201. # matrix-bot-buscarron
  1202. #
  1203. ######################################################################
  1204. # We don't enable bots by default.
  1205. matrix_bot_buscarron_enabled: false
  1206. matrix_bot_buscarron_systemd_required_services_list: |
  1207. {{
  1208. ['docker.service']
  1209. +
  1210. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1211. +
  1212. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  1213. +
  1214. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  1215. }}
  1216. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  1217. matrix_bot_buscarron_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  1218. matrix_bot_buscarron_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'buscarron.bot.db') | to_uuid }}"
  1219. matrix_bot_buscarron_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  1220. ######################################################################
  1221. #
  1222. # /matrix-bot-buscarron
  1223. #
  1224. ######################################################################
  1225. ######################################################################
  1226. #
  1227. # matrix-bot-postmoogle
  1228. #
  1229. ######################################################################
  1230. # We don't enable bots by default.
  1231. matrix_bot_postmoogle_enabled: false
  1232. matrix_bot_postmoogle_ssl_path: "{{ matrix_ssl_config_dir_path }}"
  1233. matrix_bot_postmoogle_tls_cert: "{% for domain in matrix_bot_postmoogle_domains %}/ssl/live/{{ domain }}/fullchain.pem {% endfor %}"
  1234. matrix_bot_postmoogle_tls_key: "{% for domain in matrix_bot_postmoogle_domains %}/ssl/live/{{ domain }}/privkey.pem {% endfor %}"
  1235. matrix_bot_postmoogle_systemd_required_services_list: |
  1236. {{
  1237. ['docker.service']
  1238. +
  1239. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1240. +
  1241. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  1242. }}
  1243. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  1244. matrix_bot_postmoogle_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  1245. matrix_bot_postmoogle_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'postmoogle.db') | to_uuid }}"
  1246. matrix_bot_postmoogle_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  1247. ######################################################################
  1248. #
  1249. # /matrix-bot-postmoogle
  1250. #
  1251. ######################################################################
  1252. ######################################################################
  1253. #
  1254. # matrix-bot-go-neb
  1255. #
  1256. ######################################################################
  1257. # We don't enable bots by default.
  1258. matrix_bot_go_neb_enabled: false
  1259. matrix_bot_go_neb_systemd_required_services_list: |
  1260. {{
  1261. ['docker.service']
  1262. +
  1263. ['matrix-' + matrix_homeserver_implementation + '.service']
  1264. +
  1265. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  1266. }}
  1267. matrix_bot_go_neb_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:4050' }}"
  1268. ######################################################################
  1269. #
  1270. # /matrix-bot-go-neb
  1271. #
  1272. ######################################################################
  1273. ######################################################################
  1274. #
  1275. # matrix-bot-mjolnir
  1276. #
  1277. ######################################################################
  1278. # We don't enable bots by default.
  1279. matrix_bot_mjolnir_enabled: false
  1280. matrix_bot_mjolnir_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1281. matrix_bot_mjolnir_systemd_required_services_list: |
  1282. {{
  1283. ['docker.service']
  1284. +
  1285. ['matrix-' + matrix_homeserver_implementation + '.service']
  1286. +
  1287. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1288. +
  1289. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  1290. }}
  1291. ######################################################################
  1292. #
  1293. # /matrix-bot-mjolnir
  1294. #
  1295. ######################################################################
  1296. ######################################################################
  1297. #
  1298. # matrix-backup-borg
  1299. #
  1300. ######################################################################
  1301. matrix_backup_borg_enabled: false
  1302. matrix_backup_borg_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm32', 'arm64'] }}"
  1303. matrix_backup_borg_postgresql_enabled: "{{ matrix_postgres_enabled }}"
  1304. matrix_backup_borg_postgresql_databases_hostname: "{{ matrix_postgres_connection_hostname }}"
  1305. matrix_backup_borg_postgresql_databases_username: "{{ matrix_postgres_connection_username }}"
  1306. matrix_backup_borg_postgresql_databases_password: "{{ matrix_postgres_connection_password }}"
  1307. matrix_backup_borg_postgresql_databases_port: "{{ matrix_postgres_connection_port }}"
  1308. matrix_backup_borg_postgresql_databases: |
  1309. {{
  1310. (([{
  1311. 'name': matrix_synapse_database_database
  1312. }] if (matrix_synapse_enabled and matrix_synapse_database_database == matrix_postgres_db_name and matrix_synapse_database_host == 'matrix-postgres') else [])
  1313. +
  1314. matrix_postgres_additional_databases)|map(attribute='name') | list
  1315. }}
  1316. matrix_backup_borg_location_source_directories:
  1317. - "{{ matrix_base_data_path }}"
  1318. matrix_backup_borg_location_exclude_patterns: |
  1319. {{
  1320. ([matrix_synapse_media_store_path + '/local_thumbnails', matrix_synapse_media_store_path + '/remote_thumbnail', matrix_synapse_media_store_path + '/url_cache', matrix_synapse_media_store_path + '/url_cache_thumbnails'] if matrix_homeserver_implementation == 'synapse' else [])
  1321. +
  1322. ([matrix_postgres_data_path] if matrix_postgres_enabled else [])
  1323. }}
  1324. matrix_backup_borg_systemd_required_services_list: |
  1325. {{
  1326. ['docker.service']
  1327. +
  1328. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1329. }}
  1330. ######################################################################
  1331. #
  1332. # /matrix-backup-borg
  1333. #
  1334. ######################################################################
  1335. ######################################################################
  1336. #
  1337. # matrix-cactus-comments
  1338. #
  1339. ######################################################################
  1340. matrix_cactus_comments_enabled: false
  1341. # Derive secret values from homeserver secret
  1342. matrix_cactus_comments_as_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'cactus.as.token') | to_uuid }}"
  1343. matrix_cactus_comments_hs_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'cactus.hs.token') | to_uuid }}"
  1344. matrix_cactus_comments_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm32', 'arm64'] }}"
  1345. matrix_cactus_comments_systemd_required_services_list: |
  1346. {{
  1347. (['docker.service'])
  1348. +
  1349. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  1350. +
  1351. (['matrix-' + matrix_homeserver_implementation + '.service'])
  1352. }}
  1353. matrix_cactus_comments_client_nginx_path: "{{ '/cactus-comments/' if matrix_nginx_proxy_enabled else matrix_cactus_comments_client_path + '/' }}"
  1354. ######################################################################
  1355. #
  1356. # /matrix-cactus-comments
  1357. #
  1358. ######################################################################
  1359. ######################################################################
  1360. #
  1361. # matrix-corporal
  1362. #
  1363. ######################################################################
  1364. matrix_corporal_enabled: false
  1365. matrix_corporal_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm32', 'arm64'] }}"
  1366. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-corporal over the container network.
  1367. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1368. # matrix-corporal's web-server ports to the local host.
  1369. matrix_corporal_container_http_gateway_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:41080' }}"
  1370. matrix_corporal_container_http_api_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:41081' }}"
  1371. matrix_corporal_systemd_required_services_list: |
  1372. {{
  1373. (['docker.service'])
  1374. +
  1375. (['matrix-' + matrix_homeserver_implementation + '.service'])
  1376. }}
  1377. matrix_corporal_matrix_homeserver_api_endpoint: "{{ matrix_homeserver_container_url }}"
  1378. matrix_corporal_matrix_auth_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret }}"
  1379. # This is only useful if there's REST auth provider to make use of it.
  1380. matrix_corporal_http_gateway_internal_rest_auth_enabled: "{{ matrix_synapse_ext_password_provider_rest_auth_enabled }}"
  1381. matrix_corporal_matrix_registration_shared_secret: "{{ matrix_synapse_registration_shared_secret }}"
  1382. ######################################################################
  1383. #
  1384. # /matrix-corporal
  1385. #
  1386. ######################################################################
  1387. ######################################################################
  1388. #
  1389. # matrix-coturn
  1390. #
  1391. ######################################################################
  1392. matrix_coturn_enabled: true
  1393. matrix_coturn_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm32', 'arm64'] }}"
  1394. matrix_coturn_turn_external_ip_address: "{{ ansible_host }}"
  1395. matrix_coturn_turn_static_auth_secret: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'coturn.sas') | to_uuid }}"
  1396. matrix_coturn_tls_enabled: "{{ matrix_ssl_retrieval_method != 'none' }}"
  1397. matrix_coturn_tls_cert_path: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_server_fqn_matrix }}/fullchain.pem"
  1398. matrix_coturn_tls_key_path: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_server_fqn_matrix }}/privkey.pem"
  1399. matrix_coturn_container_additional_volumes: |
  1400. {{
  1401. ([] if matrix_ssl_retrieval_method == 'none' else [
  1402. {
  1403. 'src': matrix_ssl_config_dir_path,
  1404. 'dst': matrix_ssl_config_dir_path,
  1405. 'options': 'ro',
  1406. }
  1407. ])
  1408. }}
  1409. ######################################################################
  1410. #
  1411. # /matrix-coturn
  1412. #
  1413. ######################################################################
  1414. ######################################################################
  1415. #
  1416. # matrix-dimension
  1417. #
  1418. ######################################################################
  1419. matrix_dimension_enabled: false
  1420. matrix_dimension_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1421. # Normally, matrix-nginx-proxy is enabled and nginx can reach Dimension over the container network.
  1422. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1423. # the Dimension HTTP port to the local host.
  1424. matrix_dimension_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8184' }}"
  1425. matrix_dimension_homeserver_federationUrl: "{{ matrix_homeserver_container_federation_url }}"
  1426. matrix_dimension_systemd_required_services_list: |
  1427. {{
  1428. ['docker.service']
  1429. +
  1430. ['matrix-' + matrix_homeserver_implementation + '.service']
  1431. +
  1432. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1433. +
  1434. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  1435. }}
  1436. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  1437. matrix_dimension_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  1438. matrix_dimension_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'dimension.db') | to_uuid }}"
  1439. ######################################################################
  1440. #
  1441. # /matrix-dimension
  1442. #
  1443. ######################################################################
  1444. ######################################################################
  1445. #
  1446. # matrix-etherpad
  1447. #
  1448. ######################################################################
  1449. matrix_etherpad_enabled: false
  1450. matrix_etherpad_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9001' }}"
  1451. matrix_etherpad_base_url: "{{ 'https://'+ matrix_server_fqn_dimension + matrix_etherpad_public_endpoint if matrix_etherpad_mode == 'dimension' else 'https://' + matrix_server_fqn_etherpad + '/' }}"
  1452. matrix_etherpad_systemd_required_services_list: |
  1453. {{
  1454. ['docker.service']
  1455. +
  1456. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1457. }}
  1458. matrix_etherpad_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'etherpad.db') | to_uuid }}"
  1459. ######################################################################
  1460. #
  1461. # /matrix-etherpad
  1462. #
  1463. ######################################################################
  1464. ######################################################################
  1465. #
  1466. # matrix-dynamic-dns
  1467. #
  1468. ######################################################################
  1469. matrix_dynamic_dns_enabled: false
  1470. ######################################################################
  1471. #
  1472. # /matrix-dynamic-dns
  1473. #
  1474. ######################################################################
  1475. ######################################################################
  1476. #
  1477. # matrix-email2matrix
  1478. #
  1479. ######################################################################
  1480. matrix_email2matrix_enabled: false
  1481. matrix_email2matrix_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm32', 'arm64'] }}"
  1482. ######################################################################
  1483. #
  1484. # /matrix-email2matrix
  1485. #
  1486. ######################################################################
  1487. ######################################################################
  1488. #
  1489. # matrix-jitsi
  1490. #
  1491. ######################################################################
  1492. matrix_jitsi_enabled: false
  1493. # Normally, matrix-nginx-proxy is enabled and nginx can reach jitsi/web over the container network.
  1494. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1495. # the Jitsi HTTP port to the local host.
  1496. matrix_jitsi_web_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:13080' }}"
  1497. matrix_jitsi_jvb_container_colibri_ws_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:13090' }}"
  1498. matrix_jitsi_prosody_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:5280' }}"
  1499. matrix_jitsi_jibri_xmpp_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'jibri') | to_uuid }}"
  1500. matrix_jitsi_jicofo_auth_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'jicofo') | to_uuid }}"
  1501. matrix_jitsi_jvb_auth_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'jvb') | to_uuid }}"
  1502. matrix_jitsi_web_stun_servers: |
  1503. {{
  1504. [
  1505. 'stun:' + matrix_server_fqn_matrix + ':5349',
  1506. 'stun:' + matrix_server_fqn_matrix + ':3478',
  1507. ]
  1508. if matrix_coturn_enabled
  1509. else [ 'stun:meet-jit-si-turnrelay.jitsi.net:443']
  1510. }}
  1511. # If the self-hosted Etherpad instance is available, it will also show up in Jitsi conferences,
  1512. # unless explicitly disabled by setting `matrix_jitsi_etherpad_enabled` to false.
  1513. # Falls back to the scalar.vector.im etherpad in case someone sets `matrix_jitsi_etherpad_enabled` to true,
  1514. # while also setting `matrix_etherpad_enabled` to false.
  1515. matrix_jitsi_etherpad_enabled: "{{ matrix_etherpad_enabled }}"
  1516. matrix_jitsi_etherpad_base: "{{ matrix_etherpad_base_url if matrix_etherpad_enabled else 'https://scalar.vector.im/etherpad' }}"
  1517. ######################################################################
  1518. #
  1519. # /matrix-jitsi
  1520. #
  1521. ######################################################################
  1522. ######################################################################
  1523. #
  1524. # matrix-ldap-registration-proxy
  1525. #
  1526. ######################################################################
  1527. # This is only for users with a specific LDAP setup
  1528. matrix_ldap_registration_proxy_enabled: false
  1529. ######################################################################
  1530. #
  1531. # /matrix-ldap-registration-proxy
  1532. #
  1533. ######################################################################
  1534. ######################################################################
  1535. #
  1536. # matrix-mailer
  1537. #
  1538. ######################################################################
  1539. # By default, this playbook sets up an exim mailer server (running in a container).
  1540. # This is so that Synapse can send email reminders for unread messages.
  1541. # Other services (like ma1sd), also use the mailer.
  1542. matrix_mailer_enabled: true
  1543. matrix_mailer_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm32', 'arm64'] }}"
  1544. ######################################################################
  1545. #
  1546. # /matrix-mailer
  1547. #
  1548. ######################################################################
  1549. ######################################################################
  1550. #
  1551. # matrix-ma1sd
  1552. #
  1553. ######################################################################
  1554. # We no longer install the ma1sd identity server by default.
  1555. #
  1556. # The main reason we used to install ma1sd by default in the past was to
  1557. # prevent Element from talking to the `matrix.org` / `vector.im` identity servers,
  1558. # by forcing it to talk to our own self-hosted (but otherwise useless) identity server instead,
  1559. # thus preventing contact list leaks.
  1560. #
  1561. # Since Element no longer defaults to using a public identity server if another one is not provided,
  1562. # we can stop installing ma1sd.
  1563. matrix_ma1sd_enabled: false
  1564. matrix_ma1sd_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1565. # Normally, matrix-nginx-proxy is enabled and nginx can reach ma1sd over the container network.
  1566. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1567. # ma1sd's web-server port.
  1568. matrix_ma1sd_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:' + matrix_ma1sd_container_port | string }}"
  1569. # We enable Synapse integration via its Postgres database by default.
  1570. # When using another Identity store, you might wish to disable this and define
  1571. # your own configuration in `matrix_ma1sd_configuration_extension_yaml`.
  1572. matrix_ma1sd_synapsesql_enabled: true
  1573. matrix_ma1sd_synapsesql_type: postgresql
  1574. matrix_ma1sd_synapsesql_connection: //{{ matrix_synapse_database_host }}/{{ matrix_synapse_database_database }}?user={{ matrix_synapse_database_user | urlencode() }}&password={{ matrix_synapse_database_password | urlencode() }}
  1575. matrix_ma1sd_dns_overwrite_enabled: true
  1576. matrix_ma1sd_dns_overwrite_homeserver_client_name: "{{ matrix_server_fqn_matrix }}"
  1577. # The `matrix_ma1sd_dns_overwrite_homeserver_client_value` value when matrix_nginx_proxy_enabled is false covers the general case,
  1578. # but may be inaccurate if matrix-corporal is enabled.
  1579. 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 }}"
  1580. # By default, we send mail through the `matrix-mailer` service.
  1581. matrix_ma1sd_threepid_medium_email_identity_from: "{{ matrix_mailer_sender_address }}"
  1582. matrix_ma1sd_threepid_medium_email_connectors_smtp_host: "matrix-mailer"
  1583. matrix_ma1sd_threepid_medium_email_connectors_smtp_port: 8025
  1584. matrix_ma1sd_threepid_medium_email_connectors_smtp_tls: 0
  1585. matrix_ma1sd_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1586. matrix_ma1sd_systemd_required_services_list: |
  1587. {{
  1588. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1589. }}
  1590. matrix_ma1sd_systemd_wanted_services_list: |
  1591. {{
  1592. (['matrix-corporal.service'] if matrix_corporal_enabled else ['matrix-' + matrix_homeserver_implementation + '.service'])
  1593. +
  1594. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1595. +
  1596. (['matrix-mailer.service'] if matrix_mailer_enabled else [])
  1597. }}
  1598. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  1599. matrix_ma1sd_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  1600. matrix_ma1sd_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'ma1sd.db') | to_uuid }}"
  1601. ######################################################################
  1602. #
  1603. # /matrix-ma1sd
  1604. #
  1605. ######################################################################
  1606. ######################################################################
  1607. #
  1608. # matrix-nginx-proxy
  1609. #
  1610. ######################################################################
  1611. # By default, this playbook sets up a reverse-proxy nginx proxy server on TCP ports 80, 443 and 8448.
  1612. # This is fine if you're dedicating the whole server to Matrix.
  1613. # If that's not the case, you may wish to disable this and take care of proxying yourself.
  1614. matrix_nginx_proxy_enabled: true
  1615. matrix_nginx_proxy_proxy_matrix_client_api_addr_with_container: "{{ 'matrix-corporal:41080' if matrix_corporal_enabled else 'matrix-nginx-proxy:12080' }}"
  1616. 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' }}"
  1617. matrix_nginx_proxy_proxy_matrix_client_api_client_max_body_size_mb: |-
  1618. {{
  1619. {
  1620. 'synapse': matrix_synapse_max_upload_size_mb,
  1621. 'dendrite': (matrix_dendrite_max_file_size_bytes / 1024 / 1024) | round,
  1622. 'conduit': (matrix_conduit_max_request_size / 1024 / 1024) | round,
  1623. }[matrix_homeserver_implementation]|int
  1624. }}
  1625. matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_synapse_admin_api_enabled: "{{ matrix_synapse_admin_enabled or matrix_bot_matrix_registration_bot_enabled }}"
  1626. matrix_nginx_proxy_proxy_matrix_client_redirect_root_uri_to_domain: "{{ matrix_server_fqn_element if matrix_client_element_enabled else '' }}"
  1627. matrix_nginx_proxy_proxy_matrix_enabled: true
  1628. matrix_nginx_proxy_proxy_element_enabled: "{{ matrix_client_element_enabled }}"
  1629. matrix_nginx_proxy_proxy_hydrogen_enabled: "{{ matrix_client_hydrogen_enabled }}"
  1630. matrix_nginx_proxy_proxy_cinny_enabled: "{{ matrix_client_cinny_enabled }}"
  1631. matrix_nginx_proxy_proxy_buscarron_enabled: "{{ matrix_bot_buscarron_enabled }}"
  1632. matrix_nginx_proxy_proxy_dimension_enabled: "{{ matrix_dimension_enabled }}"
  1633. matrix_nginx_proxy_proxy_etherpad_enabled: "{{ matrix_etherpad_enabled and matrix_etherpad_mode == 'standalone' }}"
  1634. matrix_nginx_proxy_proxy_bot_go_neb_enabled: "{{ matrix_bot_go_neb_enabled }}"
  1635. matrix_nginx_proxy_proxy_jitsi_enabled: "{{ matrix_jitsi_enabled }}"
  1636. matrix_nginx_proxy_proxy_grafana_enabled: "{{ matrix_grafana_enabled }}"
  1637. matrix_nginx_proxy_proxy_sygnal_enabled: "{{ matrix_sygnal_enabled }}"
  1638. matrix_nginx_proxy_proxy_ntfy_enabled: "{{ matrix_ntfy_enabled }}"
  1639. matrix_nginx_proxy_proxy_matrix_corporal_api_enabled: "{{ matrix_corporal_enabled and matrix_corporal_http_api_enabled }}"
  1640. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_with_container: "matrix-corporal:41081"
  1641. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_sans_container: "127.0.0.1:41081"
  1642. matrix_nginx_proxy_proxy_matrix_identity_api_enabled: "{{ matrix_ma1sd_enabled }}"
  1643. matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container: "matrix-ma1sd:{{ matrix_ma1sd_container_port }}"
  1644. matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container: "127.0.0.1:{{ matrix_ma1sd_container_port }}"
  1645. # By default, we do TLS termination for the Matrix Federation API (port 8448) at matrix-nginx-proxy.
  1646. # Unless this is handled there OR Synapse's federation listener port is disabled, we'll reverse-proxy.
  1647. matrix_nginx_proxy_proxy_matrix_federation_api_enabled: |-
  1648. {{
  1649. {
  1650. 'synapse': (matrix_synapse_federation_port_enabled and not matrix_synapse_tls_federation_listener_enabled),
  1651. 'dendrite': matrix_dendrite_federation_enabled,
  1652. 'conduit': matrix_conduit_allow_federation,
  1653. }[matrix_homeserver_implementation]|bool
  1654. }}
  1655. matrix_nginx_proxy_proxy_matrix_federation_api_addr_with_container: "matrix-nginx-proxy:12088"
  1656. matrix_nginx_proxy_proxy_matrix_federation_api_addr_sans_container: "127.0.0.1:12088"
  1657. matrix_nginx_proxy_proxy_synapse_enabled: "{{ matrix_synapse_enabled }}"
  1658. matrix_nginx_proxy_proxy_synapse_client_api_addr_with_container: "{{ 'matrix-synapse-reverse-proxy-companion:8008' if matrix_synapse_reverse_proxy_companion_enabled else 'matrix-synapse:8008' }}"
  1659. matrix_nginx_proxy_proxy_synapse_client_api_addr_sans_container: "127.0.0.1:8008"
  1660. matrix_nginx_proxy_proxy_synapse_federation_api_addr_with_container: "{{ 'matrix-synapse-reverse-proxy-companion:8048' if matrix_synapse_reverse_proxy_companion_enabled else 'matrix-synapse:8048' }}"
  1661. matrix_nginx_proxy_proxy_synapse_federation_api_addr_sans_container: "127.0.0.1:8048"
  1662. matrix_nginx_proxy_proxy_dendrite_enabled: "{{ matrix_dendrite_enabled }}"
  1663. matrix_nginx_proxy_proxy_dendrite_client_api_addr_with_container: "matrix-dendrite:{{ matrix_dendrite_http_bind_port | string }}"
  1664. matrix_nginx_proxy_proxy_dendrite_client_api_addr_sans_container: "127.0.0.1:{{ matrix_dendrite_http_bind_port | string }}"
  1665. matrix_nginx_proxy_proxy_dendrite_federation_api_addr_with_container: "matrix-dendrite:{{ matrix_dendrite_http_bind_port | string }}"
  1666. matrix_nginx_proxy_proxy_dendrite_federation_api_addr_sans_container: "127.0.0.1:{{ matrix_dendrite_http_bind_port | string }}"
  1667. matrix_nginx_proxy_proxy_conduit_enabled: "{{ matrix_conduit_enabled }}"
  1668. matrix_nginx_proxy_proxy_conduit_client_api_addr_with_container: "matrix-conduit:{{ matrix_conduit_port_number|string }}"
  1669. matrix_nginx_proxy_proxy_conduit_client_api_addr_sans_container: "127.0.0.1:{{ matrix_conduit_port_number|string }}"
  1670. matrix_nginx_proxy_proxy_conduit_federation_api_addr_with_container: "matrix-conduit:{{ matrix_conduit_port_number|string }}"
  1671. matrix_nginx_proxy_proxy_conduit_federation_api_addr_sans_container: "127.0.0.1:{{ matrix_conduit_port_number|string }}"
  1672. # When matrix-nginx-proxy is disabled, the actual port number that the vhost uses may begin to matter.
  1673. matrix_nginx_proxy_proxy_matrix_federation_port: "{{ matrix_federation_public_port }}"
  1674. matrix_nginx_proxy_container_federation_host_bind_port: "{{ matrix_federation_public_port }}"
  1675. matrix_nginx_proxy_proxy_matrix_user_directory_search_enabled: "{{ matrix_ma1sd_enabled }}"
  1676. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_with_container: "{{ matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container }}"
  1677. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_sans_container: "{{ matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container }}"
  1678. matrix_nginx_proxy_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1679. # OCSP stapling does not make sense when self-signed certificates are used.
  1680. # See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1073
  1681. # and https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1074
  1682. matrix_nginx_proxy_ocsp_stapling_enabled: "{{ matrix_ssl_retrieval_method != 'self-signed' }}"
  1683. matrix_nginx_proxy_systemd_wanted_services_list: |
  1684. {{
  1685. ['matrix-' + matrix_homeserver_implementation + '.service']
  1686. +
  1687. (matrix_synapse_webserving_workers_systemd_services_list if matrix_homeserver_implementation == 'synapse' and matrix_synapse_workers_enabled else [])
  1688. +
  1689. (['matrix-synapse-reverse-proxy-companion.service'] if matrix_synapse_reverse_proxy_companion_enabled else [])
  1690. +
  1691. (['matrix-corporal.service'] if matrix_corporal_enabled else [])
  1692. +
  1693. (['matrix-ma1sd.service'] if matrix_ma1sd_enabled else [])
  1694. +
  1695. (['matrix-client-cinny.service'] if matrix_client_cinny_enabled else [])
  1696. +
  1697. (['matrix-bot-buscarron.service'] if matrix_bot_buscarron_enabled else [])
  1698. +
  1699. (['matrix-client-element.service'] if matrix_client_element_enabled else [])
  1700. +
  1701. (['matrix-client-hydrogen.service'] if matrix_client_hydrogen_enabled else [])
  1702. +
  1703. (['matrix-grafana.service'] if matrix_grafana_enabled else [])
  1704. +
  1705. (['matrix-dimension.service'] if matrix_dimension_enabled else [])
  1706. +
  1707. (['matrix-sygnal.service'] if matrix_sygnal_enabled else [])
  1708. +
  1709. (['matrix-ntfy.service'] if matrix_ntfy_enabled else [])
  1710. +
  1711. (['matrix-jitsi.service'] if matrix_jitsi_enabled else [])
  1712. +
  1713. (['matrix-bot-go-neb.service'] if matrix_bot_go_neb_enabled else [])
  1714. +
  1715. (['matrix-etherpad.service'] if matrix_etherpad_enabled else [])
  1716. +
  1717. (['matrix-hookshot.service'] if matrix_hookshot_enabled else [])
  1718. }}
  1719. matrix_ssl_domains_to_obtain_certificates_for: |
  1720. {{
  1721. ([matrix_server_fqn_matrix])
  1722. +
  1723. ([matrix_server_fqn_element] if matrix_client_element_enabled else [])
  1724. +
  1725. ([matrix_nginx_proxy_proxy_riot_compat_redirect_hostname] if matrix_nginx_proxy_proxy_riot_compat_redirect_enabled else [])
  1726. +
  1727. ([matrix_server_fqn_hydrogen] if matrix_client_hydrogen_enabled else [])
  1728. +
  1729. ([matrix_server_fqn_cinny] if matrix_client_cinny_enabled else [])
  1730. +
  1731. ([matrix_server_fqn_buscarron] if matrix_bot_buscarron_enabled else [])
  1732. +
  1733. ([matrix_server_fqn_dimension] if matrix_dimension_enabled else [])
  1734. +
  1735. ([matrix_server_fqn_etherpad] if (matrix_etherpad_enabled and matrix_etherpad_mode == 'standalone') else [])
  1736. +
  1737. ([matrix_server_fqn_bot_go_neb] if matrix_bot_go_neb_enabled else [])
  1738. +
  1739. ([matrix_server_fqn_jitsi] if matrix_jitsi_enabled else [])
  1740. +
  1741. ([matrix_server_fqn_grafana] if matrix_grafana_enabled else [])
  1742. +
  1743. ([matrix_server_fqn_sygnal] if matrix_sygnal_enabled else [])
  1744. +
  1745. ([matrix_server_fqn_ntfy] if matrix_ntfy_enabled else [])
  1746. +
  1747. ([matrix_bot_postmoogle_domain] if matrix_bot_postmoogle_enabled else [])
  1748. +
  1749. ([matrix_domain] if matrix_nginx_proxy_base_domain_serving_enabled else [])
  1750. +
  1751. matrix_ssl_additional_domains_to_obtain_certificates_for
  1752. }}
  1753. matrix_ssl_architecture: "{{
  1754. {
  1755. 'amd64': 'amd64',
  1756. 'arm32': 'arm32v6',
  1757. 'arm64': 'arm64v8',
  1758. }[matrix_architecture]
  1759. }}"
  1760. matrix_ssl_pre_obtaining_required_service_name: "{{ 'matrix-dynamic-dns' if matrix_dynamic_dns_enabled else '' }}"
  1761. ######################################################################
  1762. #
  1763. # /matrix-nginx-proxy
  1764. #
  1765. ######################################################################
  1766. ######################################################################
  1767. #
  1768. # matrix-postgres
  1769. #
  1770. ######################################################################
  1771. matrix_postgres_enabled: true
  1772. matrix_postgres_architecture: "{{ matrix_architecture }}"
  1773. # We unset this if internal Postgres disabled, which will cascade to some other variables
  1774. # and tell users they need to set it (either here or in those variables).
  1775. matrix_postgres_connection_hostname: "{{ 'matrix-postgres' if matrix_postgres_enabled else '' }}"
  1776. matrix_postgres_pgloader_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1777. matrix_postgres_additional_databases: |
  1778. {{
  1779. ([{
  1780. 'name': matrix_synapse_database_database,
  1781. 'username': matrix_synapse_database_user,
  1782. 'password': matrix_synapse_database_password,
  1783. }] if (matrix_synapse_enabled and matrix_synapse_database_database != matrix_postgres_db_name and matrix_synapse_database_host == 'matrix-postgres') else [])
  1784. +
  1785. ([{
  1786. 'name': matrix_dendrite_federationapi_database,
  1787. 'username': matrix_dendrite_database_user,
  1788. 'password': matrix_dendrite_database_password,
  1789. },{
  1790. 'name': matrix_dendrite_keyserver_database,
  1791. 'username': matrix_dendrite_database_user,
  1792. 'password': matrix_dendrite_database_password,
  1793. },{
  1794. 'name': matrix_dendrite_mediaapi_database,
  1795. 'username': matrix_dendrite_database_user,
  1796. 'password': matrix_dendrite_database_password,
  1797. },{
  1798. 'name': matrix_dendrite_room_database,
  1799. 'username': matrix_dendrite_database_user,
  1800. 'password': matrix_dendrite_database_password,
  1801. },{
  1802. 'name': matrix_dendrite_syncapi_database,
  1803. 'username': matrix_dendrite_database_user,
  1804. 'password': matrix_dendrite_database_password,
  1805. },{
  1806. 'name': matrix_dendrite_userapi_database,
  1807. 'username': matrix_dendrite_database_user,
  1808. 'password': matrix_dendrite_database_password,
  1809. },{
  1810. 'name': matrix_dendrite_pushserver_database,
  1811. 'username': matrix_dendrite_database_user,
  1812. 'password': matrix_dendrite_database_password,
  1813. },{
  1814. 'name': matrix_dendrite_mscs_database,
  1815. 'username': matrix_dendrite_database_user,
  1816. 'password': matrix_dendrite_database_password,
  1817. }] if (matrix_dendrite_enabled and matrix_dendrite_database_hostname == 'matrix-postgres') else [])
  1818. +
  1819. ([{
  1820. 'name': matrix_ma1sd_database_name,
  1821. 'username': matrix_ma1sd_database_username,
  1822. 'password': matrix_ma1sd_database_password,
  1823. }] if (matrix_ma1sd_enabled and matrix_ma1sd_database_engine == 'postgres' and matrix_ma1sd_database_hostname == 'matrix-postgres') else [])
  1824. +
  1825. ([{
  1826. 'name': matrix_bot_matrix_reminder_bot_database_name,
  1827. 'username': matrix_bot_matrix_reminder_bot_database_username,
  1828. 'password': matrix_bot_matrix_reminder_bot_database_password,
  1829. }] 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 [])
  1830. +
  1831. ([{
  1832. 'name': matrix_bot_honoroit_database_name,
  1833. 'username': matrix_bot_honoroit_database_username,
  1834. 'password': matrix_bot_honoroit_database_password,
  1835. }] if (matrix_bot_honoroit_enabled and matrix_bot_honoroit_database_engine == 'postgres' and matrix_bot_honoroit_database_hostname == 'matrix-postgres') else [])
  1836. +
  1837. ([{
  1838. 'name': matrix_bot_postmoogle_database_name,
  1839. 'username': matrix_bot_postmoogle_database_username,
  1840. 'password': matrix_bot_postmoogle_database_password,
  1841. }] if (matrix_bot_postmoogle_enabled and matrix_bot_postmoogle_database_engine == 'postgres' and matrix_bot_postmoogle_database_hostname == 'matrix-postgres') else [])
  1842. +
  1843. ([{
  1844. 'name': matrix_bot_maubot_database_name,
  1845. 'username': matrix_bot_maubot_database_username,
  1846. 'password': matrix_bot_maubot_database_password,
  1847. }] if (matrix_bot_maubot_enabled and matrix_bot_maubot_database_engine == 'postgres' and matrix_bot_maubot_database_hostname == 'matrix-postgres') else [])
  1848. +
  1849. ([{
  1850. 'name': matrix_bot_buscarron_database_name,
  1851. 'username': matrix_bot_buscarron_database_username,
  1852. 'password': matrix_bot_buscarron_database_password,
  1853. }] if (matrix_bot_buscarron_enabled and matrix_bot_buscarron_database_engine == 'postgres' and matrix_bot_buscarron_database_hostname == 'matrix-postgres') else [])
  1854. +
  1855. ([{
  1856. 'name': matrix_registration_database_name,
  1857. 'username': matrix_registration_database_username,
  1858. 'password': matrix_registration_database_password,
  1859. }] if (matrix_registration_enabled and matrix_registration_database_engine == 'postgres' and matrix_registration_database_hostname == 'matrix-postgres') else [])
  1860. +
  1861. ([{
  1862. 'name': matrix_appservice_discord_database_name,
  1863. 'username': matrix_appservice_discord_database_username,
  1864. 'password': matrix_appservice_discord_database_password,
  1865. }] if (matrix_appservice_discord_enabled and matrix_appservice_discord_database_engine == 'postgres' and matrix_appservice_discord_database_hostname == 'matrix-postgres') else [])
  1866. +
  1867. ([{
  1868. 'name': matrix_appservice_slack_database_name,
  1869. 'username': matrix_appservice_slack_database_username,
  1870. 'password': matrix_appservice_slack_database_password,
  1871. }] if (matrix_appservice_slack_enabled and matrix_appservice_slack_database_engine == 'postgres' and matrix_appservice_slack_database_hostname == 'matrix-postgres') else [])
  1872. +
  1873. ([{
  1874. 'name': matrix_appservice_irc_database_name,
  1875. 'username': matrix_appservice_irc_database_username,
  1876. 'password': matrix_appservice_irc_database_password,
  1877. }] if (matrix_appservice_irc_enabled and matrix_appservice_irc_database_engine == 'postgres' and matrix_appservice_irc_database_hostname == 'matrix-postgres') else [])
  1878. +
  1879. ([{
  1880. 'name': matrix_appservice_kakaotalk_database_name,
  1881. 'username': matrix_appservice_kakaotalk_database_username,
  1882. 'password': matrix_appservice_kakaotalk_database_password,
  1883. }] if (matrix_appservice_kakaotalk_enabled and matrix_appservice_kakaotalk_database_engine == 'postgres' and matrix_appservice_kakaotalk_database_hostname == 'matrix-postgres') else [])
  1884. +
  1885. ([{
  1886. 'name': matrix_beeper_linkedin_database_name,
  1887. 'username': matrix_beeper_linkedin_database_username,
  1888. 'password': matrix_beeper_linkedin_database_password,
  1889. }] if (matrix_beeper_linkedin_enabled and matrix_beeper_linkedin_database_engine == 'postgres' and matrix_beeper_linkedin_database_hostname == 'matrix-postgres') else [])
  1890. +
  1891. ([{
  1892. 'name': matrix_go_skype_bridge_database_name,
  1893. 'username': matrix_go_skype_bridge_database_username,
  1894. 'password': matrix_go_skype_bridge_database_password,
  1895. }] if (matrix_go_skype_bridge_enabled and matrix_go_skype_bridge_database_engine == 'postgres' and matrix_go_skype_bridge_database_hostname == 'matrix-postgres') else [])
  1896. +
  1897. ([{
  1898. 'name': matrix_mautrix_facebook_database_name,
  1899. 'username': matrix_mautrix_facebook_database_username,
  1900. 'password': matrix_mautrix_facebook_database_password,
  1901. }] if (matrix_mautrix_facebook_enabled and matrix_mautrix_facebook_database_engine == 'postgres' and matrix_mautrix_facebook_database_hostname == 'matrix-postgres') else [])
  1902. +
  1903. ([{
  1904. 'name': matrix_mautrix_hangouts_database_name,
  1905. 'username': matrix_mautrix_hangouts_database_username,
  1906. 'password': matrix_mautrix_hangouts_database_password,
  1907. }] if (matrix_mautrix_hangouts_enabled and matrix_mautrix_hangouts_database_engine == 'postgres' and matrix_mautrix_hangouts_database_hostname == 'matrix-postgres') else [])
  1908. +
  1909. ([{
  1910. 'name': matrix_mautrix_googlechat_database_name,
  1911. 'username': matrix_mautrix_googlechat_database_username,
  1912. 'password': matrix_mautrix_googlechat_database_password,
  1913. }] if (matrix_mautrix_googlechat_enabled and matrix_mautrix_googlechat_database_engine == 'postgres' and matrix_mautrix_googlechat_database_hostname == 'matrix-postgres') else [])
  1914. +
  1915. ([{
  1916. 'name': matrix_mautrix_instagram_database_name,
  1917. 'username': matrix_mautrix_instagram_database_username,
  1918. 'password': matrix_mautrix_instagram_database_password,
  1919. }] if (matrix_mautrix_instagram_enabled and matrix_mautrix_instagram_database_engine == 'postgres' and matrix_mautrix_instagram_database_hostname == 'matrix-postgres') else [])
  1920. +
  1921. ([{
  1922. 'name': matrix_mautrix_signal_database_name,
  1923. 'username': matrix_mautrix_signal_database_username,
  1924. 'password': matrix_mautrix_signal_database_password,
  1925. }] if (matrix_mautrix_signal_enabled and matrix_mautrix_signal_database_engine == 'postgres' and matrix_mautrix_signal_database_hostname == 'matrix-postgres') else [])
  1926. +
  1927. ([{
  1928. 'name': matrix_mautrix_telegram_database_name,
  1929. 'username': matrix_mautrix_telegram_database_username,
  1930. 'password': matrix_mautrix_telegram_database_password,
  1931. }] if (matrix_mautrix_telegram_enabled and matrix_mautrix_telegram_database_engine == 'postgres' and matrix_mautrix_telegram_database_hostname == 'matrix-postgres') else [])
  1932. +
  1933. ([{
  1934. 'name': matrix_mautrix_twitter_database_name,
  1935. 'username': matrix_mautrix_twitter_database_username,
  1936. 'password': matrix_mautrix_twitter_database_password,
  1937. }] if (matrix_mautrix_twitter_enabled and matrix_mautrix_twitter_database_engine == 'postgres' and matrix_mautrix_twitter_database_hostname == 'matrix-postgres') else [])
  1938. +
  1939. ([{
  1940. 'name': matrix_mautrix_whatsapp_database_name,
  1941. 'username': matrix_mautrix_whatsapp_database_username,
  1942. 'password': matrix_mautrix_whatsapp_database_password,
  1943. }] if (matrix_mautrix_whatsapp_enabled and matrix_mautrix_whatsapp_database_engine == 'postgres' and matrix_mautrix_whatsapp_database_hostname == 'matrix-postgres') else [])
  1944. +
  1945. ([{
  1946. 'name': matrix_mautrix_discord_database_name,
  1947. 'username': matrix_mautrix_discord_database_username,
  1948. 'password': matrix_mautrix_discord_database_password,
  1949. }] if (matrix_mautrix_discord_enabled and matrix_mautrix_discord_database_engine == 'postgres' and matrix_mautrix_discord_database_hostname == 'matrix-postgres') else [])
  1950. +
  1951. ([{
  1952. 'name': matrix_mx_puppet_slack_database_name,
  1953. 'username': matrix_mx_puppet_slack_database_username,
  1954. 'password': matrix_mx_puppet_slack_database_password,
  1955. }] if (matrix_mx_puppet_slack_enabled and matrix_mx_puppet_slack_database_engine == 'postgres' and matrix_mx_puppet_slack_database_hostname == 'matrix-postgres') else [])
  1956. +
  1957. ([{
  1958. 'name': matrix_mx_puppet_twitter_database_name,
  1959. 'username': matrix_mx_puppet_twitter_database_username,
  1960. 'password': matrix_mx_puppet_twitter_database_password,
  1961. }] if (matrix_mx_puppet_twitter_enabled and matrix_mx_puppet_twitter_database_engine == 'postgres' and matrix_mx_puppet_twitter_database_hostname == 'matrix-postgres') else [])
  1962. +
  1963. ([{
  1964. 'name': matrix_mx_puppet_instagram_database_name,
  1965. 'username': matrix_mx_puppet_instagram_database_username,
  1966. 'password': matrix_mx_puppet_instagram_database_password,
  1967. }] if (matrix_mx_puppet_instagram_enabled and matrix_mx_puppet_instagram_database_engine == 'postgres' and matrix_mx_puppet_instagram_database_hostname == 'matrix-postgres') else [])
  1968. +
  1969. ([{
  1970. 'name': matrix_mx_puppet_discord_database_name,
  1971. 'username': matrix_mx_puppet_discord_database_username,
  1972. 'password': matrix_mx_puppet_discord_database_password,
  1973. }] if (matrix_mx_puppet_discord_enabled and matrix_mx_puppet_discord_database_engine == 'postgres' and matrix_mx_puppet_discord_database_hostname == 'matrix-postgres') else [])
  1974. +
  1975. ([{
  1976. 'name': matrix_mx_puppet_steam_database_name,
  1977. 'username': matrix_mx_puppet_steam_database_username,
  1978. 'password': matrix_mx_puppet_steam_database_password,
  1979. }] if (matrix_mx_puppet_steam_enabled and matrix_mx_puppet_steam_database_engine == 'postgres' and matrix_mx_puppet_steam_database_hostname == 'matrix-postgres') else [])
  1980. +
  1981. ([{
  1982. 'name': matrix_mx_puppet_groupme_database_name,
  1983. 'username': matrix_mx_puppet_groupme_database_username,
  1984. 'password': matrix_mx_puppet_groupme_database_password,
  1985. }] if (matrix_mx_puppet_groupme_enabled and matrix_mx_puppet_groupme_database_engine == 'postgres' and matrix_mx_puppet_groupme_database_hostname == 'matrix-postgres') else [])
  1986. +
  1987. ([{
  1988. 'name': matrix_dimension_database_name,
  1989. 'username': matrix_dimension_database_username,
  1990. 'password': matrix_dimension_database_password,
  1991. }] if (matrix_dimension_enabled and matrix_dimension_database_engine == 'postgres' and matrix_dimension_database_hostname == 'matrix-postgres') else [])
  1992. +
  1993. ([{
  1994. 'name': matrix_etherpad_database_name,
  1995. 'username': matrix_etherpad_database_username,
  1996. 'password': matrix_etherpad_database_password,
  1997. }] if (matrix_etherpad_enabled and matrix_etherpad_database_engine == 'postgres' and matrix_etherpad_database_hostname == 'matrix-postgres') else [])
  1998. +
  1999. ([{
  2000. 'name': matrix_prometheus_postgres_exporter_database_name,
  2001. 'username': matrix_prometheus_postgres_exporter_database_username,
  2002. 'password': matrix_prometheus_postgres_exporter_database_password,
  2003. }] if (matrix_prometheus_postgres_exporter_enabled and matrix_prometheus_postgres_exporter_database_hostname == 'matrix-postgres') else [])
  2004. }}
  2005. matrix_postgres_systemd_services_to_stop_for_maintenance_list: |
  2006. {{
  2007. ['matrix-' + matrix_homeserver_implementation + '.service']
  2008. }}
  2009. ######################################################################
  2010. #
  2011. # /matrix-postgres
  2012. #
  2013. ######################################################################
  2014. ######################################################################
  2015. #
  2016. # matrix-sygnal
  2017. #
  2018. ######################################################################
  2019. # Most people don't need their own push-server, because they also need their own app to utilize it from.
  2020. matrix_sygnal_enabled: false
  2021. # If someone instals Prometheus via the playbook, they most likely wish to monitor Sygnal.
  2022. matrix_sygnal_metrics_prometheus_enabled: "{{ matrix_prometheus_enabled }}"
  2023. matrix_sygnal_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:6000' }}"
  2024. ######################################################################
  2025. #
  2026. # /matrix-sygnal
  2027. #
  2028. ######################################################################
  2029. ######################################################################
  2030. #
  2031. # matrix-ntfy
  2032. #
  2033. ######################################################################
  2034. matrix_ntfy_enabled: false
  2035. matrix_ntfy_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:2586' }}"
  2036. ######################################################################
  2037. #
  2038. # /matrix-ntfy
  2039. #
  2040. ######################################################################
  2041. ######################################################################
  2042. #
  2043. # matrix-redis
  2044. #
  2045. ######################################################################
  2046. matrix_redis_enabled: "{{ matrix_synapse_workers_enabled }}"
  2047. ######################################################################
  2048. #
  2049. # /matrix-redis
  2050. #
  2051. ######################################################################
  2052. ######################################################################
  2053. #
  2054. # matrix-client-element
  2055. #
  2056. ######################################################################
  2057. # By default, this playbook installs the Element web UI on the `matrix_server_fqn_element` domain.
  2058. # If you wish to connect to your Matrix server by other means, you may wish to disable this.
  2059. matrix_client_element_enabled: true
  2060. matrix_client_element_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  2061. # Normally, matrix-nginx-proxy is enabled and nginx can reach Element over the container network.
  2062. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  2063. # the Element HTTP port to the local host.
  2064. matrix_client_element_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8765' }}"
  2065. matrix_client_element_default_hs_url: "{{ matrix_homeserver_url }}"
  2066. matrix_client_element_default_is_url: "{{ matrix_identity_server_url }}"
  2067. # Use Dimension if enabled, otherwise fall back to Scalar
  2068. matrix_client_element_integrations_ui_url: "{{ matrix_dimension_integrations_ui_url if matrix_dimension_enabled else 'https://scalar.vector.im/' }}"
  2069. matrix_client_element_integrations_rest_url: "{{ matrix_dimension_integrations_rest_url if matrix_dimension_enabled else 'https://scalar.vector.im/api' }}"
  2070. matrix_client_element_integrations_widgets_urls: "{{ matrix_dimension_integrations_widgets_urls if matrix_dimension_enabled else ['https://scalar.vector.im/api'] }}"
  2071. 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' }}"
  2072. matrix_client_element_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  2073. matrix_client_element_registration_enabled: "{{ matrix_synapse_enable_registration }}"
  2074. matrix_client_element_enable_presence_by_hs_url: |
  2075. {{
  2076. none
  2077. if matrix_synapse_presence_enabled
  2078. else {matrix_client_element_default_hs_url: false}
  2079. }}
  2080. matrix_client_element_welcome_user_id: ~
  2081. matrix_client_element_jitsi_preferredDomain: "{{ matrix_server_fqn_jitsi if matrix_jitsi_enabled else '' }}"
  2082. ######################################################################
  2083. #
  2084. # /matrix-client-element
  2085. #
  2086. ######################################################################
  2087. ######################################################################
  2088. #
  2089. # matrix-client-hydrogen
  2090. #
  2091. ######################################################################
  2092. matrix_client_hydrogen_enabled: false
  2093. # Normally, matrix-nginx-proxy is enabled and nginx can reach Hydrogen over the container network.
  2094. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  2095. # the HTTP port to the local host.
  2096. matrix_client_hydrogen_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8768' }}"
  2097. matrix_client_hydrogen_default_hs_url: "{{ matrix_homeserver_url }}"
  2098. matrix_client_hydrogen_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  2099. ######################################################################
  2100. #
  2101. # /matrix-client-hydrogen
  2102. #
  2103. ######################################################################
  2104. ######################################################################
  2105. #
  2106. # matrix-client-cinny
  2107. #
  2108. ######################################################################
  2109. matrix_client_cinny_enabled: false
  2110. matrix_client_cinny_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  2111. # Normally, matrix-nginx-proxy is enabled and nginx can reach Cinny over the container network.
  2112. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  2113. # the HTTP port to the local host.
  2114. matrix_client_cinny_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8080' }}"
  2115. matrix_client_cinny_default_hs_url: "{{ matrix_homeserver_url }}"
  2116. matrix_client_cinny_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  2117. ######################################################################
  2118. #
  2119. # /matrix-client-cinny
  2120. #
  2121. ######################################################################
  2122. ######################################################################
  2123. #
  2124. # matrix-synapse
  2125. #
  2126. ######################################################################
  2127. matrix_synapse_enabled: "{{ matrix_homeserver_implementation == 'synapse' }}"
  2128. matrix_synapse_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  2129. # When ma1sd is enabled, we can use it to validate phone numbers. It's something that the homeserver cannot do by itself.
  2130. matrix_synapse_account_threepid_delegates_msisdn: "{{ 'http://matrix-ma1sd:' + matrix_ma1sd_container_port | string if matrix_ma1sd_enabled else '' }}"
  2131. # For exposing the Matrix Federation API's TLS port (HTTPS) to the internet on all network interfaces.
  2132. 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 '' }}"
  2133. #
  2134. # For exposing the Synapse Metrics API's port (plain HTTP) to the local host.
  2135. 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 '' }}"
  2136. #
  2137. # For exposing the Synapse Manhole port (plain HTTP) to the local host.
  2138. matrix_synapse_container_manhole_api_host_bind_port: "{{ '127.0.0.1:9000' if matrix_synapse_manhole_enabled else '' }}"
  2139. #
  2140. # For exposing the Synapse worker (and metrics) ports to the local host.
  2141. matrix_synapse_workers_container_host_bind_address: "{{ '127.0.0.1' if (matrix_synapse_workers_enabled and not matrix_nginx_proxy_enabled) else '' }}"
  2142. matrix_synapse_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'synapse.db') | to_uuid }}"
  2143. matrix_synapse_macaroon_secret_key: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'synapse.mac') | to_uuid }}"
  2144. # We do not enable TLS in Synapse by default.
  2145. # TLS is handled by the matrix-nginx-proxy, which proxies the requests to Synapse.
  2146. matrix_synapse_tls_federation_listener_enabled: false
  2147. matrix_synapse_tls_certificate_path: ~
  2148. matrix_synapse_tls_private_key_path: ~
  2149. matrix_synapse_federation_port_openid_resource_required: "{{ not matrix_synapse_federation_enabled and (matrix_dimension_enabled or matrix_ma1sd_enabled) }}"
  2150. # If someone instals Prometheus via the playbook, they most likely wish to monitor Synapse.
  2151. matrix_synapse_metrics_enabled: "{{ matrix_prometheus_enabled }}"
  2152. matrix_synapse_email_enabled: "{{ matrix_mailer_enabled }}"
  2153. matrix_synapse_email_smtp_host: "matrix-mailer"
  2154. matrix_synapse_email_smtp_port: 8025
  2155. matrix_synapse_email_smtp_require_transport_security: false
  2156. matrix_synapse_email_notif_from: "Matrix <{{ matrix_mailer_sender_address }}>"
  2157. # Even if TURN doesn't support TLS (it does by default),
  2158. # it doesn't hurt to try a secure connection anyway.
  2159. #
  2160. # When Let's Encrypt certificates are used (the default case),
  2161. # we don't enable `turns` endpoints, because WebRTC in Element can't talk to them.
  2162. # Learn more here: https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1145
  2163. matrix_synapse_turn_uris: |
  2164. {{
  2165. []
  2166. +
  2167. [
  2168. 'turns:' + matrix_server_fqn_matrix + '?transport=udp',
  2169. 'turns:' + matrix_server_fqn_matrix + '?transport=tcp',
  2170. ] if matrix_coturn_enabled and matrix_coturn_tls_enabled and matrix_ssl_retrieval_method != 'lets-encrypt' else []
  2171. +
  2172. [
  2173. 'turn:' + matrix_server_fqn_matrix + '?transport=udp',
  2174. 'turn:' + matrix_server_fqn_matrix + '?transport=tcp',
  2175. ] if matrix_coturn_enabled else []
  2176. }}
  2177. matrix_synapse_turn_shared_secret: "{{ matrix_coturn_turn_static_auth_secret if matrix_coturn_enabled else '' }}"
  2178. matrix_synapse_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  2179. matrix_synapse_systemd_required_services_list: |
  2180. {{
  2181. (['docker.service'])
  2182. +
  2183. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  2184. +
  2185. (['matrix-goofys.service'] if matrix_s3_media_store_enabled else [])
  2186. }}
  2187. matrix_synapse_systemd_wanted_services_list: |
  2188. {{
  2189. (['matrix-coturn.service'] if matrix_coturn_enabled else [])
  2190. +
  2191. (['matrix-mailer.service'] if matrix_mailer_enabled else [])
  2192. }}
  2193. # Synapse workers (used for parallel load-scaling) need Redis for IPC.
  2194. matrix_synapse_redis_enabled: "{{ matrix_redis_enabled }}"
  2195. matrix_synapse_redis_host: "{{ 'matrix-redis' if matrix_redis_enabled else '' }}"
  2196. matrix_synapse_redis_password: "{{ matrix_redis_connection_password if matrix_redis_enabled else '' }}"
  2197. matrix_synapse_container_extra_arguments_auto: "{{ matrix_homeserver_container_extra_arguments_auto }}"
  2198. matrix_synapse_app_service_config_files_auto: "{{ matrix_homeserver_app_service_config_files_auto }}"
  2199. ######################################################################
  2200. #
  2201. # /matrix-synapse
  2202. #
  2203. ######################################################################
  2204. ######################################################################
  2205. #
  2206. # matrix-synapse-reverse-proxy-companion
  2207. #
  2208. ######################################################################
  2209. matrix_synapse_reverse_proxy_companion_enabled: "{{ matrix_synapse_enabled }}"
  2210. matrix_synapse_reverse_proxy_companion_client_api_client_max_body_size_mb: "{{ matrix_synapse_max_upload_size_mb }}"
  2211. matrix_synapse_reverse_proxy_companion_container_client_api_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8008' }}"
  2212. matrix_synapse_reverse_proxy_companion_container_federation_api_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8048' }}"
  2213. matrix_synapse_reverse_proxy_companion_synapse_workers_enabled: "{{ matrix_synapse_workers_enabled }}"
  2214. matrix_synapse_reverse_proxy_companion_synapse_workers_list: "{{ matrix_synapse_workers_enabled_list }}"
  2215. matrix_synapse_reverse_proxy_companion_synapse_generic_worker_client_server_locations: "{{ matrix_synapse_workers_generic_worker_client_server_endpoints }}"
  2216. matrix_synapse_reverse_proxy_companion_synapse_generic_worker_federation_locations: "{{ matrix_synapse_workers_generic_worker_federation_endpoints }}"
  2217. matrix_synapse_reverse_proxy_companion_synapse_stream_writer_typing_stream_worker_client_server_locations: "{{ matrix_synapse_workers_stream_writer_typing_stream_worker_client_server_endpoints }}"
  2218. matrix_synapse_reverse_proxy_companion_synapse_stream_writer_to_device_stream_worker_client_server_locations: "{{ matrix_synapse_workers_stream_writer_to_device_stream_worker_client_server_endpoints }}"
  2219. matrix_synapse_reverse_proxy_companion_synapse_stream_writer_account_data_stream_worker_client_server_locations: "{{ matrix_synapse_workers_stream_writer_account_data_stream_worker_client_server_endpoints }}"
  2220. matrix_synapse_reverse_proxy_companion_synapse_stream_writer_receipts_stream_worker_client_server_locations: "{{ matrix_synapse_workers_stream_writer_receipts_stream_worker_client_server_endpoints }}"
  2221. matrix_synapse_reverse_proxy_companion_synapse_stream_writer_presence_stream_worker_client_server_locations: "{{ matrix_synapse_workers_stream_writer_presence_stream_worker_client_server_endpoints }}"
  2222. matrix_synapse_reverse_proxy_companion_synapse_media_repository_locations: "{{matrix_synapse_workers_media_repository_endpoints|default([]) }}"
  2223. matrix_synapse_reverse_proxy_companion_synapse_user_dir_locations: "{{ matrix_synapse_workers_user_dir_worker_client_server_endpoints|default([]) }}"
  2224. ######################################################################
  2225. #
  2226. # /matrix-synapse-reverse-proxy-companion
  2227. #
  2228. ######################################################################
  2229. ######################################################################
  2230. #
  2231. # matrix-synapse-admin
  2232. #
  2233. ######################################################################
  2234. matrix_synapse_admin_enabled: false
  2235. # Normally, matrix-nginx-proxy is enabled and nginx can reach Synapse Admin over the container network.
  2236. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  2237. # Synapse Admin's HTTP port to the local host.
  2238. matrix_synapse_admin_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8766' }}"
  2239. matrix_synapse_admin_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  2240. ######################################################################
  2241. #
  2242. # /matrix-synapse-admin
  2243. #
  2244. ######################################################################
  2245. ######################################################################
  2246. #
  2247. # matrix-prometheus-node-exporter
  2248. #
  2249. ######################################################################
  2250. matrix_prometheus_node_exporter_enabled: false
  2251. ######################################################################
  2252. #
  2253. # /matrix-prometheus-node-exporter
  2254. #
  2255. ######################################################################
  2256. ######################################################################
  2257. #
  2258. # matrix-prometheus
  2259. #
  2260. ######################################################################
  2261. matrix_prometheus_enabled: false
  2262. # Normally, matrix-nginx-proxy is enabled and nginx can reach Prometheus over the container network.
  2263. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  2264. # Prometheus' HTTP port to the local host.
  2265. matrix_prometheus_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9090' }}"
  2266. matrix_prometheus_scraper_synapse_enabled: "{{ matrix_synapse_enabled and matrix_synapse_metrics_enabled }}"
  2267. matrix_prometheus_scraper_synapse_targets: ['matrix-synapse:{{ matrix_synapse_metrics_port }}']
  2268. matrix_prometheus_scraper_synapse_workers_enabled_list: "{{ matrix_synapse_workers_enabled_list }}"
  2269. matrix_prometheus_scraper_synapse_rules_synapse_tag: "{{ matrix_synapse_docker_image_tag }}"
  2270. matrix_prometheus_scraper_node_enabled: "{{ matrix_prometheus_node_exporter_enabled }}"
  2271. matrix_prometheus_scraper_node_targets: "{{ ['matrix-prometheus-node-exporter:9100'] if matrix_prometheus_node_exporter_enabled else [] }}"
  2272. matrix_prometheus_scraper_postgres_enabled: "{{ matrix_prometheus_postgres_exporter_enabled }}"
  2273. matrix_prometheus_scraper_postgres_targets: "{{ ['matrix-prometheus-postgres-exporter:'+ matrix_prometheus_postgres_exporter_port | string] if matrix_prometheus_scraper_postgres_enabled else [] }}"
  2274. matrix_prometheus_scraper_hookshot_enabled: "{{ matrix_hookshot_metrics_enabled|default(false) }}"
  2275. matrix_prometheus_scraper_hookshot_targets: "{{ [matrix_hookshot_container_url | string +':'+ matrix_hookshot_metrics_port | string] if matrix_hookshot_metrics_enabled else [] }}"
  2276. ######################################################################
  2277. #
  2278. # /matrix-prometheus
  2279. #
  2280. ######################################################################
  2281. ######################################################################
  2282. #
  2283. # matrix-prometheus-postgres-exporter
  2284. #
  2285. ######################################################################
  2286. matrix_prometheus_postgres_exporter_enabled: false
  2287. matrix_prometheus_postgres_exporter_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'prometheus.pg.db') | to_uuid }}"
  2288. matrix_prometheus_postgres_exporter_systemd_required_services_list: |
  2289. {{
  2290. ['docker.service']
  2291. +
  2292. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  2293. }}
  2294. ######################################################################
  2295. #
  2296. # /matrix-prometheus-postgres-exporter
  2297. #
  2298. ######################################################################
  2299. ######################################################################
  2300. #
  2301. # matrix-grafana
  2302. #
  2303. ######################################################################
  2304. matrix_grafana_enabled: false
  2305. # Normally, matrix-nginx-proxy is enabled and nginx can reach Grafana over the container network.
  2306. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  2307. # Grafana's HTTP port to the local host.
  2308. matrix_grafana_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:3000' }}"
  2309. matrix_grafana_dashboard_download_urls: |
  2310. {{
  2311. (matrix_synapse_grafana_dashboard_urls if matrix_homeserver_implementation == 'synapse' and matrix_synapse_metrics_enabled else [])
  2312. +
  2313. (matrix_prometheus_node_exporter_dashboard_urls if matrix_prometheus_node_exporter_enabled else [])
  2314. +
  2315. (matrix_prometheus_postgres_exporter_dashboard_urls if matrix_prometheus_postgres_exporter_enabled else [])
  2316. }}
  2317. matrix_grafana_default_home_dashboard_path: |-
  2318. {{
  2319. {
  2320. 'synapse': ('/etc/grafana/dashboards/synapse.json' if matrix_synapse_metrics_enabled else '/etc/grafana/dashboards/node-exporter-full.json'),
  2321. 'dendrite': '/etc/grafana/dashboards/node-exporter-full.json',
  2322. 'conduit': '/etc/grafana/dashboards/node-exporter-full.json',
  2323. }[matrix_homeserver_implementation]
  2324. }}
  2325. matrix_grafana_systemd_wanted_services_list: |
  2326. {{
  2327. []
  2328. +
  2329. (['matrix-prometheus-postgres-exporter.service'] if matrix_prometheus_postgres_exporter_enabled else [])
  2330. }}
  2331. ######################################################################
  2332. #
  2333. # /matrix-grafana
  2334. #
  2335. ######################################################################
  2336. ######################################################################
  2337. #
  2338. # matrix-registration
  2339. #
  2340. ######################################################################
  2341. matrix_registration_enabled: false
  2342. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-registration over the container network.
  2343. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  2344. # matrix-registration's HTTP port to the local host.
  2345. matrix_registration_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8767' }}"
  2346. matrix_registration_riot_instance: "{{ ('https://' + matrix_server_fqn_element) if matrix_client_element_enabled else 'https://riot.im/app/' }}"
  2347. matrix_registration_shared_secret: |-
  2348. {{
  2349. {
  2350. 'synapse': matrix_synapse_registration_shared_secret,
  2351. 'dendrite': matrix_dendrite_registration_shared_secret,
  2352. 'conduit': '',
  2353. }[matrix_homeserver_implementation]
  2354. }}
  2355. matrix_registration_server_location: "{{ matrix_homeserver_container_url }}"
  2356. matrix_registration_api_validate_certs: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  2357. matrix_registration_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  2358. matrix_registration_systemd_required_services_list: |
  2359. {{
  2360. ['docker.service']
  2361. +
  2362. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  2363. }}
  2364. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  2365. matrix_registration_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  2366. matrix_registration_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mx.registr.db') | to_uuid }}"
  2367. ######################################################################
  2368. #
  2369. # /matrix-registration
  2370. #
  2371. ######################################################################
  2372. ######################################################################
  2373. #
  2374. # matrix-postgres-backup
  2375. #
  2376. ######################################################################
  2377. matrix_postgres_backup_connection_hostname: "{{ matrix_postgres_connection_hostname }}"
  2378. matrix_postgres_backup_connection_port: "{{ matrix_postgres_connection_port }}"
  2379. matrix_postgres_backup_connection_username: "{{ matrix_postgres_connection_username }}"
  2380. matrix_postgres_backup_connection_password: "{{ matrix_postgres_connection_password }}"
  2381. matrix_postgres_backup_postgres_data_path: "{{ matrix_postgres_data_path if matrix_postgres_enabled else '' }}"
  2382. # 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
  2383. matrix_postgres_backup_databases: |
  2384. {{
  2385. (([{
  2386. 'name': matrix_synapse_database_database
  2387. }] if (matrix_synapse_enabled and matrix_synapse_database_database == matrix_postgres_db_name and matrix_synapse_database_host == 'matrix-postgres') else [])
  2388. +
  2389. matrix_postgres_additional_databases)|map(attribute='name') | list
  2390. }}
  2391. ######################################################################
  2392. #
  2393. # /matrix-postgres-backup
  2394. #
  2395. ######################################################################
  2396. ######################################################################
  2397. #
  2398. # matrix-dendrite
  2399. #
  2400. ######################################################################
  2401. matrix_dendrite_enabled: "{{ matrix_homeserver_implementation == 'dendrite' }}"
  2402. # Normally, matrix-nginx-proxy is enabled and nginx can reach Dendrite over the container network.
  2403. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it,
  2404. # you can expose Dendrite's ports to the host.
  2405. #
  2406. # For exposing Dendrite's plain HTTP server to the local host.
  2407. matrix_dendrite_container_http_host_bind_address: "{{ '' if matrix_nginx_proxy_enabled else ('127.0.0.1:' + matrix_dendrite_http_bind_port | string) }}"
  2408. #
  2409. # For exposing Dendrite's HTTPS server to the local host.
  2410. matrix_dendrite_container_https_host_bind_address: "{{ '' if matrix_nginx_proxy_enabled or not matrix_dendrite_https_bind_port else ('127.0.0.1:' + matrix_dendrite_https_bind_port | string) }}"
  2411. matrix_dendrite_sync_api_real_ip_header: "{{ 'X-Forwarded-For' if matrix_nginx_proxy_enabled else '' }}"
  2412. matrix_dendrite_registration_shared_secret: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'dendrite.rss') | to_uuid }}"
  2413. matrix_dendrite_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'dendrite.db') | to_uuid }}"
  2414. # Even if TURN doesn't support TLS (it does by default),
  2415. # it doesn't hurt to try a secure connection anyway.
  2416. matrix_dendrite_turn_uris: |
  2417. {{
  2418. [
  2419. 'turns:' + matrix_server_fqn_matrix + '?transport=udp',
  2420. 'turns:' + matrix_server_fqn_matrix + '?transport=tcp',
  2421. 'turn:' + matrix_server_fqn_matrix + '?transport=udp',
  2422. 'turn:' + matrix_server_fqn_matrix + '?transport=tcp',
  2423. ]
  2424. if matrix_coturn_enabled
  2425. else []
  2426. }}
  2427. matrix_dendrite_turn_shared_secret: "{{ matrix_coturn_turn_static_auth_secret if matrix_coturn_enabled else '' }}"
  2428. matrix_dendrite_disable_tls_validation: "{{ true if matrix_ssl_retrieval_method == 'self-signed' else false }}"
  2429. matrix_dendrite_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  2430. matrix_dendrite_trusted_id_servers: "{{ [matrix_server_fqn_matrix] if matrix_ma1sd_enabled else ['matrix.org', 'vector.im'] }}"
  2431. matrix_dendrite_systemd_required_services_list: |
  2432. {{
  2433. (['docker.service'])
  2434. +
  2435. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  2436. +
  2437. (['matrix-goofys.service'] if matrix_s3_media_store_enabled else [])
  2438. }}
  2439. matrix_dendrite_systemd_wanted_services_list: |
  2440. {{
  2441. (['matrix-coturn.service'] if matrix_coturn_enabled else [])
  2442. }}
  2443. matrix_dendrite_container_extra_arguments_auto: "{{ matrix_homeserver_container_extra_arguments_auto }}"
  2444. matrix_dendrite_app_service_config_files_auto: "{{ matrix_homeserver_app_service_config_files_auto }}"
  2445. ######################################################################
  2446. #
  2447. # /matrix-dendrite
  2448. #
  2449. ######################################################################
  2450. ######################################################################
  2451. #
  2452. # matrix-conduit
  2453. #
  2454. ######################################################################
  2455. matrix_conduit_enabled: "{{ matrix_homeserver_implementation == 'conduit' }}"
  2456. matrix_conduit_systemd_required_services_list: |
  2457. {{
  2458. (['docker.service'])
  2459. }}
  2460. ######################################################################
  2461. #
  2462. # /matrix-conduit
  2463. #
  2464. ######################################################################
  2465. ######################################################################
  2466. #
  2467. # matrix-user-creator
  2468. #
  2469. ######################################################################
  2470. matrix_user_creator_users_auto: |
  2471. {{
  2472. ([{
  2473. 'username': matrix_bot_matrix_reminder_bot_matrix_user_id_localpart,
  2474. 'initial_password': matrix_bot_matrix_reminder_bot_matrix_user_password,
  2475. 'initial_type': 'bot',
  2476. }] if matrix_bot_matrix_reminder_bot_enabled else [])
  2477. +
  2478. ([{
  2479. 'username': matrix_bot_honoroit_login,
  2480. 'initial_password': matrix_bot_honoroit_password,
  2481. 'initial_type': 'bot',
  2482. }] if matrix_bot_honoroit_enabled else [])
  2483. +
  2484. ([{
  2485. 'username': matrix_bot_postmoogle_login,
  2486. 'initial_password': matrix_bot_postmoogle_password,
  2487. 'initial_type': 'bot',
  2488. }] if matrix_bot_postmoogle_enabled else [])
  2489. +
  2490. ([{
  2491. 'username': matrix_bot_buscarron_login,
  2492. 'initial_password': matrix_bot_buscarron_password,
  2493. 'initial_type': 'bot',
  2494. }] if matrix_bot_buscarron_enabled else [])
  2495. }}
  2496. ######################################################################
  2497. #
  2498. # /matrix-user-creator
  2499. #
  2500. ######################################################################