Matrix Docker Ansible eploy
Du kannst nicht mehr als 25 Themen auswählen Themen müssen entweder mit einem Buchstaben oder einer Ziffer beginnen. Sie können Bindestriche („-“) enthalten und bis zu 35 Zeichen lang sein.
 
 

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