2021-01-30 20:36:38 +00:00
|
|
|
#### [Examples](../README.md)
|
|
|
|
|
|
2021-01-31 20:18:40 +00:00
|
|
|
## Bashtbot webhook example
|
2021-01-30 20:36:38 +00:00
|
|
|
|
2021-01-31 20:18:40 +00:00
|
|
|
### Webhooks
|
2021-01-30 20:36:38 +00:00
|
|
|
|
2021-01-31 20:18:40 +00:00
|
|
|
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.
|
2021-01-30 20:36:38 +00:00
|
|
|
|
|
|
|
|
|
2021-01-31 20:18:40 +00:00
|
|
|
#### Setup Apache webhook
|
2021-01-30 20:36:38 +00:00
|
|
|
|
2021-01-31 20:18:40 +00:00
|
|
|
Prerequisite: An Apache webserver with a valid SLL certificate chain and php enabled.
|
2021-01-30 20:36:38 +00:00
|
|
|
|
2021-01-31 20:18:40 +00:00
|
|
|
Prepare Apache to forward webhook to Bashbot:
|
2021-01-30 20:36:38 +00:00
|
|
|
|
2021-01-31 20:18:40 +00:00
|
|
|
- install bashbot as described in [Bashbot Installation](../../doc/0_install.md)
|
|
|
|
|
- create file `data-bot-bash/webhook-fifo`
|
|
|
|
|
- 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`
|
2021-01-30 20:36:38 +00:00
|
|
|
|
2021-01-31 20:18:40 +00:00
|
|
|
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`.
|
|
|
|
|
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`.
|
2021-01-30 20:36:38 +00:00
|
|
|
|
2021-01-31 20:18:40 +00:00
|
|
|
Now your Apache is ready to forward data to Bashbot.
|
2021-01-30 20:36:38 +00:00
|
|
|
|
|
|
|
|
|
2021-01-31 20:18:40 +00:00
|
|
|
#### Simple update processing
|
2021-01-30 20:36:38 +00:00
|
|
|
|
2021-02-01 11:58:57 +00:00
|
|
|
To configure `Simple update processing` delete the file `data-bot-bash/webhook-fifo` after your webhook is working.
|
|
|
|
|
All webhook calls are now forwarded to `bin/process_update.sh` for processing.
|
2021-01-31 20:30:28 +00:00
|
|
|
|
2021-02-01 11:58:57 +00:00
|
|
|
To start `Simple processing ` enable webhook on Telegram (_see below_).
|
2021-01-31 20:30:28 +00:00
|
|
|
|
|
|
|
|
Every incoming Telegram update load Bashbot once for processing one command. Even it seems overkill to load
|
2021-02-01 11:58:57 +00:00
|
|
|
Bashbot on every incoming update, it's more responsive and create less server load for low traffic bots.
|
2021-01-31 20:30:28 +00:00
|
|
|
|
2021-02-01 11:58:57 +00:00
|
|
|
If your bot uses `addons` or `BASHBOT_EVENTs` you can't use `Simple processing`.
|
|
|
|
|
|
|
|
|
|
*Note:* `Simple processing` works without running `bashbot.sh start`.
|
2021-01-31 20:30:28 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
#### High traffic processing
|
|
|
|
|
|
2021-02-01 09:30:47 +00:00
|
|
|
#### CURRENTLY NOT IMPLEMENTED
|
|
|
|
|
|
2021-01-31 20:30:28 +00:00
|
|
|
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.
|
2021-01-30 20:36:38 +00:00
|
|
|
|
2021-02-01 11:58:57 +00:00
|
|
|
To switch from `Simple processing` to `High traffic processing` start bashbot as `bashbot.sh start-webhook`.
|
2021-01-31 20:18:40 +00:00
|
|
|
Stop bashbot with `bashbot.sh stop` to switch back to `Simple processing`
|
2021-01-30 20:36:38 +00:00
|
|
|
|
|
|
|
|
|
2021-01-31 20:30:28 +00:00
|
|
|
#### 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:*
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
|
2021-02-01 11:58:57 +00:00
|
|
|
#### $$VERSION$$ v1.40-dev-29-g737be16
|
2021-01-30 20:36:38 +00:00
|
|
|
|
