Raspi2-3_GenImage Commit - r168:a11a812e7852 · 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` and `stretch`. Raspberry Pi 3 images are currently generated for 32-bit mode only.

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` and `stretch`. Raspberry Pi 3 images are currently generated for 32-bit mode only.

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 mandetory. 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 mandetory. Kernel compilation and linking will be performed on the build system using an ARM (armhf) cross-compiler toolchain.

11

12

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

12

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

13

14

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

14

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

15

16

```

16

```

17

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

17

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

18

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

18

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

19

dpkg --add-architecture armhf

19

dpkg --add-architecture armhf

20

apt-get update

20

apt-get update

21

```

21

```

22

23

## Command-line parameters

23

## Command-line parameters

24

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

24

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

25

26

#####Command-line examples:

26

#####Command-line examples:

27

```shell

27

```shell

28

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

28

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

29

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

29

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

30

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

30

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

31

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

31

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

32

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

32

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

33

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

33

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

34

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

34

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

35

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

35

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

36

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

36

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

37

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

37

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

38

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

38

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

39

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

39

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

40

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

40

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

41

```

41

```

42

43

## Configuration template files

43

## Configuration template files

44

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

44

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

45

46

#####Command-line examples:

46

#####Command-line examples:

47

```shell

47

```shell

48

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

48

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

49

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

49

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

50

```

50

```

51

52

## Supported parameters and settings

52

## Supported parameters and settings

53

#### APT settings:

53

#### APT settings:

54

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

54

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

55

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

55

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

56

57

##### `APT_PROXY`=""

57

##### `APT_PROXY`=""

58

Set Proxy server address. Using a local Proxy-Cache like `apt-cacher-ng` will speed-up the bootstrapping process because all required Debian packages will only be downloaded from the Debian mirror site once.

58

Set Proxy server address. Using a local Proxy-Cache like `apt-cacher-ng` will speed-up the bootstrapping process because all required Debian packages will only be downloaded from the Debian mirror site once.

59

60

##### `APT_INCLUDES`=""

60

##### `APT_INCLUDES`=""

61

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

61

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

62

63

---

63

---

64

65

#### General system settings:

65

#### General system settings:

66

##### `RPI_MODEL`=2

66

##### `RPI_MODEL`=2

67

Specifiy the target Raspberry Pi hardware model. The script at this time supports the Raspberry Pi models `2` and `3`. `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` is used.

67

Specifiy the target Raspberry Pi hardware model. The script at this time supports the Raspberry Pi models `2` and `3`. `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` is used.

68

69

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

69

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

70

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

70

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

71

72

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

73

Set the desired Debian release architecture.

74

72

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

75

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

73

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

76

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

74

77

75

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

78

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

76

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

79

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

77

80

78

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

81

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

79

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.

82

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.

80

83

81

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

84

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

82

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

85

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

83

86

84

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

87

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

85

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.

88

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.

86

89

87

##### `EXPANDROOT`=true

90

##### `EXPANDROOT`=true

88

Expand the root partition and filesystem automatically on first boot.

91

Expand the root partition and filesystem automatically on first boot.

89

92

90

---

93

---

91

94

92

#### Keyboard settings:

95

#### Keyboard settings:

93

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.

96

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.

94

97

95

##### `XKB_MODEL`=""

98

##### `XKB_MODEL`=""

96

Set the name of the model of your keyboard type.

99

Set the name of the model of your keyboard type.

97

100

98

##### `XKB_LAYOUT`=""

101

##### `XKB_LAYOUT`=""

99

Set the supported keyboard layout(s).

102

Set the supported keyboard layout(s).

100

103

101

##### `XKB_VARIANT`=""

104

##### `XKB_VARIANT`=""

102

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

105

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

103

106

104

##### `XKB_OPTIONS`=""

107

##### `XKB_OPTIONS`=""

105

Set extra xkb configuration options.

108

Set extra xkb configuration options.

106

109

107

---

110

---

108

111

109

#### Networking settings (DHCP):

112

#### Networking settings (DHCP):

110

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

113

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

111

114

112

#####`ENABLE_DHCP`=true

