Update docs

This commit is contained in:
Till Faelligen 2022-05-25 09:30:44 +02:00
parent 4d47020668
commit 7cd8bb2023

View file

@ -14,9 +14,8 @@ User accounts can be created on a Dendrite instance in a number of ways.
The `create-account` tool is built in the `bin` folder when building Dendrite with The `create-account` tool is built in the `bin` folder when building Dendrite with
the `build.sh` script. the `build.sh` script.
It uses the `dendrite.yaml` configuration file to connect to the Dendrite user database It uses the `dendrite.yaml` configuration file to connect to a running Dendrite instance and requires
and create the account entries directly. It can therefore be used even if Dendrite is not shared secret registration to be enabled as explained below.
running yet, as long as the database is up.
An example of using `create-account` to create a **normal account**: An example of using `create-account` to create a **normal account**:
@ -32,6 +31,13 @@ To create a new **admin account**, add the `-admin` flag:
./bin/create-account -config /path/to/dendrite.yaml -username USERNAME -admin ./bin/create-account -config /path/to/dendrite.yaml -username USERNAME -admin
``` ```
By default `create-account` uses `https://localhost:8448` to connect to Dendrite, this can be overwritten using
the `-url` flag:
```bash
./bin/create-account -config /path/to/dendrite.yaml -username USERNAME -url http://localhost:8008
```
## Using shared secret registration ## Using shared secret registration
Dendrite supports the Synapse-compatible shared secret registration endpoint. Dendrite supports the Synapse-compatible shared secret registration endpoint.