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.
10967 Commits
13 Branches
36 MiB
 
 
Branch: master
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'master'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-bridge...

374 lines
16 KiB
Raw Permalink Blame History 

  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-02-13 10:32+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-bridge-hookshot.md:11

  20. msgid "Setting up matrix-hookshot (optional)"

  21. msgstr ""

  22. 

  23. #: ../../../docs/configuring-playbook-bridge-hookshot.md:13

  24. msgid "The playbook can install and configure [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) for you."

  25. msgstr ""

  26. 

  27. #: ../../../docs/configuring-playbook-bridge-hookshot.md:15

  28. msgid "Hookshot can bridge [Webhooks](https://en.wikipedia.org/wiki/Webhook) from software project management services such as GitHub, GitLab, Jira, and Figma, as well as generic webhooks."

  29. msgstr ""

  30. 

  31. #: ../../../docs/configuring-playbook-bridge-hookshot.md:17

  32. msgid "See the project's [documentation](https://matrix-org.github.io/matrix-hookshot/latest/hookshot.html) to learn what it does and why it might be useful to you."

  33. msgstr ""

  34. 

  35. #: ../../../docs/configuring-playbook-bridge-hookshot.md:19

  36. msgid "Prerequisites"

  37. msgstr ""

  38. 

  39. #: ../../../docs/configuring-playbook-bridge-hookshot.md:21

  40. msgid "Download GitHub app private key (optional)"

  41. msgstr ""

  42. 

  43. #: ../../../docs/configuring-playbook-bridge-hookshot.md:23

  44. msgid "If you're setting up the GitHub bridge, you need to create your GitHub app, and generate a private key file of it."

  45. msgstr ""

  46. 

  47. #: ../../../docs/configuring-playbook-bridge-hookshot.md:25

  48. msgid "You need to download the private key file, if you will install the file manually or with the `aux` role. For details, see [the section below](#manage-github-private-key-with-aux-role)."

  49. msgstr ""

  50. 

  51. #: ../../../docs/configuring-playbook-bridge-hookshot.md:27

  52. msgid "Adjusting the playbook configuration"

  53. msgstr ""

  54. 

  55. #: ../../../docs/configuring-playbook-bridge-hookshot.md:29

  56. msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `GITHUB_PRIVATE_KEY_HERE` with the one created [above](#download-github-app-private-key)."

  57. msgstr ""

  58. 

  59. #: ../../../docs/configuring-playbook-bridge-hookshot.md:43

  60. msgid "For each of the services (GitHub, GitLab, Jira, Figma, and generic webhooks) fill in the respective variables `matrix_hookshot_service_*` listed in [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml) as required."

  61. msgstr ""

  62. 

  63. #: ../../../docs/configuring-playbook-bridge-hookshot.md:45

  64. msgid "Take special note of the `matrix_hookshot_*_enabled` variables. Services that need no further configuration are enabled by default (GitLab and generic webhooks), while you must first add the required configuration and enable the others (GitHub, Jira, and Figma)."

  65. msgstr ""

  66. 

  67. #: ../../../docs/configuring-playbook-bridge-hookshot.md:47

  68. msgid "Extending the configuration"

  69. msgstr ""

  70. 

  71. #: ../../../docs/configuring-playbook-bridge-hookshot.md:49

  72. msgid "There are some additional things you may wish to configure about the bridge."

  73. msgstr ""

  74. 

  75. #: ../../../docs/configuring-playbook-bridge-hookshot.md:51

  76. msgid "Take a look at:"

  77. msgstr ""

  78. 

  79. #: ../../../docs/configuring-playbook-bridge-hookshot.md:53

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

  81. msgstr ""

  82. 

  83. #: ../../../docs/configuring-playbook-bridge-hookshot.md:54

  84. msgid "`roles/custom/matrix-bridge-hookshot/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_hookshot_configuration_extension_yaml` and `matrix_hookshot_registration_extension_yaml` variables"

  85. msgstr ""

  86. 

  87. #: ../../../docs/configuring-playbook-bridge-hookshot.md:56

  88. msgid "Refer the [official instructions](https://matrix-org.github.io/matrix-hookshot/latest/setup.html) and the comments in [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml) to learn what the individual options do."

  89. msgstr ""

  90. 

  91. #: ../../../docs/configuring-playbook-bridge-hookshot.md:58

  92. msgid "Installing"

  93. msgstr ""

  94. 

  95. #: ../../../docs/configuring-playbook-bridge-hookshot.md:60

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

  97. msgstr ""

  98. 

  99. #: ../../../docs/configuring-playbook-bridge-hookshot.md:67

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

  101. msgstr ""

  102. 

  103. #: ../../../docs/configuring-playbook-bridge-hookshot.md:69

  104. msgid "`just install-service hookshot` is useful for maintaining your setup quickly 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 `just setup-all` runs the `ensure-matrix-users-created` tag too."

  105. msgstr ""

  106. 

  107. #: ../../../docs/configuring-playbook-bridge-hookshot.md:71

  108. msgid "Usage"

  109. msgstr ""

  110. 

  111. #: ../../../docs/configuring-playbook-bridge-hookshot.md:73

  112. msgid "To use the bridge, you need to create a room and invite the Hookshot bot (`@hookshot:example.com`) to it."

  113. msgstr ""

  114. 

  115. #: ../../../docs/configuring-playbook-bridge-hookshot.md:75

  116. msgid "Make sure the bot is able to send state events (usually the Moderator power level in clients)."

  117. msgstr ""

  118. 

  119. #: ../../../docs/configuring-playbook-bridge-hookshot.md:77

  120. msgid "Send `!hookshot help` to the bot to see the available commands."

  121. msgstr ""

  122. 

  123. #: ../../../docs/configuring-playbook-bridge-hookshot.md:79

  124. msgid "Refer to [Hookshot's documentation](https://matrix-org.github.io/matrix-hookshot/latest/usage.html) for more details about using the bridge's various features."

  125. msgstr ""

  126. 

  127. #: ../../../docs/configuring-playbook-bridge-hookshot.md:81

  128. msgid "💡 **Note**: the different listeners are bound to certain paths which might differ from those assumed by the hookshot documentation. See [URLs for bridges setup](#urls-for-bridges-setup) below."

  129. msgstr ""

  130. 

  131. #: ../../../docs/configuring-playbook-bridge-hookshot.md:83

  132. msgid "Reset crypto store"

  133. msgstr ""

  134. 

  135. #: ../../../docs/configuring-playbook-bridge-hookshot.md:85

  136. msgid "Should the crypto store be corrupted, you can reset it by executing this Ansible playbook with the tag `reset-hookshot-encryption` added:"

  137. msgstr ""

  138. 

  139. #: ../../../docs/configuring-playbook-bridge-hookshot.md:91

  140. msgid "More setup documentation"

  141. msgstr ""

  142. 

  143. #: ../../../docs/configuring-playbook-bridge-hookshot.md:93

  144. msgid "URLs for bridges setup"

  145. msgstr ""

  146. 

  147. #: ../../../docs/configuring-playbook-bridge-hookshot.md:95

  148. msgid "Unless indicated otherwise, the following endpoints are reachable on your `matrix.` subdomain (if the feature is enabled)."

  149. msgstr ""

  150. 

  151. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  152. msgid "Listener"

  153. msgstr ""

  154. 

  155. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  156. msgid "Default path"

  157. msgstr ""

  158. 

  159. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  160. msgid "Variable"

  161. msgstr ""

  162. 

  163. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  164. msgid "Used as"

  165. msgstr ""

  166. 

  167. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  168. msgid "-"

  169. msgstr ""

  170. 

  171. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  172. msgid "`/hookshot/webhooks/`"

  173. msgstr ""

  174. 

  175. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  176. msgid "`matrix_hookshot_webhook_endpoint`"

  177. msgstr ""

  178. 

  179. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  180. msgid "Webhook-prefix, which affects all webhook-related URLs below"

  181. msgstr ""

  182. 

  183. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  184. msgid "generic"

  185. msgstr ""

  186. 

  187. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  188. msgid "`/hookshot/webhooks/webhook`"

  189. msgstr ""

  190. 

  191. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  192. msgid "`matrix_hookshot_generic_endpoint`"

  193. msgstr ""

  194. 

  195. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  196. msgid "Generic webhooks"

  197. msgstr ""

  198. 

  199. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  200. msgid "github oauth"

  201. msgstr ""

  202. 

  203. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  204. msgid "`/hookshot/webhooks/oauth`"

  205. msgstr ""

  206. 

  207. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  208. msgid "`matrix_hookshot_github_oauth_endpoint`"

  209. msgstr ""

  210. 

  211. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  212. msgid "GitHub \"Callback URL\""

  213. msgstr ""

  214. 

  215. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  216. msgid "jira oauth"

  217. msgstr ""

  218. 

  219. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  220. msgid "`/hookshot/webhooks/jira/oauth`"

  221. msgstr ""

  222. 

  223. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  224. msgid "`matrix_hookshot_jira_oauth_endpoint`"

  225. msgstr ""

  226. 

  227. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  228. msgid "Jira OAuth"

  229. msgstr ""

  230. 

  231. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  232. msgid "figma endpoint"

  233. msgstr ""

  234. 

  235. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  236. msgid "`/hookshot/webhooks/figma/webhook`"

  237. msgstr ""

  238. 

  239. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  240. msgid "`matrix_hookshot_figma_endpoint`"

  241. msgstr ""

  242. 

  243. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  244. msgid "Figma"

  245. msgstr ""

  246. 

  247. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  248. msgid "appservice"

  249. msgstr ""

  250. 

  251. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  252. msgid "`/hookshot/_matrix/app/`"

  253. msgstr ""

  254. 

  255. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  256. msgid "`matrix_hookshot_appservice_endpoint`"

  257. msgstr ""

  258. 

  259. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  260. msgid "Matrix server"

  261. msgstr ""

  262. 

  263. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  264. msgid "widgets"

  265. msgstr ""

  266. 

  267. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  268. msgid "`/hookshot/widgetapi/`"

  269. msgstr ""

  270. 

  271. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  272. msgid "`matrix_hookshot_widgets_endpoint`"

  273. msgstr ""

  274. 

  275. #: ../../../docs/configuring-playbook-bridge-hookshot.md:0

  276. msgid "Widgets"

  277. msgstr ""

  278. 

  279. #: ../../../docs/configuring-playbook-bridge-hookshot.md:107

  280. msgid "Also see the various `matrix_hookshot_container_labels_*` variables in [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml), which expose URLs publicly."

  281. msgstr ""

  282. 

  283. #: ../../../docs/configuring-playbook-bridge-hookshot.md:109

  284. msgid "The different listeners are also reachable *internally* in the docker-network via the container's name (configured by `matrix_hookshot_container_url`) and on different ports (e.g. `matrix_hookshot_appservice_port`). Read [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml) in detail for more info."

  285. msgstr ""

  286. 

  287. #: ../../../docs/configuring-playbook-bridge-hookshot.md:111

  288. msgid "Manage GitHub Private Key with aux role"

  289. msgstr ""

  290. 

  291. #: ../../../docs/configuring-playbook-bridge-hookshot.md:113

  292. msgid "The GitHub bridge requires you to install a private key file. This can be done in multiple ways:"

  293. msgstr ""

  294. 

  295. #: ../../../docs/configuring-playbook-bridge-hookshot.md:115

  296. msgid "copy the *contents* of the downloaded file and set the variable `matrix_hookshot_github_private_key` to the contents (see example in [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml))."

  297. msgstr ""

  298. 

  299. #: ../../../docs/configuring-playbook-bridge-hookshot.md:116

  300. msgid "somehow copy the file to the path `{{ matrix_hookshot_base_path }}/{{ matrix_hookshot_github_private_key_file }}` (default: `/matrix/hookshot/private-key.pem`) on the server manually."

  301. msgstr ""

  302. 

  303. #: ../../../docs/configuring-playbook-bridge-hookshot.md:117

  304. msgid "use the [`aux` role](https://github.com/mother-of-all-self-hosting/ansible-role-aux) to copy the file from an arbitrary path on your ansible client to the correct path on the server."

  305. msgstr ""

  306. 

  307. #: ../../../docs/configuring-playbook-bridge-hookshot.md:119

  308. msgid "To use the `aux` role, make sure the `matrix_hookshot_github_private_key` variable is empty. Then add the following configuration to your `vars.yml` file:"

  309. msgstr ""

  310. 

  311. #: ../../../docs/configuring-playbook-bridge-hookshot.md:130

  312. msgid "For more information, see the documentation in the [default configuration of the aux role](https://github.com/mother-of-all-self-hosting/ansible-role-aux/blob/main/defaults/main.yml)."

  313. msgstr ""

  314. 

  315. #: ../../../docs/configuring-playbook-bridge-hookshot.md:132

  316. msgid "Enable metrics"

  317. msgstr ""

  318. 

  319. #: ../../../docs/configuring-playbook-bridge-hookshot.md:134

  320. msgid "The playbook can enable and configure the metrics of the service for you."

  321. msgstr ""

  322. 

  323. #: ../../../docs/configuring-playbook-bridge-hookshot.md:136

  324. msgid "Metrics are **only enabled by default** if the builtin [Prometheus](configuring-playbook-prometheus-grafana.md) is enabled (by default, Prometheus isn't enabled). If so, metrics will automatically be collected by Prometheus and made available in Grafana. You will, however, need to set up your own Dashboard for displaying them."

  325. msgstr ""

  326. 

  327. #: ../../../docs/configuring-playbook-bridge-hookshot.md:138

  328. msgid "To enable the metrics, add the following configuration to your `vars.yml` file:"

  329. msgstr ""

  330. 

  331. #: ../../../docs/configuring-playbook-bridge-hookshot.md:145

  332. msgid "**To collect metrics from an external Prometheus server**, besides enabling metrics as described above, you will also need to enable metrics exposure on `https://matrix.example.com/metrics/hookshot` by adding the following configuration to your `vars.yml` file:"

  333. msgstr ""

  334. 

  335. #: ../../../docs/configuring-playbook-bridge-hookshot.md:151

  336. msgid "By default metrics are exposed publicly **without** password-protection. To password-protect the metrics with dedicated credentials, add the following configuration to your `vars.yml` file:"

  337. msgstr ""

  338. 

  339. #: ../../../docs/configuring-playbook-bridge-hookshot.md:158

  340. msgid "To `matrix_hookshot_container_labels_metrics_middleware_basic_auth_users`, set the Basic Authentication credentials (raw `htpasswd` file content) used to protect the endpoint. See https://doc.traefik.io/traefik/middlewares/http/basicauth/#users for details about it."

  341. msgstr ""

  342. 

  343. #: ../../../docs/configuring-playbook-bridge-hookshot.md:160

  344. msgid "**Note**: alternatively, you can use `matrix_metrics_exposure_enabled` to expose all services on this `/metrics/*` feature, and you can use `matrix_metrics_exposure_http_basic_auth_enabled` and `matrix_metrics_exposure_http_basic_auth_users` to password-protect the metrics of them. See [this section](configuring-playbook-prometheus-grafana.md#collecting-metrics-to-an-external-prometheus-server) for more information."

  345. msgstr ""

  346. 

  347. #: ../../../docs/configuring-playbook-bridge-hookshot.md:162

  348. msgid "Enable Grafana (optional)"

  349. msgstr ""

  350. 

  351. #: ../../../docs/configuring-playbook-bridge-hookshot.md:164

  352. msgid "Probably you wish to enable Grafana along with Prometheus for generating graphs of the metrics."

  353. msgstr ""

  354. 

  355. #: ../../../docs/configuring-playbook-bridge-hookshot.md:166

  356. msgid "To enable Grafana, see [this section](configuring-playbook-prometheus-grafana.md#adjusting-the-playbook-configuration-grafana) for instructions."

  357. msgstr ""

  358. 

  359. #: ../../../docs/configuring-playbook-bridge-hookshot.md:168

  360. msgid "Troubleshooting"

  361. msgstr ""

  362. 

  363. #: ../../../docs/configuring-playbook-bridge-hookshot.md:170

  364. 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-hookshot`."

  365. msgstr ""

  366. 

  367. #: ../../../docs/configuring-playbook-bridge-hookshot.md:172

  368. msgid "Increase logging verbosity"

  369. msgstr ""

  370. 

  371. #: ../../../docs/configuring-playbook-bridge-hookshot.md:174

  372. msgid "The default logging level for this component is `warn`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:"

  373. msgstr ""