Matrix Docker Ansible eploy
Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.
 
 

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