octoleo/telegram-bot-bash
1
1
Fork 0
mirror of https://github.com/octoleo/telegram-bot-bash.git synced 2024-11-26 09:16:28 +00:00
Code Issues Projects Releases Wiki Activity
8dcbc292a2
telegram-bot-bash/doc/0_install.md
Kay Marquardt (Gnadelwartz) 4b83377905 v0.70-pre2, doc for examples
2019-04-29 19:34:47 +02:00

3.0 KiB
Raw Blame History

Home

Install bashbot

  1. 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
  2. Download latest release zip from github and extract all files.
  3. Change into the directory telegram-bot-bash
  4. Create default commands with cp commands.sh.dist commands.sh; cp mycommands.sh.dist mycommands.sh
  5. Run ./bashbot.sh init to setup the environment and enter your Bots token given by botfather.

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.

  1. 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
  2. Run git clone https://github.com/topkecleon/telegram-bot-bash.git
  3. Change into the directory telegram-bot-bash
  4. Run test/ALL-tests.sh and if everthing finish OK ...
  5. Run sudo ./bashbot.sh init to setup the environment and enter your Bots token given by botfather.

Update bashbot

  1. Go to the directory where you had installed bashbot, e.g.
    • your $HOME directory
    • /usr/local
  2. Download latest release zip from github
  3. Extract all files to your existing bashbot dir Note: all files execpt 'mycommands.sh' and 'commands.sh' may overwritten!
  4. Run sudo ./bashbot.sh init to setup your environment after the update

Notes on Updates

Location of tmp / data dir

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" ]'

Next Create Bot

$$VERSION$$ v0.7-pre2-0-g7ce2c5b