Matrix Docker Ansible eploy
Nelze vybrat více než 25 témat Téma musí začínat písmenem nebo číslem, může obsahovat pomlčky („-“) a může být dlouhé až 35 znaků.
 
 

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