Raspi2-3_GenImage Commit - r439:c35d34c19034 · Collaboration Tremplin des Sciences

1

# rpi23-gen-image

1

# rpi23-gen-image

2

## Introduction

2

## Introduction

3

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

3

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

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 `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 `stretch` build systems. Please check the [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains) for further information.

13

14

## Command-line parameters

14

## Command-line parameters

15

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

15

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

16

17

##### Command-line examples:

17

##### Command-line examples:

18

```shell

18

```shell

19

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

19

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

20

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

20

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

21

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

21

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

22

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

22

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

23

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

23

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

24

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

24

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

25

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

25

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

26

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

26

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

27

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

27

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

28

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

28

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

29

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

29

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

30

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

30

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

31

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

31

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

32

```

32

```

33

34

## Configuration template files

34

## Configuration template files

35

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

35

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

36

37

##### Command-line examples:

37

##### Command-line examples:

38

```shell

38

```shell

39

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

39

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

40

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

40

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

41

```

41

```

42

43

## Supported parameters and settings

43

## Supported parameters and settings

44

#### APT settings:

44

#### APT settings:

45

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

45

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

46

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

46

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

47

48

##### `APT_PROXY`=""

48

##### `APT_PROXY`=""

49

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

49

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

50

51

##### `APT_INCLUDES`=""

51

##### `APT_INCLUDES`=""

52

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

52

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

53

54

##### `APT_INCLUDES_LATE`=""

54

##### `APT_INCLUDES_LATE`=""

55

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

55

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

56

57

---

57

---

58

59

#### General system settings:

59

#### General system settings:

60

##### `SET_ARCH`=32

60

##### `SET_ARCH`=32

61

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

61

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

62

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

62

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

63

64

##### `RPI_MODEL`=2

64

##### `RPI_MODEL`=2

65

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

65

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

66

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

66

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

67

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

67

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

68

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

68

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

69

`2` = Used for Pi 2 model B

69

`2` = Used for Pi 2 model B

70

`3` = Used for Pi 3 model B

70

`3` = Used for Pi 3 model B

71

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

71

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

72

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

72

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

73

74

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

74

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

75

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

75

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

76

77

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

77

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

78

Set the desired Debian release architecture.

78

Set the desired Debian release architecture.

79

80

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

80

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

81

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

81

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

82

83

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

83

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

84

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

84

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

85

86

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

86

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

87

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

87

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

88

89

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

89

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

90

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

90

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

91

92

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

92

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

93

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

93

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

94

95

##### `EXPANDROOT`=true

95

##### `EXPANDROOT`=true

96

Expand the root partition and filesystem automatically on first boot.

96

Expand the root partition and filesystem automatically on first boot.

97

98

##### `ENABLE_QEMU`=false

98

##### `ENABLE_QEMU`=false

99

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

99

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

100

101

---

101

---

102

103

#### Keyboard settings:

103

#### Keyboard settings:

104

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

104

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

105

106

##### `XKB_MODEL`=""

106

##### `XKB_MODEL`=""

107

Set the name of the model of your keyboard type.

107

Set the name of the model of your keyboard type.

108

109

##### `XKB_LAYOUT`=""

109

##### `XKB_LAYOUT`=""

110

Set the supported keyboard layout(s).

110

Set the supported keyboard layout(s).

111

112

##### `XKB_VARIANT`=""

112

##### `XKB_VARIANT`=""

113

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

113

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

114

115

##### `XKB_OPTIONS`=""

115

##### `XKB_OPTIONS`=""

116

Set extra xkb configuration options.

116

Set extra xkb configuration options.

117

118

---

118

---

119

120

#### Networking settings (DHCP):

120

#### Networking settings (DHCP):

121

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

121

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

122

123

##### `ENABLE_DHCP`=true

123

##### `ENABLE_DHCP`=true

124

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

124

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

125

126

---

126

---

127

128

#### Networking settings (static):

128

#### Networking settings (static):

129

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

129

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

130

131

##### `NET_ADDRESS`=""

131

##### `NET_ADDRESS`=""

132

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

132

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

133

134

##### `NET_GATEWAY`=""

134

##### `NET_GATEWAY`=""

135

Set the IP address for the default gateway.

135

Set the IP address for the default gateway.

136

137

##### `NET_DNS_1`=""

137

##### `NET_DNS_1`=""

138

Set the IP address for the first DNS server.

138

Set the IP address for the first DNS server.

139

140

##### `NET_DNS_2`=""

140

##### `NET_DNS_2`=""

141

Set the IP address for the second DNS server.

141

Set the IP address for the second DNS server.

142

143

##### `NET_DNS_DOMAINS`=""

143

##### `NET_DNS_DOMAINS`=""

144

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

144

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

145

146

##### `NET_NTP_1`=""

146

##### `NET_NTP_1`=""

147

Set the IP address for the first NTP server.

147

Set the IP address for the first NTP server.

148

149

##### `NET_NTP_2`=""

149

##### `NET_NTP_2`=""

150

Set the IP address for the second NTP server.

150

Set the IP address for the second NTP server.

151

152

---

152

---

153

154

#### Basic system features:

154

#### Basic system features:

155

##### `ENABLE_CONSOLE`=true

155

##### `ENABLE_CONSOLE`=true

156

Enable serial console interface. Recommended if no monitor or keyboard is connected to the RPi2/3. In case of problems fe. if the network (auto) configuration failed - the serial console can be used to access the system. On ~~`RPI_MODEL= 0,3,3P`~~ ~~- Bluetooth gets auto enabled if~~ ~~`ENABLE_CONSOLE`~~ ~~and~~ ~~`ENABLE_UBOOT`~~ ~~are set to~~ ~~`false`~~

156

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

157

On `RPI_MODEL= 0,3,3P` - Bluetooth gets auto enabled if `ENABLE_CONSOLE` and `ENABLE_UBOOT` are set to `false`

157

158

##### `ENABLE_I2C`=false

159

##### `ENABLE_I2C`=false

159

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

160

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.

160

161

##### `ENABLE_SPI`=false

162

##### `ENABLE_SPI`=false

162

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

163

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.

163

164

##### `ENABLE_IPV6`=true

165

##### `ENABLE_IPV6`=true

165

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

166

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

166

167

##### `ENABLE_SSHD`=true

168

##### `ENABLE_SSHD`=true

168

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

169

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

169

170

##### `ENABLE_NONFREE`=false

171

##### `ENABLE_NONFREE`=false

171

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

172

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

172

173

##### `ENABLE_WIRELESS`=false

174

##### `ENABLE_WIRELESS`=false

174

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

175

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

175

176

##### `ENABLE_BLUETOOTH`=false

177

##### `ENABLE_BLUETOOTH`=false

177

Enable Bluetooth interface on the RPi0/3.

178

Enable Bluetooth interface on the RPi0/3.

178

179

##### `ENABLE_RSYSLOG`=true

180

##### `ENABLE_RSYSLOG`=true

180

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

181

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

181

in journal files)

182

183

##### `ENABLE_SOUND`=true

183

##### `ENABLE_SOUND`=true

184

Enable sound hardware and install Advanced Linux Sound Architecture.

184

Enable sound hardware and install Advanced Linux Sound Architecture.

185

186

##### `ENABLE_HWRANDOM`=true

186

##### `ENABLE_HWRANDOM`=true

187

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

187

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

188

189

##### `ENABLE_MINGPU`=false

189

##### `ENABLE_MINGPU`=false

190

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

190

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

191

192

##### `ENABLE_DBUS`=true

192

##### `ENABLE_DBUS`=true

193

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

193

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

194

195

##### `ENABLE_XORG`=false

195

##### `ENABLE_XORG`=false

196

Install Xorg open-source X Window System.

196

Install Xorg open-source X Window System.

197

198

##### `ENABLE_WM`=""

198

##### `ENABLE_WM`=""

199

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

199

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

200

201

##### `ENABLE_SYSVINIT`=false

201

##### `ENABLE_SYSVINIT`=false

202

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

202

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

203

204

---

204

---

205

206

#### Advanced system features:

206

#### Advanced system features:

207

##### `ENABLE_MINBASE`=false

207

##### `ENABLE_MINBASE`=false

208

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

208

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

209

210

##### `ENABLE_REDUCE`=false

210

##### `ENABLE_REDUCE`=false

211

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

211

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

212

213

##### `ENABLE_UBOOT`=false

213

##### `ENABLE_UBOOT`=false

214

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

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.

215

216

##### `UBOOTSRC_DIR`=""

216

##### `UBOOTSRC_DIR`=""

217

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

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.

218

219

##### `ENABLE_FBTURBO`=false

219

##### `ENABLE_FBTURBO`=false

220

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

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.

221

222

##### `FBTURBOSRC_DIR`=""

222

##### `FBTURBOSRC_DIR`=""

223

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

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.

224

225

##### `ENABLE_VIDEOCORE`=false

225

##### `ENABLE_VIDEOCORE`=false

226

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

226

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

227

228

##### `VIDEOCORESRC_DIR`=""

228

##### `VIDEOCORESRC_DIR`=""

229

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

229

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

230

231

##### `ENABLE_IPTABLES`=false

231

##### `ENABLE_IPTABLES`=false

232

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

232

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

233

234

##### `ENABLE_USER`=true

234

##### `ENABLE_USER`=true

235

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

235

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

236

237

##### `USER_NAME`=pi

237

##### `USER_NAME`=pi

238

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

238

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

239

240

##### `ENABLE_ROOT`=false

240

##### `ENABLE_ROOT`=false

241

Set root user password so root login will be enabled

241

Set root user password so root login will be enabled

242

243

##### `ENABLE_HARDNET`=false

243

##### `ENABLE_HARDNET`=false

244

Enable IPv4/IPv6 network stack hardening settings.

244

Enable IPv4/IPv6 network stack hardening settings.

245

246

##### `ENABLE_SPLITFS`=false

246

##### `ENABLE_SPLITFS`=false

247

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

247

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

248

249

##### `CHROOT_SCRIPTS`=""

249

##### `CHROOT_SCRIPTS`=""

250

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.

250

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.

251

252

##### `ENABLE_INITRAMFS`=false

252

##### `ENABLE_INITRAMFS`=false

253

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.

253

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.

254

255

##### `ENABLE_IFNAMES`=true

255

##### `ENABLE_IFNAMES`=true

256

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

256

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

257

258

##### `DISABLE_UNDERVOLT_WARNINGS`=

258

##### `DISABLE_UNDERVOLT_WARNINGS`=

259

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.

259

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.

260

261

---

261

---

262

263

#### SSH settings:

263

#### SSH settings:

264

##### `SSH_ENABLE_ROOT`=false

264

##### `SSH_ENABLE_ROOT`=false

265

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

265

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

266

267

##### `SSH_DISABLE_PASSWORD_AUTH`=false

267

##### `SSH_DISABLE_PASSWORD_AUTH`=false

268

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

268

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

269

270

##### `SSH_LIMIT_USERS`=false

270

##### `SSH_LIMIT_USERS`=false

271

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

271

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

272

273

##### `SSH_ROOT_PUB_KEY`=""

273

##### `SSH_ROOT_PUB_KEY`=""

274

Add SSH (v2) public key(s) from specified file to `authorized_keys` file to enable public key based SSH (v2) authentication of user `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`.

274

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

275

276

##### `SSH_USER_PUB_KEY`=""

276

##### `SSH_USER_PUB_KEY`=""

277

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.

277

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.

278

279

---

279

---

280

281

#### Kernel compilation:

281

#### Kernel compilation:

282

##### `BUILD_KERNEL`=true

282

##### `BUILD_KERNEL`=true

283

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

283

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

284

285

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

285

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

286

This sets the cross compile enviornment for the compiler.

286

This sets the cross compile enviornment for the compiler.

287

288

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

288

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

289

This sets the kernel architecture for the compiler.

289

This sets the kernel architecture for the compiler.

290

291

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

291

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

292

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.

292

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.

293

294

##### `KERNEL_BRANCH`=""

294

##### `KERNEL_BRANCH`=""

295

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

295

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

296

297

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

297

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

298

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.

298

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.

299

300

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

300

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

301

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

301

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

302

303

##### `KERNEL_REDUCE`=false

303

##### `KERNEL_REDUCE`=false

304

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

304

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

305

306

##### `KERNEL_THREADS`=1

306

##### `KERNEL_THREADS`=1

307

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.

307

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.

308

309

##### `KERNEL_HEADERS`=true

309

##### `KERNEL_HEADERS`=true

310

Install kernel headers with built kernel.

310

Install kernel headers with built kernel.

311

312

##### `KERNEL_MENUCONFIG`=false

312

##### `KERNEL_MENUCONFIG`=false

313

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

313

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

314

315

##### `KERNEL_OLDDEFCONFIG`=false

315

##### `KERNEL_OLDDEFCONFIG`=false

316

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

316

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

317

318

##### `KERNEL_CCACHE`=false

318

##### `KERNEL_CCACHE`=false

319

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

319

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

320

321

##### `KERNEL_REMOVESRC`=true

321

##### `KERNEL_REMOVESRC`=true

322

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

322

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

323

324

##### `KERNELSRC_DIR`=""

324

##### `KERNELSRC_DIR`=""

325

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.

325

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.

326

327

##### `KERNELSRC_CLEAN`=false

327

##### `KERNELSRC_CLEAN`=false

328

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.

328

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.

329

330

##### `KERNELSRC_CONFIG`=true

330

##### `KERNELSRC_CONFIG`=true

331

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.

331

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.

332

333

##### `KERNELSRC_USRCONFIG`=""

333

##### `KERNELSRC_USRCONFIG`=""

334

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

334

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

335

336

##### `KERNELSRC_PREBUILT`=false

336

##### `KERNELSRC_PREBUILT`=false

337

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.

337

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.

338

339

##### `RPI_FIRMWARE_DIR`=""

339

##### `RPI_FIRMWARE_DIR`=""

340

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.

340

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.

341

342

##### `KERNEL_NF`=false

342

##### `KERNEL_NF`=false

343

Enable Netfilter modules as kernel modules

343

Enable Netfilter modules as kernel modules

344

345

##### `KERNEL_VIRT`=false

345

##### `KERNEL_VIRT`=false

346

Enable Kernel KVM support (/dev/kvm)

346

Enable Kernel KVM support (/dev/kvm)

347

348

##### `KERNEL_ZSWAP`=false

348

##### `KERNEL_ZSWAP`=false

349

Enable Kernel Zswap support. Best use on high RAM load and mediocre CPU load usecases

349

Enable Kernel Zswap support. Best use on high RAM load and mediocre CPU load usecases

350

351

##### `KERNEL_BPF`=true

351

##### `KERNEL_BPF`=true

352

Allow attaching eBPF programs to a cgroup using the bpf syscall (CONFIG_BPF_SYSCALL CONFIG_CGROUP_BPF) [systemd compilations about it - File /lib/systemd/system/systemd-journald.server:36 configures an IP firewall (IPAddressDeny=all), but the local system does not support BPF/cgroup based firewalls]

352

Allow attaching eBPF programs to a cgroup using the bpf syscall (CONFIG_BPF_SYSCALL CONFIG_CGROUP_BPF) [systemd compilations about it - File /lib/systemd/system/systemd-journald.server:36 configures an IP firewall (IPAddressDeny=all), but the local system does not support BPF/cgroup based firewalls]

353

354

---

354

---

355

356

#### Reduce disk usage:

356

#### Reduce disk usage:

357

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

357

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

358

359

##### `REDUCE_APT`=true

359

##### `REDUCE_APT`=true

360

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

360

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

361

362

##### `REDUCE_DOC`=true

362

##### `REDUCE_DOC`=true

363

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

363

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

364

365

##### `REDUCE_MAN`=true

365

##### `REDUCE_MAN`=true

366

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

366

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

367

368

##### `REDUCE_VIM`=false

368

##### `REDUCE_VIM`=false

369

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

369

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

370

371

##### `REDUCE_BASH`=false

371

##### `REDUCE_BASH`=false

372

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

372

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

373

374

##### `REDUCE_HWDB`=true

374

##### `REDUCE_HWDB`=true

375

Remove PCI related hwdb files (experimental).

375

Remove PCI related hwdb files (experimental).

376

377

##### `REDUCE_SSHD`=true

377

##### `REDUCE_SSHD`=true

378

Replace `openssh-server` with `dropbear`.

378

Replace `openssh-server` with `dropbear`.

379

380

##### `REDUCE_LOCALE`=true

380

##### `REDUCE_LOCALE`=true

381

Remove all `locale` translation files.

381

Remove all `locale` translation files.

382

383

---

383

---

384

385

#### Encrypted root partition:

385

#### Encrypted root partition:

386

##### `ENABLE_CRYPTFS`=false

386

##### `ENABLE_CRYPTFS`=false

387

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.

387

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.

388

389

##### `CRYPTFS_PASSWORD`=""

389

##### `CRYPTFS_PASSWORD`=""

390

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

390

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

391

392

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

392

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

393

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

393

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

394

395

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

395

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

396

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

396

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

397

398

##### `CRYPTFS_XTSKEYSIZE`=512

398

##### `CRYPTFS_XTSKEYSIZE`=512

399

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

399

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

400

401

---

401

---

402

403

#### Build settings:

403

#### Build settings:

404

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

404

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

405

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

405

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

406

407

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

407

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

408

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.

408

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.

409

410

## Understanding the script

410

## Understanding the script

411

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:

411

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:

412

413

| Script | Description |

413

| Script | Description |

414

| --- | --- |

414

| --- | --- |

415

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

415

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

416

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

416

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

417

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

417

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

418

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

418

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

419

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

419

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

420

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

420

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

421

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

421

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

422

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

422

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

423

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

423

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

424

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

424

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

425

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

425

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

426

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

426

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

427

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

427

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

428

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

428

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

429

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

429

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

430

431

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.

431

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.

432

433

| Directory | Description |

433

| Directory | Description |

434

| --- | --- |

434

| --- | --- |

435

| `apt` | APT management configuration files |

435

| `apt` | APT management configuration files |

436

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

436

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

437

| `dpkg` | Package Manager configuration |

437

| `dpkg` | Package Manager configuration |

438

| `etc` | Configuration files and rc scripts |

438

| `etc` | Configuration files and rc scripts |

439

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

439

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

440

| `initramfs` | Initramfs scripts |

440

| `initramfs` | Initramfs scripts |

441

| `iptables` | Firewall configuration files |

441

| `iptables` | Firewall configuration files |

442

| `locales` | Locales configuration |

442

| `locales` | Locales configuration |

443

| `modules` | Kernel Modules configuration |

443

| `modules` | Kernel Modules configuration |

444

| `mount` | Fstab configuration |

444

| `mount` | Fstab configuration |

445

| `network` | Networking configuration files |

445

| `network` | Networking configuration files |

446

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

446

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

447

| `xorg` | fbturbo Xorg driver configuration |

447

| `xorg` | fbturbo Xorg driver configuration |

448

449

## Custom packages and scripts

449

## Custom packages and scripts

450

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

450

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

451

452

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

452

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

453

454

## Logging of the bootstrapping process

454

## Logging of the bootstrapping process

455

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:

455

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:

456

457

```shell

