From 8ae0c959f31c72889ec56c011413e66e7c6be7b5 Mon Sep 17 00:00:00 2001 From: Dan Cojocaru Date: Fri, 21 May 2021 00:45:27 +0300 Subject: [PATCH] Added README.md --- README.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c4a91b6 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# tdlib-docker + +[tdlib](https://github.com/tdlib/td) builds in a Docker container. + +Also available on [DockerHub](https://hub.docker.com/repository/docker/kbruen/tdlib). + +## Versions + +The currently built versions are: + +- `1.7.0-buster-slim`, `1.7.0-slim`, `buster-slim`, `slim` +- `1.7.0-alpine3.13`, `1.7.0-alpine3`, `1.7.0-alpine`, `alpine3.13`, `alpine3`, `alpine` + +## How to use + +The outputs of the build process are placed in the `/tdlib` folder in the image. + +The best way to use the images is in a multi-stage build: + +```dockerfile +FROM ghcr.io/dancojcoaru2000/tdlib:alpine3 AS tdlib + +FROM alpine:3 +COPY --from=tdlib /tdlib /tdlib/ +``` + +## How to build + +The files used to build the images are located in the [GitHub repository](https://github.com/dancojocaru2000/tdlib-docker). + +To build an image, enter the directory of either `alpine`, `debian` or `ubuntu` and run one of the following commands: + +- `env ALPINE_VERSION=3 ./build.sh 1.7.0` +- `env DEBIAN_VERSION=buster-slim ./build.sh 1.7.0` +- `env UBUNTU_VERSION=focal ./build.sh 1.7.0` + +The `*_VERSION` environment variable selects which Docker image version to base the build on. + +The `1.7.0` parameter to the `build.sh` script specifies the [tdlib version tag](https://github.com/tdlib/td/tags). \ No newline at end of file