115

#####`ENABLE_DHCP`=true

113

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

116

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

114

117

115

---

118

---

116

119

117

#### Networking settings (static):

120

#### Networking settings (static):

118

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

121

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

119

122

120

#####`NET_ADDRESS`=""

123

#####`NET_ADDRESS`=""

121

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

124

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

122

125

123

#####`NET_GATEWAY`=""

126

#####`NET_GATEWAY`=""

124

Set the IP address for the default gateway.

127

Set the IP address for the default gateway.

125

128

126

#####`NET_DNS_1`=""

129

#####`NET_DNS_1`=""

127

Set the IP address for the first DNS server.

130

Set the IP address for the first DNS server.

128

131

129

#####`NET_DNS_2`=""

132

#####`NET_DNS_2`=""

130

Set the IP address for the second DNS server.

133

Set the IP address for the second DNS server.

131

134

132

#####`NET_DNS_DOMAINS`=""

135

#####`NET_DNS_DOMAINS`=""

133

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

136

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

134

137

135

#####`NET_NTP_1`=""

138

#####`NET_NTP_1`=""

136

Set the IP address for the first NTP server.

139

Set the IP address for the first NTP server.

137

140

138

#####`NET_NTP_2`=""

141

#####`NET_NTP_2`=""

139

Set the IP address for the second NTP server.

142

Set the IP address for the second NTP server.

140

143

141

---

144

---

142

145

143

#### Basic system features:

146

#### Basic system features:

144

##### `ENABLE_CONSOLE`=true

147

##### `ENABLE_CONSOLE`=true

145

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.

148

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.

146

149

147

##### `ENABLE_I2C`=false

150

##### `ENABLE_I2C`=false

148

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

151

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

149

152

150

##### `ENABLE_SPI`=false

153

##### `ENABLE_SPI`=false

151

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

154

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

152

155

153

##### `ENABLE_IPV6`=true

156

##### `ENABLE_IPV6`=true

154

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

157

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

155

158

156

##### `ENABLE_SSHD`=true

159

##### `ENABLE_SSHD`=true

157

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.

160

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.

158

161

159

##### `ENABLE_NONFREE`=false

162

##### `ENABLE_NONFREE`=false

160

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.

163

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.

161

164

162

##### `ENABLE_WIRELESS`=false

165

##### `ENABLE_WIRELESS`=false

163

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

166

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

164

167

165

##### `ENABLE_RSYSLOG`=true

168

##### `ENABLE_RSYSLOG`=true

166

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

169

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

167

in journal files)

170

in journal files)

168

171

169

##### `ENABLE_SOUND`=true

172

##### `ENABLE_SOUND`=true

170

Enable sound hardware and install Advanced Linux Sound Architecture.

173

Enable sound hardware and install Advanced Linux Sound Architecture.

171

174

172

##### `ENABLE_HWRANDOM`=true

175

##### `ENABLE_HWRANDOM`=true

173

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

176

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

174

177

175

##### `ENABLE_MINGPU`=false

178

##### `ENABLE_MINGPU`=false

176

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

179

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

177

180

178

##### `ENABLE_DBUS`=true

181

##### `ENABLE_DBUS`=true

179

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

182

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

180

183

181

##### `ENABLE_XORG`=false

184

##### `ENABLE_XORG`=false

182

Install Xorg open-source X Window System.

185

Install Xorg open-source X Window System.

183

186

184

##### `ENABLE_WM`=""

187

##### `ENABLE_WM`=""

185

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

188

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

186

189

187

---

190

---

188

191

189

#### Advanced system features:

192

#### Advanced system features:

190

##### `ENABLE_MINBASE`=false

193

##### `ENABLE_MINBASE`=false

191

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

194

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

192

195

193

##### `ENABLE_REDUCE`=false

196

##### `ENABLE_REDUCE`=false

194

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

197

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

195

198

196

##### `ENABLE_UBOOT`=false

199

##### `ENABLE_UBOOT`=false

197

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

200

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

198

201

199

##### `UBOOTSRC_DIR`=""

202

