Przeglądaj źródła

Update docs/configuring-playbook-user-verification-service.md

- Use common expressions
- Remove a word puzzle for better l10n experience
- Remove a redundant whitespace character

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
pull/3857/head
Suguru Hirahara 1 rok temu
rodzic
commit
255b1807a2
Nie znaleziono w bazie danych klucza dla tego podpisu ID klucza GPG: E4F9743DAB4B7B75
1 zmienionych plików z 4 dodań i 8 usunięć
  1. +4
    -8
      docs/configuring-playbook-user-verification-service.md

+ 4
- 8
docs/configuring-playbook-user-verification-service.md Wyświetl plik

@@ -59,7 +59,7 @@ It is possible to set an API Auth Token to restrict access to the UVS. If this i


By default, the token will be derived from `matrix_homeserver_generic_secret_key` in `group_vars/matrix_servers`. By default, the token will be derived from `matrix_homeserver_generic_secret_key` in `group_vars/matrix_servers`.


To set your own Token, simply put the following in your host_vars.
To set your own Token, add the following configuration to your `vars.yml` file:


```yaml ```yaml
matrix_user_verification_service_uvs_auth_token: "TOKEN" matrix_user_verification_service_uvs_auth_token: "TOKEN"
@@ -67,26 +67,22 @@ matrix_user_verification_service_uvs_auth_token: "TOKEN"


In case Jitsi is also managed by this playbook and 'matrix' authentication in Jitsi is enabled, this collection will automatically configure Jitsi to use the configured auth token. In case Jitsi is also managed by this playbook and 'matrix' authentication in Jitsi is enabled, this collection will automatically configure Jitsi to use the configured auth token.


### (Optional) Disable Auth
### (Optional) Disable Auth


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


```yaml ```yaml
matrix_user_verification_service_uvs_require_auth: false matrix_user_verification_service_uvs_require_auth: false
``` ```


in your host_vars.

### (Optional) Federation ### (Optional) Federation


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


```yaml ```yaml
matrix_user_verification_service_uvs_pin_openid_verify_server_name: false matrix_user_verification_service_uvs_pin_openid_verify_server_name: false
``` ```


in your host_vars.

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


## Installing ## Installing


Ładowanie…
Anuluj
Zapisz