remove stage 4 & 5
This commit is contained in:
Yossi
parent
7f33e570ef
commit
c6d11b1e5c
280
README.md
280
README.md
|
|
@ -1,164 +1,4 @@
|
||||||
<<<<<<< HEAD
|
|
||||||
# Dependencies
|
# Dependencies
|
||||||
=======
|
|
||||||
# pi-gen
|
|
||||||
|
|
||||||
_Tool used to create the raspberrypi.org Raspbian images_
|
|
||||||
|
|
||||||
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
pi-gen runs on Debian based operating systems. Currently it is only supported on
|
|
||||||
either Debian Stretch or Ubuntu Xenial and is known to have issues building on
|
|
||||||
earlier releases of these systems.
|
|
||||||
|
|
||||||
To install the required dependencies for pi-gen you should run:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
apt-get install quilt parted realpath qemu-user-static debootstrap zerofree pxz zip \
|
|
||||||
dosfstools bsdtar libcap2-bin grep rsync xz-utils
|
|
||||||
```
|
|
||||||
|
|
||||||
The file `depends` contains a list of tools needed. The format of this
|
|
||||||
package is `<tool>[:<debian-package>]`.
|
|
||||||
|
|
||||||
|
|
||||||
## 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` **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 `IMG_NAME`.
|
|
||||||
|
|
||||||
* `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 `apt-cacher` or
|
|
||||||
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 `build.sh`)
|
|
||||||
|
|
||||||
**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.
|
|
||||||
|
|
||||||
* `WORK_DIR` (Default: `"$BASE_DIR/work"`)
|
|
||||||
|
|
||||||
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
|
|
||||||
Raspbian.
|
|
||||||
|
|
||||||
**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.
|
|
||||||
|
|
||||||
* `DEPLOY_DIR` (Default: `"$BASE_DIR/deploy"`)
|
|
||||||
|
|
||||||
Output directory for target system images and NOOBS bundles.
|
|
||||||
|
|
||||||
* `USE_QEMU` (Default: `"0"`)
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
|
|
||||||
A simple example for building Raspbian:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
IMG_NAME='Raspbian'
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## How the build process works
|
|
||||||
|
|
||||||
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
|
|
||||||
the ```--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 Build
|
|
||||||
|
|
||||||
```bash
|
|
||||||
vi 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 -v pigen_work`
|
|
||||||
|
|
||||||
If something breaks along the line, you can edit the corresponding scripts, and
|
|
||||||
continue:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
CONTINUE=1 ./build-docker.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
```bash
|
|
||||||
PRESERVE_CONTAINER=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).
|
|
||||||
>>>>>>> 93db3736721d968a6ab67d37243d6f3aa6958d00
|
|
||||||
|
|
||||||
sudo apt-get update && sudo apt-get install git curl quilt parted realpath qemu-user-static debootstrap zerofree pxz zip dosfstools bsdtar libcap2-bin grep rsync xz-utils -y && cd ../ &&
|
sudo apt-get update && sudo apt-get install git curl quilt parted realpath qemu-user-static debootstrap zerofree pxz zip dosfstools bsdtar libcap2-bin grep rsync xz-utils -y && cd ../ &&
|
||||||
sudo git clone https://github.com/dride/drideOS-image-generator && cd drideOS-image-generator && sudo ./build.sh
|
sudo git clone https://github.com/dride/drideOS-image-generator && cd drideOS-image-generator && sudo ./build.sh
|
||||||
|
|
@ -167,48 +7,46 @@ solution).
|
||||||
|
|
||||||
### (drideOS) Raspbian Stage Overview
|
### (drideOS) Raspbian Stage Overview
|
||||||
|
|
||||||
|
|
||||||
The build of Raspbian is divided up into several stages for logical clarity
|
The build of Raspbian is divided up into several stages for logical clarity
|
||||||
and modularity. This causes some initial complexity, but it simplifies
|
and modularity. This causes some initial complexity, but it simplifies
|
||||||
maintenance and allows for more easy customization.
|
maintenance and allows for more easy customization.
|
||||||
|
|
||||||
- Stage 0, bootstrap. The primary purpose of this stage is to create a
|
* Stage 0, bootstrap. The primary purpose of this stage is to create a
|
||||||
usable filesystem. This is accomplished largely through the use of
|
usable filesystem. This is accomplished largely through the use of
|
||||||
`debootstrap`, which creates a minimal filesystem suitable for use as a
|
`debootstrap`, which creates a minimal filesystem suitable for use as a
|
||||||
base.tgz on Debian systems. This stage also configures apt settings and
|
base.tgz on Debian systems. This stage also configures apt settings and
|
||||||
installs `raspberrypi-bootloader` which is missed by debootstrap. The
|
installs `raspberrypi-bootloader` which is missed by debootstrap. The
|
||||||
minimal core is installed but not configured, and the system will not quite
|
minimal core is installed but not configured, and the system will not quite
|
||||||
boot yet.
|
boot yet.
|
||||||
|
|
||||||
- Stage 1, truly minimal system. This stage makes the system bootable by
|
* Stage 1, truly minimal system. This stage makes the system bootable by
|
||||||
installing system files like `/etc/fstab`, configures the bootloader, makes
|
installing system files like `/etc/fstab`, configures the bootloader, makes
|
||||||
the network operable, and installs packages like raspi-config. At this
|
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
|
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.
|
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
|
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,
|
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.
|
this is minimal and the rest you could reasonably do yourself as sysadmin.
|
||||||
|
|
||||||
- State 2, lite system. This stage produces the Raspbian-Lite image. It
|
* State 2, lite system. This stage produces the Raspbian-Lite image. It
|
||||||
installs some optimized memory functions, sets timezone and charmap
|
installs some optimized memory functions, sets timezone and charmap
|
||||||
defaults, installs fake-hwclock and ntp, wifi and bluetooth support,
|
defaults, installs fake-hwclock and ntp, wifi and bluetooth support,
|
||||||
dphys-swapfile, and other basics for managing the hardware. It also
|
dphys-swapfile, and other basics for managing the hardware. It also
|
||||||
creates necessary groups and gives the pi user access to sudo and the
|
creates necessary groups and gives the pi user access to sudo and the
|
||||||
standard console hardware permission groups.
|
standard console hardware permission groups.
|
||||||
|
|
||||||
<<<<<<< HEAD
|
---
|
||||||
----
|
|
||||||
|
|
||||||
###Explaination of changes vs. upstream main repo
|
###Explaination of changes vs. upstream main repo
|
||||||
|
|
||||||
The goal is to keep minimal changes from upstream such that pulling updates is easier. Therefore we added Dride OS changes and software installation as subsequent steps within stage2.
|
The goal is to keep minimal changes from upstream such that pulling updates is easier. Therefore we added Dride OS changes and software installation as subsequent steps within stage2.
|
||||||
|
|
||||||
* stage 0 - unchanged from upstream
|
* stage 0 - unchanged from upstream
|
||||||
* stage 1 - unchanged from upstream
|
* stage 1 - unchanged from upstream
|
||||||
* stage 2 - `00-copies-and-fills`, `01-sys-tweaks`, `02-net-tweaks` and `10-cleanup` are unchanged
|
* stage 2 - `00-copies-and-fills`, `01-sys-tweaks`, `02-net-tweaks` and `10-cleanup` are unchanged
|
||||||
* stage 3, 4, 5 - removed
|
* stage 3, 4, 5 - removed
|
||||||
|
|
||||||
NOTE: resizing the `root` parition apart of the stage 2 upstream step is overruled by a subsequent step (03-boot-files) found below. Hence the root partition is **not** resized.
|
NOTE: resizing the `root` parition apart of the stage 2 upstream step is overruled by a subsequent step (03-boot-files) found below. Hence the root partition is **not** resized.
|
||||||
|
|
||||||
Changes/complimentary for DrideOS
|
Changes/complimentary for DrideOS
|
||||||
Within Stage 2, the following additions have been made:
|
Within Stage 2, the following additions have been made:
|
||||||
|
|
@ -218,10 +56,9 @@ Within Stage 2, the following additions have been made:
|
||||||
* `05-dride-net`
|
* `05-dride-net`
|
||||||
* `06-dride-base`
|
* `06-dride-base`
|
||||||
|
|
||||||
|
|
||||||
`03-boot-files`
|
`03-boot-files`
|
||||||
|
|
||||||
Modifies the boot config files to **enable** Ether over USB. This is very helpful when you wish to plug your Dride via USB port into your computer and access via SSH.
|
Modifies the boot config files to **enable** Ether over USB. This is very helpful when you wish to plug your Dride via USB port into your computer and access via SSH.
|
||||||
This also keeps the Dride WiFi access point working as well.
|
This also keeps the Dride WiFi access point working as well.
|
||||||
|
|
||||||
`04-dride-filesystem`
|
`04-dride-filesystem`
|
||||||
|
|
@ -237,69 +74,8 @@ Enable Dride WiFi access point.
|
||||||
Install all the Dride software and any dependencies needed to run the software.
|
Install all the Dride software and any dependencies needed to run the software.
|
||||||
This takes an optional environment argument that will allow differentiation between two software modes.
|
This takes an optional environment argument that will allow differentiation between two software modes.
|
||||||
|
|
||||||
The base software package - essentials - is installed if you do not provide any specific mention of the enviornment variable. This consists of minimal software to get the Dride working.
|
The base software package - essentials - is installed if you do not provide any specific mention of the enviornment variable. This consists of minimal software to get the Dride working.
|
||||||
|
|
||||||
```export OS_TYPE="dride-plus"```
|
`export OS_TYPE="dride-plus"`
|
||||||
=======
|
|
||||||
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** - Raspbian system meant to fit on a 4GB card. More development
|
|
||||||
tools, an email client, learning tools like Scratch, specialized packages
|
|
||||||
like sonic-pi, system documentation, office productivity, etc. This is the
|
|
||||||
stage that installs all of the things that make Raspbian friendly to new
|
|
||||||
users.
|
|
||||||
|
|
||||||
- **Stage 5** - The official Raspbian Desktop image. Right now only adds
|
|
||||||
Mathematica.
|
|
||||||
|
|
||||||
### 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 add an empty file named `SKIP_IMAGES` to `./stage4` (if building up to stage 2) or
|
|
||||||
to `./stage2` (if building a minimal system).
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# 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 `./stage3` and `./stage4` and
|
|
||||||
replace with your own contents in the same format.
|
|
||||||
|
|
||||||
|
|
||||||
## Skipping stages to speed up development
|
|
||||||
|
|
||||||
If you're working on a specific stage the recommended development process is as
|
|
||||||
follows:
|
|
||||||
|
|
||||||
* Add a file called SKIP_IMAGES into the directories containing EXPORT_* files
|
|
||||||
(currently stage2, stage4 and stage5)
|
|
||||||
* Add SKIP files to the stages you don't want to build. For example, if you're
|
|
||||||
basing your image on the lite image you would add these to stages 3, 4 and 5.
|
|
||||||
* Run build.sh to build all stages
|
|
||||||
* Add SKIP files to the earlier successfully built stages
|
|
||||||
* Modify the last stage
|
|
||||||
* Rebuild just the last stage using ```sudo CLEAN=1 ./build.sh```
|
|
||||||
* Once you're happy with the image you can remove the SKIP_IMAGES files and
|
|
||||||
export your image to test
|
|
||||||
>>>>>>> 93db3736721d968a6ab67d37243d6f3aa6958d00
|
|
||||||
|
|
||||||
Optionally, if you set the environment varable **before** build time - you can add additonal software features best reserved for a Raspberry Pi 3 or similar hardware.
|
Optionally, if you set the environment varable **before** build time - you can add additonal software features best reserved for a Raspberry Pi 3 or similar hardware.
|
||||||
|
|
|
||||||
|
|
@ -1,22 +0,0 @@
|
||||||
python-automationhat python3-automationhat
|
|
||||||
python-blinkt python3-blinkt
|
|
||||||
python-cap1xxx python3-cap1xxx
|
|
||||||
python-drumhat python3-drumhat
|
|
||||||
python-envirophat python3-envirophat
|
|
||||||
python-explorerhat python3-explorerhat
|
|
||||||
python-fourletterphat python3-fourletterphat
|
|
||||||
python-microdotphat python3-microdotphat
|
|
||||||
python-mote python3-mote
|
|
||||||
python-motephat python3-motephat
|
|
||||||
python-phatbeat python3-phatbeat
|
|
||||||
python-pianohat python3-pianohat
|
|
||||||
python-piglow python3-piglow
|
|
||||||
python-rainbowhat python3-rainbowhat
|
|
||||||
python-scrollphat python3-scrollphat
|
|
||||||
python-scrollphathd python3-scrollphathd
|
|
||||||
python-sn3218 python3-sn3218
|
|
||||||
python-skywriter python3-skywriter
|
|
||||||
python-touchphat python3-touchphat
|
|
||||||
python-buttonshim python3-buttonshim
|
|
||||||
python-unicornhathd python3-unicornhathd
|
|
||||||
python-pantilthat python3-pantilthat
|
|
||||||
|
|
@ -1,4 +0,0 @@
|
||||||
#!/bin/bash -e
|
|
||||||
|
|
||||||
ln -sf /etc/systemd/system/autologin@.service \
|
|
||||||
"${ROOTFS_DIR}/etc/systemd/system/getty.target.wants/getty@tty1.service"
|
|
||||||
|
|
@ -1,25 +0,0 @@
|
||||||
#!/bin/bash -e
|
|
||||||
|
|
||||||
HASH="$(wget https://api.github.com/repos/KenT2/python-games/git/refs/heads/master -qO -| grep \"sha\" | cut -f 2 -d ':' | cut -f 2 -d \")"
|
|
||||||
|
|
||||||
if [ -f files/python_games.hash ]; then
|
|
||||||
HASH_LOCAL="$(cat files/python_games.hash)"
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ ! -e files/python_games.tar.gz ] || [ "$HASH" != "$HASH_LOCAL" ]; then
|
|
||||||
wget "https://github.com/KenT2/python-games/tarball/master" -O files/python_games.tar.gz
|
|
||||||
echo "$HASH" > files/python_games.hash
|
|
||||||
fi
|
|
||||||
|
|
||||||
ln -sf pip3 "${ROOTFS_DIR}/usr/bin/pip-3.2"
|
|
||||||
|
|
||||||
install -v -o 1000 -g 1000 -d "${ROOTFS_DIR}/home/pi/python_games"
|
|
||||||
tar xvf files/python_games.tar.gz -C "${ROOTFS_DIR}/home/pi/python_games" --strip-components=1
|
|
||||||
chown 1000:1000 "${ROOTFS_DIR}/home/pi/python_games" -Rv
|
|
||||||
chmod +x "${ROOTFS_DIR}/home/pi/python_games/launcher.sh"
|
|
||||||
|
|
||||||
#Alacarte fixes
|
|
||||||
install -v -o 1000 -g 1000 -d "${ROOTFS_DIR}/home/pi/.local"
|
|
||||||
install -v -o 1000 -g 1000 -d "${ROOTFS_DIR}/home/pi/.local/share"
|
|
||||||
install -v -o 1000 -g 1000 -d "${ROOTFS_DIR}/home/pi/.local/share/applications"
|
|
||||||
install -v -o 1000 -g 1000 -d "${ROOTFS_DIR}/home/pi/.local/share/desktop-directories"
|
|
||||||
|
|
@ -1,5 +0,0 @@
|
||||||
#!/bin/bash -e
|
|
||||||
|
|
||||||
if [ ! -d "${ROOTFS_DIR}" ]; then
|
|
||||||
copy_previous
|
|
||||||
fi
|
|
||||||
|
|
@ -1,5 +0,0 @@
|
||||||
#!/bin/bash -e
|
|
||||||
|
|
||||||
if [ ! -d "${ROOTFS_DIR}" ]; then
|
|
||||||
copy_previous
|
|
||||||
fi
|
|
||||||
Loading…
Reference in New Issue
Block a user