🦜
Cage Telegram Helper

^{notification message relay server for Cage}

Introduction

This is Telegram notification message relaying server for Cage project. this will relay notification messages from your Cage instance to Telegram Bot to send message to your telegram account.

In most cases, you will not need this since Cage already provides hosted version of this server out of the box. but if you want to use Telegram notification with your own Telegram Bot, you will need this.

Usage

Firstly, you should create your own telegram bot. you can follow this guide to create your own bot. after you created your bot, you will get a token for your bot. you will need this token to configure this server.

docker run -d --name cage-telegram-helper \
    -e TELEGRAM_BOT_TOKEN=<YOUR BOT TOKEN HERE> \
    -p 8080:3000 \
    async3619/cage-telegram-helper

or you can use docker-compose:

version: "3.9"

services:
    cage-telegram-helper:
        image: async3619/cage-telegram-helper
        container_name: cage-telegram-helper
        environment:
            - TELEGRAM_BOT_TOKEN=<YOUR BOT TOKEN HERE>
        ports:
            - 8080:3000

once you started this server, your bot will be able to provide you a token that you can use to configure your Cage instance:

You: /start

Bot: Now you can configure your cage instance with this token:
<YOUR CAGE-TELEGRAM TOKEN HERE>

then you should configure your Cage instance to use this server. you can do this by adding url property to your config.json file:

{
    // ...
    "notifiers": {
        "telegram": {
            "type": "telegram",
            "url": "http://localhost:8080",
            "token": "<YOUR CAGE-TELEGRAM TOKEN HERE>"
        }
    },
    // ...
}

now you all set. you can start to use your Cage instance with Telegram notification.