Explorar el Código

Update docs/configuring-playbook-user-verification-service.md: adopt the common section "Troubleshooting"

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
pull/3994/head
Suguru Hirahara hace 1 año
padre
commit
783b1a8159
No se encontró ninguna clave conocida en la base de datos para esta firma ID de clave GPG: E4F9743DAB4B7B75
Se han modificado 1 ficheros con 11 adiciones y 12 borrados
  1. +11
    -12
      docs/configuring-playbook-user-verification-service.md

+ 11
- 12
docs/configuring-playbook-user-verification-service.md Ver fichero

@@ -90,18 +90,6 @@ matrix_user_verification_service_uvs_pin_openid_verify_server_name: false


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.


### Controlling the logging level (optional)

To specify the logging level, add the following configuration to your `vars.yml` file:

```yaml
UVS_LOG_LEVEL: info
```

Replace `info` with one of the choices (they can be checked [here](https://github.com/winstonjs/winston#logging-levels)) to control the verbosity of the logs generated.

If you have issues with a service, and are requesting support, the higher levels of logging will generally be more helpful.

### Extending the configuration ### Extending the configuration


There are some additional things you may wish to configure about the component. There are some additional things you may wish to configure about the component.
@@ -125,6 +113,17 @@ The shortcut commands with the [`just` program](just.md) are also available: `ju


## Troubleshooting ## Troubleshooting


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

### Increase logging verbosity

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:

```yaml
# See choices here: https://github.com/winstonjs/winston#logging-levels
UVS_LOG_LEVEL: debug
```

### TLS Certificate Checking ### TLS Certificate Checking


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


Cargando…
Cancelar
Guardar