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

1777 wiersze
75 KiB

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