github-com-docker-mailserver/docker-mailserver
1
0
Fork 0
mirror of https://github.com/docker-mailserver/docker-mailserver.git synced 2024-01-19 02:48:50 +00:00
Code Issues Projects Releases Wiki Activity

docs: add note about Docker version when building (#2799)

Browse source 
* add note about Docker version when building
* add note about `DOCKER_BUILDKIT` and build arguments
* provide link to COPY command
This commit is contained in:
Georg Lauterbach 2022-09-28 09:25:07 +02:00 committed by GitHub
parent 2da80bd5be
commit 98279e52b3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
docs/content/examples/tutorials/docker-build.md
View file

@ -4,6 +4,8 @@ title: 'Tutorials | Docker Build'
## Building your own Docker image ## Building your own Docker image
### Submodules
You'll need to retrieve the git submodules prior to building your own Docker image. From within your copy of the git repo run the following to retrieve the submodules and build the Docker image: You'll need to retrieve the git submodules prior to building your own Docker image. From within your copy of the git repo run the following to retrieve the submodules and build the Docker image:
```sh ```sh
@ -12,11 +14,33 @@ docker build -t mailserver/docker-mailserver .
``` ```
Or, you can clone and retrieve the submodules in one command: Or, you can clone and retrieve the submodules in one command:
```sh ```sh
git clone --recurse-submodules https://github.com/docker-mailserver/docker-mailserver git clone --recurse-submodules https://github.com/docker-mailserver/docker-mailserver
``` ```
Retrieving the git submodules will fix the error: Retrieving the git submodules will fix the error:
```
```txt
COPY failed: file not found in build context or excluded by .dockerignore: stat target/docker-configomat/configomat.sh: file does not exist COPY failed: file not found in build context or excluded by .dockerignore: stat target/docker-configomat/configomat.sh: file does not exist
``` ```
### About Docker
#### Version
We make use of build-features that require a recent version of Docker. Depending on your distribution, please have a look at [the official installation documentation for Docker](https://docs.docker.com/engine/install/) to get the latest version. Otherwise, you may encounter issues, for example with the `--link` flag for a [`#!dockerfile COPY`](https://docs.docker.com/engine/reference/builder/#copy) command.
#### Environment
If you are not using `make` to build the image, note that you will need to provide `DOCKER_BUILDKIT=1` to the `docker build` command for the build to succeed.
#### Build Arguments
The `Dockerfile` takes additional, so-called build arguments. These are
1. `VCS_VERSION`: the image version (default = edge)
2. `VCS_REVISION`: the image revision (default = unknown)
When using `make` to build the image, these are filled with proper values. You can build the image without supplying these arguments just fine though.