##### `UBOOTSRC_DIR`=""

200

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

203

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

201

204

202

##### `ENABLE_FBTURBO`=false

205

##### `ENABLE_FBTURBO`=false

203

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.

206

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.

204

207

205

##### `FBTURBOSRC_DIR`=""

208

##### `FBTURBOSRC_DIR`=""

206

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.

209

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.

207

210

208

##### `ENABLE_IPTABLES`=false

211

##### `ENABLE_IPTABLES`=false

209

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

212

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

210

213

211

##### `ENABLE_USER`=true

214

##### `ENABLE_USER`=true

212

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

215

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

213

216

214

##### `USER_NAME`=pi

217

##### `USER_NAME`=pi

215

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

218

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

216

219

217

##### `ENABLE_ROOT`=false

220

##### `ENABLE_ROOT`=false

218

Set root user password so root login will be enabled

221

Set root user password so root login will be enabled

219

222

220

##### `ENABLE_HARDNET`=false

223

##### `ENABLE_HARDNET`=false

221

Enable IPv4/IPv6 network stack hardening settings.

224

Enable IPv4/IPv6 network stack hardening settings.

222

225

223

##### `ENABLE_SPLITFS`=false

226

##### `ENABLE_SPLITFS`=false

224

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

227

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

225

228

226

##### `CHROOT_SCRIPTS`=""

229

##### `CHROOT_SCRIPTS`=""

227

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.

230

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.

228

231

229

##### `ENABLE_INITRAMFS`=false

232

##### `ENABLE_INITRAMFS`=false

230

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.

233

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.

231

234

232

##### `ENABLE_IFNAMES`=true

235

##### `ENABLE_IFNAMES`=true

233

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 release `stretch` is used.

236

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 release `stretch` is used.

234

237

235

##### `DISABLE_UNDERVOLT_WARNINGS`=

238

##### `DISABLE_UNDERVOLT_WARNINGS`=

236

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.

239

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.

237

240

238

---

241

---

239

242

240

#### SSH settings:

243

#### SSH settings:

241

##### `SSH_ENABLE_ROOT`=false

244

##### `SSH_ENABLE_ROOT`=false

242

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

245

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

243

246

244

##### `SSH_DISABLE_PASSWORD_AUTH`=false

247

##### `SSH_DISABLE_PASSWORD_AUTH`=false

245

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

248

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

246

249

247

##### `SSH_LIMIT_USERS`=false

250

##### `SSH_LIMIT_USERS`=false

248

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

251

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

249

252

250

##### `SSH_ROOT_PUB_KEY`=""

253

##### `SSH_ROOT_PUB_KEY`=""

251

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

254

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

252

255

253

##### `SSH_USER_PUB_KEY`=""

256

##### `SSH_USER_PUB_KEY`=""

254

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.

257

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.

255

258

256

---

259

---

257

260

258

#### Kernel compilation:

261

#### Kernel compilation:

259

##### `BUILD_KERNEL`=false

262

##### `BUILD_KERNEL`=false

260

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.

263

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.

261

264

265

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

266

This sets the cross compile enviornment for the compiler.

267

268

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

269

This sets the kernel architecture for the compiler.

270

271

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

272

Name of the image file in the boot partition.

273

274

##### `KERNEL_BRANCH`=""

275

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

276

277

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

278

Sets the QEMU enviornment for the Debian archive.

279

280

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

281

Sets the default config for kernel compiling.

282

262

##### `KERNEL_REDUCE`=false

283

##### `KERNEL_REDUCE`=false

263

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

284

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

264

285

265

##### `KERNEL_THREADS`=1

286

##### `KERNEL_THREADS`=1

266

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.

287

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.

267

288

268

##### `KERNEL_HEADERS`=true

289

##### `KERNEL_HEADERS`=true

269

Install kernel headers with built kernel.

290

Install kernel headers with built kernel.

270

291

271

##### `KERNEL_MENUCONFIG`=false

292

##### `KERNEL_MENUCONFIG`=false

272

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

293

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

273

294

274

##### `KERNEL_REMOVESRC`=true

295

##### `KERNEL_REMOVESRC`=true

