From 35089ec76055d7472c008cd19c5706b474b45a1c Mon Sep 17 00:00:00 2001 From: david Date: Sat, 18 May 2024 22:20:06 +0100 Subject: [PATCH] README_devuan.md: Extend description and examples. --- README_devuan.md | 148 +++++++++++++++++++++++++++++++++++++---------- 1 file changed, 118 insertions(+), 30 deletions(-) diff --git a/README_devuan.md b/README_devuan.md index d5152d1..215e9e5 100644 --- a/README_devuan.md +++ b/README_devuan.md @@ -1,44 +1,133 @@ -# Debian SD card images +# Devuan SD card images -This repository is a bunch of scripts to build SD card images that various [single-board computers](https://en.wikipedia.org/wiki/Single-board_computer) (SBC) can boot. Emphasis is on pureness; pure Debian and pure mainline U-boot. +This repository simply adds Devuan to a fork of https://github.com/johang/sd-card-images. Please do not report any Devuan-issues to johang. + +That project describes itself as +``` +a bunch of scripts to build SD card images that various single-board computers (SBC) can boot. +Emphasis is on pureness; pure Debian and pure mainline U-boot. +``` +The main implementation change is that the Dockerfile (`Dockerfile.devuan`) uses `FROM devuan/devuan:daedalus`. + +## Index +- [Pre-built images](#pre-built-images) +- [Usage](#usage) +- - [Build your own boot image](#build-your-own-boot-image) +- - [Build your own Devuan ext4 root filesystem image](#build-your-own-devuan-ext4-root-filesystem-image) +- [Examples](#examples) +- - [Example boot image](#example-boot-image) +- - - [To build a boot image for Raspberry Pi 3 B](#to-build-a-boot-image-for-raspberry-pi-3-b) +- - - [To build a boot image for Pine64 Rockpro64](#to-build-a-boot-image-for-pine64-rockpro64) +- - - [To build a boot image for Sinovoip Banana Pi M2 Zero](#to-build-a-boot-image-for-sinovoip-banana-pi-m2-zero) +- - [Example root filesystem image](#example-root-filesystem-image) +- - - [To build a Devuan ext4 root filesystem image for arm64](#to-build-a-devuan-ext4-root-filesystem-image-for-arm64) +- - - [To build a Devuan ext4 root filesystem image for armhf](#to-build-a-devuan-ext4-root-filesystem-image-for-armhf) ## Pre-built images -Pre-built images ready for download are availble at [sd-card-images.johang.se](https://sd-card-images.johang.se). +Pre-built images for Debian are available from the original project at [sd-card-images.johang.se](https://sd-card-images.johang.se). + +There are no pre-built images for Devuan. + +## If you have problems here ## + +This project is just a fork. If anything works at all, credit goes to johang. + +If you have problems building a Devuan image here, please first try to build a Debian image using https://github.com/johang/sd-card-images. + +Please do not report any Devuan-issues to johang, his interest is in pure Debian. ## Usage The generated SD card images are made up of two separate images: - **boot-BOARD.bin**: Boot image that contains partition table, U-Boot and chip-specific code. The boot image will only work on the board it's built for. The filename indicates which board it's built for. -- **debian-ARCH-VERSION-PASSWORD.bin**: Debian ext4 root filesystem image that contains a complete Debian installation, including kernel, initrd and device tree. This Debian image is generic and will work on all chips and boards with the CPU architecture it's built for. The filename indicates Debian version, CPU architecture and default root password. +- **devuan-ARCH-VERSION-PASSWORD.bin**: Devuan ext4 root filesystem image that contains a complete Devuan installation, including kernel, initrd and device tree. This Devuan image is generic and will work on all chips and boards with the CPU architecture it's built for. The filename indicates Devuan version, CPU architecture and default root password. These two images are the concatenated to a single image, which is then written to SD card, for example like this: - $ zcat boot-raspberrypi_3b.bin.gz debian-buster-arm64-XXXXXX.bin.gz > sd-card.img + $ zcat boot-raspberrypi_3b.bin.gz devuan-daedalus-arm64-XXXXXX.bin.gz > sd-card.img # dd if=sd-card.img of=/dev/sdXXX -### Build your own Devuan boot image +### Build your own boot image -#### To build a boot image for Raspberry Pi 3 B: +See many appropriate values of ```CHIP_ID``` at https://sd-card-images.johang.se/. +A full list of relevant ```CONFIG``` values is at https://github.com/u-boot/u-boot/tree/master/configs. + +For any valid combination of: + | Variable | | + |----------|-------------------------| + | BOARD_ID | Your choice of name, e.g. bananapi, pinebook | + | CHIP_ID | e.g. allwinner-a10, rk3399 | + | CONFIG | e.g. Bananapi_defconfig, pinebook-pro-rk3399_defconfig | + | TUPLE | e.g. arm-linux-gnueabihf for armhf, aarch64-linux-gnu for arm64 | + +To build: ```bash -docker build -t devuan/sd-images -f ./Dockerfile.devuan . -mkdir -p /tmp/sd-images -docker run --rm -v /tmp/sd-images:/artifacts sd-images build-boot raspberrypi_3b bcm2837 rpi_3_defconfig aarch64-linux-gnu -``` - -The image will end up in /tmp/sd-images on the host. - -#### To build a boot image for Pine64 Rockpro64: - -```bash -docker build -t devuan/sd-images -f ./Dockerfile.devuan . +docker build -t devuan/sd-images -f Dockerfile.devuan https://github.com/watchful-0wl/sd-card-images.git#add_devuan mkdir -p /tmp/sd-images docker run --rm \ -v /tmp/sd-images:/artifacts \ devuan/sd-images \ - build-boot ROCKPro64 rk3399 rockpro64-rk3399_defconfig aarch64-linux-gnu + build-boot ${BOARD_ID} ${CHIP_ID} ${CONFIG} ${TUPLE} +``` + +The image will end up in /tmp/sd-images on the host as `${BOARD_ID}.bin.gz`. + +### Build your own Devuan ext4 root filesystem image + +For any valid combination provided by the distribution: + |Variable | | | | + |--------------|---|---|---| + | DISTRIBUTION | **Devuan** | Debian | Ubuntu | + | ARCH | armhf, arm64, i386, amd64 | armhf, arm64, i386, amd64 | armhf, arm64, i386, amd64 | + | RELEASE | e.g. **daedalus**, excalibur, ceres | e.g bookworm, trixie, sid | e.g. focal, jammy, noble | + +To build: +```bash +docker build -t devuan/sd-images -f Dockerfile.devuan https://github.com/watchful-0wl/sd-card-images.git#add_devuan +mkdir -p /tmp/sd-images +docker run --rm \ + -v /tmp/sd-images:/artifacts \ + devuan/sd-images \ + build-debian ${DISTRIBUTION} ${ARCH} ${RELEASE} +``` + +The image will end up in /tmp/sd-images on the host as `${DISTRIBUTION}-${ARCH}-${RELEASE}-${PASSWORD}.bin`. + +## Examples + +### Example boot image + +#### To build a boot image for Raspberry Pi 3 B + +```bash +docker build -t devuan/sd-images -f Dockerfile.devuan https://github.com/watchful-0wl/sd-card-images.git#add_devuan +mkdir -p /tmp/sd-images +docker run --rm \ + -v /tmp/sd-images:/artifacts \ + devuan/sd-images \ + build-boot raspberrypi_3b \ + bcm2837 \ + rpi_3_defconfig \ + aarch64-linux-gnu +``` + +The image will end up in /tmp/sd-images on the host. + +#### To build a boot image for Pine64 Rockpro64 + +```bash +docker build -t devuan/sd-images -f Dockerfile.devuan https://github.com/watchful-0wl/sd-card-images.git#add_devuan +mkdir -p /tmp/sd-images +docker run --rm \ + -v /tmp/sd-images:/artifacts \ + devuan/sd-images \ + build-boot ROCKPro64 \ + rk3399 \ + rockpro64-rk3399_defconfig \ + aarch64-linux-gnu ``` The image will end up in /tmp/sd-images on the host. @@ -46,42 +135,41 @@ The image will end up in /tmp/sd-images on the host. #### To build a boot image for Sinovoip Banana Pi M2 Zero ```bash -docker build -t devuan/sd-images -f ./Dockerfile.devuan . +docker build -t devuan/sd-images -f Dockerfile.devuan https://github.com/watchful-0wl/sd-card-images.git#add_devuan mkdir -p /tmp/sd-images docker run --rm \ -v /tmp/sd-images:/artifacts \ devuan/sd-images \ - build-boot banana_pi_m2_zero allwinner-h2+ bananapi_m2_zero_defconfig arm-linux-gnueabihf + build-boot banana_pi_m2_zero \ + allwinner-h2+ \ + bananapi_m2_zero_defconfig \ + arm-linux-gnueabihf ``` The image will end up in /tmp/sd-images on the host. -### Build your own Debian ext4 root filesystem image +### Example root filesystem image -#### To build a Devuan ext4 root filesystem image for arm64: +#### To build a Devuan ext4 root filesystem image for arm64 ```bash -docker build -t devuan/sd-images -f ./Dockerfile.devuan . +docker build -t devuan/sd-images -f Dockerfile.devuan https://github.com/watchful-0wl/sd-card-images.git#add_devuan mkdir -p /tmp/sd-images docker run --rm \ -v /tmp/sd-images:/artifacts \ - -v `pwd`:/debimg \ - --privileged \ devuan/sd-images \ build-debian devuan arm64 daedalus ``` The image will end up in /tmp/sd-images on the host. -#### To build a Devuan ext4 root filesystem image for armhf: +#### To build a Devuan ext4 root filesystem image for armhf ```bash -docker build -t devuan/sd-images -f ./Dockerfile.devuan . +docker build -t devuan/sd-images -f Dockerfile.devuan https://github.com/watchful-0wl/sd-card-images.git#add_devuan mkdir -p /tmp/sd-images docker run --rm \ -v /tmp/sd-images:/artifacts \ - -v `pwd`:/debimg \ - --privileged \ devuan/sd-images \ build-debian devuan armhf daedalus ```