Matrix Docker Ansible eploy
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

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