275

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

296

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

276

297

277

##### `KERNELSRC_DIR`=""

298

##### `KERNELSRC_DIR`=""

278

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.

299

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.

279

300

280

##### `KERNELSRC_CLEAN`=false

301

##### `KERNELSRC_CLEAN`=false

281

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.

302

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.

282

303

283

##### `KERNELSRC_CONFIG`=true

304

##### `KERNELSRC_CONFIG`=true

284

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.

305

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.

285

306

286

##### `KERNELSRC_USRCONFIG`=""

307

##### `KERNELSRC_USRCONFIG`=""

287

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

308

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

288

309

289

##### `KERNELSRC_PREBUILT`=false

310

##### `KERNELSRC_PREBUILT`=false

290

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.

311

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.

291

312

292

##### `RPI_FIRMWARE_DIR`=""

313

##### `RPI_FIRMWARE_DIR`=""

293

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.

314

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.

294

315

295

---

316

---

296

317

297

#### Reduce disk usage:

318

#### Reduce disk usage:

298

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

319

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

299

320

300

##### `REDUCE_APT`=true

321

##### `REDUCE_APT`=true

301

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

322

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

302

323

303

##### `REDUCE_DOC`=true

324

##### `REDUCE_DOC`=true

304

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

325

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

305

326

306

##### `REDUCE_MAN`=true

327

##### `REDUCE_MAN`=true

307

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

328

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

308

329

309

##### `REDUCE_VIM`=false

330

##### `REDUCE_VIM`=false

310

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

331

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

311

332

312

##### `REDUCE_BASH`=false

333

##### `REDUCE_BASH`=false

313

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

334

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

314

335

315

##### `REDUCE_HWDB`=true

336

##### `REDUCE_HWDB`=true

316

Remove PCI related hwdb files (experimental).

337

Remove PCI related hwdb files (experimental).

317

338

318

##### `REDUCE_SSHD`=true

339

##### `REDUCE_SSHD`=true

319

Replace `openssh-server` with `dropbear`.

340

Replace `openssh-server` with `dropbear`.

320

341

321

##### `REDUCE_LOCALE`=true

342

##### `REDUCE_LOCALE`=true

322

Remove all `locale` translation files.

343

Remove all `locale` translation files.

323

344

324

---

345

---

325

346

326

#### Encrypted root partition:

347

#### Encrypted root partition:

327

##### `ENABLE_CRYPTFS`=false

348

##### `ENABLE_CRYPTFS`=false

328

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.

349

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.

329

350

330

##### `CRYPTFS_PASSWORD`=""

351

##### `CRYPTFS_PASSWORD`=""

331

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

352

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

332

353

333

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

354

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

334

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

355

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

335

356

336

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

357

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

337

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

358

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

338

359

339

##### `CRYPTFS_XTSKEYSIZE`=512

360

##### `CRYPTFS_XTSKEYSIZE`=512

340

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

361

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

341

362

342

---

363

---

343

364

344

#### Build settings:

365

#### Build settings:

345

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

366

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

346

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

367

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

347

368

348

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

369

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

349

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.

370

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.

350

371

351

## Understanding the script

372

## Understanding the script

352

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:

373

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:

353

374

354

| Script | Description |

375

| Script | Description |

355

| --- | --- |

376

| --- | --- |

356

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

377

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

357

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

378

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

358

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

379

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

359

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

380

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

360

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

381

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

361

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

382

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

362

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

383

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

363

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

384

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

364

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

385

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

365

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

386

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

366

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

387

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

367

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

388

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

368

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

389

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

369

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

390

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

370

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

391

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

371

392

372

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.

393

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.

373

394

374

| Directory | Description |

395

| Directory | Description |

375

| --- | --- |

396

| --- | --- |

376

| `apt` | APT management configuration files |

397

| `apt` | APT management configuration files |

377

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

398

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

378

| `dpkg` | Package Manager configuration |

399

| `dpkg` | Package Manager configuration |

379

| `etc` | Configuration files and rc scripts |

400

| `etc` | Configuration files and rc scripts |

380

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

