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/jp/LC_MESSAGES/docs/configuring-playbook-user-v...

340 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: jp\n"

  17. "Language-Team: jp <LL@li.org>\n"

  18. "MIME-Version: 1.0\n"

  19. "Content-Type: text/plain; charset=utf-8\n"

  20. "Content-Transfer-Encoding: 8bit\n"

  21. "Generated-By: Babel 2.16.0\n"

  22. 

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

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

  25. msgstr ""

  26. 

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

  28. msgid ""

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

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

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

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

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

  34. "flow and come back here later."

  35. msgstr ""

  36. 

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

  38. msgid ""

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

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

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

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

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

  44. msgstr ""

  45. 

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

  47. msgid ""

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

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

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

  51. "federation.md) is disabled."

  52. msgstr ""

  53. 

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

  55. msgid ""

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

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

  58. msgstr ""

  59. 

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

  61. msgid ""

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

  63. "here they are:__"

  64. msgstr ""

  65. 

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

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

  68. msgstr ""

  69. 

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

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

  72. msgstr ""

  73. 

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

  75. msgid ""

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

  77. "PowerLevel"

  78. msgstr ""

  79. 

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

  81. msgid ""

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

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

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

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

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

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

  88. msgstr ""

  89. 

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

  91. msgid ""

  92. "Verifying RoomMembership and PowerLevel is done against "

  93. "`matrix_user_verification_service_uvs_homeserver_url` which is by default"

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

  95. "beforehand though."

  96. msgstr ""

  97. 

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

  99. msgid "Prerequisites"

  100. msgstr ""

  101. 

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

  103. msgid ""

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

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

  106. "before installing UVS."

  107. msgstr ""

  108. 

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

  110. msgid "Enable"

  111. msgstr ""

  112. 

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

  114. msgid ""

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

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

  117. "file:"

  118. msgstr ""

  119. 

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

  121. msgid "Configuration"

  122. msgstr ""

  123. 

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

  125. msgid ""

  126. "The only required configuration variable is "

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

  128. msgstr ""

  129. 

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

  131. msgid ""

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

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

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

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

  136. msgstr ""

  137. 

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

  139. msgid ""

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

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

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

  143. "`matrix_user_verification_service_container_http_host_bind_port`."

  144. msgstr ""

  145. 

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

  147. msgid "Access token"

  148. msgstr ""

  149. 

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

  151. msgid ""

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

  153. "against `matrix_user_verification_service_uvs_homeserver_url`."

  154. msgstr ""

  155. 

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

  157. msgid ""

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

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

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

  161. msgstr ""

  162. 

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

  164. msgid ""

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

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

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

  168. "tokens.md)."

  169. msgstr ""

  170. 

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

  172. msgid ""

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

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

  175. msgstr ""

  176. 

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

  178. msgid "(Optional) Custom Auth Token"

  179. msgstr ""

  180. 

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

  182. msgid ""

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

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

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

  186. msgstr ""

  187. 

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

  189. msgid ""

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

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

  192. msgstr ""

  193. 

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

  195. msgid ""

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

  197. " file:"

  198. msgstr ""

  199. 

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

  201. msgid ""

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

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

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

  205. msgstr ""

  206. 

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

  208. msgid "(Optional) Disable Auth"

  209. msgstr ""

  210. 

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

  212. msgid ""

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

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

  215. msgstr ""

  216. 

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

  218. msgid "(Optional) Federation"

  219. msgstr ""

  220. 

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

  222. msgid ""

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

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

  225. msgstr ""

  226. 

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

  228. msgid ""

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

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

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

  232. msgstr ""

  233. 

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

  235. msgid "Installing"

  236. msgstr ""

  237. 

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

  239. msgid ""

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

  241. "tags.md) as below:"

  242. msgstr ""

  243. 

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

  245. msgid ""

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

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

  248. "`just setup-all`"

  249. msgstr ""

  250. 

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

  252. msgid ""

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

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

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

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

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

  258. msgstr ""

  259. 

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

  261. msgid "Logging"

  262. msgstr ""

  263. 

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

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

  266. msgstr ""

  267. 

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

  269. msgid "warning"

  270. msgstr ""

  271. 

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

  273. msgid "info"

  274. msgstr ""

  275. 

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

  277. msgid "debug"

  278. msgstr ""

  279. 

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

  281. msgid "TLS Certificate Checking"

  282. msgstr ""

  283. 

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

  285. msgid ""

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

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

  288. msgstr ""

  289. 

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

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

  292. msgstr ""

  293. 

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

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

  296. msgstr ""

  297. 

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

  299. msgid ""

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

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

  302. msgstr ""

  303. 

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

  305. msgid ""

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

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

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

  309. "it."

  310. msgstr ""

  311. 

  312. #~ msgid ""

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

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

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

  316. #~ "UVS:"

  317. #~ msgstr ""

  318. 

  319. #~ msgid ""

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

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

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

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

  324. #~ "all`"

  325. #~ msgstr ""

  326. 

  327. #~ msgid ""

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

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

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

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

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

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

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

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

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

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

  338. #~ msgstr ""