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

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

Update README.md
burnbabyburn -
r631:a7510c85d670
parent child
Show More
Show file before | Show file after | Hide comments
@@ -1,548 +1,550
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 ##### `ENABLE_KEYGEN`=false
220 Recover your lost codec license
219 221 ##### `ENABLE_SYSTEMDSWAP`=false
220 222 Enables [Systemd-swap service](https://github.com/Nefelim4ag/systemd-swap). Usefull if `KERNEL_ZSWAP` is enabled.
221 223
222 224 ##### `ENABLE_MINBASE`=false
223 225 Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
224 226
225 227 ##### `ENABLE_REDUCE`=false
226 228 Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.
227 229
228 230 ##### `ENABLE_UBOOT`=false
229 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.
230 232
231 233 ##### `UBOOTSRC_DIR`=""
232 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.
233 235
234 236 ##### `ENABLE_FBTURBO`=false
235 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.
236 238
237 239 ##### `FBTURBOSRC_DIR`=""
238 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.
239 241
240 242 ##### `ENABLE_VIDEOCORE`=false
241 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.
242 244
243 245 ##### `VIDEOCORESRC_DIR`=""
244 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.
245 247
246 248 ##### `ENABLE_NEXMON`=false
247 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).
248 250
249 251 ##### `NEXMONSRC_DIR`=""
250 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.
251 253
252 254 ##### `ENABLE_IPTABLES`=false
253 255 Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.
254 256
255 257 ##### `ENABLE_USER`=true
256 258 Create non-root user with password `USER_PASSWORD`=raspberry. Unless overridden with `USER_NAME`=user, the username will be `pi`.
257 259
258 260 ##### `USER_NAME`=pi
259 261 Non-root user to create. Ignored if `ENABLE_USER`=false
260 262
261 263 ##### `ENABLE_ROOT`=false
262 264 Set root user password so root login will be enabled
263 265
264 266 ##### `ENABLE_HARDNET`=false
265 267 Enable IPv4/IPv6 network stack hardening settings.
266 268
267 269 ##### `ENABLE_SPLITFS`=false
268 270 Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.
269 271
270 272 ##### `CHROOT_SCRIPTS`=""
271 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.
272 274
273 275 ##### `ENABLE_INITRAMFS`=false
274 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.
275 277
276 278 ##### `ENABLE_IFNAMES`=true
277 279 Enable automatic assignment of predictable, stable network interface names for all local Ethernet, WLAN interfaces. This might create complex and long interface names.
278 280
279 281 ##### `ENABLE_SPLASH`=true
280 282 Enable default Raspberry Pi boot up rainbow splash screen.
281 283
282 284 ##### `ENABLE_LOGO`=true
283 285 Enable default Raspberry Pi console logo (image of four raspberries in the top left corner).
284 286
285 287 ##### `ENABLE_SILENT_BOOT`=false
286 288 Set the verbosity of console messages shown during boot up to a strict minimum.
287 289
288 290 ##### `DISABLE_UNDERVOLT_WARNINGS`=
289 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.
290 292
291 293 ---
292 294
293 295 #### SSH settings:
294 296 ##### `SSH_ENABLE_ROOT`=false
295 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`.
296 298
297 299 ##### `SSH_DISABLE_PASSWORD_AUTH`=false
298 300 Disable password-based SSH authentication. Only public key based SSH (v2) authentication will be supported.
299 301
300 302 ##### `SSH_LIMIT_USERS`=false
301 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).
302 304
303 305 ##### `SSH_ROOT_PUB_KEY`=""
304 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`.
305 307
306 308 ##### `SSH_USER_PUB_KEY`=""
307 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.
308 310
309 311 ---
310 312
311 313 #### Kernel compilation:
312 314 ##### `BUILD_KERNEL`=true
313 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.
314 316
315 317 ##### `CROSS_COMPILE`="arm-linux-gnueabihf-"
316 318 This sets the cross-compile environment for the compiler.
317 319
318 320 ##### `KERNEL_ARCH`="arm"
319 321 This sets the kernel architecture for the compiler.
320 322
321 323 ##### `KERNEL_IMAGE`="kernel7.img"
322 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.
323 325
324 326 ##### `KERNEL_BRANCH`=""
325 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.
326 328
327 329 ##### `QEMU_BINARY`="/usr/bin/qemu-arm-static"
328 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.
329 331
330 332 ##### `KERNEL_DEFCONFIG`="bcm2709_defconfig"
331 333 Sets the default config for kernel compiling. If not set, `KERNEL_DEFCONFIG` will be set to "bcmrpi3\_defconfig" automatically if building for arm64.
332 334
333 335 ##### `KERNEL_REDUCE`=false
334 336 Reduce the size of the generated kernel by removing unwanted devices, network and filesystem drivers (experimental).
335 337
336 338 ##### `KERNEL_THREADS`=1
337 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.
338 340
339 341 ##### `KERNEL_HEADERS`=true
340 342 Install kernel headers with the built kernel.
341 343
342 344 ##### `KERNEL_MENUCONFIG`=false
343 345 Start `make menuconfig` interactive menu-driven kernel configuration. The script will continue after `make menuconfig` was terminated.
344 346
345 347 ##### `KERNEL_OLDDEFCONFIG`=false
346 348 Run `make olddefconfig` to automatically set all new kernel configuration options to their recommended default values.
347 349
348 350 ##### `KERNEL_CCACHE`=false
349 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.
350 352
351 353 ##### `KERNEL_REMOVESRC`=true
352 354 Remove all kernel sources from the generated OS image after it was built and installed.
353 355
354 356 ##### `KERNELSRC_DIR`=""
355 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.
356 358
357 359 ##### `KERNELSRC_CLEAN`=false
358 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.
359 361
360 362 ##### `KERNELSRC_CONFIG`=true
361 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.
362 364
363 365 ##### `KERNELSRC_USRCONFIG`=""
364 366 Copy own config file to kernel `.config`. If `KERNEL_MENUCONFIG`=true then running after copy.
365 367
366 368 ##### `KERNELSRC_PREBUILT`=false
367 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.
368 370
369 371 ##### `RPI_FIRMWARE_DIR`=""
370 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.
371 373
372 374 ##### `KERNEL_DEFAULT_GOV`="ONDEMAND"
373 375 Set the default cpu governor at kernel compilation. Supported values are: PERFORMANCE POWERSAVE USERSPACE ONDEMAND CONSERVATIVE SCHEDUTIL
374 376
375 377 ##### `KERNEL_NF`=false
376 378 Enable Netfilter modules as kernel modules
377 379
378 380 ##### `KERNEL_VIRT`=false
379 381 Enable Kernel KVM support (/dev/kvm)
380 382
381 383 ##### `KERNEL_ZSWAP`=false
382 384 Enable Kernel Zswap support. Best use on high RAM load and mediocre CPU load usecases
383 385
384 386 ##### `KERNEL_BPF`=true
385 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]
386 388
387 389 ##### `KERNEL_SECURITY`=false
388 390 Enables Apparmor, integrity subsystem, auditing.
389 391
390 392 ---
391 393
392 394 #### Reduce disk usage:
393 395 The following list of parameters is ignored if `ENABLE_REDUCE`=false.
394 396
395 397 ##### `REDUCE_APT`=true
396 398 Configure APT to use compressed package repository lists and no package caching files.
397 399
398 400 ##### `REDUCE_DOC`=true
399 401 Remove all doc files (harsh). Configure APT to not include doc files on future `apt-get` package installations.
400 402
401 403 ##### `REDUCE_MAN`=true
402 404 Remove all man pages and info files (harsh). Configure APT to not include man pages on future `apt-get` package installations.
403 405
404 406 ##### `REDUCE_VIM`=false
405 407 Replace `vim-tiny` package by `levee` a tiny vim clone.
406 408
407 409 ##### `REDUCE_BASH`=false
408 410 Remove `bash` package and switch to `dash` shell (experimental).
409 411
410 412 ##### `REDUCE_HWDB`=true
411 413 Remove PCI related hwdb files (experimental).
412 414
413 415 ##### `REDUCE_SSHD`=true
414 416 Replace `openssh-server` with `dropbear`.
415 417
416 418 ##### `REDUCE_LOCALE`=true
417 419 Remove all `locale` translation files.
418 420
419 421 ---
420 422
421 423 #### Encrypted root partition:
422 424 ##### `ENABLE_CRYPTFS`=false
423 425 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.
424 426
425 427 ##### `CRYPTFS_PASSWORD`=""
426 428 Set password of the encrypted root partition. This parameter is mandatory if `ENABLE_CRYPTFS`=true.
427 429
428 430 ##### `CRYPTFS_MAPPING`="secure"
429 431 Set name of dm-crypt managed device-mapper mapping.
430 432
431 433 ##### `CRYPTFS_CIPHER`="aes-xts-plain64:sha512"
432 434 Set cipher specification string. `aes-xts*` ciphers are strongly recommended.
433 435
434 436 ##### `CRYPTFS_XTSKEYSIZE`=512
435 437 Sets key size in bits. The argument has to be a multiple of 8.
436 438
437 439 ##### `CRYPTFS_DROPBEAR`=false
438 440 Enable Dropbear Initramfs support
439 441
440 442 ##### `CRYPTFS_DROPBEAR_PUBKEY`=""
441 443 Provide path to dropbear Public RSA-OpenSSH Key
442 444
443 445 ---
444 446
445 447 #### Build settings:
446 448 ##### `BASEDIR`=$(pwd)/images/${RELEASE}
447 449 Set a path to a working directory used by the script to generate an image.
448 450
449 451 ##### `IMAGE_NAME`=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}
450 452 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.
451 453
452 454 ## Understanding the script
453 455 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:
454 456
455 457 | Script | Description |
456 458 | --- | --- |
457 459 | `10-bootstrap.sh` | Debootstrap basic system |
458 460 | `11-apt.sh` | Setup APT repositories |
459 461 | `12-locale.sh` | Setup Locales and keyboard settings |
460 462 | `13-kernel.sh` | Build and install RPi 0/1/2/3 Kernel |
461 463 | `14-fstab.sh` | Setup fstab and initramfs |
462 464 | `15-rpi-config.sh` | Setup RPi 0/1/2/3 config and cmdline |
463 465 | `20-networking.sh` | Setup Networking |
464 466 | `21-firewall.sh` | Setup Firewall |
465 467 | `30-security.sh` | Setup Users and Security settings |
466 468 | `31-logging.sh` | Setup Logging |
467 469 | `32-sshd.sh` | Setup SSH and public keys |
468 470 | `41-uboot.sh` | Build and Setup U-Boot |
469 471 | `42-fbturbo.sh` | Build and Setup fbturbo Xorg driver |
470 472 | `43-videocore.sh` | Build and Setup videocore libraries |
471 473 | `50-firstboot.sh` | First boot actions |
472 474 | `99-reduce.sh` | Reduce the disk space usage |
473 475
474 476 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.
475 477
476 478 | Directory | Description |
477 479 | --- | --- |
478 480 | `apt` | APT management configuration files |
479 481 | `boot` | Boot and RPi 0/1/2/3 configuration files |
480 482 | `dpkg` | Package Manager configuration |
481 483 | `etc` | Configuration files and rc scripts |
482 484 | `firstboot` | Scripts that get executed on first boot |
483 485 | `initramfs` | Initramfs scripts |
484 486 | `iptables` | Firewall configuration files |
485 487 | `locales` | Locales configuration |
486 488 | `modules` | Kernel Modules configuration |
487 489 | `mount` | Fstab configuration |
488 490 | `network` | Networking configuration files |
489 491 | `sysctl.d` | Swapping and Network Hardening configuration |
490 492 | `xorg` | fbturbo Xorg driver configuration |
491 493
492 494 ## Custom packages and scripts
493 495 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`.
494 496
495 497 Scripts in the custom.d directory will be executed after all other installation is complete but before the image is created.
496 498
497 499 ## Logging of the bootstrapping process
498 500 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:
499 501
500 502 ```shell
501 503 script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log
502 504 ```
503 505
504 506 ## Flashing the image file
505 507 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`.
506 508
507 509 ##### Flashing examples:
508 510 ```shell
509 511 bmaptool copy ./images/buster/2017-01-23-rpi3-buster.img /dev/mmcblk0
510 512 dd bs=4M if=./images/buster/2017-01-23-rpi3-buster.img of=/dev/mmcblk0
511 513 ```
512 514 If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:
513 515 ```shell
514 516 bmaptool copy ./images/buster/2017-01-23-rpi3-buster-frmw.img /dev/mmcblk0
515 517 bmaptool copy ./images/buster/2017-01-23-rpi3-buster-root.img /dev/sdc
516 518 ```
517 519
518 520 ## QEMU emulation
519 521 Start QEMU full system emulation:
520 522 ```shell
521 523 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"
522 524 ```
523 525
524 526 Start QEMU full system emulation and output to console:
525 527 ```shell
526 528 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
527 529 ```
528 530
529 531 Start QEMU full system emulation with SMP and output to console:
530 532 ```shell
531 533 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
532 534 ```
533 535
534 536 Start QEMU full system emulation with cryptfs, initramfs and output to console:
535 537 ```shell
536 538 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
537 539 ```
538 540
539 541 ## External links and references
540 542 * [Debian worldwide mirror sites](https://www.debian.org/mirror/list)
541 543 * [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)
542 544 * [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains)
543 545 * [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)
544 546 * [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)
545 547 * [U-BOOT git repository](https://git.denx.de/?p=u-boot.git;a=summary)
546 548 * [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)
547 549 * [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm)
548 550 * [Collabora RPi2 Kernel precompiled](https://repositories.collabora.co.uk/debian/)
General Comments 0
Vous devez vous connecter pour laisser un commentaire. Se connecter maintenant