add documentation
This commit is contained in:
17
README.md
17
README.md
@ -1,13 +1,13 @@
|
||||
# draupnir
|
||||
|
||||
> One line description of the recipe
|
||||
> Deploy an instance of the draupnir moderation bot for a selfhosted matrix server.
|
||||
|
||||
<!-- metadata -->
|
||||
|
||||
* **Category**: Apps
|
||||
* **Status**: 0
|
||||
* **Image**: [`draupnir`](https://hub.docker.com/r/draupnir), 4, upstream
|
||||
* **Healthcheck**: No
|
||||
* **Image**: [`draupnir`](https://hub.docker.com/r/gnuxie/draupnir), 4, upstream
|
||||
* **Healthcheck**: Yes
|
||||
* **Backups**: No
|
||||
* **Email**: No
|
||||
* **Tests**: No
|
||||
@ -17,8 +17,17 @@
|
||||
|
||||
## Quick start
|
||||
|
||||
* `abra app new draupnir --secrets`
|
||||
* `abra app new draupnir`
|
||||
* `abra app config <app-name>`
|
||||
* `abra app secret insert <app-name> access_token_secret v1 <access-token>`
|
||||
* `abra app deploy <app-name>`
|
||||
|
||||
For more, see [`docs.coopcloud.tech`](https://docs.coopcloud.tech).
|
||||
|
||||
## Bot setup
|
||||
Be sure to follow the **[official instructions](https://the-draupnir-project.github.io/draupnir-documentation/bot/setup)** for setting up draupnir account and control room.
|
||||
|
||||
The most commonly-set values for the official draupnir configuration file have been extracted into the recipe's `.env` file. If you find you want to set more values in the config, feel free to submit a PR with updates to the `config.yaml.tmpl` file.
|
||||
|
||||
Once you have an account for the draupnir bot, be sure to get its access token and insert it as a secret with `abra app secret insert`.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user