Raspi2-3_GenImage Commit - r733:30010dc2bab6 · Collaboration Tremplin des Sciences

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=buster 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=buster 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

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

## Working with the your template:

44

#### APT settings:

44

* **A Pipe ("|") represents a logical OR**

45

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

45

* **A valuetype of boolean represents the options true or false**

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

* **Values without a default are required if you want do use that feature. It is possible that not every feature has a (working) sanity check.**

47

* **If it's not working as expected, search your option in all the files in this repository (With e.g.grep or notepad++).**

48

##### `APT_PROXY`=""

48

* **Check if your missing a required option while looking at the code**

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

##### `KEEP_APT_PROXY`=false

52

Keep the APT_PROXY settings used in the bootsrapping process in the generated image.

53

49

54

##### `APT_INCLUDES`=""

50

## Supported parameters and settings

55

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

56

57

##### `APT_INCLUDES_LATE`=""

58

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.

59

51

52

#### APT settings:

53

54

|---|---|---|---|---|

55

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

56

|APT_PROXY|string||URL|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.|

57

58

|APT_INCLUDES|string list||`packageA`,`packageB`,...|A comma-separated list of additional packages to be installed by debootstrap during bootstrapping.|

59

|APT_INCLUDES_LATE|string list||`packageA`,`packageB`,...|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.|

60

|APT_EXCLUDES|string list||`packageA`,`packageB`,...|A comma-separated list of packages to exclude. Use carefully|

60

---

61

---

61

62

#### General system settings:

63

#### General system settings:

63

##### `SET_ARCH`=32

64

64

Set Architecture to default 32bit. If you want to compile 64-bit (RPI3/RPI3+/RPI4) set it to `64`. This option will set every needed cross-compiler or board specific option for a successful build.

65

|---|---|---|---|---|

65

66

|SET_ARCH|integer|32|`32`\|`64`|Set Architecture to default 32bit. If you want to compile 64-bit (RPI3/RPI3+/RPI4) set it to `64`. This option will set every needed cross-compiler or board specific option for a successful build.|

66

##### `RPI_MODEL`=2

67

|RPI_MODEL|string|3P|`0`\|`1`\|`1P`\|`2`\|`3`\|`3P`\|`4`|Set Architecture. This option will set most build options accordingly. Specify the target Raspberry Pi hardware model.|

67

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

68

68

- `0` = Raspberry Pi 0 and Raspberry Pi 0 W

69

69

- `1` = Raspberry Pi 1 model A and B

70

|DEFLOCAL|string|en_US.UTF-8|Locale|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`.|

70

- `1P` = Raspberry Pi 1 model B+ and A+

71

|TIMEZONE|string|Europe/Berlin|Timezone|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.|

71

- `2` = Raspberry Pi 2 model B

72

72

- `3` = Raspberry Pi 3 model B

73

- `3P` = Raspberry Pi 3 model B+

74

- `4` = Raspberry Pi 4 model B

75

76

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

77

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

78

79

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

80

Set the desired Debian release architecture.

81

82

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

83

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

84

85

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

86

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

87

88

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

89

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.

90

91

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

92

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

93

73

94

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

74

---

95

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.

96

97

##### `EXPANDROOT`=true

98

Expand the root partition and filesystem automatically on first boot.

99

100

##### `ENABLE_DPHYSSWAP`=true

101

Enable swap. The size of the swapfile is chosen relative to the size of the root partition. It'll use the `dphys-swapfile` package for that.

102

75

103

##### `ENABLE_QEMU`=false

76

#### User settings:

104

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

77

78

|---|---|---|---|

79

80

81

82

83

105

84

106

---

85

---

107

86

108

#### Keyboard settings:

87

#### Keyboard settings:

88

109

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

89

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

110

90

111

##### `XKB_MODEL`=""

91

112

Set the name of the model of your keyboard type.

92

|---|---|---|---|---|

93

|XKB_MODEL|string||`pc104`|Set the name of the model of your keyboard type|

94

|XKB_LAYOUT|string||`us`|Set the supported keyboard layout(s)|

95

|XKB_VARIANT|string||`basic`|Set the supported variant(s) of the keyboard layout(s)|

96

|XKB_OPTIONS|string||`grp:alt_shift_toggle`|Set extra xkb configuration options|

113

97

114

##### `XKB_LAYOUT`=""

98

---

115

Set the supported keyboard layout(s).

99

100

#### Networking settings:

101

ethernet setting go to `/etc/systemd/network/eth0.network`.

102

wifi settings go to `/etc/systemd/network/wlan0.network`.

116

103

117

##### `XKB_VARIANT`=""

104

The default location of network configuration files in the Debian `stretch` release was changed to `/lib/systemd/network`.`

