https://github.com/serverwentdown/githubbot
A simple Telegram Bot for public and private GitHub repositories
https://github.com/serverwentdown/githubbot
deno github-webhooks telegram-bot typescript
Last synced: 17 days ago
JSON representation
A simple Telegram Bot for public and private GitHub repositories
- Host: GitHub
- URL: https://github.com/serverwentdown/githubbot
- Owner: serverwentdown
- Created: 2019-10-04T09:34:17.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-10-07T06:32:37.000Z (over 5 years ago)
- Last Synced: 2025-05-07T06:06:03.322Z (17 days ago)
- Topics: deno, github-webhooks, telegram-bot, typescript
- Language: TypeScript
- Homepage: https://t.me/serverwentdown_githubbot
- Size: 11.7 KB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitHub Bot
A simple Telegram Bot to notify of events. Works with both private and public repositories using Webhooks.
# Usage
Add @serverwentdown_githubbot to your chat and type "/setup@serverwentdown_githubbot"
# Limitations
Webhook URLs can't be revoked, thus be careful when sharing them. This is a result of the stateless implementation of this bot.
# Configuring Your Own Instance
Run in Docker with the below command. Remember to configure the required environmental variables.
```
docker run --rm -it -p 8080:8080 -e ... serverwentdown/githubbot
```
## Environmental Variables
### `TELEGRAM_TOKEN`
This variable is mandatory. Specify your telegram bot token. Use @BotFather to obtain this.
### `TELEGRAM_SECRET`
This variable is mandatory. Generate a random string of length greater that 12 for this. It is used as an internal secret by the bot to secure communication with Telegram.
### `GITHUBBOT_BASE_URL`
This variable is mandatory. This is the base URL that must be externally accessible by your bot, without a trailing slash. If you mount your bot on a different path with a reverse proxy, include the directory in the base URL.
### `GITHUBBOT_SECRET`
This variable is mandatory. Generate a random string of length greater that 12 for this. It is used as an internal secret to authenticate Webhook URLs.