ultram4rine/alerter repository overview

⁠Alerter

Telegram and Matrix bot for alerts from Alertmanager⁠

⁠Usage

⁠Telegram preparations

1. Create bot with BotFather⁠ and get token.

2. Get your, group or channel chat id with Get My ID⁠ bot.

⁠Matrix preparations

1. Create user under which alerter will work.

2. Add this user to room for alerts and get room_id.

After preparations:

1. Configure⁠ alerter.

2. Optionally check that messages are being sent and properly formatted with that script⁠:

   ./test.sh tg
   

   Copy

   Or

   ./test.sh matrix
   

   Copy

3. Add alerter to receivers in your alertmanager.yml:

   receivers:
     - name: alerter_tg
       webhook_configs:
         - send_resolved: true
           url: "http://127.0.0.1:3030/tg"
     - name: alerter_matrix
       webhook_configs:
         - send_resolved: true
           url: "http://127.0.0.1:3030/matrix"
   

   Copy

⁠Templating

You can modify default templates for your needs, they are in Handlebars⁠ format. For Telegram alerter uses HTML⁠ style and for Matrix Markdown⁠ style.

⁠Installation

⁠Prebuilt packages

You can download prebuilt archive or Deb/RPM package from releases⁠.

⁠Docker

Pull image from DockerHub⁠:

docker pull ultram4rine/alerter

In other cases, you need Rust⁠ installed.

⁠Crates.io

You can install alerter from crates.io⁠:

cargo install alerter

Then download needed template⁠ and run.

⁠Build from source

1. Clone repository:

   git clone https://github.com/ultram4rine/alerter.git
   cd alerter
   

   Copy

2. Build binary:

   cargo build --release
   

   Copy

3. Binary should be in target/release/alerter.

⁠Build Deb or RPM package

See cargo-deb⁠ or cargo-generate-rpm⁠ instructions respectively.

⁠Configuration

Use environment variables or command-line flags to configure alerter: