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

2311 wiersze
102 KiB

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