401

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

381

| `initramfs` | Initramfs scripts |

402

| `initramfs` | Initramfs scripts |

382

| `iptables` | Firewall configuration files |

403

| `iptables` | Firewall configuration files |

383

| `locales` | Locales configuration |

404

| `locales` | Locales configuration |

384

| `modules` | Kernel Modules configuration |

405

| `modules` | Kernel Modules configuration |

385

| `mount` | Fstab configuration |

406

| `mount` | Fstab configuration |

386

| `network` | Networking configuration files |

407

| `network` | Networking configuration files |

387

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

408

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

388

| `xorg` | fbturbo Xorg driver configuration |

409

| `xorg` | fbturbo Xorg driver configuration |

389

410

390

## Custom packages and scripts

411

## Custom packages and scripts

391

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

412

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

392

413

393

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

414

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

394

415

395

## Logging of the bootstrapping process

416

## Logging of the bootstrapping process

396

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:

417

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:

397

418

398

```shell

419

```shell

399

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

420

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

400

```

421

```

401

422

402

## Flashing the image file

423

## Flashing the image file

403

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

424

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

404

425

405

#####Flashing examples:

426

#####Flashing examples:

406

```shell

427

```shell

407

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

428

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

408

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

429

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

409

```

430

```

410

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

431

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

411

```shell

432

```shell

412

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

433

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

413

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

434

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

414

```

435

```

415

436

416

## External links and references

437

## External links and references

417

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

438

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

418

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

439

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

419

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

440

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

420

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

441

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

421

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

442

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

422

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

443

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

423

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

444

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

424

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

445

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

425

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

446

