wwmoraes/alertmanager-telegram-bot repository overview

⁠Alertmanager telegram bot

This is a work in progress, so take all functionalities with a grain of salt.

You can also jump directly to the docs⁠.

⁠Table of Contents

• About⁠
• Getting Started⁠
• Usage⁠
• Contributing⁠

⁠About

A bot that uses some fancy features from telegram as inline keyboards and replies to messages instead of the boring slash commands.

⁠Getting Started

You can setup the bot using those environment variables:

⁠Prerequisites

If running locally, nodejs and yarn, and install all dependencies:

yarn install

Otherwise you can use docker:

docker build -t wwmoraes/alertmanager-telegram-bot .

⁠message template

For formatting messages the bot uses doT⁠ + a linebreak replacement. You can provide a custom template file by mounting your file as a volume + setting the path on TEMPLATE_FILE. All br HTML tags will be replaced by line breaks.

⁠using it as a module on another bot

The alertmanager logic is also available as a Telegraf module to be used on other bots. You can do so with

import {
  AlertManagerContext,
  AlertManagerMiddleware,
  setupAlertManagerContext,
} from "./AlertManager";

interface YourBotContext extends AlertManagerContext {}

const bot = new Telegraf<YourBotContext>("your-bot-token");

setupAlertManagerContext(bot);

bot.use(AlertManagerMiddleware);

⁠Usage

yarn start

OR

docker run --rm -it --env-file=.env -p 8443:8443 wwmoraes/alertmanager-telegram-bot

The bot itself is very straightforward, and does most of the actions using inline keyboards. You can enroll yourself to receive the AM alerts using /start 😄

⁠Slash commands

The alertmanager middleware uses no slash commands, and instead automatically registers the given user IDs to receive notifications.

If using the full bot from this repository, then you can use:

• /start - registers yourself to receive the alerts
• /help - well, halp 😂

It also responds to hi and stickers as a "health check".