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

1811 řádky
77 KiB

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