{"id":13823328,"url":"https://github.com/divideprojects/docker-telegram-bot-api","last_synced_at":"2025-04-13T01:02:15.239Z","repository":{"id":39867468,"uuid":"417451640","full_name":"divideprojects/docker-telegram-bot-api","owner":"divideprojects","description":"Auto build repository for 🐳 docker image of telegram-bot-api using Github Actions ","archived":false,"fork":false,"pushed_at":"2025-01-09T14:14:14.000Z","size":60,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-26T18:57:24.449Z","etag":null,"topics":["bot","docker","telegram","telegram-api","telegram-bot","telegram-bot-api"],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/divideprojects.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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},"funding":{"ko_fi":"divkix","github":"divkix"}},"created_at":"2021-10-15T10:00:37.000Z","updated_at":"2025-01-09T14:14:12.000Z","dependencies_parsed_at":"2023-02-18T01:16:14.433Z","dependency_job_id":"96483ef5-88d5-45e6-b53d-416d690ed659","html_url":"https://github.com/divideprojects/docker-telegram-bot-api","commit_stats":null,"previous_names":["divideprojects/docker-telegram-bot-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/divideprojects%2Fdocker-telegram-bot-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/divideprojects%2Fdocker-telegram-bot-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/divideprojects%2Fdocker-telegram-bot-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/divideprojects%2Fdocker-telegram-bot-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/divideprojects","download_url":"https://codeload.github.com/divideprojects/docker-telegram-bot-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248650427,"owners_count":21139672,"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":["bot","docker","telegram","telegram-api","telegram-bot","telegram-bot-api"],"created_at":"2024-08-04T09:00:29.818Z","updated_at":"2025-04-13T01:02:15.191Z","avatar_url":"https://github.com/divideprojects.png","language":"Dockerfile","funding_links":["https://ko-fi.com/divkix","https://github.com/sponsors/divkix"],"categories":["Dockerfile"],"sub_categories":[],"readme":"# docker-telegram-bot-api\n\n\u003cp align='center'\u003e\n  \u003cimg src=\"https://img.shields.io/github/forks/divideprojects/docker-telegram-bot-api?style=flat-square\" alt=\"Forks\"\u003e\n  \u003cimg src=\"https://img.shields.io/github/stars/divideprojects/docker-telegram-bot-api?style=flat-square\" alt=\"Stars\"\u003e\n  \u003cimg src=\"https://img.shields.io/github/issues/divideprojects/docker-telegram-bot-api?style=flat-square\" alt=\"Issues\"\u003e\n  \u003cimg src=\"https://img.shields.io/github/license/divideprojects/docker-telegram-bot-api?style=flat-square\" alt=\"LICENSE\"\u003e\n  \u003cimg src=\"https://img.shields.io/github/contributors/divideprojects/docker-telegram-bot-api?style=flat-square\" alt=\"Contributors\"\u003e\n  \u003cimg src=\"https://img.shields.io/github/repo-size/divideprojects/docker-telegram-bot-api?style=flat-square\" alt=\"Repo Size\"\u003e\n  \u003ca href=\"https://hub.docker.com/r/divideprojects/aliveimage\"\u003e\u003cimg src=\"https://img.shields.io/docker/image-size/divideprojects/docker-telegram-bot-api/latest\" alt=\"Docker Image Size (tag)\"\u003e\u003c/a\u003e\n  \u003cimg src=\"https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https://github.com/divideprojects/docker-telegram-bot-api\u0026amp;title=Profile%20Views\" alt=\"Views\"\u003e\n\u003c/p\u003e\n\n\u003cp align='center'\u003e\n  \u003ca href=\"https://www.python.org/\" alt=\"made-with-python\"\u003e \u003cimg src=\"https://img.shields.io/badge/Made%20with-Docker-1f425f.svg?style=flat-square\u0026logo=docker\u0026color=blue\" /\u003e \u003c/a\u003e\n  \u003ca href=\"https://github.com/divideprojects/docker-telegram-bot-api\" alt=\"Docker!\"\u003e \u003cimg src=\"https://img.shields.io/docker/pulls/divideprojects/docker-telegram-bot-api.svg\" /\u003e \u003c/a\u003e\n  \u003ca href=\"https://hub.docker.com/r/divideprojects/docker-telegram-bot-api\" alt=\"Docker Image Version\"\u003e \u003cimg src=\"https://img.shields.io/docker/v/divideprojects/docker-telegram-bot-api/latest?label=docker%20image%20ver.\" /\u003e \u003c/a\u003e\n  \u003ca href=\"https://deepsource.io/gh/divideprojects/docker-telegram-bot-api/?ref=repository-badge\"\u003e\u003cimg src=\"https://static.deepsource.io/deepsource-badge-light-mini.svg\" alt=\"DeepSource\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nThis is an unofficial docker image for [tdlib/telegram-bot-api](https://github.com/tdlib/telegram-bot-api)\n\nYou can use this image to create a local [Local Bot API Server](https://core.telegram.org/bots/api#using-a-local-bot-api-server) for [telegram bots](https://core.telegram.org/bots)\n\n## Quick reference\n\nBefore start, you will need to obtain `api-id` and `api-hash` as described in [Telegram's Official Documentation](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 run the following command:\n```\ndocker 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 divideprojects/docker-telegram-bot-api:latest\n```\n\n## How to use?\n### Set the Environmental Variables\n\nContainer can be configured via environment variables\n\n - `TELEGRAM_API_ID`, `TELEGRAM_API_HASH`: Reuired for Telegram API access, can be obtained at https://my.telegram.org as described in https://core.telegram.org/api/obtaining_api_id\n\n - `TELEGRAM_STAT`: Enable statistics HTTP endpoint.\nUsage: `-e TELEGRAM_STAT=true -p 8082:8082` and then check that `curl http://\u003chost\u003e:8082` returns server statistic\n\n -  `TELEGRAM_FILTER`: \"\u003cremainder\u003e/\u003cmodulo\u003e\". Allow only bots with 'bot_user_id % modulo == remainder'\n\n - `TELEGRAM_MAX_WEBHOOK_CONNECTIONS`: default value of the maximum webhook connections per bot\n\n - `TELEGRAM_VERBOSITY`: log verbosity level\n\n - `TELEGRAM_LOG_FILE`: Filename where logs will be redirected (By default logs will be written to stdout/stderr streams)\n\n - `TELEGRAM_MAX_CONNECTIONS`: maximum number of open file descriptors\n\n - `TELEGRAM_PROXY`: HTTP proxy server for outgoing webhook requests in the format http://host:port\n\n - `TELEGRAM_LOCAL`: allow the Bot API server to serve local requests\n\n\n## Start with persistent storage\n\nServer's 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```\n-v telegram-bot-api-data:/etc/telegram/bot/api\n```\n\n## Usage via docker stack deploy or docker-compose\n\n```yaml\nversion: '3.8'\n\nservices:\n  telegram-bot-api:\n    image: divideprojects/docker-telegram-bot-api:latest\n    environment:\n      TELEGRAM_API_ID: \"\u003capi-id\u003e\"\n      TELEGRAM_API_HASH: \"\u003capi-hash\u003e\"\n      # you can also configure other env variables here\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\n# Credits:\n\nThese repositories helped us make this!\n\n - [bots-house](https://github.com/bots-house/docker-telegram-bot-api)\n - [aiogram](https://github.com/aiogram/telegram-bot-api)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdivideprojects%2Fdocker-telegram-bot-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdivideprojects%2Fdocker-telegram-bot-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdivideprojects%2Fdocker-telegram-bot-api/lists"}