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

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

0
Unknown -
r439:c35d34c19034
parent child
Show More
Show file before | Show file after | Hide comments
@@ -1,505 +1,505
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 Raspberry Pi 2 (RPi2) and Raspberry Pi 3 (RPi3) computers. The script at this time supports the bootstrapping of the Debian (armhf) releases `stretch` and `buster`. Raspberry Pi 3 images are generated for 32-bit mode only. Raspberry Pi 3 64-bit images can be generated using custom configuration parameters (```templates/rpi3-stretch-arm64-4.14.y```).
4 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 RPi3 this is mandatory. Kernel compilation and linking will be performed on the build system using an ARM (armhf) cross-compiler toolchain.
11 11
12 12 The script has been tested using the default `crossbuild-essential-armhf` toolchain meta package on Debian Linux `stretch` build systems. Please check the [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains) for further information.
13 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/debian"
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 ##### `APT_INCLUDES`=""
52 52 A comma separated list of additional packages to be installed by debootstrap during bootstrapping.
53 53
54 54 ##### `APT_INCLUDES_LATE`=""
55 55 A comma separated list of additional packages to be installed by apt after bootstrapping and after APT sources are set up. This is useful for packages with pre-depends, which debootstrap do not handle well.
56 56
57 57 ---
58 58
59 59 #### General system settings:
60 60 ##### `SET_ARCH`=32
61 61 Set Architecture to default 32bit. If you want to to compile 64bit (RPI3 or RPI3+) set it to `64`. This option will set every needed crosscompiler or boeard specific option for a successful build.
62 62 If you want to change e.g. cross-compiler -> Templates always override defaults
63 63
64 64 ##### `RPI_MODEL`=2
65 65 Specifiy the target Raspberry Pi hardware model. The script at this time supports the following Raspberry Pi models:
66 66 `0` = Used for Raspberry Pi 0 and Raspberry Pi 0 W
67 67 `1` = Used for Pi 1 model A and B
68 68 `1P` = Used for Pi 1 model B+ and A+
69 69 `2` = Used for Pi 2 model B
70 70 `3` = Used for Pi 3 model B
71 71 `3P` = Used for Pi 3 model B+
72 72 `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` or `3P` is used.
73 73
74 74 ##### `RELEASE`="buster"
75 75 Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases `stretch` and `buster`.
76 76
77 77 ##### `RELEASE_ARCH`="armhf"
78 78 Set the desired Debian release architecture.
79 79
80 80 ##### `HOSTNAME`="rpi$RPI_MODEL-$RELEASE"
81 81 Set system host name. It's recommended that the host name is unique in the corresponding subnet.
82 82
83 83 ##### `PASSWORD`="raspberry"
84 84 Set system `root` password. It's **STRONGLY** recommended that you choose a custom password.
85 85
86 86 ##### `USER_PASSWORD`="raspberry"
87 87 Set password for the created non-root user `USER_NAME`=pi. Ignored if `ENABLE_USER`=false. It's **STRONGLY** recommended that you choose a custom password.
88 88
89 89 ##### `DEFLOCAL`="en_US.UTF-8"
90 90 Set default system locale. This setting can also be changed inside the running OS using the `dpkg-reconfigure locales` command. Please note that on using this parameter the script will automatically install the required packages `locales`, `keyboard-configuration` and `console-setup`.
91 91
92 92 ##### `TIMEZONE`="Europe/Berlin"
93 93 Set default system timezone. All available timezones can be found in the `/usr/share/zoneinfo/` directory. This setting can also be changed inside the running OS using the `dpkg-reconfigure tzdata` command.
94 94
95 95 ##### `EXPANDROOT`=true
96 96 Expand the root partition and filesystem automatically on first boot.
97 97
98 98 ##### `ENABLE_QEMU`=false
99 99 Generate kernel (`vexpress_defconfig`), file system image (`qcow2`) and DTB files that can be used for QEMU full system emulation (`vexpress-A15`). The output files are stored in the `$(pwd)/images/qemu` directory. You can find more information about running the generated image in the QEMU section of this readme file.
100 100
101 101 ---
102 102
103 103 #### Keyboard settings:
104 104 These options are used to configure keyboard layout in `/etc/default/keyboard` for console and Xorg. These settings can also be changed inside the running OS using the `dpkg-reconfigure keyboard-configuration` command.
105 105
106 106 ##### `XKB_MODEL`=""
107 107 Set the name of the model of your keyboard type.
108 108
109 109 ##### `XKB_LAYOUT`=""
110 110 Set the supported keyboard layout(s).
111 111
112 112 ##### `XKB_VARIANT`=""
113 113 Set the supported variant(s) of the keyboard layout(s).
114 114
115 115 ##### `XKB_OPTIONS`=""
116 116 Set extra xkb configuration options.
117 117
118 118 ---
119 119
120 120 #### Networking settings (DHCP):
121 121 This parameter is used to set up networking auto configuration in `/etc/systemd/network/eth.network`. The default location of network configuration files in the Debian `stretch` release was changed to `/lib/systemd/network`.`
122 122
123 123 ##### `ENABLE_DHCP`=true
124 124 Set the system to use DHCP. This requires an DHCP server.
125 125
126 126 ---
127 127
128 128 #### Networking settings (static):
129 129 These parameters are used to set up a static networking configuration in `/etc/systemd/network/eth.network`. The following static networking parameters are only supported if `ENABLE_DHCP` was set to `false`. The default location of network configuration files in the Debian `stretch` release was changed to `/lib/systemd/network`.
130 130
131 131 ##### `NET_ADDRESS`=""
132 132 Set a static IPv4 or IPv6 address and its prefix, separated by "/", eg. "192.169.0.3/24".
133 133
134 134 ##### `NET_GATEWAY`=""
135 135 Set the IP address for the default gateway.
136 136
137 137 ##### `NET_DNS_1`=""
138 138 Set the IP address for the first DNS server.
139 139
140 140 ##### `NET_DNS_2`=""
141 141 Set the IP address for the second DNS server.
142 142
143 143 ##### `NET_DNS_DOMAINS`=""
144 144 Set the default DNS search domains to use for non fully qualified host names.
145 145
146 146 ##### `NET_NTP_1`=""
147 147 Set the IP address for the first NTP server.
148 148
149 149 ##### `NET_NTP_2`=""
150 150 Set the IP address for the second NTP server.
151 151
152 152 ---
153 153
154 154 #### Basic system features:
155 155 ##### `ENABLE_CONSOLE`=true
156 Enable serial console interface. Recommended if no monitor or keyboard is connected to the RPi2/3. In case of problems fe. if the network (auto) configuration failed - the serial console can be used to access the system. On `RPI_MODEL= 0,3,3P` - Bluetooth gets auto enabled if `ENABLE_CONSOLE` and `ENABLE_UBOOT` are set to `false`
156 Enable serial console interface. Recommended if no monitor or keyboard is connected to the RPi2/3. In case of problems fe. if the network (auto) configuration failed - the serial console can be used to access the system.
157 On `RPI_MODEL= 0,3,3P` - Bluetooth gets auto enabled if `ENABLE_CONSOLE` and `ENABLE_UBOOT` are set to `false`
157 158
158 159 ##### `ENABLE_I2C`=false
159 160 Enable I2C interface on the RPi2/3. Please check the [RPi2/3 pinout diagrams](https://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.
160 161
161 162 ##### `ENABLE_SPI`=false
162 163 Enable SPI interface on the RPi2/3. Please check the [RPi2/3 pinout diagrams](https://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.
163 164
164 165 ##### `ENABLE_IPV6`=true
165 166 Enable IPv6 support. The network interface configuration is managed via systemd-networkd.
166 167
167 168 ##### `ENABLE_SSHD`=true
168 169 Install and enable OpenSSH service. The default configuration of the service doesn't allow `root` to login. Please use the user `pi` instead and `su -` or `sudo` to execute commands as root.
169 170
170 171 ##### `ENABLE_NONFREE`=false
171 172 Allow the installation of non-free Debian packages that do not comply with the DFSG. This is required to install closed-source firmware binary blobs.
172 173
173 174 ##### `ENABLE_WIRELESS`=false
174 175 Download and install the [closed-source firmware binary blob](https://github.com/RPi-Distro/firmware-nonfree/raw/master/brcm) that is required to run the internal wireless interface of the Raspberry Pi model `3`. This parameter is ignored if the specified `RPI_MODEL` is not `3`.
175 176
176 177 ##### `ENABLE_BLUETOOTH`=false
177 178 Enable Bluetooth interface on the RPi0/3.
178 179
179 180 ##### `ENABLE_RSYSLOG`=true
180 If set to false, disable and uninstall rsyslog (so logs will be available only
181 in journal files)
181 If set to false, disable and uninstall rsyslog (so logs will be available only in journal files)
182 182
183 183 ##### `ENABLE_SOUND`=true
184 184 Enable sound hardware and install Advanced Linux Sound Architecture.
185 185
186 186 ##### `ENABLE_HWRANDOM`=true
187 187 Enable Hardware Random Number Generator. Strong random numbers are important for most network based communications that use encryption. It's recommended to be enabled.
188 188
189 189 ##### `ENABLE_MINGPU`=false
190 190 Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU.
191 191
192 192 ##### `ENABLE_DBUS`=true
193 193 Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled.
194 194
195 195 ##### `ENABLE_XORG`=false
196 196 Install Xorg open-source X Window System.
197 197
198 198 ##### `ENABLE_WM`=""
199 199 Install a user defined window manager for the X Window System. To make sure all X related package dependencies are getting installed `ENABLE_XORG` will automatically get enabled if `ENABLE_WM` is used. The `rpi23-gen-image.sh` script has been tested with the following list of window managers: `blackbox`, `openbox`, `fluxbox`, `jwm`, `dwm`, `xfce4`, `awesome`.
200 200
201 201 ##### `ENABLE_SYSVINIT`=false
202 202 Support for halt,init,poweroff,reboot,runlevel,shutdown,telinit commands
203 203
204 204 ---
205 205
206 206 #### Advanced system features:
207 207 ##### `ENABLE_MINBASE`=false
208 208 Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
209 209
210 210 ##### `ENABLE_REDUCE`=false
211 211 Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.
212 212
213 213 ##### `ENABLE_UBOOT`=false
214 214 Replace the default RPi2/3 second stage bootloader (bootcode.bin) with [U-Boot bootloader](https://git.denx.de/?p=u-boot.git;a=summary). U-Boot can boot images via the network using the BOOTP/TFTP protocol.
215 215
216 216 ##### `UBOOTSRC_DIR`=""
217 217 Path to a directory (`u-boot`) of [U-Boot bootloader sources](https://git.denx.de/?p=u-boot.git;a=summary) that will be copied, configured, build and installed inside the chroot.
218 218
219 219 ##### `ENABLE_FBTURBO`=false
220 220 Install and enable the [hardware accelerated Xorg video driver](https://github.com/ssvb/xf86-video-fbturbo) `fbturbo`. Please note that this driver is currently limited to hardware accelerated window moving and scrolling.
221 221
222 222 ##### `FBTURBOSRC_DIR`=""
223 223 Path to a directory (`xf86-video-fbturbo`) of [hardware accelerated Xorg video driver sources](https://github.com/ssvb/xf86-video-fbturbo) that will be copied, configured, build and installed inside the chroot.
224 224
225 225 ##### `ENABLE_VIDEOCORE`=false
226 226 Install and enable the [Source code for ARM side libraries for interfacing to Raspberry Pi GPU](https://github.com/raspberrypi/userland) `vcgencmd`. Please note that this driver is currently limited to hardware accelerated window moving and scrolling.
227 227
228 228 ##### `VIDEOCORESRC_DIR`=""
229 229 Path to a directory (`userland`) of [Source code for ARM side libraries for interfacing to Raspberry Pi GPU](https://github.com/raspberrypi/userland) that will be copied, configured, build and installed inside the chroot.
230 230
231 231 ##### `ENABLE_IPTABLES`=false
232 232 Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.
233 233
234 234 ##### `ENABLE_USER`=true
235 235 Create non-root user with password `USER_PASSWORD`=raspberry. Unless overridden with `USER_NAME`=user, username will be `pi`.
236 236
237 237 ##### `USER_NAME`=pi
238 238 Non-root user to create. Ignored if `ENABLE_USER`=false
239 239
240 240 ##### `ENABLE_ROOT`=false
241 241 Set root user password so root login will be enabled
242 242
243 243 ##### `ENABLE_HARDNET`=false
244 244 Enable IPv4/IPv6 network stack hardening settings.
245 245
246 246 ##### `ENABLE_SPLITFS`=false
247 247 Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.
248 248
249 249 ##### `CHROOT_SCRIPTS`=""
250 250 Path to a directory with scripts that should be run in the chroot before the image is finally built. Every executable file in this directory is run in lexicographical order.
251 251
252 252 ##### `ENABLE_INITRAMFS`=false
253 253 Create an initramfs that that will be loaded during the Linux startup process. `ENABLE_INITRAMFS` will automatically get enabled if `ENABLE_CRYPTFS`=true. This parameter will be ignored if `BUILD_KERNEL`=false.
254 254
255 255 ##### `ENABLE_IFNAMES`=true
256 256 Enable automatic assignment of predictable, stable network interface names for all local Ethernet, WLAN interfaces. This might create complex and long interface names.
257 257
258 258 ##### `DISABLE_UNDERVOLT_WARNINGS`=
259 259 Disable RPi2/3 under-voltage warnings and overlays. Setting the parameter to `1` will disable the warning overlay. Setting it to `2` will additionally allow RPi2/3 turbo mode when low-voltage is present.
260 260
261 261 ---
262 262
263 263 #### SSH settings:
264 264 ##### `SSH_ENABLE_ROOT`=false
265 265 Enable password root login via SSH. This may be a security risk with default password, use only in trusted environments. `ENABLE_ROOT` must be set to `true`.
266 266
267 267 ##### `SSH_DISABLE_PASSWORD_AUTH`=false
268 268 Disable password based SSH authentication. Only public key based SSH (v2) authentication will be supported.
269 269
270 270 ##### `SSH_LIMIT_USERS`=false
271 271 Limit the users that are allowed to login via SSH. Only allow user `USER_NAME`=pi and root if `SSH_ENABLE_ROOT`=true to login. This parameter will be ignored if `dropbear` SSH is used (`REDUCE_SSHD`=true).
272 272
273 273 ##### `SSH_ROOT_PUB_KEY`=""
274 274 Add SSH (v2) public key(s) from specified file to `authorized_keys` file to enable public key based SSH (v2) authentication of user `root`. The specified file can also contain multiple SSH (v2) public keys. SSH protocol version 1 is not supported. `ENABLE_ROOT` **and** `SSH_ENABLE_ROOT` must be set to `true`.
275 275
276 276 ##### `SSH_USER_PUB_KEY`=""
277 277 Add SSH (v2) public key(s) from specified file to `authorized_keys` file to enable public key based SSH (v2) authentication of user `USER_NAME`=pi. The specified file can also contain multiple SSH (v2) public keys. SSH protocol version 1 is not supported.
278 278
279 279 ---
280 280
281 281 #### Kernel compilation:
282 282 ##### `BUILD_KERNEL`=true
283 283 Build and install the latest RPi2/3 Linux kernel. Currently only the default RPi2/3 kernel configuration is used.
284 284
285 285 ##### `CROSS_COMPILE`="arm-linux-gnueabihf-"
286 286 This sets the cross compile enviornment for the compiler.
287 287
288 288 ##### `KERNEL_ARCH`="arm"
289 289 This sets the kernel architecture for the compiler.
290 290
291 291 ##### `KERNEL_IMAGE`="kernel7.img"
292 292 Name of the image file in the boot partition. If not set, `KERNEL_IMAGE` will be set to "kernel8.img" automatically if building for arm64.
293 293
294 294 ##### `KERNEL_BRANCH`=""
295 295 Name of the requested branch from the GIT location for the RPi Kernel. Default is using the current default branch from the GIT site.
296 296
297 297 ##### `QEMU_BINARY`="/usr/bin/qemu-arm-static"
298 298 Sets the QEMU enviornment for the Debian archive. If not set, `QEMU_BINARY` will be set to "/usr/bin/qemu-aarch64-static" automatically if building for arm64.
299 299
300 300 ##### `KERNEL_DEFCONFIG`="bcm2709_defconfig"
301 301 Sets the default config for kernel compiling. If not set, `KERNEL_DEFCONFIG` will be set to "bcmrpi3\_defconfig" automatically if building for arm64.
302 302
303 303 ##### `KERNEL_REDUCE`=false
304 304 Reduce the size of the generated kernel by removing unwanted device, network and filesystem drivers (experimental).
305 305
306 306 ##### `KERNEL_THREADS`=1
307 307 Number of parallel kernel building threads. If the parameter is left untouched the script will automatically determine the number of CPU cores to set the number of parallel threads to speed the kernel compilation.
308 308
309 309 ##### `KERNEL_HEADERS`=true
310 310 Install kernel headers with built kernel.
311 311
312 312 ##### `KERNEL_MENUCONFIG`=false
313 313 Start `make menuconfig` interactive menu-driven kernel configuration. The script will continue after `make menuconfig` was terminated.
314 314
315 315 ##### `KERNEL_OLDDEFCONFIG`=false
316 316 Run `make olddefconfig` to automatically set all new kernel configuration options to their recommended default values.
317 317
318 318 ##### `KERNEL_CCACHE`=false
319 319 Compile the kernel using ccache. This speeds up kernel recompilation by caching previous compilations and detecting when the same compilation is being done again.
320 320
321 321 ##### `KERNEL_REMOVESRC`=true
322 322 Remove all kernel sources from the generated OS image after it was built and installed.
323 323
324 324 ##### `KERNELSRC_DIR`=""
325 325 Path to a directory (`linux`) of [RaspberryPi Linux kernel sources](https://github.com/raspberrypi/linux) that will be copied, configured, build and installed inside the chroot.
326 326
327 327 ##### `KERNELSRC_CLEAN`=false
328 328 Clean the existing kernel sources directory `KERNELSRC_DIR` (using `make mrproper`) after it was copied to the chroot and before the compilation of the kernel has started. This parameter will be ignored if no `KERNELSRC_DIR` was specified or if `KERNELSRC_PREBUILT`=true.
329 329
330 330 ##### `KERNELSRC_CONFIG`=true
331 331 Run `make bcm2709_defconfig` (and optional `make menuconfig`) to configure the kernel sources before building. This parameter is automatically set to `true` if no existing kernel sources directory was specified using `KERNELSRC_DIR`. This parameter is ignored if `KERNELSRC_PREBUILT`=true.
332 332
333 333 ##### `KERNELSRC_USRCONFIG`=""
334 334 Copy own config file to kernel `.config`. If `KERNEL_MENUCONFIG`=true then running after copy.
335 335
336 336 ##### `KERNELSRC_PREBUILT`=false
337 337 With this parameter set to true the script expects the existing kernel sources directory to be already successfully cross-compiled. The parameters `KERNELSRC_CLEAN`, `KERNELSRC_CONFIG`, `KERNELSRC_USRCONFIG` and `KERNEL_MENUCONFIG` are ignored and no kernel compilation tasks are performed.
338 338
339 339 ##### `RPI_FIRMWARE_DIR`=""
340 340 The directory (`firmware`) containing a local copy of the firmware from the [RaspberryPi firmware project](https://github.com/raspberrypi/firmware). Default is to download the latest firmware directly from the project.
341 341
342 342 ##### `KERNEL_NF`=false
343 343 Enable Netfilter modules as kernel modules
344 344
345 345 ##### `KERNEL_VIRT`=false
346 346 Enable Kernel KVM support (/dev/kvm)
347 347
348 348 ##### `KERNEL_ZSWAP`=false
349 349 Enable Kernel Zswap support. Best use on high RAM load and mediocre CPU load usecases
350 350
351 351 ##### `KERNEL_BPF`=true
352 352 Allow attaching eBPF programs to a cgroup using the bpf syscall (CONFIG_BPF_SYSCALL CONFIG_CGROUP_BPF) [systemd compilations about it - File /lib/systemd/system/systemd-journald.server:36 configures an IP firewall (IPAddressDeny=all), but the local system does not support BPF/cgroup based firewalls]
353 353
354 354 ---
355 355
356 356 #### Reduce disk usage:
357 357 The following list of parameters is ignored if `ENABLE_REDUCE`=false.
358 358
359 359 ##### `REDUCE_APT`=true
360 360 Configure APT to use compressed package repository lists and no package caching files.
361 361
362 362 ##### `REDUCE_DOC`=true
363 363 Remove all doc files (harsh). Configure APT to not include doc files on future `apt-get` package installations.
364 364
365 365 ##### `REDUCE_MAN`=true
366 366 Remove all man pages and info files (harsh). Configure APT to not include man pages on future `apt-get` package installations.
367 367
368 368 ##### `REDUCE_VIM`=false
369 369 Replace `vim-tiny` package by `levee` a tiny vim clone.
370 370
371 371 ##### `REDUCE_BASH`=false
372 372 Remove `bash` package and switch to `dash` shell (experimental).
373 373
374 374 ##### `REDUCE_HWDB`=true
375 375 Remove PCI related hwdb files (experimental).
376 376
377 377 ##### `REDUCE_SSHD`=true
378 378 Replace `openssh-server` with `dropbear`.
379 379
380 380 ##### `REDUCE_LOCALE`=true
381 381 Remove all `locale` translation files.
382 382
383 383 ---
384 384
385 385 #### Encrypted root partition:
386 386 ##### `ENABLE_CRYPTFS`=false
387 387 Enable full system encryption with dm-crypt. Setup a fully LUKS encrypted root partition (aes-xts-plain64:sha512) and generate required initramfs. The /boot directory will not be encrypted. This parameter will be ignored if `BUILD_KERNEL`=false. `ENABLE_CRYPTFS` is experimental. SSH-to-initramfs is currently not supported but will be soon - feel free to help.
388 388
389 389 ##### `CRYPTFS_PASSWORD`=""
390 390 Set password of the encrypted root partition. This parameter is mandatory if `ENABLE_CRYPTFS`=true.
391 391
392 392 ##### `CRYPTFS_MAPPING`="secure"
393 393 Set name of dm-crypt managed device-mapper mapping.
394 394
395 395 ##### `CRYPTFS_CIPHER`="aes-xts-plain64:sha512"
396 396 Set cipher specification string. `aes-xts*` ciphers are strongly recommended.
397 397
398 398 ##### `CRYPTFS_XTSKEYSIZE`=512
399 399 Sets key size in bits. The argument has to be a multiple of 8.
400 400
401 401 ---
402 402
403 403 #### Build settings:
404 404 ##### `BASEDIR`=$(pwd)/images/${RELEASE}
405 405 Set a path to a working directory used by the script to generate an image.
406 406
407 407 ##### `IMAGE_NAME`=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}
408 408 Set a filename for the output file(s). Note: the script will create $IMAGE_NAME.img if `ENABLE_SPLITFS`=false or $IMAGE_NAME-frmw.img and $IMAGE_NAME-root.img if `ENABLE_SPLITFS`=true. Note 2: If the KERNEL_BRANCH is not set, the word "CURRENT" is used.
409 409
410 410 ## Understanding the script
411 411 The functions of this script that are required for the different stages of the bootstrapping are split up into single files located inside the `bootstrap.d` directory. During the bootstrapping every script in this directory gets executed in lexicographical order:
412 412
413 413 | Script | Description |
414 414 | --- | --- |
415 415 | `10-bootstrap.sh` | Debootstrap basic system |
416 416 | `11-apt.sh` | Setup APT repositories |
417 417 | `12-locale.sh` | Setup Locales and keyboard settings |
418 418 | `13-kernel.sh` | Build and install RPi2/3 Kernel |
419 419 | `14-fstab.sh` | Setup fstab and initramfs |
420 420 | `15-rpi-config.sh` | Setup RPi2/3 config and cmdline |
421 421 | `20-networking.sh` | Setup Networking |
422 422 | `21-firewall.sh` | Setup Firewall |
423 423 | `30-security.sh` | Setup Users and Security settings |
424 424 | `31-logging.sh` | Setup Logging |
425 425 | `32-sshd.sh` | Setup SSH and public keys |
426 426 | `41-uboot.sh` | Build and Setup U-Boot |
427 427 | `42-fbturbo.sh` | Build and Setup fbturbo Xorg driver |
428 428 | `50-firstboot.sh` | First boot actions |
429 429 | `99-reduce.sh` | Reduce the disk space usage |
430 430
431 431 All the required configuration files that will be copied to the generated OS image are located inside the `files` directory. It is not recommended to modify these configuration files manually.
432 432
433 433 | Directory | Description |
434 434 | --- | --- |
435 435 | `apt` | APT management configuration files |
436 436 | `boot` | Boot and RPi2/3 configuration files |
437 437 | `dpkg` | Package Manager configuration |
438 438 | `etc` | Configuration files and rc scripts |
439 439 | `firstboot` | Scripts that get executed on first boot |
440 440 | `initramfs` | Initramfs scripts |
441 441 | `iptables` | Firewall configuration files |
442 442 | `locales` | Locales configuration |
443 443 | `modules` | Kernel Modules configuration |
444 444 | `mount` | Fstab configuration |
445 445 | `network` | Networking configuration files |
446 446 | `sysctl.d` | Swapping and Network Hardening configuration |
447 447 | `xorg` | fbturbo Xorg driver configuration |
448 448
449 449 ## Custom packages and scripts
450 450 Debian custom packages, i.e. those not in the debian repositories, can be installed by placing them in the `packages` directory. They are installed immediately after packages from the repositories are installed. Any dependencies listed in the custom packages will be downloaded automatically from the repositories. Do not list these custom packages in `APT_INCLUDES`.
451 451
452 452 Scripts in the custom.d directory will be executed after all other installation is complete but before the image is created.
453 453
454 454 ## Logging of the bootstrapping process
455 455 All information related to the bootstrapping process and the commands executed by the `rpi23-gen-image.sh` script can easily be saved into a logfile. The common shell command `script` can be used for this purpose:
456 456
457 457 ```shell
458 458 script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log
459 459 ```
460 460
461 461 ## Flashing the image file
462 462 After the image file was successfully created by the `rpi23-gen-image.sh` script it can be copied to the microSD card that will be used by the RPi2/3 computer. This can be performed by using the tools `bmaptool` or `dd`. Using `bmaptool` will probably speed-up the copy process because `bmaptool` copies more wisely than `dd`.
463 463
464 464 ##### Flashing examples:
465 465 ```shell
466 466 bmaptool copy ./images/buster/2017-01-23-rpi3-buster.img /dev/mmcblk0
467 467 dd bs=4M if=./images/buster/2017-01-23-rpi3-buster.img of=/dev/mmcblk0
468 468 ```
469 469 If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:
470 470 ```shell
471 471 bmaptool copy ./images/buster/2017-01-23-rpi3-buster-frmw.img /dev/mmcblk0
472 472 bmaptool copy ./images/buster/2017-01-23-rpi3-buster-root.img /dev/sdc
473 473 ```
474 474
475 475 ## QEMU emulation
476 476 Start QEMU full system emulation:
477 477 ```shell
478 478 qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=tty1"
479 479 ```
480 480
481 481 Start QEMU full system emulation and output to console:
482 482 ```shell
483 483 qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio
484 484 ```
485 485
486 486 Start QEMU full system emulation with SMP and output to console:
487 487 ```shell
488 488 qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -smp cpus=2,maxcpus=2 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio
489 489 ```
490 490
491 491 Start QEMU full system emulation with cryptfs, initramfs and output to console:
492 492 ```shell
493 493 qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -initrd "initramfs-${KERNEL_VERSION}" -append "root=/dev/mapper/secure cryptdevice=/dev/mmcblk0p2:secure rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio
494 494 ```
495 495
496 496 ## External links and references
497 497 * [Debian worldwide mirror sites](https://www.debian.org/mirror/list)
498 498 * [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)
499 499 * [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains)
500 500 * [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)
501 501 * [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)
502 502 * [U-BOOT git repository](https://git.denx.de/?p=u-boot.git;a=summary)
503 503 * [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)
504 504 * [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/brcm)
505 505 * [Collabora RPi2 Kernel precompiled](https://repositories.collabora.co.uk/debian/)
General Comments 0
Vous devez vous connecter pour laisser un commentaire. Se connecter maintenant