overmind
/
matrix-docker-ansible-deploy
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Fork 0
Code Issues 0 Releases 0 Wiki Activity
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.
10672 Commits
12 Branches
1.6 GiB
 
 
Tree: bab0f8639c
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'bab0f8639c'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-synaps...

142 lines
7.0 KiB
Raw Blame History 

  1. # SOME DESCRIPTIVE TITLE.

  2. # Copyright (C) 2018-2025, 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: 2025-11-06 23:09+0900\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-usage-exporter.md:9

  20. msgid "Enabling synapse-usage-exporter for Synapse usage statistics (optional)"

  21. msgstr ""

  22. 

  23. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:11

  24. msgid "The playbook can install and configure [synapse-usage-exporter](https://github.com/loelkes/synapse-usage-exporter) for you."

  25. msgstr ""

  26. 

  27. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:13

  28. msgid "It allows you to export the usage statistics of a Synapse homeserver to this container service and for the collected metrics to later be scraped by Prometheus."

  29. msgstr ""

  30. 

  31. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:15

  32. msgid "Synapse does not include usage statistics in its Prometheus metrics. They can be reported to an HTTP `PUT` endpoint 5 minutes after startup and from then on at a fixed interval of once every three hours. This role integrates a simple [Flask](https://flask.palletsprojects.com) project that offers an HTTP `PUT` endpoint and holds the most recent received record available to be scraped by Prometheus."

  33. msgstr ""

  34. 

  35. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:17

  36. msgid "See the project's [documentation](https://github.com/loelkes/synapse-usage-exporter/blob/main/README.md) to learn what it does and why it might be useful to you."

  37. msgstr ""

  38. 

  39. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:19

  40. msgid "What does it do?"

  41. msgstr ""

  42. 

  43. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:21

  44. msgid "Enabling this service will automatically:"

  45. msgstr ""

  46. 

  47. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:23

  48. msgid "install the synapse-usage-exporter service"

  49. msgstr ""

  50. 

  51. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:24

  52. msgid "re-configure Synapse to push (via HTTP `PUT`) usage statistics information to synapse-usage-exporter"

  53. msgstr ""

  54. 

  55. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:25

  56. msgid "re-configure [Prometheus](./configuring-playbook-prometheus-grafana.md) (if Prometheus is enabled), to periodically scrape metrics from synapse-usage-exporter"

  57. msgstr ""

  58. 

  59. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:26

  60. msgid "add a new [Grafana](./configuring-playbook-prometheus-grafana.md) dashboard (if Grafana is enabled) containing Synapse usage statistics"

  61. msgstr ""

  62. 

  63. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:28

  64. msgid "Adjusting DNS records (optional)"

  65. msgstr ""

  66. 

  67. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:30

  68. msgid "By default, this playbook installs synapse-usage-exporter on the `matrix.` subdomain, at the `/report-usage-stats/push` path (https://matrix.example.com/report-usage-stats/push). This makes it easy to install it, because it **doesn't require additional DNS records to be set up**. If that's okay, you can skip this section."

  69. msgstr ""

  70. 

  71. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:32

  72. msgid "If you wish to adjust it, see the section [below](#adjusting-the-synapse-usage-exporter-url-optional) for details about DNS configuration."

  73. msgstr ""

  74. 

  75. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:34

  76. msgid "Adjusting the playbook configuration"

  77. msgstr ""

  78. 

  79. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:36

  80. msgid "To enable synapse-usage-exporter, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"

  81. msgstr ""

  82. 

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

  84. msgid "Adjusting the synapse-usage-exporter URL (optional)"

  85. msgstr ""

  86. 

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

  88. msgid "By tweaking the `matrix_synapse_usage_exporter_hostname` and `matrix_synapse_usage_exporter_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one."

  89. msgstr ""

  90. 

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

  92. msgid "Example additional configuration for your `vars.yml` file:"

  93. msgstr ""

  94. 

  95. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:61

  96. msgid "If you've changed the default hostname, you may need to create a CNAME record for the synapse-usage-exporter domain (`sue.example.com`), which targets `matrix.example.com`."

  97. msgstr ""

  98. 

  99. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:63

  100. msgid "When setting, replace `example.com` with your own."

  101. msgstr ""

  102. 

  103. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:65

  104. msgid "Extending the configuration"

  105. msgstr ""

  106. 

  107. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:67

  108. msgid "There are some additional things you may wish to configure about the component."

  109. msgstr ""

  110. 

  111. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:69

  112. msgid "Take a look at:"

  113. msgstr ""

  114. 

  115. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:71

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

  117. msgstr ""

  118. 

  119. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:73

  120. msgid "Installing"

  121. msgstr ""

  122. 

  123. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:75

  124. msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:"

  125. msgstr ""

  126. 

  127. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:82

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

  129. msgstr ""

  130. 

  131. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:84

  132. 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."

  133. msgstr ""

  134. 

  135. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:86

  136. msgid "Troubleshooting"

  137. msgstr ""

  138. 

  139. #: ../../../docs/configuring-playbook-synapse-usage-exporter.md:88

  140. 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-usage-exporter`."

  141. msgstr ""