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

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

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