Преглед изворни кода

Update docs/configuring-playbook-user-verification-service.md: add the common introduction

Based on docs/configuring-playbook-dimension.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
pull/3904/head
Suguru Hirahara пре 1 година
родитељ
комит
dddbebc12e
No known key found for this signature in database GPG Key ID: E4F9743DAB4B7B75
1 измењених фајлова са 8 додато и 2 уклоњено
  1. +8
    -2
      docs/configuring-playbook-user-verification-service.md

+ 8
- 2
docs/configuring-playbook-user-verification-service.md Прегледај датотеку

@@ -1,8 +1,10 @@
# Setting up Matrix User Verification Service (optional) # Setting up Matrix User Verification Service (optional)


**[Matrix User Verification Service](https://github.com/matrix-org/matrix-user-verification-service) (hereafter: 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) flow and come back here later.
The playbook can install and configure [Matrix User Verification Service](https://github.com/matrix-org/matrix-user-verification-service) (hereafter: UVS) for you.


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. Please refer to the documentation of the [Matrix User Verification Service](https://github.com/matrix-org/matrix-user-verification-service) to understand how it works.
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.

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.


**Note**: enabling Matrix User Verification Service, means that the `openid` API endpoints will be exposed on the Matrix Federation port (usually `8448`), even if [federation](configuring-playbook-federation.md) is disabled. **Note**: enabling Matrix User Verification Service, means that the `openid` API endpoints will be exposed on the Matrix Federation port (usually `8448`), even if [federation](configuring-playbook-federation.md) is disabled.


@@ -23,6 +25,10 @@ Verifying RoomMembership and PowerLevel is done against `matrix_user_verificatio


In order to use UVS, an admin token for the configured homeserver must be supplied. For now this means configuring Synapse and creating the token before installing UVS. In order to use UVS, an admin token for the configured homeserver must be supplied. For now this means configuring Synapse and creating the token before installing UVS.


### Install Matrix services

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.

## Enable ## Enable


To enable Matrix User Verification Service, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: To enable Matrix User Verification Service, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:


Loading…
Откажи
Сачувај