OpenSource/python-telegram-bot
OpenSource/python-telegram-bot
1
0
Fork 0
mirror of https://github.com/python-telegram-bot/python-telegram-bot.git synced 2024-11-26 00:56:22 +01:00
Code Issues Projects Releases Packages Wiki Activity

Updated Webhooks (markdown)

Poolitzer 2023-01-04 23:37:56 +01:00
parent ea204fe7ca
commit e53de60df8
1 changed files with 16 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
Webhooks.md

@ -47,18 +47,18 @@ There actually is a third requirement: a HTTP server to listen for webhook conne
### The integrated webhook server ### The integrated webhook server
The `python-telegram-bot` library ships a custom HTTP server, that is tightly integrated in the `telegram.ext` module and can be started using `Updater.start_webhook`/`Application.run_webhook`. This webserver also takes care of decrypting the HTTPS traffic. It is probably the easiest way to set up a webhook. The `python-telegram-bot` library ships a custom HTTP server, that is tightly integrated in the `telegram.ext` module and can be started using `Updater.start_webhook`/`Application.run_webhook`. This webserver also takes care of decrypting the HTTPS traffic. It is probably the easiest way to set up a webhook.
However, there is a limitation with this solution. Telegram currently only supports four ports for webhooks: *443, 80, 88* and *8443.* As a result, you can only run a **maximum of four bots** on one domain/IP address. However, there is a limitation with this solution. Telegram currently only supports four ports for webhooks: *443, 80, 88* and *8443.* As a result, you can only run a **maximum of four bots** on one domain/IP address with the integrated server.
If that's not a problem for you (yet), you can use the code below (or similar) to start your bot with a webhook. The `listen` address should either be `'0.0.0.0'` or, if you don't have permission for that, the public IP address of your server. The port can be one of `443`, `80`, `88` or `8443`. For the `url_path`, it is recommended to use your Bot's token, so no one can send fake updates to your bot. `key` and `cert` should contain the path to the files you generated [earlier](#creating-a-self-signed-certificate-using-openssl). The `webhook_url` should be the actual URL of your webhook. Include the `https://` protocol in the beginning, use the domain or IP address you set as the FQDN of your certificate and the correct port and URL path. If that's not a problem for you (yet), you can use the code below (or similar) to start your bot with a webhook. The `listen` address should either be `'0.0.0.0'` or, if you don't have permission for that, the public IP address of your server. The port can be one of `443`, `80`, `88` or `8443`. It is recommended to set a secret token in the `secret_token` parameter, so no one can send fake updates to your bot. `key` and `cert` should contain the path to the files you generated [earlier](#creating-a-self-signed-certificate-using-openssl). The `webhook_url` should be the actual URL of your webhook. Include the `https://` protocol in the beginning, use the domain or IP address you set as the FQDN of your certificate and the correct port and URL path.
```python ```python
application.run_webhook( application.run_webhook(
listen='0.0.0.0', listen='0.0.0.0',
port=8443, port=8443,
url_path='TOKEN', secret_token='ASecretTokenIHaveChangedByNow',
key='private.key', key='private.key',
cert='cert.pem', cert='cert.pem',
webhook_url='https://example.com:8443/TOKEN' webhook_url='https://example.com:8443'
) )
``` ```
@ -82,13 +82,13 @@ PORT = int(os.environ.get('PORT', '8443'))
application.run_webhook( application.run_webhook(
listen="0.0.0.0", listen="0.0.0.0",
port=PORT, port=PORT,
url_path=TOKEN, secret_token='ASecretTokenIHaveChangedByNow',
webhook_url="https://<appname>.herokuapp.com/" + TOKEN webhook_url="https://<appname>.herokuapp.com/"
) )
``` ```
#### Using nginx with one domain/port for all bots #### Using nginx with one domain/port for all bots
This is similar to the Heroku approach, just that you set up the reverse proxy yourself. All bots set their `url` to the same domain and port, but with a different `url_path`. The integrated server should usually be started on the `localhost` or `127.0.0.1` address, the port can be any port you choose. This is similar to the Heroku approach, just that you set up the reverse proxy yourself. All bots set their `url` to the same domain and port. To differentiate the bots, add a different `url_path`. The integrated server should usually be started on the `localhost` or `127.0.0.1` address, the port can be any port you choose.
**Note:** `example.com` could be replaced by an IP address, if you have no domain associated to your server. **Note:** `example.com` could be replaced by an IP address, if you have no domain associated to your server.
@ -97,8 +97,9 @@ Example code to start the bot:
application.run_webhook( application.run_webhook(
listen='127.0.0.1', listen='127.0.0.1',
port=5000, port=5000,
url_path='TOKEN1', url_path='1',
webhook_url='https://example.com/TOKEN1', secret_token='ASecretTokenIHaveChangedByNow',
webhook_url='https://example.com/1',
cert='cert.pem' cert='cert.pem'
) )
``` ```
@ -112,17 +113,17 @@ server {
ssl_certificate_key private.key; ssl_certificate_key private.key;
location /TOKEN1 { location /TOKEN1 {
proxy_pass http://127.0.0.1:5000/TOKEN1/; proxy_pass http://127.0.0.1:5000/1/;
} }
location /TOKEN2 { location /TOKEN2 {
proxy_pass http://127.0.0.1:5001/TOKEN2/; proxy_pass http://127.0.0.1:5001/2/;
} }
} }
``` ```
#### Using haproxy with one subdomain per bot #### Using haproxy with one subdomain per bot
In this approach, each bot is assigned their own *subdomain*. If your server has the domain *example.com*, you could have the subdomains *bot1.example.com*, *bot2.example.com* etc. You will need one certificate for each bot, with the FQDN set for their respective subdomain. The reverse proxy in this example is `haproxy`. The integrated server should usually be started on the `localhost` or `127.0.0.1` address, the port can be any port you choose. In this approach, each bot is assigned their own *subdomain*. If your server has the domain *example.com*, you could have the subdomains *bot1.example.com*, *bot2.example.com* etc. You will need one certificate for each bot, with the FQDN set for their respective subdomain (or a wildcard certificate). The reverse proxy in this example is `haproxy`. The integrated server should usually be started on the `localhost` or `127.0.0.1` address, the port can be any port you choose.
**Note:** For this to work, you need a domain for your server. **Note:** For this to work, you need a domain for your server.
@ -131,8 +132,8 @@ Example code to start the bot:
application.run_webhook( application.run_webhook(
listen='127.0.0.1', listen='127.0.0.1',
port=5000, port=5000,
url_path='TOKEN', secret_token='ASecretTokenIHaveChangedByNow',
webhook_url='https://bot1.example.com/TOKEN', webhook_url='https://bot1.example.com',
cert='cert_bot1.pem') cert='cert_bot1.pem')
) )
``` ```
@ -160,7 +161,7 @@ backend bot2
### Custom solution ### Custom solution
You don't necessarily have to use the integrated webserver *at all*. If you choose to go this way, **you should not use the `Updater` class.** The `telegram.ext` module was designed with this option in mind, so you can still use the `Application` class to profit from the message filtering/sorting it provides. You will have to do some work by hand, though. You don't necessarily have to use the integrated webserver *at all*. If you choose to go this way, **you should not use the `Updater` class.** The `telegram.ext` module was designed with this option in mind, so you can still use the `Application` class to profit from the message filtering/sorting it provides. You will have to do some work by hand, though.
The general idea is outlined below and explained in more detail also in [this wiki section](https://github.com/python-telegram-bot/python-telegram-bot/wiki/Frequently-requested-design-patterns#running-ptb-alongside-other-asyncio-frameworks). The general idea is outlined below and also explained in more detail in [this wiki section](https://github.com/python-telegram-bot/python-telegram-bot/wiki/Frequently-requested-design-patterns#running-ptb-alongside-other-asyncio-frameworks).
```python ```python
from telegram import Bot from telegram import Bot