Skip to content

Commit

Permalink
add readme instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
FredrikAugust committed Jul 8, 2024
1 parent 5c93352 commit 7c7bd89
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,20 @@ From this need, we created Debrief which is a simple Docker image you can run as

## How to use it

This tool is built around the concept of delivery mechanisms which is just a
way to list up where you want the daily updates to be sent. Currently, we support Slack and a database delivery mechanism.

You can enable the different ones with the following environment variables:

```env
DELIVERY_SLACK_ENABLED=true
DELIVERY_DB_ENABLED=true
```

Not setting them, or setting them to false, disables them.

---

Run the Docker image with the following environment variables:

```env
Expand All @@ -23,4 +37,6 @@ RUST_LOG=info
SLACK_API_KEY=
# The Slack channel ID you want to deliver the message to
SLACK_CHANNEL=
# The database URL if you want to use the DB delivery mechanism
DATABASE_URL=
```

0 comments on commit 7c7bd89

Please sign in to comment.