Raspi2-3_GenImage Commit - r262:7c50e57b8308 · 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 `jessie`, `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.11.y```).

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 `jessie`, `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.11.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) cross-compiler toolchain.

11

12

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

13

14

If a Debian Linux `jessie` build system is used it will be required to add the [Debian Cross-toolchains repository](http://emdebian.org/tools/debian/) first:

14

If a Debian Linux `jessie` build system is used it will be required to add the [Debian Cross-toolchains repository](http://emdebian.org/tools/debian/) first:

15

16

```

16

```

17

echo "deb http://emdebian.org/tools/debian/ jessie main" > /etc/apt/sources.list.d/crosstools.list

17

echo "deb http://emdebian.org/tools/debian/ jessie main" > /etc/apt/sources.list.d/crosstools.list

18

sudo -u nobody wget -O - http://emdebian.org/tools/debian/emdebian-toolchain-archive.key | apt-key add -

18

sudo -u nobody wget -O - http://emdebian.org/tools/debian/emdebian-toolchain-archive.key | apt-key add -

19

dpkg --add-architecture armhf

19

dpkg --add-architecture armhf

20

apt-get update

20

apt-get update

21

```

21

```

22

23

## Command-line parameters

23

## Command-line parameters

24

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.

24

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.

25

26

##### Command-line examples:

26

##### Command-line examples:

27

```shell

27

```shell

28

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

28

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

29

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

29

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

30

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

30

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

31

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

31

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

32

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

32

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

33

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

33

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

34

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

34

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

35

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

35

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

36

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

36

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

37

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

37

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

38

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

38

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

39

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

39

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

40

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

40

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

41

```

41

```

42

43

## Configuration template files

43

## Configuration template files

44

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.

44

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.

45

46

##### Command-line examples:

46

##### Command-line examples:

47

```shell

47

```shell

48

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

48

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

49

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

49

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

50

```

50

```

51

52

## Supported parameters and settings

52

## Supported parameters and settings

53

#### APT settings:

53

#### APT settings:

54

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

54

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

55

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.

55

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.

56

57

##### `APT_PROXY`=""

57

##### `APT_PROXY`=""

58

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.

58

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.

59

60

##### `APT_INCLUDES`=""

60

##### `APT_INCLUDES`=""

61

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

61

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

62

63

##### `APT_INCLUDES_LATE`=""

63

##### `APT_INCLUDES_LATE`=""

64

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.

64

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.

65

66

---

66

---

67

68

#### General system settings:

68

#### General system settings:

69

##### `RPI_MODEL`=2

69

##### `RPI_MODEL`=2

70

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

70

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

71

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

71

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

72

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

72

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

73

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

73

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

74

`2` = Used for Pi 2 model B

74

`2` = Used for Pi 2 model B

75

`3` = Used for Pi 3 model B

75

`3` = Used for Pi 3 model B

76

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

76

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

77

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

77

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

78

79

##### `RELEASE`="jessie"

79

##### `RELEASE`="jessie"

80

Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases "jessie", "stretch" and "buster". `BUILD_KERNEL`=true will automatically be set if the Debian releases `stretch` or `buster` are used.

80

Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases "jessie", "stretch" and "buster". `BUILD_KERNEL`=true will automatically be set if the Debian releases `stretch` or `buster` are used.

81

82

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

82

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

83

Set the desired Debian release architecture.

83

Set the desired Debian release architecture.

84

85

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

85

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

86

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

86

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

87

88

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

88

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

89

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

89

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

90

91

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

91

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

92

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.

92

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.

93

94

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

94

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

95

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`.

95

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`.

96

97

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

97

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

98

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.

98

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.

99

100

##### `EXPANDROOT`=true

100

##### `EXPANDROOT`=true

101

Expand the root partition and filesystem automatically on first boot.

101

Expand the root partition and filesystem automatically on first boot.

102

103

##### `ENABLE_QEMU`=true

104

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.

105

103

---

106

---

104

107

105

#### Keyboard settings:

108

#### Keyboard settings:

106

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.

109

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.

107

110

108

##### `XKB_MODEL`=""

111

##### `XKB_MODEL`=""

109

Set the name of the model of your keyboard type.

112

Set the name of the model of your keyboard type.

110

113

111

##### `XKB_LAYOUT`=""

114

##### `XKB_LAYOUT`=""

112

Set the supported keyboard layout(s).

115

Set the supported keyboard layout(s).

113

116

114

##### `XKB_VARIANT`=""

117

##### `XKB_VARIANT`=""

115

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

118

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

116

119

117

##### `XKB_OPTIONS`=""

120

##### `XKB_OPTIONS`=""

118

Set extra xkb configuration options.

121

Set extra xkb configuration options.

119

122

120

---

123

---

121

124

122

#### Networking settings (DHCP):

125

#### Networking settings (DHCP):

123

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`.`

126

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`.`

124

127

125

##### `ENABLE_DHCP`=true

128

##### `ENABLE_DHCP`=true

126

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

129

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

127

130

128

---

131

---

129

132

130

#### Networking settings (static):

133

#### Networking settings (static):

131

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`.

