Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sayyid5416/telegram-bot-api
Pre-Built Docker Image for telegram-bot-api
https://github.com/sayyid5416/telegram-bot-api
docker-hub docker-image telegram-bot-api
Last synced: 10 days ago
JSON representation
Pre-Built Docker Image for telegram-bot-api
- Host: GitHub
- URL: https://github.com/sayyid5416/telegram-bot-api
- Owner: sayyid5416
- Created: 2022-12-27T05:03:42.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-07T06:39:18.000Z (2 months ago)
- Last Synced: 2024-09-07T07:47:13.857Z (2 months ago)
- Topics: docker-hub, docker-image, telegram-bot-api
- Language: Dockerfile
- Homepage: https://hub.docker.com/r/sayyid5416/telegram-bot-api
- Size: 37.1 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🔰 [Docker-Hub Image](https://hub.docker.com/r/sayyid5416/telegram-bot-api)
- It's a pre-built docker image of [tdlib/telegram-bot-api](https://github.com/tdlib/telegram-bot-api).
- Different tags are also available, based on the version of [tdlib/telegram-bot-api](https://github.com/tdlib/telegram-bot-api).
- **Auto-Update:**
- It updates automatically, when [tdlib/telegram-bot-api](https://github.com/tdlib/telegram-bot-api) is updated.
- Updates are checked everyday 12:00 PM IST (6:30 AM UTC).
- Add [PAT](https://github.com/settings/tokens/new) _(with repo, user and workflow permissions)_ to `WORKFLOW_PAT` [action secret](../../settings/secrets/actions), if you want to auto-deploy to [docker-hub](https://hub.docker.com) when update is fetched. _(applicable only when you fork this repository)_
# 🔰 Pre-Requisites
### 💠Obtain API-ID and API-Hash
Obtain `api-id` & `api-hash` as described [here](https://core.telegram.org/api/obtaining_api_id) and specify them using `TELEGRAM_API_ID` & `TELEGRAM_API_HASH` [environment variables](#-environment-variables).
# 🔰 Environment Variables
### 💠Required
- `TELEGRAM_API_ID`
- `TELEGRAM_API_HASH`
### 💠Optional
- `EXTRA_ARGS`: Extra [arguments](#-available-arguments) for `telegram-bot-api`. Ex: ` `.
### 💠Available build args
- `TG_VERSION`: You can set the `TG_VERSION` env using this ARG, on build time.
### 💠ENVs available for your container, if uses this image as your base image
- All above envs _(if passed)_
- `DEFAULT_ARGS`: Default args for running telegram-bot-api.
- `TELEGRAM_WORK_DIR`: _[read here](#-available-arguments)_
- `TELEGRAM_TEMP_DIR`: _[read here](#-available-arguments)_
- `MACHINE_USERNAME`: _[read here](#-available-arguments)_
- `MACHINE_GROUPNAME`: _[read here](#-available-arguments)_
- `PORT1`: _[read here](#-available-arguments)_
- `PORT2`: _[read here](#-available-arguments)_
- `TG_VERSION`: Version of telegram-bot-api and docker-image.
# 🔰 Available Ports
- `8081/tcp` _(default for telegram-bot-api)_
- `8082/tcp`
# 🔰 Running Telegram-Bot-API
### 💠Overview
- There are many ways to run it. Some are:
- Running using `docker run`.
- **Deploying** to some hosting service directly.
- Using it as the **base image** in your docker container.
- Ex: `FROM sayyid5416/telegram-bot-api:latest`
- Check [docker-entrypoint.sh](/docker-entrypoint.sh) to get an idea of how to run it.
- Ex: `telegram-bot-api `
### 💠Available Arguments
- **Default-Arguments:** Already configured in [Dockerfile](/Dockerfile) as `DEFAULT_ARGS`.
```
Argument Default value Description
--api-id= Set it via ENV "TELEGRAM_API_ID" For Telegram API access
--api-hash= Set it via ENV "TELEGRAM_API_HASH" For Telegram API access
-p, --http-port= PORT1 (8081) HTTP listening port
-d, --dir= TELEGRAM_WORK_DIR (/file) Server working directory
-t, --temp-dir= TELEGRAM_TEMP_DIR (/tmp) Directory for storing HTTP server temporary files
-u, --username= MACHINE_USERNAME (telegram-bot-api) user name to switch to
-g, --groupname= MACHINE_GROUPNAME (telegram-bot-api) Effective group name to switch to
```
- **Extra-Arguments:** Pass these via `EXTRA_ARGS` [environment variable](#-environment-variables).
```
Argument Default value Description
--local NA Allow the Bot API server to serve local requests
-s, --http-stat-port= NA HTTP statistics port
--filter= NA "/". Allow only bots with 'bot_user_id % modulo == remainder'
--max-webhook-connections= NA Default value of the maximum webhook connections per bot
--http-ip-address= All IPv4 addresses local IP address, HTTP connections to which will be accepted
--http-stat-ip-address= All IPv4 addresses local IP address, HTTP statistics connections to which will be accepted
-l, --log= NA Path to the file where the log will be written
-v, --verbosity= NA Log verbosity level
--memory-verbosity= 3 Memory log verbosity level
--log-max-file-size= 2000000000 Maximum size of the log file in bytes before it will be auto-rotated
-c, --max-connections= NA Maximum number of open file descriptors
--proxy= NA HTTP proxy server for outgoing webhook requests in the format http://host:port
```
# 🔰 Some Useful Docs
- [Moving a bot to a local server](https://github.com/tdlib/telegram-bot-api#moving-a-bot-to-a-local-server) or [Moving a bot from one local server to another](https://github.com/tdlib/telegram-bot-api#moving-a-bot-from-one-local-server-to-another):
- You must call [logOut](https://core.telegram.org/bots/api#logout) on your bot, to deregister your bot from previous server, before using this server.
- [Using a Local Bot API Server](https://core.telegram.org/bots/api#using-a-local-bot-api-server) _(`--local`)_:
- More features will be unlocked & Limits would be removed.
- For [getFile](https://core.telegram.org/bots/api#getfile), files will be downloaded and path would be returned.
- You will need to use tools like [NGINX](https://nginx.org/en/) to download those files.
- **More Info:**
- Your own API endpoint, Ex: `/bot/getMe`.
- Telegram Bot API server accepts only HTTP requests, so a TLS termination proxy needs to be used to handle remote HTTPS requests.