overmind
/
matrix-docker-ansible-deploy
огледало од https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Креирај огранак 0
Код Дискусије 0 Издања 0 Вики 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.
10427 Комити
12 Гране
1.2 GiB
 
 
Дрво: 90d3cf78b3
Гране Ознаке
${ item.name }
Create branch ${ searchTerm }
from '90d3cf78b3'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-bridge...

410 lines
17 KiB
Датотека Blame Историја 

  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-01-27 09:54+0200\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:1

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

  21. msgstr ""

  22. 

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

  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:5

  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:7

  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:9

  36. msgid "**Note**: the playbook also supports [matrix-appservice-webhooks](configuring-playbook-bridge-appservice-webhooks.md), which however was deprecated by its author."

  37. msgstr ""

  38. 

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

  40. msgid "Prerequisites"

  41. msgstr ""

  42. 

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

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

  45. msgstr ""

  46. 

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

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

  49. msgstr ""

  50. 

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

  52. 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)."

  53. msgstr ""

  54. 

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

  56. msgid "Adjusting the playbook configuration"

  57. msgstr ""

  58. 

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

  60. 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)."

  61. msgstr ""

  62. 

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

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

  65. msgstr ""

  66. 

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

  68. 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)."

  69. msgstr ""

  70. 

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

  72. msgid "Extending the configuration"

  73. msgstr ""

  74. 

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

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

  77. msgstr ""

  78. 

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

  80. msgid "Take a look at:"

  81. msgstr ""

  82. 

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

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

  85. msgstr ""

  86. 

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

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

  89. msgstr ""

  90. 

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

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

  93. msgstr ""

  94. 

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

  96. msgid "Installing"

  97. msgstr ""

  98. 

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

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

  101. msgstr ""

  102. 

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

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

  105. msgstr ""

  106. 

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

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

  109. msgstr ""

  110. 

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

  112. msgid "Usage"

  113. msgstr ""

  114. 

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

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

  117. msgstr ""

  118. 

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

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

  121. msgstr ""

  122. 

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

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

  125. msgstr ""

  126. 

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

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

  129. msgstr ""

  130. 

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

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

  133. msgstr ""

  134. 

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

  136. msgid "Reset crypto store"

  137. msgstr ""

  138. 

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

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

  141. msgstr ""

  142. 

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

  144. msgid "More setup documentation"

  145. msgstr ""

  146. 

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

  148. msgid "URLs for bridges setup"

  149. msgstr ""

  150. 

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

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

  153. msgstr ""

  154. 

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

  156. msgid "Listener"

  157. msgstr ""

  158. 

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

  160. msgid "Default path"

  161. msgstr ""

  162. 

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

  164. msgid "Variable"

  165. msgstr ""

  166. 

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

  168. msgid "Used as"

  169. msgstr ""

  170. 

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

  172. msgid "-"

  173. msgstr ""

  174. 

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

  176. msgid "`/hookshot/webhooks/`"

  177. msgstr ""

  178. 

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

  180. msgid "`matrix_hookshot_webhook_endpoint`"

  181. msgstr ""

  182. 

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

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

  185. msgstr ""

  186. 

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

  188. msgid "generic"

  189. msgstr ""

  190. 

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

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

  193. msgstr ""

  194. 

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

  196. msgid "`matrix_hookshot_generic_endpoint`"

  197. msgstr ""

  198. 

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

  200. msgid "Generic webhooks"

  201. msgstr ""

  202. 

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

  204. msgid "github oauth"

  205. msgstr ""

  206. 

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

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

  209. msgstr ""

  210. 

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

  212. msgid "`matrix_hookshot_github_oauth_endpoint`"

  213. msgstr ""

  214. 

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

  216. msgid "GitHub \"Callback URL\""

  217. msgstr ""

  218. 

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

  220. msgid "jira oauth"

  221. msgstr ""

  222. 

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

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

  225. msgstr ""

  226. 

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

  228. msgid "`matrix_hookshot_jira_oauth_endpoint`"

  229. msgstr ""

  230. 

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

  232. msgid "Jira OAuth"

  233. msgstr ""

  234. 

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

  236. msgid "figma endpoint"

  237. msgstr ""

  238. 

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

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

  241. msgstr ""

  242. 

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

  244. msgid "`matrix_hookshot_figma_endpoint`"

  245. msgstr ""

  246. 

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

  248. msgid "Figma"

  249. msgstr ""

  250. 

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

  252. msgid "provisioning"

  253. msgstr ""

  254. 

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

  256. msgid "`/hookshot/v1/`"

  257. msgstr ""

  258. 

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

  260. msgid "`matrix_hookshot_provisioning_endpoint`"

  261. msgstr ""

  262. 

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

  264. msgid "Dimension [provisioning](#provisioning-api)"

  265. msgstr ""

  266. 

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

  268. msgid "appservice"

  269. msgstr ""

  270. 

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

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

  273. msgstr ""

  274. 

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

  276. msgid "`matrix_hookshot_appservice_endpoint`"

  277. msgstr ""

  278. 

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

  280. msgid "Matrix server"

  281. msgstr ""

  282. 

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

  284. msgid "widgets"

  285. msgstr ""

  286. 

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

  288. msgid "`/hookshot/widgetapi/`"

  289. msgstr ""

  290. 

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

  292. msgid "`matrix_hookshot_widgets_endpoint`"

  293. msgstr ""

  294. 

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

  296. msgid "Widgets"

  297. msgstr ""

  298. 

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

  300. msgid "metrics"

  301. msgstr ""

  302. 

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

  304. msgid "`/metrics/hookshot`"

  305. msgstr ""

  306. 

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

  308. msgid "`matrix_hookshot_metrics_enabled` and exposure enabled via `matrix_hookshot_metrics_proxying_enabled` or `matrix_metrics_exposure_enabled`. Read more in the [Metrics section](#metrics) below."

  309. msgstr ""

  310. 

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

  312. msgid "Prometheus"

  313. msgstr ""

  314. 

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

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

  317. msgstr ""

  318. 

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

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

  321. msgstr ""

  322. 

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

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

  325. msgstr ""

  326. 

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

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

  329. msgstr ""

  330. 

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

  332. 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))."

  333. msgstr ""

  334. 

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

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

  337. msgstr ""

  338. 

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

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

  341. msgstr ""

  342. 

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

  344. 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:"

  345. msgstr ""

  346. 

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

  348. 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)."

  349. msgstr ""

  350. 

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

  352. msgid "Provisioning API"

  353. msgstr ""

  354. 

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

  356. msgid "The provisioning API will be enabled automatically if you set `matrix_dimension_enabled: true` and provided a `matrix_hookshot_provisioning_secret`, unless you override it either way. To use hookshot with dimension, you will need to enter as \"Provisioning URL\": `http://matrix-hookshot:9002`, which is made up of the variables `matrix_hookshot_container_url` and `matrix_hookshot_provisioning_port`."

  357. msgstr ""

  358. 

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

  360. msgid "Metrics"

  361. msgstr ""

  362. 

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

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

  365. msgstr ""

  366. 

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

  368. msgid "To explicitly enable metrics, use `matrix_hookshot_metrics_enabled: true`. This only exposes metrics over the container network, however."

  369. msgstr ""

  370. 

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

  372. 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:"

  373. msgstr ""

  374. 

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

  376. msgid "either enabling metrics exposure for Hookshot via `matrix_hookshot_metrics_proxying_enabled: true`"

  377. msgstr ""

  378. 

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

  380. msgid "or enabling metrics exposure for all services via `matrix_metrics_exposure_enabled: true`"

  381. msgstr ""

  382. 

  383. #: ../../../docs/configuring-playbook-bridge-hookshot.md:141

  384. msgid "Whichever one you go with, by default metrics are exposed publicly **without** password-protection. See [the Prometheus and Grafana docs](configuring-playbook-prometheus-grafana.md) for details about password-protection for metrics."

  385. msgstr ""

  386. 

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

  388. msgid "Collision with matrix-appservice-webhooks"

  389. msgstr ""

  390. 

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

  392. msgid "If you are also running [matrix-appservice-webhooks](configuring-playbook-bridge-appservice-webhooks.md), it reserves its namespace by the default setting `matrix_appservice_webhooks_user_prefix: '_webhook_'`. You should take care if you modify its or hookshot's prefix that they do not collide with each other's namespace (default `matrix_hookshot_generic_userIdPrefix: '_webhooks_'`)."

  393. msgstr ""

  394. 

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

  396. msgid "Troubleshooting"

  397. msgstr ""

  398. 

  399. #: ../../../docs/configuring-playbook-bridge-hookshot.md:149

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

  401. msgstr ""

  402. 

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

  404. msgid "Increase logging verbosity"

  405. msgstr ""

  406. 

  407. #: ../../../docs/configuring-playbook-bridge-hookshot.md:153

  408. 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:"

  409. msgstr ""