##// END OF EJS Templates
Raspi2-3_GenImage
RSS

Cloner depuis https://github.com/drtyhlpr/rpi23-gen-image.git

Update README.md
burnbabyburn -
r638:3a396ff9cbc0
parent child
Show More
Show file before | Show file after | Hide comments
@@ -1,550 +1,553
1 1 # rpi23-gen-image
2 2 ## Introduction
3 3 `rpi23-gen-image.sh` is an advanced Debian Linux bootstrapping shell script for generating Debian OS images for all Raspberry Pi computers. The script at this time supports the bootstrapping of the Debian (armhf/armel) releases `stretch` and `buster`. Raspberry Pi 0/1/2/3 images are generated for 32-bit mode only. Raspberry Pi 3 supports 64-bit images that can be generated using custom configuration parameters (```templates/rpi3-stretch-arm64-4.14.y```).
4 4
5 5 ## Build dependencies
6 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 7
8 8 ```debootstrap debian-archive-keyring qemu-user-static binfmt-support dosfstools rsync bmap-tools whois git bc psmisc dbus sudo```
9 9
10 10 It is recommended to configure the `rpi23-gen-image.sh` script to build and install the latest Raspberry Pi Linux kernel. For the Raspberry 3 this is mandatory. Kernel compilation and linking will be performed on the build system using an ARM (armhf/armel) cross-compiler toolchain.
11 11
12 12 The script has been tested using the default `crossbuild-essential-armhf` and `crossbuild-essential-armel` toolchain meta packages on Debian Linux `stretch` build systems. Please check the [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains) for further information.
13 13
14 14 ## Command-line parameters
15 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 16
17 17 ##### Command-line examples:
18 18 ```shell
19 19 ENABLE_UBOOT=true ./rpi23-gen-image.sh
20 20 ENABLE_CONSOLE=false ENABLE_IPV6=false ./rpi23-gen-image.sh
21 21 ENABLE_WM=xfce4 ENABLE_FBTURBO=true ENABLE_MINBASE=true ./rpi23-gen-image.sh
22 22 ENABLE_HARDNET=true ENABLE_IPTABLES=true /rpi23-gen-image.sh
23 23 APT_SERVER=ftp.de.debian.org APT_PROXY="http://127.0.0.1:3142/" ./rpi23-gen-image.sh
24 24 ENABLE_MINBASE=true ./rpi23-gen-image.sh
25 25 BUILD_KERNEL=true ENABLE_MINBASE=true ENABLE_IPV6=false ./rpi23-gen-image.sh
26 26 BUILD_KERNEL=true KERNELSRC_DIR=/tmp/linux ./rpi23-gen-image.sh
27 27 ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh
28 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 29 RELEASE=stretch BUILD_KERNEL=true ./rpi23-gen-image.sh
30 30 RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
31 31 RELEASE=stretch RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
32 32 ```
33 33
34 34 ## Configuration template files
35 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 36
37 37 ##### Command-line examples:
38 38 ```shell
39 39 CONFIG_TEMPLATE=rpi3stretch ./rpi23-gen-image.sh
40 40 CONFIG_TEMPLATE=rpi2stretch ./rpi23-gen-image.sh
41 41 ```
42 42
43 43 ## Supported parameters and settings
44 44 #### APT settings:
45 45 ##### `APT_SERVER`="ftp.debian.org"
46 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 47
48 48 ##### `APT_PROXY`=""
49 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 50
51 51 ##### `KEEP_APT_PROXY`=false
52 52 Keep the APT_PROXY settings used in the bootsrapping process in the generated image.
53 53
54 54 ##### `APT_INCLUDES`=""
55 55 A comma-separated list of additional packages to be installed by debootstrap during bootstrapping.
56 56
57 57 ##### `APT_INCLUDES_LATE`=""
58 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 59
60 60 ---
61 61
62 62 #### General system settings:
63 63 ##### `SET_ARCH`=32
64 64 Set Architecture to default 32bit. If you want to compile 64-bit (RPI3 or RPI3+) set it to `64`. This option will set every needed cross-compiler or board specific option for a successful build.
65 65
66 66 ##### `RPI_MODEL`=2
67 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 70 - `1P` = Raspberry Pi 1 model B+ and A+
71 71 - `2` = Raspberry Pi 2 model B
72 72 - `3` = Raspberry Pi 3 model B
73 73 - `3P` = Raspberry Pi 3 model B+
74 74
75 75 ##### `RELEASE`="buster"
76 76 Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases `stretch` and `buster`.
77 77
78 78 ##### `RELEASE_ARCH`="armhf"
79 79 Set the desired Debian release architecture.
80 80
81 81 ##### `HOSTNAME`="rpi$RPI_MODEL-$RELEASE"
82 82 Set system hostname. It's recommended that the hostname is unique in the corresponding subnet.
83 83
84 84 ##### `PASSWORD`="raspberry"
85 85 Set system `root` password. It's **STRONGLY** recommended that you choose a custom password.
86 86
87 87 ##### `USER_PASSWORD`="raspberry"
88 88 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.
89 89
90 90 ##### `DEFLOCAL`="en_US.UTF-8"
91 91 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`.
92 92
93 93 ##### `TIMEZONE`="Europe/Berlin"
94 94 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.
95 95
96 96 ##### `EXPANDROOT`=true
97 97 Expand the root partition and filesystem automatically on first boot.
98 98
99 99 ##### `ENABLE_DPHYSSWAP`=true
100 100 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.
101 101
102 102 ##### `ENABLE_QEMU`=false
103 103 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.
104 104
105 105 ---
106 106
107 107 #### Keyboard settings:
108 108 These options are used to configure keyboard layout in `/etc/default/keyboard` for console and Xorg. These settings can also be changed inside the running OS using the `dpkg-reconfigure keyboard-configuration` command.
109 109
110 110 ##### `XKB_MODEL`=""
111 111 Set the name of the model of your keyboard type.
112 112
113 113 ##### `XKB_LAYOUT`=""
114 114 Set the supported keyboard layout(s).
115 115
116 116 ##### `XKB_VARIANT`=""
117 117 Set the supported variant(s) of the keyboard layout(s).
118 118
119 119 ##### `XKB_OPTIONS`=""
120 120 Set extra xkb configuration options.
121 121
122 122 ---
123 123
124 124 #### Networking settings (DHCP):
125 125 This parameter is used to set up networking auto-configuration in `/etc/systemd/network/eth.network`. The default location of network configuration files in the Debian `stretch` release was changed to `/lib/systemd/network`.`
126 126
127 127 ##### `ENABLE_DHCP`=true
128 128 Set the system to use DHCP. This requires an DHCP server.
129 129
130 130 ---
131 131
132 132 #### Networking settings (static):
133 133 These parameters are used to set up a static networking configuration in `/etc/systemd/network/eth.network`. The following static networking parameters are only supported if `ENABLE_DHCP` was set to `false`. The default location of network configuration files in the Debian `stretch` release was changed to `/lib/systemd/network`.
134 134
135 135 ##### `NET_ADDRESS`=""
136 136 Set a static IPv4 or IPv6 address and its prefix, separated by "/", eg. "192.169.0.3/24".
137 137
138 138 ##### `NET_GATEWAY`=""
139 139 Set the IP address for the default gateway.
140 140
141 141 ##### `NET_DNS_1`=""
142 142 Set the IP address for the first DNS server.
143 143
144 144 ##### `NET_DNS_2`=""
145 145 Set the IP address for the second DNS server.
146 146
147 147 ##### `NET_DNS_DOMAINS`=""
148 148 Set the default DNS search domains to use for non fully qualified hostnames.
149 149
150 150 ##### `NET_NTP_1`=""
151 151 Set the IP address for the first NTP server.
152 152
153 153 ##### `NET_NTP_2`=""
154 154 Set the IP address for the second NTP server.
155 155
156 156 ---
157 157
158 158 #### Basic system features:
159 159 ##### `ENABLE_CONSOLE`=true
160 160 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.
161 161
162 162 ##### `ENABLE_PRINTK`=false
163 163 Enables printing kernel messages to konsole. printk is `3 4 1 3` as in raspbian.
164 164
165 165 ##### `ENABLE_BLUETOOTH`=false
166 166 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/).
167 167
168 168 ##### `ENABLE_MINIUART_OVERLAY`=false
169 169 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.
170 170
171 171 ##### `ENABLE_TURBO`=false
172 172 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.
173 173
174 174 ##### `ENABLE_I2C`=false
175 175 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.
176 176
177 177 ##### `ENABLE_SPI`=false
178 178 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.
179 179
180 180 ##### `ENABLE_IPV6`=true
181 181 Enable IPv6 support. The network interface configuration is managed via systemd-networkd.
182 182
183 183 ##### `ENABLE_SSHD`=true
184 184 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.
185 185
186 186 ##### `ENABLE_NONFREE`=false
187 187 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.
188 188
189 189 ##### `ENABLE_WIRELESS`=false
190 190 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`.
191 191
192 192 ##### `ENABLE_RSYSLOG`=true
193 193 If set to false, disable and uninstall rsyslog (so logs will be available only in journal files)
194 194
195 195 ##### `ENABLE_SOUND`=true
196 196 Enable sound hardware and install Advanced Linux Sound Architecture.
197 197
198 198 ##### `ENABLE_HWRANDOM`=true
199 199 Enable Hardware Random Number Generator. Strong random numbers are important for most network-based communications that use encryption. It's recommended to be enabled.
200 200
201 201 ##### `ENABLE_MINGPU`=false
202 202 Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU.
203 203
204 204 ##### `ENABLE_DBUS`=true
205 205 Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled.
206 206
207 207 ##### `ENABLE_XORG`=false
208 208 Install Xorg open-source X Window System.
209 209
210 210 ##### `ENABLE_WM`=""
211 211 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`.
212 212
213 213 ##### `ENABLE_SYSVINIT`=false
214 214 Support for halt,init,poweroff,reboot,runlevel,shutdown,telinit commands
215 215
216 216 ---
217 217
218 218 #### Advanced system features:
219 219 ##### `ENABLE_KEYGEN`=false
220 220 Recover your lost codec license
221 221 ##### `ENABLE_SYSTEMDSWAP`=false
222 222 Enables [Systemd-swap service](https://github.com/Nefelim4ag/systemd-swap). Usefull if `KERNEL_ZSWAP` is enabled.
223 223
224 224 ##### `ENABLE_MINBASE`=false
225 225 Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
226 226
227 227 ##### `ENABLE_REDUCE`=false
228 228 Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.
229 229
230 230 ##### `ENABLE_UBOOT`=false
231 231 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.
232 232
233 233 ##### `UBOOTSRC_DIR`=""
234 234 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.
235 235
236 236 ##### `ENABLE_FBTURBO`=false
237 237 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.
238 238
239 239 ##### `FBTURBOSRC_DIR`=""
240 240 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.
241 241
242 242 ##### `ENABLE_VIDEOCORE`=false
243 243 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.
244 244
245 245 ##### `VIDEOCORESRC_DIR`=""
246 246 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.
247 247
248 248 ##### `ENABLE_NEXMON`=false
249 249 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).
250 250
251 251 ##### `NEXMONSRC_DIR`=""
252 252 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.
253 253
254 254 ##### `ENABLE_IPTABLES`=false
255 255 Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.
256 256
257 257 ##### `ENABLE_USER`=true
258 258 Create non-root user with password `USER_PASSWORD`=raspberry. Unless overridden with `USER_NAME`=user, the username will be `pi`.
259 259
260 260 ##### `USER_NAME`=pi
261 261 Non-root user to create. Ignored if `ENABLE_USER`=false
262 262
263 263 ##### `ENABLE_ROOT`=false
264 264 Set root user password so root login will be enabled
265 265
266 266 ##### `ENABLE_HARDNET`=false
267 267 Enable IPv4/IPv6 network stack hardening settings.
268 268
269 269 ##### `ENABLE_SPLITFS`=false
270 270 Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.
271 271
272 272 ##### `CHROOT_SCRIPTS`=""
273 273 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.
274 274
275 275 ##### `ENABLE_INITRAMFS`=false
276 276 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.
277 277
278 278 ##### `ENABLE_IFNAMES`=true
279 279 Enable automatic assignment of predictable, stable network interface names for all local Ethernet, WLAN interfaces. This might create complex and long interface names.
280 280
281 281 ##### `ENABLE_SPLASH`=true
282 282 Enable default Raspberry Pi boot up rainbow splash screen.
283 283
284 284 ##### `ENABLE_LOGO`=true
285 285 Enable default Raspberry Pi console logo (image of four raspberries in the top left corner).
286 286
287 287 ##### `ENABLE_SILENT_BOOT`=false
288 288 Set the verbosity of console messages shown during boot up to a strict minimum.
289 289
290 290 ##### `DISABLE_UNDERVOLT_WARNINGS`=
291 291 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.
292 292
293 293 ---
294 294
295 295 #### SSH settings:
296 296 ##### `SSH_ENABLE_ROOT`=false
297 297 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`.
298 298
299 299 ##### `SSH_DISABLE_PASSWORD_AUTH`=false
300 300 Disable password-based SSH authentication. Only public key based SSH (v2) authentication will be supported.
301 301
302 302 ##### `SSH_LIMIT_USERS`=false
303 303 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).
304 304
305 305 ##### `SSH_ROOT_PUB_KEY`=""
306 306 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`.
307 307
308 308 ##### `SSH_USER_PUB_KEY`=""
309 309 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.
310 310
311 311 ---
312 312
313 313 #### Kernel compilation:
314 314 ##### `BUILD_KERNEL`=true
315 315 Build and install the latest RPi 0/1/2/3 Linux kernel. Currently only the default RPi 0/1/2/3 kernel configuration is used.
316 316
317 317 ##### `CROSS_COMPILE`="arm-linux-gnueabihf-"
318 318 This sets the cross-compile environment for the compiler.
319 319
320 320 ##### `KERNEL_ARCH`="arm"
321 321 This sets the kernel architecture for the compiler.
322 322
323 323 ##### `KERNEL_IMAGE`="kernel7.img"
324 324 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.
325 325
326 326 ##### `KERNEL_BRANCH`=""
327 327 Name of the requested branch from the GIT location for the RPi Kernel. Default is using the current default branch from the GIT site.
328 328
329 329 ##### `QEMU_BINARY`="/usr/bin/qemu-arm-static"
330 330 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.
331 331
332 332 ##### `KERNEL_DEFCONFIG`="bcm2709_defconfig"
333 333 Sets the default config for kernel compiling. If not set, `KERNEL_DEFCONFIG` will be set to "bcmrpi3\_defconfig" automatically if building for arm64.
334 334
335 335 ##### `KERNEL_REDUCE`=false
336 336 Reduce the size of the generated kernel by removing unwanted devices, network and filesystem drivers (experimental).
337 337
338 338 ##### `KERNEL_THREADS`=1
339 339 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.
340 340
341 341 ##### `KERNEL_HEADERS`=true
342 342 Install kernel headers with the built kernel.
343 343
344 344 ##### `KERNEL_MENUCONFIG`=false
345 345 Start `make menuconfig` interactive menu-driven kernel configuration. The script will continue after `make menuconfig` was terminated.
346 346
347 347 ##### `KERNEL_OLDDEFCONFIG`=false
348 348 Run `make olddefconfig` to automatically set all new kernel configuration options to their recommended default values.
349 349
350 350 ##### `KERNEL_CCACHE`=false
351 351 Compile the kernel using ccache. This speeds up kernel recompilation by caching previous compilations and detecting when the same compilation is being done again.
352 352
353 353 ##### `KERNEL_REMOVESRC`=true
354 354 Remove all kernel sources from the generated OS image after it was built and installed.
355 355
356 356 ##### `KERNELSRC_DIR`=""
357 357 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.
358 358
359 359 ##### `KERNELSRC_CLEAN`=false
360 360 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.
361 361
362 362 ##### `KERNELSRC_CONFIG`=true
363 363 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.
364 364
365 365 ##### `KERNELSRC_USRCONFIG`=""
366 366 Copy own config file to kernel `.config`. If `KERNEL_MENUCONFIG`=true then running after copy.
367 367
368 368 ##### `KERNELSRC_PREBUILT`=false
369 369 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.
370 370
371 371 ##### `RPI_FIRMWARE_DIR`=""
372 372 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.
373 373
374 374 ##### `KERNEL_DEFAULT_GOV`="ONDEMAND"
375 375 Set the default cpu governor at kernel compilation. Supported values are: PERFORMANCE POWERSAVE USERSPACE ONDEMAND CONSERVATIVE SCHEDUTIL
376 376
377 377 ##### `KERNEL_NF`=false
378 378 Enable Netfilter modules as kernel modules
379 379
380 380 ##### `KERNEL_VIRT`=false
381 381 Enable Kernel KVM support (/dev/kvm)
382 382
383 383 ##### `KERNEL_ZSWAP`=false
384 384 Enable Kernel Zswap support. Best use on high RAM load and mediocre CPU load usecases
385 385
386 386 ##### `KERNEL_BPF`=true
387 387 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]
388 388
389 389 ##### `KERNEL_SECURITY`=false
390 390 Enables Apparmor, integrity subsystem, auditing.
391 391
392 392 ---
393 393
394 394 #### Reduce disk usage:
395 395 The following list of parameters is ignored if `ENABLE_REDUCE`=false.
396 396
397 397 ##### `REDUCE_APT`=true
398 398 Configure APT to use compressed package repository lists and no package caching files.
399 399
400 400 ##### `REDUCE_DOC`=true
401 401 Remove all doc files (harsh). Configure APT to not include doc files on future `apt-get` package installations.
402 402
403 403 ##### `REDUCE_MAN`=true
404 404 Remove all man pages and info files (harsh). Configure APT to not include man pages on future `apt-get` package installations.
405 405
406 406 ##### `REDUCE_VIM`=false
407 407 Replace `vim-tiny` package by `levee` a tiny vim clone.
408 408
409 409 ##### `REDUCE_BASH`=false
410 410 Remove `bash` package and switch to `dash` shell (experimental).
411 411
412 412 ##### `REDUCE_HWDB`=true
413 413 Remove PCI related hwdb files (experimental).
414 414
415 415 ##### `REDUCE_SSHD`=true
416 416 Replace `openssh-server` with `dropbear`.
417 417
418 418 ##### `REDUCE_LOCALE`=true
419 419 Remove all `locale` translation files.
420 420
421 421 ---
422 422
423 423 #### Encrypted root partition:
424 ##### `KERNEL_CRYPTFS`=false
425 Enable Kernel Moduls for crypto
426
424 427 ##### `ENABLE_CRYPTFS`=false
425 428 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.
426 429
427 430 ##### `CRYPTFS_PASSWORD`=""
428 431 Set password of the encrypted root partition. This parameter is mandatory if `ENABLE_CRYPTFS`=true.
429 432
430 433 ##### `CRYPTFS_MAPPING`="secure"
431 434 Set name of dm-crypt managed device-mapper mapping.
432 435
433 436 ##### `CRYPTFS_CIPHER`="aes-xts-plain64:sha512"
434 437 Set cipher specification string. `aes-xts*` ciphers are strongly recommended.
435 438
436 439 ##### `CRYPTFS_XTSKEYSIZE`=512
437 440 Sets key size in bits. The argument has to be a multiple of 8.
438 441
439 442 ##### `CRYPTFS_DROPBEAR`=false
440 443 Enable Dropbear Initramfs support
441 444
442 445 ##### `CRYPTFS_DROPBEAR_PUBKEY`=""
443 446 Provide path to dropbear Public RSA-OpenSSH Key
444 447
445 448 ---
446 449
447 450 #### Build settings:
448 451 ##### `BASEDIR`=$(pwd)/images/${RELEASE}
449 452 Set a path to a working directory used by the script to generate an image.
450 453
451 454 ##### `IMAGE_NAME`=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}
452 455 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.
453 456
454 457 ## Understanding the script
455 458 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:
456 459
457 460 | Script | Description |
458 461 | --- | --- |
459 462 | `10-bootstrap.sh` | Debootstrap basic system |
460 463 | `11-apt.sh` | Setup APT repositories |
461 464 | `12-locale.sh` | Setup Locales and keyboard settings |
462 465 | `13-kernel.sh` | Build and install RPi 0/1/2/3 Kernel |
463 466 | `14-fstab.sh` | Setup fstab and initramfs |
464 467 | `15-rpi-config.sh` | Setup RPi 0/1/2/3 config and cmdline |
465 468 | `20-networking.sh` | Setup Networking |
466 469 | `21-firewall.sh` | Setup Firewall |
467 470 | `30-security.sh` | Setup Users and Security settings |
468 471 | `31-logging.sh` | Setup Logging |
469 472 | `32-sshd.sh` | Setup SSH and public keys |
470 473 | `41-uboot.sh` | Build and Setup U-Boot |
471 474 | `42-fbturbo.sh` | Build and Setup fbturbo Xorg driver |
472 475 | `43-videocore.sh` | Build and Setup videocore libraries |
473 476 | `50-firstboot.sh` | First boot actions |
474 477 | `99-reduce.sh` | Reduce the disk space usage |
475 478
476 479 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.
477 480
478 481 | Directory | Description |
479 482 | --- | --- |
480 483 | `apt` | APT management configuration files |
481 484 | `boot` | Boot and RPi 0/1/2/3 configuration files |
482 485 | `dpkg` | Package Manager configuration |
483 486 | `etc` | Configuration files and rc scripts |
484 487 | `firstboot` | Scripts that get executed on first boot |
485 488 | `initramfs` | Initramfs scripts |
486 489 | `iptables` | Firewall configuration files |
487 490 | `locales` | Locales configuration |
488 491 | `modules` | Kernel Modules configuration |
489 492 | `mount` | Fstab configuration |
490 493 | `network` | Networking configuration files |
491 494 | `sysctl.d` | Swapping and Network Hardening configuration |
492 495 | `xorg` | fbturbo Xorg driver configuration |
493 496
494 497 ## Custom packages and scripts
495 498 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`.
496 499
497 500 Scripts in the custom.d directory will be executed after all other installation is complete but before the image is created.
498 501
499 502 ## Logging of the bootstrapping process
500 503 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:
501 504
502 505 ```shell
503 506 script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log
504 507 ```
505 508
506 509 ## Flashing the image file
507 510 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 RPi 0/1/2/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`.
508 511
509 512 ##### Flashing examples:
510 513 ```shell
511 514 bmaptool copy ./images/buster/2017-01-23-rpi3-buster.img /dev/mmcblk0
512 515 dd bs=4M if=./images/buster/2017-01-23-rpi3-buster.img of=/dev/mmcblk0
513 516 ```
514 517 If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:
515 518 ```shell
516 519 bmaptool copy ./images/buster/2017-01-23-rpi3-buster-frmw.img /dev/mmcblk0
517 520 bmaptool copy ./images/buster/2017-01-23-rpi3-buster-root.img /dev/sdc
518 521 ```
519 522
520 523 ## QEMU emulation
521 524 Start QEMU full system emulation:
522 525 ```shell
523 526 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"
524 527 ```
525 528
526 529 Start QEMU full system emulation and output to console:
527 530 ```shell
528 531 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
529 532 ```
530 533
531 534 Start QEMU full system emulation with SMP and output to console:
532 535 ```shell
533 536 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
534 537 ```
535 538
536 539 Start QEMU full system emulation with cryptfs, initramfs and output to console:
537 540 ```shell
538 541 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
539 542 ```
540 543
541 544 ## External links and references
542 545 * [Debian worldwide mirror sites](https://www.debian.org/mirror/list)
543 546 * [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)
544 547 * [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains)
545 548 * [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)
546 549 * [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)
547 550 * [U-BOOT git repository](https://git.denx.de/?p=u-boot.git;a=summary)
548 551 * [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)
549 552 * [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm)
550 553 * [Collabora RPi2 Kernel precompiled](https://repositories.collabora.co.uk/debian/)
General Comments 0
Vous devez vous connecter pour laisser un commentaire. Se connecter maintenant