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

2281 строка
99 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. ######################################################################
  34. #
  35. # /matrix-base
  36. #
  37. ######################################################################
  38. ######################################################################
  39. #
  40. # matrix-awx
  41. #
  42. ######################################################################
  43. # We don't enable AWX support by default.
  44. matrix_awx_enabled: false
  45. 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') }}"
  46. 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' }}"
  47. matrix_nginx_proxy_data_path_extension: "{{ '' if (matrix_awx_enabled and not matrix_nginx_proxy_base_domain_homepage_enabled) else '/matrix-domain' }}"
  48. matrix_nginx_proxy_base_domain_create_directory: "{{ not matrix_awx_enabled }}"
  49. ######################################################################
  50. #
  51. # /matrix-awx
  52. #
  53. ######################################################################
  54. ######################################################################
  55. #
  56. # matrix-bridge-appservice-discord
  57. #
  58. ######################################################################
  59. # We don't enable bridges by default.
  60. matrix_appservice_discord_enabled: false
  61. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-discord over the container network.
  62. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  63. # matrix-appservice-discord's client-server port to the local host.
  64. matrix_appservice_discord_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9005' }}"
  65. # If the homeserver disables presence, it's likely better (less wasteful) to also disable presence on the bridge side.
  66. matrix_appservice_discord_bridge_disablePresence: "{{ not matrix_synapse_presence_enabled }}"
  67. matrix_appservice_discord_systemd_required_services_list: |
  68. {{
  69. ['docker.service']
  70. +
  71. ['matrix-' + matrix_homeserver_implementation + '.service']
  72. +
  73. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  74. +
  75. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  76. }}
  77. matrix_appservice_discord_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'discord.as.token') | to_uuid }}"
  78. matrix_appservice_discord_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'discord.hs.token') | to_uuid }}"
  79. # We only make this use Postgres if our own Postgres server is enabled.
  80. # It's only then (for now) that we can automatically create the necessary database and user for this service.
  81. matrix_appservice_discord_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  82. matrix_appservice_discord_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'as.discord.db') | to_uuid }}"
  83. ######################################################################
  84. #
  85. # /matrix-bridge-appservice-discord
  86. #
  87. ######################################################################
  88. ######################################################################
  89. #
  90. # matrix-appservice-webhooks
  91. #
  92. ######################################################################
  93. # We don't enable bridges by default.
  94. matrix_appservice_webhooks_enabled: false
  95. matrix_appservice_webhooks_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  96. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-webhooks over the container network.
  97. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  98. # matrix-appservice-webhooks' client-server port to the local host.
  99. matrix_appservice_webhooks_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else ('127.0.0.1:' ~ matrix_appservice_webhooks_matrix_port) }}"
  100. matrix_appservice_webhooks_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'webhook.as.token') | to_uuid }}"
  101. matrix_appservice_webhooks_homeserver_url: "{{ matrix_homeserver_container_url }}"
  102. matrix_appservice_webhooks_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'webhook.hs.token') | to_uuid }}"
  103. matrix_appservice_webhooks_id_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'webhook.id.token') | to_uuid }}"
  104. matrix_appservice_webhooks_systemd_required_services_list: |
  105. {{
  106. ['docker.service']
  107. +
  108. ['matrix-' + matrix_homeserver_implementation + '.service']
  109. +
  110. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  111. }}
  112. ######################################################################
  113. #
  114. # /matrix-appservice-webhooks
  115. #
  116. ######################################################################
  117. ######################################################################
  118. #
  119. # matrix-appservice-slack
  120. #
  121. ######################################################################
  122. # We don't enable bridges by default.
  123. matrix_appservice_slack_enabled: false
  124. matrix_appservice_slack_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  125. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-slack over the container network.
  126. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  127. # matrix-appservice-slack's client-server port to the local host.
  128. matrix_appservice_slack_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else ('127.0.0.1:' ~ matrix_appservice_slack_slack_port) }}"
  129. matrix_appservice_slack_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'slack.as.token') | to_uuid }}"
  130. matrix_appservice_slack_homeserver_url: "{{ matrix_homeserver_container_url }}"
  131. matrix_appservice_slack_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'slack.hs.token') | to_uuid }}"
  132. matrix_appservice_slack_id_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'slack.id.token') | to_uuid }}"
  133. matrix_appservice_slack_systemd_required_services_list: |
  134. {{
  135. ['docker.service']
  136. +
  137. ['matrix-' + matrix_homeserver_implementation + '.service']
  138. +
  139. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  140. }}
  141. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  142. matrix_appservice_slack_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'nedb' }}"
  143. matrix_appservice_slack_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'as.slack.db') | to_uuid }}"
  144. ######################################################################
  145. #
  146. # /matrix-bridge-appservice-slack
  147. #
  148. ######################################################################
  149. ######################################################################
  150. #
  151. # matrix-bridge-appservice-irc
  152. #
  153. ######################################################################
  154. # We don't enable bridges by default.
  155. matrix_appservice_irc_enabled: false
  156. matrix_appservice_irc_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  157. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-irc over the container network.
  158. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  159. # matrix-appservice-irc's client-server port to the local host.
  160. matrix_appservice_irc_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9999' }}"
  161. # The IRC bridge docs say that if homeserver presence is disabled, it's better to also disable
  162. # IRC bridge presence, for performance reasons.
  163. matrix_appservice_irc_homeserver_enablePresence: "{{ matrix_synapse_presence_enabled }}"
  164. matrix_appservice_irc_systemd_required_services_list: |
  165. {{
  166. ['docker.service']
  167. +
  168. ['matrix-' + matrix_homeserver_implementation + '.service']
  169. +
  170. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  171. }}
  172. matrix_appservice_irc_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'irc.as.token') | to_uuid }}"
  173. matrix_appservice_irc_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'irc.hs.token') | to_uuid }}"
  174. matrix_appservice_irc_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'nedb' }}"
  175. matrix_appservice_irc_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'as.irc.db') | to_uuid }}"
  176. ######################################################################
  177. #
  178. # /matrix-bridge-appservice-irc
  179. #
  180. ######################################################################
  181. ######################################################################
  182. #
  183. # matrix-bridge-beeper-linkedin
  184. #
  185. ######################################################################
  186. # We don't enable bridges by default.
  187. matrix_beeper_linkedin_enabled: false
  188. matrix_beeper_linkedin_container_image_self_build: "{{ matrix_architecture not in ['amd64'] }}"
  189. matrix_beeper_linkedin_systemd_required_services_list: |
  190. {{
  191. ['docker.service']
  192. +
  193. ['matrix-' + matrix_homeserver_implementation + '.service']
  194. +
  195. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  196. +
  197. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  198. }}
  199. matrix_beeper_linkedin_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'linked.as.token') | to_uuid }}"
  200. matrix_beeper_linkedin_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'linked.hs.token') | to_uuid }}"
  201. 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 '' }}"
  202. matrix_beeper_linkedin_bridge_presence: "{{ matrix_synapse_presence_enabled if matrix_synapse_enabled else true }}"
  203. matrix_beeper_linkedin_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'maulinkedin.db') | to_uuid }}"
  204. ######################################################################
  205. #
  206. # /matrix-bridge-beeper-linkedin
  207. #
  208. ######################################################################
  209. ######################################################################
  210. #
  211. # matrix-bridge-mautrix-facebook
  212. #
  213. ######################################################################
  214. # We don't enable bridges by default.
  215. matrix_mautrix_facebook_enabled: false
  216. matrix_mautrix_facebook_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  217. matrix_mautrix_facebook_systemd_required_services_list: |
  218. {{
  219. ['docker.service']
  220. +
  221. ['matrix-' + matrix_homeserver_implementation + '.service']
  222. +
  223. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  224. +
  225. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  226. }}
  227. matrix_mautrix_facebook_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'fb.as.token') | to_uuid }}"
  228. matrix_mautrix_facebook_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'fb.hs.token') | to_uuid }}"
  229. 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 '' }}"
  230. matrix_mautrix_facebook_bridge_presence: "{{ matrix_synapse_presence_enabled if matrix_synapse_enabled else true }}"
  231. # We'd like to force-set people with external Postgres to SQLite, so the bridge role can complain
  232. # and point them to a migration path.
  233. matrix_mautrix_facebook_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  234. matrix_mautrix_facebook_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mau.fb.db') | to_uuid }}"
  235. ######################################################################
  236. #
  237. # /matrix-bridge-mautrix-facebook
  238. #
  239. ######################################################################
  240. ######################################################################
  241. #
  242. # matrix-bridge-mautrix-hangouts
  243. #
  244. ######################################################################
  245. # We don't enable bridges by default.
  246. matrix_mautrix_hangouts_enabled: false
  247. matrix_mautrix_hangouts_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  248. matrix_mautrix_hangouts_systemd_required_services_list: |
  249. {{
  250. ['docker.service']
  251. +
  252. ['matrix-' + matrix_homeserver_implementation + '.service']
  253. +
  254. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  255. +
  256. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  257. }}
  258. matrix_mautrix_hangouts_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'ho.as.token') | to_uuid }}"
  259. matrix_mautrix_hangouts_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'ho.hs.token') | to_uuid }}"
  260. matrix_mautrix_hangouts_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9007' }}"
  261. 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 '' }}"
  262. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  263. matrix_mautrix_hangouts_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  264. matrix_mautrix_hangouts_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mau.hangouts.db') | to_uuid }}"
  265. ######################################################################
  266. #
  267. # /matrix-bridge-mautrix-hangouts
  268. #
  269. ######################################################################
  270. ######################################################################
  271. #
  272. # matrix-bridge-mautrix-googlechat
  273. #
  274. ######################################################################
  275. # We don't enable bridges by default.
  276. matrix_mautrix_googlechat_enabled: false
  277. matrix_mautrix_googlechat_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  278. matrix_mautrix_googlechat_systemd_required_services_list: |
  279. {{
  280. ['docker.service']
  281. +
  282. ['matrix-' + matrix_homeserver_implementation + '.service']
  283. +
  284. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  285. +
  286. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  287. }}
  288. matrix_mautrix_googlechat_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'gc.as.token') | to_uuid }}"
  289. matrix_mautrix_googlechat_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'gc.hs.token') | to_uuid }}"
  290. matrix_mautrix_googlechat_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9007' }}"
  291. 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 '' }}"
  292. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  293. matrix_mautrix_googlechat_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  294. matrix_mautrix_googlechat_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mau.gc.db') | to_uuid }}"
  295. ######################################################################
  296. #
  297. # /matrix-bridge-mautrix-googlechat
  298. #
  299. ######################################################################
  300. ######################################################################
  301. #
  302. # matrix-bridge-mautrix-instagram
  303. #
  304. ######################################################################
  305. # We don't enable bridges by default.
  306. matrix_mautrix_instagram_enabled: false
  307. matrix_mautrix_instagram_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  308. matrix_mautrix_instagram_systemd_required_services_list: |
  309. {{
  310. ['docker.service']
  311. +
  312. ['matrix-' + matrix_homeserver_implementation + '.service']
  313. +
  314. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  315. +
  316. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  317. }}
  318. matrix_mautrix_instagram_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'ig.as.token') | to_uuid }}"
  319. matrix_mautrix_instagram_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'ig.hs.token') | to_uuid }}"
  320. 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 '' }}"
  321. matrix_mautrix_instagram_bridge_presence: "{{ matrix_synapse_presence_enabled if matrix_synapse_enabled else true }}"
  322. # We'd like to force-set people with external Postgres to SQLite, so the bridge role can complain
  323. # and point them to a migration path.
  324. matrix_mautrix_instagram_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  325. matrix_mautrix_instagram_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mau.ig.db') | to_uuid }}"
  326. ######################################################################
  327. #
  328. # /matrix-bridge-mautrix-instagram
  329. #
  330. ######################################################################
  331. ######################################################################
  332. #
  333. # matrix-bridge-mautrix-signal
  334. #
  335. ######################################################################
  336. # We don't enable bridges by default.
  337. matrix_mautrix_signal_enabled: false
  338. matrix_mautrix_signal_systemd_required_services_list: |
  339. {{
  340. ['docker.service']
  341. +
  342. ['matrix-' + matrix_homeserver_implementation + '.service']
  343. +
  344. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  345. +
  346. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  347. +
  348. ['matrix-mautrix-signal-daemon.service']
  349. }}
  350. matrix_mautrix_signal_homeserver_domain: '{{ matrix_domain }}'
  351. matrix_mautrix_signal_homeserver_address: "{{ matrix_homeserver_container_url }}"
  352. matrix_mautrix_signal_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'si.hs.token') | to_uuid }}"
  353. matrix_mautrix_signal_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'si.as.token') | to_uuid }}"
  354. 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 '' }}"
  355. matrix_mautrix_signal_database_engine: 'postgres'
  356. matrix_mautrix_signal_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mau.signal.db') | to_uuid }}"
  357. matrix_mautrix_signal_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  358. matrix_mautrix_signal_daemon_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  359. ######################################################################
  360. #
  361. # /matrix-bridge-mautrix-signal
  362. #
  363. ######################################################################
  364. ######################################################################
  365. #
  366. # matrix-bridge-mautrix-telegram
  367. #
  368. ######################################################################
  369. # We don't enable bridges by default.
  370. matrix_mautrix_telegram_enabled: false
  371. # Images are multi-arch (amd64 and arm64, but not arm32).
  372. matrix_mautrix_telegram_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  373. matrix_telegram_lottieconverter_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  374. matrix_telegram_lottieconverter_container_image_self_build_mask_arch: "{{ matrix_architecture != 'amd64' }}"
  375. matrix_mautrix_telegram_systemd_required_services_list: |
  376. {{
  377. ['docker.service']
  378. +
  379. ['matrix-' + matrix_homeserver_implementation + '.service']
  380. +
  381. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  382. +
  383. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  384. }}
  385. matrix_mautrix_telegram_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'telegr.as.token') | to_uuid }}"
  386. matrix_mautrix_telegram_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'telegr.hs.token') | to_uuid }}"
  387. matrix_mautrix_telegram_public_endpoint: "/{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'telegram') | to_uuid }}"
  388. matrix_mautrix_telegram_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9006' }}"
  389. 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 '' }}"
  390. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  391. matrix_mautrix_telegram_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  392. matrix_mautrix_telegram_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mau.telegram.db') | to_uuid }}"
  393. ######################################################################
  394. #
  395. # /matrix-bridge-mautrix-telegram
  396. #
  397. ######################################################################
  398. ######################################################################
  399. #
  400. # matrix-bridge-mautrix-twitter
  401. #
  402. ######################################################################
  403. # We don't enable bridges by default.
  404. matrix_mautrix_twitter_enabled: false
  405. matrix_mautrix_twitter_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
  406. matrix_mautrix_twitter_systemd_required_services_list: |
  407. {{
  408. ['docker.service']
  409. +
  410. ['matrix-' + matrix_homeserver_implementation + '.service']
  411. +
  412. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  413. +
  414. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  415. }}
  416. matrix_mautrix_twitter_appservice_token: "{{ matrix_homeserver_generic_secret_key | password_hash('sha512', 'twt.as.token') | to_uuid }}"
  417. matrix_mautrix_twitter_homeserver_token: "{{ matrix_homeserver_generic_secret_key | password_hash('sha512', 'twt.hs.token') | to_uuid }}"
  418. 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 '' }}"
  419. # We'd like to force-set people with external Postgres to SQLite, so the bridge role can complain
  420. # and point them to a migration path.
  421. matrix_mautrix_twitter_database_engine: "{{ 'postgres' if matrix_postgres_enabled else '' }}"
  422. matrix_mautrix_twitter_database_password: "{{ matrix_homeserver_generic_secret_key | password_hash('sha512', 'mau.twt.db') | to_uuid }}"
  423. ######################################################################
  424. #
  425. # /matrix-bridge-mautrix-twitter
  426. #
  427. ######################################################################
  428. ######################################################################
  429. #
  430. # matrix-bridge-mautrix-whatsapp
  431. #
  432. ######################################################################
  433. # We don't enable bridges by default.
  434. matrix_mautrix_whatsapp_enabled: false
  435. matrix_mautrix_whatsapp_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  436. matrix_mautrix_whatsapp_systemd_required_services_list: |
  437. {{
  438. ['docker.service']
  439. +
  440. ['matrix-' + matrix_homeserver_implementation + '.service']
  441. +
  442. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  443. +
  444. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  445. }}
  446. matrix_mautrix_whatsapp_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'whats.as.token') | to_uuid }}"
  447. matrix_mautrix_whatsapp_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'whats.hs.token') | to_uuid }}"
  448. matrix_mautrix_whatsapp_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
  449. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  450. matrix_mautrix_whatsapp_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  451. matrix_mautrix_whatsapp_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mauwhatsapp.db') | to_uuid }}"
  452. ######################################################################
  453. #
  454. # /matrix-bridge-mautrix-whatsapp
  455. #
  456. ######################################################################
  457. ######################################################################
  458. #
  459. # matrix-sms-bridge
  460. #
  461. ######################################################################
  462. # We don't enable bridges by default.
  463. matrix_sms_bridge_enabled: false
  464. matrix_sms_bridge_systemd_required_services_list: |
  465. {{
  466. ['docker.service']
  467. +
  468. ['matrix-' + matrix_homeserver_implementation + '.service']
  469. +
  470. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  471. }}
  472. matrix_sms_bridge_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'sms.as.token') | to_uuid }}"
  473. matrix_sms_bridge_homeserver_port: "{{ matrix_synapse_container_client_api_port }}"
  474. matrix_sms_bridge_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'sms.hs.token') | to_uuid }}"
  475. ######################################################################
  476. #
  477. # /matrix-sms-bridge
  478. #
  479. ######################################################################
  480. ######################################################################
  481. #
  482. # matrix-bridge-heisenbridge
  483. #
  484. ######################################################################
  485. # We don't enable bridges by default.
  486. matrix_heisenbridge_enabled: false
  487. matrix_heisenbridge_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'heisen.as.tok') | to_uuid }}"
  488. matrix_heisenbridge_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'heisen.hs.tok') | to_uuid }}"
  489. matrix_heisenbridge_systemd_wanted_services_list: |
  490. {{
  491. ['matrix-' + matrix_homeserver_implementation + '.service']
  492. +
  493. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  494. }}
  495. ######################################################################
  496. #
  497. # /matrix-bridge-heisenbridge
  498. #
  499. ######################################################################
  500. ######################################################################
  501. #
  502. # matrix-bridge-mx-puppet-skype
  503. #
  504. ######################################################################
  505. # We don't enable bridges by default.
  506. matrix_mx_puppet_skype_enabled: false
  507. matrix_mx_puppet_skype_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  508. matrix_mx_puppet_skype_systemd_required_services_list: |
  509. {{
  510. ['docker.service']
  511. +
  512. ['matrix-' + matrix_homeserver_implementation + '.service']
  513. +
  514. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  515. +
  516. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  517. }}
  518. matrix_mx_puppet_skype_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'skype.as.tok') | to_uuid }}"
  519. matrix_mx_puppet_skype_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'skype.hs.tok') | to_uuid }}"
  520. 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 '' }}"
  521. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  522. matrix_mx_puppet_skype_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  523. matrix_mx_puppet_skype_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.skype.db') | to_uuid }}"
  524. ######################################################################
  525. #
  526. # /matrix-bridge-mx-puppet-skype
  527. #
  528. ######################################################################
  529. ######################################################################
  530. #
  531. # matrix-bridge-mx-puppet-slack
  532. #
  533. ######################################################################
  534. # We don't enable bridges by default.
  535. matrix_mx_puppet_slack_enabled: false
  536. matrix_mx_puppet_slack_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  537. matrix_mx_puppet_slack_systemd_required_services_list: |
  538. {{
  539. ['docker.service']
  540. +
  541. ['matrix-' + matrix_homeserver_implementation + '.service']
  542. +
  543. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  544. +
  545. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  546. }}
  547. matrix_mx_puppet_slack_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxslk.as.tok') | to_uuid }}"
  548. matrix_mx_puppet_slack_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxslk.hs.tok') | to_uuid }}"
  549. 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 '' }}"
  550. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  551. matrix_mx_puppet_slack_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  552. matrix_mx_puppet_slack_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.slack.db') | to_uuid }}"
  553. ######################################################################
  554. #
  555. # /matrix-bridge-mx-puppet-slack
  556. #
  557. ######################################################################
  558. ######################################################################
  559. #
  560. # matrix-bridge-mx-puppet-twitter
  561. #
  562. ######################################################################
  563. # We don't enable bridges by default.
  564. matrix_mx_puppet_twitter_enabled: false
  565. matrix_mx_puppet_twitter_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  566. matrix_mx_puppet_twitter_systemd_required_services_list: |
  567. {{
  568. ['docker.service']
  569. +
  570. ['matrix-' + matrix_homeserver_implementation + '.service']
  571. +
  572. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  573. +
  574. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  575. }}
  576. matrix_mx_puppet_twitter_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxtwt.as.tok') | to_uuid }}"
  577. matrix_mx_puppet_twitter_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxtwt.hs.tok') | to_uuid }}"
  578. 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 '' }}"
  579. 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) }}"
  580. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  581. matrix_mx_puppet_twitter_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  582. matrix_mx_puppet_twitter_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.twitter.db') | to_uuid }}"
  583. ######################################################################
  584. #
  585. # /matrix-bridge-mx-puppet-twitter
  586. #
  587. ######################################################################
  588. ######################################################################
  589. #
  590. # matrix-bridge-mx-puppet-instagram
  591. #
  592. ######################################################################
  593. # We don't enable bridges by default.
  594. matrix_mx_puppet_instagram_enabled: false
  595. matrix_mx_puppet_instagram_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  596. matrix_mx_puppet_instagram_systemd_required_services_list: |
  597. {{
  598. ['docker.service']
  599. +
  600. ['matrix-' + matrix_homeserver_implementation + '.service']
  601. +
  602. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  603. +
  604. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  605. }}
  606. matrix_mx_puppet_instagram_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxig.as.tok') | to_uuid }}"
  607. matrix_mx_puppet_instagram_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxig.hs.tok') | to_uuid }}"
  608. 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 '' }}"
  609. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  610. matrix_mx_puppet_instagram_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  611. matrix_mx_puppet_instagram_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.ig.db') | to_uuid }}"
  612. ######################################################################
  613. #
  614. # /matrix-bridge-mx-puppet-instagram
  615. #
  616. ######################################################################
  617. ######################################################################
  618. #
  619. # matrix-bridge-mx-puppet-discord
  620. #
  621. ######################################################################
  622. # We don't enable bridges by default.
  623. matrix_mx_puppet_discord_enabled: false
  624. matrix_mx_puppet_discord_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  625. matrix_mx_puppet_discord_systemd_required_services_list: |
  626. {{
  627. ['docker.service']
  628. +
  629. ['matrix-' + matrix_homeserver_implementation + '.service']
  630. +
  631. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  632. +
  633. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  634. }}
  635. matrix_mx_puppet_discord_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxdsc.as.tok') | to_uuid }}"
  636. matrix_mx_puppet_discord_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxdsc.hs.tok') | to_uuid }}"
  637. 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 '' }}"
  638. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  639. matrix_mx_puppet_discord_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  640. matrix_mx_puppet_discord_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.dsc.db') | to_uuid }}"
  641. ######################################################################
  642. #
  643. # /matrix-bridge-mx-puppet-discord
  644. #
  645. ######################################################################
  646. ######################################################################
  647. #
  648. # matrix-bridge-mx-puppet-steam
  649. #
  650. ######################################################################
  651. # We don't enable bridges by default.
  652. matrix_mx_puppet_steam_enabled: false
  653. matrix_mx_puppet_steam_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  654. matrix_mx_puppet_steam_systemd_required_services_list: |
  655. {{
  656. ['docker.service']
  657. +
  658. ['matrix-' + matrix_homeserver_implementation + '.service']
  659. +
  660. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  661. +
  662. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  663. }}
  664. matrix_mx_puppet_steam_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxste.as.tok') | to_uuid }}"
  665. matrix_mx_puppet_steam_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxste.hs.tok') | to_uuid }}"
  666. 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 '' }}"
  667. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  668. matrix_mx_puppet_steam_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  669. matrix_mx_puppet_steam_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.steam.db') | to_uuid }}"
  670. ######################################################################
  671. #
  672. # /matrix-bridge-mx-puppet-steam
  673. #
  674. ######################################################################
  675. ######################################################################
  676. #
  677. # matrix-bridge-mx-puppet-groupme
  678. #
  679. ######################################################################
  680. # We don't enable bridges by default.
  681. matrix_mx_puppet_groupme_enabled: false
  682. matrix_mx_puppet_groupme_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  683. matrix_mx_puppet_groupme_systemd_required_services_list: |
  684. {{
  685. ['docker.service']
  686. +
  687. ['matrix-' + matrix_homeserver_implementation + '.service']
  688. +
  689. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  690. +
  691. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  692. }}
  693. matrix_mx_puppet_groupme_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxgro.as.tok') | to_uuid }}"
  694. matrix_mx_puppet_groupme_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxgro.hs.tok') | to_uuid }}"
  695. 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 '' }}"
  696. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  697. matrix_mx_puppet_groupme_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  698. matrix_mx_puppet_groupme_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.groupme.db') | to_uuid }}"
  699. ######################################################################
  700. #
  701. # /matrix-bridge-mx-puppet-groupme
  702. #
  703. ######################################################################
  704. ######################################################################
  705. #
  706. # matrix-bot-matrix-reminder-bot
  707. #
  708. ######################################################################
  709. # We don't enable bots by default.
  710. matrix_bot_matrix_reminder_bot_enabled: false
  711. matrix_bot_matrix_reminder_bot_systemd_required_services_list: |
  712. {{
  713. ['docker.service']
  714. +
  715. ['matrix-' + matrix_homeserver_implementation + '.service']
  716. +
  717. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  718. +
  719. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  720. }}
  721. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  722. matrix_bot_matrix_reminder_bot_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  723. matrix_bot_matrix_reminder_bot_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'reminder.bot.db') | to_uuid }}"
  724. matrix_bot_matrix_reminder_bot_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  725. ######################################################################
  726. #
  727. # /matrix-bot-matrix-reminder-bot
  728. #
  729. ######################################################################
  730. ######################################################################
  731. #
  732. # matrix-bot-honoroit
  733. #
  734. ######################################################################
  735. # We don't enable bots by default.
  736. matrix_bot_honoroit_enabled: false
  737. matrix_bot_honoroit_systemd_required_services_list: |
  738. {{
  739. ['docker.service']
  740. +
  741. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  742. +
  743. (['matrix-synapse.service'] if matrix_synapse_enabled else [])
  744. +
  745. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  746. }}
  747. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  748. matrix_bot_honoroit_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  749. matrix_bot_honoroit_database_password: "{{ '%s' | format(matrix_synapse_macaroon_secret_key) | password_hash('sha512', 'honoroit.bot.db') | to_uuid }}"
  750. matrix_bot_honoroit_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  751. ######################################################################
  752. #
  753. # /matrix-bot-honoroit
  754. #
  755. ######################################################################
  756. ######################################################################
  757. #
  758. # matrix-bot-go-neb
  759. #
  760. ######################################################################
  761. # We don't enable bots by default.
  762. matrix_bot_go_neb_enabled: false
  763. matrix_bot_go_neb_systemd_required_services_list: |
  764. {{
  765. ['docker.service']
  766. +
  767. ['matrix-' + matrix_homeserver_implementation + '.service']
  768. +
  769. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  770. }}
  771. matrix_bot_go_neb_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:4050' }}"
  772. ######################################################################
  773. #
  774. # /matrix-bot-go-neb
  775. #
  776. ######################################################################
  777. ######################################################################
  778. #
  779. # matrix-bot-mjolnir
  780. #
  781. ######################################################################
  782. # We don't enable bots by default.
  783. matrix_bot_mjolnir_enabled: false
  784. matrix_bot_mjolnir_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  785. matrix_bot_mjolnir_systemd_required_services_list: |
  786. {{
  787. ['docker.service']
  788. +
  789. ['matrix-' + matrix_homeserver_implementation + '.service']
  790. +
  791. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  792. +
  793. (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
  794. }}
  795. ######################################################################
  796. #
  797. # /matrix-bot-mjolnir
  798. #
  799. ######################################################################
  800. ######################################################################
  801. #
  802. # matrix-corporal
  803. #
  804. ######################################################################
  805. matrix_corporal_enabled: false
  806. matrix_corporal_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  807. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-corporal over the container network.
  808. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  809. # matrix-corporal's web-server ports to the local host.
  810. matrix_corporal_container_http_gateway_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:41080' }}"
  811. matrix_corporal_container_http_api_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:41081' }}"
  812. matrix_corporal_systemd_required_services_list: |
  813. {{
  814. (['docker.service'])
  815. +
  816. (['matrix-' + matrix_homeserver_implementation + '.service'])
  817. }}
  818. matrix_corporal_matrix_homeserver_api_endpoint: "{{ matrix_homeserver_container_url }}"
  819. matrix_corporal_matrix_auth_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret }}"
  820. # This is only useful if there's REST auth provider to make use of it.
  821. matrix_corporal_http_gateway_internal_rest_auth_enabled: "{{ matrix_synapse_ext_password_provider_rest_auth_enabled }}"
  822. matrix_corporal_matrix_registration_shared_secret: "{{ matrix_synapse_registration_shared_secret }}"
  823. ######################################################################
  824. #
  825. # /matrix-corporal
  826. #
  827. ######################################################################
  828. ######################################################################
  829. #
  830. # matrix-coturn
  831. #
  832. ######################################################################
  833. matrix_coturn_enabled: true
  834. matrix_coturn_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
  835. matrix_coturn_turn_external_ip_address: "{{ ansible_host }}"
  836. matrix_coturn_turn_static_auth_secret: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'coturn.sas') | to_uuid }}"
  837. matrix_coturn_tls_enabled: "{{ matrix_ssl_retrieval_method != 'none' }}"
  838. matrix_coturn_tls_cert_path: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_server_fqn_matrix }}/fullchain.pem"
  839. matrix_coturn_tls_key_path: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_server_fqn_matrix }}/privkey.pem"
  840. matrix_coturn_container_additional_volumes: |
  841. {{
  842. ([] if matrix_ssl_retrieval_method == 'none' else [
  843. {
  844. 'src': matrix_ssl_config_dir_path,
  845. 'dst': matrix_ssl_config_dir_path,
  846. 'options': 'ro',
  847. }
  848. ])
  849. }}
  850. ######################################################################
  851. #
  852. # /matrix-coturn
  853. #
  854. ######################################################################
  855. ######################################################################
  856. #
  857. # matrix-dimension
  858. #
  859. ######################################################################
  860. matrix_dimension_enabled: false
  861. matrix_dimension_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  862. # Normally, matrix-nginx-proxy is enabled and nginx can reach Dimension over the container network.
  863. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  864. # the Dimension HTTP port to the local host.
  865. matrix_dimension_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8184' }}"
  866. matrix_dimension_homeserver_federationUrl: "{{ matrix_homeserver_container_federation_url }}"
  867. matrix_integration_manager_rest_url: "{{ matrix_dimension_integrations_rest_url if matrix_dimension_enabled else None }}"
  868. matrix_integration_manager_ui_url: "{{ matrix_dimension_integrations_ui_url if matrix_dimension_enabled else None }}"
  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-element.service'] if matrix_client_element_enabled else [])
  1120. }}
  1121. matrix_ssl_domains_to_obtain_certificates_for: |
  1122. {{
  1123. ([matrix_server_fqn_matrix])
  1124. +
  1125. ([matrix_server_fqn_element] if matrix_client_element_enabled else [])
  1126. +
  1127. ([matrix_nginx_proxy_proxy_riot_compat_redirect_hostname] if matrix_nginx_proxy_proxy_riot_compat_redirect_enabled else [])
  1128. +
  1129. ([matrix_server_fqn_hydrogen] if matrix_client_hydrogen_enabled else [])
  1130. +
  1131. ([matrix_server_fqn_cinny] if matrix_client_cinny_enabled else [])
  1132. +
  1133. ([matrix_server_fqn_dimension] if matrix_dimension_enabled else [])
  1134. +
  1135. ([matrix_server_fqn_bot_go_neb] if matrix_bot_go_neb_enabled else [])
  1136. +
  1137. ([matrix_server_fqn_jitsi] if matrix_jitsi_enabled else [])
  1138. +
  1139. ([matrix_server_fqn_grafana] if matrix_grafana_enabled else [])
  1140. +
  1141. ([matrix_server_fqn_sygnal] if matrix_sygnal_enabled else [])
  1142. +
  1143. ([matrix_domain] if matrix_nginx_proxy_base_domain_serving_enabled else [])
  1144. +
  1145. matrix_ssl_additional_domains_to_obtain_certificates_for
  1146. }}
  1147. matrix_ssl_architecture: "{{
  1148. {
  1149. 'amd64': 'amd64',
  1150. 'arm32': 'arm32v6',
  1151. 'arm64': 'arm64v8',
  1152. }[matrix_architecture]
  1153. }}"
  1154. matrix_ssl_pre_obtaining_required_service_name: "{{ 'matrix-dynamic-dns' if matrix_dynamic_dns_enabled else '' }}"
  1155. ######################################################################
  1156. #
  1157. # /matrix-nginx-proxy
  1158. #
  1159. ######################################################################
  1160. ######################################################################
  1161. #
  1162. # matrix-postgres
  1163. #
  1164. ######################################################################
  1165. matrix_postgres_enabled: true
  1166. matrix_postgres_architecture: "{{ matrix_architecture }}"
  1167. # We unset this if internal Postgres disabled, which will cascade to some other variables
  1168. # and tell users they need to set it (either here or in those variables).
  1169. matrix_postgres_connection_hostname: "{{ 'matrix-postgres' if matrix_postgres_enabled else '' }}"
  1170. matrix_postgres_pgloader_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1171. matrix_postgres_additional_databases: |
  1172. {{
  1173. ([{
  1174. 'name': matrix_synapse_database_database,
  1175. 'username': matrix_synapse_database_user,
  1176. 'password': matrix_synapse_database_password,
  1177. }] if (matrix_synapse_enabled and matrix_synapse_database_database != matrix_postgres_db_name and matrix_synapse_database_host == 'matrix-postgres') else [])
  1178. +
  1179. ([{
  1180. 'name': matrix_dendrite_naffka_database,
  1181. 'username': matrix_dendrite_database_user,
  1182. 'password': matrix_dendrite_database_password,
  1183. },{
  1184. 'name': matrix_dendrite_appservice_database,
  1185. 'username': matrix_dendrite_database_user,
  1186. 'password': matrix_dendrite_database_password,
  1187. },{
  1188. 'name': matrix_dendrite_federationsender_database,
  1189. 'username': matrix_dendrite_database_user,
  1190. 'password': matrix_dendrite_database_password,
  1191. },{
  1192. 'name': matrix_dendrite_keyserver_database,
  1193. 'username': matrix_dendrite_database_user,
  1194. 'password': matrix_dendrite_database_password,
  1195. },{
  1196. 'name': matrix_dendrite_mediaapi_database,
  1197. 'username': matrix_dendrite_database_user,
  1198. 'password': matrix_dendrite_database_password,
  1199. },{
  1200. 'name': matrix_dendrite_room_database,
  1201. 'username': matrix_dendrite_database_user,
  1202. 'password': matrix_dendrite_database_password,
  1203. },{
  1204. 'name': matrix_dendrite_singingkeyserver_database,
  1205. 'username': matrix_dendrite_database_user,
  1206. 'password': matrix_dendrite_database_password,
  1207. },{
  1208. 'name': matrix_dendrite_syncapi_database,
  1209. 'username': matrix_dendrite_database_user,
  1210. 'password': matrix_dendrite_database_password,
  1211. },{
  1212. 'name': matrix_dendrite_account_database,
  1213. 'username': matrix_dendrite_database_user,
  1214. 'password': matrix_dendrite_database_password,
  1215. },{
  1216. 'name': matrix_dendrite_device_database,
  1217. 'username': matrix_dendrite_database_user,
  1218. 'password': matrix_dendrite_database_password,
  1219. },{
  1220. 'name': matrix_dendrite_mscs_database,
  1221. 'username': matrix_dendrite_database_user,
  1222. 'password': matrix_dendrite_database_password,
  1223. }] if (matrix_dendrite_enabled and matrix_dendrite_database_hostname == 'matrix-postgres') else [])
  1224. +
  1225. ([{
  1226. 'name': matrix_ma1sd_database_name,
  1227. 'username': matrix_ma1sd_database_username,
  1228. 'password': matrix_ma1sd_database_password,
  1229. }] if (matrix_ma1sd_enabled and matrix_ma1sd_database_engine == 'postgres' and matrix_ma1sd_database_hostname == 'matrix-postgres') else [])
  1230. +
  1231. ([{
  1232. 'name': matrix_bot_matrix_reminder_bot_database_name,
  1233. 'username': matrix_bot_matrix_reminder_bot_database_username,
  1234. 'password': matrix_bot_matrix_reminder_bot_database_password,
  1235. }] 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 [])
  1236. +
  1237. ([{
  1238. 'name': matrix_bot_honoroit_database_name,
  1239. 'username': matrix_bot_honoroit_database_username,
  1240. 'password': matrix_bot_honoroit_database_password,
  1241. }] if (matrix_bot_honoroit_enabled and matrix_bot_honoroit_database_engine == 'postgres' and matrix_bot_honoroit_database_hostname == 'matrix-postgres') else [])
  1242. +
  1243. ([{
  1244. 'name': matrix_registration_database_name,
  1245. 'username': matrix_registration_database_username,
  1246. 'password': matrix_registration_database_password,
  1247. }] if (matrix_registration_enabled and matrix_registration_database_engine == 'postgres' and matrix_registration_database_hostname == 'matrix-postgres') else [])
  1248. +
  1249. ([{
  1250. 'name': matrix_appservice_discord_database_name,
  1251. 'username': matrix_appservice_discord_database_username,
  1252. 'password': matrix_appservice_discord_database_password,
  1253. }] if (matrix_appservice_discord_enabled and matrix_appservice_discord_database_engine == 'postgres' and matrix_appservice_discord_database_hostname == 'matrix-postgres') else [])
  1254. +
  1255. ([{
  1256. 'name': matrix_appservice_slack_database_name,
  1257. 'username': matrix_appservice_slack_database_username,
  1258. 'password': matrix_appservice_slack_database_password,
  1259. }] if (matrix_appservice_slack_enabled and matrix_appservice_slack_database_engine == 'postgres' and matrix_appservice_slack_database_hostname == 'matrix-postgres') else [])
  1260. +
  1261. ([{
  1262. 'name': matrix_appservice_irc_database_name,
  1263. 'username': matrix_appservice_irc_database_username,
  1264. 'password': matrix_appservice_irc_database_password,
  1265. }] if (matrix_appservice_irc_enabled and matrix_appservice_irc_database_engine == 'postgres' and matrix_appservice_irc_database_hostname == 'matrix-postgres') else [])
  1266. +
  1267. ([{
  1268. 'name': matrix_beeper_linkedin_database_name,
  1269. 'username': matrix_beeper_linkedin_database_username,
  1270. 'password': matrix_beeper_linkedin_database_password,
  1271. }] if (matrix_beeper_linkedin_enabled and matrix_beeper_linkedin_database_engine == 'postgres' and matrix_beeper_linkedin_database_hostname == 'matrix-postgres') else [])
  1272. +
  1273. ([{
  1274. 'name': matrix_mautrix_facebook_database_name,
  1275. 'username': matrix_mautrix_facebook_database_username,
  1276. 'password': matrix_mautrix_facebook_database_password,
  1277. }] if (matrix_mautrix_facebook_enabled and matrix_mautrix_facebook_database_engine == 'postgres' and matrix_mautrix_facebook_database_hostname == 'matrix-postgres') else [])
  1278. +
  1279. ([{
  1280. 'name': matrix_mautrix_hangouts_database_name,
  1281. 'username': matrix_mautrix_hangouts_database_username,
  1282. 'password': matrix_mautrix_hangouts_database_password,
  1283. }] if (matrix_mautrix_hangouts_enabled and matrix_mautrix_hangouts_database_engine == 'postgres' and matrix_mautrix_hangouts_database_hostname == 'matrix-postgres') else [])
  1284. +
  1285. ([{
  1286. 'name': matrix_mautrix_googlechat_database_name,
  1287. 'username': matrix_mautrix_googlechat_database_username,
  1288. 'password': matrix_mautrix_googlechat_database_password,
  1289. }] if (matrix_mautrix_googlechat_enabled and matrix_mautrix_googlechat_database_engine == 'postgres' and matrix_mautrix_googlechat_database_hostname == 'matrix-postgres') else [])
  1290. +
  1291. ([{
  1292. 'name': matrix_mautrix_instagram_database_name,
  1293. 'username': matrix_mautrix_instagram_database_username,
  1294. 'password': matrix_mautrix_instagram_database_password,
  1295. }] if (matrix_mautrix_instagram_enabled and matrix_mautrix_instagram_database_engine == 'postgres' and matrix_mautrix_instagram_database_hostname == 'matrix-postgres') else [])
  1296. +
  1297. ([{
  1298. 'name': matrix_mautrix_signal_database_name,
  1299. 'username': matrix_mautrix_signal_database_username,
  1300. 'password': matrix_mautrix_signal_database_password,
  1301. }] if (matrix_mautrix_signal_enabled and matrix_mautrix_signal_database_engine == 'postgres' and matrix_mautrix_signal_database_hostname == 'matrix-postgres') else [])
  1302. +
  1303. ([{
  1304. 'name': matrix_mautrix_telegram_database_name,
  1305. 'username': matrix_mautrix_telegram_database_username,
  1306. 'password': matrix_mautrix_telegram_database_password,
  1307. }] if (matrix_mautrix_telegram_enabled and matrix_mautrix_telegram_database_engine == 'postgres' and matrix_mautrix_telegram_database_hostname == 'matrix-postgres') else [])
  1308. +
  1309. ([{
  1310. 'name': matrix_mautrix_twitter_database_name,
  1311. 'username': matrix_mautrix_twitter_database_username,
  1312. 'password': matrix_mautrix_twitter_database_password,
  1313. }] if (matrix_mautrix_twitter_enabled and matrix_mautrix_twitter_database_engine == 'postgres' and matrix_mautrix_twitter_database_hostname == 'matrix-postgres') else [])
  1314. +
  1315. ([{
  1316. 'name': matrix_mautrix_whatsapp_database_name,
  1317. 'username': matrix_mautrix_whatsapp_database_username,
  1318. 'password': matrix_mautrix_whatsapp_database_password,
  1319. }] if (matrix_mautrix_whatsapp_enabled and matrix_mautrix_whatsapp_database_engine == 'postgres' and matrix_mautrix_whatsapp_database_hostname == 'matrix-postgres') else [])
  1320. +
  1321. ([{
  1322. 'name': matrix_mx_puppet_skype_database_name,
  1323. 'username': matrix_mx_puppet_skype_database_username,
  1324. 'password': matrix_mx_puppet_skype_database_password,
  1325. }] if (matrix_mx_puppet_skype_enabled and matrix_mx_puppet_skype_database_engine == 'postgres' and matrix_mx_puppet_skype_database_hostname == 'matrix-postgres') else [])
  1326. +
  1327. ([{
  1328. 'name': matrix_mx_puppet_slack_database_name,
  1329. 'username': matrix_mx_puppet_slack_database_username,
  1330. 'password': matrix_mx_puppet_slack_database_password,
  1331. }] if (matrix_mx_puppet_slack_enabled and matrix_mx_puppet_slack_database_engine == 'postgres' and matrix_mx_puppet_slack_database_hostname == 'matrix-postgres') else [])
  1332. +
  1333. ([{
  1334. 'name': matrix_mx_puppet_twitter_database_name,
  1335. 'username': matrix_mx_puppet_twitter_database_username,
  1336. 'password': matrix_mx_puppet_twitter_database_password,
  1337. }] if (matrix_mx_puppet_twitter_enabled and matrix_mx_puppet_twitter_database_engine == 'postgres' and matrix_mx_puppet_twitter_database_hostname == 'matrix-postgres') else [])
  1338. +
  1339. ([{
  1340. 'name': matrix_mx_puppet_instagram_database_name,
  1341. 'username': matrix_mx_puppet_instagram_database_username,
  1342. 'password': matrix_mx_puppet_instagram_database_password,
  1343. }] if (matrix_mx_puppet_instagram_enabled and matrix_mx_puppet_instagram_database_engine == 'postgres' and matrix_mx_puppet_instagram_database_hostname == 'matrix-postgres') else [])
  1344. +
  1345. ([{
  1346. 'name': matrix_mx_puppet_discord_database_name,
  1347. 'username': matrix_mx_puppet_discord_database_username,
  1348. 'password': matrix_mx_puppet_discord_database_password,
  1349. }] if (matrix_mx_puppet_discord_enabled and matrix_mx_puppet_discord_database_engine == 'postgres' and matrix_mx_puppet_discord_database_hostname == 'matrix-postgres') else [])
  1350. +
  1351. ([{
  1352. 'name': matrix_mx_puppet_steam_database_name,
  1353. 'username': matrix_mx_puppet_steam_database_username,
  1354. 'password': matrix_mx_puppet_steam_database_password,
  1355. }] if (matrix_mx_puppet_steam_enabled and matrix_mx_puppet_steam_database_engine == 'postgres' and matrix_mx_puppet_steam_database_hostname == 'matrix-postgres') else [])
  1356. +
  1357. ([{
  1358. 'name': matrix_mx_puppet_groupme_database_name,
  1359. 'username': matrix_mx_puppet_groupme_database_username,
  1360. 'password': matrix_mx_puppet_groupme_database_password,
  1361. }] if (matrix_mx_puppet_groupme_enabled and matrix_mx_puppet_groupme_database_engine == 'postgres' and matrix_mx_puppet_groupme_database_hostname == 'matrix-postgres') else [])
  1362. +
  1363. ([{
  1364. 'name': matrix_dimension_database_name,
  1365. 'username': matrix_dimension_database_username,
  1366. 'password': matrix_dimension_database_password,
  1367. }] if (matrix_dimension_enabled and matrix_dimension_database_engine == 'postgres' and matrix_dimension_database_hostname == 'matrix-postgres') else [])
  1368. +
  1369. ([{
  1370. 'name': matrix_etherpad_database_name,
  1371. 'username': matrix_etherpad_database_username,
  1372. 'password': matrix_etherpad_database_password,
  1373. }] if (matrix_etherpad_enabled and matrix_etherpad_database_engine == 'postgres' and matrix_etherpad_database_hostname == 'matrix-postgres') else [])
  1374. +
  1375. ([{
  1376. 'name': matrix_prometheus_postgres_exporter_database_name,
  1377. 'username': matrix_prometheus_postgres_exporter_database_username,
  1378. 'password': matrix_prometheus_postgres_exporter_database_password,
  1379. }] if (matrix_prometheus_postgres_exporter_enabled and matrix_prometheus_postgres_exporter_database_hostname == 'matrix-postgres') else [])
  1380. }}
  1381. matrix_postgres_import_roles_to_ignore: |
  1382. {{
  1383. [matrix_postgres_connection_username]
  1384. +
  1385. matrix_postgres_additional_databases|map(attribute='username')|list
  1386. }}
  1387. matrix_postgres_import_databases_to_ignore: |
  1388. {{
  1389. [matrix_postgres_db_name]
  1390. +
  1391. matrix_postgres_additional_databases|map(attribute='name')|list
  1392. }}
  1393. ######################################################################
  1394. #
  1395. # /matrix-postgres
  1396. #
  1397. ######################################################################
  1398. ######################################################################
  1399. #
  1400. # matrix-sygnal
  1401. #
  1402. ######################################################################
  1403. # Most people don't need their own push-server, because they also need their own app to utilize it from.
  1404. matrix_sygnal_enabled: false
  1405. # If someone instals Prometheus via the playbook, they most likely wish to monitor Sygnal.
  1406. matrix_sygnal_metrics_prometheus_enabled: "{{ matrix_prometheus_enabled }}"
  1407. matrix_sygnal_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:6000' }}"
  1408. ######################################################################
  1409. #
  1410. # /matrix-sygnal
  1411. #
  1412. ######################################################################
  1413. ######################################################################
  1414. #
  1415. # matrix-redis
  1416. #
  1417. ######################################################################
  1418. matrix_redis_enabled: "{{ matrix_synapse_workers_enabled }}"
  1419. ######################################################################
  1420. #
  1421. # /matrix-redis
  1422. #
  1423. ######################################################################
  1424. ######################################################################
  1425. #
  1426. # matrix-client-element
  1427. #
  1428. ######################################################################
  1429. # By default, this playbook installs the Element web UI on the `matrix_server_fqn_element` domain.
  1430. # If you wish to connect to your Matrix server by other means, you may wish to disable this.
  1431. matrix_client_element_enabled: true
  1432. matrix_client_element_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1433. # Normally, matrix-nginx-proxy is enabled and nginx can reach Element over the container network.
  1434. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1435. # the Element HTTP port to the local host.
  1436. matrix_client_element_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8765' }}"
  1437. matrix_client_element_default_hs_url: "{{ matrix_homeserver_url }}"
  1438. matrix_client_element_default_is_url: "{{ matrix_identity_server_url }}"
  1439. # Use Dimension if enabled, otherwise fall back to Scalar
  1440. matrix_client_element_integrations_ui_url: "{{ matrix_dimension_integrations_ui_url if matrix_dimension_enabled else 'https://scalar.vector.im/' }}"
  1441. matrix_client_element_integrations_rest_url: "{{ matrix_dimension_integrations_rest_url if matrix_dimension_enabled else 'https://scalar.vector.im/api' }}"
  1442. matrix_client_element_integrations_widgets_urls: "{{ matrix_dimension_integrations_widgets_urls if matrix_dimension_enabled else ['https://scalar.vector.im/api'] }}"
  1443. 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' }}"
  1444. matrix_client_element_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1445. matrix_client_element_registration_enabled: "{{ matrix_synapse_enable_registration }}"
  1446. matrix_client_element_enable_presence_by_hs_url: |
  1447. {{
  1448. none
  1449. if matrix_synapse_presence_enabled
  1450. else {matrix_client_element_default_hs_url: false}
  1451. }}
  1452. matrix_client_element_welcome_user_id: ~
  1453. matrix_client_element_jitsi_preferredDomain: "{{ matrix_server_fqn_jitsi if matrix_jitsi_enabled else '' }}"
  1454. ######################################################################
  1455. #
  1456. # /matrix-client-element
  1457. #
  1458. ######################################################################
  1459. ######################################################################
  1460. #
  1461. # matrix-client-hydrogen
  1462. #
  1463. ######################################################################
  1464. matrix_client_hydrogen_enabled: false
  1465. # Normally, matrix-nginx-proxy is enabled and nginx can reach Hydrogen over the container network.
  1466. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1467. # the HTTP port to the local host.
  1468. matrix_client_hydrogen_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8768' }}"
  1469. matrix_client_hydrogen_default_hs_url: "{{ matrix_homeserver_url }}"
  1470. matrix_client_hydrogen_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1471. ######################################################################
  1472. #
  1473. # /matrix-client-hydrogen
  1474. #
  1475. ######################################################################
  1476. ######################################################################
  1477. #
  1478. # matrix-client-cinny
  1479. #
  1480. ######################################################################
  1481. matrix_client_cinny_enabled: false
  1482. matrix_client_cinny_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1483. # Normally, matrix-nginx-proxy is enabled and nginx can reach Cinny over the container network.
  1484. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1485. # the HTTP port to the local host.
  1486. matrix_client_cinny_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8080' }}"
  1487. matrix_client_cinny_default_hs_url: "{{ matrix_homeserver_url }}"
  1488. matrix_client_cinny_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1489. ######################################################################
  1490. #
  1491. # /matrix-client-cinny
  1492. #
  1493. ######################################################################
  1494. ######################################################################
  1495. #
  1496. # matrix-synapse
  1497. #
  1498. ######################################################################
  1499. matrix_synapse_enabled: "{{ matrix_homeserver_implementation == 'synapse' }}"
  1500. matrix_synapse_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
  1501. # When ma1sd is enabled, we can use it to validate email addresses and phone numbers.
  1502. # 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.
  1503. matrix_synapse_account_threepid_delegates_email: "{{ 'http://matrix-ma1sd:' + matrix_ma1sd_container_port|string if matrix_ma1sd_enabled else '' }}"
  1504. matrix_synapse_account_threepid_delegates_msisdn: "{{ 'http://matrix-ma1sd:' + matrix_ma1sd_container_port|string if matrix_ma1sd_enabled else '' }}"
  1505. # Normally, matrix-nginx-proxy is enabled and nginx can reach Synapse over the container network.
  1506. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it,
  1507. # you can expose Synapse's ports to the host.
  1508. #
  1509. # For exposing the Matrix Client API's port (plain HTTP) to the local host.
  1510. 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 }}"
  1511. #
  1512. # For exposing the Matrix Federation API's plain port (plain HTTP) to the local host.
  1513. 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 }}"
  1514. #
  1515. # For exposing the Matrix Federation API's TLS port (HTTPS) to the internet on all network interfaces.
  1516. 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 '' }}"
  1517. #
  1518. # For exposing the Synapse Metrics API's port (plain HTTP) to the local host.
  1519. 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 '' }}"
  1520. #
  1521. # For exposing the Synapse Manhole port (plain HTTP) to the local host.
  1522. matrix_synapse_container_manhole_api_host_bind_port: "{{ '127.0.0.1:9000' if matrix_synapse_manhole_enabled else '' }}"
  1523. #
  1524. # For exposing the Synapse worker (and metrics) ports to the local host.
  1525. matrix_synapse_workers_container_host_bind_address: "{{ '127.0.0.1' if (matrix_synapse_workers_enabled and not matrix_nginx_proxy_enabled) else '' }}"
  1526. matrix_synapse_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'synapse.db') | to_uuid }}"
  1527. matrix_synapse_macaroon_secret_key: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'synapse.mac') | to_uuid }}"
  1528. # We do not enable TLS in Synapse by default.
  1529. # TLS is handled by the matrix-nginx-proxy, which proxies the requests to Synapse.
  1530. matrix_synapse_tls_federation_listener_enabled: false
  1531. matrix_synapse_tls_certificate_path: ~
  1532. matrix_synapse_tls_private_key_path: ~
  1533. matrix_synapse_federation_port_openid_resource_required: "{{ not matrix_synapse_federation_enabled and (matrix_dimension_enabled or matrix_ma1sd_enabled) }}"
  1534. # If someone instals Prometheus via the playbook, they most likely wish to monitor Synapse.
  1535. matrix_synapse_metrics_enabled: "{{ matrix_prometheus_enabled }}"
  1536. matrix_synapse_email_enabled: "{{ matrix_mailer_enabled }}"
  1537. matrix_synapse_email_smtp_host: "matrix-mailer"
  1538. matrix_synapse_email_smtp_port: 8025
  1539. matrix_synapse_email_smtp_require_transport_security: false
  1540. matrix_synapse_email_notif_from: "Matrix <{{ matrix_mailer_sender_address }}>"
  1541. # Even if TURN doesn't support TLS (it does by default),
  1542. # it doesn't hurt to try a secure connection anyway.
  1543. #
  1544. # When Let's Encrypt certificates are used (the default case),
  1545. # we don't enable `turns` endpoints, because WebRTC in Element can't talk to them.
  1546. # Learn more here: https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1145
  1547. matrix_synapse_turn_uris: |
  1548. {{
  1549. []
  1550. +
  1551. [
  1552. 'turns:' + matrix_server_fqn_matrix + '?transport=udp',
  1553. 'turns:' + matrix_server_fqn_matrix + '?transport=tcp',
  1554. ] if matrix_coturn_enabled and matrix_coturn_tls_enabled and matrix_ssl_retrieval_method != 'lets-encrypt' else []
  1555. +
  1556. [
  1557. 'turn:' + matrix_server_fqn_matrix + '?transport=udp',
  1558. 'turn:' + matrix_server_fqn_matrix + '?transport=tcp',
  1559. ] if matrix_coturn_enabled else []
  1560. }}
  1561. matrix_synapse_turn_shared_secret: "{{ matrix_coturn_turn_static_auth_secret if matrix_coturn_enabled else '' }}"
  1562. matrix_synapse_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1563. matrix_synapse_systemd_required_services_list: |
  1564. {{
  1565. (['docker.service'])
  1566. +
  1567. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1568. +
  1569. (['matrix-goofys'] if matrix_s3_media_store_enabled else [])
  1570. }}
  1571. matrix_synapse_systemd_wanted_services_list: |
  1572. {{
  1573. (['matrix-coturn.service'] if matrix_coturn_enabled else [])
  1574. +
  1575. (['matrix-mailer.service'] if matrix_mailer_enabled else [])
  1576. }}
  1577. # Synapse workers (used for parallel load-scaling) need Redis for IPC.
  1578. matrix_synapse_redis_enabled: "{{ matrix_redis_enabled }}"
  1579. matrix_synapse_redis_host: "{{ 'matrix-redis' if matrix_redis_enabled else '' }}"
  1580. matrix_synapse_redis_password: "{{ matrix_redis_connection_password if matrix_redis_enabled else '' }}"
  1581. ######################################################################
  1582. #
  1583. # /matrix-synapse
  1584. #
  1585. ######################################################################
  1586. ######################################################################
  1587. #
  1588. # matrix-synapse-admin
  1589. #
  1590. ######################################################################
  1591. matrix_synapse_admin_enabled: false
  1592. # Normally, matrix-nginx-proxy is enabled and nginx can reach Synapse Admin over the container network.
  1593. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1594. # Synapse Admin's HTTP port to the local host.
  1595. matrix_synapse_admin_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8766' }}"
  1596. matrix_synapse_admin_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1597. ######################################################################
  1598. #
  1599. # /matrix-synapse-admin
  1600. #
  1601. ######################################################################
  1602. ######################################################################
  1603. #
  1604. # matrix-prometheus-node-exporter
  1605. #
  1606. ######################################################################
  1607. matrix_prometheus_node_exporter_enabled: false
  1608. ######################################################################
  1609. #
  1610. # /matrix-prometheus-node-exporter
  1611. #
  1612. ######################################################################
  1613. ######################################################################
  1614. #
  1615. # matrix-prometheus
  1616. #
  1617. ######################################################################
  1618. matrix_prometheus_enabled: false
  1619. # Normally, matrix-nginx-proxy is enabled and nginx can reach Prometheus over the container network.
  1620. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1621. # Prometheus' HTTP port to the local host.
  1622. matrix_prometheus_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9090' }}"
  1623. matrix_prometheus_scraper_synapse_enabled: "{{ matrix_synapse_enabled and matrix_synapse_metrics_enabled }}"
  1624. matrix_prometheus_scraper_synapse_targets: ['matrix-synapse:{{ matrix_synapse_metrics_port }}']
  1625. matrix_prometheus_scraper_synapse_workers_enabled_list: "{{ matrix_synapse_workers_enabled_list }}"
  1626. matrix_prometheus_scraper_synapse_rules_synapse_tag: "{{ matrix_synapse_docker_image_tag }}"
  1627. matrix_prometheus_scraper_node_enabled: "{{ matrix_prometheus_node_exporter_enabled }}"
  1628. matrix_prometheus_scraper_node_targets: "{{ ['matrix-prometheus-node-exporter:9100'] if matrix_prometheus_node_exporter_enabled else [] }}"
  1629. matrix_prometheus_scraper_postgres_enabled: "{{ matrix_prometheus_postgres_exporter_enabled }}"
  1630. matrix_prometheus_scraper_postgres_targets: "{{ ['matrix-prometheus-postgres-exporter:'+ matrix_prometheus_postgres_exporter_port|string] if matrix_prometheus_scraper_postgres_enabled else [] }}"
  1631. ######################################################################
  1632. #
  1633. # /matrix-prometheus
  1634. #
  1635. ######################################################################
  1636. ######################################################################
  1637. #
  1638. # matrix-prometheus-postgres-exporter
  1639. #
  1640. ######################################################################
  1641. matrix_prometheus_postgres_exporter_enabled: false
  1642. matrix_prometheus_postgres_exporter_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'prometheus.pg.db') | to_uuid }}"
  1643. matrix_prometheus_postgres_exporter_systemd_required_services_list: |
  1644. {{
  1645. ['docker.service']
  1646. +
  1647. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1648. }}
  1649. ######################################################################
  1650. #
  1651. # /matrix-prometheus-postgres-exporter
  1652. #
  1653. ######################################################################
  1654. ######################################################################
  1655. #
  1656. # matrix-grafana
  1657. #
  1658. ######################################################################
  1659. matrix_grafana_enabled: false
  1660. # Normally, matrix-nginx-proxy is enabled and nginx can reach Grafana over the container network.
  1661. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1662. # Grafana's HTTP port to the local host.
  1663. matrix_grafana_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:3000' }}"
  1664. matrix_grafana_dashboard_download_urls_all: |
  1665. {{
  1666. matrix_grafana_dashboard_download_urls
  1667. +
  1668. (matrix_prometheus_postgres_exporter_dashboard_urls if matrix_prometheus_postgres_exporter_enabled else [])
  1669. }}
  1670. ######################################################################
  1671. #
  1672. # /matrix-grafana
  1673. #
  1674. ######################################################################
  1675. ######################################################################
  1676. #
  1677. # matrix-registration
  1678. #
  1679. ######################################################################
  1680. matrix_registration_enabled: false
  1681. # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-registration over the container network.
  1682. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
  1683. # matrix-registration's HTTP port to the local host.
  1684. matrix_registration_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8767' }}"
  1685. matrix_registration_riot_instance: "{{ ('https://' + matrix_server_fqn_element) if matrix_client_element_enabled else 'https://riot.im/app/' }}"
  1686. matrix_registration_shared_secret: |-
  1687. {{
  1688. {
  1689. 'synapse': matrix_synapse_registration_shared_secret,
  1690. 'dendrite': matrix_dendrite_registration_shared_secret,
  1691. }[matrix_homeserver_implementation]
  1692. }}
  1693. matrix_registration_server_location: "{{ matrix_homeserver_container_url }}"
  1694. matrix_registration_api_validate_certs: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1695. matrix_registration_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
  1696. matrix_registration_systemd_required_services_list: |
  1697. {{
  1698. ['docker.service']
  1699. +
  1700. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1701. }}
  1702. # Postgres is the default, except if not using `matrix_postgres` (internal postgres)
  1703. matrix_registration_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
  1704. matrix_registration_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mx.registr.db') | to_uuid }}"
  1705. ######################################################################
  1706. #
  1707. # /matrix-registration
  1708. #
  1709. ######################################################################
  1710. ######################################################################
  1711. #
  1712. # matrix-postgres-backup
  1713. #
  1714. ######################################################################
  1715. matrix_postgres_backup_connection_hostname: "{{ matrix_postgres_connection_hostname }}"
  1716. matrix_postgres_backup_connection_port: "{{ matrix_postgres_connection_port }}"
  1717. matrix_postgres_backup_connection_username: "{{ matrix_postgres_connection_username }}"
  1718. matrix_postgres_backup_connection_password: "{{ matrix_postgres_connection_password }}"
  1719. matrix_postgres_backup_postgres_data_path: "{{ matrix_postgres_data_path if matrix_postgres_enabled else '' }}"
  1720. # 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
  1721. matrix_postgres_backup_databases: |
  1722. {{
  1723. (([{
  1724. 'name': matrix_synapse_database_database
  1725. }] if (matrix_synapse_enabled and matrix_synapse_database_database == matrix_postgres_db_name and matrix_synapse_database_host == 'matrix-postgres') else [])
  1726. +
  1727. matrix_postgres_additional_databases)|map(attribute='name')|list
  1728. }}
  1729. ######################################################################
  1730. #
  1731. # /matrix-postgres-backup
  1732. #
  1733. ######################################################################
  1734. ######################################################################
  1735. #
  1736. # matrix-dendrite
  1737. #
  1738. ######################################################################
  1739. matrix_dendrite_enabled: "{{ matrix_homeserver_implementation == 'dendrite' }}"
  1740. # Normally, matrix-nginx-proxy is enabled and nginx can reach Dendrite over the container network.
  1741. # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it,
  1742. # you can expose Dendrite's ports to the host.
  1743. #
  1744. # For exposing Dendrite's plain HTTP server to the local host.
  1745. matrix_dendrite_container_http_host_bind_address: "{{ '' if matrix_nginx_proxy_enabled else ('127.0.0.1:' + matrix_dendrite_http_bind_port|string) }}"
  1746. #
  1747. # For exposing Dendrite's HTTPS server to the local host.
  1748. 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) }}"
  1749. matrix_dendrite_sync_api_real_ip_header: "{{ 'X-Forwarded-For' if matrix_nginx_proxy_enabled else '' }}"
  1750. matrix_dendrite_registration_shared_secret: "{{ matrix_homeserver_generic_secret_key | password_hash('sha512', 'dendrite.rss') | to_uuid }}"
  1751. matrix_dendrite_database_password: "{{ matrix_homeserver_generic_secret_key | password_hash('sha512', 'dendrite.db') | to_uuid }}"
  1752. # Even if TURN doesn't support TLS (it does by default),
  1753. # it doesn't hurt to try a secure connection anyway.
  1754. matrix_dendrite_turn_uris: |
  1755. {{
  1756. [
  1757. 'turns:' + matrix_server_fqn_matrix + '?transport=udp',
  1758. 'turns:' + matrix_server_fqn_matrix + '?transport=tcp',
  1759. 'turn:' + matrix_server_fqn_matrix + '?transport=udp',
  1760. 'turn:' + matrix_server_fqn_matrix + '?transport=tcp',
  1761. ]
  1762. if matrix_coturn_enabled
  1763. else []
  1764. }}
  1765. matrix_dendrite_turn_shared_secret: "{{ matrix_coturn_turn_static_auth_secret if matrix_coturn_enabled else '' }}"
  1766. matrix_dendrite_disable_tls_validation: "{{ true if matrix_ssl_retrieval_method == 'self-signed' else false }}"
  1767. matrix_dendrite_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
  1768. matrix_dendrite_trusted_id_servers: "{{ [matrix_server_fqn_matrix] if matrix_ma1sd_enabled else ['matrix.org', 'vector.im'] }}"
  1769. matrix_dendrite_systemd_required_services_list: |
  1770. {{
  1771. (['docker.service'])
  1772. +
  1773. (['matrix-postgres.service'] if matrix_postgres_enabled else [])
  1774. +
  1775. (['matrix-goofys'] if matrix_s3_media_store_enabled else [])
  1776. }}
  1777. matrix_dendrite_systemd_wanted_services_list: |
  1778. {{
  1779. (['matrix-coturn.service'] if matrix_coturn_enabled else [])
  1780. }}
  1781. ######################################################################
  1782. #
  1783. # /matrix-dendrite
  1784. #
  1785. ######################################################################