octoleo/telegram-bot-bash
1
1
Fork 0
mirror of https://github.com/octoleo/telegram-bot-bash.git synced 2024-11-15 04:44:02 +00:00
Code Issues Projects Releases Wiki Activity
8adca9beea
telegram-bot-bash/examples/webhook
History
Kay Marquardt (Gnadelwartz) 8adca9beea final adjustments for v1.5
2021-03-08 08:06:35 +01:00
..
BASHBOT_HOME Bashbot Version 1.40 2021-02-04 18:13:32 +01:00
index.php startup: factor out bot_cleanup 2021-03-04 13:58:04 +01:00
json.txt bin: process_xxx: replace BOTADMIN with id of bot admin 2021-02-28 14:15:26 +01:00
README.md final adjustments for v1.5 2021-03-08 08:06:35 +01:00

README.md

Examples

Bashbot webhook example

Webhook

Bashbot default mode is to poll Telegram server for updates but Telegram offers webhook as a more efficient method to deliver updates. If your server is reachable from the Internet its possible to use the method described here.

Prerequisite for receiving Telegram updates with webhook is a valid SSL certificate, a self signed certificate will not be sufficient.

Webhook processing require special setup on server and Telegram side, therefore it's implemented as separate scripts and you need at least sudo rights to setup.

Setup Apache webhook

Prerequisite: An Apache webserver with a valid SLL certificate chain and php enabled.
This should work with other webservers also but it's not testet.

Setup webhook with Apache:

  • install bashbot as described in Bashbot Installation
  • create file data-bot-bash/webhook-fifo-<botname> (<botname> as in botconfig.jssh)
  • run sudo bashbot.sh init to setup bashbot to run as same user as web server (e.g. www)
  • create a directory in web root: telegram/<your_bot_token> (<your_bot_token> as botconfig.jssh)
  • give web server access to directory (e.g.chown www:www -R telegram)
  • go into the new directory and copy all files from examples/webhook to it
  • edit file BASHBOT_HOME to contain ithe Bashbot installation directory as first line (other lines are ignored)
  • execute php index.php with user id of web server to test write access to `data-bot-bash/webhook-fifo-

Calling https://<yourservername>/telegram/<your_bot_token>/ will execute index.php thus append received data to the file data-bot-bash/webhook-fifo-<botname>. E.g. https://<yourservername>/telegram/<your_bot_token>/?json={"test":"me"} will append {"test":"me"}.

Now your Server is ready to receive updates from Telegram.

Default webhook processing

This is the testet and supported default method for processing Telegram updates over webhook.

To enable update processing delete the file data-bot-bash/webhook-fifo-<botname> if webhook is working as described above. Incoming Telegram updates are now forwarded to the script bin/process_update.sh for processing.

On incoming Telegram updates the script is executed, it sources bashbot.sh and forward the update to Bashbot for processing. Even it seems overhead to source Bashbot for every update, it's more responsive and create less load than Bashbot polling mode.

Nevertheles there are some limitations compared to polling mode:

  • no startup actions
  • no background* and interactive jobs
  • addons and TIMER_EVENTS are not working

* Workaround for background jobs is to execute ./bashbot.sh resumeback if a new background job was started.

Full webhook processing

Full webhook processing use an external script to imitate Bashbot polling mode with webhook. Warning: This method is not much testet and may not work in all cases.

  1. Default webook method must work first!
  2. run bashbot.sh init to setup bashbot to run with your user id
  3. Create a named pipe: mkfifo data-bot-bash/webhook-fifo-botname and give the web server write access to it
  4. execute php index.php with user id of web server to test write access to `data-bot-bash/webhook-fifo-
  5. Start script for Bashbot webhook polling mode:
    bin/process-batch.sh --startbot --watch data-bot-bash/webhook-fifo-<botname>

The script read updates from given file line by line and forward updates to Bashbot update processing. --startbot will run the startup actions (e.g. load addons, start TIMER, trigger first run) and --watch will wait for new updates instead of exit on end of file. Short form: 'bin/process-batch.sh -s -w'

If script works as expected, you may run Bashbot webook polling in background by using ./bachbot.rc starthook/stophook.

To switch back to default processing delete fifo data-bot-bash/webhook-fifo-<botname> and stop bin/process-batch.sh.

Enable webhook on Telegram side

To get updates via webhook your server must be reachable from the internet and you must instruct Telegram where to deliver updates, this is done by calling bashbot function set_webhook.

Example:

bin/any_command.sh set_webhook "https://myserver.com/telegram"

instruct Telegram to use the URL https://myserver.com/telegram/<your_bot_token>/ to deliver updates. After you enable webhook to deliver Telegram updates it's no more possible to poll updates with bashbot.sh start.

To stop delivering of Telegram updates via webhook run bin/any_command.sh delete_webhook.

Important: Telegram will refuse to deliver updates if your webhook has no valid SSL certificate chain.

Bash webhook

A pure bash webhook implementation is not possible without extra software because Telegram delivers webhook updates only over secure TLS connections with a valid SSL certificate chain.

socat looks like a tool to listen for Telegram updates from bash scripts, let's see ...

$$VERSION$$ v1.45-dev-85-g41e6883