Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Documentation: for custom config file #85

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve Documentation: for custom config file #85

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ You can find the list of docker images [here](https://github.com/mr-karan/calert
docker pull ghcr.io/mr-karan/calert:latest
```

#### Custom Message Template

Here's an example `docker-compose` config with a custom `message.tmpl` mounted inside the container:

```yml
Expand All @@ -39,6 +41,18 @@ Here's an example `docker-compose` config with a custom `message.tmpl` mounted i
- ./message.tmpl:/etc/calert/message.tmpl
```

#### Custom Configuration

Here's an example `docker-compose` config with a custom `config.toml` mounted inside the container:
```yml
calert:
image: ghcr.io/mr-karan/calert:latest
ports:
- "6000:6000"
volumes:
- ./config.toml:/app/config.sample.toml
```

### Configuration

Refer to [config.sample.toml](./config.sample.toml) for instructions on how to configure `calert`.
Expand Down