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ů.
 
 

1916 řádky
81 KiB

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