ficd/zmk
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Option to use podman

Browse source
This commit is contained in:
urob 2023-03-31 22:09:17 -04:00
parent f04448e0c0
commit 78b1142e6f
2 changed files with 14 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

18
scripts/readme.md
View file

@ -41,10 +41,12 @@ The build script can be used to install either a "docker" or a "local"
toolchain. If unsure, I recommend using the docker toolchain. Depending on your toolchain. If unsure, I recommend using the docker toolchain. Depending on your
installation choice, do **one** of the following: installation choice, do **one** of the following:
1. Install the Docker engine following the 1. Install Docker or Podman (recommended) and, if using Podman, configure the docker
[instructions](https://docs.docker.com/engine/install/#server) for your registry. On Debian or Ubuntu, you can do both by running:
operating system. On Debian and Ubuntu, I recommend using the "Install from ```bash
Docker's `apt` repository" option. sudo apt-get install podman
echo 'unqualified-search-registries = ["docker.io"]' > $XDG_CONFIG_HOME/containers/registries.conf
```
2. Install a local [developer 2. Install a local [developer
toolchain](https://zmk.dev/docs/development/setup). The toolchain](https://zmk.dev/docs/development/setup). The
`zmk_local_install.sh` script in this repository automates the process for `zmk_local_install.sh` script in this repository automates the process for
@ -56,7 +58,7 @@ Run the `zmk_build.sh` script to build your boards. By default, the script will
build all boards specified in `build.yaml` in your `zmk-config` repo. The default can be build all boards specified in `build.yaml` in your `zmk-config` repo. The default can be
overwritten with the `-b` option. overwritten with the `-b` option.
If using docker, the script will pull down the required dependencies the first If using docker/podman, the script will pull down the required dependencies the first
time it is used. The script will automatically detect whether the build time it is used. The script will automatically detect whether the build
requirement have changed, and will only re-download the dependencies if needed. requirement have changed, and will only re-download the dependencies if needed.
@ -71,8 +73,10 @@ By default the script will copy the firmware into the `OUTPUT_DIR` folder
specified in the script. Other locations can be specified using the specified in the script. Other locations can be specified using the
`--output-dir` argument. `--output-dir` argument.
In order to start Docker in sudo-mode (required when the user is not in the To switch between Docker and Podman, set the `DOCKER_BIN` variable in the
docker-group), use `-s`. script (defaults to `podman`). If using Docker and the user is not in the
docker-group, then one can use Docker in sudo-mode by using the `-s` flag for
the script. If using Podman, running in rootless mode is recommended.
One can pass custom options to `west` by preluding them with `--`. One can pass custom options to `west` by preluding them with `--`.

5
scripts/zmk_build.sh
View file

@ -90,6 +90,7 @@ done
[[ -z $CLEAR_CACHE ]] && CLEAR_CACHE="false" [[ -z $CLEAR_CACHE ]] && CLEAR_CACHE="false"
DOCKER_IMG="zmkfirmware/zmk-dev-arm:$ZEPHYR_VERSION" DOCKER_IMG="zmkfirmware/zmk-dev-arm:$ZEPHYR_VERSION"
DOCKER_BIN="$SUDO podman"
# +-------------------------+ # +-------------------------+
# | AUTOMATE CONFIG OPTIONS | # | AUTOMATE CONFIG OPTIONS |
@ -127,7 +128,7 @@ fi
if [[ $RUNWITH_DOCKER = true ]] if [[ $RUNWITH_DOCKER = true ]]
then then
echo "Build mode: docker" echo "Build mode: docker"
DOCKER_CMD="$SUDO docker run --name zmk-$ZEPHYR_VERSION --rm \ DOCKER_CMD="$DOCKER_BIN run --name zmk-$ZEPHYR_VERSION --rm \
--mount type=bind,source=$HOST_ZMK_DIR,target=$DOCKER_ZMK_DIR \ --mount type=bind,source=$HOST_ZMK_DIR,target=$DOCKER_ZMK_DIR \
--mount type=bind,source=$HOST_CONFIG_DIR,target=$DOCKER_CONFIG_DIR,readonly \ --mount type=bind,source=$HOST_CONFIG_DIR,target=$DOCKER_CONFIG_DIR,readonly \
--mount type=volume,source=zmk-root-user-$ZEPHYR_VERSION,target=/root \ --mount type=volume,source=zmk-root-user-$ZEPHYR_VERSION,target=/root \
@ -138,7 +139,7 @@ then
# Reset volumes # Reset volumes
if [[ $CLEAR_CACHE = true ]] if [[ $CLEAR_CACHE = true ]]
then then
$SUDO docker volume rm $(sudo docker volume ls -q | grep "^zmk-.*-$ZEPHYR_VERSION$") $DOCKER_BIN volume rm $($DOCKER_BIN volume ls -q | grep "^zmk-.*-$ZEPHYR_VERSION$")
fi fi
# Update west if needed # Update west if needed