diff --git a/README.md b/README.md index 4e75b49..0c92e14 100644 --- a/README.md +++ b/README.md @@ -7,17 +7,20 @@ Telegram team. ## How to use the image -### Docker version +### Github authentication +You need to authenticate with github [see this thread](https://github.community/t/docker-pull-from-public-github-package-registry-fail-with-no-basic-auth-credentials-error/16358/87) to pull even the publicly available images. To do so you need to create [Personal Access Token](https://github.com/settings/tokens/new) 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 ``` -### Kubernetes version +### Kubernetes configuration version TBC; - -## TODO - -- Provide shorter link for the pulls. Honestly. \ No newline at end of file