Matrix Docker Ansible eploy
Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.
 
 

1994 rader
85 KiB

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