rudefox/burrow-pi-img
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
e3c072fdb8
burrow-pi-img/README.md

98 lines
4.6 KiB
Markdown
Raw Normal View History

Gen 2 is go
2017-01-30 19:52:22 +00:00
Fork of `pi_gen` by [@RPI-Distro](https://github.com/RPi-Distro/pi-gen).
Update README.md
2016-04-11 06:25:30 +00:00
Gen 2 is go
2017-01-30 19:52:22 +00:00
## Building your own
The Haspbian image is built with the same script that generates the official [Raspbian](https://www.raspberrypi.org/downloads/raspbian/) image's from the [Raspberry Pi Foundation](https://www.raspberrypi.org/about/).
Update README.md
2016-04-11 06:25:30 +00:00
Gen 2 is go
2017-01-30 19:52:22 +00:00
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`.
Update README.md
2016-04-11 06:25:30 +00:00
Gen 2 is go
2017-01-30 19:52:22 +00:00
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 contense 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 qemu-arm-static:qemu-user-static debootstrap kpartx zerofree pxz zip mkdosfs:dosfstools capsh:libcap2-bin bsdtar`
README.md: Working toward basic documentation (#10) * README.md: document config file Still pretty sparse, but as this bit is necessary to actually use pi-gen, here it is. * README.md: Overview of Raspbian's stages * README.md: Stages -> Raspbian Stages + heading Decided that the Stages heading probably made more sense as being retitled to refer specifically to Raspbian since it has no direct bearing on pi-gen itself which could produce any Debianish system for the pi, and also that there ought to be a Stage Anatomy section first talking about the nuts and bolts of what goes into these stages. Stage Anatomy is just a heading for now. * README.md: Make Config section less conversational Left the stage overview as it was since it's intended more as a plain language explanation than a technically complete look. I believe that kind of information is useful to have, but perhaps as README.md becomes longer it may be advisable to move it to another location.
2016-09-05 04:02:39 +00:00
Tidy up README hierarchy further
2017-01-20 17:29:01 +00:00
## Config
README.md: Working toward basic documentation (#10) * README.md: document config file Still pretty sparse, but as this bit is necessary to actually use pi-gen, here it is. * README.md: Overview of Raspbian's stages * README.md: Stages -> Raspbian Stages + heading Decided that the Stages heading probably made more sense as being retitled to refer specifically to Raspbian since it has no direct bearing on pi-gen itself which could produce any Debianish system for the pi, and also that there ought to be a Stage Anatomy section first talking about the nuts and bolts of what goes into these stages. Stage Anatomy is just a heading for now. * README.md: Make Config section less conversational Left the stage overview as it was since it's intended more as a plain language explanation than a technically complete look. I believe that kind of information is useful to have, but perhaps as README.md becomes longer it may be advisable to move it to another location.
2016-09-05 04:02:39 +00:00
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:
Gen 2 is go
2017-01-30 19:52:22 +00:00
* `IMG_NAME`, the name of the distribution to build (required)
* `APT_PROXY`, proxy/cache URL to be included in the build
README.md: Improve config variable documentation (#24)
2016-10-05 21:56:45 +00:00
Gen 2 is go
2017-01-30 19:52:22 +00:00
A simple example for building Hassbian:
README.md: Working toward basic documentation (#10) * README.md: document config file Still pretty sparse, but as this bit is necessary to actually use pi-gen, here it is. * README.md: Overview of Raspbian's stages * README.md: Stages -> Raspbian Stages + heading Decided that the Stages heading probably made more sense as being retitled to refer specifically to Raspbian since it has no direct bearing on pi-gen itself which could produce any Debianish system for the pi, and also that there ought to be a Stage Anatomy section first talking about the nuts and bolts of what goes into these stages. Stage Anatomy is just a heading for now. * README.md: Make Config section less conversational Left the stage overview as it was since it's intended more as a plain language explanation than a technically complete look. I believe that kind of information is useful to have, but perhaps as README.md becomes longer it may be advisable to move it to another location.
2016-09-05 04:02:39 +00:00
```bash
Gen 2 is go
2017-01-30 19:52:22 +00:00
IMG_NAME='Hassbian'
README.md: Working toward basic documentation (#10) * README.md: document config file Still pretty sparse, but as this bit is necessary to actually use pi-gen, here it is. * README.md: Overview of Raspbian's stages * README.md: Stages -> Raspbian Stages + heading Decided that the Stages heading probably made more sense as being retitled to refer specifically to Raspbian since it has no direct bearing on pi-gen itself which could produce any Debianish system for the pi, and also that there ought to be a Stage Anatomy section first talking about the nuts and bolts of what goes into these stages. Stage Anatomy is just a heading for now. * README.md: Make Config section less conversational Left the stage overview as it was since it's intended more as a plain language explanation than a technically complete look. I believe that kind of information is useful to have, but perhaps as README.md becomes longer it may be advisable to move it to another location.
2016-09-05 04:02:39 +00:00
```
Tidy up README hierarchy further
2017-01-20 17:29:01 +00:00
### Raspbian Stage Overview
README.md: Working toward basic documentation (#10) * README.md: document config file Still pretty sparse, but as this bit is necessary to actually use pi-gen, here it is. * README.md: Overview of Raspbian's stages * README.md: Stages -> Raspbian Stages + heading Decided that the Stages heading probably made more sense as being retitled to refer specifically to Raspbian since it has no direct bearing on pi-gen itself which could produce any Debianish system for the pi, and also that there ought to be a Stage Anatomy section first talking about the nuts and bolts of what goes into these stages. Stage Anatomy is just a heading for now. * README.md: Make Config section less conversational Left the stage overview as it was since it's intended more as a plain language explanation than a technically complete look. I believe that kind of information is useful to have, but perhaps as README.md becomes longer it may be advisable to move it to another location.
2016-09-05 04:02:39 +00:00
Gen 2 is go
2017-01-30 19:52:22 +00:00
The build of Hassbian is divided up into several stages for logical clarity
README.md: Working toward basic documentation (#10) * README.md: document config file Still pretty sparse, but as this bit is necessary to actually use pi-gen, here it is. * README.md: Overview of Raspbian's stages * README.md: Stages -> Raspbian Stages + heading Decided that the Stages heading probably made more sense as being retitled to refer specifically to Raspbian since it has no direct bearing on pi-gen itself which could produce any Debianish system for the pi, and also that there ought to be a Stage Anatomy section first talking about the nuts and bolts of what goes into these stages. Stage Anatomy is just a heading for now. * README.md: Make Config section less conversational Left the stage overview as it was since it's intended more as a plain language explanation than a technically complete look. I believe that kind of information is useful to have, but perhaps as README.md becomes longer it may be advisable to move it to another location.
2016-09-05 04:02:39 +00:00
and modularity. This causes some initial complexity, but it simplifies
maintenance and allows for more easy customization.
Add stage specification instructions
2017-01-20 17:36:29 +00:00
- **Stage 0** - bootstrap. The primary purpose of this stage is to create a
README.md: Working toward basic documentation (#10) * README.md: document config file Still pretty sparse, but as this bit is necessary to actually use pi-gen, here it is. * README.md: Overview of Raspbian's stages * README.md: Stages -> Raspbian Stages + heading Decided that the Stages heading probably made more sense as being retitled to refer specifically to Raspbian since it has no direct bearing on pi-gen itself which could produce any Debianish system for the pi, and also that there ought to be a Stage Anatomy section first talking about the nuts and bolts of what goes into these stages. Stage Anatomy is just a heading for now. * README.md: Make Config section less conversational Left the stage overview as it was since it's intended more as a plain language explanation than a technically complete look. I believe that kind of information is useful to have, but perhaps as README.md becomes longer it may be advisable to move it to another location.
2016-09-05 04:02:39 +00:00
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.
Add stage specification instructions
2017-01-20 17:36:29 +00:00
- **Stage 1** - truly minimal system. This stage makes the system bootable by
README.md: Working toward basic documentation (#10) * README.md: document config file Still pretty sparse, but as this bit is necessary to actually use pi-gen, here it is. * README.md: Overview of Raspbian's stages * README.md: Stages -> Raspbian Stages + heading Decided that the Stages heading probably made more sense as being retitled to refer specifically to Raspbian since it has no direct bearing on pi-gen itself which could produce any Debianish system for the pi, and also that there ought to be a Stage Anatomy section first talking about the nuts and bolts of what goes into these stages. Stage Anatomy is just a heading for now. * README.md: Make Config section less conversational Left the stage overview as it was since it's intended more as a plain language explanation than a technically complete look. I believe that kind of information is useful to have, but perhaps as README.md becomes longer it may be advisable to move it to another location.
2016-09-05 04:02:39 +00:00
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.
Add stage specification instructions
2017-01-20 17:36:29 +00:00
- **Stage 2** - lite system. This stage produces the Raspbian-Lite image. It
README.md: Working toward basic documentation (#10) * README.md: document config file Still pretty sparse, but as this bit is necessary to actually use pi-gen, here it is. * README.md: Overview of Raspbian's stages * README.md: Stages -> Raspbian Stages + heading Decided that the Stages heading probably made more sense as being retitled to refer specifically to Raspbian since it has no direct bearing on pi-gen itself which could produce any Debianish system for the pi, and also that there ought to be a Stage Anatomy section first talking about the nuts and bolts of what goes into these stages. Stage Anatomy is just a heading for now. * README.md: Make Config section less conversational Left the stage overview as it was since it's intended more as a plain language explanation than a technically complete look. I believe that kind of information is useful to have, but perhaps as README.md becomes longer it may be advisable to move it to another location.
2016-09-05 04:02:39 +00:00
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
Gen 2 is go
2017-01-30 19:52:22 +00:00
standard console hardware permission groups. This stage has a minor
modification to prevent ssh from being disabled.
README.md: Working toward basic documentation (#10) * README.md: document config file Still pretty sparse, but as this bit is necessary to actually use pi-gen, here it is. * README.md: Overview of Raspbian's stages * README.md: Stages -> Raspbian Stages + heading Decided that the Stages heading probably made more sense as being retitled to refer specifically to Raspbian since it has no direct bearing on pi-gen itself which could produce any Debianish system for the pi, and also that there ought to be a Stage Anatomy section first talking about the nuts and bolts of what goes into these stages. Stage Anatomy is just a heading for now. * README.md: Make Config section less conversational Left the stage overview as it was since it's intended more as a plain language explanation than a technically complete look. I believe that kind of information is useful to have, but perhaps as README.md becomes longer it may be advisable to move it to another location.
2016-09-05 04:02:39 +00:00
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.
Gen 2 is go
2017-01-30 19:52:22 +00:00
- **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 3** and **Stage 4** are removed since they are not
used on the HASSbian image.
README.md: Working toward basic documentation (#10) * README.md: document config file Still pretty sparse, but as this bit is necessary to actually use pi-gen, here it is. * README.md: Overview of Raspbian's stages * README.md: Stages -> Raspbian Stages + heading Decided that the Stages heading probably made more sense as being retitled to refer specifically to Raspbian since it has no direct bearing on pi-gen itself which could produce any Debianish system for the pi, and also that there ought to be a Stage Anatomy section first talking about the nuts and bolts of what goes into these stages. Stage Anatomy is just a heading for now. * README.md: Make Config section less conversational Left the stage overview as it was since it's intended more as a plain language explanation than a technically complete look. I believe that kind of information is useful to have, but perhaps as README.md becomes longer it may be advisable to move it to another location.
2016-09-05 04:02:39 +00:00
Add stage specification instructions
2017-01-20 17:36:29 +00:00
### 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).
```
Gen 2 is go
2017-01-30 19:52:22 +00:00
# Example for building a lite system without Home Assistant
$ touch ./stage3/SKIP
$ rm stage3/EXPORT*
```
Reference in New Issue Copy Permalink