https://github.com/bots-house/docker-telegram-bot-api

🧢 Docker image for Telegram Bot API. Always fresh!
https://github.com/bots-house/docker-telegram-bot-api

docker-image telegram-bot-api

Last synced: 10 months ago
JSON representation

🧢 Docker image for Telegram Bot API. Always fresh!

• Host: GitHub
• URL: https://github.com/bots-house/docker-telegram-bot-api
• Owner: bots-house
• License: mit
• Created: 2020-11-04T15:05:47.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-03-15T09:59:16.000Z (over 2 years ago)
• Last Synced: 2024-04-16T00:45:53.593Z (about 2 years ago)
• Topics: docker-image, telegram-bot-api
• Language: Dockerfile
• Homepage: https://github.com/tdlib/telegram-bot-api
• Size: 12.7 KB
• Stars: 69
• Watchers: 6
• Forks: 11
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# docker-telegram-bot-api ![CI](https://github.com/bots-house/docker-telegram-bot-api/workflows/CI/badge.svg)

It's just image and CI pipline for build [tdlib/telegram-bot-api](https://github.com/tdlib/telegram-bot-api). 

 - 🧙 no magic, contains only build stage with binary entrypoint; 

 - 🔄 trigger build when someone push to upstream repository (via [github-actions-upstream-watch](https://github.com/bots-house/github-actions-upstream-watch))

## Docker Compose

```yaml

version: '3.8'

volumes:

  server-data: 

    driver: local

services:

  server:

    image: ghcr.io/bots-house/docker-telegram-bot-api:latest

    environment: 

      # get this values from https://core.telegram.org/api/obtaining_api_id

      TELEGRAM_API_ID: ?

      TELEGRAM_API_HASH: ?

    command: 

      # set working directory for files 

      - --dir=/var/lib/telegram-bot-api

      # enable logging, disable in production

      - --verbosity=2

    volumes: 

      # mount volume for persistance of files

      - server-data:/var/lib/telegram-bot-api

    ports:

      # access the API on 8081 port

      - 8081:8081

```

## Usage 

You can configure it through the command line flags, here is the list of available ones:

```

Usage: telegram-bot-api --api_id= --api-hash= [--local] [OPTION]...

Telegram Bot API server. Options:

  -h, --help                          display this help text and exit

      --local                         allow the Bot API server to serve local requests

      --api-id=                  application identifier for Telegram API access, which can be obtained at https://my.telegram.org (defaults to the value of the TELEGRAM_API_ID environment variable)

      --api-hash=                application identifier hash for Telegram API access, which can be obtained at https://my.telegram.org (defaults to the value of the TELEGRAM_API_HASH environment variable)

  -p, --http-port=               HTTP listening port (default is 8081)

  -s, --http-stat-port=          HTTP statistics port

  -d, --dir=                     server working directory

  -t, --temp-dir=                directory for storing HTTP server temporary files

      --filter=                  "/". Allow only bots with 'bot_user_id % modulo == remainder'

      --max-webhook-connections= default value of the maximum webhook connections per bot

  -l, --log=                     path to the file where the log will be written

  -v, --verbosity=               log verbosity level

      --log-max-file-size=       maximum size of the log file in bytes before it will be auto-rotated (default is 2000000000)

  -u, --username=                effective user name to switch to

  -g, --groupname=               effective group name to switch to

  -c, --max-connections=         maximum number of open file descriptors

      --proxy=                   HTTP proxy server for outgoing webhook requests in the format http://host:port

```

## Show your support

Give a ⭐️ if this project helped you!