134

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`.

132

135

133

##### `NET_ADDRESS`=""

136

##### `NET_ADDRESS`=""

134

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

137

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

135

138

136

##### `NET_GATEWAY`=""

139

##### `NET_GATEWAY`=""

137

Set the IP address for the default gateway.

140

Set the IP address for the default gateway.

138

141

139

##### `NET_DNS_1`=""

142

##### `NET_DNS_1`=""

140

Set the IP address for the first DNS server.

143

Set the IP address for the first DNS server.

141

144

142

##### `NET_DNS_2`=""

145

##### `NET_DNS_2`=""

143

Set the IP address for the second DNS server.

146

Set the IP address for the second DNS server.

144

147

145

##### `NET_DNS_DOMAINS`=""

148

##### `NET_DNS_DOMAINS`=""

146

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

149

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

147

150

148

##### `NET_NTP_1`=""

151

##### `NET_NTP_1`=""

149

Set the IP address for the first NTP server.

152

Set the IP address for the first NTP server.

150

153

151

##### `NET_NTP_2`=""

154

##### `NET_NTP_2`=""

152

Set the IP address for the second NTP server.

155

Set the IP address for the second NTP server.

153

156

154

---

157

---

155

158

156

#### Basic system features:

159

#### Basic system features:

157

##### `ENABLE_CONSOLE`=true

160

##### `ENABLE_CONSOLE`=true

158

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.

161

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.

159

162

160

##### `ENABLE_I2C`=false

163

##### `ENABLE_I2C`=false

161

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.

164

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.

162

165

163

##### `ENABLE_SPI`=false

166

##### `ENABLE_SPI`=false

164

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.

167

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.

165

168

166

##### `ENABLE_IPV6`=true

169

##### `ENABLE_IPV6`=true

167

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

170

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

168

171

169

##### `ENABLE_SSHD`=true

172

##### `ENABLE_SSHD`=true

170

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.

173

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.

171

174

172

##### `ENABLE_NONFREE`=false

175

##### `ENABLE_NONFREE`=false

173

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.

176

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.

174

177

175

##### `ENABLE_WIRELESS`=false

178

##### `ENABLE_WIRELESS`=false

176

Download and install the [closed-source firmware binary blob](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/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`.

179

