Raspi2-3_GenImage Commit - r424:294013ff4644 · Collaboration Tremplin des Sciences

1

# rpi23-gen-image

1

# rpi23-gen-image

2

## Introduction

2

## Introduction

3

`rpi23-gen-image.sh` is an advanced Debian Linux bootstrapping shell script for generating Debian OS images for ~~Raspberry Pi 2 (RPi2) and~~ Raspberry Pi ~~3 (RPi3)~~ computers. The script at this time supports the bootstrapping of the Debian (armhf) releases `stretch` and `buster`. Raspberry Pi 3 images are generated for 32-bit mode only. Raspberry Pi 3 64-bit images can be generated using custom configuration parameters (```templates/rpi3-stretch-arm64-4.14.y```).

3

`rpi23-gen-image.sh` is an advanced Debian Linux bootstrapping shell script for generating Debian OS images for all Raspberry Pi computers. The script at this time supports the bootstrapping of the Debian (armhf/armel) releases `stretch` and `buster`. Raspberry Pi 3 images are generated for 32-bit mode only. Raspberry Pi 3 64-bit images can be generated using custom configuration parameters (```templates/rpi3-stretch-arm64-4.14.y```).

4

5

## Build dependencies

5

## Build dependencies

6

The following list of Debian packages must be installed on the build system because they are essentially required for the bootstrapping process. The script will check if all required packages are installed and missing packages will be installed automatically if confirmed by the user.

6

The following list of Debian packages must be installed on the build system because they are essentially required for the bootstrapping process. The script will check if all required packages are installed and missing packages will be installed automatically if confirmed by the user.

7

8

```debootstrap debian-archive-keyring qemu-user-static binfmt-support dosfstools rsync bmap-tools whois git bc psmisc dbus sudo```

8

```debootstrap debian-archive-keyring qemu-user-static binfmt-support dosfstools rsync bmap-tools whois git bc psmisc dbus sudo```

9

10

It is recommended to configure the `rpi23-gen-image.sh` script to build and install the latest Raspberry Pi Linux kernel. For the RPi3 this is mandatory. Kernel compilation and linking will be performed on the build system using an ARM (armhf) cross-compiler toolchain.

10

It is recommended to configure the `rpi23-gen-image.sh` script to build and install the latest Raspberry Pi Linux kernel. For the RPi3 this is mandatory. Kernel compilation and linking will be performed on the build system using an ARM (armhf/armel) cross-compiler toolchain.

11

12

The script has been tested using the default `crossbuild-essential-armhf` toolchain meta package on Debian Linux `stretch` build systems. Please check the [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains) for further information.

12

The script has been tested using the default `crossbuild-essential-armhf` and `crossbuild-essential-armel` toolchain meta packages on Debian Linux `stretch` build systems. Please check the [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains) for further information.

13

14

## Command-line parameters

14

## Command-line parameters

15

The script accepts certain command-line parameters to enable or disable specific OS features, services and configuration settings. These parameters are passed to the `rpi23-gen-image.sh` script via (simple) shell-variables. Unlike environment shell-variables (simple) shell-variables are defined at the beginning of the command-line call of the `rpi23-gen-image.sh` script.

15

The script accepts certain command-line parameters to enable or disable specific OS features, services and configuration settings. These parameters are passed to the `rpi23-gen-image.sh` script via (simple) shell-variables. Unlike environment shell-variables (simple) shell-variables are defined at the beginning of the command-line call of the `rpi23-gen-image.sh` script.

16

17

##### Command-line examples:

17

##### Command-line examples:

18

```shell

18

```shell

19

ENABLE_UBOOT=true ./rpi23-gen-image.sh

19

ENABLE_UBOOT=true ./rpi23-gen-image.sh

20

ENABLE_CONSOLE=false ENABLE_IPV6=false ./rpi23-gen-image.sh

20

ENABLE_CONSOLE=false ENABLE_IPV6=false ./rpi23-gen-image.sh

21

ENABLE_WM=xfce4 ENABLE_FBTURBO=true ENABLE_MINBASE=true ./rpi23-gen-image.sh

21

ENABLE_WM=xfce4 ENABLE_FBTURBO=true ENABLE_MINBASE=true ./rpi23-gen-image.sh

22

ENABLE_HARDNET=true ENABLE_IPTABLES=true /rpi23-gen-image.sh

22

ENABLE_HARDNET=true ENABLE_IPTABLES=true /rpi23-gen-image.sh

23

APT_SERVER=ftp.de.debian.org APT_PROXY="http://127.0.0.1:3142/" ./rpi23-gen-image.sh

23

APT_SERVER=ftp.de.debian.org APT_PROXY="http://127.0.0.1:3142/" ./rpi23-gen-image.sh

24

ENABLE_MINBASE=true ./rpi23-gen-image.sh

24

ENABLE_MINBASE=true ./rpi23-gen-image.sh

25

BUILD_KERNEL=true ENABLE_MINBASE=true ENABLE_IPV6=false ./rpi23-gen-image.sh

25

BUILD_KERNEL=true ENABLE_MINBASE=true ENABLE_IPV6=false ./rpi23-gen-image.sh

26

BUILD_KERNEL=true KERNELSRC_DIR=/tmp/linux ./rpi23-gen-image.sh

26

BUILD_KERNEL=true KERNELSRC_DIR=/tmp/linux ./rpi23-gen-image.sh

27

ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh

27

ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh

28

ENABLE_CRYPTFS=true CRYPTFS_PASSWORD=changeme EXPANDROOT=false ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh

28

ENABLE_CRYPTFS=true CRYPTFS_PASSWORD=changeme EXPANDROOT=false ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh

29

RELEASE=stretch BUILD_KERNEL=true ./rpi23-gen-image.sh

29

RELEASE=stretch BUILD_KERNEL=true ./rpi23-gen-image.sh

30

RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh

30

RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh

31

RELEASE=stretch RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh

31

RELEASE=stretch RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh

32

```

32

```

33

34

## Configuration template files

34

## Configuration template files

35

To avoid long lists of command-line parameters and to help to store the favourite parameter configurations the `rpi23-gen-image.sh` script supports so called configuration template files (`CONFIG_TEMPLATE`=template). These are simple text files located in the `./templates` directory that contain the list of configuration parameters that will be used. New configuration template files can be added to the `./templates` directory.

35

To avoid long lists of command-line parameters and to help to store the favourite parameter configurations the `rpi23-gen-image.sh` script supports so called configuration template files (`CONFIG_TEMPLATE`=template). These are simple text files located in the `./templates` directory that contain the list of configuration parameters that will be used. New configuration template files can be added to the `./templates` directory.

36

37

##### Command-line examples:

37

##### Command-line examples:

38

```shell

38

```shell

39

CONFIG_TEMPLATE=rpi3stretch ./rpi23-gen-image.sh

39

CONFIG_TEMPLATE=rpi3stretch ./rpi23-gen-image.sh

40

CONFIG_TEMPLATE=rpi2stretch ./rpi23-gen-image.sh

40

CONFIG_TEMPLATE=rpi2stretch ./rpi23-gen-image.sh

41

```

41

```

42

43

## Supported parameters and settings

43

## Supported parameters and settings

44

#### APT settings:

44

#### APT settings:

45

##### `APT_SERVER`="ftp.debian.org"

45

##### `APT_SERVER`="ftp.debian.org"

46

