Raspi2-3_GenImage Commit - r309:5e9c128faa90 · 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 `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 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:

15

16

```

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 -

19

dpkg --add-architecture armhf

20

apt-get update

21

```

22

13

23

## Command-line parameters

14

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

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.

25

16

26

##### Command-line examples:

17

##### Command-line examples:

27

```shell

18

```shell

28

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

19

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

29

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

20

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

30

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

31

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

22

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

23

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

24

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

34

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

35

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

26

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

27

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

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

38

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

29

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

30

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

31

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

41

```

32

```

42

33

43

## Configuration template files

34

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

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.

45

36

46

##### Command-line examples:

37

##### Command-line examples:

47

```shell

38

```shell

48

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

39

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

49

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

40

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

50

```

41

```

51

42

52

## Supported parameters and settings

43

## Supported parameters and settings

53

#### APT settings:

44

#### APT settings:

54

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

45

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

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.

56

47

57

##### `APT_PROXY`=""

48

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

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.

59

50

60

##### `APT_INCLUDES`=""

51

##### `APT_INCLUDES`=""

61

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.

62

53

63

##### `APT_INCLUDES_LATE`=""

54

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

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.

65

56

66

---

57

---

67

58

68

#### General system settings:

59

#### General system settings:

69

##### `RPI_MODEL`=2

60

##### `RPI_MODEL`=2

70

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

61

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

62

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

72

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

63

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

73

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

64

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

74

`2` = Used for Pi 2 model B

65

`2` = Used for Pi 2 model B

75

`3` = Used for Pi 3 model B

66

`3` = Used for Pi 3 model B

76

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

67

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

68

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

78

69

79

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

70

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

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.

71

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

81

72

82

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

73

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

83

Set the desired Debian release architecture.

74

Set the desired Debian release architecture.

84

75

85

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

76

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

86

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

77

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

87

78

88

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

79

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

89

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

80

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

90

81

91

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

82

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

83

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

84

94

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

85

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

86

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

87

97

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

88

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

89

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

90

100

##### `EXPANDROOT`=true

91

##### `EXPANDROOT`=true

101

Expand the root partition and filesystem automatically on first boot.

92

Expand the root partition and filesystem automatically on first boot.

102

93

103

##### `ENABLE_QEMU`=false

94

##### `ENABLE_QEMU`=false

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.

95

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

96

106

---

97

---

107

98

108

#### Keyboard settings:

99

#### Keyboard settings:

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.

100

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.

110

101

111

##### `XKB_MODEL`=""

102

##### `XKB_MODEL`=""

112

Set the name of the model of your keyboard type.

103

Set the name of the model of your keyboard type.

113

104

114

##### `XKB_LAYOUT`=""

105

##### `XKB_LAYOUT`=""

115

Set the supported keyboard layout(s).

106

Set the supported keyboard layout(s).

116

107

117

##### `XKB_VARIANT`=""

108

##### `XKB_VARIANT`=""

118

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

109

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

119

110

120

##### `XKB_OPTIONS`=""

111

##### `XKB_OPTIONS`=""

121

Set extra xkb configuration options.

112

Set extra xkb configuration options.

122

113

123

---

114

---

124

115

125

#### Networking settings (DHCP):

116

#### Networking settings (DHCP):

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

117

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

127

118

128

##### `ENABLE_DHCP`=true

119

##### `ENABLE_DHCP`=true

129

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

120

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

130

121

131

---

122

---

132

123

133

#### Networking settings (static):

124

#### Networking settings (static):

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

125

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

135

126

136

##### `NET_ADDRESS`=""

127

##### `NET_ADDRESS`=""

137

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

128

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

138

129

139

##### `NET_GATEWAY`=""

130

##### `NET_GATEWAY`=""

140

Set the IP address for the default gateway.

131

Set the IP address for the default gateway.

141

132

142

##### `NET_DNS_1`=""

133

##### `NET_DNS_1`=""

143

Set the IP address for the first DNS server.

134

Set the IP address for the first DNS server.

144

135

145

##### `NET_DNS_2`=""

136

##### `NET_DNS_2`=""

146

Set the IP address for the second DNS server.

137

Set the IP address for the second DNS server.

147

138

148

##### `NET_DNS_DOMAINS`=""

139

##### `NET_DNS_DOMAINS`=""

149

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

140

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

150

141

151

##### `NET_NTP_1`=""

142

##### `NET_NTP_1`=""

152

Set the IP address for the first NTP server.

143

Set the IP address for the first NTP server.

153

144

154

##### `NET_NTP_2`=""

145

##### `NET_NTP_2`=""

155

Set the IP address for the second NTP server.

146

Set the IP address for the second NTP server.

156

147

157

---

148

---

158

149

159

#### Basic system features:

150

#### Basic system features:

160

##### `ENABLE_CONSOLE`=true

151

##### `ENABLE_CONSOLE`=true

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.

152

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.

162

153

163

##### `ENABLE_I2C`=false

154

##### `ENABLE_I2C`=false

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.

155

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.

165

156

166

##### `ENABLE_SPI`=false

157

##### `ENABLE_SPI`=false

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.

158

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.

168

159

169

##### `ENABLE_IPV6`=true

160

##### `ENABLE_IPV6`=true

170

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

161

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

171

162

172

##### `ENABLE_SSHD`=true

163

##### `ENABLE_SSHD`=true

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.

164

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.

174

165

175

##### `ENABLE_NONFREE`=false

166

##### `ENABLE_NONFREE`=false

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.

167

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.

177

168

178

##### `ENABLE_WIRELESS`=false

169

##### `ENABLE_WIRELESS`=false

179

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

170

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

180

171

181

##### `ENABLE_RSYSLOG`=true

172

##### `ENABLE_RSYSLOG`=true

182

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

173

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

183

in journal files)

174

in journal files)

184

175

185

##### `ENABLE_SOUND`=true

176

##### `ENABLE_SOUND`=true

186

Enable sound hardware and install Advanced Linux Sound Architecture.

177

Enable sound hardware and install Advanced Linux Sound Architecture.

187

178

188

##### `ENABLE_HWRANDOM`=true

179

##### `ENABLE_HWRANDOM`=true

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.

180

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

190

181

191

##### `ENABLE_MINGPU`=false

182

##### `ENABLE_MINGPU`=false

192

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

183

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

193

184

194

##### `ENABLE_DBUS`=true

185

##### `ENABLE_DBUS`=true

195

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

186

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

196

187

197

##### `ENABLE_XORG`=false

188

##### `ENABLE_XORG`=false

198

Install Xorg open-source X Window System.

189

Install Xorg open-source X Window System.

199

190

200

##### `ENABLE_WM`=""

191

##### `ENABLE_WM`=""

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

192

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

202

193

203

---

194

---

204

195

205

#### Advanced system features:

196

#### Advanced system features:

206

##### `ENABLE_MINBASE`=false

197

##### `ENABLE_MINBASE`=false

207

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

198

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

208

199

209

##### `ENABLE_REDUCE`=false

200

##### `ENABLE_REDUCE`=false

210

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

201

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

211

202

212

##### `ENABLE_UBOOT`=false

203

##### `ENABLE_UBOOT`=false

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.

204

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.

214

205

215

##### `UBOOTSRC_DIR`=""

206

##### `UBOOTSRC_DIR`=""

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.

207

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.

217

208

218

##### `ENABLE_FBTURBO`=false

209

##### `ENABLE_FBTURBO`=false

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.

210

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.

220

211

221

##### `FBTURBOSRC_DIR`=""

212

##### `FBTURBOSRC_DIR`=""

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.

213

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.

223

214

224

##### `ENABLE_IPTABLES`=false

215

##### `ENABLE_IPTABLES`=false

225

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

216

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

226

217

227

##### `ENABLE_USER`=true

218

##### `ENABLE_USER`=true

228

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

219

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

229

220

230

##### `USER_NAME`=pi

221

##### `USER_NAME`=pi

231

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

222

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

232

223

233

##### `ENABLE_ROOT`=false

224

##### `ENABLE_ROOT`=false

234

Set root user password so root login will be enabled

225

Set root user password so root login will be enabled

235

226

236

##### `ENABLE_HARDNET`=false

227

##### `ENABLE_HARDNET`=false

237

Enable IPv4/IPv6 network stack hardening settings.

228

Enable IPv4/IPv6 network stack hardening settings.

238

229

239

##### `ENABLE_SPLITFS`=false

230

##### `ENABLE_SPLITFS`=false

240

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

231

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

241

232

242

##### `CHROOT_SCRIPTS`=""

233

##### `CHROOT_SCRIPTS`=""

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.

234

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.

244

235

245

##### `ENABLE_INITRAMFS`=false

236

##### `ENABLE_INITRAMFS`=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.

237

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.

247

238

248

##### `ENABLE_IFNAMES`=true

239

##### `ENABLE_IFNAMES`=true

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.

240

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.

250

241

251

##### `DISABLE_UNDERVOLT_WARNINGS`=

242

##### `DISABLE_UNDERVOLT_WARNINGS`=

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.

243

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.

253

244

254

---

245

---

255

246

256

#### SSH settings:

247

#### SSH settings:

257

##### `SSH_ENABLE_ROOT`=false

248

##### `SSH_ENABLE_ROOT`=false

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

249

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

259

250

260

##### `SSH_DISABLE_PASSWORD_AUTH`=false

251

##### `SSH_DISABLE_PASSWORD_AUTH`=false

261

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

252

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

262

253

263

##### `SSH_LIMIT_USERS`=false

254

##### `SSH_LIMIT_USERS`=false

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

255

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

265

256

266

##### `SSH_ROOT_PUB_KEY`=""

257

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

258

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

268

259

269

##### `SSH_USER_PUB_KEY`=""

260

##### `SSH_USER_PUB_KEY`=""

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.

261

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.

271

262

272

---

263

---

273

264

274

#### Kernel compilation:

265

#### Kernel compilation:

275

##### `BUILD_KERNEL`=false

266

##### `BUILD_KERNEL`=false

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.

267

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.

277

268

278

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

269

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

279

This sets the cross compile enviornment for the compiler.

270

This sets the cross compile enviornment for the compiler.

280

271

281

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

272

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

282

This sets the kernel architecture for the compiler.

273

This sets the kernel architecture for the compiler.

283

274

284

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

275

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

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.

276

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.

286

277

287

##### `KERNEL_BRANCH`=""

278

##### `KERNEL_BRANCH`=""

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.

279

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

289

280

290

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

281

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

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.

282

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.

292

283

293

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

284

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

294

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

285

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

295

286

296

##### `KERNEL_REDUCE`=false

287

##### `KERNEL_REDUCE`=false

297

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

288

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

298

289

299

##### `KERNEL_THREADS`=1

290

##### `KERNEL_THREADS`=1

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.

291

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.

301

292

302

##### `KERNEL_HEADERS`=true

293

##### `KERNEL_HEADERS`=true

303

Install kernel headers with built kernel.

294

Install kernel headers with built kernel.

304

295

305

##### `KERNEL_MENUCONFIG`=false

296

##### `KERNEL_MENUCONFIG`=false

306

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

297

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

307

298

308

##### `KERNEL_OLDDEFCONFIG`=false

299

##### `KERNEL_OLDDEFCONFIG`=false

309

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

300

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

310

301

311

##### `KERNEL_CCACHE`=false

302

##### `KERNEL_CCACHE`=false

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.

303

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

313

304

314

##### `KERNEL_REMOVESRC`=true

305

##### `KERNEL_REMOVESRC`=true

315

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

306

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

316

307

317

##### `KERNELSRC_DIR`=""

308

##### `KERNELSRC_DIR`=""

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.

309

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.

319

310

320

##### `KERNELSRC_CLEAN`=false

311

##### `KERNELSRC_CLEAN`=false

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.

312

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.

322

313

323

##### `KERNELSRC_CONFIG`=true

314

##### `KERNELSRC_CONFIG`=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.

315

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.

325

316

326

##### `KERNELSRC_USRCONFIG`=""

317

##### `KERNELSRC_USRCONFIG`=""

327

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

318

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

328

319

329

##### `KERNELSRC_PREBUILT`=false

320

##### `KERNELSRC_PREBUILT`=false

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.

321

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.

331

322

332

##### `RPI_FIRMWARE_DIR`=""

323

##### `RPI_FIRMWARE_DIR`=""

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.

324

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.

334

325

335

---

326

---

336

327

337

#### Reduce disk usage:

328

#### Reduce disk usage:

338

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

329

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

339

330

340

##### `REDUCE_APT`=true

331

##### `REDUCE_APT`=true

341

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

332

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

342

333

343

##### `REDUCE_DOC`=true

334

##### `REDUCE_DOC`=true

344

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

335

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

345

336

346

##### `REDUCE_MAN`=true

337

##### `REDUCE_MAN`=true

347

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

338

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

348

339

349

##### `REDUCE_VIM`=false

340

##### `REDUCE_VIM`=false

350

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

341

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

351

342

352

##### `REDUCE_BASH`=false

343

##### `REDUCE_BASH`=false

353

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

344

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

354

345

355

##### `REDUCE_HWDB`=true

346

##### `REDUCE_HWDB`=true

356

Remove PCI related hwdb files (experimental).

347

Remove PCI related hwdb files (experimental).

357

348

358

##### `REDUCE_SSHD`=true

349

##### `REDUCE_SSHD`=true

359

Replace `openssh-server` with `dropbear`.

350

Replace `openssh-server` with `dropbear`.

360

351

361

##### `REDUCE_LOCALE`=true

352

##### `REDUCE_LOCALE`=true

362

Remove all `locale` translation files.

353

Remove all `locale` translation files.

363

354

364

---

355

---

365

356

366

#### Encrypted root partition:

357

#### Encrypted root partition:

367

##### `ENABLE_CRYPTFS`=false

358

##### `ENABLE_CRYPTFS`=false

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.

359

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.

369

360

370

##### `CRYPTFS_PASSWORD`=""

361

##### `CRYPTFS_PASSWORD`=""

371

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

362

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

372

363

373

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

364

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

374

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

365

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

375

366

376

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

367

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

377

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

368

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

378

369

379

##### `CRYPTFS_XTSKEYSIZE`=512

370

##### `CRYPTFS_XTSKEYSIZE`=512

380

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

371

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

381

372

382

---

373

---

383

374

384

#### Build settings:

375

#### Build settings:

385

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

376

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

386

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

377

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

387

378

388

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

379

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

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.

380

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.

390

381

391

## Understanding the script

382

## Understanding the script

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:

383

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:

393

384

394

| Script | Description |

385

| Script | Description |

395

| --- | --- |

386

| --- | --- |

396

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

387

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

397

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

388

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

398

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

389

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

399

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

390

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

400

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

391

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

401

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

392

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

402

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

393

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

403

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

394

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

404

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

395

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

405

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

396

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

406

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

397

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

407

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

398

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

408

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

399

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

409

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

400

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

410

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

401

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

411

402

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.

403

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.

413

404

414

| Directory | Description |

405

| Directory | Description |

415

| --- | --- |

406

| --- | --- |

416

| `apt` | APT management configuration files |

407

| `apt` | APT management configuration files |

417

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

408

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

418

| `dpkg` | Package Manager configuration |

409

| `dpkg` | Package Manager configuration |

419

| `etc` | Configuration files and rc scripts |

410

| `etc` | Configuration files and rc scripts |

420

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

411

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

421

| `initramfs` | Initramfs scripts |

412

| `initramfs` | Initramfs scripts |

422

| `iptables` | Firewall configuration files |

413

| `iptables` | Firewall configuration files |

423

| `locales` | Locales configuration |

414

| `locales` | Locales configuration |

424

| `modules` | Kernel Modules configuration |

415

| `modules` | Kernel Modules configuration |

425

| `mount` | Fstab configuration |

416

| `mount` | Fstab configuration |

426

| `network` | Networking configuration files |

417

| `network` | Networking configuration files |

427

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

418

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

428

| `xorg` | fbturbo Xorg driver configuration |

419

| `xorg` | fbturbo Xorg driver configuration |

429

420

430

## Custom packages and scripts

421

## Custom packages and scripts

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

422

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

432

423

433

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

424

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

434

425

435

## Logging of the bootstrapping process

426

## Logging of the bootstrapping process

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:

427

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:

437

428

438

```shell

