Parcourir la source

Document --tags=list-matrix-registration-tokens

Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/778
pull/787/head
Slavi Pantaleev il y a 5 ans
Parent
révision
0f9be8321c
1 fichiers modifiés avec 16 ajouts et 3 suppressions
  1. +16
    -3
      docs/configuring-playbook-matrix-registration.md

+ 16
- 3
docs/configuring-playbook-matrix-registration.md Voir le fichier

@@ -37,11 +37,14 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start

It provides various [APIs](https://github.com/ZerataX/matrix-registration/wiki/api) - for creating registration tokens, listing tokens, disabling tokens, etc. To make use of all of its capabilities, consider using `curl`.

We make the most common API (the one for creating unique registration tokens) easy to use via the playbook.
We make the most common APIs easy to use via the playbook (see below).

**To create a new user registration token (link)**, use this command:

```
### Creating registration tokens

To **create a new user registration token (link)**, use this command:

```bash
ansible-playbook -i inventory/hosts setup.yml \
--tags=generate-matrix-registration-token \
--extra-vars="one_time=yes ex_date=2021-12-31"
@@ -51,3 +54,13 @@ The above command creates and returns a **one-time use** token, which **expires*
Adjust the `one_time` and `ex_date` variables as you see fit.

Share the unique registration link (generated by the command above) with users to let them register on your Matrix server.


### Listing registration tokens

To **list the existing user registration tokens**, use this command:

```bash
ansible-playbook -i inventory/hosts setup.yml \
--tags=list-matrix-registration-tokens
```

Chargement…
Annuler
Enregistrer