Matrix Docker Ansible eploy
選択できるのは25トピックまでです。 トピックは、先頭が英数字で、英数字とダッシュ('-')を使用した35文字以内のものにしてください。
 
 

2341 行
104 KiB

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