tdlib-telegram-bot-api-docker/README.md
2020-12-28 09:49:35 +00:00

2.6 KiB

tdlib-telegram-bot-api-docker

Purpose of the project

Produce working, minimal Docker image for the Telegram Bot API server together with easy to use pipeline generating builds on the changes within the main repository managed by Telegram team.

Motivation: #0, #1, #2

This project does not modify any part of the tdlib/telegram-bot-api code.

Issues

As I do not modify any part of the server code I am not responsible for the way it works. For that purpose you should open an issue on the telegram bot api server issue tracker. TL;DR: My responsibility ends when container and binary starts.

Build schedule

Build will be triggered automatically once a week to produce the latest version of the Telegram API Server. I would set it for the daily release but every build takes ~25 minutes and generates additional costs on my side. Images are versioned in format 1.0.x where x is a build number.

How to use the image

Images created within this project support following architectures: AMD64 and ARM64

Yes, it means you can run them on regular servers and Raspberry Pi 4 and above as well! 🥳

Github authentication

You need to authenticate with github (see this thread) to pull even the publicly available images. To do so you need to create Personal Access Token with read:packages scope and use it to authenticate your docker client with the Github Docker Registry.

docker login -u $GITHUB_USERNAME -p $GITHUB_TOKEN docker.pkg.github.com

Docker configuration version

docker pull docker.pkg.github.com/lukaszraczylo/tdlib-telegram-bot-api-docker/telegram-api-server:latest
docker run -p 8081:8081 -e TELEGRAM_API_ID=yourApiID -e TELEGRAM_API_HASH=yourApiHash -t docker.pkg.github.com/lukaszraczylo/tdlib-telegram-bot-api-docker/telegram-api-server

Thing to remember: Entrypoint is set to the server binary, therefore you can still modify parameters on the go, as shown below

Setting the log output and verbosity

Set the log output and verbosity

Printing out the help

Print out the help

Kubernetes configuration version

TBC;