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

514 lines
18 KiB

  1. # SOME DESCRIPTIVE TITLE.
  2. # Copyright (C) 2018-2024, Slavi Pantaleev, Aine Etke, MDAD community
  3. # members
  4. # This file is distributed under the same license as the
  5. # matrix-docker-ansible-deploy package.
  6. # FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
  7. #
  8. #, fuzzy
  9. msgid ""
  10. msgstr ""
  11. "Project-Id-Version: matrix-docker-ansible-deploy \n"
  12. "Report-Msgid-Bugs-To: \n"
  13. "POT-Creation-Date: 2024-12-16 12:05+0900\n"
  14. "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
  15. "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
  16. "Language: bg\n"
  17. "Language-Team: bg <LL@li.org>\n"
  18. "Plural-Forms: nplurals=2; plural=(n != 1);\n"
  19. "MIME-Version: 1.0\n"
  20. "Content-Type: text/plain; charset=utf-8\n"
  21. "Content-Transfer-Encoding: 8bit\n"
  22. "Generated-By: Babel 2.16.0\n"
  23. #: ../../../docs/configuring-playbook-prometheus-grafana.md:1
  24. msgid ""
  25. "Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server "
  26. "(optional)"
  27. msgstr ""
  28. #: ../../../docs/configuring-playbook-prometheus-grafana.md:3
  29. msgid ""
  30. "The playbook can install [Grafana](https://grafana.com/) with "
  31. "[Prometheus](https://prometheus.io/) and configure performance metrics of"
  32. " your homeserver with graphs for you."
  33. msgstr ""
  34. #: ../../../docs/configuring-playbook-prometheus-grafana.md:5
  35. msgid "Adjusting the playbook configuration"
  36. msgstr ""
  37. #: ../../../docs/configuring-playbook-prometheus-grafana.md:7
  38. msgid ""
  39. "To enable Grafana and/or Prometheus, add the following configuration to "
  40. "your `inventory/host_vars/matrix.example.com/vars.yml` file:"
  41. msgstr ""
  42. #: ../../../docs/configuring-playbook-prometheus-grafana.md:33
  43. msgid ""
  44. "The retention policy of Prometheus metrics is [15 days by "
  45. "default](https://prometheus.io/docs/prometheus/latest/storage"
  46. "/#operational-aspects). Older data gets deleted automatically."
  47. msgstr ""
  48. #: ../../../docs/configuring-playbook-prometheus-grafana.md:35
  49. msgid "Adjusting the Grafana URL"
  50. msgstr ""
  51. #: ../../../docs/configuring-playbook-prometheus-grafana.md:37
  52. msgid ""
  53. "By default, this playbook installs Grafana web user-interface on the "
  54. "`stats.` subdomain (`stats.example.com`) and requires you to [adjust your"
  55. " DNS records](#adjusting-dns-records)."
  56. msgstr ""
  57. #: ../../../docs/configuring-playbook-prometheus-grafana.md:39
  58. msgid ""
  59. "By tweaking the `grafana_hostname` variable, you can easily make the "
  60. "service available at a **different hostname** than the default one."
  61. msgstr ""
  62. #: ../../../docs/configuring-playbook-prometheus-grafana.md:41
  63. msgid ""
  64. "Example additional configuration for your "
  65. "`inventory/host_vars/matrix.example.com/vars.yml` file:"
  66. msgstr ""
  67. #: ../../../docs/configuring-playbook-prometheus-grafana.md:48
  68. msgid "Adjusting DNS records"
  69. msgstr ""
  70. #: ../../../docs/configuring-playbook-prometheus-grafana.md:50
  71. msgid ""
  72. "Once you've decided on the domain, **you may need to adjust your DNS** "
  73. "records to point the Grafana domain to the Matrix server."
  74. msgstr ""
  75. #: ../../../docs/configuring-playbook-prometheus-grafana.md:52
  76. msgid ""
  77. "By default, you will need to create a CNAME record for `stats`. See "
  78. "[Configuring DNS](configuring-dns.md) for details about DNS changes."
  79. msgstr ""
  80. #: ../../../docs/configuring-playbook-prometheus-grafana.md:54
  81. msgid ""
  82. "**Note**: It is possible to install Prometheus without installing "
  83. "Grafana. This case it is not required to create the CNAME record."
  84. msgstr ""
  85. #: ../../../docs/configuring-playbook-prometheus-grafana.md:56
  86. msgid "Installing"
  87. msgstr ""
  88. #: ../../../docs/configuring-playbook-prometheus-grafana.md:58
  89. msgid ""
  90. "After configuring the playbook and potentially [adjusting your DNS "
  91. "records](#adjusting-dns-records), run the playbook with [playbook tags"
  92. "](playbook-tags.md) as below:"
  93. msgstr ""
  94. #: ../../../docs/configuring-playbook-prometheus-grafana.md:65
  95. msgid ""
  96. "The shortcut commands with the [`just` program](just.md) are also "
  97. "available: `just install-all` or `just setup-all`"
  98. msgstr ""
  99. #: ../../../docs/configuring-playbook-prometheus-grafana.md:67
  100. msgid ""
  101. "`just install-all` is useful for maintaining your setup quickly ([2x-5x "
  102. "faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-"
  103. "runtime) than `just setup-all`) when its components remain unchanged. If "
  104. "you adjust your `vars.yml` to remove other components, you'd need to run "
  105. "`just setup-all`, or these components will still remain installed. Note "
  106. "these shortcuts run the `ensure-matrix-users-created` tag too."
  107. msgstr ""
  108. #: ../../../docs/configuring-playbook-prometheus-grafana.md:69
  109. msgid "What does it do?"
  110. msgstr ""
  111. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  112. msgid "Name"
  113. msgstr ""
  114. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  115. msgid "Description"
  116. msgstr ""
  117. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  118. msgid "`prometheus_enabled`"
  119. msgstr ""
  120. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  121. msgid ""
  122. "[Prometheus](https://prometheus.io) is a time series database. It holds "
  123. "all the data we're going to talk about."
  124. msgstr ""
  125. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  126. msgid "`prometheus_node_exporter_enabled`"
  127. msgstr ""
  128. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  129. msgid ""
  130. "[Node Exporter](https://prometheus.io/docs/guides/node-exporter/) is an "
  131. "addon of sorts to Prometheus that collects generic system information "
  132. "such as CPU, memory, filesystem, and even system temperatures"
  133. msgstr ""
  134. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  135. msgid "`prometheus_postgres_exporter_enabled`"
  136. msgstr ""
  137. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  138. msgid ""
  139. "[Postgres Exporter](configuring-playbook-prometheus-postgres.md) is an "
  140. "addon of sorts to expose Postgres database metrics to Prometheus."
  141. msgstr ""
  142. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  143. msgid "`matrix_prometheus_nginxlog_exporter_enabled`"
  144. msgstr ""
  145. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  146. msgid ""
  147. "[NGINX Log Exporter](configuring-playbook-prometheus-nginxlog.md) is an "
  148. "addon of sorts to expose NGINX logs to Prometheus."
  149. msgstr ""
  150. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  151. msgid "`grafana_enabled`"
  152. msgstr ""
  153. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  154. msgid ""
  155. "[Grafana](https://grafana.com/) is the visual component. It shows (on the"
  156. " `stats.example.com` subdomain) the dashboards with the graphs that we're"
  157. " interested in"
  158. msgstr ""
  159. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  160. msgid "`grafana_anonymous_access`"
  161. msgstr ""
  162. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  163. msgid ""
  164. "By default you need to log in to see graphs. If you want to publicly "
  165. "share your graphs (e.g. when asking for help in "
  166. "[`#synapse:matrix.org`](https://matrix.to/#/#synapse:matrix.org?via=matrix.org&via=privacytools.io&via=mozilla.org))"
  167. " you'll want to enable this option."
  168. msgstr ""
  169. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  170. msgid "`grafana_default_admin_user`<br>`grafana_default_admin_password`"
  171. msgstr ""
  172. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  173. msgid ""
  174. "By default Grafana creates a user with `admin` as the username and "
  175. "password. If you feel this is insecure and you want to change it "
  176. "beforehand, you can do that here"
  177. msgstr ""
  178. #: ../../../docs/configuring-playbook-prometheus-grafana.md:81
  179. msgid "Security and privacy"
  180. msgstr ""
  181. #: ../../../docs/configuring-playbook-prometheus-grafana.md:83
  182. msgid ""
  183. "Metrics and resulting graphs can contain a lot of information. This "
  184. "includes system specs but also usage patterns. This applies especially to"
  185. " small personal/family scale homeservers. Someone might be able to figure"
  186. " out when you wake up and go to sleep by looking at the graphs over time."
  187. " Think about this before enabling anonymous access. And you should really"
  188. " not forget to change your Grafana password."
  189. msgstr ""
  190. #: ../../../docs/configuring-playbook-prometheus-grafana.md:85
  191. msgid ""
  192. "Most of our docker containers run with limited system access, but the "
  193. "`prometheus-node-exporter` has access to the host network stack and "
  194. "(readonly) root filesystem. This is required to report on them. If you "
  195. "don't like that, you can set `prometheus_node_exporter_enabled: false` "
  196. "(which is actually the default). You will still get Synapse metrics with "
  197. "this container disabled. Both of the dashboards will always be enabled, "
  198. "so you can still look at historical data after disabling either source."
  199. msgstr ""
  200. #: ../../../docs/configuring-playbook-prometheus-grafana.md:87
  201. msgid "Collecting metrics to an external Prometheus server"
  202. msgstr ""
  203. #: ../../../docs/configuring-playbook-prometheus-grafana.md:89
  204. msgid ""
  205. "**If the integrated Prometheus server is enabled** (`prometheus_enabled: "
  206. "true`), metrics are collected by it from each service via communication "
  207. "that happens over the container network. Each service does not need to "
  208. "expose its metrics \"publicly\"."
  209. msgstr ""
  210. #: ../../../docs/configuring-playbook-prometheus-grafana.md:91
  211. msgid ""
  212. "When you'd like **to collect metrics from an external Prometheus "
  213. "server**, you need to expose service metrics outside of the container "
  214. "network."
  215. msgstr ""
  216. #: ../../../docs/configuring-playbook-prometheus-grafana.md:93
  217. msgid ""
  218. "The playbook provides a single endpoint "
  219. "(`https://matrix.example.com/metrics/*`), under which various services "
  220. "may expose their metrics (e.g. `/metrics/node-exporter`, `/metrics"
  221. "/postgres-exporter`, `/metrics/hookshot`, etc). To expose all services on"
  222. " this `/metrics/*` feature, use `matrix_metrics_exposure_enabled`. To "
  223. "protect access using [Basic "
  224. "Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication),"
  225. " see `matrix_metrics_exposure_http_basic_auth_enabled` and "
  226. "`matrix_metrics_exposure_http_basic_auth_users` below."
  227. msgstr ""
  228. #: ../../../docs/configuring-playbook-prometheus-grafana.md:95
  229. msgid ""
  230. "When using `matrix_metrics_exposure_enabled`, you don't need to expose "
  231. "metrics for individual services one by one."
  232. msgstr ""
  233. #: ../../../docs/configuring-playbook-prometheus-grafana.md:97
  234. msgid "The following variables may be of interest:"
  235. msgstr ""
  236. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  237. msgid "`matrix_metrics_exposure_enabled`"
  238. msgstr ""
  239. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  240. msgid ""
  241. "Set this to `true` to **enable metrics exposure for all services** on "
  242. "`https://matrix.example.com/metrics/*`. If you think this is too much, "
  243. "refer to the helpful (but nonexhaustive) list of individual "
  244. "`matrix_SERVICE_metrics_proxying_enabled` (or similar) variables below "
  245. "for exposing metrics on a per-service basis."
  246. msgstr ""
  247. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  248. msgid "`matrix_metrics_exposure_http_basic_auth_enabled`"
  249. msgstr ""
  250. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  251. msgid ""
  252. "Set this to `true` to protect all `https://matrix.example.com/metrics/*` "
  253. "endpoints with [Basic "
  254. "Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication)"
  255. " (see the other variables below for supplying the actual credentials). "
  256. "When enabled, all endpoints beneath `/metrics` will be protected with the"
  257. " same credentials"
  258. msgstr ""
  259. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  260. msgid "`matrix_metrics_exposure_http_basic_auth_users`"
  261. msgstr ""
  262. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  263. msgid ""
  264. "Set this to the Basic Authentication credentials (raw `htpasswd` file "
  265. "content) used to protect `/metrics/*`. This htpasswd-file needs to be "
  266. "generated with the `htpasswd` tool and can include multiple "
  267. "username/password pairs."
  268. msgstr ""
  269. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  270. msgid "`matrix_synapse_metrics_enabled`"
  271. msgstr ""
  272. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  273. msgid ""
  274. "Set this to `true` to make Synapse expose metrics (locally, on the "
  275. "container network)"
  276. msgstr ""
  277. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  278. msgid "`matrix_synapse_metrics_proxying_enabled`"
  279. msgstr ""
  280. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  281. msgid ""
  282. "Set this to `true` to expose Synapse's metrics on "
  283. "`https://matrix.example.com/metrics/synapse/main-process` and "
  284. "`https://matrix.example.com/metrics/synapse/worker/TYPE-ID`. Read [below"
  285. "](#collecting-synapse-worker-metrics-to-an-external-prometheus-server) if"
  286. " you're running a Synapse worker setup (`matrix_synapse_workers_enabled: "
  287. "true`). To password-protect the metrics, see "
  288. "`matrix_metrics_exposure_http_basic_auth_users` above."
  289. msgstr ""
  290. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  291. msgid ""
  292. "Set this to `true` to enable the node (general system stats) exporter "
  293. "(locally, on the container network)"
  294. msgstr ""
  295. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  296. msgid "`prometheus_node_exporter_container_labels_traefik_enabled`"
  297. msgstr ""
  298. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  299. msgid ""
  300. "Set this to `true` to expose the node (general system stats) metrics on "
  301. "`https://matrix.example.com/metrics/node-exporter`. To password-protect "
  302. "the metrics, see `matrix_metrics_exposure_http_basic_auth_users` above."
  303. msgstr ""
  304. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  305. msgid ""
  306. "Set this to `true` to enable the [Postgres exporter](configuring-"
  307. "playbook-prometheus-postgres.md) (locally, on the container network)"
  308. msgstr ""
  309. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  310. msgid "`prometheus_postgres_exporter_container_labels_traefik_enabled`"
  311. msgstr ""
  312. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  313. msgid ""
  314. "Set this to `true` to expose the [Postgres exporter](configuring-"
  315. "playbook-prometheus-postgres.md) metrics on "
  316. "`https://matrix.example.com/metrics/postgres-exporter`. To password-"
  317. "protect the metrics, see `matrix_metrics_exposure_http_basic_auth_users` "
  318. "above."
  319. msgstr ""
  320. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  321. msgid ""
  322. "Set this to `true` to enable the [NGINX Log exporter](configuring-"
  323. "playbook-prometheus-nginxlog.md) (locally, on the container network)"
  324. msgstr ""
  325. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  326. msgid "`matrix_sliding_sync_metrics_enabled`"
  327. msgstr ""
  328. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  329. msgid ""
  330. "Set this to `true` to make [Sliding Sync](configuring-playbook-sliding-"
  331. "sync-proxy.md) expose metrics (locally, on the container network)"
  332. msgstr ""
  333. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  334. msgid "`matrix_sliding_sync_metrics_proxying_enabled`"
  335. msgstr ""
  336. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  337. msgid ""
  338. "Set this to `true` to expose the [Sliding Sync](configuring-playbook-"
  339. "sliding-sync-proxy.md) metrics on `https://matrix.example.com/metrics"
  340. "/sliding-sync`. To password-protect the metrics, see "
  341. "`matrix_metrics_exposure_http_basic_auth_users` above."
  342. msgstr ""
  343. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  344. msgid "`matrix_bridge_hookshot_metrics_enabled`"
  345. msgstr ""
  346. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  347. msgid ""
  348. "Set this to `true` to make [Hookshot](configuring-playbook-bridge-"
  349. "hookshot.md) expose metrics (locally, on the container network)"
  350. msgstr ""
  351. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  352. msgid "`matrix_bridge_hookshot_metrics_proxying_enabled`"
  353. msgstr ""
  354. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  355. msgid ""
  356. "Set this to `true` to expose the [Hookshot](configuring-playbook-bridge-"
  357. "hookshot.md) metrics on `https://matrix.example.com/metrics/hookshot`. To"
  358. " password-protect the metrics, see "
  359. "`matrix_metrics_exposure_http_basic_auth_users` above."
  360. msgstr ""
  361. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  362. msgid "`matrix_SERVICE_metrics_proxying_enabled`"
  363. msgstr ""
  364. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  365. msgid ""
  366. "Various other services/roles may provide similar `_metrics_enabled` and "
  367. "`_metrics_proxying_enabled` variables for exposing their metrics. Refer "
  368. "to each role for details. To password-protect the metrics, see "
  369. "`matrix_metrics_exposure_http_basic_auth_users` above or "
  370. "`matrix_SERVICE_container_labels_metrics_middleware_basic_auth_enabled`/`matrix_SERVICE_container_labels_metrics_middleware_basic_auth_users`"
  371. " variables provided by each role."
  372. msgstr ""
  373. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  374. msgid "`matrix_media_repo_metrics_enabled`"
  375. msgstr ""
  376. #: ../../../docs/configuring-playbook-prometheus-grafana.md
  377. msgid ""
  378. "Set this to `true` to make media-repo expose metrics (locally, on the "
  379. "container network)"
  380. msgstr ""
  381. #: ../../../docs/configuring-playbook-prometheus-grafana.md:118
  382. msgid "Collecting Synapse worker metrics to an external Prometheus server"
  383. msgstr ""
  384. #: ../../../docs/configuring-playbook-prometheus-grafana.md:120
  385. msgid ""
  386. "If you are using workers (`matrix_synapse_workers_enabled: true`) and "
  387. "have enabled `matrix_synapse_metrics_proxying_enabled` as described "
  388. "above, the playbook will also automatically expose all Synapse worker "
  389. "threads' metrics to "
  390. "`https://matrix.example.com/metrics/synapse/worker/ID`, where `ID` "
  391. "corresponds to the worker `id` as exemplified in "
  392. "`matrix_synapse_workers_enabled_list`."
  393. msgstr ""
  394. #: ../../../docs/configuring-playbook-prometheus-grafana.md:122
  395. msgid ""
  396. "The playbook also generates an exemplary config file "
  397. "(`/matrix/synapse/external_prometheus.yml.template`) with all the correct"
  398. " paths which you can copy to your Prometheus server and adapt to your "
  399. "needs. Make sure to edit the specified `password_file` path and contents "
  400. "and path to your `synapse-v2.rules`. It will look a bit like this:"
  401. msgstr ""
  402. #: ../../../docs/configuring-playbook-prometheus-grafana.md:150
  403. msgid "More information"
  404. msgstr ""
  405. #: ../../../docs/configuring-playbook-prometheus-grafana.md:152
  406. msgid ""
  407. "[Enabling synapse-usage-exporter for Synapse usage statistics"
  408. "](configuring-playbook-synapse-usage-exporter.md)"
  409. msgstr ""
  410. #: ../../../docs/configuring-playbook-prometheus-grafana.md:153
  411. msgid ""
  412. "[Understanding Synapse Performance Issues Through Grafana Graphs](https"
  413. "://element-"
  414. "hq.github.io/synapse/latest/usage/administration/understanding_synapse_through_grafana_graphs.html)"
  415. " at the Synapse Github Wiki"
  416. msgstr ""
  417. #: ../../../docs/configuring-playbook-prometheus-grafana.md:154
  418. msgid ""
  419. "[The Prometheus scraping rules](https://github.com/element-"
  420. "hq/synapse/tree/master/contrib/prometheus) (we use v2)"
  421. msgstr ""
  422. #: ../../../docs/configuring-playbook-prometheus-grafana.md:155
  423. msgid ""
  424. "[The Synapse Grafana dashboard](https://github.com/element-"
  425. "hq/synapse/tree/master/contrib/grafana)"
  426. msgstr ""
  427. #: ../../../docs/configuring-playbook-prometheus-grafana.md:156
  428. msgid ""
  429. "[The Node Exporter dashboard](https://github.com/rfrail3/grafana-"
  430. "dashboards) (for generic non-synapse performance graphs)"
  431. msgstr ""