Matrix Docker Ansible eploy
25'ten fazla konu seçemezsiniz Konular bir harf veya rakamla başlamalı, kısa çizgiler ('-') içerebilir ve en fazla 35 karakter uzunluğunda olabilir.
 
 

235 satır
12 KiB

  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: 2025-01-27 09:54+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. #: ../../../docs/configuring-playbook-user-verification-service.md:1
  24. msgid "Setting up Matrix User Verification Service (optional)"
  25. msgstr ""
  26. #: ../../../docs/configuring-playbook-user-verification-service.md:3
  27. msgid "The playbook can install and configure [Matrix User Verification Service](https://github.com/matrix-org/matrix-user-verification-service) (hereafter: UVS) for you."
  28. msgstr ""
  29. #: ../../../docs/configuring-playbook-user-verification-service.md:5
  30. msgid "See the project's [documentation](https://github.com/matrix-org/matrix-user-verification-service/blob/master/README.md) to learn what it does and why it might be useful to you."
  31. msgstr ""
  32. #: ../../../docs/configuring-playbook-user-verification-service.md:7
  33. msgid "Currently, the main purpose of this role is to allow Jitsi to authenticate Matrix users and check if they are authorized to join a conference. If the Jitsi server is also configured by this playbook, all plugging of variables and secrets is handled in `group_vars/matrix_servers`."
  34. msgstr ""
  35. #: ../../../docs/configuring-playbook-user-verification-service.md:9
  36. msgid "What does it do?"
  37. msgstr ""
  38. #: ../../../docs/configuring-playbook-user-verification-service.md:11
  39. msgid "UVS can be used to verify two claims:"
  40. msgstr ""
  41. #: ../../../docs/configuring-playbook-user-verification-service.md:13
  42. msgid "(A) Whether a given OpenID token is valid for a given server and"
  43. msgstr ""
  44. #: ../../../docs/configuring-playbook-user-verification-service.md:14
  45. msgid "(B) whether a user is member of a given room and the corresponding PowerLevel"
  46. msgstr ""
  47. #: ../../../docs/configuring-playbook-user-verification-service.md:16
  48. msgid "Verifying an OpenID token ID done by finding the corresponding Homeserver via `/.well-known/matrix/server` for the given domain. The configured `matrix_user_verification_service_uvs_homeserver_url` does **not** factor into this. By default, this playbook only checks against `matrix_server_fqn_matrix`. Therefore, the request will be made against the public `openid` API for `matrix_server_fqn_matrix`."
  49. msgstr ""
  50. #: ../../../docs/configuring-playbook-user-verification-service.md:18
  51. msgid "Verifying RoomMembership and PowerLevel is done against `matrix_user_verification_service_uvs_homeserver_url` which is by default done via the docker network. UVS will verify the validity of the token beforehand though."
  52. msgstr ""
  53. #: ../../../docs/configuring-playbook-user-verification-service.md:20
  54. msgid "Prerequisites"
  55. msgstr ""
  56. #: ../../../docs/configuring-playbook-user-verification-service.md:22
  57. msgid "Open Matrix Federation port"
  58. msgstr ""
  59. #: ../../../docs/configuring-playbook-user-verification-service.md:24
  60. msgid "Enabling the UVS service will automatically reconfigure your Synapse homeserver to expose the `openid` API endpoints on the Matrix Federation port (usually `8448`), even if [federation](configuring-playbook-federation.md) is disabled. If you enable the component, make sure that the port is accessible."
  61. msgstr ""
  62. #: ../../../docs/configuring-playbook-user-verification-service.md:26
  63. msgid "Install Matrix services"
  64. msgstr ""
  65. #: ../../../docs/configuring-playbook-user-verification-service.md:28
  66. msgid "UVS can only be installed after Matrix services are installed and running. If you're just installing Matrix services for the first time, please continue with the [Configuration](configuring-playbook.md) / [Installation](installing.md) and come back here later."
  67. msgstr ""
  68. #: ../../../docs/configuring-playbook-user-verification-service.md:30
  69. msgid "Register a dedicated Matrix user (optional, recommended)"
  70. msgstr ""
  71. #: ../../../docs/configuring-playbook-user-verification-service.md:32
  72. msgid "We recommend that you create a dedicated Matrix user for uvs (`uvs` is a good username). **Because UVS requires an access token as an admin user, that user needs to be an admin.**"
  73. msgstr ""
  74. #: ../../../docs/configuring-playbook-user-verification-service.md:34
  75. msgid "Generate a strong password for the user. You can create one with a command like `pwgen -s 64 1`."
  76. msgstr ""
  77. #: ../../../docs/configuring-playbook-user-verification-service.md:36
  78. msgid "You can use the playbook to [register a new user](registering-users.md):"
  79. msgstr ""
  80. #: ../../../docs/configuring-playbook-user-verification-service.md:42
  81. msgid "Obtain an access token"
  82. msgstr ""
  83. #: ../../../docs/configuring-playbook-user-verification-service.md:44
  84. msgid "UVS requires an access token as an admin user to verify RoomMembership and PowerLevel against `matrix_user_verification_service_uvs_homeserver_url`. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md)."
  85. msgstr ""
  86. #: ../../../docs/configuring-playbook-user-verification-service.md:46
  87. msgid "[!WARNING] Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone."
  88. msgstr ""
  89. #: ../../../docs/configuring-playbook-user-verification-service.md:49
  90. msgid "Adjusting the playbook configuration"
  91. msgstr ""
  92. #: ../../../docs/configuring-playbook-user-verification-service.md:51
  93. msgid "To enable UVS, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `ACCESS_TOKEN_HERE` with the one created [above](#obtain-an-access-token)."
  94. msgstr ""
  95. #: ../../../docs/configuring-playbook-user-verification-service.md:59
  96. msgid "In the default configuration, the UVS Server is only reachable via the docker network, which is fine if e.g. Jitsi is also running in a container on the host. However, it is possible to expose UVS via setting `matrix_user_verification_service_container_http_host_bind_port`."
  97. msgstr ""
  98. #: ../../../docs/configuring-playbook-user-verification-service.md:61
  99. msgid "Custom Auth Token (optional)"
  100. msgstr ""
  101. #: ../../../docs/configuring-playbook-user-verification-service.md:63
  102. msgid "It is possible to set an API Auth Token to restrict access to the UVS. If this is enabled, anyone making a request to UVS must provide it via the header `Authorization: Bearer YOUR_TOKEN_HERE`."
  103. msgstr ""
  104. #: ../../../docs/configuring-playbook-user-verification-service.md:65
  105. msgid "By default, the token (`YOUR_TOKEN_HERE`) will be derived from `matrix_homeserver_generic_secret_key` in `group_vars/matrix_servers`."
  106. msgstr ""
  107. #: ../../../docs/configuring-playbook-user-verification-service.md:67
  108. msgid "To set your own token, add the following configuration to your `vars.yml` file. Make sure to replace `YOUR_TOKEN_HERE` with your own."
  109. msgstr ""
  110. #: ../../../docs/configuring-playbook-user-verification-service.md:73
  111. msgid "If a Jitsi instance is also managed by this playbook and [`matrix` authentication](configuring-playbook-jitsi.md#authenticate-using-matrix-openid-auth-type-matrix) is enabled there, this collection will automatically configure Jitsi to use the configured auth token."
  112. msgstr ""
  113. #: ../../../docs/configuring-playbook-user-verification-service.md:75
  114. msgid "Disable Authorization (optional)"
  115. msgstr ""
  116. #: ../../../docs/configuring-playbook-user-verification-service.md:77
  117. msgid "Authorization is enabled by default. To disable it, add the following configuration to your `vars.yml` file:"
  118. msgstr ""
  119. #: ../../../docs/configuring-playbook-user-verification-service.md:83
  120. msgid "Federation (optional)"
  121. msgstr ""
  122. #: ../../../docs/configuring-playbook-user-verification-service.md:85
  123. msgid "In theory (however currently untested), UVS can handle federation. To enable it, add the following configuration to your `vars.yml` file:"
  124. msgstr ""
  125. #: ../../../docs/configuring-playbook-user-verification-service.md:91
  126. msgid "This will instruct UVS to verify the OpenID token against any domain given in a request. Homeserver discovery is done via `.well-known/matrix/server` of the given domain."
  127. msgstr ""
  128. #: ../../../docs/configuring-playbook-user-verification-service.md:93
  129. msgid "Extending the configuration"
  130. msgstr ""
  131. #: ../../../docs/configuring-playbook-user-verification-service.md:95
  132. msgid "There are some additional things you may wish to configure about the component."
  133. msgstr ""
  134. #: ../../../docs/configuring-playbook-user-verification-service.md:97
  135. msgid "Take a look at:"
  136. msgstr ""
  137. #: ../../../docs/configuring-playbook-user-verification-service.md:99
  138. msgid "`roles/custom/matrix-user-verification-service/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"
  139. msgstr ""
  140. #: ../../../docs/configuring-playbook-user-verification-service.md:101
  141. msgid "Installing"
  142. msgstr ""
  143. #: ../../../docs/configuring-playbook-user-verification-service.md:103
  144. msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
  145. msgstr ""
  146. #: ../../../docs/configuring-playbook-user-verification-service.md:110
  147. msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-service matrix-user-verification-service` or `just setup-all`"
  148. msgstr ""
  149. #: ../../../docs/configuring-playbook-user-verification-service.md:112
  150. msgid "`just install-service matrix-user-verification-service` 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."
  151. msgstr ""
  152. #: ../../../docs/configuring-playbook-user-verification-service.md:114
  153. msgid "Troubleshooting"
  154. msgstr ""
  155. #: ../../../docs/configuring-playbook-user-verification-service.md:116
  156. 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-user-verification-service`."
  157. msgstr ""
  158. #: ../../../docs/configuring-playbook-user-verification-service.md:118
  159. msgid "Increase logging verbosity"
  160. msgstr ""
  161. #: ../../../docs/configuring-playbook-user-verification-service.md:120
  162. msgid "The default logging level for this component is `info`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:"
  163. msgstr ""
  164. #: ../../../docs/configuring-playbook-user-verification-service.md:127
  165. msgid "TLS Certificate Checking"
  166. msgstr ""
  167. #: ../../../docs/configuring-playbook-user-verification-service.md:129
  168. msgid "If the Matrix Homeserver does not provide a valid TLS certificate, UVS will fail with the following error message:"
  169. msgstr ""
  170. #: ../../../docs/configuring-playbook-user-verification-service.md:131
  171. msgid "message: 'No response received: [object Object]',"
  172. msgstr ""
  173. #: ../../../docs/configuring-playbook-user-verification-service.md:133
  174. msgid "This also applies to self-signed and Let's Encrypt staging certificates."
  175. msgstr ""
  176. #: ../../../docs/configuring-playbook-user-verification-service.md:135
  177. msgid "To disable certificate validation altogether (INSECURE! Not suitable for production use!) set: `NODE_TLS_REJECT_UNAUTHORIZED=0`"
  178. msgstr ""
  179. #: ../../../docs/configuring-playbook-user-verification-service.md:137
  180. msgid "Alternatively, it is possible to inject your own CA certificates into the container by mounting a PEM file with additional trusted CAs into the container and pointing the `NODE_EXTRA_CA_CERTS` environment variable to it."
  181. msgstr ""