aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMax Audron <audron@cocaine.farm>2021-02-28 05:59:42 +0100
committerGitHub <noreply@github.com>2021-02-28 15:59:42 +1100
commite4d3ff2374142fe6431b68874f6604a471732fae (patch)
tree7d2ee5ec0fcd7e901be3c46ad7afb94d7a6d2fc0 /docs
parentbcbcb3d107a3d991044354129c06e77ce19bda27 (diff)
downloadqmk_firmware-e4d3ff2374142fe6431b68874f6604a471732fae.tar.gz
qmk_firmware-e4d3ff2374142fe6431b68874f6604a471732fae.zip
Add support for using podman to util/docker_build.sh (#10819)
* add podman support to docker_build.sh script * break out runtime into the RUNTIME variable * allows RUNTIME to be set by the user * decides on docker or podman if docker isn't avaible * rewrote check for docker-machine to account only for docker runtime * put --user arg into a variable only to be used with docker this is not needed with podman as podman maps the containers root id to the users id. * add podman to getting_started_docker documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/getting_started_docker.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/getting_started_docker.md b/docs/getting_started_docker.md
index e5309fdbb..f9c3b366a 100644
--- a/docs/getting_started_docker.md
+++ b/docs/getting_started_docker.md
@@ -4,8 +4,9 @@ This project includes a Docker workflow that will allow you to build a new firmw
4 4
5## Requirements 5## Requirements
6 6
7The main prerequisite is a working `docker` install. 7The main prerequisite is a working `docker` or `podman` install.
8* [Docker CE](https://docs.docker.com/install/#supported-platforms) 8* [Docker CE](https://docs.docker.com/install/#supported-platforms)
9* [Podman](https://podman.io/getting-started/installation)
9 10
10## Usage 11## Usage
11 12
@@ -38,6 +39,13 @@ util/docker_build.sh
38# Reads parameters as input (leave blank for all keyboards/keymaps) 39# Reads parameters as input (leave blank for all keyboards/keymaps)
39``` 40```
40 41
42You can manually set which container runtime you want to use by setting the `RUNTIME` environment variable to it's name or path.
43By default docker or podman are automatically detected and docker is preferred over podman.
44
45```bash
46RUNTIME="podman" util/docker_build.sh keyboard:keymap:target
47```
48
41## FAQ 49## FAQ
42 50
43### Why can't I flash on Windows/macOS 51### Why can't I flash on Windows/macOS