Matrix Docker Ansible eploy
Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.

2422 строки
106 KiB

  1. ---
  2. # This variables file wires together the various components (roles) used by the playbook.
  3. #
  4. # Roles used by playbook are pretty minimal and kept independent of one another as much as possible.
  5. # To deliver a turnkey fully-featured Matrix server, this playbook needs
  6. # to connect them all together. It does so by overriding role variables.
  7. #
  8. # You can also override ANY variable (seen here or in any given role),
  9. # by re-defining it in your own configuration file (`inventory/host_vars/matrix.<your-domain>`).
  10. ######################################################################
  11. #
  12. # matrix-base
  13. #
  14. ######################################################################
  15. matrix_identity_server_url: "{{ ('https://' + matrix_server_fqn_matrix) if matrix_ma1sd_enabled else None }}"
  16. # If Synapse workers are enabled and matrix-nginx-proxy is disabled, certain APIs may not work over 'http://matrix-synapse:{{ matrix_synapse_container_client_api_port }}'.
  17. # This is because we explicitly disable them for the main Synapse process.
  18. matrix_homeserver_container_url: |-
  19. {{
  20. 'http://matrix-nginx-proxy:12080' if matrix_nginx_proxy_enabled else {
  21. 'synapse': ('http://matrix-synapse:'+ matrix_synapse_container_client_api_port | string),
  22. 'dendrite': ('http://matrix-dendrite:' + matrix_dendrite_http_bind_port | string),
  23. }[matrix_homeserver_implementation]
  24. }}
  25. matrix_homeserver_container_federation_url: |-
  26. {{
  27. 'http://matrix-nginx-proxy:12088' if matrix_nginx_proxy_enabled else {
  28. 'synapse': ('http://matrix-synapse:'+ matrix_synapse_container_federation_api_plain_port | string),
  29. 'dendrite': ('http://matrix-dendrite:' + matrix_dendrite_http_bind_port | string),
  30. }[matrix_homeserver_implementation]
  31. }}
  32. matrix_integration_manager_rest_url: "{{ matrix_dimension_integrations_rest_url if matrix_dimension_enabled else None }}"
  33. matrix_integration_manager_ui_url: "{{ matrix_dimension_integrations_ui_url if matrix_dimension_enabled else None }}"
  34. ######################################################################
  35. #
  36. # /matrix-base
  37. #
  38. ######################################################################
  39. ######################################################################
  40. #
  41. # matrix-bridge-appservice-discord
  42. #
  43. ######################################################################
  44. # We don't enable bridges by default.
  45. matrix_appservice_discord_enabled: false
  46. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-discord over the container network.
  47. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  48. # matrix-appservice-discord's client-server port to the local host.
  49. matrix_appservice_discord_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9005' }}"
  50. # If the homeserver disables presence, it's likely better (less wasteful) to also disable presence on the bridge side.
  51. matrix_appservice_discord_bridge_disablePresence: "{{ not matrix_synapse_presence_enabled }}"
  52. matrix_appservice_discord_systemd_required_services_list: |
  53. {{
  54. ['docker.service']
  55. +
  56. ['matrix-' + matrix_homeserver_implementation + '.service']
  57. +
  58. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  59. +
  60. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  61. }}
  62. matrix_appservice_discord_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'discord.as.token') | to_uuid }}"
  63. matrix_appservice_discord_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'discord.hs.token') | to_uuid }}"
  64. # We only make this use Postgres if our own Postgres server is enabled.
  65. # It's only then (for now) that we can automatically create the necessary database and user for this service.
  66. matrix_appservice_discord_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  67. matrix_appservice_discord_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'as.discord.db') | to_uuid }}"
  68. ######################################################################
  69. #
  70. # /matrix-bridge-appservice-discord
  71. #
  72. ######################################################################
  73. ######################################################################
  74. #
  75. # matrix-appservice-webhooks
  76. #
  77. ######################################################################
  78. # We don't enable bridges by default.
  79. matrix_appservice_webhooks_enabled: false
  80. matrix_appservice_webhooks_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  81. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-webhooks over the container network.
  82. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  83. # matrix-appservice-webhooks' client-server port to the local host.
  84. matrix_appservice_webhooks_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else ('127.0.0.1:' ~ matrix_appservice_webhooks_matrix_port) }}"
  85. matrix_appservice_webhooks_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'webhook.as.token') | to_uuid }}"
  86. matrix_appservice_webhooks_homeserver_url: "{{ matrix_homeserver_container_url }}"
  87. matrix_appservice_webhooks_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'webhook.hs.token') | to_uuid }}"
  88. matrix_appservice_webhooks_id_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'webhook.id.token') | to_uuid }}"
  89. matrix_appservice_webhooks_systemd_required_services_list: |
  90. {{
  91. ['docker.service']
  92. +
  93. ['matrix-' + matrix_homeserver_implementation + '.service']
  94. +
  95. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  96. }}
  97. ######################################################################
  98. #
  99. # /matrix-appservice-webhooks
  100. #
  101. ######################################################################
  102. ######################################################################
  103. #
  104. # matrix-appservice-slack
  105. #
  106. ######################################################################
  107. # We don't enable bridges by default.
  108. matrix_appservice_slack_enabled: false
  109. matrix_appservice_slack_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  110. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-slack over the container network.
  111. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  112. # matrix-appservice-slack's client-server port to the local host.
  113. matrix_appservice_slack_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else ('127.0.0.1:' ~ matrix_appservice_slack_slack_port) }}"
  114. matrix_appservice_slack_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'slack.as.token') | to_uuid }}"
  115. matrix_appservice_slack_homeserver_url: "{{ matrix_homeserver_container_url }}"
  116. matrix_appservice_slack_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'slack.hs.token') | to_uuid }}"
  117. matrix_appservice_slack_id_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'slack.id.token') | to_uuid }}"
  118. matrix_appservice_slack_systemd_required_services_list: |
  119. {{
  120. ['docker.service']
  121. +
  122. ['matrix-' + matrix_homeserver_implementation + '.service']
  123. +
  124. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  125. }}
  126. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  127. matrix_appservice_slack_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'nedb' }}"
  128. matrix_appservice_slack_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'as.slack.db') | to_uuid }}"
  129. ######################################################################
  130. #
  131. # /matrix-bridge-appservice-slack
  132. #
  133. ######################################################################
  134. ######################################################################
  135. #
  136. # matrix-bridge-appservice-irc
  137. #
  138. ######################################################################
  139. # We don't enable bridges by default.
  140. matrix_appservice_irc_enabled: false
  141. matrix_appservice_irc_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  142. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-irc over the container network.
  143. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  144. # matrix-appservice-irc's client-server port to the local host.
  145. matrix_appservice_irc_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9999' }}"
  146. # The IRC bridge docs say that if homeserver presence is disabled, it's better to also disable
  147. # IRC bridge presence, for performance reasons.
  148. matrix_appservice_irc_homeserver_enablePresence: "{{ matrix_synapse_presence_enabled }}"
  149. matrix_appservice_irc_systemd_required_services_list: |
  150. {{
  151. ['docker.service']
  152. +
  153. ['matrix-' + matrix_homeserver_implementation + '.service']
  154. +
  155. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  156. }}
  157. matrix_appservice_irc_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'irc.as.token') | to_uuid }}"
  158. matrix_appservice_irc_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'irc.hs.token') | to_uuid }}"
  159. matrix_appservice_irc_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'nedb' }}"
  160. matrix_appservice_irc_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'as.irc.db') | to_uuid }}"
  161. ######################################################################
  162. #
  163. # /matrix-bridge-appservice-irc
  164. #
  165. ######################################################################
  166. ######################################################################
  167. #
  168. # matrix-bridge-beeper-linkedin
  169. #
  170. ######################################################################
  171. # We don't enable bridges by default.
  172. matrix_beeper_linkedin_enabled: false
  173. matrix_beeper_linkedin_container_image_self_build: "{{ matrix_architecture not in ['amd64'] }}"
  174. matrix_beeper_linkedin_systemd_required_services_list: |
  175. {{
  176. ['docker.service']
  177. +
  178. ['matrix-' + matrix_homeserver_implementation + '.service']
  179. +
  180. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  181. +
  182. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  183. }}
  184. matrix_beeper_linkedin_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'linked.as.token') | to_uuid }}"
  185. matrix_beeper_linkedin_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'linked.hs.token') | to_uuid }}"
  186. 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 '' }}"
  187. matrix_beeper_linkedin_bridge_presence: "{{ matrix_synapse_presence_enabled if matrix_synapse_enabled else true }}"
  188. matrix_beeper_linkedin_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'maulinkedin.db') | to_uuid }}"
  189. ######################################################################
  190. #
  191. # /matrix-bridge-beeper-linkedin
  192. #
  193. ######################################################################
  194. ######################################################################
  195. #
  196. # matrix-bridge-go-skype-bridge
  197. #
  198. ######################################################################
  199. # We don't enable bridges by default.
  200. matrix_go_skype_bridge_enabled: false
  201. matrix_go_skype_bridge_container_image_self_build: true
  202. matrix_go_skype_bridge_systemd_required_services_list: |
  203. {{
  204. ['docker.service']
  205. +
  206. ['matrix-' + matrix_homeserver_implementation + '.service']
  207. +
  208. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  209. +
  210. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  211. }}
  212. matrix_go_skype_bridge_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'skype.as.token') | to_uuid }}"
  213. matrix_go_skype_bridge_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'skype.hs.token') | to_uuid }}"
  214. 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 '' }}"
  215. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  216. matrix_go_skype_bridge_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  217. matrix_go_skype_bridge_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'goskype.db') | to_uuid }}"
  218. ######################################################################
  219. #
  220. # /matrix-bridge-go-skype-bridge
  221. #
  222. ######################################################################
  223. ######################################################################
  224. #
  225. # matrix-bridge-mautrix-facebook
  226. #
  227. ######################################################################
  228. # We don't enable bridges by default.
  229. matrix_mautrix_facebook_enabled: false
  230. matrix_mautrix_facebook_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  231. matrix_mautrix_facebook_systemd_required_services_list: |
  232. {{
  233. ['docker.service']
  234. +
  235. ['matrix-' + matrix_homeserver_implementation + '.service']
  236. +
  237. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  238. +
  239. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  240. }}
  241. matrix_mautrix_facebook_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'fb.as.token') | to_uuid }}"
  242. matrix_mautrix_facebook_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'fb.hs.token') | to_uuid }}"
  243. matrix_mautrix_facebook_public_endpoint: "/{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'facebook') | to_uuid }}"
  244. matrix_mautrix_facebook_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9008' }}"
  245. 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 '' }}"
  246. matrix_mautrix_facebook_bridge_presence: "{{ matrix_synapse_presence_enabled if matrix_synapse_enabled else true }}"
  247. # We'd like to force-set people with external Postgres to SQLite, so the bridge role can complain
  248. # and point them to a migration path.
  249. matrix_mautrix_facebook_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  250. matrix_mautrix_facebook_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mau.fb.db') | to_uuid }}"
  251. ######################################################################
  252. #
  253. # /matrix-bridge-mautrix-facebook
  254. #
  255. ######################################################################
  256. ######################################################################
  257. #
  258. # matrix-bridge-mautrix-hangouts
  259. #
  260. ######################################################################
  261. # We don't enable bridges by default.
  262. matrix_mautrix_hangouts_enabled: false
  263. matrix_mautrix_hangouts_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  264. matrix_mautrix_hangouts_systemd_required_services_list: |
  265. {{
  266. ['docker.service']
  267. +
  268. ['matrix-' + matrix_homeserver_implementation + '.service']
  269. +
  270. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  271. +
  272. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  273. }}
  274. matrix_mautrix_hangouts_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'ho.as.token') | to_uuid }}"
  275. matrix_mautrix_hangouts_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'ho.hs.token') | to_uuid }}"
  276. matrix_mautrix_hangouts_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9007' }}"
  277. 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 '' }}"
  278. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  279. matrix_mautrix_hangouts_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  280. matrix_mautrix_hangouts_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mau.hangouts.db') | to_uuid }}"
  281. ######################################################################
  282. #
  283. # /matrix-bridge-mautrix-hangouts
  284. #
  285. ######################################################################
  286. ######################################################################
  287. #
  288. # matrix-bridge-mautrix-googlechat
  289. #
  290. ######################################################################
  291. # We don't enable bridges by default.
  292. matrix_mautrix_googlechat_enabled: false
  293. matrix_mautrix_googlechat_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  294. matrix_mautrix_googlechat_systemd_required_services_list: |
  295. {{
  296. ['docker.service']
  297. +
  298. ['matrix-' + matrix_homeserver_implementation + '.service']
  299. +
  300. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  301. +
  302. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  303. }}
  304. matrix_mautrix_googlechat_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'gc.as.token') | to_uuid }}"
  305. matrix_mautrix_googlechat_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'gc.hs.token') | to_uuid }}"
  306. matrix_mautrix_googlechat_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9007' }}"
  307. 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 '' }}"
  308. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  309. matrix_mautrix_googlechat_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  310. matrix_mautrix_googlechat_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mau.gc.db') | to_uuid }}"
  311. ######################################################################
  312. #
  313. # /matrix-bridge-mautrix-googlechat
  314. #
  315. ######################################################################
  316. ######################################################################
  317. #
  318. # matrix-bridge-mautrix-instagram
  319. #
  320. ######################################################################
  321. # We don't enable bridges by default.
  322. matrix_mautrix_instagram_enabled: false
  323. matrix_mautrix_instagram_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  324. matrix_mautrix_instagram_systemd_required_services_list: |
  325. {{
  326. ['docker.service']
  327. +
  328. ['matrix-' + matrix_homeserver_implementation + '.service']
  329. +
  330. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  331. +
  332. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  333. }}
  334. matrix_mautrix_instagram_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'ig.as.token') | to_uuid }}"
  335. matrix_mautrix_instagram_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'ig.hs.token') | to_uuid }}"
  336. 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 '' }}"
  337. matrix_mautrix_instagram_bridge_presence: "{{ matrix_synapse_presence_enabled if matrix_synapse_enabled else true }}"
  338. # We'd like to force-set people with external Postgres to SQLite, so the bridge role can complain
  339. # and point them to a migration path.
  340. matrix_mautrix_instagram_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  341. matrix_mautrix_instagram_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mau.ig.db') | to_uuid }}"
  342. ######################################################################
  343. #
  344. # /matrix-bridge-mautrix-instagram
  345. #
  346. ######################################################################
  347. ######################################################################
  348. #
  349. # matrix-bridge-mautrix-signal
  350. #
  351. ######################################################################
  352. # We don't enable bridges by default.
  353. matrix_mautrix_signal_enabled: false
  354. matrix_mautrix_signal_systemd_required_services_list: |
  355. {{
  356. ['docker.service']
  357. +
  358. ['matrix-' + matrix_homeserver_implementation + '.service']
  359. +
  360. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  361. +
  362. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  363. +
  364. ['matrix-mautrix-signal-daemon.service']
  365. }}
  366. matrix_mautrix_signal_homeserver_domain: '{{ matrix_domain }}'
  367. matrix_mautrix_signal_homeserver_address: "{{ matrix_homeserver_container_url }}"
  368. matrix_mautrix_signal_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'si.hs.token') | to_uuid }}"
  369. matrix_mautrix_signal_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'si.as.token') | to_uuid }}"
  370. 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 '' }}"
  371. matrix_mautrix_signal_database_engine: 'postgres'
  372. matrix_mautrix_signal_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mau.signal.db') | to_uuid }}"
  373. matrix_mautrix_signal_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  374. matrix_mautrix_signal_daemon_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  375. ######################################################################
  376. #
  377. # /matrix-bridge-mautrix-signal
  378. #
  379. ######################################################################
  380. ######################################################################
  381. #
  382. # matrix-bridge-mautrix-telegram
  383. #
  384. ######################################################################
  385. # We don't enable bridges by default.
  386. matrix_mautrix_telegram_enabled: false
  387. # Images are multi-arch (amd64 and arm64, but not arm32).
  388. matrix_mautrix_telegram_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  389. matrix_telegram_lottieconverter_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  390. matrix_telegram_lottieconverter_container_image_self_build_mask_arch: "{{ matrix_architecture != 'amd64' }}"
  391. matrix_mautrix_telegram_systemd_required_services_list: |
  392. {{
  393. ['docker.service']
  394. +
  395. ['matrix-' + matrix_homeserver_implementation + '.service']
  396. +
  397. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  398. +
  399. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  400. }}
  401. matrix_mautrix_telegram_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'telegr.as.token') | to_uuid }}"
  402. matrix_mautrix_telegram_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'telegr.hs.token') | to_uuid }}"
  403. matrix_mautrix_telegram_public_endpoint: "/{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'telegram') | to_uuid }}"
  404. matrix_mautrix_telegram_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9006' }}"
  405. 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 '' }}"
  406. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  407. matrix_mautrix_telegram_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  408. matrix_mautrix_telegram_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mau.telegram.db') | to_uuid }}"
  409. ######################################################################
  410. #
  411. # /matrix-bridge-mautrix-telegram
  412. #
  413. ######################################################################
  414. ######################################################################
  415. #
  416. # matrix-bridge-mautrix-twitter
  417. #
  418. ######################################################################
  419. # We don't enable bridges by default.
  420. matrix_mautrix_twitter_enabled: false
  421. matrix_mautrix_twitter_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  422. matrix_mautrix_twitter_systemd_required_services_list: |
  423. {{
  424. ['docker.service']
  425. +
  426. ['matrix-' + matrix_homeserver_implementation + '.service']
  427. +
  428. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  429. +
  430. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  431. }}
  432. matrix_mautrix_twitter_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'twt.as.token') | to_uuid }}"
  433. matrix_mautrix_twitter_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'twt.hs.token') | to_uuid }}"
  434. 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 '' }}"
  435. matrix_mautrix_twitter_database_hostname: "{{ 'matrix-postgres' if matrix_postgres_enabled else '' }}"
  436. 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 '' }}"
  437. ######################################################################
  438. #
  439. # /matrix-bridge-mautrix-twitter
  440. #
  441. ######################################################################
  442. ######################################################################
  443. #
  444. # matrix-bridge-mautrix-whatsapp
  445. #
  446. ######################################################################
  447. # We don't enable bridges by default.
  448. matrix_mautrix_whatsapp_enabled: false
  449. matrix_mautrix_whatsapp_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  450. matrix_mautrix_whatsapp_systemd_required_services_list: |
  451. {{
  452. ['docker.service']
  453. +
  454. ['matrix-' + matrix_homeserver_implementation + '.service']
  455. +
  456. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  457. +
  458. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  459. }}
  460. matrix_mautrix_whatsapp_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'whats.as.token') | to_uuid }}"
  461. matrix_mautrix_whatsapp_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'whats.hs.token') | to_uuid }}"
  462. 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 '' }}"
  463. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  464. matrix_mautrix_whatsapp_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  465. matrix_mautrix_whatsapp_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mauwhatsapp.db') | to_uuid }}"
  466. ######################################################################
  467. #
  468. # /matrix-bridge-mautrix-whatsapp
  469. #
  470. ######################################################################
  471. ######################################################################
  472. #
  473. # matrix-sms-bridge
  474. #
  475. ######################################################################
  476. # We don't enable bridges by default.
  477. matrix_sms_bridge_enabled: false
  478. matrix_sms_bridge_systemd_required_services_list: |
  479. {{
  480. ['docker.service']
  481. +
  482. ['matrix-' + matrix_homeserver_implementation + '.service']
  483. +
  484. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  485. }}
  486. matrix_sms_bridge_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'sms.as.token') | to_uuid }}"
  487. matrix_sms_bridge_homeserver_port: "{{ matrix_synapse_container_client_api_port }}"
  488. matrix_sms_bridge_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'sms.hs.token') | to_uuid }}"
  489. ######################################################################
  490. #
  491. # /matrix-sms-bridge
  492. #
  493. ######################################################################
  494. ######################################################################
  495. #
  496. # matrix-bridge-heisenbridge
  497. #
  498. ######################################################################
  499. # We don't enable bridges by default.
  500. matrix_heisenbridge_enabled: false
  501. matrix_heisenbridge_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'heisen.as.tok') | to_uuid }}"
  502. matrix_heisenbridge_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'heisen.hs.tok') | to_uuid }}"
  503. matrix_heisenbridge_systemd_wanted_services_list: |
  504. {{
  505. ['matrix-' + matrix_homeserver_implementation + '.service']
  506. +
  507. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  508. }}
  509. ######################################################################
  510. #
  511. # /matrix-bridge-heisenbridge
  512. #
  513. ######################################################################
  514. ######################################################################
  515. #
  516. # matrix-bridge-hookshot
  517. #
  518. ######################################################################
  519. # We don't enable bridges by default.
  520. matrix_hookshot_enabled: false
  521. matrix_hookshot_container_image_self_build: "{{ matrix_architecture not in ['amd64'] }}"
  522. matrix_hookshot_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'hookshot.as.tok') | to_uuid }}"
  523. matrix_hookshot_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'hookshot.hs.tok') | to_uuid }}"
  524. matrix_hookshot_systemd_wanted_services_list: |
  525. {{
  526. (['matrix-' + matrix_homeserver_implementation + '.service'])
  527. +
  528. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  529. }}
  530. matrix_hookshot_container_http_host_bind_ports_defaultmapping:
  531. - "127.0.0.1:{{ matrix_hookshot_appservice_port }}:{{ matrix_hookshot_appservice_port }}"
  532. - "127.0.0.1:{{ matrix_hookshot_metrics_port }}:{{ matrix_hookshot_metrics_port }}"
  533. - "127.0.0.1:{{ matrix_hookshot_webhook_port }}:{{ matrix_hookshot_webhook_port }}"
  534. - "127.0.0.1:{{ matrix_hookshot_provisioning_port }}:{{ matrix_hookshot_provisioning_port }}"
  535. matrix_hookshot_container_http_host_bind_ports: "{{ [] if matrix_nginx_proxy_enabled else matrix_hookshot_container_http_host_bind_ports_defaultmapping }}"
  536. matrix_hookshot_provisioning_enabled: "{{ matrix_hookshot_provisioning_secret and matrix_dimension_enabled }}"
  537. # We only enable metrics (locally, in the container network) for the bridge if Prometheus is enabled.
  538. #
  539. # People using an external Prometheus server will need to toggle all of these to be able to consume metrics remotely:
  540. # - `matrix_hookshot_metrics_enabled`
  541. # - `matrix_hookshot_metrics_proxying_enabled`
  542. # - `matrix_nginx_proxy_proxy_matrix_metrics_enabled`
  543. matrix_hookshot_metrics_enabled: "{{ matrix_prometheus_enabled }}"
  544. 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 }}"
  545. 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 }}"
  546. 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 '' }}"
  547. ######################################################################
  548. #
  549. # /matrix-bridge-hookshot
  550. #
  551. ######################################################################
  552. ######################################################################
  553. #
  554. # matrix-bridge-mx-puppet-slack
  555. #
  556. ######################################################################
  557. # We don't enable bridges by default.
  558. matrix_mx_puppet_slack_enabled: false
  559. matrix_mx_puppet_slack_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  560. matrix_mx_puppet_slack_systemd_required_services_list: |
  561. {{
  562. ['docker.service']
  563. +
  564. ['matrix-' + matrix_homeserver_implementation + '.service']
  565. +
  566. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  567. +
  568. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  569. }}
  570. matrix_mx_puppet_slack_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxslk.as.tok') | to_uuid }}"
  571. matrix_mx_puppet_slack_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxslk.hs.tok') | to_uuid }}"
  572. 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 '' }}"
  573. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  574. matrix_mx_puppet_slack_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  575. matrix_mx_puppet_slack_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.slack.db') | to_uuid }}"
  576. ######################################################################
  577. #
  578. # /matrix-bridge-mx-puppet-slack
  579. #
  580. ######################################################################
  581. ######################################################################
  582. #
  583. # matrix-bridge-mx-puppet-twitter
  584. #
  585. ######################################################################
  586. # We don't enable bridges by default.
  587. matrix_mx_puppet_twitter_enabled: false
  588. matrix_mx_puppet_twitter_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  589. matrix_mx_puppet_twitter_systemd_required_services_list: |
  590. {{
  591. ['docker.service']
  592. +
  593. ['matrix-' + matrix_homeserver_implementation + '.service']
  594. +
  595. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  596. +
  597. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  598. }}
  599. matrix_mx_puppet_twitter_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxtwt.as.tok') | to_uuid }}"
  600. matrix_mx_puppet_twitter_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxtwt.hs.tok') | to_uuid }}"
  601. 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 '' }}"
  602. 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) }}"
  603. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  604. matrix_mx_puppet_twitter_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  605. matrix_mx_puppet_twitter_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.twitter.db') | to_uuid }}"
  606. ######################################################################
  607. #
  608. # /matrix-bridge-mx-puppet-twitter
  609. #
  610. ######################################################################
  611. ######################################################################
  612. #
  613. # matrix-bridge-mx-puppet-instagram
  614. #
  615. ######################################################################
  616. # We don't enable bridges by default.
  617. matrix_mx_puppet_instagram_enabled: false
  618. matrix_mx_puppet_instagram_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  619. matrix_mx_puppet_instagram_systemd_required_services_list: |
  620. {{
  621. ['docker.service']
  622. +
  623. ['matrix-' + matrix_homeserver_implementation + '.service']
  624. +
  625. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  626. +
  627. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  628. }}
  629. matrix_mx_puppet_instagram_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxig.as.tok') | to_uuid }}"
  630. matrix_mx_puppet_instagram_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxig.hs.tok') | to_uuid }}"
  631. 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 '' }}"
  632. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  633. matrix_mx_puppet_instagram_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  634. matrix_mx_puppet_instagram_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.ig.db') | to_uuid }}"
  635. ######################################################################
  636. #
  637. # /matrix-bridge-mx-puppet-instagram
  638. #
  639. ######################################################################
  640. ######################################################################
  641. #
  642. # matrix-bridge-mx-puppet-discord
  643. #
  644. ######################################################################
  645. # We don't enable bridges by default.
  646. matrix_mx_puppet_discord_enabled: false
  647. matrix_mx_puppet_discord_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  648. matrix_mx_puppet_discord_systemd_required_services_list: |
  649. {{
  650. ['docker.service']
  651. +
  652. ['matrix-' + matrix_homeserver_implementation + '.service']
  653. +
  654. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  655. +
  656. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  657. }}
  658. matrix_mx_puppet_discord_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxdsc.as.tok') | to_uuid }}"
  659. matrix_mx_puppet_discord_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxdsc.hs.tok') | to_uuid }}"
  660. 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 '' }}"
  661. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  662. matrix_mx_puppet_discord_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  663. matrix_mx_puppet_discord_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.dsc.db') | to_uuid }}"
  664. ######################################################################
  665. #
  666. # /matrix-bridge-mx-puppet-discord
  667. #
  668. ######################################################################
  669. ######################################################################
  670. #
  671. # matrix-bridge-mx-puppet-steam
  672. #
  673. ######################################################################
  674. # We don't enable bridges by default.
  675. matrix_mx_puppet_steam_enabled: false
  676. matrix_mx_puppet_steam_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  677. matrix_mx_puppet_steam_systemd_required_services_list: |
  678. {{
  679. ['docker.service']
  680. +
  681. ['matrix-' + matrix_homeserver_implementation + '.service']
  682. +
  683. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  684. +
  685. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  686. }}
  687. matrix_mx_puppet_steam_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxste.as.tok') | to_uuid }}"
  688. matrix_mx_puppet_steam_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxste.hs.tok') | to_uuid }}"
  689. 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 '' }}"
  690. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  691. matrix_mx_puppet_steam_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  692. matrix_mx_puppet_steam_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.steam.db') | to_uuid }}"
  693. ######################################################################
  694. #
  695. # /matrix-bridge-mx-puppet-steam
  696. #
  697. ######################################################################
  698. ######################################################################
  699. #
  700. # matrix-bridge-mx-puppet-groupme
  701. #
  702. ######################################################################
  703. # We don't enable bridges by default.
  704. matrix_mx_puppet_groupme_enabled: false
  705. matrix_mx_puppet_groupme_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  706. matrix_mx_puppet_groupme_systemd_required_services_list: |
  707. {{
  708. ['docker.service']
  709. +
  710. ['matrix-' + matrix_homeserver_implementation + '.service']
  711. +
  712. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  713. +
  714. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  715. }}
  716. matrix_mx_puppet_groupme_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxgro.as.tok') | to_uuid }}"
  717. matrix_mx_puppet_groupme_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxgro.hs.tok') | to_uuid }}"
  718. 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 '' }}"
  719. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  720. matrix_mx_puppet_groupme_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  721. matrix_mx_puppet_groupme_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.groupme.db') | to_uuid }}"
  722. ######################################################################
  723. #
  724. # /matrix-bridge-mx-puppet-groupme
  725. #
  726. ######################################################################
  727. ######################################################################
  728. #
  729. # matrix-bot-matrix-reminder-bot
  730. #
  731. ######################################################################
  732. # We don't enable bots by default.
  733. matrix_bot_matrix_reminder_bot_enabled: false
  734. matrix_bot_matrix_reminder_bot_systemd_required_services_list: |
  735. {{
  736. ['docker.service']
  737. +
  738. ['matrix-' + matrix_homeserver_implementation + '.service']
  739. +
  740. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  741. +
  742. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  743. }}
  744. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  745. matrix_bot_matrix_reminder_bot_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  746. matrix_bot_matrix_reminder_bot_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'reminder.bot.db') | to_uuid }}"
  747. matrix_bot_matrix_reminder_bot_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  748. ######################################################################
  749. #
  750. # /matrix-bot-matrix-reminder-bot
  751. #
  752. ######################################################################
  753. ######################################################################
  754. #
  755. # matrix-bot-matrix-registration-bot
  756. #
  757. ######################################################################
  758. # We don't enable bots by default.
  759. matrix_bot_matrix_registration_bot_enabled: false
  760. matrix_bot_matrix_registration_bot_container_image_self_build: "{{ matrix_architecture not in ['amd64'] }}"
  761. matrix_bot_matrix_registration_bot_systemd_required_services_list: |
  762. {{
  763. ['docker.service']
  764. +
  765. ['matrix-' + matrix_homeserver_implementation + '.service']
  766. +
  767. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  768. }}
  769. ######################################################################
  770. #
  771. # /matrix-bot-matrix-registration-bot
  772. #
  773. ######################################################################
  774. ######################################################################
  775. #
  776. # matrix-bot-honoroit
  777. #
  778. ######################################################################
  779. # We don't enable bots by default.
  780. matrix_bot_honoroit_enabled: false
  781. matrix_bot_honoroit_systemd_required_services_list: |
  782. {{
  783. ['docker.service']
  784. +
  785. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  786. +
  787. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  788. +
  789. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  790. }}
  791. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  792. matrix_bot_honoroit_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  793. matrix_bot_honoroit_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'honoroit.bot.db') | to_uuid }}"
  794. matrix_bot_honoroit_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm32', 'arm64'] }}"
  795. ######################################################################
  796. #
  797. # /matrix-bot-honoroit
  798. #
  799. ######################################################################
  800. ######################################################################
  801. #
  802. # matrix-bot-buscarron
  803. #
  804. ######################################################################
  805. # We don't enable bots by default.
  806. matrix_bot_buscarron_enabled: false
  807. matrix_bot_buscarron_systemd_required_services_list: |
  808. {{
  809. ['docker.service']
  810. +
  811. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  812. +
  813. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  814. +
  815. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  816. }}
  817. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  818. matrix_bot_buscarron_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  819. matrix_bot_buscarron_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'buscarron.bot.db') | to_uuid }}"
  820. matrix_bot_buscarron_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm32', 'arm64'] }}"
  821. ######################################################################
  822. #
  823. # /matrix-bot-buscarron
  824. #
  825. ######################################################################
  826. ######################################################################
  827. #
  828. # matrix-bot-go-neb
  829. #
  830. ######################################################################
  831. # We don't enable bots by default.
  832. matrix_bot_go_neb_enabled: false
  833. matrix_bot_go_neb_systemd_required_services_list: |
  834. {{
  835. ['docker.service']
  836. +
  837. ['matrix-' + matrix_homeserver_implementation + '.service']
  838. +
  839. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  840. }}
  841. matrix_bot_go_neb_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:4050' }}"
  842. ######################################################################
  843. #
  844. # /matrix-bot-go-neb
  845. #
  846. ######################################################################
  847. ######################################################################
  848. #
  849. # matrix-bot-mjolnir
  850. #
  851. ######################################################################
  852. # We don't enable bots by default.
  853. matrix_bot_mjolnir_enabled: false
  854. matrix_bot_mjolnir_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  855. matrix_bot_mjolnir_systemd_required_services_list: |
  856. {{
  857. ['docker.service']
  858. +
  859. ['matrix-' + matrix_homeserver_implementation + '.service']
  860. +
  861. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  862. +
  863. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  864. }}
  865. ######################################################################
  866. #
  867. # /matrix-bot-mjolnir
  868. #
  869. ######################################################################
  870. ######################################################################
  871. #
  872. # matrix-backup-borg
  873. #
  874. ######################################################################
  875. matrix_backup_borg_enabled: false
  876. matrix_backup_borg_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm32', 'arm64'] }}"
  877. matrix_backup_borg_postgresql_enabled: "{{ matrix_postgres_enabled }}"
  878. matrix_backup_borg_postgresql_databases_hostname: "{{ matrix_postgres_connection_hostname }}"
  879. matrix_backup_borg_postgresql_databases_username: "{{ matrix_postgres_connection_username }}"
  880. matrix_backup_borg_postgresql_databases_password: "{{ matrix_postgres_connection_password }}"
  881. matrix_backup_borg_postgresql_databases_port: "{{ matrix_postgres_connection_port }}"
  882. matrix_backup_borg_postgresql_databases: |
  883. {{
  884. (([{
  885. 'name': matrix_synapse_database_database
  886. }] if (matrix_synapse_enabled and matrix_synapse_database_database == matrix_postgres_db_name and matrix_synapse_database_host == 'matrix-postgres') else [])
  887. +
  888. matrix_postgres_additional_databases)|map(attribute='name') | list
  889. }}
  890. matrix_backup_borg_location_source_directories:
  891. - "{{ matrix_base_data_path }}"
  892. matrix_backup_borg_location_exclude_patterns: |
  893. {{
  894. ([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 [])
  895. +
  896. ([matrix_postgres_data_path] if matrix_postgres_enabled else [])
  897. }}
  898. matrix_backup_borg_systemd_required_services_list: |
  899. {{
  900. ['docker.service']
  901. +
  902. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  903. }}
  904. ######################################################################
  905. #
  906. # /matrix-backup-borg
  907. #
  908. ######################################################################
  909. ######################################################################
  910. #
  911. # matrix-corporal
  912. #
  913. ######################################################################
  914. matrix_corporal_enabled: false
  915. matrix_corporal_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm32', 'arm64'] }}"
  916. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-corporal over the container network.
  917. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  918. # matrix-corporal's web-server ports to the local host.
  919. matrix_corporal_container_http_gateway_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:41080' }}"
  920. matrix_corporal_container_http_api_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:41081' }}"
  921. matrix_corporal_systemd_required_services_list: |
  922. {{
  923. (['docker.service'])
  924. +
  925. (['matrix-' + matrix_homeserver_implementation + '.service'])
  926. }}
  927. matrix_corporal_matrix_homeserver_api_endpoint: "{{ matrix_homeserver_container_url }}"
  928. matrix_corporal_matrix_auth_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret }}"
  929. # This is only useful if there's REST auth provider to make use of it.
  930. matrix_corporal_http_gateway_internal_rest_auth_enabled: "{{ matrix_synapse_ext_password_provider_rest_auth_enabled }}"
  931. matrix_corporal_matrix_registration_shared_secret: "{{ matrix_synapse_registration_shared_secret }}"
  932. ######################################################################
  933. #
  934. # /matrix-corporal
  935. #
  936. ######################################################################
  937. ######################################################################
  938. #
  939. # matrix-coturn
  940. #
  941. ######################################################################
  942. matrix_coturn_enabled: true
  943. matrix_coturn_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm32', 'arm64'] }}"
  944. matrix_coturn_turn_external_ip_address: "{{ ansible_host }}"
  945. matrix_coturn_turn_static_auth_secret: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'coturn.sas') | to_uuid }}"
  946. matrix_coturn_tls_enabled: "{{ matrix_ssl_retrieval_method != 'none' }}"
  947. matrix_coturn_tls_cert_path: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_server_fqn_matrix }}/fullchain.pem"
  948. matrix_coturn_tls_key_path: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_server_fqn_matrix }}/privkey.pem"
  949. matrix_coturn_container_additional_volumes: |
  950. {{
  951. ([] if matrix_ssl_retrieval_method == 'none' else [
  952. {
  953. 'src': matrix_ssl_config_dir_path,
  954. 'dst': matrix_ssl_config_dir_path,
  955. 'options': 'ro',
  956. }
  957. ])
  958. }}
  959. ######################################################################
  960. #
  961. # /matrix-coturn
  962. #
  963. ######################################################################
  964. ######################################################################
  965. #
  966. # matrix-dimension
  967. #
  968. ######################################################################
  969. matrix_dimension_enabled: false
  970. matrix_dimension_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  971. # Normally, matrix-nginx-proxy is enabled and nginx can reach Dimension over the container network.
  972. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  973. # the Dimension HTTP port to the local host.
  974. matrix_dimension_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8184' }}"
  975. matrix_dimension_homeserver_federationUrl: "{{ matrix_homeserver_container_federation_url }}"
  976. matrix_dimension_systemd_required_services_list: |
  977. {{
  978. ['docker.service']
  979. +
  980. ['matrix-' + matrix_homeserver_implementation + '.service']
  981. +
  982. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  983. +
  984. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  985. }}
  986. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  987. matrix_dimension_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  988. matrix_dimension_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'dimension.db') | to_uuid }}"
  989. ######################################################################
  990. #
  991. # /matrix-dimension
  992. #
  993. ######################################################################
  994. ######################################################################
  995. #
  996. # matrix-etherpad
  997. #
  998. ######################################################################
  999. matrix_etherpad_enabled: false
  1000. matrix_etherpad_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9001' }}"
  1001. matrix_etherpad_systemd_required_services_list: |
  1002. {{
  1003. ['docker.service']
  1004. +
  1005. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1006. }}
  1007. matrix_etherpad_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'etherpad.db') | to_uuid }}"
  1008. ######################################################################
  1009. #
  1010. # /matrix-etherpad
  1011. #
  1012. ######################################################################
  1013. ######################################################################
  1014. #
  1015. # matrix-dynamic-dns
  1016. #
  1017. ######################################################################
  1018. matrix_dynamic_dns_enabled: false
  1019. ######################################################################
  1020. #
  1021. # /matrix-dynamic-dns
  1022. #
  1023. ######################################################################
  1024. ######################################################################
  1025. #
  1026. # matrix-email2matrix
  1027. #
  1028. ######################################################################
  1029. matrix_email2matrix_enabled: false
  1030. matrix_email2matrix_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm32', 'arm64'] }}"
  1031. ######################################################################
  1032. #
  1033. # /matrix-email2matrix
  1034. #
  1035. ######################################################################
  1036. ######################################################################
  1037. #
  1038. # matrix-jitsi
  1039. #
  1040. ######################################################################
  1041. matrix_jitsi_enabled: false
  1042. # Normally, matrix-nginx-proxy is enabled and nginx can reach jitsi/web over the container network.
  1043. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1044. # the Jitsi HTTP port to the local host.
  1045. matrix_jitsi_web_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:13080' }}"
  1046. matrix_jitsi_jvb_container_colibri_ws_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:13090' }}"
  1047. matrix_jitsi_prosody_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:5280' }}"
  1048. matrix_jitsi_jibri_xmpp_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'jibri') | to_uuid }}"
  1049. matrix_jitsi_jicofo_auth_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'jicofo') | to_uuid }}"
  1050. matrix_jitsi_jvb_auth_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'jvb') | to_uuid }}"
  1051. matrix_jitsi_web_stun_servers: |
  1052. {{
  1053. [
  1054. 'stun:' + matrix_server_fqn_matrix + ':5349',
  1055. 'stun:' + matrix_server_fqn_matrix + ':3478',
  1056. ]
  1057. if matrix_coturn_enabled
  1058. else [ 'stun:meet-jit-si-turnrelay.jitsi.net:443']
  1059. }}
  1060. # If the self-hosted Etherpad instance is available, it will also show up in Jitsi conferences,
  1061. # unless explicitly disabled by setting `matrix_jitsi_etherpad_enabled` to false.
  1062. # Falls back to the scalar.vector.im etherpad in case someone sets `matrix_jitsi_etherpad_enabled` to true,
  1063. # while also setting `matrix_etherpad_enabled` to false.
  1064. matrix_jitsi_etherpad_enabled: "{{ matrix_etherpad_enabled }}"
  1065. matrix_jitsi_etherpad_base: "{{ matrix_etherpad_base_url if matrix_etherpad_enabled else 'https://scalar.vector.im/etherpad' }}"
  1066. ######################################################################
  1067. #
  1068. # /matrix-jitsi
  1069. #
  1070. ######################################################################
  1071. ######################################################################
  1072. #
  1073. # matrix-mailer
  1074. #
  1075. ######################################################################
  1076. # By default, this playbook sets up an exim mailer server (running in a container).
  1077. # This is so that Synapse can send email reminders for unread messages.
  1078. # Other services (like ma1sd), also use the mailer.
  1079. matrix_mailer_enabled: true
  1080. matrix_mailer_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm32', 'arm64'] }}"
  1081. ######################################################################
  1082. #
  1083. # /matrix-mailer
  1084. #
  1085. ######################################################################
  1086. ######################################################################
  1087. #
  1088. # matrix-ma1sd
  1089. #
  1090. ######################################################################
  1091. # We no longer install the ma1sd identity server by default.
  1092. #
  1093. # The main reason we used to install ma1sd by default in the past was to
  1094. # prevent Element from talking to the `matrix.org` / `vector.im` identity servers,
  1095. # by forcing it to talk to our own self-hosted (but otherwise useless) identity server instead,
  1096. # thus preventing contact list leaks.
  1097. #
  1098. # Since Element no longer defaults to using a public identity server if another one is not provided,
  1099. # we can stop installing ma1sd.
  1100. matrix_ma1sd_enabled: false
  1101. matrix_ma1sd_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1102. # Normally, matrix-nginx-proxy is enabled and nginx can reach ma1sd over the container network.
  1103. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1104. # ma1sd's web-server port.
  1105. matrix_ma1sd_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:' + matrix_ma1sd_container_port | string }}"
  1106. # We enable Synapse integration via its Postgres database by default.
  1107. # When using another Identity store, you might wish to disable this and define
  1108. # your own configuration in `matrix_ma1sd_configuration_extension_yaml`.
  1109. matrix_ma1sd_synapsesql_enabled: true
  1110. matrix_ma1sd_synapsesql_type: postgresql
  1111. matrix_ma1sd_synapsesql_connection: //{{ matrix_synapse_database_host }}/{{ matrix_synapse_database_database }}?user={{ matrix_synapse_database_user | urlencode() }}&password={{ matrix_synapse_database_password | urlencode() }}
  1112. matrix_ma1sd_dns_overwrite_enabled: true
  1113. matrix_ma1sd_dns_overwrite_homeserver_client_name: "{{ matrix_server_fqn_matrix }}"
  1114. # The `matrix_ma1sd_dns_overwrite_homeserver_client_value` value when matrix_nginx_proxy_enabled is false covers the general case,
  1115. # but may be inaccurate if matrix-corporal is enabled.
  1116. 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 }}"
  1117. # By default, we send mail through the `matrix-mailer` service.
  1118. matrix_ma1sd_threepid_medium_email_identity_from: "{{ matrix_mailer_sender_address }}"
  1119. matrix_ma1sd_threepid_medium_email_connectors_smtp_host: "matrix-mailer"
  1120. matrix_ma1sd_threepid_medium_email_connectors_smtp_port: 8025
  1121. matrix_ma1sd_threepid_medium_email_connectors_smtp_tls: 0
  1122. matrix_ma1sd_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1123. matrix_ma1sd_systemd_required_services_list: |
  1124. {{
  1125. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1126. }}
  1127. matrix_ma1sd_systemd_wanted_services_list: |
  1128. {{
  1129. (['matrix-corporal.service'] if matrix_corporal_enabled else ['matrix-' + matrix_homeserver_implementation + '.service'])
  1130. +
  1131. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1132. +
  1133. (['matrix-mailer.service'] if matrix_mailer_enabled else [])
  1134. }}
  1135. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  1136. matrix_ma1sd_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  1137. matrix_ma1sd_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'ma1sd.db') | to_uuid }}"
  1138. ######################################################################
  1139. #
  1140. # /matrix-ma1sd
  1141. #
  1142. ######################################################################
  1143. ######################################################################
  1144. #
  1145. # matrix-nginx-proxy
  1146. #
  1147. ######################################################################
  1148. # By default, this playbook sets up a reverse-proxy nginx proxy server on TCP ports 80, 443 and 8448.
  1149. # This is fine if you're dedicating the whole server to Matrix.
  1150. # If that's not the case, you may wish to disable this and take care of proxying yourself.
  1151. matrix_nginx_proxy_enabled: true
  1152. matrix_nginx_proxy_proxy_matrix_client_api_addr_with_container: "{{ 'matrix-corporal:41080' if matrix_corporal_enabled else 'matrix-nginx-proxy:12080' }}"
  1153. 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' }}"
  1154. matrix_nginx_proxy_proxy_matrix_client_api_client_max_body_size_mb: |-
  1155. {{
  1156. {
  1157. 'synapse': matrix_synapse_max_upload_size_mb,
  1158. 'dendrite': (matrix_dendrite_max_file_size_bytes / 1024 / 1024) | round,
  1159. }[matrix_homeserver_implementation]|int
  1160. }}
  1161. matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_synapse_admin_api_enabled: "{{ matrix_synapse_admin_enabled or matrix_bot_matrix_registration_bot_enabled }}"
  1162. matrix_nginx_proxy_proxy_matrix_client_redirect_root_uri_to_domain: "{{ matrix_server_fqn_element if matrix_client_element_enabled else '' }}"
  1163. matrix_nginx_proxy_proxy_matrix_enabled: true
  1164. matrix_nginx_proxy_proxy_element_enabled: "{{ matrix_client_element_enabled }}"
  1165. matrix_nginx_proxy_proxy_hydrogen_enabled: "{{ matrix_client_hydrogen_enabled }}"
  1166. matrix_nginx_proxy_proxy_cinny_enabled: "{{ matrix_client_cinny_enabled }}"
  1167. matrix_nginx_proxy_proxy_buscarron_enabled: "{{ matrix_bot_buscarron_enabled }}"
  1168. matrix_nginx_proxy_proxy_dimension_enabled: "{{ matrix_dimension_enabled }}"
  1169. matrix_nginx_proxy_proxy_bot_go_neb_enabled: "{{ matrix_bot_go_neb_enabled }}"
  1170. matrix_nginx_proxy_proxy_jitsi_enabled: "{{ matrix_jitsi_enabled }}"
  1171. matrix_nginx_proxy_proxy_grafana_enabled: "{{ matrix_grafana_enabled }}"
  1172. matrix_nginx_proxy_proxy_sygnal_enabled: "{{ matrix_sygnal_enabled }}"
  1173. matrix_nginx_proxy_proxy_ntfy_enabled: "{{ matrix_ntfy_enabled }}"
  1174. matrix_nginx_proxy_proxy_matrix_corporal_api_enabled: "{{ matrix_corporal_enabled and matrix_corporal_http_api_enabled }}"
  1175. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_with_container: "matrix-corporal:41081"
  1176. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_sans_container: "127.0.0.1:41081"
  1177. matrix_nginx_proxy_proxy_matrix_identity_api_enabled: "{{ matrix_ma1sd_enabled }}"
  1178. matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container: "matrix-ma1sd:{{ matrix_ma1sd_container_port }}"
  1179. matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container: "127.0.0.1:{{ matrix_ma1sd_container_port }}"
  1180. # By default, we do TLS termination for the Matrix Federation API (port 8448) at matrix-nginx-proxy.
  1181. # Unless this is handled there OR Synapse's federation listener port is disabled, we'll reverse-proxy.
  1182. matrix_nginx_proxy_proxy_matrix_federation_api_enabled: |-
  1183. {{
  1184. {
  1185. 'synapse': (matrix_synapse_federation_port_enabled and not matrix_synapse_tls_federation_listener_enabled),
  1186. 'dendrite': matrix_dendrite_federation_enabled,
  1187. }[matrix_homeserver_implementation]|bool
  1188. }}
  1189. matrix_nginx_proxy_proxy_matrix_federation_api_addr_with_container: "matrix-nginx-proxy:12088"
  1190. matrix_nginx_proxy_proxy_matrix_federation_api_addr_sans_container: "127.0.0.1:12088"
  1191. matrix_nginx_proxy_proxy_synapse_enabled: "{{ matrix_synapse_enabled }}"
  1192. matrix_nginx_proxy_proxy_synapse_client_api_addr_with_container: "matrix-synapse:{{ matrix_synapse_container_client_api_port }}"
  1193. matrix_nginx_proxy_proxy_synapse_client_api_addr_sans_container: "127.0.0.1:{{ matrix_synapse_container_client_api_port }}"
  1194. matrix_nginx_proxy_proxy_synapse_federation_api_addr_with_container: "matrix-synapse:{{matrix_synapse_container_federation_api_plain_port | string}}"
  1195. matrix_nginx_proxy_proxy_synapse_federation_api_addr_sans_container: "127.0.0.1:{{matrix_synapse_container_federation_api_plain_port | string}}"
  1196. matrix_nginx_proxy_proxy_dendrite_enabled: "{{ matrix_dendrite_enabled }}"
  1197. matrix_nginx_proxy_proxy_dendrite_client_api_addr_with_container: "matrix-dendrite:{{ matrix_dendrite_http_bind_port | string }}"
  1198. matrix_nginx_proxy_proxy_dendrite_client_api_addr_sans_container: "127.0.0.1:{{ matrix_dendrite_http_bind_port | string }}"
  1199. matrix_nginx_proxy_proxy_dendrite_federation_api_addr_with_container: "matrix-dendrite:{{ matrix_dendrite_http_bind_port | string }}"
  1200. matrix_nginx_proxy_proxy_dendrite_federation_api_addr_sans_container: "127.0.0.1:{{ matrix_dendrite_http_bind_port | string }}"
  1201. # When matrix-nginx-proxy is disabled, the actual port number that the vhost uses may begin to matter.
  1202. matrix_nginx_proxy_proxy_matrix_federation_port: "{{ matrix_federation_public_port }}"
  1203. matrix_nginx_proxy_container_federation_host_bind_port: "{{ matrix_federation_public_port }}"
  1204. matrix_nginx_proxy_proxy_matrix_user_directory_search_enabled: "{{ matrix_ma1sd_enabled }}"
  1205. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_with_container: "{{ matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container }}"
  1206. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_sans_container: "{{ matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container }}"
  1207. matrix_nginx_proxy_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1208. # OCSP stapling does not make sense when self-signed certificates are used.
  1209. # See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1073
  1210. # and https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1074
  1211. matrix_nginx_proxy_ocsp_stapling_enabled: "{{ matrix_ssl_retrieval_method != 'self-signed' }}"
  1212. matrix_nginx_proxy_synapse_presence_disabled: "{{ not matrix_synapse_presence_enabled }}"
  1213. matrix_nginx_proxy_synapse_workers_enabled: "{{ matrix_synapse_workers_enabled }}"
  1214. matrix_nginx_proxy_synapse_workers_list: "{{ matrix_synapse_workers_enabled_list }}"
  1215. matrix_nginx_proxy_synapse_generic_worker_client_server_locations: "{{ matrix_synapse_workers_generic_worker_client_server_endpoints }}"
  1216. matrix_nginx_proxy_synapse_generic_worker_federation_locations: "{{ matrix_synapse_workers_generic_worker_federation_endpoints }}"
  1217. matrix_nginx_proxy_synapse_media_repository_locations: "{{matrix_synapse_workers_media_repository_endpoints|default([]) }}"
  1218. matrix_nginx_proxy_synapse_user_dir_locations: "{{ matrix_synapse_workers_user_dir_endpoints|default([]) }}"
  1219. matrix_nginx_proxy_synapse_frontend_proxy_locations: "{{ matrix_synapse_workers_frontend_proxy_endpoints|default([]) }}"
  1220. matrix_nginx_proxy_systemd_wanted_services_list: |
  1221. {{
  1222. ['matrix-' + matrix_homeserver_implementation + '.service']
  1223. +
  1224. (['matrix-corporal.service'] if matrix_corporal_enabled else [])
  1225. +
  1226. (['matrix-ma1sd.service'] if matrix_ma1sd_enabled else [])
  1227. +
  1228. (['matrix-client-cinny.service'] if matrix_client_cinny_enabled else [])
  1229. +
  1230. (['matrix-bot-buscarron.service'] if matrix_bot_buscarron_enabled else [])
  1231. +
  1232. (['matrix-client-element.service'] if matrix_client_element_enabled else [])
  1233. +
  1234. (['matrix-client-hydrogen.service'] if matrix_client_hydrogen_enabled else [])
  1235. +
  1236. (['matrix-grafana.service'] if matrix_grafana_enabled else [])
  1237. +
  1238. (['matrix-dimension.service'] if matrix_dimension_enabled else [])
  1239. +
  1240. (['matrix-sygnal.service'] if matrix_sygnal_enabled else [])
  1241. +
  1242. (['matrix-ntfy.service'] if matrix_ntfy_enabled else [])
  1243. +
  1244. (['matrix-jitsi.service'] if matrix_jitsi_enabled else [])
  1245. +
  1246. (['matrix-bot-go-neb.service'] if matrix_bot_go_neb_enabled else [])
  1247. +
  1248. (['matrix-etherpad.service'] if matrix_etherpad_enabled and matrix_dimension_enabled else [])
  1249. +
  1250. (['matrix-hookshot.service'] if matrix_hookshot_enabled else [])
  1251. }}
  1252. matrix_ssl_domains_to_obtain_certificates_for: |
  1253. {{
  1254. ([matrix_server_fqn_matrix])
  1255. +
  1256. ([matrix_server_fqn_element] if matrix_client_element_enabled else [])
  1257. +
  1258. ([matrix_nginx_proxy_proxy_riot_compat_redirect_hostname] if matrix_nginx_proxy_proxy_riot_compat_redirect_enabled else [])
  1259. +
  1260. ([matrix_server_fqn_hydrogen] if matrix_client_hydrogen_enabled else [])
  1261. +
  1262. ([matrix_server_fqn_cinny] if matrix_client_cinny_enabled else [])
  1263. +
  1264. ([matrix_server_fqn_buscarron] if matrix_bot_buscarron_enabled else [])
  1265. +
  1266. ([matrix_server_fqn_dimension] if matrix_dimension_enabled else [])
  1267. +
  1268. ([matrix_server_fqn_bot_go_neb] if matrix_bot_go_neb_enabled else [])
  1269. +
  1270. ([matrix_server_fqn_jitsi] if matrix_jitsi_enabled else [])
  1271. +
  1272. ([matrix_server_fqn_grafana] if matrix_grafana_enabled else [])
  1273. +
  1274. ([matrix_server_fqn_sygnal] if matrix_sygnal_enabled else [])
  1275. +
  1276. ([matrix_server_fqn_ntfy] if matrix_ntfy_enabled else [])
  1277. +
  1278. ([matrix_domain] if matrix_nginx_proxy_base_domain_serving_enabled else [])
  1279. +
  1280. matrix_ssl_additional_domains_to_obtain_certificates_for
  1281. }}
  1282. matrix_ssl_architecture: "{{
  1283. {
  1284. 'amd64': 'amd64',
  1285. 'arm32': 'arm32v6',
  1286. 'arm64': 'arm64v8',
  1287. }[matrix_architecture]
  1288. }}"
  1289. matrix_ssl_pre_obtaining_required_service_name: "{{ 'matrix-dynamic-dns' if matrix_dynamic_dns_enabled else '' }}"
  1290. ######################################################################
  1291. #
  1292. # /matrix-nginx-proxy
  1293. #
  1294. ######################################################################
  1295. ######################################################################
  1296. #
  1297. # matrix-postgres
  1298. #
  1299. ######################################################################
  1300. matrix_postgres_enabled: true
  1301. matrix_postgres_architecture: "{{ matrix_architecture }}"
  1302. # We unset this if internal Postgres disabled, which will cascade to some other variables
  1303. # and tell users they need to set it (either here or in those variables).
  1304. matrix_postgres_connection_hostname: "{{ 'matrix-postgres' if matrix_postgres_enabled else '' }}"
  1305. matrix_postgres_pgloader_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1306. matrix_postgres_additional_databases: |
  1307. {{
  1308. ([{
  1309. 'name': matrix_synapse_database_database,
  1310. 'username': matrix_synapse_database_user,
  1311. 'password': matrix_synapse_database_password,
  1312. }] if (matrix_synapse_enabled and matrix_synapse_database_database != matrix_postgres_db_name and matrix_synapse_database_host == 'matrix-postgres') else [])
  1313. +
  1314. ([{
  1315. 'name': matrix_dendrite_appservice_database,
  1316. 'username': matrix_dendrite_database_user,
  1317. 'password': matrix_dendrite_database_password,
  1318. },{
  1319. 'name': matrix_dendrite_federationapi_database,
  1320. 'username': matrix_dendrite_database_user,
  1321. 'password': matrix_dendrite_database_password,
  1322. },{
  1323. 'name': matrix_dendrite_keyserver_database,
  1324. 'username': matrix_dendrite_database_user,
  1325. 'password': matrix_dendrite_database_password,
  1326. },{
  1327. 'name': matrix_dendrite_mediaapi_database,
  1328. 'username': matrix_dendrite_database_user,
  1329. 'password': matrix_dendrite_database_password,
  1330. },{
  1331. 'name': matrix_dendrite_room_database,
  1332. 'username': matrix_dendrite_database_user,
  1333. 'password': matrix_dendrite_database_password,
  1334. },{
  1335. 'name': matrix_dendrite_syncapi_database,
  1336. 'username': matrix_dendrite_database_user,
  1337. 'password': matrix_dendrite_database_password,
  1338. },{
  1339. 'name': matrix_dendrite_userapi_database,
  1340. 'username': matrix_dendrite_database_user,
  1341. 'password': matrix_dendrite_database_password,
  1342. },{
  1343. 'name': matrix_dendrite_pushserver_database,
  1344. 'username': matrix_dendrite_database_user,
  1345. 'password': matrix_dendrite_database_password,
  1346. },{
  1347. 'name': matrix_dendrite_mscs_database,
  1348. 'username': matrix_dendrite_database_user,
  1349. 'password': matrix_dendrite_database_password,
  1350. }] if (matrix_dendrite_enabled and matrix_dendrite_database_hostname == 'matrix-postgres') else [])
  1351. +
  1352. ([{
  1353. 'name': matrix_ma1sd_database_name,
  1354. 'username': matrix_ma1sd_database_username,
  1355. 'password': matrix_ma1sd_database_password,
  1356. }] if (matrix_ma1sd_enabled and matrix_ma1sd_database_engine == 'postgres' and matrix_ma1sd_database_hostname == 'matrix-postgres') else [])
  1357. +
  1358. ([{
  1359. 'name': matrix_bot_matrix_reminder_bot_database_name,
  1360. 'username': matrix_bot_matrix_reminder_bot_database_username,
  1361. 'password': matrix_bot_matrix_reminder_bot_database_password,
  1362. }] 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 [])
  1363. +
  1364. ([{
  1365. 'name': matrix_bot_honoroit_database_name,
  1366. 'username': matrix_bot_honoroit_database_username,
  1367. 'password': matrix_bot_honoroit_database_password,
  1368. }] if (matrix_bot_honoroit_enabled and matrix_bot_honoroit_database_engine == 'postgres' and matrix_bot_honoroit_database_hostname == 'matrix-postgres') else [])
  1369. +
  1370. ([{
  1371. 'name': matrix_bot_buscarron_database_name,
  1372. 'username': matrix_bot_buscarron_database_username,
  1373. 'password': matrix_bot_buscarron_database_password,
  1374. }] if (matrix_bot_buscarron_enabled and matrix_bot_buscarron_database_engine == 'postgres' and matrix_bot_buscarron_database_hostname == 'matrix-postgres') else [])
  1375. +
  1376. ([{
  1377. 'name': matrix_registration_database_name,
  1378. 'username': matrix_registration_database_username,
  1379. 'password': matrix_registration_database_password,
  1380. }] if (matrix_registration_enabled and matrix_registration_database_engine == 'postgres' and matrix_registration_database_hostname == 'matrix-postgres') else [])
  1381. +
  1382. ([{
  1383. 'name': matrix_appservice_discord_database_name,
  1384. 'username': matrix_appservice_discord_database_username,
  1385. 'password': matrix_appservice_discord_database_password,
  1386. }] if (matrix_appservice_discord_enabled and matrix_appservice_discord_database_engine == 'postgres' and matrix_appservice_discord_database_hostname == 'matrix-postgres') else [])
  1387. +
  1388. ([{
  1389. 'name': matrix_appservice_slack_database_name,
  1390. 'username': matrix_appservice_slack_database_username,
  1391. 'password': matrix_appservice_slack_database_password,
  1392. }] if (matrix_appservice_slack_enabled and matrix_appservice_slack_database_engine == 'postgres' and matrix_appservice_slack_database_hostname == 'matrix-postgres') else [])
  1393. +
  1394. ([{
  1395. 'name': matrix_appservice_irc_database_name,
  1396. 'username': matrix_appservice_irc_database_username,
  1397. 'password': matrix_appservice_irc_database_password,
  1398. }] if (matrix_appservice_irc_enabled and matrix_appservice_irc_database_engine == 'postgres' and matrix_appservice_irc_database_hostname == 'matrix-postgres') else [])
  1399. +
  1400. ([{
  1401. 'name': matrix_beeper_linkedin_database_name,
  1402. 'username': matrix_beeper_linkedin_database_username,
  1403. 'password': matrix_beeper_linkedin_database_password,
  1404. }] if (matrix_beeper_linkedin_enabled and matrix_beeper_linkedin_database_engine == 'postgres' and matrix_beeper_linkedin_database_hostname == 'matrix-postgres') else [])
  1405. +
  1406. ([{
  1407. 'name': matrix_go_skype_bridge_database_name,
  1408. 'username': matrix_go_skype_bridge_database_username,
  1409. 'password': matrix_go_skype_bridge_database_password,
  1410. }] if (matrix_go_skype_bridge_enabled and matrix_go_skype_bridge_database_engine == 'postgres' and matrix_go_skype_bridge_database_hostname == 'matrix-postgres') else [])
  1411. +
  1412. ([{
  1413. 'name': matrix_mautrix_facebook_database_name,
  1414. 'username': matrix_mautrix_facebook_database_username,
  1415. 'password': matrix_mautrix_facebook_database_password,
  1416. }] if (matrix_mautrix_facebook_enabled and matrix_mautrix_facebook_database_engine == 'postgres' and matrix_mautrix_facebook_database_hostname == 'matrix-postgres') else [])
  1417. +
  1418. ([{
  1419. 'name': matrix_mautrix_hangouts_database_name,
  1420. 'username': matrix_mautrix_hangouts_database_username,
  1421. 'password': matrix_mautrix_hangouts_database_password,
  1422. }] if (matrix_mautrix_hangouts_enabled and matrix_mautrix_hangouts_database_engine == 'postgres' and matrix_mautrix_hangouts_database_hostname == 'matrix-postgres') else [])
  1423. +
  1424. ([{
  1425. 'name': matrix_mautrix_googlechat_database_name,
  1426. 'username': matrix_mautrix_googlechat_database_username,
  1427. 'password': matrix_mautrix_googlechat_database_password,
  1428. }] if (matrix_mautrix_googlechat_enabled and matrix_mautrix_googlechat_database_engine == 'postgres' and matrix_mautrix_googlechat_database_hostname == 'matrix-postgres') else [])
  1429. +
  1430. ([{
  1431. 'name': matrix_mautrix_instagram_database_name,
  1432. 'username': matrix_mautrix_instagram_database_username,
  1433. 'password': matrix_mautrix_instagram_database_password,
  1434. }] if (matrix_mautrix_instagram_enabled and matrix_mautrix_instagram_database_engine == 'postgres' and matrix_mautrix_instagram_database_hostname == 'matrix-postgres') else [])
  1435. +
  1436. ([{
  1437. 'name': matrix_mautrix_signal_database_name,
  1438. 'username': matrix_mautrix_signal_database_username,
  1439. 'password': matrix_mautrix_signal_database_password,
  1440. }] if (matrix_mautrix_signal_enabled and matrix_mautrix_signal_database_engine == 'postgres' and matrix_mautrix_signal_database_hostname == 'matrix-postgres') else [])
  1441. +
  1442. ([{
  1443. 'name': matrix_mautrix_telegram_database_name,
  1444. 'username': matrix_mautrix_telegram_database_username,
  1445. 'password': matrix_mautrix_telegram_database_password,
  1446. }] if (matrix_mautrix_telegram_enabled and matrix_mautrix_telegram_database_engine == 'postgres' and matrix_mautrix_telegram_database_hostname == 'matrix-postgres') else [])
  1447. +
  1448. ([{
  1449. 'name': matrix_mautrix_twitter_database_name,
  1450. 'username': matrix_mautrix_twitter_database_username,
  1451. 'password': matrix_mautrix_twitter_database_password,
  1452. }] if (matrix_mautrix_twitter_enabled and matrix_mautrix_twitter_database_engine == 'postgres' and matrix_mautrix_twitter_database_hostname == 'matrix-postgres') else [])
  1453. +
  1454. ([{
  1455. 'name': matrix_mautrix_whatsapp_database_name,
  1456. 'username': matrix_mautrix_whatsapp_database_username,
  1457. 'password': matrix_mautrix_whatsapp_database_password,
  1458. }] if (matrix_mautrix_whatsapp_enabled and matrix_mautrix_whatsapp_database_engine == 'postgres' and matrix_mautrix_whatsapp_database_hostname == 'matrix-postgres') else [])
  1459. +
  1460. ([{
  1461. 'name': matrix_mx_puppet_slack_database_name,
  1462. 'username': matrix_mx_puppet_slack_database_username,
  1463. 'password': matrix_mx_puppet_slack_database_password,
  1464. }] if (matrix_mx_puppet_slack_enabled and matrix_mx_puppet_slack_database_engine == 'postgres' and matrix_mx_puppet_slack_database_hostname == 'matrix-postgres') else [])
  1465. +
  1466. ([{
  1467. 'name': matrix_mx_puppet_twitter_database_name,
  1468. 'username': matrix_mx_puppet_twitter_database_username,
  1469. 'password': matrix_mx_puppet_twitter_database_password,
  1470. }] if (matrix_mx_puppet_twitter_enabled and matrix_mx_puppet_twitter_database_engine == 'postgres' and matrix_mx_puppet_twitter_database_hostname == 'matrix-postgres') else [])
  1471. +
  1472. ([{
  1473. 'name': matrix_mx_puppet_instagram_database_name,
  1474. 'username': matrix_mx_puppet_instagram_database_username,
  1475. 'password': matrix_mx_puppet_instagram_database_password,
  1476. }] if (matrix_mx_puppet_instagram_enabled and matrix_mx_puppet_instagram_database_engine == 'postgres' and matrix_mx_puppet_instagram_database_hostname == 'matrix-postgres') else [])
  1477. +
  1478. ([{
  1479. 'name': matrix_mx_puppet_discord_database_name,
  1480. 'username': matrix_mx_puppet_discord_database_username,
  1481. 'password': matrix_mx_puppet_discord_database_password,
  1482. }] if (matrix_mx_puppet_discord_enabled and matrix_mx_puppet_discord_database_engine == 'postgres' and matrix_mx_puppet_discord_database_hostname == 'matrix-postgres') else [])
  1483. +
  1484. ([{
  1485. 'name': matrix_mx_puppet_steam_database_name,
  1486. 'username': matrix_mx_puppet_steam_database_username,
  1487. 'password': matrix_mx_puppet_steam_database_password,
  1488. }] if (matrix_mx_puppet_steam_enabled and matrix_mx_puppet_steam_database_engine == 'postgres' and matrix_mx_puppet_steam_database_hostname == 'matrix-postgres') else [])
  1489. +
  1490. ([{
  1491. 'name': matrix_mx_puppet_groupme_database_name,
  1492. 'username': matrix_mx_puppet_groupme_database_username,
  1493. 'password': matrix_mx_puppet_groupme_database_password,
  1494. }] if (matrix_mx_puppet_groupme_enabled and matrix_mx_puppet_groupme_database_engine == 'postgres' and matrix_mx_puppet_groupme_database_hostname == 'matrix-postgres') else [])
  1495. +
  1496. ([{
  1497. 'name': matrix_dimension_database_name,
  1498. 'username': matrix_dimension_database_username,
  1499. 'password': matrix_dimension_database_password,
  1500. }] if (matrix_dimension_enabled and matrix_dimension_database_engine == 'postgres' and matrix_dimension_database_hostname == 'matrix-postgres') else [])
  1501. +
  1502. ([{
  1503. 'name': matrix_etherpad_database_name,
  1504. 'username': matrix_etherpad_database_username,
  1505. 'password': matrix_etherpad_database_password,
  1506. }] if (matrix_etherpad_enabled and matrix_etherpad_database_engine == 'postgres' and matrix_etherpad_database_hostname == 'matrix-postgres') else [])
  1507. +
  1508. ([{
  1509. 'name': matrix_prometheus_postgres_exporter_database_name,
  1510. 'username': matrix_prometheus_postgres_exporter_database_username,
  1511. 'password': matrix_prometheus_postgres_exporter_database_password,
  1512. }] if (matrix_prometheus_postgres_exporter_enabled and matrix_prometheus_postgres_exporter_database_hostname == 'matrix-postgres') else [])
  1513. }}
  1514. matrix_postgres_import_roles_to_ignore: |
  1515. {{
  1516. [matrix_postgres_connection_username]
  1517. +
  1518. matrix_postgres_additional_databases|map(attribute='username') | list
  1519. }}
  1520. matrix_postgres_import_databases_to_ignore: |
  1521. {{
  1522. [matrix_postgres_db_name]
  1523. +
  1524. matrix_postgres_additional_databases|map(attribute='name') | list
  1525. }}
  1526. ######################################################################
  1527. #
  1528. # /matrix-postgres
  1529. #
  1530. ######################################################################
  1531. ######################################################################
  1532. #
  1533. # matrix-sygnal
  1534. #
  1535. ######################################################################
  1536. # Most people don't need their own push-server, because they also need their own app to utilize it from.
  1537. matrix_sygnal_enabled: false
  1538. # If someone instals Prometheus via the playbook, they most likely wish to monitor Sygnal.
  1539. matrix_sygnal_metrics_prometheus_enabled: "{{ matrix_prometheus_enabled }}"
  1540. matrix_sygnal_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:6000' }}"
  1541. ######################################################################
  1542. #
  1543. # /matrix-sygnal
  1544. #
  1545. ######################################################################
  1546. ######################################################################
  1547. #
  1548. # matrix-ntfy
  1549. #
  1550. ######################################################################
  1551. matrix_ntfy_enabled: false
  1552. matrix_ntfy_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:2586' }}"
  1553. ######################################################################
  1554. #
  1555. # /matrix-ntfy
  1556. #
  1557. ######################################################################
  1558. ######################################################################
  1559. #
  1560. # matrix-redis
  1561. #
  1562. ######################################################################
  1563. matrix_redis_enabled: "{{ matrix_synapse_workers_enabled }}"
  1564. ######################################################################
  1565. #
  1566. # /matrix-redis
  1567. #
  1568. ######################################################################
  1569. ######################################################################
  1570. #
  1571. # matrix-client-element
  1572. #
  1573. ######################################################################
  1574. # By default, this playbook installs the Element web UI on the `matrix_server_fqn_element` domain.
  1575. # If you wish to connect to your Matrix server by other means, you may wish to disable this.
  1576. matrix_client_element_enabled: true
  1577. matrix_client_element_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1578. # Normally, matrix-nginx-proxy is enabled and nginx can reach Element over the container network.
  1579. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1580. # the Element HTTP port to the local host.
  1581. matrix_client_element_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8765' }}"
  1582. matrix_client_element_default_hs_url: "{{ matrix_homeserver_url }}"
  1583. matrix_client_element_default_is_url: "{{ matrix_identity_server_url }}"
  1584. # Use Dimension if enabled, otherwise fall back to Scalar
  1585. matrix_client_element_integrations_ui_url: "{{ matrix_dimension_integrations_ui_url if matrix_dimension_enabled else 'https://scalar.vector.im/' }}"
  1586. matrix_client_element_integrations_rest_url: "{{ matrix_dimension_integrations_rest_url if matrix_dimension_enabled else 'https://scalar.vector.im/api' }}"
  1587. matrix_client_element_integrations_widgets_urls: "{{ matrix_dimension_integrations_widgets_urls if matrix_dimension_enabled else ['https://scalar.vector.im/api'] }}"
  1588. 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' }}"
  1589. matrix_client_element_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1590. matrix_client_element_registration_enabled: "{{ matrix_synapse_enable_registration }}"
  1591. matrix_client_element_enable_presence_by_hs_url: |
  1592. {{
  1593. none
  1594. if matrix_synapse_presence_enabled
  1595. else {matrix_client_element_default_hs_url: false}
  1596. }}
  1597. matrix_client_element_welcome_user_id: ~
  1598. matrix_client_element_jitsi_preferredDomain: "{{ matrix_server_fqn_jitsi if matrix_jitsi_enabled else '' }}"
  1599. ######################################################################
  1600. #
  1601. # /matrix-client-element
  1602. #
  1603. ######################################################################
  1604. ######################################################################
  1605. #
  1606. # matrix-client-hydrogen
  1607. #
  1608. ######################################################################
  1609. matrix_client_hydrogen_enabled: false
  1610. # Normally, matrix-nginx-proxy is enabled and nginx can reach Hydrogen over the container network.
  1611. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1612. # the HTTP port to the local host.
  1613. matrix_client_hydrogen_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8768' }}"
  1614. matrix_client_hydrogen_default_hs_url: "{{ matrix_homeserver_url }}"
  1615. matrix_client_hydrogen_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1616. ######################################################################
  1617. #
  1618. # /matrix-client-hydrogen
  1619. #
  1620. ######################################################################
  1621. ######################################################################
  1622. #
  1623. # matrix-client-cinny
  1624. #
  1625. ######################################################################
  1626. matrix_client_cinny_enabled: false
  1627. matrix_client_cinny_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1628. # Normally, matrix-nginx-proxy is enabled and nginx can reach Cinny over the container network.
  1629. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1630. # the HTTP port to the local host.
  1631. matrix_client_cinny_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8080' }}"
  1632. matrix_client_cinny_default_hs_url: "{{ matrix_homeserver_url }}"
  1633. matrix_client_cinny_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1634. ######################################################################
  1635. #
  1636. # /matrix-client-cinny
  1637. #
  1638. ######################################################################
  1639. ######################################################################
  1640. #
  1641. # matrix-synapse
  1642. #
  1643. ######################################################################
  1644. matrix_synapse_enabled: "{{ matrix_homeserver_implementation == 'synapse' }}"
  1645. matrix_synapse_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  1646. # When ma1sd is enabled, we can use it to validate email addresses and phone numbers.
  1647. # Synapse can validate email addresses by itself as well, but it's probably not what we want by default when we have an identity server.
  1648. matrix_synapse_account_threepid_delegates_email: "{{ 'http://matrix-ma1sd:' + matrix_ma1sd_container_port | string if matrix_ma1sd_enabled else '' }}"
  1649. matrix_synapse_account_threepid_delegates_msisdn: "{{ 'http://matrix-ma1sd:' + matrix_ma1sd_container_port | string if matrix_ma1sd_enabled else '' }}"
  1650. # Normally, matrix-nginx-proxy is enabled and nginx can reach Synapse over the container network.
  1651. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it,
  1652. # you can expose Synapse's ports to the host.
  1653. #
  1654. # For exposing the Matrix Client API's port (plain HTTP) to the local host.
  1655. matrix_synapse_container_client_api_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:' + matrix_synapse_container_client_api_port | string }}"
  1656. #
  1657. # For exposing the Matrix Federation API's plain port (plain HTTP) to the local host.
  1658. matrix_synapse_container_federation_api_plain_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:' + matrix_synapse_container_federation_api_plain_port | string }}"
  1659. #
  1660. # For exposing the Matrix Federation API's TLS port (HTTPS) to the internet on all network interfaces.
  1661. 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 '' }}"
  1662. #
  1663. # For exposing the Synapse Metrics API's port (plain HTTP) to the local host.
  1664. 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 '' }}"
  1665. #
  1666. # For exposing the Synapse Manhole port (plain HTTP) to the local host.
  1667. matrix_synapse_container_manhole_api_host_bind_port: "{{ '127.0.0.1:9000' if matrix_synapse_manhole_enabled else '' }}"
  1668. #
  1669. # For exposing the Synapse worker (and metrics) ports to the local host.
  1670. matrix_synapse_workers_container_host_bind_address: "{{ '127.0.0.1' if (matrix_synapse_workers_enabled and not matrix_nginx_proxy_enabled) else '' }}"
  1671. matrix_synapse_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'synapse.db') | to_uuid }}"
  1672. matrix_synapse_macaroon_secret_key: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'synapse.mac') | to_uuid }}"
  1673. # We do not enable TLS in Synapse by default.
  1674. # TLS is handled by the matrix-nginx-proxy, which proxies the requests to Synapse.
  1675. matrix_synapse_tls_federation_listener_enabled: false
  1676. matrix_synapse_tls_certificate_path: ~
  1677. matrix_synapse_tls_private_key_path: ~
  1678. matrix_synapse_federation_port_openid_resource_required: "{{ not matrix_synapse_federation_enabled and (matrix_dimension_enabled or matrix_ma1sd_enabled) }}"
  1679. # If someone instals Prometheus via the playbook, they most likely wish to monitor Synapse.
  1680. matrix_synapse_metrics_enabled: "{{ matrix_prometheus_enabled }}"
  1681. matrix_synapse_email_enabled: "{{ matrix_mailer_enabled }}"
  1682. matrix_synapse_email_smtp_host: "matrix-mailer"
  1683. matrix_synapse_email_smtp_port: 8025
  1684. matrix_synapse_email_smtp_require_transport_security: false
  1685. matrix_synapse_email_notif_from: "Matrix <{{ matrix_mailer_sender_address }}>"
  1686. # Even if TURN doesn't support TLS (it does by default),
  1687. # it doesn't hurt to try a secure connection anyway.
  1688. #
  1689. # When Let's Encrypt certificates are used (the default case),
  1690. # we don't enable `turns` endpoints, because WebRTC in Element can't talk to them.
  1691. # Learn more here: https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1145
  1692. matrix_synapse_turn_uris: |
  1693. {{
  1694. []
  1695. +
  1696. [
  1697. 'turns:' + matrix_server_fqn_matrix + '?transport=udp',
  1698. 'turns:' + matrix_server_fqn_matrix + '?transport=tcp',
  1699. ] if matrix_coturn_enabled and matrix_coturn_tls_enabled and matrix_ssl_retrieval_method != 'lets-encrypt' else []
  1700. +
  1701. [
  1702. 'turn:' + matrix_server_fqn_matrix + '?transport=udp',
  1703. 'turn:' + matrix_server_fqn_matrix + '?transport=tcp',
  1704. ] if matrix_coturn_enabled else []
  1705. }}
  1706. matrix_synapse_turn_shared_secret: "{{ matrix_coturn_turn_static_auth_secret if matrix_coturn_enabled else '' }}"
  1707. matrix_synapse_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1708. matrix_synapse_systemd_required_services_list: |
  1709. {{
  1710. (['docker.service'])
  1711. +
  1712. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1713. +
  1714. (['matrix-goofys'] if matrix_s3_media_store_enabled else [])
  1715. }}
  1716. matrix_synapse_systemd_wanted_services_list: |
  1717. {{
  1718. (['matrix-coturn.service'] if matrix_coturn_enabled else [])
  1719. +
  1720. (['matrix-mailer.service'] if matrix_mailer_enabled else [])
  1721. }}
  1722. # Synapse workers (used for parallel load-scaling) need Redis for IPC.
  1723. matrix_synapse_redis_enabled: "{{ matrix_redis_enabled }}"
  1724. matrix_synapse_redis_host: "{{ 'matrix-redis' if matrix_redis_enabled else '' }}"
  1725. matrix_synapse_redis_password: "{{ matrix_redis_connection_password if matrix_redis_enabled else '' }}"
  1726. ######################################################################
  1727. #
  1728. # /matrix-synapse
  1729. #
  1730. ######################################################################
  1731. ######################################################################
  1732. #
  1733. # matrix-synapse-admin
  1734. #
  1735. ######################################################################
  1736. matrix_synapse_admin_enabled: false
  1737. # Normally, matrix-nginx-proxy is enabled and nginx can reach Synapse Admin over the container network.
  1738. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1739. # Synapse Admin's HTTP port to the local host.
  1740. matrix_synapse_admin_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8766' }}"
  1741. matrix_synapse_admin_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  1742. ######################################################################
  1743. #
  1744. # /matrix-synapse-admin
  1745. #
  1746. ######################################################################
  1747. ######################################################################
  1748. #
  1749. # matrix-prometheus-node-exporter
  1750. #
  1751. ######################################################################
  1752. matrix_prometheus_node_exporter_enabled: false
  1753. ######################################################################
  1754. #
  1755. # /matrix-prometheus-node-exporter
  1756. #
  1757. ######################################################################
  1758. ######################################################################
  1759. #
  1760. # matrix-prometheus
  1761. #
  1762. ######################################################################
  1763. matrix_prometheus_enabled: false
  1764. # Normally, matrix-nginx-proxy is enabled and nginx can reach Prometheus over the container network.
  1765. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1766. # Prometheus' HTTP port to the local host.
  1767. matrix_prometheus_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9090' }}"
  1768. matrix_prometheus_scraper_synapse_enabled: "{{ matrix_synapse_enabled and matrix_synapse_metrics_enabled }}"
  1769. matrix_prometheus_scraper_synapse_targets: ['matrix-synapse:{{ matrix_synapse_metrics_port }}']
  1770. matrix_prometheus_scraper_synapse_workers_enabled_list: "{{ matrix_synapse_workers_enabled_list }}"
  1771. matrix_prometheus_scraper_synapse_rules_synapse_tag: "{{ matrix_synapse_docker_image_tag }}"
  1772. matrix_prometheus_scraper_node_enabled: "{{ matrix_prometheus_node_exporter_enabled }}"
  1773. matrix_prometheus_scraper_node_targets: "{{ ['matrix-prometheus-node-exporter:9100'] if matrix_prometheus_node_exporter_enabled else [] }}"
  1774. matrix_prometheus_scraper_postgres_enabled: "{{ matrix_prometheus_postgres_exporter_enabled }}"
  1775. matrix_prometheus_scraper_postgres_targets: "{{ ['matrix-prometheus-postgres-exporter:'+ matrix_prometheus_postgres_exporter_port | string] if matrix_prometheus_scraper_postgres_enabled else [] }}"
  1776. matrix_prometheus_scraper_hookshot_enabled: "{{ matrix_hookshot_metrics_enabled|default(false) }}"
  1777. matrix_prometheus_scraper_hookshot_targets: "{{ [matrix_hookshot_container_url | string +':'+ matrix_hookshot_metrics_port | string] if matrix_hookshot_metrics_enabled else [] }}"
  1778. ######################################################################
  1779. #
  1780. # /matrix-prometheus
  1781. #
  1782. ######################################################################
  1783. ######################################################################
  1784. #
  1785. # matrix-prometheus-postgres-exporter
  1786. #
  1787. ######################################################################
  1788. matrix_prometheus_postgres_exporter_enabled: false
  1789. matrix_prometheus_postgres_exporter_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'prometheus.pg.db') | to_uuid }}"
  1790. matrix_prometheus_postgres_exporter_systemd_required_services_list: |
  1791. {{
  1792. ['docker.service']
  1793. +
  1794. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1795. }}
  1796. ######################################################################
  1797. #
  1798. # /matrix-prometheus-postgres-exporter
  1799. #
  1800. ######################################################################
  1801. ######################################################################
  1802. #
  1803. # matrix-grafana
  1804. #
  1805. ######################################################################
  1806. matrix_grafana_enabled: false
  1807. # Normally, matrix-nginx-proxy is enabled and nginx can reach Grafana over the container network.
  1808. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1809. # Grafana's HTTP port to the local host.
  1810. matrix_grafana_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:3000' }}"
  1811. matrix_grafana_dashboard_download_urls_all: |
  1812. {{
  1813. matrix_grafana_dashboard_download_urls
  1814. +
  1815. (matrix_prometheus_postgres_exporter_dashboard_urls if matrix_prometheus_postgres_exporter_enabled else [])
  1816. }}
  1817. matrix_grafana_systemd_wanted_services_list: |
  1818. {{
  1819. []
  1820. +
  1821. (['matrix-prometheus-postgres-exporter.service'] if matrix_prometheus_postgres_exporter_enabled else [])
  1822. }}
  1823. ######################################################################
  1824. #
  1825. # /matrix-grafana
  1826. #
  1827. ######################################################################
  1828. ######################################################################
  1829. #
  1830. # matrix-registration
  1831. #
  1832. ######################################################################
  1833. matrix_registration_enabled: false
  1834. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-registration over the container network.
  1835. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1836. # matrix-registration's HTTP port to the local host.
  1837. matrix_registration_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8767' }}"
  1838. matrix_registration_riot_instance: "{{ ('https://' + matrix_server_fqn_element) if matrix_client_element_enabled else 'https://riot.im/app/' }}"
  1839. matrix_registration_shared_secret: |-
  1840. {{
  1841. {
  1842. 'synapse': matrix_synapse_registration_shared_secret,
  1843. 'dendrite': matrix_dendrite_registration_shared_secret,
  1844. }[matrix_homeserver_implementation]
  1845. }}
  1846. matrix_registration_server_location: "{{ matrix_homeserver_container_url }}"
  1847. matrix_registration_api_validate_certs: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1848. matrix_registration_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1849. matrix_registration_systemd_required_services_list: |
  1850. {{
  1851. ['docker.service']
  1852. +
  1853. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1854. }}
  1855. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  1856. matrix_registration_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  1857. matrix_registration_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mx.registr.db') | to_uuid }}"
  1858. ######################################################################
  1859. #
  1860. # /matrix-registration
  1861. #
  1862. ######################################################################
  1863. ######################################################################
  1864. #
  1865. # matrix-postgres-backup
  1866. #
  1867. ######################################################################
  1868. matrix_postgres_backup_connection_hostname: "{{ matrix_postgres_connection_hostname }}"
  1869. matrix_postgres_backup_connection_port: "{{ matrix_postgres_connection_port }}"
  1870. matrix_postgres_backup_connection_username: "{{ matrix_postgres_connection_username }}"
  1871. matrix_postgres_backup_connection_password: "{{ matrix_postgres_connection_password }}"
  1872. matrix_postgres_backup_postgres_data_path: "{{ matrix_postgres_data_path if matrix_postgres_enabled else '' }}"
  1873. # 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
  1874. matrix_postgres_backup_databases: |
  1875. {{
  1876. (([{
  1877. 'name': matrix_synapse_database_database
  1878. }] if (matrix_synapse_enabled and matrix_synapse_database_database == matrix_postgres_db_name and matrix_synapse_database_host == 'matrix-postgres') else [])
  1879. +
  1880. matrix_postgres_additional_databases)|map(attribute='name') | list
  1881. }}
  1882. ######################################################################
  1883. #
  1884. # /matrix-postgres-backup
  1885. #
  1886. ######################################################################
  1887. ######################################################################
  1888. #
  1889. # matrix-dendrite
  1890. #
  1891. ######################################################################
  1892. matrix_dendrite_enabled: "{{ matrix_homeserver_implementation == 'dendrite' }}"
  1893. # Normally, matrix-nginx-proxy is enabled and nginx can reach Dendrite over the container network.
  1894. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it,
  1895. # you can expose Dendrite's ports to the host.
  1896. #
  1897. # For exposing Dendrite's plain HTTP server to the local host.
  1898. matrix_dendrite_container_http_host_bind_address: "{{ '' if matrix_nginx_proxy_enabled else ('127.0.0.1:' + matrix_dendrite_http_bind_port | string) }}"
  1899. #
  1900. # For exposing Dendrite's HTTPS server to the local host.
  1901. 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) }}"
  1902. matrix_dendrite_sync_api_real_ip_header: "{{ 'X-Forwarded-For' if matrix_nginx_proxy_enabled else '' }}"
  1903. matrix_dendrite_registration_shared_secret: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'dendrite.rss') | to_uuid }}"
  1904. matrix_dendrite_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'dendrite.db') | to_uuid }}"
  1905. # Even if TURN doesn't support TLS (it does by default),
  1906. # it doesn't hurt to try a secure connection anyway.
  1907. matrix_dendrite_turn_uris: |
  1908. {{
  1909. [
  1910. 'turns:' + matrix_server_fqn_matrix + '?transport=udp',
  1911. 'turns:' + matrix_server_fqn_matrix + '?transport=tcp',
  1912. 'turn:' + matrix_server_fqn_matrix + '?transport=udp',
  1913. 'turn:' + matrix_server_fqn_matrix + '?transport=tcp',
  1914. ]
  1915. if matrix_coturn_enabled
  1916. else []
  1917. }}
  1918. matrix_dendrite_turn_shared_secret: "{{ matrix_coturn_turn_static_auth_secret if matrix_coturn_enabled else '' }}"
  1919. matrix_dendrite_disable_tls_validation: "{{ true if matrix_ssl_retrieval_method == 'self-signed' else false }}"
  1920. matrix_dendrite_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1921. matrix_dendrite_trusted_id_servers: "{{ [matrix_server_fqn_matrix] if matrix_ma1sd_enabled else ['matrix.org', 'vector.im'] }}"
  1922. matrix_dendrite_systemd_required_services_list: |
  1923. {{
  1924. (['docker.service'])
  1925. +
  1926. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1927. +
  1928. (['matrix-goofys'] if matrix_s3_media_store_enabled else [])
  1929. }}
  1930. matrix_dendrite_systemd_wanted_services_list: |
  1931. {{
  1932. (['matrix-coturn.service'] if matrix_coturn_enabled else [])
  1933. }}
  1934. ######################################################################
  1935. #
  1936. # /matrix-dendrite
  1937. #
  1938. ######################################################################