429

```shell

439

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

430

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

440

```

431

```

441

432

442

## Flashing the image file

433

## Flashing the image file

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

434

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

444

435

445

##### Flashing examples:

436

##### Flashing examples:

446

```shell

437

```shell

447

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

438

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

448

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

439

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

449

```

440

```

450

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

441

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

451

```shell

442

```shell

452

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

443

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

453

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

444

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

454

```

445

```

455

446

456

## QEMU emulation

447

## QEMU emulation

457

Start QEMU full system emulation:

448

Start QEMU full system emulation:

458

```shell

449

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

450

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

```

451

```

461

452

462

Start QEMU full system emulation and output to console:

453

Start QEMU full system emulation and output to console:

463

```shell

454

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

455

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

```

456

```

466

457

467

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

458

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

468

```shell

459

```shell

469

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

460

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

470

```

461

```

471

462

472

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

463

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

473

```shell

464

```shell

474

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

465

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

475

```

466

```

476

467

477

## Weekly image builds

468

## Weekly image builds

478

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

469

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

479

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

470

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

480

471

481

## External links and references

472

## External links and references

482

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

473

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

483

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

474

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

484

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

475

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

485

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

476

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

486

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

477

* [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)

478

* [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)

479

* [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)

480

* [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/)

481

* [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```).
+            `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.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.
+            The script has been tested using the default `crossbuild-essential-armhf` toolchain meta package on Debian Linux 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"
+            ##### `RELEASE`="buster"
-            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.
+            Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases "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`=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_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/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`.
             ---
             #### 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 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
             ```
             ## 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/)