telegram-bot-bash

mirror of https://github.com/octoleo/telegram-bot-bash.git synced 2024-11-15 04:44:02 +00:00

History

Kay Marquardt (Gnadelwartz) a473e25dfd example: webhook: small doc updates		2021-03-01 12:59:06 +01:00
..
BASHBOT_HOME	Bashbot Version 1.40	2021-02-04 18:13:32 +01:00
index.php	webhook: save json as one line	2021-02-27 16:46: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	example: webhook: small doc updates	2021-03-01 12:59:06 +01:00

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 unpdates with webhook is a valid SSL certificate, a self signed certificate will not be sufficient.

Note: You need at least sudo rights to setup webhook.

Setup Apache webhook

Prerequisite: An Apache webserver with a valid SLL certificate chain and php enabled. Other webserver should work also but they are not testet.

Prepare Apache to forward webhook to Bashbot:

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 Apache (e.g. www)
go to apache web root and create the directory telegram/<your_bot_token>
change to the new directory and copy all files from examples/webhook to it
edit file BASHBOT_HOME to contain Bashbot installation directory as first line
execute php index.php as first test

From now on every call to https://<yourservername>/telegram/<your_bot_token>/ will execute index.php and write received JSON to the file data-bot-bash/webhook-fifo-<botname>. E.g. the URL https://<yourservername>/telegram/<your_bot_token>/?json={"test":"me"} will append {"test":"me"} to the file data-bot-bash/webhook-fifo-<botname>.

Now your Server is ready to receive updates from Telegram.

Default webhook processing

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

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

On every incoming Telegram update the script calls Bashbot once for processing the update. Even it seems overkill to load Bashbot on every incoming update, it's more responsive and create less server load than polling Telegram.

Nevertheles this has some limitations compared to run bashbot in polling mode:

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

Workaround for running new background jobs is to execute ./bashbot.sh resumeback after starting a new background job.

Full webhook processing

Full webhook processing use an external script to imitate Bashbot polling mode with webhook. There is no support for running the script in background, as a service or an other user.

Default webook method must work first!
run bashbot.sh to setup bashbot to run with your user id
Create fifo: mkfifo data-bot-bash/webhook-fifo-botname and give apache server write access to it
Start script to imitate Bashbot 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 run Bashbot startup actions (e.g. load addons, start TIMER, trigger first run) and --watch mean wait for new updates instead of exit on end of file.

To switch back to default processing delete fifo data-bot-bash/webhook-fifo-<botname> and kill 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 implementaition is not possible without additional software because Telegram deliver updates only over secure TLS connections and if a valid SSL certificate chain exists.

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

README.md

Examples