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-22 15:17:00 +01:00
Code Issues Projects Releases Packages Wiki Activity

Updated Local Bot API Servers (markdown)

Bibo-Joshi 2020-11-29 15:56:43 +01:00
parent bc98a9a05c
commit c8a65bd09a
1 changed files with 4 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
Local-Bot-API-Servers.md

@ -1,6 +1,4 @@
**WIP! v13.1 is not yet out and these remarks weren't double checked yet!**
Since Bot API 5.0, Telegram made the [Bot API server](https://github.com/tdlib/telegram-bot-api) open source allowing you to host your own instance. For details on what benefits hosting your own instance has and how it works, please see the [official docs](Using a Local Bot API Server).
Since Bot API 5.0, Telegram made the [Bot API server](https://github.com/tdlib/telegram-bot-api) open source allowing you to host your own instance. For details on what benefits hosting your own instance has and how it works, please see the [official docs](https://core.telegram.org/bots/api#using-a-local-bot-api-server).
Bot API 5.0 is supported by PTB since v13.1.
@ -9,10 +7,10 @@ Bot API 5.0 is supported by PTB since v13.1.
* Before moving your bot from the official server to a self hosted, you need to use the [`log_out`](https://core.telegram.org/bots/api#logout) method.
* Before moving from one self hosted instance to another, you need to use the [`delete_webhook`](https://core.telegram.org/bots/api#deletewebhook) and [`close`](https://core.telegram.org/bots/api#close) methods.
* To make PTB aware that you're not using the official server, pass the following to your `Updater` (or `Bot`):
* `base_url=your-bot-api-server.com/bot`
* `base_file_url=your-bot-api-server.com/file/bot`
* `base_url='your-bot-api-server.com/bot'`
* `base_file_url='your-bot-api-server.com/file/bot'`
### Working with files
* When running the server with the `--local` flag, `get_file` will give you the local file path as `file_path`. PTB detects that, so that `get_file(…).download()` just opens the local file instead of downloading it.
* When running the server with the `--local` flag, you can send files by passing `'file:///absolute/path/to/file'` instead of an URL or a file handler. Skipping the `'file://'` prefix, passing relative paths (without prefix) or even passing `pathlib.Path` objects is also supported as convenience feature by PTB.
* When running the server *without* the `--local` flag, the Bot API server does *not* automatically serve the files obtained by `get_file()`. See this [telegram-bot-api/#26](https://github.com/tdlib/telegram-bot-api/issues/26). Changing this is not within the scope of PTB, so this is merely a heads up.
* When running the server *without* the `--local` flag, the Bot API server does *not* automatically serve the files obtained by `get_file()`. See [telegram-bot-api/#26](https://github.com/tdlib/telegram-bot-api/issues/26). Changing this is not within the scope of PTB, so this is merely a heads up.