ansol/matrix-docker-ansible-deploy
7
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2025-01-10 05:13:50 +00:00
Code Issues Projects Releases Wiki Activity

Update docs/configuring-playbook-user-verification-service.md: adopt the common section for controlling the logging level and minor changes (#3910)

Browse Source 
* Update docs/configuring-playbook-user-verification-service.md: adopt the common section for controlling the logging level

Based on:
- docs/configuring-playbook-bridge-mautrix-bridges.md
- roles/custom/matrix-user-verification-service/defaults/main.yml

Other minor changes:
- Add an upper section "troubleshooting" for "TLS Certificate Checking"
- Use backticks

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

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

---------

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
This commit is contained in:
Suguru Hirahara 2025-01-03 09:54:02 -05:00 committed by GitHub
parent ce30c347fd
commit 6facfb2f77
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/configuring-playbook-user-verification-service.md
View File

@ -13,7 +13,7 @@ UVS can be used to verify two claims:
* (A) Whether a given OpenID token is valid for a given server and
* (B) whether a user is member of a given room and the corresponding PowerLevel
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`.
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`.
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.
@ -91,6 +91,18 @@ 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.
### 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.
## Installing
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:
@ -104,14 +116,9 @@ The shortcut commands with the [`just` program](just.md) are also available: `ju
`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.
## Logging
## Troubleshooting
The configuration variable `UVS_LOG_LEVEL` can be set to:
- warning
- info
- 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: