_Tool used to create the raspberrypi.org Raspbian images_
#Burrow Pi Image
This is a fork of the [pi-gen](https://github.com/RPi-Distro/pi-gen) project, the "tool used to create the raspberrypi.org Raspbian images". `pi-gen` serves as a decent base becuase it:
* Builds compact images that self-inflate on the device during the first boot
* Provides a comfortable development workflow
I modified `pi-gen` with the following features:
* Rudefox Burrow installed
* Auto-login
* Read-only filesystem (as a security measure to prevent you from accidentally storing sensitive information on this low-security hardware)
* Most user-space networking packages removed (kernel still included networking capabilities)
## Dependencies
@ -29,13 +39,17 @@ environment variables.
The following environment variables are supported:
* `IMG_NAME`**required** (Default: unset)
* `IMG_NAME`(Default: `RudefoxBurrow`)
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 `IMG_NAME`.
* `RUDEFOX_BURROW_VERSION` (Default: `0.0.2`)
The version of Rudefox Burrow to download and install.
* `RELEASE` (Default: buster)
The release version to build images against. Valid values are jessie, stretch
@ -83,11 +97,11 @@ The following environment variables are supported:
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" )
* `LOCALE_DEFAULT` (Default: "en_US.UTF-8" )
Default system locale.
* `TARGET_HOSTNAME` (Default: "raspberrypi" )
* `TARGET_HOSTNAME` (Default: "burrow" )
Setting the hostname to the specified value.
@ -99,7 +113,7 @@ The following environment variables are supported:
keyboard-configuration` and look at the
`keyboard-configuration/model` value.
* `KEYBOARD_KEYMAP` (Default: "gb" )
* `KEYBOARD_KEYMAP` (Default: "us" )
Default keyboard keymap.
@ -122,11 +136,11 @@ The following environment variables are supported:
To get the current value from a running system, look in
`/etc/timezone`.
* `FIRST_USER_NAME` (Default: "pi" )
* `FIRST_USER_NAME` (Default: "rudefox" )
Username for the first user
* `FIRST_USER_PASS` (Default: "raspberry")
* `FIRST_USER_PASS` (Default: "burrow")
Password for the first user
@ -138,14 +152,17 @@ The following environment variables are supported:
Setting to `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.
* `STAGE_LIST` (Default: `stage*`)
* `STAGE_LIST` (Default: `stage[0-2]`)
The default setting builds only the "lite" image for Rudefox Burrow, which is all you need.
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.
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:
A simple example for building RaspbianBurrow:
```bash
IMG_NAME='Raspbian'
APT_PROXY=http://172.17.10.10:3142
TIMEZONE_DEFAULT="America/Toronto"
```
The config file can also be specified on the command line as an argument the `build.sh` or `build-docker.sh` scripts.
