|B.J. Dweck e07da141c9||6 months ago|
|export-image||6 months ago|
|export-noobs||6 months ago|
|scripts||1 year ago|
|stage0||1 year ago|
|stage1||1 year ago|
|stage2||6 months ago|
|stage3||6 months ago|
|stage4||6 months ago|
|stage5||6 months ago|
|.dockerignore||3 years ago|
|.gitignore||6 months ago|
|Dockerfile||6 months ago|
|LICENSE||3 years ago|
|README.md||6 months ago|
|build-docker.sh||6 months ago|
|build.sh||7 months ago|
|depends||1 year ago|
|docker-compose.yml||3 years ago|
configfile in the project similar to the following:
IMG_NAME=RasbianTorch KEYBOARD_KEYMAP="us" LOCALE_DEFAULT="en_CA.UTF-8" FIRST_USER_NAME=[USERNAME] ENABLE_SSH=1 PUBKEY_SSH_FIRST_USER=[YOUR_SSH_PUBKEY] PUBKEY_ONLY_SSH=1 STAGE_LIST="stage0 stage1 stage2"
After a nice, long build, a file named (something like)
image_2020-10-07-RasbianTorch-lite.zip will appear in the
Unzip this file to an
.img file and flash it to an SD card
/boot partition of the SD card and create a dir named
Copy your torch configuration files for this device into the
/boot/torch dir (see torch-agent for details on configuration)
/boot partition and eject the SD card
pi-gen runs on Debian-based operating systems. Currently it is only supported on either Debian Buster or Ubuntu Xenial and is known to have issues building on earlier releases of these systems. On other Linux distributions it may be possible to use the Docker build described below.
To install the required dependencies for
pi-gen you should run:
apt-get install coreutils quilt parted qemu-user-static debootstrap zerofree zip \ dosfstools bsdtar libcap2-bin grep rsync xz-utils file git curl bc
depends contains a list of tools needed. The format of this
build.sh will source the file
config in the current
working directory. This bash shell fragment is intended to set needed
The following environment variables are supported:
IMG_NAME required (Default: unset)
The name of the image to build with the current stage directories. Setting
IMG_NAME=Raspbian is logical for an unmodified RPi-Distro/pi-gen build,
but you should use something else for a customized version. Export files
in stages may add suffixes to
RELEASE (Default: buster)
The release version to build images against. Valid values are jessie, stretch buster, bullseye, and testing.
APT_PROXY (Default: unset)
If you require the use of an apt proxy, set it here. This proxy setting
will not be included in the image, making it safe to use an
similar package for development.
If you have Docker installed, you can set up a local apt caching proxy to like speed up subsequent builds like this:
docker-compose up -d echo 'APT_PROXY=http://172.17.0.1:3142' >> config
BASE_DIR (Default: location of
CAUTION: Currently, changing this value will probably break build.sh
Top-level directory for
pi-gen. Contains stage directories, build
scripts, and by default both work and deployment directories.
Directory in which
pi-gen builds the target system. This value can be
changed if you have a suitably large, fast storage location for stages to
be built and cached. Note,
WORK_DIR stores a complete copy of the target
system for each build stage, amounting to tens of gigabytes in the case of
CAUTION: If your working directory is on an NTFS partition you probably won't be able to build: make sure this is a proper Linux filesystem.
Output directory for target system images and NOOBS bundles.
0 will deploy the actual image (
.img) instead of a zipped image (
Setting to '1' enables the QEMU mode - creating an image that can be mounted via QEMU for an emulated environment. These images include "-qemu" in the image file name.
LOCALE_DEFAULT (Default: "en_GB.UTF-8" )
Default system locale.
TARGET_HOSTNAME (Default: "raspberrypi" )
Setting the hostname to the specified value.
KEYBOARD_KEYMAP (Default: "gb" )
Default keyboard keymap.
To get the current value from a running system, run
debconf-show keyboard-configuration and look at the
KEYBOARD_LAYOUT (Default: "English (UK)" )
Default keyboard layout.
To get the current value from a running system, run
debconf-show keyboard-configuration and look at the
TIMEZONE_DEFAULT (Default: "Europe/London" )
Default keyboard layout.
To get the current value from a running system, look in
FIRST_USER_NAME (Default: "pi" )
Username for the first user
FIRST_USER_PASS (Default: "raspberry")
Password for the first user
WPA_COUNTRY (Default: unset)
If these are set, they are use to configure
wpa_supplicant.conf, so that the Raspberry Pi can automatically connect to a wireless network on first boot. If
WPA_ESSID is set and
WPA_PASSWORD is unset an unprotected wireless network will be configured. If set,
WPA_PASSWORD must be between 8 and 63 characters.
1 will enable ssh server for remote log in. Note that if you are using a common password such as the defaults there is a high risk of attackers taking over you Raspberry Pi.
PUBKEY_SSH_FIRST_USER (Default: unset)
Setting this to a value will make that value the contents of the FIRST_USER_NAME's ~/.ssh/authorized_keys. Obviously the value should therefore be a valid authorized_keys file. Note that this does not automatically enable SSH.
1 will disable password authentication for SSH and enable
public key authentication. Note that if SSH is not enabled this will take
effect when SSH becomes enabled.
If set, then instead of working through the numeric stages in order, this list will be followed. For example setting to
"stage0 stage1 mystage stage2" will run the contents of
mystage before stage2. Note that quotes are needed around the list. An absolute or relative path can be given for stages outside the pi-gen directory.
A simple example for building Raspbian:
The config file can also be specified on the command line as an argument the
./build.sh -c myconfig
This is parsed after
config so can be used to override values set there.
The following process is followed to build images:
Loop through all of the stage directories in alphanumeric order
Move on to the next directory if this stage directory contains a file called "SKIP"
Run the script
prerun.sh which is generally just used to copy the build
directory between stages.
In each stage directory loop through each subdirectory and then run each of the install scripts it contains, again in alphanumeric order. These need to be named with a two digit padded number at the beginning. There are a number of different files and directories which can be used to control different parts of the build process:
00-run.sh - A unix shell script. Needs to be made executable for it to run.
00-run-chroot.sh - A unix shell script which will be run in the chroot of the image build directory. Needs to be made executable for it to run.
00-debconf - Contents of this file are passed to debconf-set-selections to configure things like locale, etc.
00-packages - A list of packages to install. Can have more than one, space separated, per line.
00-packages-nr - As 00-packages, except these will be installed using
--no-install-recommends -y parameters to apt-get.
00-patches - A directory containing patch files to be applied, using quilt. If a file named 'EDIT' is present in the directory, the build process will be interrupted with a bash session, allowing an opportunity to create/revise the patches.
If the stage directory contains files called "EXPORT_NOOBS" or "EXPORT_IMAGE" then add this stage to a list of images to generate
Generate the images for any stages that have specified them
It is recommended to examine build.sh for finer details.
Docker can be used to perform the build inside a container. This partially isolates the build from the host system, and allows using the script on non-debian based systems (e.g. Fedora Linux). The isolate is not complete due to the need to use some kernel level services for arm emulation (binfmt) and loop devices (losetup).
vi config # Edit your config file. See above. ./build-docker.sh
If everything goes well, your finished image will be in the
You can then remove the build container with
docker rm -v pigen_work
If something breaks along the line, you can edit the corresponding scripts, and continue:
To examine the container after a failure you can enter a shell within it using:
sudo docker run -it --privileged --volumes-from=pigen_work pi-gen /bin/bash
After successful build, the build container is by default removed. This may be undesired when making incremental changes to a customized build. To prevent the build script from remove the container add
There is a possibility that even when running from a docker container, the
qemu-user-static will silently fail when building the image
binfmt-support must be enabled on the underlying kernel. An easy
fix is to ensure
binfmt-support is installed on the host machine before
./build-docker.sh script (or using your own docker build
The build of Raspbian is divided up into several stages for logical clarity and modularity. This causes some initial complexity, but it simplifies maintenance and allows for more easy customization.
Stage 0 - bootstrap. The primary purpose of this stage is to create a
usable filesystem. This is accomplished largely through the use of
debootstrap, which creates a minimal filesystem suitable for use as a
base.tgz on Debian systems. This stage also configures apt settings and
raspberrypi-bootloader which is missed by debootstrap. The
minimal core is installed but not configured, and the system will not quite
Stage 1 - truly minimal system. This stage makes the system bootable by
installing system files like
/etc/fstab, configures the bootloader, makes
the network operable, and installs packages like raspi-config. At this
stage the system should boot to a local console from which you have the
means to perform basic tasks needed to configure and install the system.
This is as minimal as a system can possibly get, and its arguably not
really usable yet in a traditional sense yet. Still, if you want minimal,
this is minimal and the rest you could reasonably do yourself as sysadmin.
Stage 2 - lite system. This stage produces the Raspbian-Lite image. It installs some optimized memory functions, sets timezone and charmap defaults, installs fake-hwclock and ntp, wireless LAN and bluetooth support, dphys-swapfile, and other basics for managing the hardware. It also creates necessary groups and gives the pi user access to sudo and the standard console hardware permission groups.
There are a few tools that may not make a whole lot of sense here for
development purposes on a minimal system such as basic Python and Lua
packages as well as the
build-essential package. They are lumped right
in with more essential packages presently, though they need not be with
pi-gen. These are understandable for Raspbian's target audience, but if
you were looking for something between truly minimal and Raspbian-Lite,
here's where you start trimming.
Stage 3 - desktop system. Here's where you get the full desktop system with X11 and LXDE, web browsers, git for development, Raspbian custom UI enhancements, etc. This is a base desktop system, with some development tools installed.
Stage 4 - Normal Raspbian image. System meant to fit on a 4GB card. This is the stage that installs most things that make Raspbian friendly to new users like system documentation.
Stage 5 - The Raspbian Full image. More development tools, an email client, learning tools like Scratch, specialized packages like sonic-pi, office productivity, etc.
If you wish to build up to a specified stage (such as building up to stage 2
for a lite system), place an empty file named
SKIP in each of the
directories you wish not to include.
Then add an empty file named
./stage5 (if building up to stage 2) or
./stage2 (if building a minimal system).
# Example for building a lite system echo "IMG_NAME='Raspbian'" > config touch ./stage3/SKIP ./stage4/SKIP ./stage5/SKIP touch ./stage4/SKIP_IMAGES ./stage5/SKIP_IMAGES sudo ./build.sh # or ./build-docker.sh
If you wish to build further configurations upon (for example) the lite
system, you can also delete the contents of
replace with your own contents in the same format.
If you're working on a specific stage the recommended development process is as follows:
sudo CLEAN=1 ./build.sh
64 Bit Systems
Please note there is currently an issue when compiling with a 64 Bit OS. See https://github.com/RPi-Distro/pi-gen/issues/271
Linux is able execute binaries from other architectures, meaning that it should be
possible to make use of
pi-gen on an x86_64 system, even though it will be running
ARM binaries. This requires support from the
You may see the following error:
update-binfmts: warning: Couldn't load the binfmt_misc module.
To resolve this, ensure that the following files are available (install them if necessary):
/lib/modules/$(uname -r)/kernel/fs/binfmt_misc.ko /usr/bin/qemu-arm-static
You may also need to load the module by hand - run