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

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

README beautify
drtyhlpr -
r428:becef7bb3b54
parent child
Show More
Show file before | Show file after | Hide comments
@@ -1,490 +1,495
1 1 # rpi23-gen-image
2 2 ## Introduction
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 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```).
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 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/armel) cross-compiler toolchain.
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 ##### `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
63 63 ##### `RPI_MODEL`=2
64 Specifiy the target Raspberry Pi hardware model. The script at this time supports the following Raspberry Pi models:
64 Specifiy the target Raspberry Pi hardware model. The script at this time supports the following Raspberry Pi models (`BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` or `3P` is used) :
65
65 66 `0` = Used for Raspberry Pi 0 and Raspberry Pi 0 W
66 `1` = Used for Pi 1 model A and B
67 `1P` = Used for Pi 1 model B+ and A+
68 `2` = Used for Pi 2 model B
69 `3` = Used for Pi 3 model B
70 `3P` = Used for Pi 3 model B+
71 `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` or `3P` is used.
67
68 `1` = Used for Raspberry Pi 1 model A and B
69
70 `1P` = Used for Raspberry Pi 1 model B+ and A+
71
72 `2` = Used for Raspberry Pi 2 model B
73
74 `3` = Used for Raspberry Pi 3 model B
75
76 `3P` = Used for Raspberry Pi 3 model B+
72 77
73 78 ##### `RELEASE`="buster"
74 79 Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases `stretch` and `buster`.
75 80
76 81 ##### `RELEASE_ARCH`="armhf"
77 82 Set the desired Debian release architecture.
78 83
79 84 ##### `HOSTNAME`="rpi$RPI_MODEL-$RELEASE"
80 85 Set system host name. It's recommended that the host name is unique in the corresponding subnet.
81 86
82 87 ##### `PASSWORD`="raspberry"
83 88 Set system `root` password. It's **STRONGLY** recommended that you choose a custom password.
84 89
85 90 ##### `USER_PASSWORD`="raspberry"
86 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.
87 92
88 93 ##### `DEFLOCAL`="en_US.UTF-8"
89 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`.
90 95
91 96 ##### `TIMEZONE`="Europe/Berlin"
92 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.
93 98
94 99 ##### `EXPANDROOT`=true
95 100 Expand the root partition and filesystem automatically on first boot.
96 101
97 102 ##### `ENABLE_QEMU`=false
98 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.
99 104
100 105 ---
101 106
102 107 #### Keyboard settings:
103 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.
104 109
105 110 ##### `XKB_MODEL`=""
106 111 Set the name of the model of your keyboard type.
107 112
108 113 ##### `XKB_LAYOUT`=""
109 114 Set the supported keyboard layout(s).
110 115
111 116 ##### `XKB_VARIANT`=""
112 117 Set the supported variant(s) of the keyboard layout(s).
113 118
114 119 ##### `XKB_OPTIONS`=""
115 120 Set extra xkb configuration options.
116 121
117 122 ---
118 123
119 124 #### Networking settings (DHCP):
120 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`.`
121 126
122 127 ##### `ENABLE_DHCP`=true
123 128 Set the system to use DHCP. This requires an DHCP server.
124 129
125 130 ---
126 131
127 132 #### Networking settings (static):
128 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`.
129 134
130 135 ##### `NET_ADDRESS`=""
131 136 Set a static IPv4 or IPv6 address and its prefix, separated by "/", eg. "192.169.0.3/24".
132 137
133 138 ##### `NET_GATEWAY`=""
134 139 Set the IP address for the default gateway.
135 140
136 141 ##### `NET_DNS_1`=""
137 142 Set the IP address for the first DNS server.
138 143
139 144 ##### `NET_DNS_2`=""
140 145 Set the IP address for the second DNS server.
141 146
142 147 ##### `NET_DNS_DOMAINS`=""
143 148 Set the default DNS search domains to use for non fully qualified host names.
144 149
145 150 ##### `NET_NTP_1`=""
146 151 Set the IP address for the first NTP server.
147 152
148 153 ##### `NET_NTP_2`=""
149 154 Set the IP address for the second NTP server.
150 155
151 156 ---
152 157
153 158 #### Basic system features:
154 159 ##### `ENABLE_CONSOLE`=true
155 Enable serial console interface. Recommended if no monitor or keyboard is connected to the RPi0/1/2/3. In case of problems fe. if the network (auto) configuration failed - the serial console can be used to access the system.
160 Enable serial console interface. Recommended if no monitor or keyboard is connected to the RPi 0/1/2/3. In case of problems fe. if the network (auto) configuration failed - the serial console can be used to access the system.
156 161
157 162 ##### `ENABLE_I2C`=false
158 Enable I2C interface on the RPi0/1/2/3. Please check the [RPi0/1/2/3 pinout diagrams](https://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.
163 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.
159 164
160 165 ##### `ENABLE_SPI`=false
161 Enable SPI interface on the RPi0/1/2/3. Please check the [RPi0/1/2/3 pinout diagrams](https://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.
166 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.
162 167
163 168 ##### `ENABLE_IPV6`=true
164 169 Enable IPv6 support. The network interface configuration is managed via systemd-networkd.
165 170
166 171 ##### `ENABLE_SSHD`=true
167 172 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.
168 173
169 174 ##### `ENABLE_NONFREE`=false
170 175 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.
171 176
172 177 ##### `ENABLE_WIRELESS`=false
173 178 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`.
174 179
175 180 ##### `ENABLE_RSYSLOG`=true
176 181 If set to false, disable and uninstall rsyslog (so logs will be available only
177 182 in journal files)
178 183
179 184 ##### `ENABLE_SOUND`=true
180 185 Enable sound hardware and install Advanced Linux Sound Architecture.
181 186
182 187 ##### `ENABLE_HWRANDOM`=true
183 188 Enable Hardware Random Number Generator. Strong random numbers are important for most network based communications that use encryption. It's recommended to be enabled.
184 189
185 190 ##### `ENABLE_MINGPU`=false
186 191 Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU.
187 192
188 193 ##### `ENABLE_DBUS`=true
189 194 Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled.
190 195
191 196 ##### `ENABLE_XORG`=false
192 197 Install Xorg open-source X Window System.
193 198
194 199 ##### `ENABLE_WM`=""
195 200 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`.
196 201
197 202 ##### `ENABLE_SYSVINIT`=false
198 203 Support for halt,init,poweroff,reboot,runlevel,shutdown,telinit commands
199 204
200 205 ---
201 206
202 207 #### Advanced system features:
203 208 ##### `ENABLE_MINBASE`=false
204 209 Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
205 210
206 211 ##### `ENABLE_REDUCE`=false
207 212 Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.
208 213
209 214 ##### `ENABLE_UBOOT`=false
210 Replace the default RPi0/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.
215 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.
211 216
212 217 ##### `UBOOTSRC_DIR`=""
213 218 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.
214 219
215 220 ##### `ENABLE_FBTURBO`=false
216 221 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.
217 222
218 223 ##### `FBTURBOSRC_DIR`=""
219 224 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.
220 225
221 226 ##### `ENABLE_VIDEOCORE`=false
222 227 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.
223 228
224 229 ##### `VIDEOCORESRC_DIR`=""
225 230 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.
226 231
227 232 ##### `ENABLE_IPTABLES`=false
228 233 Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.
229 234
230 235 ##### `ENABLE_USER`=true
231 236 Create non-root user with password `USER_PASSWORD`=raspberry. Unless overridden with `USER_NAME`=user, username will be `pi`.
232 237
233 238 ##### `USER_NAME`=pi
234 239 Non-root user to create. Ignored if `ENABLE_USER`=false
235 240
236 241 ##### `ENABLE_ROOT`=false
237 242 Set root user password so root login will be enabled
238 243
239 244 ##### `ENABLE_HARDNET`=false
240 245 Enable IPv4/IPv6 network stack hardening settings.
241 246
242 247 ##### `ENABLE_SPLITFS`=false
243 248 Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.
244 249
245 250 ##### `CHROOT_SCRIPTS`=""
246 251 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.
247 252
248 253 ##### `ENABLE_INITRAMFS`=false
249 254 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.
250 255
251 256 ##### `ENABLE_IFNAMES`=true
252 257 Enable automatic assignment of predictable, stable network interface names for all local Ethernet, WLAN interfaces. This might create complex and long interface names.
253 258
254 259 ##### `DISABLE_UNDERVOLT_WARNINGS`=
255 260 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.
256 261
257 262 ---
258 263
259 264 #### SSH settings:
260 265 ##### `SSH_ENABLE_ROOT`=false
261 266 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`.
262 267
263 268 ##### `SSH_DISABLE_PASSWORD_AUTH`=false
264 269 Disable password based SSH authentication. Only public key based SSH (v2) authentication will be supported.
265 270
266 271 ##### `SSH_LIMIT_USERS`=false
267 272 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).
268 273
269 274 ##### `SSH_ROOT_PUB_KEY`=""
270 275 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`.
271 276
272 277 ##### `SSH_USER_PUB_KEY`=""
273 278 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.
274 279
275 280 ---
276 281
277 282 #### Kernel compilation:
278 283 ##### `BUILD_KERNEL`=true
279 Build and install the latest RPi0/1/2/3 Linux kernel. Currently only the default RPi0/1/2/3 kernel configuration is used.
284 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.
280 285
281 286 ##### `CROSS_COMPILE`="arm-linux-gnueabihf-"
282 287 This sets the cross compile enviornment for the compiler.
283 288
284 289 ##### `KERNEL_ARCH`="arm"
285 290 This sets the kernel architecture for the compiler.
286 291
287 292 ##### `KERNEL_IMAGE`="kernel7.img"
288 293 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.
289 294
290 295 ##### `KERNEL_BRANCH`=""
291 296 Name of the requested branch from the GIT location for the RPi Kernel. Default is using the current default branch from the GIT site.
292 297
293 298 ##### `QEMU_BINARY`="/usr/bin/qemu-arm-static"
294 299 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.
295 300
296 301 ##### `KERNEL_DEFCONFIG`="bcm2709_defconfig"
297 302 Sets the default config for kernel compiling. If not set, `KERNEL_DEFCONFIG` will be set to "bcmrpi3\_defconfig" automatically if building for arm64.
298 303
299 304 ##### `KERNEL_REDUCE`=false
300 305 Reduce the size of the generated kernel by removing unwanted device, network and filesystem drivers (experimental).
301 306
302 307 ##### `KERNEL_THREADS`=1
303 308 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.
304 309
305 310 ##### `KERNEL_HEADERS`=true
306 311 Install kernel headers with built kernel.
307 312
308 313 ##### `KERNEL_MENUCONFIG`=false
309 314 Start `make menuconfig` interactive menu-driven kernel configuration. The script will continue after `make menuconfig` was terminated.
310 315
311 316 ##### `KERNEL_OLDDEFCONFIG`=false
312 317 Run `make olddefconfig` to automatically set all new kernel configuration options to their recommended default values.
313 318
314 319 ##### `KERNEL_CCACHE`=false
315 320 Compile the kernel using ccache. This speeds up kernel recompilation by caching previous compilations and detecting when the same compilation is being done again.
316 321
317 322 ##### `KERNEL_REMOVESRC`=true
318 323 Remove all kernel sources from the generated OS image after it was built and installed.
319 324
320 325 ##### `KERNELSRC_DIR`=""
321 326 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.
322 327
323 328 ##### `KERNELSRC_CLEAN`=false
324 329 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.
325 330
326 331 ##### `KERNELSRC_CONFIG`=true
327 332 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.
328 333
329 334 ##### `KERNELSRC_USRCONFIG`=""
330 335 Copy own config file to kernel `.config`. If `KERNEL_MENUCONFIG`=true then running after copy.
331 336
332 337 ##### `KERNELSRC_PREBUILT`=false
333 338 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.
334 339
335 340 ##### `RPI_FIRMWARE_DIR`=""
336 341 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.
337 342
338 343 ---
339 344
340 345 #### Reduce disk usage:
341 346 The following list of parameters is ignored if `ENABLE_REDUCE`=false.
342 347
343 348 ##### `REDUCE_APT`=true
344 349 Configure APT to use compressed package repository lists and no package caching files.
345 350
346 351 ##### `REDUCE_DOC`=true
347 352 Remove all doc files (harsh). Configure APT to not include doc files on future `apt-get` package installations.
348 353
349 354 ##### `REDUCE_MAN`=true
350 355 Remove all man pages and info files (harsh). Configure APT to not include man pages on future `apt-get` package installations.
351 356
352 357 ##### `REDUCE_VIM`=false
353 358 Replace `vim-tiny` package by `levee` a tiny vim clone.
354 359
355 360 ##### `REDUCE_BASH`=false
356 361 Remove `bash` package and switch to `dash` shell (experimental).
357 362
358 363 ##### `REDUCE_HWDB`=true
359 364 Remove PCI related hwdb files (experimental).
360 365
361 366 ##### `REDUCE_SSHD`=true
362 367 Replace `openssh-server` with `dropbear`.
363 368
364 369 ##### `REDUCE_LOCALE`=true
365 370 Remove all `locale` translation files.
366 371
367 372 ---
368 373
369 374 #### Encrypted root partition:
370 375 ##### `ENABLE_CRYPTFS`=false
371 376 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.
372 377
373 378 ##### `CRYPTFS_PASSWORD`=""
374 379 Set password of the encrypted root partition. This parameter is mandatory if `ENABLE_CRYPTFS`=true.
375 380
376 381 ##### `CRYPTFS_MAPPING`="secure"
377 382 Set name of dm-crypt managed device-mapper mapping.
378 383
379 384 ##### `CRYPTFS_CIPHER`="aes-xts-plain64:sha512"
380 385 Set cipher specification string. `aes-xts*` ciphers are strongly recommended.
381 386
382 387 ##### `CRYPTFS_XTSKEYSIZE`=512
383 388 Sets key size in bits. The argument has to be a multiple of 8.
384 389
385 390 ---
386 391
387 392 #### Build settings:
388 393 ##### `BASEDIR`=$(pwd)/images/${RELEASE}
389 394 Set a path to a working directory used by the script to generate an image.
390 395
391 396 ##### `IMAGE_NAME`=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}
392 397 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.
393 398
394 399 ## Understanding the script
395 400 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:
396 401
397 402 | Script | Description |
398 403 | --- | --- |
399 404 | `10-bootstrap.sh` | Debootstrap basic system |
400 405 | `11-apt.sh` | Setup APT repositories |
401 406 | `12-locale.sh` | Setup Locales and keyboard settings |
402 | `13-kernel.sh` | Build and install RPi0/1/2/3 Kernel |
407 | `13-kernel.sh` | Build and install RPi 0/1/2/3 Kernel |
403 408 | `14-fstab.sh` | Setup fstab and initramfs |
404 | `15-rpi-config.sh` | Setup RPi0/1/2/3 config and cmdline |
409 | `15-rpi-config.sh` | Setup RPi 0/1/2/3 config and cmdline |
405 410 | `20-networking.sh` | Setup Networking |
406 411 | `21-firewall.sh` | Setup Firewall |
407 412 | `30-security.sh` | Setup Users and Security settings |
408 413 | `31-logging.sh` | Setup Logging |
409 414 | `32-sshd.sh` | Setup SSH and public keys |
410 415 | `41-uboot.sh` | Build and Setup U-Boot |
411 416 | `42-fbturbo.sh` | Build and Setup fbturbo Xorg driver |
412 417 | `43-videocore.sh` | Build and Setup videocore libraries |
413 418 | `50-firstboot.sh` | First boot actions |
414 419 | `99-reduce.sh` | Reduce the disk space usage |
415 420
416 421 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.
417 422
418 423 | Directory | Description |
419 424 | --- | --- |
420 425 | `apt` | APT management configuration files |
421 | `boot` | Boot and RPi0/1/2/3 configuration files |
426 | `boot` | Boot and RPi 0/1/2/3 configuration files |
422 427 | `dpkg` | Package Manager configuration |
423 428 | `etc` | Configuration files and rc scripts |
424 429 | `firstboot` | Scripts that get executed on first boot |
425 430 | `initramfs` | Initramfs scripts |
426 431 | `iptables` | Firewall configuration files |
427 432 | `locales` | Locales configuration |
428 433 | `modules` | Kernel Modules configuration |
429 434 | `mount` | Fstab configuration |
430 435 | `network` | Networking configuration files |
431 436 | `sysctl.d` | Swapping and Network Hardening configuration |
432 437 | `xorg` | fbturbo Xorg driver configuration |
433 438
434 439 ## Custom packages and scripts
435 440 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`.
436 441
437 442 Scripts in the custom.d directory will be executed after all other installation is complete but before the image is created.
438 443
439 444 ## Logging of the bootstrapping process
440 445 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:
441 446
442 447 ```shell
443 448 script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log
444 449 ```
445 450
446 451 ## Flashing the image file
447 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 RPi0/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`.
452 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`.
448 453
449 454 ##### Flashing examples:
450 455 ```shell
451 456 bmaptool copy ./images/buster/2017-01-23-rpi3-buster.img /dev/mmcblk0
452 457 dd bs=4M if=./images/buster/2017-01-23-rpi3-buster.img of=/dev/mmcblk0
453 458 ```
454 459 If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:
455 460 ```shell
456 461 bmaptool copy ./images/buster/2017-01-23-rpi3-buster-frmw.img /dev/mmcblk0
457 462 bmaptool copy ./images/buster/2017-01-23-rpi3-buster-root.img /dev/sdc
458 463 ```
459 464
460 465 ## QEMU emulation
461 466 Start QEMU full system emulation:
462 467 ```shell
463 468 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"
464 469 ```
465 470
466 471 Start QEMU full system emulation and output to console:
467 472 ```shell
468 473 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
469 474 ```
470 475
471 476 Start QEMU full system emulation with SMP and output to console:
472 477 ```shell
473 478 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
474 479 ```
475 480
476 481 Start QEMU full system emulation with cryptfs, initramfs and output to console:
477 482 ```shell
478 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 -initrd "initramfs-${KERNEL_VERSION}" -append "root=/dev/mapper/secure cryptdevice=/dev/mmcblk0p2:secure rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio
479 484 ```
480 485
481 486 ## External links and references
482 487 * [Debian worldwide mirror sites](https://www.debian.org/mirror/list)
483 488 * [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)
484 489 * [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains)
485 490 * [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)
486 491 * [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)
487 492 * [U-BOOT git repository](https://git.denx.de/?p=u-boot.git;a=summary)
488 493 * [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)
489 494 * [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/brcm)
490 495 * [Collabora RPi2 Kernel precompiled](https://repositories.collabora.co.uk/debian/)
General Comments 0
Vous devez vous connecter pour laisser un commentaire. Se connecter maintenant