457

```shell

458

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

458

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

459

```

459

```

460

461

## Flashing the image file

461

## Flashing the image file

462

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

462

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

463

464

##### Flashing examples:

464

##### Flashing examples:

465

```shell

465

```shell

466

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

466

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

467

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

467

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

468

```

468

```

469

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

469

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

470

```shell

470

```shell

471

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

471

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

472

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

472

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

473

```

473

```

474

475

## QEMU emulation

475

## QEMU emulation

476

Start QEMU full system emulation:

476

Start QEMU full system emulation:

477

```shell

477

```shell

478

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

478

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

479

```

479

```

480

481

Start QEMU full system emulation and output to console:

481

Start QEMU full system emulation and output to console:

482

```shell

482

```shell

483

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

483

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

484

```

484

```

485

486

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

486

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

487

```shell

487

```shell

488

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

488

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

489

```

489

```

490

491

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

491

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

492

```shell

492

```shell

493

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

493

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

494

```

494

```

495

496

## External links and references

496

## External links and references

497

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

497

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

498

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

498

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

499

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

499

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

500

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

500

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

501

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

501

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

502

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

502

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

503

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

503

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

504

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

504

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

505

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

505

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

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

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

             # rpi23-gen-image
             ## Introduction
             `rpi23-gen-image.sh` is an advanced Debian Linux bootstrapping shell script for generating Debian OS images for Raspberry Pi 2 (RPi2) and Raspberry Pi 3 (RPi3) computers. The script at this time supports the bootstrapping of the Debian (armhf) releases `stretch` and `buster`. Raspberry Pi 3 images are generated for 32-bit mode only. Raspberry Pi 3 64-bit images can be generated using custom configuration parameters (```templates/rpi3-stretch-arm64-4.14.y```).
             ## 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 `stretch` build systems. Please check the [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains) for further information.
             ## Command-line parameters
             The script accepts certain command-line parameters to enable or disable specific OS features, services and configuration settings. These parameters are passed to the `rpi23-gen-image.sh` script via (simple) shell-variables. Unlike environment shell-variables (simple) shell-variables are defined at the beginning of the command-line call of the `rpi23-gen-image.sh` script.
             ##### Command-line examples:
             ```shell
             ENABLE_UBOOT=true ./rpi23-gen-image.sh
             ENABLE_CONSOLE=false ENABLE_IPV6=false ./rpi23-gen-image.sh
             ENABLE_WM=xfce4 ENABLE_FBTURBO=true ENABLE_MINBASE=true ./rpi23-gen-image.sh
             ENABLE_HARDNET=true ENABLE_IPTABLES=true /rpi23-gen-image.sh
             APT_SERVER=ftp.de.debian.org APT_PROXY="http://127.0.0.1:3142/" ./rpi23-gen-image.sh
             ENABLE_MINBASE=true ./rpi23-gen-image.sh
             BUILD_KERNEL=true ENABLE_MINBASE=true ENABLE_IPV6=false ./rpi23-gen-image.sh
             BUILD_KERNEL=true KERNELSRC_DIR=/tmp/linux ./rpi23-gen-image.sh
             ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh
             ENABLE_CRYPTFS=true CRYPTFS_PASSWORD=changeme EXPANDROOT=false ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh
             RELEASE=stretch BUILD_KERNEL=true ./rpi23-gen-image.sh
             RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
             RELEASE=stretch RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
             ```
             ## Configuration template files
             To avoid long lists of command-line parameters and to help to store the favourite parameter configurations the `rpi23-gen-image.sh` script supports so called configuration template files (`CONFIG_TEMPLATE`=template). These are simple text files located in the `./templates` directory that contain the list of configuration parameters that will be used. New configuration template files can be added to the `./templates` directory.
             ##### Command-line examples:
             ```shell
             CONFIG_TEMPLATE=rpi3stretch ./rpi23-gen-image.sh
             CONFIG_TEMPLATE=rpi2stretch ./rpi23-gen-image.sh
             ```
             ## Supported parameters and settings
             #### APT settings:
             ##### `APT_SERVER`="ftp.debian.org/debian"
             Set Debian packages server address. Choose a server from the list of Debian worldwide [mirror sites](https://www.debian.org/mirror/list). Using a nearby server will probably speed-up all required downloads within the bootstrapping process.
             ##### `APT_PROXY`=""
             Set Proxy server address. Using a local Proxy-Cache like `apt-cacher-ng` will speed-up the bootstrapping process because all required Debian packages will only be downloaded from the Debian mirror site once. If `apt-cacher-ng` is running on default `http://127.0.0.1:3142` it is autodetected and you don't need to set this.
             ##### `APT_INCLUDES`=""
             A comma separated list of additional packages to be installed by debootstrap during bootstrapping.
             ##### `APT_INCLUDES_LATE`=""
             A comma separated list of additional packages to be installed by apt after bootstrapping and after APT sources are set up.  This is useful for packages with pre-depends, which debootstrap do not handle well.
             ---
             #### General system settings:
             ##### `SET_ARCH`=32
             Set Architecture to default 32bit. If you want to to compile 64bit (RPI3 or RPI3+) set it to `64`. This option will set every needed crosscompiler or boeard specific option for a successful build.
             If you want to change e.g. cross-compiler -> Templates always override defaults
             ##### `RPI_MODEL`=2
             Specifiy the target Raspberry Pi hardware model. The script at this time supports the following Raspberry Pi models:
             `0`  = Used for Raspberry Pi 0 and Raspberry Pi 0 W
             `1`  = Used for Pi 1 model A and B
             `1P` = Used for Pi 1 model B+ and A+
             `2`  = Used for Pi 2 model B
             `3`  = Used for Pi 3 model B
             `3P` = Used for Pi 3 model B+
             `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` or `3P` is used.
             ##### `RELEASE`="buster"
             Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases `stretch` and `buster`.
             ##### `RELEASE_ARCH`="armhf"
             Set the desired Debian release architecture.
             ##### `HOSTNAME`="rpi$RPI_MODEL-$RELEASE"
             Set system host name. It's recommended that the host name is unique in the corresponding subnet.
             ##### `PASSWORD`="raspberry"
             Set system `root` password. It's **STRONGLY** recommended that you choose a custom password.
             ##### `USER_PASSWORD`="raspberry"
             Set password for the created non-root user `USER_NAME`=pi. Ignored if `ENABLE_USER`=false. It's **STRONGLY** recommended that you choose a custom password.
             ##### `DEFLOCAL`="en_US.UTF-8"
             Set default system locale. This setting can also be changed inside the running OS using the `dpkg-reconfigure locales` command. Please note that on using this parameter the script will automatically install the required packages `locales`, `keyboard-configuration` and `console-setup`.
             ##### `TIMEZONE`="Europe/Berlin"
             Set default system timezone. All available timezones can be found in the `/usr/share/zoneinfo/` directory. This setting can also be changed inside the running OS using the `dpkg-reconfigure tzdata` command.
             ##### `EXPANDROOT`=true
             Expand the root partition and filesystem automatically on first boot.
             ##### `ENABLE_QEMU`=false
             Generate kernel (`vexpress_defconfig`), file system image (`qcow2`) and DTB files that can be used for QEMU full system emulation (`vexpress-A15`). The output files are stored in the `$(pwd)/images/qemu` directory. You can find more information about running the generated image in the QEMU section of this readme file.
             ---
             #### Keyboard settings:
             These options are used to configure keyboard layout in `/etc/default/keyboard` for console and Xorg. These settings can also be changed inside the running OS using the `dpkg-reconfigure keyboard-configuration` command.
             ##### `XKB_MODEL`=""
             Set the name of the model of your keyboard type.
             ##### `XKB_LAYOUT`=""
             Set the supported keyboard layout(s).
             ##### `XKB_VARIANT`=""
             Set the supported variant(s) of the keyboard layout(s).
             ##### `XKB_OPTIONS`=""
             Set extra xkb configuration options.
             ---
             #### Networking settings (DHCP):
             This parameter is used to set up networking auto configuration in `/etc/systemd/network/eth.network`. The default location of network configuration files in the Debian `stretch` release was changed to `/lib/systemd/network`.`
             ##### `ENABLE_DHCP`=true
             Set the system to use DHCP. This requires an DHCP server.
             ---
             #### Networking settings (static):
             These parameters are used to set up a static networking configuration in `/etc/systemd/network/eth.network`. The following static networking parameters are only supported if `ENABLE_DHCP` was set to `false`. The default location of network configuration files in the Debian `stretch` release was changed to `/lib/systemd/network`.
             ##### `NET_ADDRESS`=""
             Set a static IPv4 or IPv6 address and its prefix, separated by "/", eg. "192.169.0.3/24".
             ##### `NET_GATEWAY`=""
             Set the IP address for the default gateway.
             ##### `NET_DNS_1`=""
             Set the IP address for the first DNS server.
             ##### `NET_DNS_2`=""
             Set the IP address for the second DNS server.
             ##### `NET_DNS_DOMAINS`=""
             Set the default DNS search domains to use for non fully qualified host names.
             ##### `NET_NTP_1`=""
             Set the IP address for the first NTP server.
             ##### `NET_NTP_2`=""
             Set the IP address for the second NTP server.
             ---
             #### Basic system features:
             ##### `ENABLE_CONSOLE`=true
-            Enable serial console interface. Recommended if no monitor or keyboard is connected to the RPi2/3. In case of problems fe. if the network (auto) configuration failed - the serial console can be used to access the system. On `RPI_MODEL= 0,3,3P` - Bluetooth gets auto enabled if `ENABLE_CONSOLE` and `ENABLE_UBOOT` are set to `false`
+            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.
+            On `RPI_MODEL= 0,3,3P` - Bluetooth gets auto enabled if `ENABLE_CONSOLE` and `ENABLE_UBOOT` are set to `false`
             ##### `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_BLUETOOTH`=false
             Enable Bluetooth interface on the RPi0/3.
             ##### `ENABLE_RSYSLOG`=true
-            If set to false, disable and uninstall rsyslog (so logs will be available only
+            If set to false, disable and uninstall rsyslog (so logs will be available only in journal files)
-            in journal files)
             ##### `ENABLE_SOUND`=true
             Enable sound hardware and install Advanced Linux Sound Architecture.
             ##### `ENABLE_HWRANDOM`=true
             Enable Hardware Random Number Generator. Strong random numbers are important for most network based communications that use encryption. It's recommended to be enabled.
             ##### `ENABLE_MINGPU`=false
             Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU.
             ##### `ENABLE_DBUS`=true
             Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled.
             ##### `ENABLE_XORG`=false
             Install Xorg open-source X Window System.
             ##### `ENABLE_WM`=""
             Install a user defined window manager for the X Window System. To make sure all X related package dependencies are getting installed `ENABLE_XORG` will automatically get enabled if `ENABLE_WM` is used. The `rpi23-gen-image.sh` script has been tested with the following list of window managers: `blackbox`, `openbox`, `fluxbox`, `jwm`, `dwm`, `xfce4`, `awesome`.
             ##### `ENABLE_SYSVINIT`=false
             Support for halt,init,poweroff,reboot,runlevel,shutdown,telinit commands
             ---
             #### Advanced system features:
             ##### `ENABLE_MINBASE`=false
             Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
             ##### `ENABLE_REDUCE`=false
             Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.
             ##### `ENABLE_UBOOT`=false
             Replace the default RPi2/3 second stage bootloader (bootcode.bin) with [U-Boot bootloader](https://git.denx.de/?p=u-boot.git;a=summary). U-Boot can boot images via the network using the BOOTP/TFTP protocol.
             ##### `UBOOTSRC_DIR`=""
             Path to a directory (`u-boot`) of [U-Boot bootloader sources](https://git.denx.de/?p=u-boot.git;a=summary) that will be copied, configured, build and installed inside the chroot.
             ##### `ENABLE_FBTURBO`=false
             Install and enable the [hardware accelerated Xorg video driver](https://github.com/ssvb/xf86-video-fbturbo) `fbturbo`. Please note that this driver is currently limited to hardware accelerated window moving and scrolling.
             ##### `FBTURBOSRC_DIR`=""
             Path to a directory (`xf86-video-fbturbo`) of [hardware accelerated Xorg video driver sources](https://github.com/ssvb/xf86-video-fbturbo) that will be copied, configured, build and installed inside the chroot.
             ##### `ENABLE_VIDEOCORE`=false
             Install and enable the [Source code for ARM side libraries for interfacing to Raspberry Pi GPU](https://github.com/raspberrypi/userland) `vcgencmd`. Please note that this driver is currently limited to hardware accelerated window moving and scrolling.
             ##### `VIDEOCORESRC_DIR`=""
             Path to a directory (`userland`) of [Source code for ARM side libraries for interfacing to Raspberry Pi GPU](https://github.com/raspberrypi/userland) that will be copied, configured, build and installed inside the chroot.
             ##### `ENABLE_IPTABLES`=false
             Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.
             ##### `ENABLE_USER`=true
             Create non-root user with password `USER_PASSWORD`=raspberry. Unless overridden with `USER_NAME`=user, username will be `pi`.
             ##### `USER_NAME`=pi
             Non-root user to create.  Ignored if `ENABLE_USER`=false
             ##### `ENABLE_ROOT`=false
             Set root user password so root login will be enabled
             ##### `ENABLE_HARDNET`=false
             Enable IPv4/IPv6 network stack hardening settings.
             ##### `ENABLE_SPLITFS`=false
             Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.
             ##### `CHROOT_SCRIPTS`=""
             Path to a directory with scripts that should be run in the chroot before the image is finally built. Every executable file in this directory is run in lexicographical order.
             ##### `ENABLE_INITRAMFS`=false
             Create an initramfs that that will be loaded during the Linux startup process. `ENABLE_INITRAMFS` will automatically get enabled if `ENABLE_CRYPTFS`=true. This parameter will be ignored if `BUILD_KERNEL`=false.
             ##### `ENABLE_IFNAMES`=true
             Enable automatic assignment of predictable, stable network interface names for all local Ethernet, WLAN interfaces. This might create complex and long interface names.
             ##### `DISABLE_UNDERVOLT_WARNINGS`=
             Disable RPi2/3 under-voltage warnings and overlays. Setting the parameter to `1` will disable the warning overlay. Setting it to `2` will additionally allow RPi2/3 turbo mode when low-voltage is present.
             ---
             #### SSH settings:
             ##### `SSH_ENABLE_ROOT`=false
             Enable password root login via SSH. This may be a security risk with default password, use only in trusted environments. `ENABLE_ROOT` must be set to `true`.
             ##### `SSH_DISABLE_PASSWORD_AUTH`=false
             Disable password based SSH authentication. Only public key based SSH (v2) authentication will be supported.
             ##### `SSH_LIMIT_USERS`=false
             Limit the users that are allowed to login via SSH. Only allow user `USER_NAME`=pi and root if `SSH_ENABLE_ROOT`=true to login. This parameter will be ignored if `dropbear` SSH is used (`REDUCE_SSHD`=true).
             ##### `SSH_ROOT_PUB_KEY`=""
             Add SSH (v2) public key(s) from specified file to `authorized_keys` file to enable public key based SSH (v2) authentication of user `root`. The specified file can also contain multiple SSH (v2) public keys. SSH protocol version 1 is not supported. `ENABLE_ROOT` **and** `SSH_ENABLE_ROOT` must be set to `true`.
             ##### `SSH_USER_PUB_KEY`=""
             Add SSH (v2) public key(s) from specified file to `authorized_keys` file to enable public key based SSH (v2) authentication of user `USER_NAME`=pi. The specified file can also contain multiple SSH (v2) public keys. SSH protocol version 1 is not supported.
             ---
             #### Kernel compilation:
             ##### `BUILD_KERNEL`=true
             Build and install the latest RPi2/3 Linux kernel. Currently only the default RPi2/3 kernel configuration is used.
             ##### `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.
             ##### `KERNEL_NF`=false
             Enable Netfilter modules as kernel modules
             ##### `KERNEL_VIRT`=false
             Enable Kernel KVM support (/dev/kvm)
             ##### `KERNEL_ZSWAP`=false
             Enable Kernel Zswap support. Best use on high RAM load and mediocre CPU load usecases
             ##### `KERNEL_BPF`=true
             Allow attaching eBPF programs to a cgroup using the bpf syscall (CONFIG_BPF_SYSCALL CONFIG_CGROUP_BPF) [systemd compilations about it - File /lib/systemd/system/systemd-journald.server:36 configures an IP firewall (IPAddressDeny=all), but the local system does not support BPF/cgroup based firewalls]
             ---
             #### 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/buster/2017-01-23-rpi3-buster.img /dev/mmcblk0
             dd bs=4M if=./images/buster/2017-01-23-rpi3-buster.img of=/dev/mmcblk0
             ```
             If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:
             ```shell
             bmaptool copy ./images/buster/2017-01-23-rpi3-buster-frmw.img /dev/mmcblk0
             bmaptool copy ./images/buster/2017-01-23-rpi3-buster-root.img /dev/sdc
             ```
             ## QEMU emulation
             Start QEMU full system emulation:
             ```shell
             qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=tty1"
             ```
             Start QEMU full system emulation and output to console:
             ```shell
             qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio
             ```
             Start QEMU full system emulation with SMP and output to console:
             ```shell
             qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -smp cpus=2,maxcpus=2 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio
             ```
             Start QEMU full system emulation with cryptfs, initramfs and output to console:
             ```shell
             qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -initrd "initramfs-${KERNEL_VERSION}" -append "root=/dev/mapper/secure cryptdevice=/dev/mmcblk0p2:secure rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio
             ```
             ## External links and references
             * [Debian worldwide mirror sites](https://www.debian.org/mirror/list)
             * [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)
             * [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains)
             * [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)
             * [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)
             * [U-BOOT git repository](https://git.denx.de/?p=u-boot.git;a=summary)
             * [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)
             * [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/brcm)
             * [Collabora RPi2 Kernel precompiled](https://repositories.collabora.co.uk/debian/)