Debian Codegraph @

docker/README.md

raw
1 # Dockerised davix
2
3 Files in this directory enable the creation of a Docker image for davix. The
4 Dockerfile is able to build all branches and tags from the repository. The
5 branch/tag to build is controlled by the `DAVIX_RELEASE` [build argument].
6
7 [build argument]: https://docs.docker.com/engine/reference/commandline/build#set-build-time-variables---build-arg
8
9 ## Building
10
11 To build this image with the default branch, which is the `devel` branch, run
12 the following command. This will create an image called `davix`:
13
14 ```shell
15 docker build -t davix .
16 ```
17
18 To build this image at a given release instead, run a command similar to the
19 following one. This will create an image tagged after the name of the release:
20
21 ```shell
22 docker build -t davix:0.7.2 --build-arg DAVIX_RELEASE=R_0_7_2 .
23 ```
24
25 ## Running
26
27 Given a Docker image called `davix`, you should be able to call the various
28 `davix` binaries without their leading `davix-` preamble in the binary name.
29 This is achieved through declaring [`davix.sh`] as the [ENTRYPOINT] of the
30 image.
31
32 [`davix.sh`]: ./davix.sh
33 [ENTRYPOINT]: https://docs.docker.com/engine/reference/builder/#entrypoint
34
35 For example, to call the `davix-ls` binary inside the Docker image `davix`, you
36 could run a command similar to the following:
37
38 ```shell
39 docker run -it --rm davix ls --help
40 ```