Matrix Docker Ansible eploy
Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.
 
 

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