Burrow Raspberry Pi Image
Go to file
2017-04-29 16:53:48 +02:00
export-image Clean up clean up 2017-04-03 16:01:13 +01:00
export-noobs export-noobs: replace all spaces with underscores in OS icon file 2017-04-03 16:39:20 +01:00
scripts Clean up clean up 2017-04-03 16:01:13 +01:00
stage0 Use capsh to ensure file capabilities aren't set 2016-11-14 23:55:45 +00:00
stage1 Update pi-gen and prepare for Tradfri 2017-04-29 16:52:35 +02:00
stage2 Update pi-gen and prepare for Tradfri 2017-04-29 16:52:35 +02:00
stage3 Update pi-gen and prepare for Tradfri 2017-04-29 16:53:48 +02:00
.dockerignore Added Docker support (#40) 2017-01-23 12:44:03 +00:00
.gitignore build.sh: execute postrun.sh, if executable 2017-03-13 17:44:31 +00:00
build-docker.sh Added Docker support (#40) 2017-01-23 12:44:03 +00:00
build.sh Updated {i}-run-chroot script filename to match {i}-run.sh format 2017-03-20 15:53:55 +01:00
CLA.md Gen 2 is go 2017-01-30 20:52:22 +01:00
CODE_OF_CONDUCT.md Gen 2 is go 2017-01-30 20:52:22 +01:00
depends Added Docker support (#40) 2017-01-23 12:44:03 +00:00
Dockerfile Added Docker support (#40) 2017-01-23 12:44:03 +00:00
License.md Create License.md 2016-09-14 01:29:07 +10:00
README.md Update pi-gen and prepare for Tradfri 2017-04-29 16:53:48 +02:00

Fork of pi_gen by @RPI-Distro.

Building your own

The Haspbian image is built with the same script that generates the official Raspbian image's from the Raspberry Pi Foundation.

By default the Haspbian image is built on a Debian 8 droplet on Digital Ocean and takes about 30 minutes to build on the cheapest droplet. Dependencies and everything is handled by the build script with the exception of git.

Build instructions:

  • Install git. sudo apt-get update && sudo apt-get upgrade -y && sudo apt-get install git
  • Clone the rpi_gen code. git clone https://github.com/home-assistant/pi-gen.git
  • Create a file in the current folder named config. More about it's contents below.
  • Run the build script, with sudo or as root. sudo ./build.sh
  • Wait ~30 minutes for build to complete.
  • Retrieve your freshly built Raspberry Pi image from the rpi_gen\deploy folder.

Dependencies

quilt parted realpath qemu-user-static debootstrap zerofree pxz zip dosfstools bsdtar libcap2-bin grep rsync

Config

Upon execution, build.sh will source the file config in the current working directory. This bash shell fragment is intended to set needed environment variables.

The following environment variables are supported:

  • IMG_NAME, the name of the distribution to build (required)
  • APT_PROXY, proxy/cache URL to be included in the build

A simple example for building Hassbian:

IMG_NAME='Hassbian'

Docker Build

nano config         # Edit your config file. See above.
./build-docker.sh

If everything goes well, your finished image will be in the deploy/ folder. You can then remove the build container with docker rm pigen_work

If something breaks along the line, you can edit the corresponding scripts, and continue:

CONTINUE=1 ./build-docker.sh

There is a possibility that even when running from a docker container, the installation of qemu-user-static will silently fail when building the image because binfmt-support must be enabled on the underlying kernel. An easy fix is to ensure binfmt-support is installed on the host machine before starting the ./build-docker.sh script (or using your own docker build solution).

Stage Anatomy

Raspbian Stage Overview

The build of Hassbian 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 installs raspberrypi-bootloader which is missed by debootstrap. The minimal core is installed but not configured, and the system will not quite boot yet.

  • 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, wifi 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. This stage has a minor modification to prevent ssh from being disabled.

    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 - the HASSbian stage. This is where all the Home Assistant specific packages are installed, permissions are set and users created. This is the only stage we add to the original build script.

    The original Stage 4 and Stage 5 are removed since they are not used on the HASSbian image.

Stage specification

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 ./stage directories you wish not to include.

Then remove the EXPORT* files from ./stage4 (if building up to stage 2) or from ./stage2 (if building a minimal system).

## Example for building a lite system without Home Assistant
$ touch ./stage3/SKIP 
$ rm stage3/EXPORT*

If you wish to build further configurations upon (for example) the lite system, you can also delete the contents of ./stage3 and ./stage4 and replace with your own contents in the same format.