https://github.com/async3619/cage-telegram-helper
notification message relay server for Cage
https://github.com/async3619/cage-telegram-helper
Last synced: 12 months ago
JSON representation
notification message relay server for Cage
- Host: GitHub
- URL: https://github.com/async3619/cage-telegram-helper
- Owner: async3619
- License: mit
- Created: 2022-12-11T04:48:34.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-15T13:14:19.000Z (over 3 years ago)
- Last Synced: 2025-03-25T05:15:23.476Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 308 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
🦜
Cage Telegram Helper
## Introduction
This is Telegram notification message relaying server for [Cage](https://github.com/async3619/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](https://core.telegram.org/bots/features#botfather) 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.
```bash
docker run -d --name cage-telegram-helper \
-e TELEGRAM_BOT_TOKEN= \
-p 8080:3000 \
async3619/cage-telegram-helper
```
or you can use docker-compose:
```yaml
version: "3.9"
services:
cage-telegram-helper:
image: async3619/cage-telegram-helper
container_name: cage-telegram-helper
environment:
- TELEGRAM_BOT_TOKEN=
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:
```text
You: /start
Bot: Now you can configure your cage instance with this token:
```
then you should configure your Cage instance to use this server. you can do this by adding `url` property to your `config.json` file:
```json5
{
// ...
"notifiers": {
"telegram": {
"type": "telegram",
"url": "http://localhost:8080",
"token": ""
}
},
// ...
}
```
now you all set. you can start to use your Cage instance with Telegram notification.