* [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` and `stretch`. Raspberry Pi 3 images are currently generated for 32-bit mode only.
             ## 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 mandetory. Kernel compilation and linking will be performed on the build system using an ARM (armhf) cross-compiler toolchain.
             The script has been tested using the default `crossbuild-essential-armhf` toolchain meta package on Debian Linux `jessie` and `stretch` build systems. Please check the [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains) for further information.
             If a Debian Linux `jessie` build system is used it will be required to add the [Debian Cross-toolchains repository](http://emdebian.org/tools/debian/) first:
             ```
             echo "deb http://emdebian.org/tools/debian/ jessie main" > /etc/apt/sources.list.d/crosstools.list
             sudo -u nobody wget -O - http://emdebian.org/tools/debian/emdebian-toolchain-archive.key | apt-key add -
             dpkg --add-architecture armhf
             apt-get update
             ```
             ## Command-line parameters
             The script accepts certain command-line parameters to enable or disable specific OS features, services and configuration settings. These parameters are passed to the `rpi23-gen-image.sh` script via (simple) shell-variables. Unlike environment shell-variables (simple) shell-variables are defined at the beginning of the command-line call of the `rpi23-gen-image.sh` script.
             #####Command-line examples:
             ```shell
             ENABLE_UBOOT=true ./rpi23-gen-image.sh
             ENABLE_CONSOLE=false ENABLE_IPV6=false ./rpi23-gen-image.sh
             ENABLE_WM=xfce4 ENABLE_FBTURBO=true ENABLE_MINBASE=true ./rpi23-gen-image.sh
             ENABLE_HARDNET=true ENABLE_IPTABLES=true /rpi23-gen-image.sh
             APT_SERVER=ftp.de.debian.org APT_PROXY="http://127.0.0.1:3142/" ./rpi23-gen-image.sh
             ENABLE_MINBASE=true ./rpi23-gen-image.sh
             BUILD_KERNEL=true ENABLE_MINBASE=true ENABLE_IPV6=false ./rpi23-gen-image.sh
             BUILD_KERNEL=true KERNELSRC_DIR=/tmp/linux ./rpi23-gen-image.sh
             ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh
             ENABLE_CRYPTFS=true CRYPTFS_PASSWORD=changeme EXPANDROOT=false ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh
             RELEASE=stretch BUILD_KERNEL=true ./rpi23-gen-image.sh
             RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
             RELEASE=stretch RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
             ```
             ## Configuration template files
             To avoid long lists of command-line parameters and to help to store the favourite parameter configurations the `rpi23-gen-image.sh` script supports so called configuration template files (`CONFIG_TEMPLATE`=template). These are simple text files located in the `./templates` directory that contain the list of configuration parameters that will be used. New configuration template files can be added to the `./templates` directory.
             #####Command-line examples:
             ```shell
             CONFIG_TEMPLATE=rpi3stretch ./rpi23-gen-image.sh
             CONFIG_TEMPLATE=rpi2stretch ./rpi23-gen-image.sh
             ```
             ## Supported parameters and settings
             #### APT settings:
             ##### `APT_SERVER`="ftp.debian.org"
             Set Debian packages server address. Choose a server from the list of Debian worldwide [mirror sites](https://www.debian.org/mirror/list). Using a nearby server will probably speed-up all required downloads within the bootstrapping process.
             ##### `APT_PROXY`=""
             Set Proxy server address. Using a local Proxy-Cache like `apt-cacher-ng` will speed-up the bootstrapping process because all required Debian packages will only be downloaded from the Debian mirror site once.
             ##### `APT_INCLUDES`=""
             A comma separated list of additional packages to be installed during bootstrapping.
             ---
             #### General system settings:
             ##### `RPI_MODEL`=2
             Specifiy the target Raspberry Pi hardware model. The script at this time supports the Raspberry Pi models `2` and `3`. `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` is used.
             ##### `RELEASE`="jessie"
             Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases "jessie" and "stretch". `BUILD_KERNEL`=true will automatically be set if the Debian release `stretch` is 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.
             ---
             #### 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](http://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](http://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.
             ##### `ENABLE_IPV6`=true
             Enable IPv6 support. The network interface configuration is managed via systemd-networkd.
             ##### `ENABLE_SSHD`=true
             Install and enable OpenSSH service. The default configuration of the service doesn't allow `root` to login. Please use the user `pi` instead and `su -` or `sudo` to execute commands as root.
             ##### `ENABLE_NONFREE`=false
             Allow the installation of non-free Debian packages that do not comply with the DFSG. This is required to install closed-source firmware binary blobs.
             ##### `ENABLE_WIRELESS`=false
             Download and install the [closed-source firmware binary blob](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/brcm) that is required to run the internal wireless interface of the Raspberry Pi model `3`. This parameter is ignored if the specified `RPI_MODEL` is not `3`.
             ##### `ENABLE_RSYSLOG`=true
             If set to false, disable and uninstall rsyslog (so logs will be available only
             in journal files)
             ##### `ENABLE_SOUND`=true
             Enable sound hardware and install Advanced Linux Sound Architecture.
             ##### `ENABLE_HWRANDOM`=true
             Enable Hardware Random Number Generator. Strong random numbers are important for most network based communications that use encryption. It's recommended to be enabled.
             ##### `ENABLE_MINGPU`=false
             Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU.
             ##### `ENABLE_DBUS`=true
             Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled.
             ##### `ENABLE_XORG`=false
             Install Xorg open-source X Window System.
             ##### `ENABLE_WM`=""
             Install a user defined window manager for the X Window System. To make sure all X related package dependencies are getting installed `ENABLE_XORG` will automatically get enabled if `ENABLE_WM` is used. The `rpi23-gen-image.sh` script has been tested with the following list of window managers: `blackbox`, `openbox`, `fluxbox`, `jwm`, `dwm`, `xfce4`, `awesome`.
             ---
             #### Advanced system features:
             ##### `ENABLE_MINBASE`=false
             Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
             ##### `ENABLE_REDUCE`=false
             Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.
             ##### `ENABLE_UBOOT`=false
             Replace the default RPi2/3 second stage bootloader (bootcode.bin) with [U-Boot bootloader](http://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](http://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 release `stretch` is 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.
+            ##### `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.
+            ##### `KERNEL_DEFCONFIG`="bcm2709_defconfig"
+            Sets the default config for kernel compiling.
             ##### `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_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}-rpi${RPI_MODEL}-${RELEASE}
+            ##### `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.
+            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
             ```
             ## 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](http://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/)