Set Debian packages server address. Choose a server from the list of Debian worldwide [mirror sites](https://www.debian.org/mirror/list). Using a nearby server will probably speed-up all required downloads within the bootstrapping process.

46

Set Debian packages server address. Choose a server from the list of Debian worldwide [mirror sites](https://www.debian.org/mirror/list). Using a nearby server will probably speed-up all required downloads within the bootstrapping process.

47

48

##### `APT_PROXY`=""

48

##### `APT_PROXY`=""

49

Set Proxy server address. Using a local Proxy-Cache like `apt-cacher-ng` will speed-up the bootstrapping process because all required Debian packages will only be downloaded from the Debian mirror site once. If `apt-cacher-ng` is running on default `http://127.0.0.1:3142` it is autodetected and you don't need to set this.

49

Set Proxy server address. Using a local Proxy-Cache like `apt-cacher-ng` will speed-up the bootstrapping process because all required Debian packages will only be downloaded from the Debian mirror site once. If `apt-cacher-ng` is running on default `http://127.0.0.1:3142` it is autodetected and you don't need to set this.

50

51

##### `APT_INCLUDES`=""

51

##### `APT_INCLUDES`=""

52

A comma separated list of additional packages to be installed by debootstrap during bootstrapping.

52

A comma separated list of additional packages to be installed by debootstrap during bootstrapping.

53

54

##### `APT_INCLUDES_LATE`=""

54

##### `APT_INCLUDES_LATE`=""

55

A comma separated list of additional packages to be installed by apt after bootstrapping and after APT sources are set up. This is useful for packages with pre-depends, which debootstrap do not handle well.

55

A comma separated list of additional packages to be installed by apt after bootstrapping and after APT sources are set up. This is useful for packages with pre-depends, which debootstrap do not handle well.

56

57

---

57

---

58

59

#### General system settings:

59

#### General system settings:

60

##### `SET_ARCH`=32

60

##### `SET_ARCH`=32

61

Set Architecture to default 32bit. If you want to to compile 64bit (RPI3 or RPI3+) set it to `64`. This option will set every needed crosscompiler or boeard specific option for a successful build.

61

Set Architecture to default 32bit. If you want to to compile 64bit (RPI3 or RPI3+) set it to `64`. This option will set every needed crosscompiler or boeard specific option for a successful build.

62

If you want to change e.g. cross-compiler -> Templates always override defaults

63

62

64

##### `RPI_MODEL`=2

63

##### `RPI_MODEL`=2

65

Specifiy the target Raspberry Pi hardware model. The script at this time supports the following Raspberry Pi models:

64

Specifiy the target Raspberry Pi hardware model. The script at this time supports the following Raspberry Pi models:

66

`0` = Used for Raspberry Pi 0 and Raspberry Pi 0 W

65

`0` = Used for Raspberry Pi 0 and Raspberry Pi 0 W

67

`1` = Used for Pi 1 model A and B

66

`1` = Used for Pi 1 model A and B

68

`1P` = Used for Pi 1 model B+ and A+

67

`1P` = Used for Pi 1 model B+ and A+

69

`2` = Used for Pi 2 model B

68

`2` = Used for Pi 2 model B

70

`3` = Used for Pi 3 model B

69

`3` = Used for Pi 3 model B

71

`3P` = Used for Pi 3 model B+

70

`3P` = Used for Pi 3 model B+

72

`BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` or `3P` is used.

71

`BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` or `3P` is used.

73

72

74

##### `RELEASE`="buster"

73

##### `RELEASE`="buster"

75

Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases `stretch` and `buster`.

74

Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases `stretch` and `buster`.

76

75

77

##### `RELEASE_ARCH`="armhf"

76

##### `RELEASE_ARCH`="armhf"

78

Set the desired Debian release architecture.

77

Set the desired Debian release architecture.

79

78

80

##### `HOSTNAME`="rpi$RPI_MODEL-$RELEASE"

79

##### `HOSTNAME`="rpi$RPI_MODEL-$RELEASE"

81

Set system host name. It's recommended that the host name is unique in the corresponding subnet.

80

Set system host name. It's recommended that the host name is unique in the corresponding subnet.

82

81

83

##### `PASSWORD`="raspberry"

82

##### `PASSWORD`="raspberry"

84

Set system `root` password. It's **STRONGLY** recommended that you choose a custom password.

83

Set system `root` password. It's **STRONGLY** recommended that you choose a custom password.

85

84

86

##### `USER_PASSWORD`="raspberry"

85

##### `USER_PASSWORD`="raspberry"

87

Set password for the created non-root user `USER_NAME`=pi. Ignored if `ENABLE_USER`=false. It's **STRONGLY** recommended that you choose a custom password.

86

Set password for the created non-root user `USER_NAME`=pi. Ignored if `ENABLE_USER`=false. It's **STRONGLY** recommended that you choose a custom password.

88

87

89

##### `DEFLOCAL`="en_US.UTF-8"

88

##### `DEFLOCAL`="en_US.UTF-8"

90

Set default system locale. This setting can also be changed inside the running OS using the `dpkg-reconfigure locales` command. Please note that on using this parameter the script will automatically install the required packages `locales`, `keyboard-configuration` and `console-setup`.

89

Set default system locale. This setting can also be changed inside the running OS using the `dpkg-reconfigure locales` command. Please note that on using this parameter the script will automatically install the required packages `locales`, `keyboard-configuration` and `console-setup`.

91

90

92

##### `TIMEZONE`="Europe/Berlin"

91

##### `TIMEZONE`="Europe/Berlin"

93

Set default system timezone. All available timezones can be found in the `/usr/share/zoneinfo/` directory. This setting can also be changed inside the running OS using the `dpkg-reconfigure tzdata` command.

92

Set default system timezone. All available timezones can be found in the `/usr/share/zoneinfo/` directory. This setting can also be changed inside the running OS using the `dpkg-reconfigure tzdata` command.

94

93

95

##### `EXPANDROOT`=true

94

##### `EXPANDROOT`=true

96

Expand the root partition and filesystem automatically on first boot.

95

Expand the root partition and filesystem automatically on first boot.

97

96

98

##### `ENABLE_QEMU`=false

97

##### `ENABLE_QEMU`=false

99

Generate kernel (`vexpress_defconfig`), file system image (`qcow2`) and DTB files that can be used for QEMU full system emulation (`vexpress-A15`). The output files are stored in the `$(pwd)/images/qemu` directory. You can find more information about running the generated image in the QEMU section of this readme file.

98

Generate kernel (`vexpress_defconfig`), file system image (`qcow2`) and DTB files that can be used for QEMU full system emulation (`vexpress-A15`). The output files are stored in the `$(pwd)/images/qemu` directory. You can find more information about running the generated image in the QEMU section of this readme file.

100

99

101

---

100

---

102

101

103

#### Keyboard settings:

102

#### Keyboard settings:

104

These options are used to configure keyboard layout in `/etc/default/keyboard` for console and Xorg. These settings can also be changed inside the running OS using the `dpkg-reconfigure keyboard-configuration` command.

103

These options are used to configure keyboard layout in `/etc/default/keyboard` for console and Xorg. These settings can also be changed inside the running OS using the `dpkg-reconfigure keyboard-configuration` command.

105

104

106

##### `XKB_MODEL`=""

105

##### `XKB_MODEL`=""

107

Set the name of the model of your keyboard type.

106

Set the name of the model of your keyboard type.

108

107

109

##### `XKB_LAYOUT`=""

108

##### `XKB_LAYOUT`=""

110

Set the supported keyboard layout(s).

109

Set the supported keyboard layout(s).

111

110

112

##### `XKB_VARIANT`=""

111

##### `XKB_VARIANT`=""

113

Set the supported variant(s) of the keyboard layout(s).

112

Set the supported variant(s) of the keyboard layout(s).

114

113

115

##### `XKB_OPTIONS`=""

114

##### `XKB_OPTIONS`=""

116

Set extra xkb configuration options.

115

Set extra xkb configuration options.

117

116

118

---

117

---

119

118

120

#### Networking settings (DHCP):

119

#### Networking settings (DHCP):

121

This parameter is used to set up networking auto configuration in `/etc/systemd/network/eth.network`. The default location of network configuration files in the Debian `stretch` release was changed to `/lib/systemd/network`.`

120

This parameter is used to set up networking auto configuration in `/etc/systemd/network/eth.network`. The default location of network configuration files in the Debian `stretch` release was changed to `/lib/systemd/network`.`

122

121

123

##### `ENABLE_DHCP`=true

122

##### `ENABLE_DHCP`=true

124

Set the system to use DHCP. This requires an DHCP server.

123

Set the system to use DHCP. This requires an DHCP server.

125

124

126

---

125

---

127

126

128

#### Networking settings (static):

127

#### Networking settings (static):

129

These parameters are used to set up a static networking configuration in `/etc/systemd/network/eth.network`. The following static networking parameters are only supported if `ENABLE_DHCP` was set to `false`. The default location of network configuration files in the Debian `stretch` release was changed to `/lib/systemd/network`.

128

These parameters are used to set up a static networking configuration in `/etc/systemd/network/eth.network`. The following static networking parameters are only supported if `ENABLE_DHCP` was set to `false`. The default location of network configuration files in the Debian `stretch` release was changed to `/lib/systemd/network`.

130

129

131

##### `NET_ADDRESS`=""

130

##### `NET_ADDRESS`=""

132

Set a static IPv4 or IPv6 address and its prefix, separated by "/", eg. "192.169.0.3/24".

131

Set a static IPv4 or IPv6 address and its prefix, separated by "/", eg. "192.169.0.3/24".

133

132

134

##### `NET_GATEWAY`=""

133

##### `NET_GATEWAY`=""

135

Set the IP address for the default gateway.

134

Set the IP address for the default gateway.

136

135

137

##### `NET_DNS_1`=""

136

##### `NET_DNS_1`=""

138

Set the IP address for the first DNS server.

137

Set the IP address for the first DNS server.

139

138

140

##### `NET_DNS_2`=""

139

##### `NET_DNS_2`=""

141

Set the IP address for the second DNS server.

140

Set the IP address for the second DNS server.

142

141

143

##### `NET_DNS_DOMAINS`=""

142

##### `NET_DNS_DOMAINS`=""

144

Set the default DNS search domains to use for non fully qualified host names.

143

Set the default DNS search domains to use for non fully qualified host names.

145

144

146

##### `NET_NTP_1`=""

145

##### `NET_NTP_1`=""

147

Set the IP address for the first NTP server.

146

Set the IP address for the first NTP server.

148

147

149

##### `NET_NTP_2`=""

148

##### `NET_NTP_2`=""

150

Set the IP address for the second NTP server.

149

Set the IP address for the second NTP server.

151

150

152

---

151

---

153

152

154

#### Basic system features:

153

#### Basic system features:

155

##### `ENABLE_CONSOLE`=true

154

##### `ENABLE_CONSOLE`=true

156

Enable serial console interface. Recommended if no monitor or keyboard is connected to the RPi2/3. In case of problems fe. if the network (auto) configuration failed - the serial console can be used to access the system.

155

Enable serial console interface. Recommended if no monitor or keyboard is connected to the RPi0/1/2/3. In case of problems fe. if the network (auto) configuration failed - the serial console can be used to access the system.

157

156

158

##### `ENABLE_I2C`=false

157

##### `ENABLE_I2C`=false

159

Enable I2C interface on the RPi2/3. Please check the [RPi2/3 pinout diagrams](https://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.

158

Enable I2C interface on the RPi0/1/2/3. Please check the [RPi0/1/2/3 pinout diagrams](https://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.

160

159

161

##### `ENABLE_SPI`=false

160

##### `ENABLE_SPI`=false

162

Enable SPI interface on the RPi2/3. Please check the [RPi2/3 pinout diagrams](https://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.

161

Enable SPI interface on the RPi0/1/2/3. Please check the [RPi0/1/2/3 pinout diagrams](https://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.

163

162

164

##### `ENABLE_IPV6`=true

163

##### `ENABLE_IPV6`=true

165

Enable IPv6 support. The network interface configuration is managed via systemd-networkd.

164

Enable IPv6 support. The network interface configuration is managed via systemd-networkd.

166

165

167

##### `ENABLE_SSHD`=true

166

##### `ENABLE_SSHD`=true

168

Install and enable OpenSSH service. The default configuration of the service doesn't allow `root` to login. Please use the user `pi` instead and `su -` or `sudo` to execute commands as root.

167

Install and enable OpenSSH service. The default configuration of the service doesn't allow `root` to login. Please use the user `pi` instead and `su -` or `sudo` to execute commands as root.

169

168

170

##### `ENABLE_NONFREE`=false

169

##### `ENABLE_NONFREE`=false

171

Allow the installation of non-free Debian packages that do not comply with the DFSG. This is required to install closed-source firmware binary blobs.

170

Allow the installation of non-free Debian packages that do not comply with the DFSG. This is required to install closed-source firmware binary blobs.

172

171

173

##### `ENABLE_WIRELESS`=false

172

##### `ENABLE_WIRELESS`=false

174

Download and install the [closed-source firmware binary blob](https://github.com/RPi-Distro/firmware-nonfree/raw/master/brcm) that is required to run the internal wireless interface of the Raspberry Pi model `3`. This parameter is ignored if the specified `RPI_MODEL` is not `3`.

173

Download and install the [closed-source firmware binary blob](https://github.com/RPi-Distro/firmware-nonfree/raw/master/brcm) that is required to run the internal wireless interface of the Raspberry Pi model `3`. This parameter is ignored if the specified `RPI_MODEL` is not `3`.

175

174

176

##### `ENABLE_RSYSLOG`=true

175

##### `ENABLE_RSYSLOG`=true

177

If set to false, disable and uninstall rsyslog (so logs will be available only

176

If set to false, disable and uninstall rsyslog (so logs will be available only

178

in journal files)

177

in journal files)

179

178

180

##### `ENABLE_SOUND`=true

179

##### `ENABLE_SOUND`=true

181

Enable sound hardware and install Advanced Linux Sound Architecture.

180

Enable sound hardware and install Advanced Linux Sound Architecture.

182

181

183

##### `ENABLE_HWRANDOM`=true

182

##### `ENABLE_HWRANDOM`=true

184

Enable Hardware Random Number Generator. Strong random numbers are important for most network based communications that use encryption. It's recommended to be enabled.

183

Enable Hardware Random Number Generator. Strong random numbers are important for most network based communications that use encryption. It's recommended to be enabled.

185

184

186

##### `ENABLE_MINGPU`=false

185

##### `ENABLE_MINGPU`=false

187

Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU.

186

Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU.

188

187

189

##### `ENABLE_DBUS`=true

188

##### `ENABLE_DBUS`=true

190

Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled.

189

Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled.

191

190

192

##### `ENABLE_XORG`=false

191

##### `ENABLE_XORG`=false

193

Install Xorg open-source X Window System.

192

Install Xorg open-source X Window System.

194

193

195

##### `ENABLE_WM`=""

194

##### `ENABLE_WM`=""

196

Install a user defined window manager for the X Window System. To make sure all X related package dependencies are getting installed `ENABLE_XORG` will automatically get enabled if `ENABLE_WM` is used. The `rpi23-gen-image.sh` script has been tested with the following list of window managers: `blackbox`, `openbox`, `fluxbox`, `jwm`, `dwm`, `xfce4`, `awesome`.

195

Install a user defined window manager for the X Window System. To make sure all X related package dependencies are getting installed `ENABLE_XORG` will automatically get enabled if `ENABLE_WM` is used. The `rpi23-gen-image.sh` script has been tested with the following list of window managers: `blackbox`, `openbox`, `fluxbox`, `jwm`, `dwm`, `xfce4`, `awesome`.

197

196

198

##### `ENABLE_SYSVINIT`=false

197

##### `ENABLE_SYSVINIT`=false

199

Support for halt,init,poweroff,reboot,runlevel,shutdown,telinit commands

198

Support for halt,init,poweroff,reboot,runlevel,shutdown,telinit commands

200

199

201

---

200

---

202

201

203

#### Advanced system features:

202

#### Advanced system features:

204

##### `ENABLE_MINBASE`=false

203

##### `ENABLE_MINBASE`=false

205

Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.

204

Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.

206

205

207

##### `ENABLE_REDUCE`=false

206

##### `ENABLE_REDUCE`=false

208

Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.

207

Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.

209

208

210

##### `ENABLE_UBOOT`=false

209

##### `ENABLE_UBOOT`=false

211

Replace the default RPi2/3 second stage bootloader (bootcode.bin) with [U-Boot bootloader](https://git.denx.de/?p=u-boot.git;a=summary). U-Boot can boot images via the network using the BOOTP/TFTP protocol.

210

Replace the default RPi0/1/2/3 second stage bootloader (bootcode.bin) with [U-Boot bootloader](https://git.denx.de/?p=u-boot.git;a=summary). U-Boot can boot images via the network using the BOOTP/TFTP protocol.

212

211

213

##### `UBOOTSRC_DIR`=""

212

##### `UBOOTSRC_DIR`=""

214

Path to a directory (`u-boot`) of [U-Boot bootloader sources](https://git.denx.de/?p=u-boot.git;a=summary) that will be copied, configured, build and installed inside the chroot.

213

Path to a directory (`u-boot`) of [U-Boot bootloader sources](https://git.denx.de/?p=u-boot.git;a=summary) that will be copied, configured, build and installed inside the chroot.

215

214

216

##### `ENABLE_FBTURBO`=false

215

##### `ENABLE_FBTURBO`=false

217

Install and enable the [hardware accelerated Xorg video driver](https://github.com/ssvb/xf86-video-fbturbo) `fbturbo`. Please note that this driver is currently limited to hardware accelerated window moving and scrolling.

216

Install and enable the [hardware accelerated Xorg video driver](https://github.com/ssvb/xf86-video-fbturbo) `fbturbo`. Please note that this driver is currently limited to hardware accelerated window moving and scrolling.

218

217

219

##### `FBTURBOSRC_DIR`=""

218

##### `FBTURBOSRC_DIR`=""

220

Path to a directory (`xf86-video-fbturbo`) of [hardware accelerated Xorg video driver sources](https://github.com/ssvb/xf86-video-fbturbo) that will be copied, configured, build and installed inside the chroot.

219

Path to a directory (`xf86-video-fbturbo`) of [hardware accelerated Xorg video driver sources](https://github.com/ssvb/xf86-video-fbturbo) that will be copied, configured, build and installed inside the chroot.

221

220

222

##### `ENABLE_VIDEOCORE`=false

221

##### `ENABLE_VIDEOCORE`=false

223

Install and enable the [Source code for ARM side libraries for interfacing to Raspberry Pi GPU](https://github.com/raspberrypi/userland) `vcgencmd`. Please note that this driver is currently limited to hardware accelerated window moving and scrolling.

222

Install and enable the [Source code for ARM side libraries for interfacing to Raspberry Pi GPU](https://github.com/raspberrypi/userland) `vcgencmd`. Please note that this driver is currently limited to hardware accelerated window moving and scrolling.

224

223

225

##### `VIDEOCORESRC_DIR`=""

224

##### `VIDEOCORESRC_DIR`=""

226

Path to a directory (`userland`) of [Source code for ARM side libraries for interfacing to Raspberry Pi GPU](https://github.com/raspberrypi/userland) that will be copied, configured, build and installed inside the chroot.

225

Path to a directory (`userland`) of [Source code for ARM side libraries for interfacing to Raspberry Pi GPU](https://github.com/raspberrypi/userland) that will be copied, configured, build and installed inside the chroot.

227

226

228

##### `ENABLE_IPTABLES`=false

227

##### `ENABLE_IPTABLES`=false

229

Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.

228

Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.

230

229

231

##### `ENABLE_USER`=true

230

##### `ENABLE_USER`=true

232

Create non-root user with password `USER_PASSWORD`=raspberry. Unless overridden with `USER_NAME`=user, username will be `pi`.

231

Create non-root user with password `USER_PASSWORD`=raspberry. Unless overridden with `USER_NAME`=user, username will be `pi`.

233

232

234

##### `USER_NAME`=pi

233

##### `USER_NAME`=pi

235

Non-root user to create. Ignored if `ENABLE_USER`=false

234

Non-root user to create. Ignored if `ENABLE_USER`=false

236

235

237

##### `ENABLE_ROOT`=false

236

##### `ENABLE_ROOT`=false

238

Set root user password so root login will be enabled

237

Set root user password so root login will be enabled

239

238

240

##### `ENABLE_HARDNET`=false

239

##### `ENABLE_HARDNET`=false

241

Enable IPv4/IPv6 network stack hardening settings.

240

Enable IPv4/IPv6 network stack hardening settings.

242

241

243

##### `ENABLE_SPLITFS`=false

242

##### `ENABLE_SPLITFS`=false

244

Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.

243

Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.

245

244

246

##### `CHROOT_SCRIPTS`=""

245

##### `CHROOT_SCRIPTS`=""

247

Path to a directory with scripts that should be run in the chroot before the image is finally built. Every executable file in this directory is run in lexicographical order.

246

Path to a directory with scripts that should be run in the chroot before the image is finally built. Every executable file in this directory is run in lexicographical order.

248

247

249

##### `ENABLE_INITRAMFS`=false

248

##### `ENABLE_INITRAMFS`=false

250

Create an initramfs that that will be loaded during the Linux startup process. `ENABLE_INITRAMFS` will automatically get enabled if `ENABLE_CRYPTFS`=true. This parameter will be ignored if `BUILD_KERNEL`=false.

249

Create an initramfs that that will be loaded during the Linux startup process. `ENABLE_INITRAMFS` will automatically get enabled if `ENABLE_CRYPTFS`=true. This parameter will be ignored if `BUILD_KERNEL`=false.

251

250

252

##### `ENABLE_IFNAMES`=true

251

##### `ENABLE_IFNAMES`=true

253

Enable automatic assignment of predictable, stable network interface names for all local Ethernet, WLAN interfaces. This might create complex and long interface names.

252

Enable automatic assignment of predictable, stable network interface names for all local Ethernet, WLAN interfaces. This might create complex and long interface names.

254

253

255

##### `DISABLE_UNDERVOLT_WARNINGS`=

254

##### `DISABLE_UNDERVOLT_WARNINGS`=

256

Disable RPi2/3 under-voltage warnings and overlays. Setting the parameter to `1` will disable the warning overlay. Setting it to `2` will additionally allow RPi2/3 turbo mode when low-voltage is present.

255

Disable RPi2/3 under-voltage warnings and overlays. Setting the parameter to `1` will disable the warning overlay. Setting it to `2` will additionally allow RPi2/3 turbo mode when low-voltage is present.

257

256

258

---

257

---

259

258

260

#### SSH settings:

259

#### SSH settings:

261

##### `SSH_ENABLE_ROOT`=false

260

##### `SSH_ENABLE_ROOT`=false

262

Enable password root login via SSH. This may be a security risk with default password, use only in trusted environments. `ENABLE_ROOT` must be set to `true`.

261

Enable password root login via SSH. This may be a security risk with default password, use only in trusted environments. `ENABLE_ROOT` must be set to `true`.

263

262

264

##### `SSH_DISABLE_PASSWORD_AUTH`=false

263

##### `SSH_DISABLE_PASSWORD_AUTH`=false

265

Disable password based SSH authentication. Only public key based SSH (v2) authentication will be supported.

264

Disable password based SSH authentication. Only public key based SSH (v2) authentication will be supported.

266

265

267

##### `SSH_LIMIT_USERS`=false

266

##### `SSH_LIMIT_USERS`=false

268

Limit the users that are allowed to login via SSH. Only allow user `USER_NAME`=pi and root if `SSH_ENABLE_ROOT`=true to login. This parameter will be ignored if `dropbear` SSH is used (`REDUCE_SSHD`=true).

267

Limit the users that are allowed to login via SSH. Only allow user `USER_NAME`=pi and root if `SSH_ENABLE_ROOT`=true to login. This parameter will be ignored if `dropbear` SSH is used (`REDUCE_SSHD`=true).

269

268

270

##### `SSH_ROOT_PUB_KEY`=""

269

##### `SSH_ROOT_PUB_KEY`=""

271

Add SSH (v2) public key(s) from specified file to `authorized_keys` file to enable public key based SSH (v2) authentication of user `root`. The specified file can also contain multiple SSH (v2) public keys. SSH protocol version 1 is not supported. `ENABLE_ROOT` **and** `SSH_ENABLE_ROOT` must be set to `true`.

270

Add SSH (v2) public key(s) from specified file to `authorized_keys` file to enable public key based SSH (v2) authentication of user `root`. The specified file can also contain multiple SSH (v2) public keys. SSH protocol version 1 is not supported. `ENABLE_ROOT` **and** `SSH_ENABLE_ROOT` must be set to `true`.

272

271

273

##### `SSH_USER_PUB_KEY`=""

272

##### `SSH_USER_PUB_KEY`=""

274

Add SSH (v2) public key(s) from specified file to `authorized_keys` file to enable public key based SSH (v2) authentication of user `USER_NAME`=pi. The specified file can also contain multiple SSH (v2) public keys. SSH protocol version 1 is not supported.

273

Add SSH (v2) public key(s) from specified file to `authorized_keys` file to enable public key based SSH (v2) authentication of user `USER_NAME`=pi. The specified file can also contain multiple SSH (v2) public keys. SSH protocol version 1 is not supported.

275

274

276

---

275

---

277

276

278

#### Kernel compilation:

277

#### Kernel compilation:

279

##### `BUILD_KERNEL`=true

278

##### `BUILD_KERNEL`=true

280

Build and install the latest RPi2/3 Linux kernel. Currently only the default RPi2/3 kernel configuration is used.

279

Build and install the latest RPi0/1/2/3 Linux kernel. Currently only the default RPi0/1/2/3 kernel configuration is used.

281

280

282

##### `CROSS_COMPILE`="arm-linux-gnueabihf-"

281

##### `CROSS_COMPILE`="arm-linux-gnueabihf-"

283

This sets the cross compile enviornment for the compiler.

282

This sets the cross compile enviornment for the compiler.

284

283

285

##### `KERNEL_ARCH`="arm"

284

##### `KERNEL_ARCH`="arm"

286

This sets the kernel architecture for the compiler.

285

This sets the kernel architecture for the compiler.

287

286

288

##### `KERNEL_IMAGE`="kernel7.img"

287

##### `KERNEL_IMAGE`="kernel7.img"

289

Name of the image file in the boot partition. If not set, `KERNEL_IMAGE` will be set to "kernel8.img" automatically if building for arm64.

288

Name of the image file in the boot partition. If not set, `KERNEL_IMAGE` will be set to "kernel8.img" automatically if building for arm64.

290

289

291

##### `KERNEL_BRANCH`=""

290

##### `KERNEL_BRANCH`=""

292

Name of the requested branch from the GIT location for the RPi Kernel. Default is using the current default branch from the GIT site.

291

Name of the requested branch from the GIT location for the RPi Kernel. Default is using the current default branch from the GIT site.

293

292

294

##### `QEMU_BINARY`="/usr/bin/qemu-arm-static"

293

##### `QEMU_BINARY`="/usr/bin/qemu-arm-static"

295

Sets the QEMU enviornment for the Debian archive. If not set, `QEMU_BINARY` will be set to "/usr/bin/qemu-aarch64-static" automatically if building for arm64.

294

Sets the QEMU enviornment for the Debian archive. If not set, `QEMU_BINARY` will be set to "/usr/bin/qemu-aarch64-static" automatically if building for arm64.

296

295

297

##### `KERNEL_DEFCONFIG`="bcm2709_defconfig"

296

##### `KERNEL_DEFCONFIG`="bcm2709_defconfig"

298

Sets the default config for kernel compiling. If not set, `KERNEL_DEFCONFIG` will be set to "bcmrpi3\_defconfig" automatically if building for arm64.

297

Sets the default config for kernel compiling. If not set, `KERNEL_DEFCONFIG` will be set to "bcmrpi3\_defconfig" automatically if building for arm64.

299

298

300

##### `KERNEL_REDUCE`=false

299

##### `KERNEL_REDUCE`=false

301

Reduce the size of the generated kernel by removing unwanted device, network and filesystem drivers (experimental).

300

Reduce the size of the generated kernel by removing unwanted device, network and filesystem drivers (experimental).

302

301

303

##### `KERNEL_THREADS`=1

302

##### `KERNEL_THREADS`=1

304

Number of parallel kernel building threads. If the parameter is left untouched the script will automatically determine the number of CPU cores to set the number of parallel threads to speed the kernel compilation.

303

Number of parallel kernel building threads. If the parameter is left untouched the script will automatically determine the number of CPU cores to set the number of parallel threads to speed the kernel compilation.

305

304

306

##### `KERNEL_HEADERS`=true

305

##### `KERNEL_HEADERS`=true

307

Install kernel headers with built kernel.

306

Install kernel headers with built kernel.

308

307

309

##### `KERNEL_MENUCONFIG`=false

308

##### `KERNEL_MENUCONFIG`=false

310

Start `make menuconfig` interactive menu-driven kernel configuration. The script will continue after `make menuconfig` was terminated.

309

Start `make menuconfig` interactive menu-driven kernel configuration. The script will continue after `make menuconfig` was terminated.

311

310

312

##### `KERNEL_OLDDEFCONFIG`=false

311

##### `KERNEL_OLDDEFCONFIG`=false

313

Run `make olddefconfig` to automatically set all new kernel configuration options to their recommended default values.

312

Run `make olddefconfig` to automatically set all new kernel configuration options to their recommended default values.

314

313

315

##### `KERNEL_CCACHE`=false

314

##### `KERNEL_CCACHE`=false

316

Compile the kernel using ccache. This speeds up kernel recompilation by caching previous compilations and detecting when the same compilation is being done again.

315

Compile the kernel using ccache. This speeds up kernel recompilation by caching previous compilations and detecting when the same compilation is being done again.

317

316

318

##### `KERNEL_REMOVESRC`=true

317

##### `KERNEL_REMOVESRC`=true

319

Remove all kernel sources from the generated OS image after it was built and installed.

318

Remove all kernel sources from the generated OS image after it was built and installed.

320

319

321

##### `KERNELSRC_DIR`=""

320

##### `KERNELSRC_DIR`=""

322

Path to a directory (`linux`) of [RaspberryPi Linux kernel sources](https://github.com/raspberrypi/linux) that will be copied, configured, build and installed inside the chroot.

321

Path to a directory (`linux`) of [RaspberryPi Linux kernel sources](https://github.com/raspberrypi/linux) that will be copied, configured, build and installed inside the chroot.

323

322

324

##### `KERNELSRC_CLEAN`=false

323

##### `KERNELSRC_CLEAN`=false

325

Clean the existing kernel sources directory `KERNELSRC_DIR` (using `make mrproper`) after it was copied to the chroot and before the compilation of the kernel has started. This parameter will be ignored if no `KERNELSRC_DIR` was specified or if `KERNELSRC_PREBUILT`=true.

324

Clean the existing kernel sources directory `KERNELSRC_DIR` (using `make mrproper`) after it was copied to the chroot and before the compilation of the kernel has started. This parameter will be ignored if no `KERNELSRC_DIR` was specified or if `KERNELSRC_PREBUILT`=true.

326

325

327

##### `KERNELSRC_CONFIG`=true

326

##### `KERNELSRC_CONFIG`=true

328

Run `make bcm2709_defconfig` (and optional `make menuconfig`) to configure the kernel sources before building. This parameter is automatically set to `true` if no existing kernel sources directory was specified using `KERNELSRC_DIR`. This parameter is ignored if `KERNELSRC_PREBUILT`=true.

327

Run `make bcm2709_defconfig` (and optional `make menuconfig`) to configure the kernel sources before building. This parameter is automatically set to `true` if no existing kernel sources directory was specified using `KERNELSRC_DIR`. This parameter is ignored if `KERNELSRC_PREBUILT`=true.

329

328

330

##### `KERNELSRC_USRCONFIG`=""

329

##### `KERNELSRC_USRCONFIG`=""

331

Copy own config file to kernel `.config`. If `KERNEL_MENUCONFIG`=true then running after copy.

330

Copy own config file to kernel `.config`. If `KERNEL_MENUCONFIG`=true then running after copy.

332

331

333

##### `KERNELSRC_PREBUILT`=false

332

##### `KERNELSRC_PREBUILT`=false

334

With this parameter set to true the script expects the existing kernel sources directory to be already successfully cross-compiled. The parameters `KERNELSRC_CLEAN`, `KERNELSRC_CONFIG`, `KERNELSRC_USRCONFIG` and `KERNEL_MENUCONFIG` are ignored and no kernel compilation tasks are performed.

333

With this parameter set to true the script expects the existing kernel sources directory to be already successfully cross-compiled. The parameters `KERNELSRC_CLEAN`, `KERNELSRC_CONFIG`, `KERNELSRC_USRCONFIG` and `KERNEL_MENUCONFIG` are ignored and no kernel compilation tasks are performed.

335

334

336

##### `RPI_FIRMWARE_DIR`=""

335

##### `RPI_FIRMWARE_DIR`=""

337

The directory (`firmware`) containing a local copy of the firmware from the [RaspberryPi firmware project](https://github.com/raspberrypi/firmware). Default is to download the latest firmware directly from the project.

336

The directory (`firmware`) containing a local copy of the firmware from the [RaspberryPi firmware project](https://github.com/raspberrypi/firmware). Default is to download the latest firmware directly from the project.

338

337

339

---

338

---

340

339

341

#### Reduce disk usage:

340

#### Reduce disk usage:

342

The following list of parameters is ignored if `ENABLE_REDUCE`=false.

341

The following list of parameters is ignored if `ENABLE_REDUCE`=false.

343

342

344

##### `REDUCE_APT`=true

343

##### `REDUCE_APT`=true

345

Configure APT to use compressed package repository lists and no package caching files.

344

Configure APT to use compressed package repository lists and no package caching files.

346

345

347

##### `REDUCE_DOC`=true

346

##### `REDUCE_DOC`=true

348

Remove all doc files (harsh). Configure APT to not include doc files on future `apt-get` package installations.

347

Remove all doc files (harsh). Configure APT to not include doc files on future `apt-get` package installations.

349

348

350

##### `REDUCE_MAN`=true

349

##### `REDUCE_MAN`=true

351

Remove all man pages and info files (harsh). Configure APT to not include man pages on future `apt-get` package installations.

350

Remove all man pages and info files (harsh). Configure APT to not include man pages on future `apt-get` package installations.

352

351

353

##### `REDUCE_VIM`=false

352

##### `REDUCE_VIM`=false

354

Replace `vim-tiny` package by `levee` a tiny vim clone.

353

Replace `vim-tiny` package by `levee` a tiny vim clone.

355

354

356

##### `REDUCE_BASH`=false

355

##### `REDUCE_BASH`=false

357

Remove `bash` package and switch to `dash` shell (experimental).

356

Remove `bash` package and switch to `dash` shell (experimental).

358

357

359

##### `REDUCE_HWDB`=true

358

##### `REDUCE_HWDB`=true

360

Remove PCI related hwdb files (experimental).

359

Remove PCI related hwdb files (experimental).

361

360

362

##### `REDUCE_SSHD`=true

361

##### `REDUCE_SSHD`=true

363

Replace `openssh-server` with `dropbear`.

362

Replace `openssh-server` with `dropbear`.

364

363

365

##### `REDUCE_LOCALE`=true

364

##### `REDUCE_LOCALE`=true

366

Remove all `locale` translation files.

365

Remove all `locale` translation files.

367

366

368

---

367

---

369

368

370

#### Encrypted root partition:

369

#### Encrypted root partition:

371

##### `ENABLE_CRYPTFS`=false

370

##### `ENABLE_CRYPTFS`=false

372

Enable full system encryption with dm-crypt. Setup a fully LUKS encrypted root partition (aes-xts-plain64:sha512) and generate required initramfs. The /boot directory will not be encrypted. This parameter will be ignored if `BUILD_KERNEL`=false. `ENABLE_CRYPTFS` is experimental. SSH-to-initramfs is currently not supported but will be soon - feel free to help.

371

Enable full system encryption with dm-crypt. Setup a fully LUKS encrypted root partition (aes-xts-plain64:sha512) and generate required initramfs. The /boot directory will not be encrypted. This parameter will be ignored if `BUILD_KERNEL`=false. `ENABLE_CRYPTFS` is experimental. SSH-to-initramfs is currently not supported but will be soon - feel free to help.

373

372

374

##### `CRYPTFS_PASSWORD`=""

373

##### `CRYPTFS_PASSWORD`=""

375

Set password of the encrypted root partition. This parameter is mandatory if `ENABLE_CRYPTFS`=true.

374

Set password of the encrypted root partition. This parameter is mandatory if `ENABLE_CRYPTFS`=true.

376

375

377

##### `CRYPTFS_MAPPING`="secure"

376

##### `CRYPTFS_MAPPING`="secure"

378

Set name of dm-crypt managed device-mapper mapping.

377

Set name of dm-crypt managed device-mapper mapping.

379

378

380

##### `CRYPTFS_CIPHER`="aes-xts-plain64:sha512"

379

##### `CRYPTFS_CIPHER`="aes-xts-plain64:sha512"

381

Set cipher specification string. `aes-xts*` ciphers are strongly recommended.

380

Set cipher specification string. `aes-xts*` ciphers are strongly recommended.

382

381

383

##### `CRYPTFS_XTSKEYSIZE`=512

382

##### `CRYPTFS_XTSKEYSIZE`=512

384

Sets key size in bits. The argument has to be a multiple of 8.

383

Sets key size in bits. The argument has to be a multiple of 8.

385

384

386

---

385

---

387

386

388

#### Build settings:

387

#### Build settings:

389

##### `BASEDIR`=$(pwd)/images/${RELEASE}

388

##### `BASEDIR`=$(pwd)/images/${RELEASE}

390

Set a path to a working directory used by the script to generate an image.

389

Set a path to a working directory used by the script to generate an image.

391

390

392

##### `IMAGE_NAME`=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}

391

##### `IMAGE_NAME`=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}

393

Set a filename for the output file(s). Note: the script will create $IMAGE_NAME.img if `ENABLE_SPLITFS`=false or $IMAGE_NAME-frmw.img and $IMAGE_NAME-root.img if `ENABLE_SPLITFS`=true. Note 2: If the KERNEL_BRANCH is not set, the word "CURRENT" is used.

392

Set a filename for the output file(s). Note: the script will create $IMAGE_NAME.img if `ENABLE_SPLITFS`=false or $IMAGE_NAME-frmw.img and $IMAGE_NAME-root.img if `ENABLE_SPLITFS`=true. Note 2: If the KERNEL_BRANCH is not set, the word "CURRENT" is used.

394

393

395

## Understanding the script

394

## Understanding the script

396

The functions of this script that are required for the different stages of the bootstrapping are split up into single files located inside the `bootstrap.d` directory. During the bootstrapping every script in this directory gets executed in lexicographical order:

395

The functions of this script that are required for the different stages of the bootstrapping are split up into single files located inside the `bootstrap.d` directory. During the bootstrapping every script in this directory gets executed in lexicographical order:

397

396

398

| Script | Description |

397

| Script | Description |

399

| --- | --- |

398

| --- | --- |

400

| `10-bootstrap.sh` | Debootstrap basic system |

399

| `10-bootstrap.sh` | Debootstrap basic system |

401

| `11-apt.sh` | Setup APT repositories |

400

| `11-apt.sh` | Setup APT repositories |

402

| `12-locale.sh` | Setup Locales and keyboard settings |

401

| `12-locale.sh` | Setup Locales and keyboard settings |

403

| `13-kernel.sh` | Build and install RPi2/3 Kernel |

402

| `13-kernel.sh` | Build and install RPi0/1/2/3 Kernel |

404

| `14-fstab.sh` | Setup fstab and initramfs |

403

| `14-fstab.sh` | Setup fstab and initramfs |

405

| `15-rpi-config.sh` | Setup RPi2/3 config and cmdline |

404

| `15-rpi-config.sh` | Setup RPi0/1/2/3 config and cmdline |

406

| `20-networking.sh` | Setup Networking |

405

| `20-networking.sh` | Setup Networking |

407

| `21-firewall.sh` | Setup Firewall |

406

| `21-firewall.sh` | Setup Firewall |

408

| `30-security.sh` | Setup Users and Security settings |

407

| `30-security.sh` | Setup Users and Security settings |

409

| `31-logging.sh` | Setup Logging |

408

| `31-logging.sh` | Setup Logging |

410

| `32-sshd.sh` | Setup SSH and public keys |

409

| `32-sshd.sh` | Setup SSH and public keys |

411

| `41-uboot.sh` | Build and Setup U-Boot |

410

| `41-uboot.sh` | Build and Setup U-Boot |

412

| `42-fbturbo.sh` | Build and Setup fbturbo Xorg driver |

411

| `42-fbturbo.sh` | Build and Setup fbturbo Xorg driver |

412

| `43-videocore.sh` | Build and Setup videocore libraries |

413

| `50-firstboot.sh` | First boot actions |

413

| `50-firstboot.sh` | First boot actions |

414

| `99-reduce.sh` | Reduce the disk space usage |

414

| `99-reduce.sh` | Reduce the disk space usage |

415

416

All the required configuration files that will be copied to the generated OS image are located inside the `files` directory. It is not recommended to modify these configuration files manually.

416

All the required configuration files that will be copied to the generated OS image are located inside the `files` directory. It is not recommended to modify these configuration files manually.

417

418

| Directory | Description |

418

| Directory | Description |

419

| --- | --- |

419

| --- | --- |

420

| `apt` | APT management configuration files |

420

| `apt` | APT management configuration files |

421

| `boot` | Boot and RPi2/3 configuration files |

421

| `boot` | Boot and RPi0/1/2/3 configuration files |

422

| `dpkg` | Package Manager configuration |

422

| `dpkg` | Package Manager configuration |

423

| `etc` | Configuration files and rc scripts |

423

| `etc` | Configuration files and rc scripts |

424

| `firstboot` | Scripts that get executed on first boot |

424

| `firstboot` | Scripts that get executed on first boot |

425

| `initramfs` | Initramfs scripts |

425

| `initramfs` | Initramfs scripts |

426

| `iptables` | Firewall configuration files |

426

| `iptables` | Firewall configuration files |

427

| `locales` | Locales configuration |

427

| `locales` | Locales configuration |

428

| `modules` | Kernel Modules configuration |

428

| `modules` | Kernel Modules configuration |

429

| `mount` | Fstab configuration |

429

| `mount` | Fstab configuration |

430

| `network` | Networking configuration files |

430

| `network` | Networking configuration files |

431

| `sysctl.d` | Swapping and Network Hardening configuration |

431

| `sysctl.d` | Swapping and Network Hardening configuration |

432

| `xorg` | fbturbo Xorg driver configuration |

432

| `xorg` | fbturbo Xorg driver configuration |

433

434

## Custom packages and scripts

434

## Custom packages and scripts

435

Debian custom packages, i.e. those not in the debian repositories, can be installed by placing them in the `packages` directory. They are installed immediately after packages from the repositories are installed. Any dependencies listed in the custom packages will be downloaded automatically from the repositories. Do not list these custom packages in `APT_INCLUDES`.

435

Debian custom packages, i.e. those not in the debian repositories, can be installed by placing them in the `packages` directory. They are installed immediately after packages from the repositories are installed. Any dependencies listed in the custom packages will be downloaded automatically from the repositories. Do not list these custom packages in `APT_INCLUDES`.

436

437

Scripts in the custom.d directory will be executed after all other installation is complete but before the image is created.

437

Scripts in the custom.d directory will be executed after all other installation is complete but before the image is created.

438

439

## Logging of the bootstrapping process

439

## Logging of the bootstrapping process

440

All information related to the bootstrapping process and the commands executed by the `rpi23-gen-image.sh` script can easily be saved into a logfile. The common shell command `script` can be used for this purpose:

440

All information related to the bootstrapping process and the commands executed by the `rpi23-gen-image.sh` script can easily be saved into a logfile. The common shell command `script` can be used for this purpose:

441

442

```shell

442

```shell

443

script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log

443

script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log

444

```

444

```

445

446

## Flashing the image file

446

## Flashing the image file

447

After the image file was successfully created by the `rpi23-gen-image.sh` script it can be copied to the microSD card that will be used by the RPi2/3 computer. This can be performed by using the tools `bmaptool` or `dd`. Using `bmaptool` will probably speed-up the copy process because `bmaptool` copies more wisely than `dd`.

447

After the image file was successfully created by the `rpi23-gen-image.sh` script it can be copied to the microSD card that will be used by the RPi0/1/2/3 computer. This can be performed by using the tools `bmaptool` or `dd`. Using `bmaptool` will probably speed-up the copy process because `bmaptool` copies more wisely than `dd`.

448

449

##### Flashing examples:

449

##### Flashing examples:

450

```shell

450

```shell

451

bmaptool copy ./images/buster/2017-01-23-rpi3-buster.img /dev/mmcblk0

451

bmaptool copy ./images/buster/2017-01-23-rpi3-buster.img /dev/mmcblk0

452

dd bs=4M if=./images/buster/2017-01-23-rpi3-buster.img of=/dev/mmcblk0

452

dd bs=4M if=./images/buster/2017-01-23-rpi3-buster.img of=/dev/mmcblk0

453

```

453

```

454

If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:

454

If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:

455

```shell

455

```shell

456

bmaptool copy ./images/buster/2017-01-23-rpi3-buster-frmw.img /dev/mmcblk0

456

bmaptool copy ./images/buster/2017-01-23-rpi3-buster-frmw.img /dev/mmcblk0

457

bmaptool copy ./images/buster/2017-01-23-rpi3-buster-root.img /dev/sdc

457

bmaptool copy ./images/buster/2017-01-23-rpi3-buster-root.img /dev/sdc

458

```

458

```

459

460

## QEMU emulation

460

## QEMU emulation

461

Start QEMU full system emulation:

461

Start QEMU full system emulation:

462

```shell

462

```shell

463

qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=tty1"

463

qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=tty1"

464

```

464

```

465

466

Start QEMU full system emulation and output to console:

466

Start QEMU full system emulation and output to console:

467

```shell

467

```shell

468

qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio

468

qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio

469

```

469

```

470

471

Start QEMU full system emulation with SMP and output to console:

471

Start QEMU full system emulation with SMP and output to console:

472

```shell

472

```shell

473

qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -smp cpus=2,maxcpus=2 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio

473

qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -smp cpus=2,maxcpus=2 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio

474

```

474

```

475

476

Start QEMU full system emulation with cryptfs, initramfs and output to console:

476

Start QEMU full system emulation with cryptfs, initramfs and output to console:

477

```shell

477

```shell

478

qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -initrd "initramfs-${KERNEL_VERSION}" -append "root=/dev/mapper/secure cryptdevice=/dev/mmcblk0p2:secure rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio

478

qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -initrd "initramfs-${KERNEL_VERSION}" -append "root=/dev/mapper/secure cryptdevice=/dev/mmcblk0p2:secure rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio

479

```

479

```

480

481

## External links and references

481

## External links and references

482

* [Debian worldwide mirror sites](https://www.debian.org/mirror/list)

482

* [Debian worldwide mirror sites](https://www.debian.org/mirror/list)

483

* [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)

483

* [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)

484

* [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains)

484

* [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains)

485

* [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)

485

* [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)

486

* [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)

486

* [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)

487

* [U-BOOT git repository](https://git.denx.de/?p=u-boot.git;a=summary)

487

* [U-BOOT git repository](https://git.denx.de/?p=u-boot.git;a=summary)

488

* [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)

488

* [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)

489

* [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/brcm)

489

* [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/brcm)

490

* [Collabora RPi2 Kernel precompiled](https://repositories.collabora.co.uk/debian/)

490

* [Collabora RPi2 Kernel precompiled](https://repositories.collabora.co.uk/debian/)

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Dépôts
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

             # rpi23-gen-image
             ## Introduction
-            `rpi23-gen-image.sh` is an advanced Debian Linux bootstrapping shell script for generating Debian OS images for Raspberry Pi 2 (RPi2) and Raspberry Pi 3 (RPi3) computers. The script at this time supports the bootstrapping of the Debian (armhf) releases `stretch` and `buster`. Raspberry Pi 3 images are generated for 32-bit mode only. Raspberry Pi 3 64-bit images can be generated using custom configuration parameters (```templates/rpi3-stretch-arm64-4.14.y```).
+            `rpi23-gen-image.sh` is an advanced Debian Linux bootstrapping shell script for generating Debian OS images for all Raspberry Pi computers. The script at this time supports the bootstrapping of the Debian (armhf/armel) releases `stretch` and `buster`. Raspberry Pi 3 images are generated for 32-bit mode only. Raspberry Pi 3 64-bit images can be generated using custom configuration parameters (```templates/rpi3-stretch-arm64-4.14.y```).
             ## Build dependencies
             The following list of Debian packages must be installed on the build system because they are essentially required for the bootstrapping process. The script will check if all required packages are installed and missing packages will be installed automatically if confirmed by the user.
               ```debootstrap debian-archive-keyring qemu-user-static binfmt-support dosfstools rsync bmap-tools whois git bc psmisc dbus sudo```
-            It is recommended to configure the `rpi23-gen-image.sh` script to build and install the latest Raspberry Pi Linux kernel. For the RPi3 this is mandatory. Kernel compilation and linking will be performed on the build system using an ARM (armhf) cross-compiler toolchain.
+            It is recommended to configure the `rpi23-gen-image.sh` script to build and install the latest Raspberry Pi Linux kernel. For the RPi3 this is mandatory. Kernel compilation and linking will be performed on the build system using an ARM (armhf/armel) cross-compiler toolchain.
-            The script has been tested using the default `crossbuild-essential-armhf` toolchain meta package on Debian Linux `stretch` build systems. Please check the [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains) for further information.
+            The script has been tested using the default `crossbuild-essential-armhf` and `crossbuild-essential-armel` toolchain meta packages on Debian Linux `stretch` build systems. Please check the [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains) for further information.
             ## Command-line parameters
             The script accepts certain command-line parameters to enable or disable specific OS features, services and configuration settings. These parameters are passed to the `rpi23-gen-image.sh` script via (simple) shell-variables. Unlike environment shell-variables (simple) shell-variables are defined at the beginning of the command-line call of the `rpi23-gen-image.sh` script.
             ##### Command-line examples:
             ```shell
             ENABLE_UBOOT=true ./rpi23-gen-image.sh
             ENABLE_CONSOLE=false ENABLE_IPV6=false ./rpi23-gen-image.sh
             ENABLE_WM=xfce4 ENABLE_FBTURBO=true ENABLE_MINBASE=true ./rpi23-gen-image.sh
             ENABLE_HARDNET=true ENABLE_IPTABLES=true /rpi23-gen-image.sh
             APT_SERVER=ftp.de.debian.org APT_PROXY="http://127.0.0.1:3142/" ./rpi23-gen-image.sh
             ENABLE_MINBASE=true ./rpi23-gen-image.sh
             BUILD_KERNEL=true ENABLE_MINBASE=true ENABLE_IPV6=false ./rpi23-gen-image.sh
             BUILD_KERNEL=true KERNELSRC_DIR=/tmp/linux ./rpi23-gen-image.sh
             ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh
             ENABLE_CRYPTFS=true CRYPTFS_PASSWORD=changeme EXPANDROOT=false ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh
             RELEASE=stretch BUILD_KERNEL=true ./rpi23-gen-image.sh
             RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
             RELEASE=stretch RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
             ```
             ## Configuration template files
             To avoid long lists of command-line parameters and to help to store the favourite parameter configurations the `rpi23-gen-image.sh` script supports so called configuration template files (`CONFIG_TEMPLATE`=template). These are simple text files located in the `./templates` directory that contain the list of configuration parameters that will be used. New configuration template files can be added to the `./templates` directory.
             ##### Command-line examples:
             ```shell
             CONFIG_TEMPLATE=rpi3stretch ./rpi23-gen-image.sh
             CONFIG_TEMPLATE=rpi2stretch ./rpi23-gen-image.sh
             ```
             ## Supported parameters and settings
             #### APT settings:
             ##### `APT_SERVER`="ftp.debian.org"
             Set Debian packages server address. Choose a server from the list of Debian worldwide [mirror sites](https://www.debian.org/mirror/list). Using a nearby server will probably speed-up all required downloads within the bootstrapping process.
             ##### `APT_PROXY`=""
             Set Proxy server address. Using a local Proxy-Cache like `apt-cacher-ng` will speed-up the bootstrapping process because all required Debian packages will only be downloaded from the Debian mirror site once. If `apt-cacher-ng` is running on default `http://127.0.0.1:3142` it is autodetected and you don't need to set this.
             ##### `APT_INCLUDES`=""
             A comma separated list of additional packages to be installed by debootstrap during bootstrapping.
             ##### `APT_INCLUDES_LATE`=""
             A comma separated list of additional packages to be installed by apt after bootstrapping and after APT sources are set up.  This is useful for packages with pre-depends, which debootstrap do not handle well.
             ---
             #### General system settings:
             ##### `SET_ARCH`=32
             Set Architecture to default 32bit. If you want to to compile 64bit (RPI3 or RPI3+) set it to `64`. This option will set every needed crosscompiler or boeard specific option for a successful build.
-            If you want to change e.g. cross-compiler -> Templates always override defaults
             ##### `RPI_MODEL`=2
             Specifiy the target Raspberry Pi hardware model. The script at this time supports the following Raspberry Pi models:
             `0`  = Used for Raspberry Pi 0 and Raspberry Pi 0 W
             `1`  = Used for Pi 1 model A and B
             `1P` = Used for Pi 1 model B+ and A+
             `2`  = Used for Pi 2 model B
             `3`  = Used for Pi 3 model B
             `3P` = Used for Pi 3 model B+
             `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` or `3P` is used.
             ##### `RELEASE`="buster"
             Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases `stretch` and `buster`.
             ##### `RELEASE_ARCH`="armhf"
             Set the desired Debian release architecture.
             ##### `HOSTNAME`="rpi$RPI_MODEL-$RELEASE"
             Set system host name. It's recommended that the host name is unique in the corresponding subnet.
             ##### `PASSWORD`="raspberry"
             Set system `root` password. It's **STRONGLY** recommended that you choose a custom password.
             ##### `USER_PASSWORD`="raspberry"
             Set password for the created non-root user `USER_NAME`=pi. Ignored if `ENABLE_USER`=false. It's **STRONGLY** recommended that you choose a custom password.
             ##### `DEFLOCAL`="en_US.UTF-8"
             Set default system locale. This setting can also be changed inside the running OS using the `dpkg-reconfigure locales` command. Please note that on using this parameter the script will automatically install the required packages `locales`, `keyboard-configuration` and `console-setup`.
             ##### `TIMEZONE`="Europe/Berlin"
             Set default system timezone. All available timezones can be found in the `/usr/share/zoneinfo/` directory. This setting can also be changed inside the running OS using the `dpkg-reconfigure tzdata` command.
             ##### `EXPANDROOT`=true
             Expand the root partition and filesystem automatically on first boot.
             ##### `ENABLE_QEMU`=false
             Generate kernel (`vexpress_defconfig`), file system image (`qcow2`) and DTB files that can be used for QEMU full system emulation (`vexpress-A15`). The output files are stored in the `$(pwd)/images/qemu` directory. You can find more information about running the generated image in the QEMU section of this readme file.
             ---
             #### Keyboard settings:
             These options are used to configure keyboard layout in `/etc/default/keyboard` for console and Xorg. These settings can also be changed inside the running OS using the `dpkg-reconfigure keyboard-configuration` command.
             ##### `XKB_MODEL`=""
             Set the name of the model of your keyboard type.
             ##### `XKB_LAYOUT`=""
             Set the supported keyboard layout(s).
             ##### `XKB_VARIANT`=""
             Set the supported variant(s) of the keyboard layout(s).
             ##### `XKB_OPTIONS`=""
             Set extra xkb configuration options.
             ---
             #### Networking settings (DHCP):
             This parameter is used to set up networking auto configuration in `/etc/systemd/network/eth.network`. The default location of network configuration files in the Debian `stretch` release was changed to `/lib/systemd/network`.`
             ##### `ENABLE_DHCP`=true
             Set the system to use DHCP. This requires an DHCP server.
             ---
             #### Networking settings (static):
             These parameters are used to set up a static networking configuration in `/etc/systemd/network/eth.network`. The following static networking parameters are only supported if `ENABLE_DHCP` was set to `false`. The default location of network configuration files in the Debian `stretch` release was changed to `/lib/systemd/network`.
             ##### `NET_ADDRESS`=""
             Set a static IPv4 or IPv6 address and its prefix, separated by "/", eg. "192.169.0.3/24".
             ##### `NET_GATEWAY`=""
             Set the IP address for the default gateway.
             ##### `NET_DNS_1`=""
             Set the IP address for the first DNS server.
             ##### `NET_DNS_2`=""
             Set the IP address for the second DNS server.
             ##### `NET_DNS_DOMAINS`=""
             Set the default DNS search domains to use for non fully qualified host names.
             ##### `NET_NTP_1`=""
             Set the IP address for the first NTP server.
             ##### `NET_NTP_2`=""
             Set the IP address for the second NTP server.
             ---
             #### Basic system features:
             ##### `ENABLE_CONSOLE`=true
-            Enable serial console interface. Recommended if no monitor or keyboard is connected to the RPi2/3. In case of problems fe. if the network (auto) configuration failed - the serial console can be used to access the system.
+            Enable serial console interface. Recommended if no monitor or keyboard is connected to the RPi0/1/2/3. In case of problems fe. if the network (auto) configuration failed - the serial console can be used to access the system.
             ##### `ENABLE_I2C`=false
-            Enable I2C interface on the RPi2/3. Please check the [RPi2/3 pinout diagrams](https://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.
+            Enable I2C interface on the RPi0/1/2/3. Please check the [RPi0/1/2/3 pinout diagrams](https://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.
             ##### `ENABLE_SPI`=false
-            Enable SPI interface on the RPi2/3. Please check the [RPi2/3 pinout diagrams](https://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.
+            Enable SPI interface on the RPi0/1/2/3. Please check the [RPi0/1/2/3 pinout diagrams](https://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.
             ##### `ENABLE_IPV6`=true
             Enable IPv6 support. The network interface configuration is managed via systemd-networkd.
             ##### `ENABLE_SSHD`=true
             Install and enable OpenSSH service. The default configuration of the service doesn't allow `root` to login. Please use the user `pi` instead and `su -` or `sudo` to execute commands as root.
             ##### `ENABLE_NONFREE`=false
             Allow the installation of non-free Debian packages that do not comply with the DFSG. This is required to install closed-source firmware binary blobs.
             ##### `ENABLE_WIRELESS`=false
             Download and install the [closed-source firmware binary blob](https://github.com/RPi-Distro/firmware-nonfree/raw/master/brcm) that is required to run the internal wireless interface of the Raspberry Pi model `3`. This parameter is ignored if the specified `RPI_MODEL` is not `3`.
             ##### `ENABLE_RSYSLOG`=true
             If set to false, disable and uninstall rsyslog (so logs will be available only
             in journal files)
             ##### `ENABLE_SOUND`=true
             Enable sound hardware and install Advanced Linux Sound Architecture.
             ##### `ENABLE_HWRANDOM`=true
             Enable Hardware Random Number Generator. Strong random numbers are important for most network based communications that use encryption. It's recommended to be enabled.
             ##### `ENABLE_MINGPU`=false
             Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU.
             ##### `ENABLE_DBUS`=true
             Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled.
             ##### `ENABLE_XORG`=false
             Install Xorg open-source X Window System.
             ##### `ENABLE_WM`=""
             Install a user defined window manager for the X Window System. To make sure all X related package dependencies are getting installed `ENABLE_XORG` will automatically get enabled if `ENABLE_WM` is used. The `rpi23-gen-image.sh` script has been tested with the following list of window managers: `blackbox`, `openbox`, `fluxbox`, `jwm`, `dwm`, `xfce4`, `awesome`.
             ##### `ENABLE_SYSVINIT`=false
             Support for halt,init,poweroff,reboot,runlevel,shutdown,telinit commands
             ---
             #### Advanced system features:
             ##### `ENABLE_MINBASE`=false
             Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
             ##### `ENABLE_REDUCE`=false
             Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.
             ##### `ENABLE_UBOOT`=false
-            Replace the default RPi2/3 second stage bootloader (bootcode.bin) with [U-Boot bootloader](https://git.denx.de/?p=u-boot.git;a=summary). U-Boot can boot images via the network using the BOOTP/TFTP protocol.
+            Replace the default RPi0/1/2/3 second stage bootloader (bootcode.bin) with [U-Boot bootloader](https://git.denx.de/?p=u-boot.git;a=summary). U-Boot can boot images via the network using the BOOTP/TFTP protocol.
             ##### `UBOOTSRC_DIR`=""
             Path to a directory (`u-boot`) of [U-Boot bootloader sources](https://git.denx.de/?p=u-boot.git;a=summary) that will be copied, configured, build and installed inside the chroot.
             ##### `ENABLE_FBTURBO`=false
             Install and enable the [hardware accelerated Xorg video driver](https://github.com/ssvb/xf86-video-fbturbo) `fbturbo`. Please note that this driver is currently limited to hardware accelerated window moving and scrolling.
             ##### `FBTURBOSRC_DIR`=""
             Path to a directory (`xf86-video-fbturbo`) of [hardware accelerated Xorg video driver sources](https://github.com/ssvb/xf86-video-fbturbo) that will be copied, configured, build and installed inside the chroot.
             ##### `ENABLE_VIDEOCORE`=false
             Install and enable the [Source code for ARM side libraries for interfacing to Raspberry Pi GPU](https://github.com/raspberrypi/userland) `vcgencmd`. Please note that this driver is currently limited to hardware accelerated window moving and scrolling.
             ##### `VIDEOCORESRC_DIR`=""
             Path to a directory (`userland`) of [Source code for ARM side libraries for interfacing to Raspberry Pi GPU](https://github.com/raspberrypi/userland) that will be copied, configured, build and installed inside the chroot.
             ##### `ENABLE_IPTABLES`=false
             Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.
             ##### `ENABLE_USER`=true
             Create non-root user with password `USER_PASSWORD`=raspberry. Unless overridden with `USER_NAME`=user, username will be `pi`.
             ##### `USER_NAME`=pi
             Non-root user to create.  Ignored if `ENABLE_USER`=false
             ##### `ENABLE_ROOT`=false
             Set root user password so root login will be enabled
             ##### `ENABLE_HARDNET`=false
             Enable IPv4/IPv6 network stack hardening settings.
             ##### `ENABLE_SPLITFS`=false
             Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.
             ##### `CHROOT_SCRIPTS`=""
             Path to a directory with scripts that should be run in the chroot before the image is finally built. Every executable file in this directory is run in lexicographical order.
             ##### `ENABLE_INITRAMFS`=false
             Create an initramfs that that will be loaded during the Linux startup process. `ENABLE_INITRAMFS` will automatically get enabled if `ENABLE_CRYPTFS`=true. This parameter will be ignored if `BUILD_KERNEL`=false.
             ##### `ENABLE_IFNAMES`=true
             Enable automatic assignment of predictable, stable network interface names for all local Ethernet, WLAN interfaces. This might create complex and long interface names.
             ##### `DISABLE_UNDERVOLT_WARNINGS`=
             Disable RPi2/3 under-voltage warnings and overlays. Setting the parameter to `1` will disable the warning overlay. Setting it to `2` will additionally allow RPi2/3 turbo mode when low-voltage is present.
             ---
             #### SSH settings:
             ##### `SSH_ENABLE_ROOT`=false
             Enable password root login via SSH. This may be a security risk with default password, use only in trusted environments. `ENABLE_ROOT` must be set to `true`.
             ##### `SSH_DISABLE_PASSWORD_AUTH`=false
             Disable password based SSH authentication. Only public key based SSH (v2) authentication will be supported.
             ##### `SSH_LIMIT_USERS`=false
             Limit the users that are allowed to login via SSH. Only allow user `USER_NAME`=pi and root if `SSH_ENABLE_ROOT`=true to login. This parameter will be ignored if `dropbear` SSH is used (`REDUCE_SSHD`=true).
             ##### `SSH_ROOT_PUB_KEY`=""
             Add SSH (v2) public key(s) from specified file to `authorized_keys` file to enable public key based SSH (v2) authentication of user `root`. The specified file can also contain multiple SSH (v2) public keys. SSH protocol version 1 is not supported. `ENABLE_ROOT` **and** `SSH_ENABLE_ROOT` must be set to `true`.
             ##### `SSH_USER_PUB_KEY`=""
             Add SSH (v2) public key(s) from specified file to `authorized_keys` file to enable public key based SSH (v2) authentication of user `USER_NAME`=pi. The specified file can also contain multiple SSH (v2) public keys. SSH protocol version 1 is not supported.
             ---
             #### Kernel compilation:
             ##### `BUILD_KERNEL`=true
-            Build and install the latest RPi2/3 Linux kernel. Currently only the default RPi2/3 kernel configuration is used.
+            Build and install the latest RPi0/1/2/3 Linux kernel. Currently only the default RPi0/1/2/3 kernel configuration is used.
             ##### `CROSS_COMPILE`="arm-linux-gnueabihf-"
             This sets the cross compile enviornment for the compiler.
             ##### `KERNEL_ARCH`="arm"
             This sets the kernel architecture for the compiler.
             ##### `KERNEL_IMAGE`="kernel7.img"
             Name of the image file in the boot partition. If not set, `KERNEL_IMAGE` will be set to "kernel8.img" automatically if building for arm64.
             ##### `KERNEL_BRANCH`=""
             Name of the requested branch from the GIT location for the RPi Kernel. Default is using the current default branch from the GIT site.
             ##### `QEMU_BINARY`="/usr/bin/qemu-arm-static"
             Sets the QEMU enviornment for the Debian archive. If not set, `QEMU_BINARY` will be set to "/usr/bin/qemu-aarch64-static" automatically if building for arm64.
             ##### `KERNEL_DEFCONFIG`="bcm2709_defconfig"
             Sets the default config for kernel compiling. If not set, `KERNEL_DEFCONFIG` will be set to "bcmrpi3\_defconfig" automatically if building for arm64.
             ##### `KERNEL_REDUCE`=false
             Reduce the size of the generated kernel by removing unwanted device, network and filesystem drivers (experimental).
             ##### `KERNEL_THREADS`=1
             Number of parallel kernel building threads. If the parameter is left untouched the script will automatically determine the number of CPU cores to set the number of parallel threads to speed the kernel compilation.
             ##### `KERNEL_HEADERS`=true
             Install kernel headers with built kernel.
             ##### `KERNEL_MENUCONFIG`=false
             Start `make menuconfig` interactive menu-driven kernel configuration. The script will continue after `make menuconfig` was terminated.
             ##### `KERNEL_OLDDEFCONFIG`=false
             Run `make olddefconfig` to automatically set all new kernel configuration options to their recommended default values.
             ##### `KERNEL_CCACHE`=false
             Compile the kernel using ccache. This speeds up kernel recompilation by caching previous compilations and detecting when the same compilation is being done again.
             ##### `KERNEL_REMOVESRC`=true
             Remove all kernel sources from the generated OS image after it was built and installed.
             ##### `KERNELSRC_DIR`=""
             Path to a directory (`linux`) of [RaspberryPi Linux kernel sources](https://github.com/raspberrypi/linux) that will be copied, configured, build and installed inside the chroot.
             ##### `KERNELSRC_CLEAN`=false
             Clean the existing kernel sources directory `KERNELSRC_DIR` (using `make mrproper`) after it was copied to the chroot and before the compilation of the kernel has started. This parameter will be ignored if no `KERNELSRC_DIR` was specified or if `KERNELSRC_PREBUILT`=true.
             ##### `KERNELSRC_CONFIG`=true
             Run `make bcm2709_defconfig` (and optional `make menuconfig`) to configure the kernel sources before building. This parameter is automatically set to `true` if no existing kernel sources directory was specified using `KERNELSRC_DIR`. This parameter is ignored if `KERNELSRC_PREBUILT`=true.
             ##### `KERNELSRC_USRCONFIG`=""
             Copy own config file to kernel `.config`. If `KERNEL_MENUCONFIG`=true then running after copy.
             ##### `KERNELSRC_PREBUILT`=false
             With this parameter set to true the script expects the existing kernel sources directory to be already successfully cross-compiled. The parameters `KERNELSRC_CLEAN`, `KERNELSRC_CONFIG`, `KERNELSRC_USRCONFIG` and `KERNEL_MENUCONFIG` are ignored and no kernel compilation tasks are performed.
             ##### `RPI_FIRMWARE_DIR`=""
             The directory (`firmware`) containing a local copy of the firmware from the [RaspberryPi firmware project](https://github.com/raspberrypi/firmware). Default is to download the latest firmware directly from the project.
             ---
             #### Reduce disk usage:
             The following list of parameters is ignored if `ENABLE_REDUCE`=false.
             ##### `REDUCE_APT`=true
             Configure APT to use compressed package repository lists and no package caching files.
             ##### `REDUCE_DOC`=true
             Remove all doc files (harsh). Configure APT to not include doc files on future `apt-get` package installations.
             ##### `REDUCE_MAN`=true
             Remove all man pages and info files (harsh).  Configure APT to not include man pages on future `apt-get` package installations.
             ##### `REDUCE_VIM`=false
             Replace `vim-tiny` package by `levee` a tiny vim clone.
             ##### `REDUCE_BASH`=false
             Remove `bash` package and switch to `dash` shell (experimental).
             ##### `REDUCE_HWDB`=true
             Remove PCI related hwdb files (experimental).
             ##### `REDUCE_SSHD`=true
             Replace `openssh-server` with `dropbear`.
             ##### `REDUCE_LOCALE`=true
             Remove all `locale` translation files.
             ---
             #### Encrypted root partition:
             ##### `ENABLE_CRYPTFS`=false
             Enable full system encryption with dm-crypt. Setup a fully LUKS encrypted root partition (aes-xts-plain64:sha512) and generate required initramfs. The /boot directory will not be encrypted. This parameter will be ignored if `BUILD_KERNEL`=false. `ENABLE_CRYPTFS` is experimental. SSH-to-initramfs is currently not supported but will be soon - feel free to help.
             ##### `CRYPTFS_PASSWORD`=""
             Set password of the encrypted root partition. This parameter is mandatory if `ENABLE_CRYPTFS`=true.
             ##### `CRYPTFS_MAPPING`="secure"
             Set name of dm-crypt managed device-mapper mapping.
             ##### `CRYPTFS_CIPHER`="aes-xts-plain64:sha512"
             Set cipher specification string. `aes-xts*` ciphers are strongly recommended.
             ##### `CRYPTFS_XTSKEYSIZE`=512
             Sets key size in bits. The argument has to be a multiple of 8.
             ---
             #### Build settings:
             ##### `BASEDIR`=$(pwd)/images/${RELEASE}
             Set a path to a working directory used by the script to generate an image.
             ##### `IMAGE_NAME`=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}
             Set a filename for the output file(s). Note: the script will create $IMAGE_NAME.img if `ENABLE_SPLITFS`=false or $IMAGE_NAME-frmw.img and $IMAGE_NAME-root.img if `ENABLE_SPLITFS`=true. Note 2: If the KERNEL_BRANCH is not set, the word "CURRENT" is used.
             ## Understanding the script
             The functions of this script that are required for the different stages of the bootstrapping are split up into single files located inside the `bootstrap.d` directory. During the bootstrapping every script in this directory gets executed in lexicographical order:
             | Script | Description |
             | --- | --- |
             | `10-bootstrap.sh` | Debootstrap basic system |
             | `11-apt.sh` | Setup APT repositories |
             | `12-locale.sh` | Setup Locales and keyboard settings |
-            | `13-kernel.sh` | Build and install RPi2/3 Kernel |
+            | `13-kernel.sh` | Build and install RPi0/1/2/3 Kernel |
             | `14-fstab.sh` | Setup fstab and initramfs |
-            | `15-rpi-config.sh` | Setup RPi2/3 config and cmdline |
+            | `15-rpi-config.sh` | Setup RPi0/1/2/3 config and cmdline |
             | `20-networking.sh` | Setup Networking |
             | `21-firewall.sh` | Setup Firewall |
             | `30-security.sh` | Setup Users and Security settings |
             | `31-logging.sh` | Setup Logging |
             | `32-sshd.sh` | Setup SSH and public keys |
             | `41-uboot.sh` | Build and Setup U-Boot |
             | `42-fbturbo.sh` | Build and Setup fbturbo Xorg driver |
+            | `43-videocore.sh` | Build and Setup videocore libraries |
             | `50-firstboot.sh` | First boot actions |
             | `99-reduce.sh` | Reduce the disk space usage |
             All the required configuration files that will be copied to the generated OS image are located inside the `files` directory. It is not recommended to modify these configuration files manually.
             | Directory | Description |
             | --- | --- |
             | `apt` | APT management configuration files |
-            | `boot` | Boot and RPi2/3 configuration files |
+            | `boot` | Boot and RPi0/1/2/3 configuration files |
             | `dpkg` | Package Manager configuration |
             | `etc` | Configuration files and rc scripts |
             | `firstboot` | Scripts that get executed on first boot  |
             | `initramfs` | Initramfs scripts |
             | `iptables` | Firewall configuration files |
             | `locales` | Locales configuration |
             | `modules` | Kernel Modules configuration |
             | `mount` | Fstab configuration |
             | `network` | Networking configuration files |
             | `sysctl.d` | Swapping and Network Hardening configuration |
             | `xorg` | fbturbo Xorg driver configuration |
             ## Custom packages and scripts
             Debian custom packages, i.e. those not in the debian repositories, can be installed by placing them in the `packages` directory. They are installed immediately after packages from the repositories are installed. Any dependencies listed in the custom packages will be downloaded automatically from the repositories. Do not list these custom packages in `APT_INCLUDES`.
             Scripts in the custom.d directory will be executed after all other installation is complete but before the image is created.
             ## Logging of the bootstrapping process
             All information related to the bootstrapping process and the commands executed by the `rpi23-gen-image.sh` script can easily be saved into a logfile. The common shell command `script` can be used for this purpose:
             ```shell
             script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log
             ```
             ## Flashing the image file
-            After the image file was successfully created by the `rpi23-gen-image.sh` script it can be copied to the microSD card that will be used by the RPi2/3 computer. This can be performed by using the tools `bmaptool` or `dd`. Using `bmaptool` will probably speed-up the copy process because `bmaptool` copies more wisely than `dd`.
+            After the image file was successfully created by the `rpi23-gen-image.sh` script it can be copied to the microSD card that will be used by the RPi0/1/2/3 computer. This can be performed by using the tools `bmaptool` or `dd`. Using `bmaptool` will probably speed-up the copy process because `bmaptool` copies more wisely than `dd`.
             ##### Flashing examples:
             ```shell
             bmaptool copy ./images/buster/2017-01-23-rpi3-buster.img /dev/mmcblk0
             dd bs=4M if=./images/buster/2017-01-23-rpi3-buster.img of=/dev/mmcblk0
             ```
             If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:
             ```shell
             bmaptool copy ./images/buster/2017-01-23-rpi3-buster-frmw.img /dev/mmcblk0
             bmaptool copy ./images/buster/2017-01-23-rpi3-buster-root.img /dev/sdc
             ```
             ## QEMU emulation
             Start QEMU full system emulation:
             ```shell
             qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=tty1"
             ```
             Start QEMU full system emulation and output to console:
             ```shell
             qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio
             ```
             Start QEMU full system emulation with SMP and output to console:
             ```shell
             qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -smp cpus=2,maxcpus=2 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio
             ```
             Start QEMU full system emulation with cryptfs, initramfs and output to console:
             ```shell
             qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -initrd "initramfs-${KERNEL_VERSION}" -append "root=/dev/mapper/secure cryptdevice=/dev/mmcblk0p2:secure rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio
             ```
             ## External links and references
             * [Debian worldwide mirror sites](https://www.debian.org/mirror/list)
             * [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)
             * [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains)
             * [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)
             * [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)
             * [U-BOOT git repository](https://git.denx.de/?p=u-boot.git;a=summary)
             * [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)
             * [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/brcm)
             * [Collabora RPi2 Kernel precompiled](https://repositories.collabora.co.uk/debian/)