{"id":18976291,"url":"https://github.com/aiogram/telegram-bot-api","last_synced_at":"2025-04-04T08:06:42.324Z","repository":{"id":42461682,"uuid":"310136578","full_name":"aiogram/telegram-bot-api","owner":"aiogram","description":"Docker image of Telegram Bot API Server","archived":false,"fork":false,"pushed_at":"2024-10-20T23:01:33.000Z","size":48,"stargazers_count":161,"open_issues_count":1,"forks_count":49,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-10-29T23:59:59.519Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/aiogram/telegram-bot-api","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aiogram.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-11-04T22:57:15.000Z","updated_at":"2024-10-28T01:05:03.000Z","dependencies_parsed_at":"2023-09-26T04:25:59.046Z","dependency_job_id":"e32f42fc-97e3-48e9-a27d-cd41933e0061","html_url":"https://github.com/aiogram/telegram-bot-api","commit_stats":{"total_commits":47,"total_committers":6,"mean_commits":7.833333333333333,"dds":"0.17021276595744683","last_synced_commit":"a3e3b4c0a25ebb123cb19485696782199a555443"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aiogram%2Ftelegram-bot-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aiogram%2Ftelegram-bot-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aiogram%2Ftelegram-bot-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aiogram%2Ftelegram-bot-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aiogram","download_url":"https://codeload.github.com/aiogram/telegram-bot-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247142052,"owners_count":20890652,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T15:23:30.764Z","updated_at":"2025-04-04T08:06:42.301Z","avatar_url":"https://github.com/aiogram.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Unofficial Docker image of Telegram Bot API\n\nHere is Docker image for https://github.com/tdlib/telegram-bot-api\n\nThe Telegram Bot API provides an HTTP API for creating [Telegram Bots](https://core.telegram.org/bots).\n\nIf you've got any questions about bots or would like to report an issue with your bot, kindly contact us at [@BotSupport](https://t.me/BotSupport) in Telegram.\n\n## Quick reference\n\nBefore start, you will need to obtain `api-id` and `api-hash` as described in https://core.telegram.org/api/obtaining_api_id and specify them using the `TELEGRAM_API_ID` and `TELEGRAM_API_HASH` environment variables.\n\nAnd then to start the Telegram Bot API all you need to do is\n`docker run -d -p 8081:8081 --name=telegram-bot-api --restart=always -v telegram-bot-api-data:/var/lib/telegram-bot-api -e TELEGRAM_API_ID=\u003capi_id\u003e -e TELEGRAM_API_HASH=\u003capi-hash\u003e aiogram/telegram-bot-api:latest`\n\n## Configuration\n\nContainer can be configured via environment variables\n\n### `TELEGRAM_API_ID`, `TELEGRAM_API_HASH`\n\nApplication identifiers for Telegram API access, which can be obtained at https://my.telegram.org as described in https://core.telegram.org/api/obtaining_api_id\n\n### `TELEGRAM_STAT`\n\nEnable statistics HTTP endpoint.\n\nUsage: `-e TELEGRAM_STAT=1 -p 8082:8082` and then check that `curl http://\u003chost\u003e:8082` returns server statistic\n\n### `TELEGRAM_FILTER`\n\n\"\u003cremainder\u003e/\u003cmodulo\u003e\". Allow only bots with 'bot_user_id % modulo == remainder'\n\n### `TELEGRAM_MAX_WEBHOOK_CONNECTIONS`\n\ndefault value of the maximum webhook connections per bot\n\n### `TELEGRAM_VERBOSITY`\n\nlog verbosity level\n\n### `TELEGRAM_LOG_FILE`\n\nFilename where logs will be redirected (By default logs will be written to stdout/stderr streams)\n\n### `TELEGRAM_MAX_CONNECTIONS`\n\nmaximum number of open file descriptors\n\n### `TELEGRAM_PROXY`\n\nHTTP proxy server for outgoing webhook requests in the format http://host:port\n\n### `TELEGRAM_LOCAL`\n\nallow the Bot API server to serve local requests\n\n### `TELEGRAM_HTTP_IP_ADDRESS`\n\nUse the `TELEGRAM_HTTP_IP_ADDRESS: \"[::]\"` parameter to listen on the ipv6 intranet\n\n### `TELEGRAM_HTTP_PORT`\n\nSet which port the api server should listen to if you want to run the image in network mode as host and want to change the port.\n\nIf not set then the api server will listen to port 8081.\n\n## Start with persistent storage\n\nServer working directory is `/var/lib/telegram-bot-api` so if you want to persist the server data you can mount this folder as volume:\n\n`-v telegram-bot-api-data:/etc/telegram/bot/api`\n\nNote that all files in this directory will be owned by user `telegram-bot-api` and group `telegram-bot-api` (uid: `101`, gid: `101`, compatible with [nginx](https://hub.docker.com/_/nginx) image)\n\n## Usage via docker stack deploy or docker-compose\n\n```yaml\nversion: '3.7'\n\nservices:\n  telegram-bot-api:\n    image: aiogram/telegram-bot-api:latest\n    environment:\n      TELEGRAM_API_ID: \"\u003capi-id\u003e\"\n      TELEGRAM_API_HASH: \"\u003capi-hash\u003e\"\n    volumes:\n      - telegram-bot-api-data:/var/lib/telegram-bot-api\n    ports:\n      - \"8081:8081\"\n\nvolumes:\n  telegram-bot-api-data:\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faiogram%2Ftelegram-bot-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faiogram%2Ftelegram-bot-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faiogram%2Ftelegram-bot-api/lists"}