5.2 KiB
Home
Install bashbot
- Go to the directory you want to install bashbot, e.g.
- your $HOME directory (install and run with your user-ID)
- /usr/local if you want to run as service
- Download latest release zip from github and extract all files.
- Change into the directory
telegram-bot-bash - Acticate the bot example commands ``cp mycommands.sh.dist mycommands.sh```
- Run
./bashbot.sh initto setup the environment and enter your Bots token given by botfather.
Edit 'mycommands.sh to your needs. Now your Bot is ready to start ...
If you are new to Bot development read Bots: An introduction for developers
Install from Github
As an alternative to download the zip files, you can clone the github repository to get the latest improvements/fixes.
- Go to the directory you want to install bashbot, e.g.
- your $HOME directory (install and run with your user-ID)
- /usr/local if you want to run as service
- Run
git clone https://github.com/topkecleon/telegram-bot-bash.git - Change into the directory
telegram-bot-bash - Run
test/ALL-tests.shand if everthing finish OK ... - Run
sudo ./bashbot.sh initto setup the environment and enter your Bots token given by botfather.
Update bashbot
Note: all files including 'mycommands.sh' may overwritten, make a backup!
- Go to the directory where you had installed bashbot, e.g.
- your $HOME directory
- /usr/local
- Download latest release zip from github
- Stop all running instances of bashbot
- Extract all files to your existing bashbot dir
- Run
sudo ./bashbot.sh initto setup your environment after the update
If you modified commands.sh move your changes to mycommands.sh, this avoids overwrrite of you changes on updates.
Now you can restart your bashbot instances.
Note for BSD and MacOS
On MacOS you must install a more recent version of bash, as the default bash is way to old, see e.g. Install Bash on Mac
On BSD and MacOS I recommend to install gnu coreutils and include them in front of your PATH environment variable before running bashbot, e.g. the gnu versions of sed, grep, find ...
I considered to make bashbot BSD sed compatible, but much of the bashbot "magic" relies on
(gnu) sed features, e.g. alternation |, non printables \n\t\< or repeat ?+ pattern, not supported by BSD sed.
BSD/MacOS sed compatibility will result in a rewrite of all grep/sed commands with an uncertain outcome,
see BSD/MacOS vs. GNU sed
to get an impression how different they are.
In adition you must adjust the shebang line of the scripts bashbot.sh and json.sh to point to to the correct bash
or use the example script: examples/bash2env *.sh */*.sh
Bashbot will stay with /bin/bash shebang, as using a fixed path is more secure than the portable /usr/bin/env variant, see Security Considerations
Notes on Updates
removal of TMUX
From version 0.80 on TMUX is no longer needed and the bachsbot command 'attach' is deleted. Old function 'inproc' is replaced by 'send_interactive'. send_interactive does checks if an interactive job is running internaly. Pls check if you make use of inproc and remove it including the old checks, e.g.
if tmux ls | grep -v send | grep -q "$copname"; then inproc; fi
# or
[ checkprog ] && inproc
must be replaced by send_interactive "${CHATD[ID]}" "${MESSAGE}"
Do not edit commands.sh
From version 0.60 on your commands must be placed in 'mycommands.sh'. If you update from a version with your commands in 'commands.sh' move all your commands and functions to 'mycommands.sh'.
From version 0.80 on 'commands.sh' will be overwritten on update!
Location of var / tmp / data dirs
From version 0.70 on the tmp dir is renamed to 'data-bot-bash' to reflect the fact that not only temporary files are stored. an existing 'tmp-bot-bash' will be automatically renamed after update.
From version 0.50 on the temporary files are no more placed in '/tmp'. instead a dedicated tmp dir is used.
Changes to send_keyboard in v0.6
From Version 0.60 on keybord format for send_keyboard and send_message "mykeyboardstartshere ..." was changed.
Keybords are now defined in JSON Array notation e.g. "[ \"yes\" , \"no\" ]".
This has the advantage that you can create any type of keyboard supported by Telegram.
The old format is supported for backward compatibility, but may fail for corner cases.
Example Keyboards:
- yes no in two rows:
- OLD format: 'yes' 'no' (two strings)
- NEW format: '[ "yes" ] , [ "no" ]' (two arrays with a string)
- new layouts made easy with NEW format:
- Yes No in one row: '[ "yes" , "no" ]'
- Yes No plus Maybe in 2.row: '[ "yes" , "no" ] , [ "maybe" ]'
- numpad style keyboard: '[ "1" , "2" , "3" ] , [ "4" , "5" , "6" ] , [ "7" , "8" , "9" ] , [ "0" ]'