From 6493a6a67b59c6ebab6fee7457e2b51277bc52ff Mon Sep 17 00:00:00 2001 From: Linnea Date: Thu, 26 Feb 2026 21:37:31 -0800 Subject: [PATCH] add documentation --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 19de098..4a1fe37 100644 --- a/README.md +++ b/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. * **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 ` +* `abra app secret insert access_token_secret v1 ` * `abra app deploy ` 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`. +