ambrose
/
githubbot
mirror of https://github.com/serverwentdown/githubbot.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Update README.md

master
Ambrose Chua 2019-10-04 19:04:49 +08:00 committed by GitHub
parent 350460e386
commit d079fd39a4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -7,6 +7,10 @@ A simple Telegram Bot to notify of events. Works with both private and public re
Add @serverwentdown_githubbot to your chat and type "/setup@serverwentdown_githubbot" 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 # Configuring Your Own Instance
Run in Docker with the below command. Remember to configure the required environmental variables. Run in Docker with the below command. Remember to configure the required environmental variables.
@ -17,23 +21,19 @@ docker run --rm -it -p 8080:8080 -e ... serverwentdown/githubbot
## Environmental Variables ## Environmental Variables
### TELEGRAM_TOKEN ### `TELEGRAM_TOKEN`
This variable is mandatory. Specify your telegram bot token. Use @BotFather to obtain this. This variable is mandatory. Specify your telegram bot token. Use @BotFather to obtain this.
### TELEGRAM_SECRET ### `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. 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 ### `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. 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 ### `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. 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.
## Limitations
Webhook URLs can't be revoked, thus be careful when sharing them. This is a result of the stateless implementation of this bot.