Download and install the [closed-source firmware binary blob](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/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`.

177

180

178

##### `ENABLE_RSYSLOG`=true

181

##### `ENABLE_RSYSLOG`=true

179

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

182

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

180

in journal files)

183

in journal files)

181

184

182

##### `ENABLE_SOUND`=true

185

##### `ENABLE_SOUND`=true

183

Enable sound hardware and install Advanced Linux Sound Architecture.

186

Enable sound hardware and install Advanced Linux Sound Architecture.

184

187

185

##### `ENABLE_HWRANDOM`=true

188

##### `ENABLE_HWRANDOM`=true

186

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

189

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

187

190

188

##### `ENABLE_MINGPU`=false

191

##### `ENABLE_MINGPU`=false

189

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

192

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

190

193

191

##### `ENABLE_DBUS`=true

194

##### `ENABLE_DBUS`=true

192

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

195

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

193

196

194

##### `ENABLE_XORG`=false

197

##### `ENABLE_XORG`=false

195

Install Xorg open-source X Window System.

198

Install Xorg open-source X Window System.

196

199

197

##### `ENABLE_WM`=""

200

##### `ENABLE_WM`=""

198

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`.

201

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`.

199

202

200

---

203

---

201

204

202

#### Advanced system features:

205

#### Advanced system features:

203

##### `ENABLE_MINBASE`=false

206

##### `ENABLE_MINBASE`=false

204

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

207

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

205

208

206

##### `ENABLE_REDUCE`=false

209

##### `ENABLE_REDUCE`=false

207

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

210

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

208

211

209

##### `ENABLE_UBOOT`=false

212

##### `ENABLE_UBOOT`=false

210

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.

213

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.

211

214

212

##### `UBOOTSRC_DIR`=""

215

##### `UBOOTSRC_DIR`=""

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.

216

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.

214

217

215

##### `ENABLE_FBTURBO`=false

218

##### `ENABLE_FBTURBO`=false

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.

219

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.

217

220

218

##### `FBTURBOSRC_DIR`=""

221

##### `FBTURBOSRC_DIR`=""

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.

222

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.

220

223

221

##### `ENABLE_IPTABLES`=false

224

##### `ENABLE_IPTABLES`=false

222

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

225

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

223

226

224

##### `ENABLE_USER`=true

227

##### `ENABLE_USER`=true

225

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

228

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

226

229

227

##### `USER_NAME`=pi

230

##### `USER_NAME`=pi

228

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

231

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

229

232

230

##### `ENABLE_ROOT`=false

233

##### `ENABLE_ROOT`=false

231

Set root user password so root login will be enabled

234

Set root user password so root login will be enabled

232

235

233

##### `ENABLE_HARDNET`=false

236

##### `ENABLE_HARDNET`=false

234

Enable IPv4/IPv6 network stack hardening settings.

237

Enable IPv4/IPv6 network stack hardening settings.

235

238

236

##### `ENABLE_SPLITFS`=false

239

##### `ENABLE_SPLITFS`=false

237

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

240

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

238

241

239

##### `CHROOT_SCRIPTS`=""

242

##### `CHROOT_SCRIPTS`=""

240

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.

243

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.

241

244

242

##### `ENABLE_INITRAMFS`=false

245

##### `ENABLE_INITRAMFS`=false

243

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.

246

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.

244

247

245

##### `ENABLE_IFNAMES`=true

248

##### `ENABLE_IFNAMES`=true

246

Enable automatic assignment of predictable, stable network interface names for all local Ethernet, WLAN interfaces. This might create complex and long interface names. This parameter is only supported if the Debian releases `stretch` or `buster` are used.

249

Enable automatic assignment of predictable, stable network interface names for all local Ethernet, WLAN interfaces. This might create complex and long interface names. This parameter is only supported if the Debian releases `stretch` or `buster` are used.

247

250

248

##### `DISABLE_UNDERVOLT_WARNINGS`=

251

##### `DISABLE_UNDERVOLT_WARNINGS`=

249

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.

252

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.

250

253

251

---

254

---

252

255

253

#### SSH settings:

256

#### SSH settings:

254

##### `SSH_ENABLE_ROOT`=false

257

##### `SSH_ENABLE_ROOT`=false

255

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`.

258

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`.

256

259

257

##### `SSH_DISABLE_PASSWORD_AUTH`=false

260

##### `SSH_DISABLE_PASSWORD_AUTH`=false

258

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

261

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

259

262

260

##### `SSH_LIMIT_USERS`=false

263

##### `SSH_LIMIT_USERS`=false

261

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).

264

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).

262

265

263

##### `SSH_ROOT_PUB_KEY`=""

266

##### `SSH_ROOT_PUB_KEY`=""

264

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`.

267

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`.

265

268

266

##### `SSH_USER_PUB_KEY`=""

269

##### `SSH_USER_PUB_KEY`=""

267

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.

270

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.

268

271

269

---

272

---

270

273

271

#### Kernel compilation:

274

#### Kernel compilation:

272

##### `BUILD_KERNEL`=false

275

##### `BUILD_KERNEL`=false

273

Build and install the latest RPi2/3 Linux kernel. Currently only the default RPi2/3 kernel configuration is used. `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` is used.

276

Build and install the latest RPi2/3 Linux kernel. Currently only the default RPi2/3 kernel configuration is used. `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` is used.

274

277

275

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

278

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

276

This sets the cross compile enviornment for the compiler.

279

This sets the cross compile enviornment for the compiler.

277

280

278

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

281

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

279

This sets the kernel architecture for the compiler.

282

This sets the kernel architecture for the compiler.

280

283

281

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

284

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

282

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.

285

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.

283

286

284

##### `KERNEL_BRANCH`=""

287

##### `KERNEL_BRANCH`=""

285

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

288

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

286

289

287

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

290

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

288

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.

291

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.

289

292

290

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

293

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

291

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

294

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

292

295

293

##### `KERNEL_REDUCE`=false

296

##### `KERNEL_REDUCE`=false

294

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

297

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

295

298

296

##### `KERNEL_THREADS`=1

299

##### `KERNEL_THREADS`=1

297

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.

300

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.

298

301

299

##### `KERNEL_HEADERS`=true

302

##### `KERNEL_HEADERS`=true

300

Install kernel headers with built kernel.

303

Install kernel headers with built kernel.

301

304

302

##### `KERNEL_MENUCONFIG`=false

305

##### `KERNEL_MENUCONFIG`=false

303

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

306

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

304

307

305

##### `KERNEL_OLDDEFCONFIG`=false

308

##### `KERNEL_OLDDEFCONFIG`=false

306

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

309

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

307

310

308

##### `KERNEL_CCACHE`=false

311

##### `KERNEL_CCACHE`=false

309

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

312

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

310

313

311

##### `KERNEL_REMOVESRC`=true

314

##### `KERNEL_REMOVESRC`=true

312

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

315

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

313

316

314

##### `KERNELSRC_DIR`=""

317

##### `KERNELSRC_DIR`=""

315

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.

318

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.

316

319

317

##### `KERNELSRC_CLEAN`=false

320

##### `KERNELSRC_CLEAN`=false

318

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.

321

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.

319

322

320

##### `KERNELSRC_CONFIG`=true

323

##### `KERNELSRC_CONFIG`=true

321

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.

324

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.

322

325

323

##### `KERNELSRC_USRCONFIG`=""

326

##### `KERNELSRC_USRCONFIG`=""

324

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

327

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

325

328

326

##### `KERNELSRC_PREBUILT`=false

329

##### `KERNELSRC_PREBUILT`=false

327

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.

330

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.

328

331

329

##### `RPI_FIRMWARE_DIR`=""

332

##### `RPI_FIRMWARE_DIR`=""

330

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.

333

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.

331

334

332

---

335

---

333

336

334

#### Reduce disk usage:

337

#### Reduce disk usage:

335

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

338

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

336

339

337

##### `REDUCE_APT`=true

340

##### `REDUCE_APT`=true

338

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

341

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

339

342

340

##### `REDUCE_DOC`=true

343

##### `REDUCE_DOC`=true

341

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

344

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

342

345

343

##### `REDUCE_MAN`=true

346

##### `REDUCE_MAN`=true

344

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

347

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

345

348

346

##### `REDUCE_VIM`=false

349

##### `REDUCE_VIM`=false

347

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

350

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

348

351

349

##### `REDUCE_BASH`=false

352

##### `REDUCE_BASH`=false

350

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

353

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

351

354

352

##### `REDUCE_HWDB`=true

355

##### `REDUCE_HWDB`=true

353

Remove PCI related hwdb files (experimental).

356

Remove PCI related hwdb files (experimental).

354

357

355

##### `REDUCE_SSHD`=true

358

##### `REDUCE_SSHD`=true

356

Replace `openssh-server` with `dropbear`.

359

Replace `openssh-server` with `dropbear`.

357

360

358

##### `REDUCE_LOCALE`=true

361

##### `REDUCE_LOCALE`=true

359

Remove all `locale` translation files.

362

Remove all `locale` translation files.

360

363

361

---

364

---

362

365

363

#### Encrypted root partition:

366

#### Encrypted root partition:

364

##### `ENABLE_CRYPTFS`=false

367

##### `ENABLE_CRYPTFS`=false

365

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.

368

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.

366

369

367

##### `CRYPTFS_PASSWORD`=""

370

##### `CRYPTFS_PASSWORD`=""

368

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

371

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

369

372

370

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

373

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

371

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

374

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

372

375

373

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

376

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

374

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

377

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

375

378

376

##### `CRYPTFS_XTSKEYSIZE`=512

379

##### `CRYPTFS_XTSKEYSIZE`=512

377

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

380

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

378

381

379

---

382

---

380

383

381

#### Build settings:

384

#### Build settings:

382

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

385

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

383

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

386

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

384

387

385

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

388

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

386

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.

389

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.

387

390

388

## Understanding the script

391

## Understanding the script

389

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:

392

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:

390

393

391

| Script | Description |

394

| Script | Description |

392

| --- | --- |

395

| --- | --- |

393

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

396

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

394

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

397

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

395

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

398

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

396

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

399

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

397

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

400

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

398

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

401

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

399

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

402

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

400

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

403

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

401

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

404

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

402

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

405

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

403

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

406

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

404

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

407

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

405

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

408

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

406

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

409

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

407

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

410

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

408

411

409

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.

412

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.

410

413

411

| Directory | Description |

414

| Directory | Description |

412

| --- | --- |

415

| --- | --- |

413

| `apt` | APT management configuration files |

416

| `apt` | APT management configuration files |

414

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

417

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

415

| `dpkg` | Package Manager configuration |

418

| `dpkg` | Package Manager configuration |

416

| `etc` | Configuration files and rc scripts |

419

| `etc` | Configuration files and rc scripts |

417

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

420

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

418

| `initramfs` | Initramfs scripts |

421

| `initramfs` | Initramfs scripts |

419

| `iptables` | Firewall configuration files |

422

| `iptables` | Firewall configuration files |

420

| `locales` | Locales configuration |

423

| `locales` | Locales configuration |

421

| `modules` | Kernel Modules configuration |

424

| `modules` | Kernel Modules configuration |

422

| `mount` | Fstab configuration |

425

| `mount` | Fstab configuration |

423

| `network` | Networking configuration files |

426

| `network` | Networking configuration files |

424

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

427

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

425

| `xorg` | fbturbo Xorg driver configuration |

428

| `xorg` | fbturbo Xorg driver configuration |

426

429

427

## Custom packages and scripts

430

## Custom packages and scripts

428

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`.

431

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`.

429

432

430

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

433

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

431

434

432

## Logging of the bootstrapping process

435

## Logging of the bootstrapping process

433

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:

436

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:

434

437

435

```shell

438

```shell

436

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

439

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

437

```

440

```

438

441

439

## Flashing the image file

442

## Flashing the image file

440

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`.

443

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`.

441

444

442

##### Flashing examples:

445

##### Flashing examples:

443

```shell

446

```shell

444

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

447

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

445

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

448

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

446

```

449

```

447

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

450

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

448

```shell

451

```shell

449

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

452

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

450

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

453

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

451

```

454

```

455

456

## QEMU emulation

457

Start QEMU full system emulation:

458

```shell

459

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"

460

```

461

462

Start QEMU full system emulation and output to console:

463

```shell

464

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

465

```

466

467

Start QEMU full system emulation with cryptfs, initramfs and output to console. (NOT WORKING yey!) :

468

```shell

469

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

470

```

471

452

## Weekly image builds

472

## Weekly image builds

453

The image files are provided by JRWR'S I/O PORT and are built once a Sunday at midnight UTC!

473

The image files are provided by JRWR'S I/O PORT and are built once a Sunday at midnight UTC!

454

* [Debian Stretch Raspberry Pi2/3 Weekly Image Builds](https://jrwr.io/doku.php?id=projects:debianpi)

474

* [Debian Stretch Raspberry Pi2/3 Weekly Image Builds](https://jrwr.io/doku.php?id=projects:debianpi)

455

475

456

## External links and references

476

## External links and references

457

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

477

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

458

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

478

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

459

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

479

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

460

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

480

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

461

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

481

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

462

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

482

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

463

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

483

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

464

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

484

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

465

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

485

* [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 `jessie`, `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.11.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.
             The script has been tested using the default `crossbuild-essential-armhf` toolchain meta package on Debian Linux `jessie` and `stretch` build systems. Please check the [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains) for further information.
             If a Debian Linux `jessie` build system is used it will be required to add the [Debian Cross-toolchains repository](http://emdebian.org/tools/debian/) first:
             ```
             echo "deb http://emdebian.org/tools/debian/ jessie main" > /etc/apt/sources.list.d/crosstools.list
             sudo -u nobody wget -O - http://emdebian.org/tools/debian/emdebian-toolchain-archive.key | apt-key add -
             dpkg --add-architecture armhf
             apt-get update
             ```
             ## 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.
             ##### `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:
             ##### `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`="jessie"
             Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases "jessie", "stretch" and "buster". `BUILD_KERNEL`=true will automatically be set if the Debian releases `stretch` or `buster` are used.
             ##### `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`=true
+            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_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_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_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/tree/master/brcm80211/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`.
             ---
             #### 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.
             ##### `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_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. This parameter is only supported if the Debian releases `stretch` or `buster` are used.
             ##### `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`=false
             Build and install the latest RPi2/3 Linux kernel. Currently only the default RPi2/3 kernel configuration is used. `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` 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 |
             | `14-fstab.sh` | Setup fstab and initramfs |
             | `15-rpi-config.sh` | Setup RPi2/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 |
             | `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 |
             | `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`.
             ##### Flashing examples:
             ```shell
             bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie.img /dev/mmcblk0
             dd bs=4M if=./images/jessie/2017-01-23-rpi3-jessie.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/jessie/2017-01-23-rpi3-jessie-frmw.img /dev/mmcblk0
             bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie-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 cryptfs, initramfs and output to console. (NOT WORKING yey!) :
+            ```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
+            ```
             ## Weekly image builds
             The image files are provided by JRWR'S I/O PORT and are built once a Sunday at midnight UTC!
             * [Debian Stretch Raspberry Pi2/3 Weekly Image Builds](https://jrwr.io/doku.php?id=projects:debianpi)
             ## 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/)