118

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

119

105

120

##### `XKB_OPTIONS`=""

106

121

Set extra xkb configuration options.

107

|---|---|---|---|

108

109

|ENABLE_WIRELESS|boolean|false|true=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 `0`,`3`,`3P`,`4`|

110

|ENABLE_IPTABLES|boolean|false|true=Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.|

111

112

|ENABLE_IFNAMES|boolean|true|true=creates complex and long interface names like e.g. encx8945924. Enable automatic assignment of predictable, stable network interface names for all NICs|

122

113

123

---

114

---

124

115

125

#### Networking settings (DHCP):

116

#### Networking settings (DHCP):

126

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

127

117

128

##### `ENABLE_DHCP`=true

118

129

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

119

120

|---|---|---|---|

121

122

130

123

131

---

124

---

132

125

133

#### Networking settings (static):

126

#### Networking settings (ethernet static):

134

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

127

The following static networking parameters are only supported if `ENABLE_ETH_DHCP` was set to `false`.

135

128

136

##### `NET_ADDRESS`=""

129

137

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

130

|---|---|---|---|

131

132

133

134

135

136

137

138

139

##### `NET_GATEWAY`=""

139

---

140

Set the IP address for the default gateway.

141

140

142

##### `NET_DNS_1`=""

141

#### Networking settings (WIFI):

143

Set the IP address for the first DNS server.

144

142

145

##### `NET_DNS_2`=""

143

146

Set the IP address for the second DNS server.

144

|---|---|---|---|

145

146

147

148

##### `NET_DNS_DOMAINS`=""

148

---

149

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

150

149

151

##### `NET_NTP_1`=""

150

#### Networking settings (WIFI static):

152

Set the IP address for the first NTP server.

151

The following static networking parameters are only supported if `ENABLE_WIFI_DHCP` was set to `false`.

153

152

154

##### `NET_NTP_2`=""

153

155

Set the IP address for the second NTP server.

154

|---|---|---|---|

155

156

157

158

159

160

161

156

162

157

---

163

---

158

164

159

#### Basic system features:

165

#### Basic system features:

160

##### `ENABLE_CONSOLE`=true

161

Enable serial console interface. Recommended if no monitor or keyboard is connected to the RPi2/3. In case of problems fe. if the network (auto) configuration failed - the serial console can be used to access the system. On RPI `0` `3` `3P` the CPU speed is locked at lowest speed.

162

163

##### `ENABLE_PRINTK`=false

164

Enables printing kernel messages to konsole. printk is `3 4 1 3` as in raspbian.

165

166

##### `ENABLE_BLUETOOTH`=false

167

