From 832ba0f04f486506ae57b6da1346555343cd161c Mon Sep 17 00:00:00 2001 From: Kalyan Mudumby <71078441+theinhumaneme@users.noreply.github.com> Date: Tue, 3 Dec 2024 22:55:26 +0530 Subject: [PATCH] improve documentation with instructions of custom config file --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 772c3f1..b2fa737 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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`.