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.
8817 Commits
13 Branches
36 MiB
 
 
Tree: 0afa372ca8
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '0afa372ca8'
${ noResults }
matrix-docker-ansible-deploy/i18n/locales/bg/LC_MESSAGES/docs/configuring-playbook-user-v...

341 lines
12 KiB
Raw Blame History 

  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-20 09:53+0200\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. 

  24. #: ../../../docs/configuring-playbook-user-verification-service.md:1

  25. msgid "Setting up Matrix User Verification Service (optional)"

  26. msgstr ""

  27. 

  28. #: ../../../docs/configuring-playbook-user-verification-service.md:3

  29. msgid ""

  30. "**[Matrix User Verification Service](https://github.com/matrix-org"

  31. "/matrix-user-verification-service) (hereafter: UVS) can only be installed"

  32. " after Matrix services are installed and running.** If you're just "

  33. "installing Matrix services for the first time, please continue with the "

  34. "[Configuration](configuring-playbook.md) / [Installation](installing.md) "

  35. "flow and come back here later."

  36. msgstr ""

  37. 

  38. #: ../../../docs/configuring-playbook-user-verification-service.md:5

  39. msgid ""

  40. "Currently, the main purpose of this role is to allow Jitsi to "

  41. "authenticate Matrix users and check if they are authorized to join a "

  42. "conference. Please refer to the documentation of the [Matrix User "

  43. "Verification Service](https://github.com/matrix-org/matrix-user-"

  44. "verification-service) to understand how it works."

  45. msgstr ""

  46. 

  47. #: ../../../docs/configuring-playbook-user-verification-service.md:7

  48. msgid ""

  49. "**Note**: enabling Matrix User Verification Service, means that the "

  50. "`openid` API endpoints will be exposed on the Matrix Federation port "

  51. "(usually `8448`), even if [federation](configuring-playbook-"

  52. "federation.md) is disabled."

  53. msgstr ""

  54. 

  55. #: ../../../docs/configuring-playbook-user-verification-service.md:9

  56. msgid ""

  57. "If the Jitsi server is also configured by this playbook, all plugging of "

  58. "variables and secrets is handled in `group_vars/matrix_servers`."

  59. msgstr ""

  60. 

  61. #: ../../../docs/configuring-playbook-user-verification-service.md:11

  62. msgid ""

  63. "__Some general concepts of UVS may be helpful to understand the rest, so "

  64. "here they are:__"

  65. msgstr ""

  66. 

  67. #: ../../../docs/configuring-playbook-user-verification-service.md:13

  68. msgid "UVS can be used to verify two claims:"

  69. msgstr ""

  70. 

  71. #: ../../../docs/configuring-playbook-user-verification-service.md:15

  72. msgid "(A) Whether a given OpenID token is valid for a given server and"

  73. msgstr ""

  74. 

  75. #: ../../../docs/configuring-playbook-user-verification-service.md:16

  76. msgid ""

  77. "(B) whether a user is member of a given room and the corresponding "

  78. "PowerLevel"

  79. msgstr ""

  80. 

  81. #: ../../../docs/configuring-playbook-user-verification-service.md:18

  82. msgid ""

  83. "Verifying an OpenID token ID done by finding the corresponding Homeserver"

  84. " via  '.well-known/matrix/server' for the given domain. The configured "

  85. "`matrix_user_verification_service_uvs_homeserver_url` does **not** factor"

  86. " into this. By default, this playbook only checks against "

  87. "`matrix_server_fqn_matrix`. Therefore, the request will be made against "

  88. "the public openid API for `matrix_server_fqn_matrix`."

  89. msgstr ""

  90. 

  91. #: ../../../docs/configuring-playbook-user-verification-service.md:20

  92. msgid ""

  93. "Verifying RoomMembership and PowerLevel is done against "

  94. "`matrix_user_verification_service_uvs_homeserver_url` which is by default"

  95. " done via the docker network. UVS will verify the validity of the token "

  96. "beforehand though."

  97. msgstr ""

  98. 

  99. #: ../../../docs/configuring-playbook-user-verification-service.md:22

  100. msgid "Prerequisites"

  101. msgstr ""

  102. 

  103. #: ../../../docs/configuring-playbook-user-verification-service.md:24

  104. msgid ""

  105. "In order to use UVS, an admin token for the configured homeserver must be"

  106. " supplied. For now this means configuring Synapse and creating the token "

  107. "before installing UVS."

  108. msgstr ""

  109. 

  110. #: ../../../docs/configuring-playbook-user-verification-service.md:26

  111. msgid "Enable"

  112. msgstr ""

  113. 

  114. #: ../../../docs/configuring-playbook-user-verification-service.md:28

  115. msgid ""

  116. "To enable Matrix User Verification Service, add the following "

  117. "configuration to your `inventory/host_vars/matrix.example.com/vars.yml` "

  118. "file:"

  119. msgstr ""

  120. 

  121. #: ../../../docs/configuring-playbook-user-verification-service.md:34

  122. msgid "Configuration"

  123. msgstr ""

  124. 

  125. #: ../../../docs/configuring-playbook-user-verification-service.md:36

  126. msgid ""

  127. "The only required configuration variable is "

  128. "`matrix_user_verification_service_uvs_access_token` (see below)."

  129. msgstr ""

  130. 

  131. #: ../../../docs/configuring-playbook-user-verification-service.md:38

  132. msgid ""

  133. "For a list of all configuration options see the role defaults [`roles"

  134. "/matrix-user-verification-service/defaults/main.yml`](../roles/custom"

  135. "/matrix-user-verification-service/defaults/main.yml). But be aware of all"

  136. " the plugging happening in `group_vars/matrix_servers`."

  137. msgstr ""

  138. 

  139. #: ../../../docs/configuring-playbook-user-verification-service.md:40

  140. msgid ""

  141. "In the default configuration, the UVS Server is only reachable via the "

  142. "docker network, which is fine if e.g. Jitsi is also running in a "

  143. "container on the host. However, it is possible to expose UVS via setting "

  144. "`matrix_user_verification_service_container_http_host_bind_port`."

  145. msgstr ""

  146. 

  147. #: ../../../docs/configuring-playbook-user-verification-service.md:42

  148. msgid "Access token"

  149. msgstr ""

  150. 

  151. #: ../../../docs/configuring-playbook-user-verification-service.md:44

  152. msgid ""

  153. "The Synapse Access Token is used to verify RoomMembership and PowerLevel "

  154. "against `matrix_user_verification_service_uvs_homeserver_url`."

  155. msgstr ""

  156. 

  157. #: ../../../docs/configuring-playbook-user-verification-service.md:46

  158. msgid ""

  159. "We recommend that you create a dedicated Matrix user for uvs (`uvs` is a "

  160. "good username). Follow our [Registering users](registering-users.md) "

  161. "guide to register a user with administration privileges."

  162. msgstr ""

  163. 

  164. #: ../../../docs/configuring-playbook-user-verification-service.md:48

  165. msgid ""

  166. "You are required to specify an access token (belonging to this new user) "

  167. "for UVS to work. To get an access token for the UVS user, you can follow "

  168. "the documentation on [how to do obtain an access token](obtaining-access-"

  169. "tokens.md)."

  170. msgstr ""

  171. 

  172. #: ../../../docs/configuring-playbook-user-verification-service.md:50

  173. msgid ""

  174. "**Access tokens are sensitive information. Do not include them in any bug"

  175. " reports, messages, or logs. Do not share the access token with anyone.**"

  176. msgstr ""

  177. 

  178. #: ../../../docs/configuring-playbook-user-verification-service.md:56

  179. msgid "(Optional) Custom Auth Token"

  180. msgstr ""

  181. 

  182. #: ../../../docs/configuring-playbook-user-verification-service.md:58

  183. msgid ""

  184. "It is possible to set an API Auth Token to restrict access to the UVS. If"

  185. " this is enabled, anyone making a request to UVS must provide it via the "

  186. "header \"Authorization: Bearer TOKEN\""

  187. msgstr ""

  188. 

  189. #: ../../../docs/configuring-playbook-user-verification-service.md:60

  190. msgid ""

  191. "By default, the token will be derived from "

  192. "`matrix_homeserver_generic_secret_key` in `group_vars/matrix_servers`."

  193. msgstr ""

  194. 

  195. #: ../../../docs/configuring-playbook-user-verification-service.md:62

  196. msgid ""

  197. "To set your own Token, add the following configuration to your `vars.yml`"

  198. " file:"

  199. msgstr ""

  200. 

  201. #: ../../../docs/configuring-playbook-user-verification-service.md:68

  202. msgid ""

  203. "In case Jitsi is also managed by this playbook and 'matrix' "

  204. "authentication in Jitsi is enabled, this collection will automatically "

  205. "configure Jitsi to use the configured auth token."

  206. msgstr ""

  207. 

  208. #: ../../../docs/configuring-playbook-user-verification-service.md:70

  209. msgid "(Optional) Disable Auth"

  210. msgstr ""

  211. 

  212. #: ../../../docs/configuring-playbook-user-verification-service.md:72

  213. msgid ""

  214. "Authorization is enabled by default. To disable it, add the following "

  215. "configuration to your `vars.yml` file:"

  216. msgstr ""

  217. 

  218. #: ../../../docs/configuring-playbook-user-verification-service.md:78

  219. msgid "(Optional) Federation"

  220. msgstr ""

  221. 

  222. #: ../../../docs/configuring-playbook-user-verification-service.md:80

  223. msgid ""

  224. "In theory (however currently untested), UVS can handle federation. To "

  225. "enable it, add the following configuration to your `vars.yml` file:"

  226. msgstr ""

  227. 

  228. #: ../../../docs/configuring-playbook-user-verification-service.md:86

  229. msgid ""

  230. "This will instruct UVS to verify the OpenID token against any domain "

  231. "given in a request. Homeserver discovery is done via '.well-"

  232. "known/matrix/server' of the given domain."

  233. msgstr ""

  234. 

  235. #: ../../../docs/configuring-playbook-user-verification-service.md:88

  236. msgid "Installing"

  237. msgstr ""

  238. 

  239. #: ../../../docs/configuring-playbook-user-verification-service.md:90

  240. msgid ""

  241. "After configuring the playbook, run it with [playbook tags](playbook-"

  242. "tags.md) as below:"

  243. msgstr ""

  244. 

  245. #: ../../../docs/configuring-playbook-user-verification-service.md:97

  246. msgid ""

  247. "The shortcut commands with the [`just` program](just.md) are also "

  248. "available: `just install-service matrix-user-verification-service` or "

  249. "`just setup-all`"

  250. msgstr ""

  251. 

  252. #: ../../../docs/configuring-playbook-user-verification-service.md:99

  253. msgid ""

  254. "`just install-service matrix-user-verification-service` is useful for "

  255. "maintaining your setup quickly when its components remain unchanged. If "

  256. "you adjust your `vars.yml` to remove other components, you'd need to run "

  257. "`just setup-all`, or these components will still remain installed. Note "

  258. "`just setup-all` runs the `ensure-matrix-users-created` tag too."

  259. msgstr ""

  260. 

  261. #: ../../../docs/configuring-playbook-user-verification-service.md:101

  262. msgid "Logging"

  263. msgstr ""

  264. 

  265. #: ../../../docs/configuring-playbook-user-verification-service.md:103

  266. msgid "The configuration variable `UVS_LOG_LEVEL` can be set to:"

  267. msgstr ""

  268. 

  269. #: ../../../docs/configuring-playbook-user-verification-service.md:104

  270. msgid "warning"

  271. msgstr ""

  272. 

  273. #: ../../../docs/configuring-playbook-user-verification-service.md:105

  274. msgid "info"

  275. msgstr ""

  276. 

  277. #: ../../../docs/configuring-playbook-user-verification-service.md:106

  278. msgid "debug"

  279. msgstr ""

  280. 

  281. #: ../../../docs/configuring-playbook-user-verification-service.md:108

  282. msgid "TLS Certificate Checking"

  283. msgstr ""

  284. 

  285. #: ../../../docs/configuring-playbook-user-verification-service.md:110

  286. msgid ""

  287. "If the Matrix Homeserver does not provide a valid TLS certificate, UVS "

  288. "will fail with the following error message:"

  289. msgstr ""

  290. 

  291. #: ../../../docs/configuring-playbook-user-verification-service.md:112

  292. msgid "message: 'No response received: [object Object]',"

  293. msgstr ""

  294. 

  295. #: ../../../docs/configuring-playbook-user-verification-service.md:114

  296. msgid "This also applies to self-signed and let's encrypt staging certificates."

  297. msgstr ""

  298. 

  299. #: ../../../docs/configuring-playbook-user-verification-service.md:116

  300. msgid ""

  301. "To disable certificate validation altogether (INSECURE! Not suitable for "

  302. "production use!) set: `NODE_TLS_REJECT_UNAUTHORIZED=0`"

  303. msgstr ""

  304. 

  305. #: ../../../docs/configuring-playbook-user-verification-service.md:118

  306. msgid ""

  307. "Alternatively, it is possible to inject your own CA certificates into the"

  308. " container by mounting a PEM file with additional trusted CAs into the "

  309. "container and pointing the `NODE_EXTRA_CA_CERTS` environment variable to "

  310. "it."

  311. msgstr ""

  312. 

  313. #~ msgid ""

  314. #~ "After these variables have been set, "

  315. #~ "run the playbook with [playbook tags"

  316. #~ "](playbook-tags.md) as below to restart "

  317. #~ "UVS:"

  318. #~ msgstr ""

  319. 

  320. #~ msgid ""

  321. #~ "The shortcut commands with the [`just`"

  322. #~ " program](just.md) are also available: "

  323. #~ "`just run-tags setup-matrix-user-"

  324. #~ "verification-service,start` or `just setup-"

  325. #~ "all`"

  326. #~ msgstr ""

  327. 

  328. #~ msgid ""

  329. #~ "`just run-tags setup-matrix-user-"

  330. #~ "verification-service,start` is useful for "

  331. #~ "maintaining your setup quickly when its"

  332. #~ " components remain unchanged. If you "

  333. #~ "adjust your `vars.yml` to remove other"

  334. #~ " components, you'd need to run `just"

  335. #~ " setup-all`, or these components will"

  336. #~ " still remain installed. Note `just "

  337. #~ "setup-all` runs the `ensure-matrix-"

  338. #~ "users-created` tag too."

  339. #~ msgstr ""