diff --git a/README.html b/README.html index 6862f6d..2f7f285 100644 --- a/README.html +++ b/README.html @@ -91,9 +91,9 @@ Written by Drew (@topkecleon), Daniil Gentili (@danogentili), and Kay M (@gnadel
Released to the public domain wherever applicable. Elsewhere, consider it released under the WTFPLv2.
Uses JSON.sh, but no more TMUX.
-Even bashbot is written in bash, it depends on commands typically availible in a Unix/Linux Environment. More concret on the common commands provided by recent versions of coreutils, busybox or toybox, see Developer Notes
+Even bashbot is written in bash, it depends on commands typically available in a Unix/Linux Environment. More concret on the common commands provided by recent versions of coreutils, busybox or toybox, see Developer Notes
Note for MacOS and BSD Users: As bashbot heavily uses modern bash and (gnu) grep/sed features, bashbot will not run without installing additional software, see Install Bashbot
-Bashbot Documentation and Downloads are availible on www.github.com
+Bashbot Documentation and Downloads are available on www.github.com
To install and run bashbot you need acess to a linux/unix command line. If you don't know how to get accces to a linux/unix/bsd like command line you should stop reading here :-(
+To install and run bashbot you need access to a linux/unix command line. If you don't know how to get access to a linux/unix/bsd like command line you should stop reading here :-(
In addition you need a Telegram client and a mobile phone to register an account. If you don't want to register for Telegram you should stop reading here ;-)
After you're registered to Telegram send a message to @botfather, create a new Telegram Bot token and write it down. You need the token to install the bot.
Now open a linux/unix/bsd terminal and check if bash is installed: which bash && echo "bash installed!"
. If you get an error message bash is not installed.
For more Information on how to install, customize and use your new bot, read the Documentation
Since version 0.96 bashbot log commands recieved/send and connection errors. If you start bashbot in debug mode bash stdout, stderr and all send/received telegram message are logged also.
+Since version 0.96 bashbot log commands received/send and connection errors. If you start bashbot in debug mode bash stdout, stderr and all send/received telegram message are logged also.
To enable debug mode start bashbot with debug as third argument: bashbot start debug
├── logs
│ ├── BASHBOT.log # log what your bot is doing ...
@@ -225,7 +225,7 @@ It features background tasks and interactive chats, and can serve as an interfac
Why Bash and not the much better xyz?
Well, thats a damn good question ... may be because I'm an Unix/Linux admin from stone age. Nevertheless there are more reasons from my side:
-- bashbot will run everywhere where bash is availible, from ebedded linux to mainframe
+- bashbot will run everywhere where bash is available, from ebedded linux to mainframe
- easy to integrate with other shell script, e.g. for sending system message / health status
- no need to install or learn a new programming language, library or framework
- no database, not event driven, not OO ...
@@ -246,17 +246,17 @@ It features background tasks and interactive chats, and can serve as an interfac
# send me output of a system command
send_message "$(<"$BOTADMIN")" "$(df -h)"
For more information see Expert Use
-May be your IP is blocked by telegram. You can test this by running curl or wget manually:
+This may happen if to many wrong requests are sent to api.telegram.org, e.g. using a wrong token or not existing API calls. If you have a fixed IP you can ask telegram service to unblock your ip or change your IP. If you are running a tor proxy on your server you may uncomment the BASHBOT_CURL_ARGS
line in 'mycommands.sh'
You can test if younare blockeds by running curl or wget manually:
curl -m 10 https://api.telegram.org/bot
#curl: (28) Connection timed out after 10001 milliseconds
wget -t 1 -T 10 https://api.telegram.org/bot
#Connecting to api.telegram.org (api.telegram.org)|46.38.243.234|:443... failed: Connection timed out.
This may happen if to many wrong requests are sent to api.telegram.org, e.g. using a wrong token or not existing API calls. If you have a fixed IP you can ask telegram service to unblock your ip or change your IP. If you are running a socks or tor proxy on your server look for the BASHBOT_CURL_ARGS
lines in 'mycommands.sh' as example.
@Gnadelwartz
If you feel that there's something missing or if you found a bug, feel free to submit a pull request!
-