telegram-bot-bash

mirror of https://github.com/octoleo/telegram-bot-bash.git synced 2024-11-28 18:26:28 +00:00

History

Kay Marquardt (Gnadelwartz) d6f37afa3a example/webhook: add botname to fifo		2021-02-15 15:17:50 +01:00
..
BASHBOT_HOME	Bashbot Version 1.40	2021-02-04 18:13:32 +01:00
index.php	example/webhook: add botname to fifo	2021-02-15 15:17:50 +01:00
json.txt	modules: processUpdates: show sleep minutes	2021-02-01 08:59:53 +01:00
README.md	example/webhook: add botname to fifo	2021-02-15 15:17:50 +01:00

Bashtbot webhook example

Webhooks

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

Setup Apache webhook

Prerequisite: An Apache webserver with a valid SLL certificate chain and php enabled.

Prepare Apache to forward webhook to Bashbot:

install bashbot as described in Bashbot Installation
create file data-bot-bash/webhook-fifo-<botname> ( as in botconfig.jssh)
run bashbot.sh init to setup bashbot to run as same user as Apache (e.g. www)
go to apache web root and create directory telegram/<your_bot_token>
copy all files from examples/webhook to new directory and change to it
write bashbot installation directory as first line to file BASHBOT_HOME
execute php index.php

Every call to webhook https://<yourservername>/telegram/<your_bot_token>/ will execute index.php and write received JSON to 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 Apache is ready to forward data to Bashbot.

Simple update processing

To configure Simple update processing delete the file data-bot-bash/webhook-fifo-<botname> after your webhook is working. All webhook calls are now forwarded to bin/process_update.sh for processing.

To start Simple processing enable webhook on Telegram (see below).

Every incoming Telegram update load Bashbot once for processing one command. Even it seems overkill to load Bashbot on every incoming update, it's more responsive and create less server load for low traffic bots.

If your bot uses addons or BASHBOT_EVENTs you can't use Simple processing.

Note: Simple processing works without running bashbot.sh start.

High traffic processing

CURRENTLY NOT IMPLEMENTED

High traffic processing writes Telegram updates to the named pipe data-bot-bash/webhook-fifo and Bashbot poll them, this is much more efficient than polling Telegram server.

To switch from Simple processing to High traffic processing start bashbot as bashbot.sh start-webhook. Stop bashbot with bashbot.sh stop to switch back to Simple processing

Enable webhook on Telegram

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: Only https connections with a valid certificate chain are allowed as endpoint for webhook.

README.md

Examples