overmind
/
matrix-docker-ansible-deploy
spogulis no https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Atdalīts 0
Kods Problēmas 0 Laidieni 0 Vikivietne Aktivitāte
Matrix Docker Ansible eploy
Nevar pievienot vairāk kā 25 tēmas Tēmai ir jāsākas ar burtu vai ciparu, tā var saturēt domu zīmes ('-') un var būt līdz 35 simboliem gara.
11106 Revīzijas
13 Atzari
531 MiB
 
 
Koks: c851bb5d32
Atzari Tagi
${ item.name }
Izveidot atzaru ${ searchTerm }
no 'c851bb5d32'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-synaps...

318 rindas
18 KiB
Neapstrādāts Vainot Vēsture 

  1. # SOME DESCRIPTIVE TITLE.

  2. # Copyright (C) 2018-2026, Slavi Pantaleev, Aine Etke, MDAD community members

  3. # This file is distributed under the same license as the matrix-docker-ansible-deploy package.

  4. # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.

  5. #

  6. #, fuzzy

  7. msgid ""

  8. msgstr ""

  9. "Project-Id-Version: matrix-docker-ansible-deploy \n"

  10. "Report-Msgid-Bugs-To: \n"

  11. "POT-Creation-Date: 2026-03-31 05:49+0000\n"

  12. "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"

  13. "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"

  14. "Language-Team: LANGUAGE <LL@li.org>\n"

  15. "MIME-Version: 1.0\n"

  16. "Content-Type: text/plain; charset=UTF-8\n"

  17. "Content-Transfer-Encoding: 8bit\n"

  18. 

  19. #: ../../../docs/configuring-playbook-synapse.md:12

  20. msgid "Configuring Synapse (optional)"

  21. msgstr ""

  22. 

  23. #: ../../../docs/configuring-playbook-synapse.md:14

  24. msgid "By default, this playbook configures the [Synapse](https://github.com/element-hq/synapse) Matrix server, so that it works for the general case. If that's okay, you can skip this document."

  25. msgstr ""

  26. 

  27. #: ../../../docs/configuring-playbook-synapse.md:16

  28. msgid "💡 See this page for details about maintaining Synapse: [Synapse maintenance](maintenance-synapse.md)"

  29. msgstr ""

  30. 

  31. #: ../../../docs/configuring-playbook-synapse.md:18

  32. msgid "Adjusting the playbook configuration"

  33. msgstr ""

  34. 

  35. #: ../../../docs/configuring-playbook-synapse.md:20

  36. msgid "Load balancing with workers"

  37. msgstr ""

  38. 

  39. #: ../../../docs/configuring-playbook-synapse.md:22

  40. msgid "To have Synapse gracefully handle thousands of users, worker support should be enabled. It factors out some homeserver tasks and spreads the load of incoming client and server-to-server traffic between multiple processes. More information can be found in the [official Synapse workers documentation](https://github.com/element-hq/synapse/blob/master/docs/workers.md) and [Tom Foster](https://github.com/tcpipuk)'s [Synapse homeserver guide](https://tcpipuk.github.io/synapse/index.html)."

  41. msgstr ""

  42. 

  43. #: ../../../docs/configuring-playbook-synapse.md:24

  44. msgid "To enable Synapse worker support, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"

  45. msgstr ""

  46. 

  47. #: ../../../docs/configuring-playbook-synapse.md:32

  48. msgid "By default, this enables the `one-of-each` [worker preset](#worker-presets), but you may wish to use another preset or [control the number of worker instances](#controlling-the-number-of-worker-instances)."

  49. msgstr ""

  50. 

  51. #: ../../../docs/configuring-playbook-synapse.md:34

  52. msgid "Worker presets"

  53. msgstr ""

  54. 

  55. #: ../../../docs/configuring-playbook-synapse.md:36

  56. msgid "We support a few configuration presets (`matrix_synapse_workers_preset: one-of-each` being the default configuration right now):"

  57. msgstr ""

  58. 

  59. #: ../../../docs/configuring-playbook-synapse.md:38

  60. msgid "(federation-only) `little-federation-helper` — a very minimal worker configuration to improve federation performance"

  61. msgstr ""

  62. 

  63. #: ../../../docs/configuring-playbook-synapse.md:39

  64. msgid "(generic) `one-of-each` — defaults to one worker of each supported type — no smart routing, just generic workers"

  65. msgstr ""

  66. 

  67. #: ../../../docs/configuring-playbook-synapse.md:40

  68. msgid "(specialized) `specialized-workers` — defaults to one worker of each supported type, but disables generic workers and uses [specialized workers](#specialized-workers) instead"

  69. msgstr ""

  70. 

  71. #: ../../../docs/configuring-playbook-synapse.md:42

  72. msgid "These presets represent a few common configurations. There are many worker types which can be mixed and matched based on your needs."

  73. msgstr ""

  74. 

  75. #: ../../../docs/configuring-playbook-synapse.md:44

  76. msgid "Generic workers"

  77. msgstr ""

  78. 

  79. #: ../../../docs/configuring-playbook-synapse.md:46

  80. msgid "Previously, the playbook only supported the most basic type of load-balancing. We call it **generic load-balancing** below, because incoming HTTP requests are sent to a generic worker. Load-balancing was done based on the requestor's IP address. This is simple, but not necessarily optimal. If you're accessing your account from multiple IP addresses (e.g. your mobile phone being on a different network than your PC), these separate requests may potentially be routed to different workers, each of which would need to cache roughly the same data."

  81. msgstr ""

  82. 

  83. #: ../../../docs/configuring-playbook-synapse.md:48

  84. msgid "This is **still the default load-balancing method (preset) used by the playbook**."

  85. msgstr ""

  86. 

  87. #: ../../../docs/configuring-playbook-synapse.md:50

  88. msgid "To use generic load-balancing, do not specify `matrix_synapse_workers_preset` to make it use the default value (`one-of-each`), or better yet — explicitly set it as `one-of-each`."

  89. msgstr ""

  90. 

  91. #: ../../../docs/configuring-playbook-synapse.md:52

  92. msgid "You may also consider [tweaking the number of workers of each type](#controlling-the-number-of-worker-instances) from the default (one of each)."

  93. msgstr ""

  94. 

  95. #: ../../../docs/configuring-playbook-synapse.md:54

  96. msgid "Specialized workers"

  97. msgstr ""

  98. 

  99. #: ../../../docs/configuring-playbook-synapse.md:56

  100. msgid "The playbook now supports a smarter **specialized load-balancing** inspired by [Tom Foster](https://github.com/tcpipuk)'s [Synapse homeserver guide](https://tcpipuk.github.io/synapse/index.html). Instead of routing requests to one or more [generic workers](#generic-workers) based only on the requester's IP address, specialized load-balancing routes to **4 different types of specialized workers** based on **smarter criteria** — the access token (username) of the requester and/or on the resource (room, etc.) being requested."

  101. msgstr ""

  102. 

  103. #: ../../../docs/configuring-playbook-synapse.md:58

  104. msgid "The playbook supports these **4 types** of specialized workers:"

  105. msgstr ""

  106. 

  107. #: ../../../docs/configuring-playbook-synapse.md:60

  108. msgid "Room workers — handles various [Client-Server](https://spec.matrix.org/v1.9/client-server-api/) & [Federation](https://spec.matrix.org/v1.9/server-server-api) APIs dedicated to handling specific rooms"

  109. msgstr ""

  110. 

  111. #: ../../../docs/configuring-playbook-synapse.md:61

  112. msgid "Sync workers — handles various [Client-Server](https://spec.matrix.org/v1.9/client-server-api/) APIs related to synchronization (most notably [the `/sync` endpoint](https://spec.matrix.org/v1.9/client-server-api/#get_matrixclientv3sync))"

  113. msgstr ""

  114. 

  115. #: ../../../docs/configuring-playbook-synapse.md:62

  116. msgid "Client readers — handles various [Client-Server](https://spec.matrix.org/v1.9/client-server-api/) APIs which are not for specific rooms (handled by **room workers**) or for synchronization (handled by **sync workers**)"

  117. msgstr ""

  118. 

  119. #: ../../../docs/configuring-playbook-synapse.md:63

  120. msgid "Federation readers — handles various [Federation](https://spec.matrix.org/v1.9/server-server-api) APIs which are not for specific rooms (handled by **room workers**)"

  121. msgstr ""

  122. 

  123. #: ../../../docs/configuring-playbook-synapse.md:65

  124. msgid "To use specialized load-balancing, consider enabling the `specialized-workers` [worker preset](#worker-presets) and potentially [tweaking the number of workers of each type](#controlling-the-number-of-worker-instances) from the default (one of each)."

  125. msgstr ""

  126. 

  127. #: ../../../docs/configuring-playbook-synapse.md:67

  128. msgid "Controlling the number of worker instances"

  129. msgstr ""

  130. 

  131. #: ../../../docs/configuring-playbook-synapse.md:69

  132. msgid "If you'd like more customization power, you can start with one of the [worker presets](#worker-presets) and then tweak various `matrix_synapse_workers_*_count` variables manually."

  133. msgstr ""

  134. 

  135. #: ../../../docs/configuring-playbook-synapse.md:71

  136. msgid "To find what variables are available for you to override in your own `vars.yml` configuration file, see the [`defaults/main.yml` file for the `matrix-synapse` Ansible role](../roles/custom/matrix-synapse/defaults/main.yml)."

  137. msgstr ""

  138. 

  139. #: ../../../docs/configuring-playbook-synapse.md:73

  140. msgid "The only thing you **cannot** do is mix [generic workers](#generic-workers) and [specialized workers](#specialized-workers)."

  141. msgstr ""

  142. 

  143. #: ../../../docs/configuring-playbook-synapse.md:75

  144. msgid "Effect of enabling workers on the rest of your server"

  145. msgstr ""

  146. 

  147. #: ../../../docs/configuring-playbook-synapse.md:77

  148. msgid "When Synapse workers are enabled, the integrated [Postgres database is tuned](maintenance-postgres.md#tuning-postgresql), so that the maximum number of Postgres connections are increased from `200` to `500`. If you need to decrease or increase the number of maximum Postgres connections further, use the `postgres_max_connections` variable."

  149. msgstr ""

  150. 

  151. #: ../../../docs/configuring-playbook-synapse.md:79

  152. msgid "The `matrix-synapse` role also manages the `matrix-synapse-reverse-proxy-companion` component for load-balancing with workers. This component is automatically enabled when you enable workers. Make sure to use the `setup-all` tag (not `install-all`!) during the playbook's [installation](./installing.md) process, especially if you're disabling workers, so that components may be installed/uninstalled correctly."

  153. msgstr ""

  154. 

  155. #: ../../../docs/configuring-playbook-synapse.md:81

  156. msgid "In case any problems occur, make sure to have a look at the [list of synapse issues about workers](https://github.com/element-hq/synapse/issues?q=workers+in%3Atitle) and your `journalctl --unit 'matrix-*'`."

  157. msgstr ""

  158. 

  159. #: ../../../docs/configuring-playbook-synapse.md:83

  160. msgid "Limit joining heavy rooms on constrained hosts"

  161. msgstr ""

  162. 

  163. #: ../../../docs/configuring-playbook-synapse.md:85

  164. msgid "If your server is underpowered, joining heavy rooms can cause Synapse to consume a lot of resources and be unavailable for long (while it catches up)."

  165. msgstr ""

  166. 

  167. #: ../../../docs/configuring-playbook-synapse.md:87

  168. msgid "To avoid this, Synapse can be configured to reject joins for remote rooms that are too complex before users enter them."

  169. msgstr ""

  170. 

  171. #: ../../../docs/configuring-playbook-synapse.md:89

  172. msgid "Complexity is computed as `current_state_events / 500` (Synapse state event count for current room state). When the resulting value is higher than `matrix_synapse_limit_remote_rooms_complexity` and `matrix_synapse_limit_remote_rooms_enabled` is `true`, Synapse blocks joining the room."

  173. msgstr ""

  174. 

  175. #: ../../../docs/configuring-playbook-synapse.md:91

  176. msgid "We recommend using this as a guardrail on low-resource servers:"

  177. msgstr ""

  178. 

  179. #: ../../../docs/configuring-playbook-synapse.md:106

  180. msgid "Synapse + OpenID Connect for Single-Sign-On"

  181. msgstr ""

  182. 

  183. #: ../../../docs/configuring-playbook-synapse.md:108

  184. msgid "💡 An alternative to setting up OIDC in Synapse is to use [Matrix Authentication Service](./configuring-playbook-matrix-authentication-service.md) (MAS). Newer clients (like Element X) only support SSO-based authentication via MAS and not via the legacy Synapse OIDC setup described below. That said, MAS is still a new experimental service which comes with its own downsides. Consult its documentation to learn if it will be a good fit for your deployment."

  185. msgstr ""

  186. 

  187. #: ../../../docs/configuring-playbook-synapse.md:110

  188. msgid "If you'd like to use OpenID Connect authentication with Synapse, you'll need some additional configuration."

  189. msgstr ""

  190. 

  191. #: ../../../docs/configuring-playbook-synapse.md:112

  192. msgid "This example configuration is for [keycloak](https://www.keycloak.org/), an opensource Identity Provider maintained by Red Hat."

  193. msgstr ""

  194. 

  195. #: ../../../docs/configuring-playbook-synapse.md:114

  196. msgid "For more detailed documentation on available options and how to setup keycloak, see the [Synapse documentation on OpenID Connect with keycloak](https://github.com/element-hq/synapse/blob/develop/docs/openid.md#keycloak)."

  197. msgstr ""

  198. 

  199. #: ../../../docs/configuring-playbook-synapse.md:116

  200. msgid "In case you encounter errors regarding the parsing of the variables, you can try to add `{% raw %}` and `{% endraw %}` blocks around them. For example ;"

  201. msgstr ""

  202. 

  203. #: ../../../docs/configuring-playbook-synapse.md:137

  204. msgid "Customizing templates"

  205. msgstr ""

  206. 

  207. #: ../../../docs/configuring-playbook-synapse.md:139

  208. msgid "[Templates](https://github.com/element-hq/synapse/blob/develop/docs/templates.md) are used by Synapse for showing **certain web pages** handled by the server, as well as for **email notifications**."

  209. msgstr ""

  210. 

  211. #: ../../../docs/configuring-playbook-synapse.md:141

  212. msgid "This playbook allows you to customize the default templates (see the [`synapse/res/templates` directory](https://github.com/element-hq/synapse/tree/develop/synapse/res/templates))."

  213. msgstr ""

  214. 

  215. #: ../../../docs/configuring-playbook-synapse.md:143

  216. msgid "If template customization is enabled, the playbook will build a custom container image based on the official one."

  217. msgstr ""

  218. 

  219. #: ../../../docs/configuring-playbook-synapse.md:145

  220. msgid "Your custom templates need to live in a public or private git repository. This repository will be cloned during Synapse image customization (during the playbook run)."

  221. msgstr ""

  222. 

  223. #: ../../../docs/configuring-playbook-synapse.md:147

  224. msgid "To enable template customizations, add the following configuration to your `vars.yml` file (adapt to your needs):"

  225. msgstr ""

  226. 

  227. #: ../../../docs/configuring-playbook-synapse.md:173

  228. msgid "As mentioned in Synapse's Templates documentation, Synapse will fall back to its own templates if a template is not found in that directory. Due to this, it's recommended to only store and maintain template files in your repository if you need to make custom changes. Other files (which you don't need to change), should not be duplicated, so that you don't need to worry about getting out-of-sync with the original Synapse templates."

  229. msgstr ""

  230. 

  231. #: ../../../docs/configuring-playbook-synapse.md:175

  232. msgid "Extending the configuration"

  233. msgstr ""

  234. 

  235. #: ../../../docs/configuring-playbook-synapse.md:177

  236. msgid "There are some additional things you may wish to configure about the server."

  237. msgstr ""

  238. 

  239. #: ../../../docs/configuring-playbook-synapse.md:179

  240. msgid "Take a look at:"

  241. msgstr ""

  242. 

  243. #: ../../../docs/configuring-playbook-synapse.md:181

  244. msgid "`roles/custom/matrix-synapse/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"

  245. msgstr ""

  246. 

  247. #: ../../../docs/configuring-playbook-synapse.md:182

  248. msgid "`roles/custom/matrix-synapse/templates/synapse/homeserver.yaml.j2` for the server's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_synapse_configuration_extension_yaml` variable"

  249. msgstr ""

  250. 

  251. #: ../../../docs/configuring-playbook-synapse.md:184

  252. msgid "Installing"

  253. msgstr ""

  254. 

  255. #: ../../../docs/configuring-playbook-synapse.md:186

  256. msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"

  257. msgstr ""

  258. 

  259. #: ../../../docs/configuring-playbook-synapse.md:193

  260. msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"

  261. msgstr ""

  262. 

  263. #: ../../../docs/configuring-playbook-synapse.md:195

  264. msgid "`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too."

  265. msgstr ""

  266. 

  267. #: ../../../docs/configuring-playbook-synapse.md:197

  268. msgid "Usage"

  269. msgstr ""

  270. 

  271. #: ../../../docs/configuring-playbook-synapse.md:199

  272. msgid "Synapse Admin"

  273. msgstr ""

  274. 

  275. #: ../../../docs/configuring-playbook-synapse.md:201

  276. msgid "With [Synapse Admin](configuring-playbook-synapse-admin.md), certain Synapse administration tasks (managing users and rooms, etc.) can be performed via a web user-interace."

  277. msgstr ""

  278. 

  279. #: ../../../docs/configuring-playbook-synapse.md:203

  280. msgid "The playbook can install and configure Synapse Admin for you. For details about it, see [this page](configuring-playbook-synapse-admin.md)."

  281. msgstr ""

  282. 

  283. #: ../../../docs/configuring-playbook-synapse.md:205

  284. msgid "Monitoring Synapse Metrics with Prometheus and Grafana"

  285. msgstr ""

  286. 

  287. #: ../../../docs/configuring-playbook-synapse.md:207

  288. msgid "This playbook allows you to enable Synapse metrics, which can provide insight into the performance and activity of Synapse."

  289. msgstr ""

  290. 

  291. #: ../../../docs/configuring-playbook-synapse.md:209

  292. msgid "To enable Synapse runtime metrics, see: [Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server](configuring-playbook-prometheus-grafana.md) and [its subsection](configuring-playbook-prometheus-grafana.md#expose-metrics-of-other-services-roles)"

  293. msgstr ""

  294. 

  295. #: ../../../docs/configuring-playbook-synapse.md:211

  296. msgid "To enable Synapse usage metrics, see: [Enabling synapse-usage-exporter for Synapse usage statistics](configuring-playbook-synapse-usage-exporter.md)"

  297. msgstr ""

  298. 

  299. #: ../../../docs/configuring-playbook-synapse.md:213

  300. msgid "Troubleshooting"

  301. msgstr ""

  302. 

  303. #: ../../../docs/configuring-playbook-synapse.md:215

  304. msgid "As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-synapse`."

  305. msgstr ""

  306. 

  307. #: ../../../docs/configuring-playbook-synapse.md:217

  308. msgid "Increase logging verbosity"

  309. msgstr ""

  310. 

  311. #: ../../../docs/configuring-playbook-synapse.md:219

  312. msgid "Because Synapse is originally very chatty when it comes to logging, we intentionally reduce its [logging level](https://docs.python.org/3/library/logging.html#logging-levels) from `INFO` to `WARNING`."

  313. msgstr ""

  314. 

  315. #: ../../../docs/configuring-playbook-synapse.md:221

  316. msgid "If you'd like to debug an issue or [report a Synapse bug](https://github.com/element-hq/synapse/issues/new/choose) to the developers, it'd be better if you temporarily increase the logging verbosity to `INFO`. To do so, add the following configuration to your `vars.yml` file and re-run the playbook:"

  317. msgstr ""