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.
10427 Commits
11 Branches
284 MiB
 
 
Tree: 90d3cf78b3
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '90d3cf78b3'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-user-v...

230 lines
12 KiB
Raw Blame History 

  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-user-verification-service.md:1

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

  21. msgstr ""

  22. 

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

  24. msgid "The playbook can install and configure [Matrix User Verification Service](https://github.com/matrix-org/matrix-user-verification-service) (hereafter: UVS) for you."

  25. msgstr ""

  26. 

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

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

  29. msgstr ""

  30. 

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

  32. 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`."

  33. msgstr ""

  34. 

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

  36. msgid "What does it do?"

  37. msgstr ""

  38. 

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

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

  41. msgstr ""

  42. 

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

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

  45. msgstr ""

  46. 

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

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

  49. msgstr ""

  50. 

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

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

  53. msgstr ""

  54. 

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

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

  57. msgstr ""

  58. 

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

  60. msgid "Prerequisites"

  61. msgstr ""

  62. 

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

  64. msgid "Open Matrix Federation port"

  65. msgstr ""

  66. 

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

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

  69. msgstr ""

  70. 

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

  72. msgid "Install Matrix services"

  73. msgstr ""

  74. 

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

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

  77. msgstr ""

  78. 

  79. #: ../../../docs/configuring-playbook-user-verification-service.md:30

  80. msgid "Register a dedicated Matrix user (optional, recommended)"

  81. msgstr ""

  82. 

  83. #: ../../../docs/configuring-playbook-user-verification-service.md:32

  84. 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.**"

  85. msgstr ""

  86. 

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

  88. msgid "Generate a strong password for the user. You can create one with a command like `pwgen -s 64 1`."

  89. msgstr ""

  90. 

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

  92. msgid "You can use the playbook to [register a new user](registering-users.md):"

  93. msgstr ""

  94. 

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

  96. msgid "Obtain an access token"

  97. msgstr ""

  98. 

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

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

  101. msgstr ""

  102. 

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

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

  105. msgstr ""

  106. 

  107. #: ../../../docs/configuring-playbook-user-verification-service.md:49

  108. msgid "Adjusting the playbook configuration"

  109. msgstr ""

  110. 

  111. #: ../../../docs/configuring-playbook-user-verification-service.md:51

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

  113. msgstr ""

  114. 

  115. #: ../../../docs/configuring-playbook-user-verification-service.md:59

  116. 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`."

  117. msgstr ""

  118. 

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

  120. msgid "Custom Auth Token (optional)"

  121. msgstr ""

  122. 

  123. #: ../../../docs/configuring-playbook-user-verification-service.md:63

  124. 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`."

  125. msgstr ""

  126. 

  127. #: ../../../docs/configuring-playbook-user-verification-service.md:65

  128. msgid "By default, the token (`YOUR_TOKEN_HERE`) will be derived from `matrix_homeserver_generic_secret_key` in `group_vars/matrix_servers`."

  129. msgstr ""

  130. 

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

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

  133. msgstr ""

  134. 

  135. #: ../../../docs/configuring-playbook-user-verification-service.md:73

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

  137. msgstr ""

  138. 

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

  140. msgid "Disable Authorization (optional)"

  141. msgstr ""

  142. 

  143. #: ../../../docs/configuring-playbook-user-verification-service.md:77

  144. msgid "Authorization is enabled by default. To disable it, add the following configuration to your `vars.yml` file:"

  145. msgstr ""

  146. 

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

  148. msgid "Federation (optional)"

  149. msgstr ""

  150. 

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

  152. msgid "In theory (however currently untested), UVS can handle federation. To enable it, add the following configuration to your `vars.yml` file:"

  153. msgstr ""

  154. 

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

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

  157. msgstr ""

  158. 

  159. #: ../../../docs/configuring-playbook-user-verification-service.md:93

  160. msgid "Extending the configuration"

  161. msgstr ""

  162. 

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

  164. msgid "There are some additional things you may wish to configure about the component."

  165. msgstr ""

  166. 

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

  168. msgid "Take a look at:"

  169. msgstr ""

  170. 

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

  172. msgid "`roles/custom/matrix-user-verification-service/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"

  173. msgstr ""

  174. 

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

  176. msgid "Installing"

  177. msgstr ""

  178. 

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

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

  181. msgstr ""

  182. 

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

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

  185. msgstr ""

  186. 

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

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

  189. msgstr ""

  190. 

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

  192. msgid "Troubleshooting"

  193. msgstr ""

  194. 

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

  196. 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`."

  197. msgstr ""

  198. 

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

  200. msgid "Increase logging verbosity"

  201. msgstr ""

  202. 

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

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

  205. msgstr ""

  206. 

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

  208. msgid "TLS Certificate Checking"

  209. msgstr ""

  210. 

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

  212. msgid "If the Matrix Homeserver does not provide a valid TLS certificate, UVS will fail with the following error message:"

  213. msgstr ""

  214. 

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

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

  217. msgstr ""

  218. 

  219. #: ../../../docs/configuring-playbook-user-verification-service.md:133

  220. msgid "This also applies to self-signed and Let's Encrypt staging certificates."

  221. msgstr ""

  222. 

  223. #: ../../../docs/configuring-playbook-user-verification-service.md:135

  224. msgid "To disable certificate validation altogether (INSECURE! Not suitable for production use!) set: `NODE_TLS_REJECT_UNAUTHORIZED=0`"

  225. msgstr ""

  226. 

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

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

  229. msgstr ""