Koyote - Fast GitLab Event Notifications for Telegram

FYI

🦊 Koyote (no, it's not a misspelling) is a simple and fast Telegram bot that integrates with your GitLab (Cloud or Self-Hosted) to notify you about events that happen in your project.

TL;DR

Run Koyote as Binary

KOYOTE_API_PORT=8081 KOYOTE_TELEGRAM_BOT_TOKEN=abc:11223344 ./koyote

Run Koyote with Docker:

docker run -p 8081:8081 koyote:v0.1 -e KOYOTE_API_PORT=8081 -e KOYOTE_TELEGRAM_BOT_TOKEN=abc:11223344

How Koyote works

Koyote receives an event from GitLab
Koyote tries to parse the response from the API to known models
Koyote templates a message for a Telegram notification
Koyote sends the message to a Telegram chat or channel depending on the ID that is received from the WebHook URL

Koyote parameters

Parameter	Description	Default Value
`KOYOTE_API_PORT`	Koyote web-server port	8081
`KOYOTE_TELEGRAM_BOT_TOKEN`	Telegram bot token from @BotFather	empty (required)
`KOYOTE_ENABLE_JOB_NOTIFICATION`	Enable Telegram notification for JOB event	false
`KOYOTE_ENABLE_MR_NOTIFICATION`	Enable Telegram notification for MERGE REQUEST event	true
`KOYOTE_ENABLE_NOTE_NOTIFICATION`	Enable Telegram notification for NOTE event	false
`KOYOTE_ENABLE_PIPELINE_NOTIFICATION`	Enable Telegram notification for PIPELINE event	true
`KOYOTE_ENABLE_PUSH_NOTIFICATION`	Enable Telegram notification for PUSH event	false
`KOYOTE_ENABLE_TAG_PUSH_NOTIFICATION`	Enable Telegram notification for TAG PUSH event	false
`KOYOTE_REDIS_ENABLED`	Enable Redis for Event pooling if Telegram cannot be reached/whatever	false
`KOYOTE_REDIS_CHECK_UNSENDED_EVENTS_INTEVAL`	Interval (in seconds) to check for unsent Telegram events	empty
`KOYOTE_REDIS_UNSENDED_TASK_TTL`	Time in seconds for unsent Telegram events to expire	empty
`KOYOTE_REDIS_INSTANCE_URI`	Redis instance host	empty
`KOYOTE_REDIS_INSTANCE_PORT`	Redis instance port	empty
`KOYOTE_REDIS_USERNAME`	Redis username (default 'root')	empty
`KOYOTE_REDIS_PASSWORD`	Redis password	empty

GitLab configuration

Open your project in GitLab and go to Settings -> Webhooks
Check the triggers that you want to receive in Telegram
Insert the URL (e.g. http://koyote/notify/<chat_id>)
Press the "Add Webhook" button at the bottom of the page
At the bottom of the page, you can see the new webhook. Try sending a test event with the "Test" button and select the event you want to receive

Telegram configuration

Go to the @BotFather
Follow the instructions to create the bot
Get the Bot API token and forward it to Koyote with the environment variable KOYOTE_TELEGRAM_BOT_TOKEN
Enjoy :)

Roadmap

Improve stability and fix the codestyle
Implement a normal logic for taskpooler
...

What is this bot for?

We faced the problem of developers spending a lot of time notifying the team about new MR requests or failed builds and pipelines in the development chat. So I created this bot to make notifications faster and more automated. This bot helps our developers save time by not having to notify others manually and resend requests for new MRs to other developers. That's all.

After testing this bot in my projects for a month and not finding a normal realization of a bot like mine, I decided to create a community version for developers who are looking for something to automate the notification process.

Logo from Freepik - Flaticon

Akionka/koyote