Enable onboard Bluetooth interface on the RPi0/3/3P. See: [Configuring the GPIO serial port on Raspbian jessie and stretch](https://spellfoundry.com/2016/05/29/configuring-gpio-serial-port-raspbian-jessie-including-pi-3/).

168

169

##### `ENABLE_MINIUART_OVERLAY`=false

170

Enable Bluetooth to use this. Adds overlay to swap UART0 with UART1. Enabling (slower) Bluetooth and full speed serial console. - RPI `0` `3` `3P` have a fast `hardware UART0` (ttyAMA0) and a `mini UART1` (ttyS0)! RPI `1` `1P` `2` only have a `hardware UART0`. `UART0` is considered better, because is faster and more stable than `mini UART1`. By default the Bluetooth modem is mapped to the `hardware UART0` and `mini UART` is used for console. The `mini UART` is a problem for the serial console, because its baudrate depends on the CPU frequency, which is changing on runtime. Resulting in a volatile baudrate and thus in an unusable serial console.

171

172

##### `ENABLE_TURBO`=false

173

Enable Turbo mode. This setting locks cpu at the highest frequency. As setting ENABLE_CONSOLE=true locks RPI to lowest CPU speed, this is can be used additionally to lock cpu hat max speed. Need a good power supply and probably cooling for the Raspberry PI.

174

175

##### `ENABLE_I2C`=false

176

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

177

166

178

##### `ENABLE_SPI`=false

167

179

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

168

|---|---|---|---|---|

180

169

|ENABLE_CONSOLE|boolean|false|`true`\|`false`|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 `0` `3` `3P` the CPU speed is locked at lowest speed.|

181

##### `ENABLE_IPV6`=true

170

182

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

171

|ENABLE_BLUETOOTH|boolean|false|`true`\|`false`|true=Enable onboard Bluetooth interface on the RPi0/3/3P. See: [Configuring the GPIO serial port on Raspbian jessie and stretch](https://spellfoundry.com/2016/05/29/configuring-gpio-serial-port-raspbian-jessie-including-pi-3/)|

183

172

|ENABLE_MINIUART_OVERLAY|boolean|false|`true`\|`false`|true=Enable Bluetooth to use this. Adds overlay to swap UART0 with UART1. Enabling (slower) Bluetooth and full speed serial console. - RPI `0` `3` `3P` have a fast `hardware UART0` (ttyAMA0) and a `mini UART1` (ttyS0)! RPI `1` `1P` `2` only have a `hardware UART0`. `UART0` is considered better, because is faster and more stable than `mini UART1`. By default the Bluetooth modem is mapped to the `hardware UART0` and `mini UART` is used for console. The `mini UART` is a problem for the serial console, because its baudrate depends on the CPU frequency, which is changing on runtime. Resulting in a volatile baudrate and thus in an unusable serial console.|

184

##### `ENABLE_SSHD`=true

173

|ENABLE_TURBO|boolean|false|`true`\|`false`|true=Enable Turbo mode. This setting locks cpu at the highest frequency. As setting ENABLE_CONSOLE=true locks RPI to lowest CPU speed, this is can be used additionally to lock cpu hat max speed. Need a good power supply and probably cooling for the Raspberry PI|

185

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

174

186

175

187

##### `ENABLE_NONFREE`=false

176

188

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

177

189

178

190

##### `ENABLE_WIRELESS`=false

179

191

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

180

192

181

193

##### `ENABLE_RSYSLOG`=true

182

194

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

183

|ENABLE_WM|string||`blackbox`, `openbox`, `fluxbox`, `jwm`, `dwm`, `xfce4`, `awesome`|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 set true if `ENABLE_WM` is used|

195

184

196

##### `ENABLE_SOUND`=true

185

197

Enable sound hardware and install Advanced Linux Sound Architecture.

186

198

187

199

##### `ENABLE_HWRANDOM`=true

188

|DISABLE_UNDERVOLT_WARNINGS|integer||`1`\|`2`|Unset to keep default behaviour. 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|

200

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

201

202

##### `ENABLE_MINGPU`=false

203

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

204

205

##### `ENABLE_DBUS`=true

206

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

207

208

##### `ENABLE_XORG`=false

209

Install Xorg open-source X Window System.

210

211

##### `ENABLE_WM`=""

212

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

213

214

##### `ENABLE_SYSVINIT`=false

215

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

216

189

217

---

190

---

218

191

219

#### Advanced system features:

192

#### Advanced system features:

220

##### `ENABLE_KEYGEN`=false

221

Recover your lost codec license

222

223

##### `ENABLE_SYSTEMDSWAP`=false

224

Enables [Systemd-swap service](https://github.com/Nefelim4ag/systemd-swap). Usefull if `KERNEL_ZSWAP` is enabled.

225

226

##### `ENABLE_MINBASE`=false

227

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

228

229

##### `ENABLE_REDUCE`=false

230

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

231

232

##### `ENABLE_UBOOT`=false

233

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

234

RPI4 needs tbd

235

236

##### `UBOOTSRC_DIR`=""

237

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.

238

239

##### `ENABLE_FBTURBO`=false

240

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.

241

242

##### `FBTURBOSRC_DIR`=""

243

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.

244

245

##### `ENABLE_VIDEOCORE`=false

246

Install and enable the [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.

247

248

##### `VIDEOCORESRC_DIR`=""

249

Path to a directory (`userland`) of [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.

250

251

##### `ENABLE_NEXMON`=false

252

Install and enable the [Source code for a C-based firmware patching framework for Broadcom/Cypress WiFi chips that enables you to write your own firmware patches, for example, to enable monitor mode with radiotap headers and frame injection](https://github.com/seemoo-lab/nexmon.git).

253

254

##### `NEXMONSRC_DIR`=""

255

Path to a directory (`nexmon`) 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.

256

257

##### `ENABLE_IPTABLES`=false

258

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

259

260

##### `ENABLE_USER`=true

261

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

262

263

##### `USER_NAME`=pi

264

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

265

266

##### `ENABLE_ROOT`=false

267

Set root user password so root login will be enabled

268

269

##### `ENABLE_HARDNET`=false

270

Enable IPv4/IPv6 network stack hardening settings.

271

193

272

##### `ENABLE_SPLITFS`=false

194

273

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

195

|---|---|---|---|---|

274

196

275

##### `CHROOT_SCRIPTS`=""

197

276

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.

198

|ENABLE_QEMU|boolean|false|`true`\|`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|

277

199

|QEMU_BINARY|string||`FullPathToQemuBinaryFile`|Sets the QEMU enviornment for the Debian archive. **Set by RPI_MODEL**|

278

##### `ENABLE_INITRAMFS`=false

200

279

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.

201

280

202

281

##### `ENABLE_IFNAMES`=true

203

|ENABLE_INITRAMFS|boolean|false|`true`\|`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|

282

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

204

283

205

284

##### `ENABLE_SPLASH`=true

206

|CHROOT_SCRIPTS|string||`FullPathToScriptFolder`|Full 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|

285

Enable default Raspberry Pi boot up rainbow splash screen.

207

|ENABLE_UBOOT|boolean|false|`true`\|`false`|Replace the default RPi 0/1/2/3 second stage bootloader (bootcode.bin) with [U-Boot bootloader](https://git.denx.de/?p=u-boot.git;a=summary). U-Boot can boot images via the network using the BOOTP/TFTP protocol. RPI4 needs tbd|

286

208

|UBOOTSRC_DIR|string||`FullPathToUBootFolder`|Full path to a directory named `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|

287

##### `ENABLE_LOGO`=true

209

|ENABLE_FBTURBO|boolean|false|`true`\|`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|

288

Enable default Raspberry Pi console logo (image of four raspberries in the top left corner).

210

|FBTURBOSRC_DIR|string||`FullPathToFbTurboFolder`|Full path to a directory named `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|

289

211

|ENABLE_VIDEOCORE|boolean|false|`true`\|`false`|Install and enable the [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|

290

##### `ENABLE_SILENT_BOOT`=false

212

|VIDEOCORESRC_DIR|string||`FullPathToVideoSrcFolder`|Full path to a directory named `userland` of [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|

291

Set the verbosity of console messages shown during boot up to a strict minimum.

213

|ENABLE_NEXMON|boolean|false|`true`\|`false`|Install and enable the source code for a C-based firmware patching framework for Broadcom/Cypress WiFi chips that enables you to write your own firmware patches, for example, to enable monitor mode with radiotap headers and frame injection](https://github.com/seemoo-lab/nexmon.git)|

292

214

|NEXMONSRC_DIR|string||`FullPathToNexmonFolder`|Full path to a directory named `nexmon` 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|

293

##### `DISABLE_UNDERVOLT_WARNINGS`=

294

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.

295

215

296

---

216

---

297

217

298

#### SSH settings:

218

#### SSH settings:

299

##### `SSH_ENABLE_ROOT`=false

300

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

301

219

302

##### `SSH_DISABLE_PASSWORD_AUTH`=false

220

303

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

221

|---|---|---|---|---|

304

222

305

##### `SSH_LIMIT_USERS`=false

223

306

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

224

307

225

|SSH_ROOT_PUB_KEY|string||`PathToYourROOT` `RSAPublicKeyFile`|Full path to file. 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`|

308

##### `SSH_ROOT_PUB_KEY`=""

226

|SSH_USER_PUB_KEY|string||`PathToYourUSER` `RSAPublicKeyFile`|Full path to file. 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|

309

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

310

311

##### `SSH_USER_PUB_KEY`=""

312

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.

313

227

314

---

228

---

315

229

316

#### Kernel ~~compilation~~:

230

#### Kernel settings:

317

##### `BUILD_KERNEL`=true

231

318

Build and install the latest RPi 0/1/2/3/4 Linux kernel. The default RPi 0/1/2/3/ kernel configuration is used most of the time.

232

319

ENABLE_NEXMON - Changes Kernel Source to [https://github.com/Re4son/](Kali Linux Kernel)

233

|---|---|---|---|---|

320

Precompiled 32bit kernel for RPI0/1/2/3 by [https://github.com/hypriot/](hypriot)

234

|BUILD_KERNEL||true|`true`\|`false`|Build and install the latest RPi 0/1/2/3/4 Linux kernel. The default RPi 0/1/2/3/ kernel configuration is used most of the time. ENABLE_NEXMON - Changes Kernel Source to [https://github.com/Re4son/](Kali Linux Kernel) Precompiled 32bit kernel for RPI0/1/2/3 by [https://github.com/hypriot/](hypriot) Precompiled 64bit kernel for RPI3/4 by [https://github.com/sakaki-/](sakaki)|

321

Precompiled 64bit kernel for RPI3/4 by [https://github.com/sakaki-/](sakaki)

235

|CROSS_COMPILE|string|||This sets the cross-compile environment for the compiler. Set by RPI_MODEL|

322

236

|KERNEL_ARCH|string|||This sets the kernel architecture for the compiler. Set by RPI_MODEL|

323

237

|KERNEL_IMAGE|string|||Name of the image file in the boot partition. Set by RPI_MODEL|

324

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

238

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

325

This sets the cross-compile environment for the compiler.

239

|KERNEL_DEFCONFIG|string|||Sets the default config for kernel compiling. Set by RPI_MODEL|

326

240

|KERNEL_THREADS|integer|1|`1`\|`2`\|`3`\|...|Number of threads to build the kernel. If not set, the script will automatically determine the maximum number of CPU cores to speed up kernel compilation|

327

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

241

328

This sets the kernel architecture for the compiler.

242

329

243

330

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

244

331

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.

245

332

246

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

333

##### `KERNEL_BRANCH`=""

247

|KERNELSRC_CLEAN|boolean|false|`true`\|`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|

334

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

248

|KERNELSRC_CONFIG|boolean|true|`true`\|`false`|true=enable custom kernel options. 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|

335

249

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

336

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

250

|KERNELSRC_PREBUILT|boolean|false|`true`\|`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|

337

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.

251

|RPI_FIRMWARE_DIR|string||`FullPathToFolder`|Full path to a directory named `firmware`, containing a local copy of the firmware from the [RaspberryPi firmware project](https://github.com/raspberrypi/firmware). Default is to download the latest firmware directly from the project|

338

252

339

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

253

340

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

254

341

255

342

##### `KERNEL_REDUCE`=false

256

|KERNEL_BPF|boolean|true|`true`\|`false`|Allow attaching eBPF programs to a cgroup using the bpf syscall (CONFIG_BPF_SYSCALL CONFIG_CGROUP_BPF) [systemd wants 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]|

343

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

257

344

258

345

##### `KERNEL_THREADS`=1

259

346

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.

260

347

261

348

##### `KERNEL_HEADERS`=true

349

Install kernel headers with the built kernel.

350

351

##### `KERNEL_MENUCONFIG`=false

352

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

353

354

##### `KERNEL_OLDDEFCONFIG`=false

355

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

356

357

##### `KERNEL_CCACHE`=false

358

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

359

360

##### `KERNEL_REMOVESRC`=true

361

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

362

363

##### `KERNELSRC_DIR`=""

364

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.

365

366

##### `KERNELSRC_CLEAN`=false

367

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.

368

369

##### `KERNELSRC_CONFIG`=true

370

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.

371

372

##### `KERNELSRC_USRCONFIG`=""

373

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

374

375

##### `KERNELSRC_PREBUILT`=false

376

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.

377

378

##### `RPI_FIRMWARE_DIR`=""

379

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.

380

381

##### `KERNEL_DEFAULT_GOV`="ONDEMAND"

382

Set the default cpu governor at kernel compilation. Supported values are: PERFORMANCE POWERSAVE USERSPACE ONDEMAND CONSERVATIVE SCHEDUTIL

383

384

##### `KERNEL_NF`=false

385

Enable Netfilter modules as kernel modules

386

387

##### `KERNEL_VIRT`=false

388

Enable Kernel KVM support (/dev/kvm)

389

390

##### `KERNEL_ZSWAP`=false

391

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

392

393

##### `KERNEL_BPF`=true

394

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]

395

396

##### `KERNEL_SECURITY`=false

397

Enables Apparmor, integrity subsystem, auditing.

398

399

##### `KERNEL_BTRFS`="false"

400

enable btrfs kernel support

401

402

##### `KERNEL_POEHAT`="false"

403

enable Enable RPI POE HAT fan kernel support

404

405

##### `KERNEL_NSPAWN`="false"

406

Enable per-interface network priority control - for systemd-nspawn

407

408

##### `KERNEL_DHKEY`="true"

409

Diffie-Hellman operations on retained keys - required for >keyutils-1.6

410

262

411

---

263

---

412

264

413

#### Reduce disk usage:

265

#### Reduce disk usage:

414

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

266

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

415

267

416

##### `REDUCE_APT`=true

268

417

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

269

|---|---|---|---|---|

418

270

419

##### `REDUCE_DOC`=true

271

420

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

272

421

273

422

##### `REDUCE_MAN`=true

274

423

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

275

424

276

425

##### `REDUCE_VIM`=false

277

426

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

278

427

279

428

##### `REDUCE_BASH`=false

429

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

430

431

##### `REDUCE_HWDB`=true

432

Remove PCI related hwdb files (experimental).

433

434

##### `REDUCE_SSHD`=true

435

Replace `openssh-server` with `dropbear`.

436

437

##### `REDUCE_LOCALE`=true

438

Remove all `locale` translation files.

439

440

---

280

---

441

281

442

#### Encrypted root partition:

282

#### Encrypted root partition:

443

##### `ENABLE_CRYPTFS`=false

283

#### On first boot, you will be asked to enter you password several time

444

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.

284

#### See cryptsetup options for a more information about opttion values(https://wiki.archlinux.org/index.php/Dm-crypt/Device_encryption)

445

285

446

##### `CRYPTFS_PASSWORD`=""

286

447

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

287

|---|---|---|---|---|

448

288

|ENABLE_CRYPTFS|boolean|false|`true`\|`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|

449

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

289

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

450

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

290

451

291

452

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

292

|CRYPTFS_HASH|string|sha256|`sha256`\|`sha512`|cryptsetup hash algorithm|

453

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

293

|CRYPTFS_XTSKEYSIZE|integer|256|`256`\|`512`||Sets key size in bits. The argument has to be a multiple of 8|

454

294

455

##### `CRYPTFS_HASH`=sha512

295

|CRYPTFS_DROPBEAR_PUBKEY|string||`PathToYourPublicDropbearKeyFile`|Full path to dropbear Public RSA-OpenSSH Key|

456

Hash function and size to be used

457

458

##### `CRYPTFS_XTSKEYSIZE`=512

459

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

460

461

##### `CRYPTFS_DROPBEAR`=false

462

Enable Dropbear Initramfs support

463

464

##### `CRYPTFS_DROPBEAR_PUBKEY`=""

465

Provide path to dropbear Public RSA-OpenSSH Key

466

296

467

---

297

---

468

298

469

#### Build settings:

299

#### Build settings:

470

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

300

471

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

301

|---|---|---|---|---|

302

|BASEDIR|string||`FullPathToScriptRootDir`|If unset start from scriptroot or set to Full path to rpi123-gen-image directory|

303

|IMAGE_NAME|string||`YourImageName`|if unset creates a name after this template: rpi`RPI_MODEL`-`RELEASE`-`RELEASE_ARCH`|

472

304

473

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

305

---

474

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.

475

306

476

## Understanding the script

307

## Understanding the script

477

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:

308

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:

	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