From 555b4b107c5f56ec9d4815dd2cbee9725c04a111 Mon Sep 17 00:00:00 2001 From: Jenny Danzmayr Date: Fri, 8 Dec 2023 22:51:09 +0100 Subject: [PATCH] added readme for building the docker containers --- docker/README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 docker/README.md diff --git a/docker/README.md b/docker/README.md new file mode 100644 index 00000000..c7ed408a --- /dev/null +++ b/docker/README.md @@ -0,0 +1,25 @@ +# Docker Containers for c3nav + + +## Requirements for building + +You need docker buildx and qemu-user-static and a buildkit builder that is using the docker-container or kubernetes +driver if you want to build multi-arch images. + +This are the necessary steps to get it working on arch linux + +```bash +pacman -Sy docker-buildx qemu-user-static +docker buildx create --driver=docker-container --bootstrap --use +``` + +Additonally you need to be signed in into the github container registry. A guid for how to do this can be found +[here](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-with-a-personal-access-token-classic). + + +## Building + +You can run the `build.sh` script in two modes. If you run it without any arguments it uses your local git tree +including any uncommitted changes to build the docker containers. + +If you run `./build.sh git` it will do a fresh git checkout of the same commit as you currently on for building.