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

2350 строки
103 KiB

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