Matrix Docker Ansible eploy
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

2301 lines
100 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. # We'd like to force-set people with external Postgres to SQLite, so the bridge role can complain
  422. # and point them to a migration path.
  423. matrix_mautrix_twitter_database_engine: "{{ 'postgres' if matrix_postgres_enabled else '' }}"
  424. matrix_mautrix_twitter_database_password: "{{ matrix_homeserver_generic_secret_key | password_hash('sha512', 'mau.twt.db') | to_uuid }}"
  425. ######################################################################
  426. #
  427. # /matrix-bridge-mautrix-twitter
  428. #
  429. ######################################################################
  430. ######################################################################
  431. #
  432. # matrix-bridge-mautrix-whatsapp
  433. #
  434. ######################################################################
  435. # We don't enable bridges by default.
  436. matrix_mautrix_whatsapp_enabled: false
  437. matrix_mautrix_whatsapp_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  438. matrix_mautrix_whatsapp_systemd_required_services_list: |
  439. {{
  440. ['docker.service']
  441. +
  442. ['matrix-' + matrix_homeserver_implementation + '.service']
  443. +
  444. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  445. +
  446. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  447. }}
  448. matrix_mautrix_whatsapp_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'whats.as.token') | to_uuid }}"
  449. matrix_mautrix_whatsapp_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'whats.hs.token') | to_uuid }}"
  450. 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 '' }}"
  451. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  452. matrix_mautrix_whatsapp_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  453. matrix_mautrix_whatsapp_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mauwhatsapp.db') | to_uuid }}"
  454. ######################################################################
  455. #
  456. # /matrix-bridge-mautrix-whatsapp
  457. #
  458. ######################################################################
  459. ######################################################################
  460. #
  461. # matrix-sms-bridge
  462. #
  463. ######################################################################
  464. # We don't enable bridges by default.
  465. matrix_sms_bridge_enabled: false
  466. matrix_sms_bridge_systemd_required_services_list: |
  467. {{
  468. ['docker.service']
  469. +
  470. ['matrix-' + matrix_homeserver_implementation + '.service']
  471. +
  472. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  473. }}
  474. matrix_sms_bridge_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'sms.as.token') | to_uuid }}"
  475. matrix_sms_bridge_homeserver_port: "{{ matrix_synapse_container_client_api_port }}"
  476. matrix_sms_bridge_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'sms.hs.token') | to_uuid }}"
  477. ######################################################################
  478. #
  479. # /matrix-sms-bridge
  480. #
  481. ######################################################################
  482. ######################################################################
  483. #
  484. # matrix-bridge-heisenbridge
  485. #
  486. ######################################################################
  487. # We don't enable bridges by default.
  488. matrix_heisenbridge_enabled: false
  489. matrix_heisenbridge_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'heisen.as.tok') | to_uuid }}"
  490. matrix_heisenbridge_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'heisen.hs.tok') | to_uuid }}"
  491. matrix_heisenbridge_systemd_wanted_services_list: |
  492. {{
  493. ['matrix-' + matrix_homeserver_implementation + '.service']
  494. +
  495. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  496. }}
  497. ######################################################################
  498. #
  499. # /matrix-bridge-heisenbridge
  500. #
  501. ######################################################################
  502. ######################################################################
  503. #
  504. # matrix-bridge-mx-puppet-skype
  505. #
  506. ######################################################################
  507. # We don't enable bridges by default.
  508. matrix_mx_puppet_skype_enabled: false
  509. matrix_mx_puppet_skype_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  510. matrix_mx_puppet_skype_systemd_required_services_list: |
  511. {{
  512. ['docker.service']
  513. +
  514. ['matrix-' + matrix_homeserver_implementation + '.service']
  515. +
  516. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  517. +
  518. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  519. }}
  520. matrix_mx_puppet_skype_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'skype.as.tok') | to_uuid }}"
  521. matrix_mx_puppet_skype_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'skype.hs.tok') | to_uuid }}"
  522. 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 '' }}"
  523. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  524. matrix_mx_puppet_skype_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  525. matrix_mx_puppet_skype_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.skype.db') | to_uuid }}"
  526. ######################################################################
  527. #
  528. # /matrix-bridge-mx-puppet-skype
  529. #
  530. ######################################################################
  531. ######################################################################
  532. #
  533. # matrix-bridge-mx-puppet-slack
  534. #
  535. ######################################################################
  536. # We don't enable bridges by default.
  537. matrix_mx_puppet_slack_enabled: false
  538. matrix_mx_puppet_slack_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  539. matrix_mx_puppet_slack_systemd_required_services_list: |
  540. {{
  541. ['docker.service']
  542. +
  543. ['matrix-' + matrix_homeserver_implementation + '.service']
  544. +
  545. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  546. +
  547. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  548. }}
  549. matrix_mx_puppet_slack_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxslk.as.tok') | to_uuid }}"
  550. matrix_mx_puppet_slack_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxslk.hs.tok') | to_uuid }}"
  551. 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 '' }}"
  552. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  553. matrix_mx_puppet_slack_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  554. matrix_mx_puppet_slack_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.slack.db') | to_uuid }}"
  555. ######################################################################
  556. #
  557. # /matrix-bridge-mx-puppet-slack
  558. #
  559. ######################################################################
  560. ######################################################################
  561. #
  562. # matrix-bridge-mx-puppet-twitter
  563. #
  564. ######################################################################
  565. # We don't enable bridges by default.
  566. matrix_mx_puppet_twitter_enabled: false
  567. matrix_mx_puppet_twitter_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  568. matrix_mx_puppet_twitter_systemd_required_services_list: |
  569. {{
  570. ['docker.service']
  571. +
  572. ['matrix-' + matrix_homeserver_implementation + '.service']
  573. +
  574. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  575. +
  576. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  577. }}
  578. matrix_mx_puppet_twitter_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxtwt.as.tok') | to_uuid }}"
  579. matrix_mx_puppet_twitter_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxtwt.hs.tok') | to_uuid }}"
  580. 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 '' }}"
  581. 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) }}"
  582. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  583. matrix_mx_puppet_twitter_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  584. matrix_mx_puppet_twitter_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.twitter.db') | to_uuid }}"
  585. ######################################################################
  586. #
  587. # /matrix-bridge-mx-puppet-twitter
  588. #
  589. ######################################################################
  590. ######################################################################
  591. #
  592. # matrix-bridge-mx-puppet-instagram
  593. #
  594. ######################################################################
  595. # We don't enable bridges by default.
  596. matrix_mx_puppet_instagram_enabled: false
  597. matrix_mx_puppet_instagram_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  598. matrix_mx_puppet_instagram_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_instagram_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxig.as.tok') | to_uuid }}"
  609. matrix_mx_puppet_instagram_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxig.hs.tok') | to_uuid }}"
  610. 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 '' }}"
  611. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  612. matrix_mx_puppet_instagram_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  613. matrix_mx_puppet_instagram_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.ig.db') | to_uuid }}"
  614. ######################################################################
  615. #
  616. # /matrix-bridge-mx-puppet-instagram
  617. #
  618. ######################################################################
  619. ######################################################################
  620. #
  621. # matrix-bridge-mx-puppet-discord
  622. #
  623. ######################################################################
  624. # We don't enable bridges by default.
  625. matrix_mx_puppet_discord_enabled: false
  626. matrix_mx_puppet_discord_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  627. matrix_mx_puppet_discord_systemd_required_services_list: |
  628. {{
  629. ['docker.service']
  630. +
  631. ['matrix-' + matrix_homeserver_implementation + '.service']
  632. +
  633. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  634. +
  635. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  636. }}
  637. matrix_mx_puppet_discord_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxdsc.as.tok') | to_uuid }}"
  638. matrix_mx_puppet_discord_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxdsc.hs.tok') | to_uuid }}"
  639. 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 '' }}"
  640. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  641. matrix_mx_puppet_discord_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  642. matrix_mx_puppet_discord_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.dsc.db') | to_uuid }}"
  643. ######################################################################
  644. #
  645. # /matrix-bridge-mx-puppet-discord
  646. #
  647. ######################################################################
  648. ######################################################################
  649. #
  650. # matrix-bridge-mx-puppet-steam
  651. #
  652. ######################################################################
  653. # We don't enable bridges by default.
  654. matrix_mx_puppet_steam_enabled: false
  655. matrix_mx_puppet_steam_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  656. matrix_mx_puppet_steam_systemd_required_services_list: |
  657. {{
  658. ['docker.service']
  659. +
  660. ['matrix-' + matrix_homeserver_implementation + '.service']
  661. +
  662. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  663. +
  664. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  665. }}
  666. matrix_mx_puppet_steam_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxste.as.tok') | to_uuid }}"
  667. matrix_mx_puppet_steam_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxste.hs.tok') | to_uuid }}"
  668. 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 '' }}"
  669. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  670. matrix_mx_puppet_steam_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  671. matrix_mx_puppet_steam_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.steam.db') | to_uuid }}"
  672. ######################################################################
  673. #
  674. # /matrix-bridge-mx-puppet-steam
  675. #
  676. ######################################################################
  677. ######################################################################
  678. #
  679. # matrix-bridge-mx-puppet-groupme
  680. #
  681. ######################################################################
  682. # We don't enable bridges by default.
  683. matrix_mx_puppet_groupme_enabled: false
  684. matrix_mx_puppet_groupme_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  685. matrix_mx_puppet_groupme_systemd_required_services_list: |
  686. {{
  687. ['docker.service']
  688. +
  689. ['matrix-' + matrix_homeserver_implementation + '.service']
  690. +
  691. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  692. +
  693. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  694. }}
  695. matrix_mx_puppet_groupme_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxgro.as.tok') | to_uuid }}"
  696. matrix_mx_puppet_groupme_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxgro.hs.tok') | to_uuid }}"
  697. 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 '' }}"
  698. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  699. matrix_mx_puppet_groupme_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  700. matrix_mx_puppet_groupme_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.groupme.db') | to_uuid }}"
  701. ######################################################################
  702. #
  703. # /matrix-bridge-mx-puppet-groupme
  704. #
  705. ######################################################################
  706. ######################################################################
  707. #
  708. # matrix-bot-matrix-reminder-bot
  709. #
  710. ######################################################################
  711. # We don't enable bots by default.
  712. matrix_bot_matrix_reminder_bot_enabled: false
  713. matrix_bot_matrix_reminder_bot_systemd_required_services_list: |
  714. {{
  715. ['docker.service']
  716. +
  717. ['matrix-' + matrix_homeserver_implementation + '.service']
  718. +
  719. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  720. +
  721. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  722. }}
  723. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  724. matrix_bot_matrix_reminder_bot_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  725. matrix_bot_matrix_reminder_bot_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'reminder.bot.db') | to_uuid }}"
  726. matrix_bot_matrix_reminder_bot_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  727. ######################################################################
  728. #
  729. # /matrix-bot-matrix-reminder-bot
  730. #
  731. ######################################################################
  732. ######################################################################
  733. #
  734. # matrix-bot-honoroit
  735. #
  736. ######################################################################
  737. # We don't enable bots by default.
  738. matrix_bot_honoroit_enabled: false
  739. matrix_bot_honoroit_systemd_required_services_list: |
  740. {{
  741. ['docker.service']
  742. +
  743. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  744. +
  745. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  746. +
  747. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  748. }}
  749. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  750. matrix_bot_honoroit_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  751. matrix_bot_honoroit_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'honoroit.bot.db') | to_uuid }}"
  752. matrix_bot_honoroit_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm32', 'arm64'] }}"
  753. ######################################################################
  754. #
  755. # /matrix-bot-honoroit
  756. #
  757. ######################################################################
  758. ######################################################################
  759. #
  760. # matrix-bot-go-neb
  761. #
  762. ######################################################################
  763. # We don't enable bots by default.
  764. matrix_bot_go_neb_enabled: false
  765. matrix_bot_go_neb_systemd_required_services_list: |
  766. {{
  767. ['docker.service']
  768. +
  769. ['matrix-' + matrix_homeserver_implementation + '.service']
  770. +
  771. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  772. }}
  773. matrix_bot_go_neb_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:4050' }}"
  774. ######################################################################
  775. #
  776. # /matrix-bot-go-neb
  777. #
  778. ######################################################################
  779. ######################################################################
  780. #
  781. # matrix-bot-mjolnir
  782. #
  783. ######################################################################
  784. # We don't enable bots by default.
  785. matrix_bot_mjolnir_enabled: false
  786. matrix_bot_mjolnir_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  787. matrix_bot_mjolnir_systemd_required_services_list: |
  788. {{
  789. ['docker.service']
  790. +
  791. ['matrix-' + matrix_homeserver_implementation + '.service']
  792. +
  793. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  794. +
  795. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  796. }}
  797. ######################################################################
  798. #
  799. # /matrix-bot-mjolnir
  800. #
  801. ######################################################################
  802. ######################################################################
  803. #
  804. # matrix-corporal
  805. #
  806. ######################################################################
  807. matrix_corporal_enabled: false
  808. matrix_corporal_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  809. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-corporal over the container network.
  810. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  811. # matrix-corporal's web-server ports to the local host.
  812. matrix_corporal_container_http_gateway_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:41080' }}"
  813. matrix_corporal_container_http_api_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:41081' }}"
  814. matrix_corporal_systemd_required_services_list: |
  815. {{
  816. (['docker.service'])
  817. +
  818. (['matrix-' + matrix_homeserver_implementation + '.service'])
  819. }}
  820. matrix_corporal_matrix_homeserver_api_endpoint: "{{ matrix_homeserver_container_url }}"
  821. matrix_corporal_matrix_auth_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret }}"
  822. # This is only useful if there's REST auth provider to make use of it.
  823. matrix_corporal_http_gateway_internal_rest_auth_enabled: "{{ matrix_synapse_ext_password_provider_rest_auth_enabled }}"
  824. matrix_corporal_matrix_registration_shared_secret: "{{ matrix_synapse_registration_shared_secret }}"
  825. ######################################################################
  826. #
  827. # /matrix-corporal
  828. #
  829. ######################################################################
  830. ######################################################################
  831. #
  832. # matrix-coturn
  833. #
  834. ######################################################################
  835. matrix_coturn_enabled: true
  836. matrix_coturn_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  837. matrix_coturn_turn_external_ip_address: "{{ ansible_host }}"
  838. matrix_coturn_turn_static_auth_secret: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'coturn.sas') | to_uuid }}"
  839. matrix_coturn_tls_enabled: "{{ matrix_ssl_retrieval_method != 'none' }}"
  840. matrix_coturn_tls_cert_path: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_server_fqn_matrix }}/fullchain.pem"
  841. matrix_coturn_tls_key_path: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_server_fqn_matrix }}/privkey.pem"
  842. matrix_coturn_container_additional_volumes: |
  843. {{
  844. ([] if matrix_ssl_retrieval_method == 'none' else [
  845. {
  846. 'src': matrix_ssl_config_dir_path,
  847. 'dst': matrix_ssl_config_dir_path,
  848. 'options': 'ro',
  849. }
  850. ])
  851. }}
  852. ######################################################################
  853. #
  854. # /matrix-coturn
  855. #
  856. ######################################################################
  857. ######################################################################
  858. #
  859. # matrix-dimension
  860. #
  861. ######################################################################
  862. matrix_dimension_enabled: false
  863. matrix_dimension_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  864. # Normally, matrix-nginx-proxy is enabled and nginx can reach Dimension over the container network.
  865. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  866. # the Dimension HTTP port to the local host.
  867. matrix_dimension_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8184' }}"
  868. matrix_dimension_homeserver_federationUrl: "{{ matrix_homeserver_container_federation_url }}"
  869. matrix_dimension_systemd_required_services_list: |
  870. {{
  871. ['docker.service']
  872. +
  873. ['matrix-' + matrix_homeserver_implementation + '.service']
  874. +
  875. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  876. +
  877. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  878. }}
  879. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  880. matrix_dimension_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  881. matrix_dimension_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'dimension.db') | to_uuid }}"
  882. ######################################################################
  883. #
  884. # /matrix-dimension
  885. #
  886. ######################################################################
  887. ######################################################################
  888. #
  889. # matrix-etherpad
  890. #
  891. ######################################################################
  892. matrix_etherpad_enabled: false
  893. matrix_etherpad_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9001' }}"
  894. matrix_etherpad_systemd_required_services_list: |
  895. {{
  896. ['docker.service']
  897. +
  898. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  899. }}
  900. matrix_etherpad_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'etherpad.db') | to_uuid }}"
  901. ######################################################################
  902. #
  903. # /matrix-etherpad
  904. #
  905. ######################################################################
  906. ######################################################################
  907. #
  908. # matrix-dynamic-dns
  909. #
  910. ######################################################################
  911. matrix_dynamic_dns_enabled: false
  912. ######################################################################
  913. #
  914. # /matrix-dynamic-dns
  915. #
  916. ######################################################################
  917. ######################################################################
  918. #
  919. # matrix-email2matrix
  920. #
  921. ######################################################################
  922. matrix_email2matrix_enabled: false
  923. matrix_email2matrix_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  924. ######################################################################
  925. #
  926. # /matrix-email2matrix
  927. #
  928. ######################################################################
  929. ######################################################################
  930. #
  931. # matrix-jitsi
  932. #
  933. ######################################################################
  934. matrix_jitsi_enabled: false
  935. # Normally, matrix-nginx-proxy is enabled and nginx can reach jitsi/web over the container network.
  936. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  937. # the Jitsi HTTP port to the local host.
  938. matrix_jitsi_web_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:13080' }}"
  939. matrix_jitsi_jvb_container_colibri_ws_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:13090' }}"
  940. matrix_jitsi_prosody_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:5280' }}"
  941. matrix_jitsi_jibri_xmpp_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'jibri') | to_uuid }}"
  942. matrix_jitsi_jicofo_auth_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'jicofo') | to_uuid }}"
  943. matrix_jitsi_jvb_auth_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'jvb') | to_uuid }}"
  944. matrix_jitsi_web_stun_servers: |
  945. {{
  946. [
  947. 'stun:' + matrix_server_fqn_matrix + ':5349',
  948. 'stun:' + matrix_server_fqn_matrix + ':3478',
  949. ]
  950. if matrix_coturn_enabled
  951. else [ 'stun:meet-jit-si-turnrelay.jitsi.net:443']
  952. }}
  953. # If the self-hosted Etherpad instance is available, it will also show up in Jitsi conferences,
  954. # unless explicitly disabled by setting `matrix_jitsi_etherpad_enabled` to false.
  955. # Falls back to the scalar.vector.im etherpad in case someone sets `matrix_jitsi_etherpad_enabled` to true,
  956. # while also setting `matrix_etherpad_enabled` to false.
  957. matrix_jitsi_etherpad_enabled: "{{ matrix_etherpad_enabled }}"
  958. matrix_jitsi_etherpad_base: "{{ matrix_etherpad_base_url if matrix_etherpad_enabled else 'https://scalar.vector.im/etherpad' }}"
  959. ######################################################################
  960. #
  961. # /matrix-jitsi
  962. #
  963. ######################################################################
  964. ######################################################################
  965. #
  966. # matrix-mailer
  967. #
  968. ######################################################################
  969. # By default, this playbook sets up an exim mailer server (running in a container).
  970. # This is so that Synapse can send email reminders for unread messages.
  971. # Other services (like ma1sd), also use the mailer.
  972. matrix_mailer_enabled: true
  973. matrix_mailer_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  974. ######################################################################
  975. #
  976. # /matrix-mailer
  977. #
  978. ######################################################################
  979. ######################################################################
  980. #
  981. # matrix-ma1sd
  982. #
  983. ######################################################################
  984. # By default, this playbook installs the ma1sd identity server on the same domain as Synapse (`matrix_server_fqn_matrix`).
  985. # If you wish to use the public identity servers (matrix.org, vector.im) instead of your own you may wish to disable this.
  986. matrix_ma1sd_enabled: true
  987. matrix_ma1sd_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  988. # Normally, matrix-nginx-proxy is enabled and nginx can reach ma1sd over the container network.
  989. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  990. # ma1sd's web-server port.
  991. matrix_ma1sd_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:' + matrix_ma1sd_container_port|string }}"
  992. # We enable Synapse integration via its Postgres database by default.
  993. # When using another Identity store, you might wish to disable this and define
  994. # your own configuration in `matrix_ma1sd_configuration_extension_yaml`.
  995. matrix_ma1sd_synapsesql_enabled: true
  996. matrix_ma1sd_synapsesql_type: postgresql
  997. matrix_ma1sd_synapsesql_connection: //{{ matrix_synapse_database_host }}/{{ matrix_synapse_database_database }}?user={{ matrix_synapse_database_user | urlencode() }}&password={{ matrix_synapse_database_password | urlencode() }}
  998. matrix_ma1sd_dns_overwrite_enabled: true
  999. matrix_ma1sd_dns_overwrite_homeserver_client_name: "{{ matrix_server_fqn_matrix }}"
  1000. # The `matrix_ma1sd_dns_overwrite_homeserver_client_value` value when matrix_nginx_proxy_enabled is false covers the general case,
  1001. # but may be inaccurate if matrix-corporal is enabled.
  1002. 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 }}"
  1003. # By default, we send mail through the `matrix-mailer` service.
  1004. matrix_ma1sd_threepid_medium_email_identity_from: "{{ matrix_mailer_sender_address }}"
  1005. matrix_ma1sd_threepid_medium_email_connectors_smtp_host: "matrix-mailer"
  1006. matrix_ma1sd_threepid_medium_email_connectors_smtp_port: 8025
  1007. matrix_ma1sd_threepid_medium_email_connectors_smtp_tls: 0
  1008. matrix_ma1sd_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1009. matrix_ma1sd_systemd_required_services_list: |
  1010. {{
  1011. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1012. }}
  1013. matrix_ma1sd_systemd_wanted_services_list: |
  1014. {{
  1015. (['matrix-corporal.service'] if matrix_corporal_enabled else ['matrix-' + matrix_homeserver_implementation + '.service'])
  1016. +
  1017. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1018. +
  1019. (['matrix-mailer.service'] if matrix_mailer_enabled else [])
  1020. }}
  1021. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  1022. matrix_ma1sd_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  1023. matrix_ma1sd_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'ma1sd.db') | to_uuid }}"
  1024. ######################################################################
  1025. #
  1026. # /matrix-ma1sd
  1027. #
  1028. ######################################################################
  1029. ######################################################################
  1030. #
  1031. # matrix-nginx-proxy
  1032. #
  1033. ######################################################################
  1034. # By default, this playbook sets up a reverse-proxy nginx proxy server on TCP ports 80, 443 and 8448.
  1035. # This is fine if you're dedicating the whole server to Matrix.
  1036. # If that's not the case, you may wish to disable this and take care of proxying yourself.
  1037. matrix_nginx_proxy_enabled: true
  1038. matrix_nginx_proxy_proxy_matrix_client_api_addr_with_container: "{{ 'matrix-corporal:41080' if matrix_corporal_enabled else 'matrix-nginx-proxy:12080' }}"
  1039. 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' }}"
  1040. matrix_nginx_proxy_proxy_matrix_client_api_client_max_body_size_mb: |-
  1041. {{
  1042. {
  1043. 'synapse': matrix_synapse_max_upload_size_mb,
  1044. 'dendrite': (matrix_dendrite_max_file_size_bytes / 1024 / 1024) | round,
  1045. }[matrix_homeserver_implementation]|int
  1046. }}
  1047. matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_synapse_admin_api_enabled: "{{ matrix_synapse_admin_enabled }}"
  1048. matrix_nginx_proxy_proxy_matrix_client_redirect_root_uri_to_domain: "{{ matrix_server_fqn_element if matrix_client_element_enabled else '' }}"
  1049. matrix_nginx_proxy_proxy_matrix_enabled: true
  1050. matrix_nginx_proxy_proxy_element_enabled: "{{ matrix_client_element_enabled }}"
  1051. matrix_nginx_proxy_proxy_hydrogen_enabled: "{{ matrix_client_hydrogen_enabled }}"
  1052. matrix_nginx_proxy_proxy_cinny_enabled: "{{ matrix_client_cinny_enabled }}"
  1053. matrix_nginx_proxy_proxy_dimension_enabled: "{{ matrix_dimension_enabled }}"
  1054. matrix_nginx_proxy_proxy_bot_go_neb_enabled: "{{ matrix_bot_go_neb_enabled }}"
  1055. matrix_nginx_proxy_proxy_jitsi_enabled: "{{ matrix_jitsi_enabled }}"
  1056. matrix_nginx_proxy_proxy_grafana_enabled: "{{ matrix_grafana_enabled }}"
  1057. matrix_nginx_proxy_proxy_sygnal_enabled: "{{ matrix_sygnal_enabled }}"
  1058. matrix_nginx_proxy_proxy_matrix_corporal_api_enabled: "{{ matrix_corporal_enabled and matrix_corporal_http_api_enabled }}"
  1059. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_with_container: "matrix-corporal:41081"
  1060. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_sans_container: "127.0.0.1:41081"
  1061. matrix_nginx_proxy_proxy_matrix_identity_api_enabled: "{{ matrix_ma1sd_enabled }}"
  1062. matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container: "matrix-ma1sd:{{ matrix_ma1sd_container_port }}"
  1063. matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container: "127.0.0.1:{{ matrix_ma1sd_container_port }}"
  1064. # By default, we do TLS termination for the Matrix Federation API (port 8448) at matrix-nginx-proxy.
  1065. # Unless this is handled there OR Synapse's federation listener port is disabled, we'll reverse-proxy.
  1066. matrix_nginx_proxy_proxy_matrix_federation_api_enabled: |-
  1067. {{
  1068. {
  1069. 'synapse': (matrix_synapse_federation_port_enabled and not matrix_synapse_tls_federation_listener_enabled),
  1070. 'dendrite': matrix_dendrite_federation_enabled,
  1071. }[matrix_homeserver_implementation]|bool
  1072. }}
  1073. matrix_nginx_proxy_proxy_matrix_federation_api_addr_with_container: "matrix-nginx-proxy:12088"
  1074. matrix_nginx_proxy_proxy_matrix_federation_api_addr_sans_container: "127.0.0.1:12088"
  1075. matrix_nginx_proxy_proxy_synapse_enabled: "{{ matrix_synapse_enabled }}"
  1076. matrix_nginx_proxy_proxy_synapse_client_api_addr_with_container: "matrix-synapse:{{ matrix_synapse_container_client_api_port }}"
  1077. matrix_nginx_proxy_proxy_synapse_client_api_addr_sans_container: "127.0.0.1:{{ matrix_synapse_container_client_api_port }}"
  1078. matrix_nginx_proxy_proxy_synapse_federation_api_addr_with_container: "matrix-synapse:{{matrix_synapse_container_federation_api_plain_port|string}}"
  1079. matrix_nginx_proxy_proxy_synapse_federation_api_addr_sans_container: "localhost:{{matrix_synapse_container_federation_api_plain_port|string}}"
  1080. matrix_nginx_proxy_proxy_dendrite_enabled: "{{ matrix_dendrite_enabled }}"
  1081. matrix_nginx_proxy_proxy_dendrite_client_api_addr_with_container: "matrix-dendrite:{{ matrix_dendrite_http_bind_port|string }}"
  1082. matrix_nginx_proxy_proxy_dendrite_client_api_addr_sans_container: "127.0.0.1:{{ matrix_dendrite_http_bind_port|string }}"
  1083. matrix_nginx_proxy_proxy_dendrite_federation_api_addr_with_container: "matrix-dendrite:{{ matrix_dendrite_http_bind_port|string }}"
  1084. matrix_nginx_proxy_proxy_dendrite_federation_api_addr_sans_container: "127.0.0.1:{{ matrix_dendrite_http_bind_port|string }}"
  1085. # When matrix-nginx-proxy is disabled, the actual port number that the vhost uses may begin to matter.
  1086. matrix_nginx_proxy_proxy_matrix_federation_port: "{{ matrix_federation_public_port }}"
  1087. matrix_nginx_proxy_container_federation_host_bind_port: "{{ matrix_federation_public_port }}"
  1088. # This used to be hooked to `matrix_synapse_metrics_enabled`, but we don't do it anymore.
  1089. # The fact that someone wishes to enable Synapse metrics does not necessarily mean they want to make them public.
  1090. # A local Prometheus can consume them over the container network.
  1091. matrix_nginx_proxy_proxy_synapse_metrics: false
  1092. matrix_nginx_proxy_proxy_synapse_metrics_addr_with_container: "matrix-synapse:{{ matrix_synapse_metrics_port }}"
  1093. matrix_nginx_proxy_proxy_synapse_metrics_addr_sans_container: "127.0.0.1:{{ matrix_synapse_metrics_port }}"
  1094. matrix_nginx_proxy_proxy_matrix_user_directory_search_enabled: "{{ matrix_ma1sd_enabled }}"
  1095. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_with_container: "{{ matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container }}"
  1096. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_sans_container: "{{ matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container }}"
  1097. matrix_nginx_proxy_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1098. # OCSP stapling does not make sense when self-signed certificates are used.
  1099. # See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1073
  1100. # and https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1074
  1101. matrix_nginx_proxy_ocsp_stapling_enabled: "{{ matrix_ssl_retrieval_method != 'self-signed' }}"
  1102. matrix_nginx_proxy_synapse_presence_disabled: "{{ not matrix_synapse_presence_enabled }}"
  1103. matrix_nginx_proxy_synapse_workers_enabled: "{{ matrix_synapse_workers_enabled }}"
  1104. matrix_nginx_proxy_synapse_workers_list: "{{ matrix_synapse_workers_enabled_list }}"
  1105. matrix_nginx_proxy_synapse_generic_worker_client_server_locations: "{{ matrix_synapse_workers_generic_worker_client_server_endpoints }}"
  1106. matrix_nginx_proxy_synapse_generic_worker_federation_locations: "{{ matrix_synapse_workers_generic_worker_federation_endpoints }}"
  1107. matrix_nginx_proxy_synapse_media_repository_locations: "{{matrix_synapse_workers_media_repository_endpoints|default([]) }}"
  1108. matrix_nginx_proxy_synapse_user_dir_locations: "{{ matrix_synapse_workers_user_dir_endpoints|default([]) }}"
  1109. matrix_nginx_proxy_synapse_frontend_proxy_locations: "{{ matrix_synapse_workers_frontend_proxy_endpoints|default([]) }}"
  1110. matrix_nginx_proxy_proxy_synapse_workers_enabled_list: "{{ matrix_synapse_workers_enabled_list }}"
  1111. matrix_nginx_proxy_systemd_wanted_services_list: |
  1112. {{
  1113. ['matrix-' + matrix_homeserver_implementation + '.service']
  1114. +
  1115. (['matrix-corporal.service'] if matrix_corporal_enabled else [])
  1116. +
  1117. (['matrix-ma1sd.service'] if matrix_ma1sd_enabled else [])
  1118. +
  1119. (['matrix-client-cinny.service'] if matrix_client_cinny_enabled else [])
  1120. +
  1121. (['matrix-client-element.service'] if matrix_client_element_enabled else [])
  1122. +
  1123. (['matrix-client-hydrogen.service'] if matrix_client_hydrogen_enabled else [])
  1124. +
  1125. (['matrix-grafana.service'] if matrix_grafana_enabled else [])
  1126. +
  1127. (['matrix-dimension.service'] if matrix_dimension_enabled else [])
  1128. +
  1129. (['matrix-sygnal.service'] if matrix_sygnal_enabled else [])
  1130. +
  1131. (['matrix-jitsi.service'] if matrix_jitsi_enabled else [])
  1132. +
  1133. (['matrix-bot-go-neb.service'] if matrix_bot_go_neb_enabled else [])
  1134. }}
  1135. matrix_ssl_domains_to_obtain_certificates_for: |
  1136. {{
  1137. ([matrix_server_fqn_matrix])
  1138. +
  1139. ([matrix_server_fqn_element] if matrix_client_element_enabled else [])
  1140. +
  1141. ([matrix_nginx_proxy_proxy_riot_compat_redirect_hostname] if matrix_nginx_proxy_proxy_riot_compat_redirect_enabled else [])
  1142. +
  1143. ([matrix_server_fqn_hydrogen] if matrix_client_hydrogen_enabled else [])
  1144. +
  1145. ([matrix_server_fqn_cinny] if matrix_client_cinny_enabled else [])
  1146. +
  1147. ([matrix_server_fqn_dimension] if matrix_dimension_enabled else [])
  1148. +
  1149. ([matrix_server_fqn_bot_go_neb] if matrix_bot_go_neb_enabled else [])
  1150. +
  1151. ([matrix_server_fqn_jitsi] if matrix_jitsi_enabled else [])
  1152. +
  1153. ([matrix_server_fqn_grafana] if matrix_grafana_enabled else [])
  1154. +
  1155. ([matrix_server_fqn_sygnal] if matrix_sygnal_enabled else [])
  1156. +
  1157. ([matrix_domain] if matrix_nginx_proxy_base_domain_serving_enabled else [])
  1158. +
  1159. matrix_ssl_additional_domains_to_obtain_certificates_for
  1160. }}
  1161. matrix_ssl_architecture: "{{
  1162. {
  1163. 'amd64': 'amd64',
  1164. 'arm32': 'arm32v6',
  1165. 'arm64': 'arm64v8',
  1166. }[matrix_architecture]
  1167. }}"
  1168. matrix_ssl_pre_obtaining_required_service_name: "{{ 'matrix-dynamic-dns' if matrix_dynamic_dns_enabled else '' }}"
  1169. ######################################################################
  1170. #
  1171. # /matrix-nginx-proxy
  1172. #
  1173. ######################################################################
  1174. ######################################################################
  1175. #
  1176. # matrix-postgres
  1177. #
  1178. ######################################################################
  1179. matrix_postgres_enabled: true
  1180. matrix_postgres_architecture: "{{ matrix_architecture }}"
  1181. # We unset this if internal Postgres disabled, which will cascade to some other variables
  1182. # and tell users they need to set it (either here or in those variables).
  1183. matrix_postgres_connection_hostname: "{{ 'matrix-postgres' if matrix_postgres_enabled else '' }}"
  1184. matrix_postgres_pgloader_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1185. matrix_postgres_additional_databases: |
  1186. {{
  1187. ([{
  1188. 'name': matrix_synapse_database_database,
  1189. 'username': matrix_synapse_database_user,
  1190. 'password': matrix_synapse_database_password,
  1191. }] if (matrix_synapse_enabled and matrix_synapse_database_database != matrix_postgres_db_name and matrix_synapse_database_host == 'matrix-postgres') else [])
  1192. +
  1193. ([{
  1194. 'name': matrix_dendrite_naffka_database,
  1195. 'username': matrix_dendrite_database_user,
  1196. 'password': matrix_dendrite_database_password,
  1197. },{
  1198. 'name': matrix_dendrite_appservice_database,
  1199. 'username': matrix_dendrite_database_user,
  1200. 'password': matrix_dendrite_database_password,
  1201. },{
  1202. 'name': matrix_dendrite_federationsender_database,
  1203. 'username': matrix_dendrite_database_user,
  1204. 'password': matrix_dendrite_database_password,
  1205. },{
  1206. 'name': matrix_dendrite_keyserver_database,
  1207. 'username': matrix_dendrite_database_user,
  1208. 'password': matrix_dendrite_database_password,
  1209. },{
  1210. 'name': matrix_dendrite_mediaapi_database,
  1211. 'username': matrix_dendrite_database_user,
  1212. 'password': matrix_dendrite_database_password,
  1213. },{
  1214. 'name': matrix_dendrite_room_database,
  1215. 'username': matrix_dendrite_database_user,
  1216. 'password': matrix_dendrite_database_password,
  1217. },{
  1218. 'name': matrix_dendrite_singingkeyserver_database,
  1219. 'username': matrix_dendrite_database_user,
  1220. 'password': matrix_dendrite_database_password,
  1221. },{
  1222. 'name': matrix_dendrite_syncapi_database,
  1223. 'username': matrix_dendrite_database_user,
  1224. 'password': matrix_dendrite_database_password,
  1225. },{
  1226. 'name': matrix_dendrite_account_database,
  1227. 'username': matrix_dendrite_database_user,
  1228. 'password': matrix_dendrite_database_password,
  1229. },{
  1230. 'name': matrix_dendrite_device_database,
  1231. 'username': matrix_dendrite_database_user,
  1232. 'password': matrix_dendrite_database_password,
  1233. },{
  1234. 'name': matrix_dendrite_mscs_database,
  1235. 'username': matrix_dendrite_database_user,
  1236. 'password': matrix_dendrite_database_password,
  1237. }] if (matrix_dendrite_enabled and matrix_dendrite_database_hostname == 'matrix-postgres') else [])
  1238. +
  1239. ([{
  1240. 'name': matrix_ma1sd_database_name,
  1241. 'username': matrix_ma1sd_database_username,
  1242. 'password': matrix_ma1sd_database_password,
  1243. }] if (matrix_ma1sd_enabled and matrix_ma1sd_database_engine == 'postgres' and matrix_ma1sd_database_hostname == 'matrix-postgres') else [])
  1244. +
  1245. ([{
  1246. 'name': matrix_bot_matrix_reminder_bot_database_name,
  1247. 'username': matrix_bot_matrix_reminder_bot_database_username,
  1248. 'password': matrix_bot_matrix_reminder_bot_database_password,
  1249. }] 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 [])
  1250. +
  1251. ([{
  1252. 'name': matrix_bot_honoroit_database_name,
  1253. 'username': matrix_bot_honoroit_database_username,
  1254. 'password': matrix_bot_honoroit_database_password,
  1255. }] if (matrix_bot_honoroit_enabled and matrix_bot_honoroit_database_engine == 'postgres' and matrix_bot_honoroit_database_hostname == 'matrix-postgres') else [])
  1256. +
  1257. ([{
  1258. 'name': matrix_registration_database_name,
  1259. 'username': matrix_registration_database_username,
  1260. 'password': matrix_registration_database_password,
  1261. }] if (matrix_registration_enabled and matrix_registration_database_engine == 'postgres' and matrix_registration_database_hostname == 'matrix-postgres') else [])
  1262. +
  1263. ([{
  1264. 'name': matrix_appservice_discord_database_name,
  1265. 'username': matrix_appservice_discord_database_username,
  1266. 'password': matrix_appservice_discord_database_password,
  1267. }] if (matrix_appservice_discord_enabled and matrix_appservice_discord_database_engine == 'postgres' and matrix_appservice_discord_database_hostname == 'matrix-postgres') else [])
  1268. +
  1269. ([{
  1270. 'name': matrix_appservice_slack_database_name,
  1271. 'username': matrix_appservice_slack_database_username,
  1272. 'password': matrix_appservice_slack_database_password,
  1273. }] if (matrix_appservice_slack_enabled and matrix_appservice_slack_database_engine == 'postgres' and matrix_appservice_slack_database_hostname == 'matrix-postgres') else [])
  1274. +
  1275. ([{
  1276. 'name': matrix_appservice_irc_database_name,
  1277. 'username': matrix_appservice_irc_database_username,
  1278. 'password': matrix_appservice_irc_database_password,
  1279. }] if (matrix_appservice_irc_enabled and matrix_appservice_irc_database_engine == 'postgres' and matrix_appservice_irc_database_hostname == 'matrix-postgres') else [])
  1280. +
  1281. ([{
  1282. 'name': matrix_beeper_linkedin_database_name,
  1283. 'username': matrix_beeper_linkedin_database_username,
  1284. 'password': matrix_beeper_linkedin_database_password,
  1285. }] if (matrix_beeper_linkedin_enabled and matrix_beeper_linkedin_database_engine == 'postgres' and matrix_beeper_linkedin_database_hostname == 'matrix-postgres') else [])
  1286. +
  1287. ([{
  1288. 'name': matrix_mautrix_facebook_database_name,
  1289. 'username': matrix_mautrix_facebook_database_username,
  1290. 'password': matrix_mautrix_facebook_database_password,
  1291. }] if (matrix_mautrix_facebook_enabled and matrix_mautrix_facebook_database_engine == 'postgres' and matrix_mautrix_facebook_database_hostname == 'matrix-postgres') else [])
  1292. +
  1293. ([{
  1294. 'name': matrix_mautrix_hangouts_database_name,
  1295. 'username': matrix_mautrix_hangouts_database_username,
  1296. 'password': matrix_mautrix_hangouts_database_password,
  1297. }] if (matrix_mautrix_hangouts_enabled and matrix_mautrix_hangouts_database_engine == 'postgres' and matrix_mautrix_hangouts_database_hostname == 'matrix-postgres') else [])
  1298. +
  1299. ([{
  1300. 'name': matrix_mautrix_googlechat_database_name,
  1301. 'username': matrix_mautrix_googlechat_database_username,
  1302. 'password': matrix_mautrix_googlechat_database_password,
  1303. }] if (matrix_mautrix_googlechat_enabled and matrix_mautrix_googlechat_database_engine == 'postgres' and matrix_mautrix_googlechat_database_hostname == 'matrix-postgres') else [])
  1304. +
  1305. ([{
  1306. 'name': matrix_mautrix_instagram_database_name,
  1307. 'username': matrix_mautrix_instagram_database_username,
  1308. 'password': matrix_mautrix_instagram_database_password,
  1309. }] if (matrix_mautrix_instagram_enabled and matrix_mautrix_instagram_database_engine == 'postgres' and matrix_mautrix_instagram_database_hostname == 'matrix-postgres') else [])
  1310. +
  1311. ([{
  1312. 'name': matrix_mautrix_signal_database_name,
  1313. 'username': matrix_mautrix_signal_database_username,
  1314. 'password': matrix_mautrix_signal_database_password,
  1315. }] if (matrix_mautrix_signal_enabled and matrix_mautrix_signal_database_engine == 'postgres' and matrix_mautrix_signal_database_hostname == 'matrix-postgres') else [])
  1316. +
  1317. ([{
  1318. 'name': matrix_mautrix_telegram_database_name,
  1319. 'username': matrix_mautrix_telegram_database_username,
  1320. 'password': matrix_mautrix_telegram_database_password,
  1321. }] if (matrix_mautrix_telegram_enabled and matrix_mautrix_telegram_database_engine == 'postgres' and matrix_mautrix_telegram_database_hostname == 'matrix-postgres') else [])
  1322. +
  1323. ([{
  1324. 'name': matrix_mautrix_twitter_database_name,
  1325. 'username': matrix_mautrix_twitter_database_username,
  1326. 'password': matrix_mautrix_twitter_database_password,
  1327. }] if (matrix_mautrix_twitter_enabled and matrix_mautrix_twitter_database_engine == 'postgres' and matrix_mautrix_twitter_database_hostname == 'matrix-postgres') else [])
  1328. +
  1329. ([{
  1330. 'name': matrix_mautrix_whatsapp_database_name,
  1331. 'username': matrix_mautrix_whatsapp_database_username,
  1332. 'password': matrix_mautrix_whatsapp_database_password,
  1333. }] if (matrix_mautrix_whatsapp_enabled and matrix_mautrix_whatsapp_database_engine == 'postgres' and matrix_mautrix_whatsapp_database_hostname == 'matrix-postgres') else [])
  1334. +
  1335. ([{
  1336. 'name': matrix_mx_puppet_skype_database_name,
  1337. 'username': matrix_mx_puppet_skype_database_username,
  1338. 'password': matrix_mx_puppet_skype_database_password,
  1339. }] if (matrix_mx_puppet_skype_enabled and matrix_mx_puppet_skype_database_engine == 'postgres' and matrix_mx_puppet_skype_database_hostname == 'matrix-postgres') else [])
  1340. +
  1341. ([{
  1342. 'name': matrix_mx_puppet_slack_database_name,
  1343. 'username': matrix_mx_puppet_slack_database_username,
  1344. 'password': matrix_mx_puppet_slack_database_password,
  1345. }] if (matrix_mx_puppet_slack_enabled and matrix_mx_puppet_slack_database_engine == 'postgres' and matrix_mx_puppet_slack_database_hostname == 'matrix-postgres') else [])
  1346. +
  1347. ([{
  1348. 'name': matrix_mx_puppet_twitter_database_name,
  1349. 'username': matrix_mx_puppet_twitter_database_username,
  1350. 'password': matrix_mx_puppet_twitter_database_password,
  1351. }] if (matrix_mx_puppet_twitter_enabled and matrix_mx_puppet_twitter_database_engine == 'postgres' and matrix_mx_puppet_twitter_database_hostname == 'matrix-postgres') else [])
  1352. +
  1353. ([{
  1354. 'name': matrix_mx_puppet_instagram_database_name,
  1355. 'username': matrix_mx_puppet_instagram_database_username,
  1356. 'password': matrix_mx_puppet_instagram_database_password,
  1357. }] if (matrix_mx_puppet_instagram_enabled and matrix_mx_puppet_instagram_database_engine == 'postgres' and matrix_mx_puppet_instagram_database_hostname == 'matrix-postgres') else [])
  1358. +
  1359. ([{
  1360. 'name': matrix_mx_puppet_discord_database_name,
  1361. 'username': matrix_mx_puppet_discord_database_username,
  1362. 'password': matrix_mx_puppet_discord_database_password,
  1363. }] if (matrix_mx_puppet_discord_enabled and matrix_mx_puppet_discord_database_engine == 'postgres' and matrix_mx_puppet_discord_database_hostname == 'matrix-postgres') else [])
  1364. +
  1365. ([{
  1366. 'name': matrix_mx_puppet_steam_database_name,
  1367. 'username': matrix_mx_puppet_steam_database_username,
  1368. 'password': matrix_mx_puppet_steam_database_password,
  1369. }] if (matrix_mx_puppet_steam_enabled and matrix_mx_puppet_steam_database_engine == 'postgres' and matrix_mx_puppet_steam_database_hostname == 'matrix-postgres') else [])
  1370. +
  1371. ([{
  1372. 'name': matrix_mx_puppet_groupme_database_name,
  1373. 'username': matrix_mx_puppet_groupme_database_username,
  1374. 'password': matrix_mx_puppet_groupme_database_password,
  1375. }] if (matrix_mx_puppet_groupme_enabled and matrix_mx_puppet_groupme_database_engine == 'postgres' and matrix_mx_puppet_groupme_database_hostname == 'matrix-postgres') else [])
  1376. +
  1377. ([{
  1378. 'name': matrix_dimension_database_name,
  1379. 'username': matrix_dimension_database_username,
  1380. 'password': matrix_dimension_database_password,
  1381. }] if (matrix_dimension_enabled and matrix_dimension_database_engine == 'postgres' and matrix_dimension_database_hostname == 'matrix-postgres') else [])
  1382. +
  1383. ([{
  1384. 'name': matrix_etherpad_database_name,
  1385. 'username': matrix_etherpad_database_username,
  1386. 'password': matrix_etherpad_database_password,
  1387. }] if (matrix_etherpad_enabled and matrix_etherpad_database_engine == 'postgres' and matrix_etherpad_database_hostname == 'matrix-postgres') else [])
  1388. +
  1389. ([{
  1390. 'name': matrix_prometheus_postgres_exporter_database_name,
  1391. 'username': matrix_prometheus_postgres_exporter_database_username,
  1392. 'password': matrix_prometheus_postgres_exporter_database_password,
  1393. }] if (matrix_prometheus_postgres_exporter_enabled and matrix_prometheus_postgres_exporter_database_hostname == 'matrix-postgres') else [])
  1394. }}
  1395. matrix_postgres_import_roles_to_ignore: |
  1396. {{
  1397. [matrix_postgres_connection_username]
  1398. +
  1399. matrix_postgres_additional_databases|map(attribute='username')|list
  1400. }}
  1401. matrix_postgres_import_databases_to_ignore: |
  1402. {{
  1403. [matrix_postgres_db_name]
  1404. +
  1405. matrix_postgres_additional_databases|map(attribute='name')|list
  1406. }}
  1407. ######################################################################
  1408. #
  1409. # /matrix-postgres
  1410. #
  1411. ######################################################################
  1412. ######################################################################
  1413. #
  1414. # matrix-sygnal
  1415. #
  1416. ######################################################################
  1417. # Most people don't need their own push-server, because they also need their own app to utilize it from.
  1418. matrix_sygnal_enabled: false
  1419. # If someone instals Prometheus via the playbook, they most likely wish to monitor Sygnal.
  1420. matrix_sygnal_metrics_prometheus_enabled: "{{ matrix_prometheus_enabled }}"
  1421. matrix_sygnal_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:6000' }}"
  1422. ######################################################################
  1423. #
  1424. # /matrix-sygnal
  1425. #
  1426. ######################################################################
  1427. ######################################################################
  1428. #
  1429. # matrix-redis
  1430. #
  1431. ######################################################################
  1432. matrix_redis_enabled: "{{ matrix_synapse_workers_enabled }}"
  1433. ######################################################################
  1434. #
  1435. # /matrix-redis
  1436. #
  1437. ######################################################################
  1438. ######################################################################
  1439. #
  1440. # matrix-client-element
  1441. #
  1442. ######################################################################
  1443. # By default, this playbook installs the Element web UI on the `matrix_server_fqn_element` domain.
  1444. # If you wish to connect to your Matrix server by other means, you may wish to disable this.
  1445. matrix_client_element_enabled: true
  1446. matrix_client_element_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1447. # Normally, matrix-nginx-proxy is enabled and nginx can reach Element over the container network.
  1448. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1449. # the Element HTTP port to the local host.
  1450. matrix_client_element_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8765' }}"
  1451. matrix_client_element_default_hs_url: "{{ matrix_homeserver_url }}"
  1452. matrix_client_element_default_is_url: "{{ matrix_identity_server_url }}"
  1453. # Use Dimension if enabled, otherwise fall back to Scalar
  1454. matrix_client_element_integrations_ui_url: "{{ matrix_dimension_integrations_ui_url if matrix_dimension_enabled else 'https://scalar.vector.im/' }}"
  1455. matrix_client_element_integrations_rest_url: "{{ matrix_dimension_integrations_rest_url if matrix_dimension_enabled else 'https://scalar.vector.im/api' }}"
  1456. matrix_client_element_integrations_widgets_urls: "{{ matrix_dimension_integrations_widgets_urls if matrix_dimension_enabled else ['https://scalar.vector.im/api'] }}"
  1457. 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' }}"
  1458. matrix_client_element_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1459. matrix_client_element_registration_enabled: "{{ matrix_synapse_enable_registration }}"
  1460. matrix_client_element_enable_presence_by_hs_url: |
  1461. {{
  1462. none
  1463. if matrix_synapse_presence_enabled
  1464. else {matrix_client_element_default_hs_url: false}
  1465. }}
  1466. matrix_client_element_welcome_user_id: ~
  1467. matrix_client_element_jitsi_preferredDomain: "{{ matrix_server_fqn_jitsi if matrix_jitsi_enabled else '' }}"
  1468. ######################################################################
  1469. #
  1470. # /matrix-client-element
  1471. #
  1472. ######################################################################
  1473. ######################################################################
  1474. #
  1475. # matrix-client-hydrogen
  1476. #
  1477. ######################################################################
  1478. matrix_client_hydrogen_enabled: false
  1479. # Normally, matrix-nginx-proxy is enabled and nginx can reach Hydrogen over the container network.
  1480. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1481. # the HTTP port to the local host.
  1482. matrix_client_hydrogen_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8768' }}"
  1483. matrix_client_hydrogen_default_hs_url: "{{ matrix_homeserver_url }}"
  1484. matrix_client_hydrogen_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1485. ######################################################################
  1486. #
  1487. # /matrix-client-hydrogen
  1488. #
  1489. ######################################################################
  1490. ######################################################################
  1491. #
  1492. # matrix-client-cinny
  1493. #
  1494. ######################################################################
  1495. matrix_client_cinny_enabled: false
  1496. matrix_client_cinny_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1497. # Normally, matrix-nginx-proxy is enabled and nginx can reach Cinny over the container network.
  1498. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1499. # the HTTP port to the local host.
  1500. matrix_client_cinny_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8080' }}"
  1501. matrix_client_cinny_default_hs_url: "{{ matrix_homeserver_url }}"
  1502. matrix_client_cinny_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1503. ######################################################################
  1504. #
  1505. # /matrix-client-cinny
  1506. #
  1507. ######################################################################
  1508. ######################################################################
  1509. #
  1510. # matrix-synapse
  1511. #
  1512. ######################################################################
  1513. matrix_synapse_enabled: "{{ matrix_homeserver_implementation == 'synapse' }}"
  1514. matrix_synapse_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  1515. # When ma1sd is enabled, we can use it to validate email addresses and phone numbers.
  1516. # 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.
  1517. matrix_synapse_account_threepid_delegates_email: "{{ 'http://matrix-ma1sd:' + matrix_ma1sd_container_port|string if matrix_ma1sd_enabled else '' }}"
  1518. matrix_synapse_account_threepid_delegates_msisdn: "{{ 'http://matrix-ma1sd:' + matrix_ma1sd_container_port|string if matrix_ma1sd_enabled else '' }}"
  1519. # Normally, matrix-nginx-proxy is enabled and nginx can reach Synapse over the container network.
  1520. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it,
  1521. # you can expose Synapse's ports to the host.
  1522. #
  1523. # For exposing the Matrix Client API's port (plain HTTP) to the local host.
  1524. 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 }}"
  1525. #
  1526. # For exposing the Matrix Federation API's plain port (plain HTTP) to the local host.
  1527. 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 }}"
  1528. #
  1529. # For exposing the Matrix Federation API's TLS port (HTTPS) to the internet on all network interfaces.
  1530. 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 '' }}"
  1531. #
  1532. # For exposing the Synapse Metrics API's port (plain HTTP) to the local host.
  1533. 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 '' }}"
  1534. #
  1535. # For exposing the Synapse Manhole port (plain HTTP) to the local host.
  1536. matrix_synapse_container_manhole_api_host_bind_port: "{{ '127.0.0.1:9000' if matrix_synapse_manhole_enabled else '' }}"
  1537. #
  1538. # For exposing the Synapse worker (and metrics) ports to the local host.
  1539. matrix_synapse_workers_container_host_bind_address: "{{ '127.0.0.1' if (matrix_synapse_workers_enabled and not matrix_nginx_proxy_enabled) else '' }}"
  1540. matrix_synapse_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'synapse.db') | to_uuid }}"
  1541. matrix_synapse_macaroon_secret_key: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'synapse.mac') | to_uuid }}"
  1542. # We do not enable TLS in Synapse by default.
  1543. # TLS is handled by the matrix-nginx-proxy, which proxies the requests to Synapse.
  1544. matrix_synapse_tls_federation_listener_enabled: false
  1545. matrix_synapse_tls_certificate_path: ~
  1546. matrix_synapse_tls_private_key_path: ~
  1547. matrix_synapse_federation_port_openid_resource_required: "{{ not matrix_synapse_federation_enabled and (matrix_dimension_enabled or matrix_ma1sd_enabled) }}"
  1548. # If someone instals Prometheus via the playbook, they most likely wish to monitor Synapse.
  1549. matrix_synapse_metrics_enabled: "{{ matrix_prometheus_enabled }}"
  1550. matrix_synapse_email_enabled: "{{ matrix_mailer_enabled }}"
  1551. matrix_synapse_email_smtp_host: "matrix-mailer"
  1552. matrix_synapse_email_smtp_port: 8025
  1553. matrix_synapse_email_smtp_require_transport_security: false
  1554. matrix_synapse_email_notif_from: "Matrix <{{ matrix_mailer_sender_address }}>"
  1555. # Even if TURN doesn't support TLS (it does by default),
  1556. # it doesn't hurt to try a secure connection anyway.
  1557. #
  1558. # When Let's Encrypt certificates are used (the default case),
  1559. # we don't enable `turns` endpoints, because WebRTC in Element can't talk to them.
  1560. # Learn more here: https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1145
  1561. matrix_synapse_turn_uris: |
  1562. {{
  1563. []
  1564. +
  1565. [
  1566. 'turns:' + matrix_server_fqn_matrix + '?transport=udp',
  1567. 'turns:' + matrix_server_fqn_matrix + '?transport=tcp',
  1568. ] if matrix_coturn_enabled and matrix_coturn_tls_enabled and matrix_ssl_retrieval_method != 'lets-encrypt' else []
  1569. +
  1570. [
  1571. 'turn:' + matrix_server_fqn_matrix + '?transport=udp',
  1572. 'turn:' + matrix_server_fqn_matrix + '?transport=tcp',
  1573. ] if matrix_coturn_enabled else []
  1574. }}
  1575. matrix_synapse_turn_shared_secret: "{{ matrix_coturn_turn_static_auth_secret if matrix_coturn_enabled else '' }}"
  1576. matrix_synapse_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1577. matrix_synapse_systemd_required_services_list: |
  1578. {{
  1579. (['docker.service'])
  1580. +
  1581. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1582. +
  1583. (['matrix-goofys'] if matrix_s3_media_store_enabled else [])
  1584. }}
  1585. matrix_synapse_systemd_wanted_services_list: |
  1586. {{
  1587. (['matrix-coturn.service'] if matrix_coturn_enabled else [])
  1588. +
  1589. (['matrix-mailer.service'] if matrix_mailer_enabled else [])
  1590. }}
  1591. # Synapse workers (used for parallel load-scaling) need Redis for IPC.
  1592. matrix_synapse_redis_enabled: "{{ matrix_redis_enabled }}"
  1593. matrix_synapse_redis_host: "{{ 'matrix-redis' if matrix_redis_enabled else '' }}"
  1594. matrix_synapse_redis_password: "{{ matrix_redis_connection_password if matrix_redis_enabled else '' }}"
  1595. ######################################################################
  1596. #
  1597. # /matrix-synapse
  1598. #
  1599. ######################################################################
  1600. ######################################################################
  1601. #
  1602. # matrix-synapse-admin
  1603. #
  1604. ######################################################################
  1605. matrix_synapse_admin_enabled: false
  1606. # Normally, matrix-nginx-proxy is enabled and nginx can reach Synapse Admin over the container network.
  1607. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1608. # Synapse Admin's HTTP port to the local host.
  1609. matrix_synapse_admin_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8766' }}"
  1610. matrix_synapse_admin_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1611. ######################################################################
  1612. #
  1613. # /matrix-synapse-admin
  1614. #
  1615. ######################################################################
  1616. ######################################################################
  1617. #
  1618. # matrix-prometheus-node-exporter
  1619. #
  1620. ######################################################################
  1621. matrix_prometheus_node_exporter_enabled: false
  1622. ######################################################################
  1623. #
  1624. # /matrix-prometheus-node-exporter
  1625. #
  1626. ######################################################################
  1627. ######################################################################
  1628. #
  1629. # matrix-prometheus
  1630. #
  1631. ######################################################################
  1632. matrix_prometheus_enabled: false
  1633. # Normally, matrix-nginx-proxy is enabled and nginx can reach Prometheus over the container network.
  1634. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1635. # Prometheus' HTTP port to the local host.
  1636. matrix_prometheus_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9090' }}"
  1637. matrix_prometheus_scraper_synapse_enabled: "{{ matrix_synapse_enabled and matrix_synapse_metrics_enabled }}"
  1638. matrix_prometheus_scraper_synapse_targets: ['matrix-synapse:{{ matrix_synapse_metrics_port }}']
  1639. matrix_prometheus_scraper_synapse_workers_enabled_list: "{{ matrix_synapse_workers_enabled_list }}"
  1640. matrix_prometheus_scraper_synapse_rules_synapse_tag: "{{ matrix_synapse_docker_image_tag }}"
  1641. matrix_prometheus_scraper_node_enabled: "{{ matrix_prometheus_node_exporter_enabled }}"
  1642. matrix_prometheus_scraper_node_targets: "{{ ['matrix-prometheus-node-exporter:9100'] if matrix_prometheus_node_exporter_enabled else [] }}"
  1643. matrix_prometheus_scraper_postgres_enabled: "{{ matrix_prometheus_postgres_exporter_enabled }}"
  1644. matrix_prometheus_scraper_postgres_targets: "{{ ['matrix-prometheus-postgres-exporter:'+ matrix_prometheus_postgres_exporter_port|string] if matrix_prometheus_scraper_postgres_enabled else [] }}"
  1645. ######################################################################
  1646. #
  1647. # /matrix-prometheus
  1648. #
  1649. ######################################################################
  1650. ######################################################################
  1651. #
  1652. # matrix-prometheus-postgres-exporter
  1653. #
  1654. ######################################################################
  1655. matrix_prometheus_postgres_exporter_enabled: false
  1656. matrix_prometheus_postgres_exporter_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'prometheus.pg.db') | to_uuid }}"
  1657. matrix_prometheus_postgres_exporter_systemd_required_services_list: |
  1658. {{
  1659. ['docker.service']
  1660. +
  1661. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1662. }}
  1663. ######################################################################
  1664. #
  1665. # /matrix-prometheus-postgres-exporter
  1666. #
  1667. ######################################################################
  1668. ######################################################################
  1669. #
  1670. # matrix-grafana
  1671. #
  1672. ######################################################################
  1673. matrix_grafana_enabled: false
  1674. # Normally, matrix-nginx-proxy is enabled and nginx can reach Grafana over the container network.
  1675. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1676. # Grafana's HTTP port to the local host.
  1677. matrix_grafana_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:3000' }}"
  1678. matrix_grafana_dashboard_download_urls_all: |
  1679. {{
  1680. matrix_grafana_dashboard_download_urls
  1681. +
  1682. (matrix_prometheus_postgres_exporter_dashboard_urls if matrix_prometheus_postgres_exporter_enabled else [])
  1683. }}
  1684. matrix_grafana_systemd_wanted_services_list: |
  1685. {{
  1686. []
  1687. +
  1688. (['matrix-prometheus-postgres-exporter.service'] if matrix_prometheus_postgres_exporter_enabled else [])
  1689. }}
  1690. ######################################################################
  1691. #
  1692. # /matrix-grafana
  1693. #
  1694. ######################################################################
  1695. ######################################################################
  1696. #
  1697. # matrix-registration
  1698. #
  1699. ######################################################################
  1700. matrix_registration_enabled: false
  1701. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-registration over the container network.
  1702. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1703. # matrix-registration's HTTP port to the local host.
  1704. matrix_registration_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8767' }}"
  1705. matrix_registration_riot_instance: "{{ ('https://' + matrix_server_fqn_element) if matrix_client_element_enabled else 'https://riot.im/app/' }}"
  1706. matrix_registration_shared_secret: |-
  1707. {{
  1708. {
  1709. 'synapse': matrix_synapse_registration_shared_secret,
  1710. 'dendrite': matrix_dendrite_registration_shared_secret,
  1711. }[matrix_homeserver_implementation]
  1712. }}
  1713. matrix_registration_server_location: "{{ matrix_homeserver_container_url }}"
  1714. matrix_registration_api_validate_certs: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1715. matrix_registration_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1716. matrix_registration_systemd_required_services_list: |
  1717. {{
  1718. ['docker.service']
  1719. +
  1720. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1721. }}
  1722. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  1723. matrix_registration_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  1724. matrix_registration_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mx.registr.db') | to_uuid }}"
  1725. ######################################################################
  1726. #
  1727. # /matrix-registration
  1728. #
  1729. ######################################################################
  1730. ######################################################################
  1731. #
  1732. # matrix-postgres-backup
  1733. #
  1734. ######################################################################
  1735. matrix_postgres_backup_connection_hostname: "{{ matrix_postgres_connection_hostname }}"
  1736. matrix_postgres_backup_connection_port: "{{ matrix_postgres_connection_port }}"
  1737. matrix_postgres_backup_connection_username: "{{ matrix_postgres_connection_username }}"
  1738. matrix_postgres_backup_connection_password: "{{ matrix_postgres_connection_password }}"
  1739. matrix_postgres_backup_postgres_data_path: "{{ matrix_postgres_data_path if matrix_postgres_enabled else '' }}"
  1740. # 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
  1741. matrix_postgres_backup_databases: |
  1742. {{
  1743. (([{
  1744. 'name': matrix_synapse_database_database
  1745. }] if (matrix_synapse_enabled and matrix_synapse_database_database == matrix_postgres_db_name and matrix_synapse_database_host == 'matrix-postgres') else [])
  1746. +
  1747. matrix_postgres_additional_databases)|map(attribute='name')|list
  1748. }}
  1749. ######################################################################
  1750. #
  1751. # /matrix-postgres-backup
  1752. #
  1753. ######################################################################
  1754. ######################################################################
  1755. #
  1756. # matrix-dendrite
  1757. #
  1758. ######################################################################
  1759. matrix_dendrite_enabled: "{{ matrix_homeserver_implementation == 'dendrite' }}"
  1760. # Normally, matrix-nginx-proxy is enabled and nginx can reach Dendrite over the container network.
  1761. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it,
  1762. # you can expose Dendrite's ports to the host.
  1763. #
  1764. # For exposing Dendrite's plain HTTP server to the local host.
  1765. matrix_dendrite_container_http_host_bind_address: "{{ '' if matrix_nginx_proxy_enabled else ('127.0.0.1:' + matrix_dendrite_http_bind_port|string) }}"
  1766. #
  1767. # For exposing Dendrite's HTTPS server to the local host.
  1768. 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) }}"
  1769. matrix_dendrite_sync_api_real_ip_header: "{{ 'X-Forwarded-For' if matrix_nginx_proxy_enabled else '' }}"
  1770. matrix_dendrite_registration_shared_secret: "{{ matrix_homeserver_generic_secret_key | password_hash('sha512', 'dendrite.rss') | to_uuid }}"
  1771. matrix_dendrite_database_password: "{{ matrix_homeserver_generic_secret_key | password_hash('sha512', 'dendrite.db') | to_uuid }}"
  1772. # Even if TURN doesn't support TLS (it does by default),
  1773. # it doesn't hurt to try a secure connection anyway.
  1774. matrix_dendrite_turn_uris: |
  1775. {{
  1776. [
  1777. 'turns:' + matrix_server_fqn_matrix + '?transport=udp',
  1778. 'turns:' + matrix_server_fqn_matrix + '?transport=tcp',
  1779. 'turn:' + matrix_server_fqn_matrix + '?transport=udp',
  1780. 'turn:' + matrix_server_fqn_matrix + '?transport=tcp',
  1781. ]
  1782. if matrix_coturn_enabled
  1783. else []
  1784. }}
  1785. matrix_dendrite_turn_shared_secret: "{{ matrix_coturn_turn_static_auth_secret if matrix_coturn_enabled else '' }}"
  1786. matrix_dendrite_disable_tls_validation: "{{ true if matrix_ssl_retrieval_method == 'self-signed' else false }}"
  1787. matrix_dendrite_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1788. matrix_dendrite_trusted_id_servers: "{{ [matrix_server_fqn_matrix] if matrix_ma1sd_enabled else ['matrix.org', 'vector.im'] }}"
  1789. matrix_dendrite_systemd_required_services_list: |
  1790. {{
  1791. (['docker.service'])
  1792. +
  1793. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1794. +
  1795. (['matrix-goofys'] if matrix_s3_media_store_enabled else [])
  1796. }}
  1797. matrix_dendrite_systemd_wanted_services_list: |
  1798. {{
  1799. (['matrix-coturn.service'] if matrix_coturn_enabled else [])
  1800. }}
  1801. ######################################################################
  1802. #
  1803. # /matrix-dendrite
  1804. #
  1805. ######################################################################