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

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

Refactor...
Unknown -
r375:a90f6ad1a83f
parent child
Show More
Show file before | Show file after | Hide comments
@@ -1,499 +1,490
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 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```).
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.11.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 The script has been tested using the default `crossbuild-essential-armhf` toolchain meta package on Debian Linux `jessie` and `stretch` build systems. Please check the [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains) for further information.
13
14 If a Debian Linux `jessie` build system is used it will be required to add the [Debian Cross-toolchains repository](http://emdebian.org/tools/debian/) first:
15
16 ```
17 echo "deb http://emdebian.org/tools/debian/ jessie main" > /etc/apt/sources.list.d/crosstools.list
18 sudo -u nobody wget -O - http://emdebian.org/tools/debian/emdebian-toolchain-archive.key | apt-key add -
19 dpkg --add-architecture armhf
20 apt-get update
21 ```
12 The script has been tested using the default `crossbuild-essential-armhf` toolchain meta package on Debian Linux and `stretch` build systems. Please check the [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains) for further information.
22 13
23 14 ## Command-line parameters
24 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.
25 16
26 17 ##### Command-line examples:
27 18 ```shell
28 19 ENABLE_UBOOT=true ./rpi23-gen-image.sh
29 20 ENABLE_CONSOLE=false ENABLE_IPV6=false ./rpi23-gen-image.sh
30 21 ENABLE_WM=xfce4 ENABLE_FBTURBO=true ENABLE_MINBASE=true ./rpi23-gen-image.sh
31 22 ENABLE_HARDNET=true ENABLE_IPTABLES=true /rpi23-gen-image.sh
32 23 APT_SERVER=ftp.de.debian.org APT_PROXY="http://127.0.0.1:3142/" ./rpi23-gen-image.sh
33 24 ENABLE_MINBASE=true ./rpi23-gen-image.sh
34 25 BUILD_KERNEL=true ENABLE_MINBASE=true ENABLE_IPV6=false ./rpi23-gen-image.sh
35 26 BUILD_KERNEL=true KERNELSRC_DIR=/tmp/linux ./rpi23-gen-image.sh
36 27 ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh
37 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
38 29 RELEASE=stretch BUILD_KERNEL=true ./rpi23-gen-image.sh
39 30 RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
40 31 RELEASE=stretch RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
41 32 ```
42 33
43 34 ## Configuration template files
44 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.
45 36
46 37 ##### Command-line examples:
47 38 ```shell
48 39 CONFIG_TEMPLATE=rpi3stretch ./rpi23-gen-image.sh
49 40 CONFIG_TEMPLATE=rpi2stretch ./rpi23-gen-image.sh
50 41 ```
51 42
52 43 ## Supported parameters and settings
53 44 #### APT settings:
54 45 ##### `APT_SERVER`="ftp.debian.org"
55 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.
56 47
57 48 ##### `APT_PROXY`=""
58 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.
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.
59 50
60 51 ##### `APT_INCLUDES`=""
61 52 A comma separated list of additional packages to be installed by debootstrap during bootstrapping.
62 53
63 54 ##### `APT_INCLUDES_LATE`=""
64 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.
65 56
66 57 ---
67 58
68 59 #### General system settings:
69 60 ##### `RPI_MODEL`=2
70 61 Specifiy the target Raspberry Pi hardware model. The script at this time supports the following Raspberry Pi models:
71 62 `0` = Used for Raspberry Pi 0 and Raspberry Pi 0 W
72 63 `1` = Used for Pi 1 model A and B
73 64 `1P` = Used for Pi 1 model B+ and A+
74 65 `2` = Used for Pi 2 model B
75 66 `3` = Used for Pi 3 model B
76 67 `3P` = Used for Pi 3 model B+
77 68 `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` or `3P` is used.
78 69
79 ##### `RELEASE`="jessie"
80 Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases "jessie", "stretch" and "buster". `BUILD_KERNEL`=true will automatically be set if the Debian releases `stretch` or `buster` are used.
70 ##### `RELEASE`="buster"
71 Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases "stretch" and "buster". `BUILD_KERNEL`=true will automatically be set if the Debian releases `stretch` or `buster` are used.
81 72
82 73 ##### `RELEASE_ARCH`="armhf"
83 74 Set the desired Debian release architecture.
84 75
85 76 ##### `HOSTNAME`="rpi$RPI_MODEL-$RELEASE"
86 77 Set system host name. It's recommended that the host name is unique in the corresponding subnet.
87 78
88 79 ##### `PASSWORD`="raspberry"
89 80 Set system `root` password. It's **STRONGLY** recommended that you choose a custom password.
90 81
91 82 ##### `USER_PASSWORD`="raspberry"
92 83 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.
93 84
94 85 ##### `DEFLOCAL`="en_US.UTF-8"
95 86 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`.
96 87
97 88 ##### `TIMEZONE`="Europe/Berlin"
98 89 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.
99 90
100 91 ##### `EXPANDROOT`=true
101 92 Expand the root partition and filesystem automatically on first boot.
102 93
103 94 ##### `ENABLE_QEMU`=false
104 95 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.
105 96
106 97 ---
107 98
108 99 #### Keyboard settings:
109 100 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.
110 101
111 102 ##### `XKB_MODEL`=""
112 103 Set the name of the model of your keyboard type.
113 104
114 105 ##### `XKB_LAYOUT`=""
115 106 Set the supported keyboard layout(s).
116 107
117 108 ##### `XKB_VARIANT`=""
118 109 Set the supported variant(s) of the keyboard layout(s).
119 110
120 111 ##### `XKB_OPTIONS`=""
121 112 Set extra xkb configuration options.
122 113
123 114 ---
124 115
125 116 #### Networking settings (DHCP):
126 117 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`.`
127 118
128 119 ##### `ENABLE_DHCP`=true
129 120 Set the system to use DHCP. This requires an DHCP server.
130 121
131 122 ---
132 123
133 124 #### Networking settings (static):
134 125 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`.
135 126
136 127 ##### `NET_ADDRESS`=""
137 128 Set a static IPv4 or IPv6 address and its prefix, separated by "/", eg. "192.169.0.3/24".
138 129
139 130 ##### `NET_GATEWAY`=""
140 131 Set the IP address for the default gateway.
141 132
142 133 ##### `NET_DNS_1`=""
143 134 Set the IP address for the first DNS server.
144 135
145 136 ##### `NET_DNS_2`=""
146 137 Set the IP address for the second DNS server.
147 138
148 139 ##### `NET_DNS_DOMAINS`=""
149 140 Set the default DNS search domains to use for non fully qualified host names.
150 141
151 142 ##### `NET_NTP_1`=""
152 143 Set the IP address for the first NTP server.
153 144
154 145 ##### `NET_NTP_2`=""
155 146 Set the IP address for the second NTP server.
156 147
157 148 ---
158 149
159 150 #### Basic system features:
160 151 ##### `ENABLE_CONSOLE`=true
161 152 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.
162 153
163 154 ##### `ENABLE_I2C`=false
164 155 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.
165 156
166 157 ##### `ENABLE_SPI`=false
167 158 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.
168 159
169 160 ##### `ENABLE_IPV6`=true
170 161 Enable IPv6 support. The network interface configuration is managed via systemd-networkd.
171 162
172 163 ##### `ENABLE_SSHD`=true
173 164 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.
174 165
175 166 ##### `ENABLE_NONFREE`=false
176 167 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.
177 168
178 169 ##### `ENABLE_WIRELESS`=false
179 170 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`.
180 171
181 172 ##### `ENABLE_RSYSLOG`=true
182 173 If set to false, disable and uninstall rsyslog (so logs will be available only
183 174 in journal files)
184 175
185 176 ##### `ENABLE_SOUND`=true
186 177 Enable sound hardware and install Advanced Linux Sound Architecture.
187 178
188 179 ##### `ENABLE_HWRANDOM`=true
189 180 Enable Hardware Random Number Generator. Strong random numbers are important for most network based communications that use encryption. It's recommended to be enabled.
190 181
191 182 ##### `ENABLE_MINGPU`=false
192 183 Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU.
193 184
194 185 ##### `ENABLE_DBUS`=true
195 186 Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled.
196 187
197 188 ##### `ENABLE_XORG`=false
198 189 Install Xorg open-source X Window System.
199 190
200 191 ##### `ENABLE_WM`=""
201 192 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`.
202 193
203 194 ##### `ENABLE_SYSVINIT`=false
204 195 Support for halt,init,poweroff,reboot,runlevel,shutdown,telinit commands
205 196
206 197 ---
207 198
208 199 #### Advanced system features:
209 200 ##### `ENABLE_MINBASE`=false
210 201 Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
211 202
212 203 ##### `ENABLE_REDUCE`=false
213 204 Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.
214 205
215 206 ##### `ENABLE_UBOOT`=false
216 207 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.
217 208
218 209 ##### `UBOOTSRC_DIR`=""
219 210 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.
220 211
221 212 ##### `ENABLE_FBTURBO`=false
222 213 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.
223 214
224 215 ##### `FBTURBOSRC_DIR`=""
225 216 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.
226 217
227 218 ##### `ENABLE_VIDEOCORE`=false
228 219 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.
229 220
230 221 ##### `VIDEOCORESRC_DIR`=""
231 222 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.
232 223
233 224 ##### `ENABLE_IPTABLES`=false
234 225 Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.
235 226
236 227 ##### `ENABLE_USER`=true
237 228 Create non-root user with password `USER_PASSWORD`=raspberry. Unless overridden with `USER_NAME`=user, username will be `pi`.
238 229
239 230 ##### `USER_NAME`=pi
240 231 Non-root user to create. Ignored if `ENABLE_USER`=false
241 232
242 233 ##### `ENABLE_ROOT`=false
243 234 Set root user password so root login will be enabled
244 235
245 236 ##### `ENABLE_HARDNET`=false
246 237 Enable IPv4/IPv6 network stack hardening settings.
247 238
248 239 ##### `ENABLE_SPLITFS`=false
249 240 Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.
250 241
251 242 ##### `CHROOT_SCRIPTS`=""
252 243 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.
253 244
254 245 ##### `ENABLE_INITRAMFS`=false
255 246 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.
256 247
257 248 ##### `ENABLE_IFNAMES`=true
258 249 Enable automatic assignment of predictable, stable network interface names for all local Ethernet, WLAN interfaces. This might create complex and long interface names. This parameter is only supported if the Debian releases `stretch` or `buster` are used.
259 250
260 251 ##### `DISABLE_UNDERVOLT_WARNINGS`=
261 252 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.
262 253
263 254 ---
264 255
265 256 #### SSH settings:
266 257 ##### `SSH_ENABLE_ROOT`=false
267 258 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`.
268 259
269 260 ##### `SSH_DISABLE_PASSWORD_AUTH`=false
270 261 Disable password based SSH authentication. Only public key based SSH (v2) authentication will be supported.
271 262
272 263 ##### `SSH_LIMIT_USERS`=false
273 264 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).
274 265
275 266 ##### `SSH_ROOT_PUB_KEY`=""
276 267 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`.
277 268
278 269 ##### `SSH_USER_PUB_KEY`=""
279 270 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.
280 271
281 272 ---
282 273
283 274 #### Kernel compilation:
284 275 ##### `BUILD_KERNEL`=false
285 276 Build and install the latest RPi2/3 Linux kernel. Currently only the default RPi2/3 kernel configuration is used. `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` is used.
286 277
287 278 ##### `CROSS_COMPILE`="arm-linux-gnueabihf-"
288 279 This sets the cross compile enviornment for the compiler.
289 280
290 281 ##### `KERNEL_ARCH`="arm"
291 282 This sets the kernel architecture for the compiler.
292 283
293 284 ##### `KERNEL_IMAGE`="kernel7.img"
294 285 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.
295 286
296 287 ##### `KERNEL_BRANCH`=""
297 288 Name of the requested branch from the GIT location for the RPi Kernel. Default is using the current default branch from the GIT site.
298 289
299 290 ##### `QEMU_BINARY`="/usr/bin/qemu-arm-static"
300 291 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.
301 292
302 293 ##### `KERNEL_DEFCONFIG`="bcm2709_defconfig"
303 294 Sets the default config for kernel compiling. If not set, `KERNEL_DEFCONFIG` will be set to "bcmrpi3\_defconfig" automatically if building for arm64.
304 295
305 296 ##### `KERNEL_REDUCE`=false
306 297 Reduce the size of the generated kernel by removing unwanted device, network and filesystem drivers (experimental).
307 298
308 299 ##### `KERNEL_THREADS`=1
309 300 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.
310 301
311 302 ##### `KERNEL_HEADERS`=true
312 303 Install kernel headers with built kernel.
313 304
314 305 ##### `KERNEL_MENUCONFIG`=false
315 306 Start `make menuconfig` interactive menu-driven kernel configuration. The script will continue after `make menuconfig` was terminated.
316 307
317 308 ##### `KERNEL_OLDDEFCONFIG`=false
318 309 Run `make olddefconfig` to automatically set all new kernel configuration options to their recommended default values.
319 310
320 311 ##### `KERNEL_CCACHE`=false
321 312 Compile the kernel using ccache. This speeds up kernel recompilation by caching previous compilations and detecting when the same compilation is being done again.
322 313
323 314 ##### `KERNEL_REMOVESRC`=true
324 315 Remove all kernel sources from the generated OS image after it was built and installed.
325 316
326 317 ##### `KERNELSRC_DIR`=""
327 318 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.
328 319
329 320 ##### `KERNELSRC_CLEAN`=false
330 321 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.
331 322
332 323 ##### `KERNELSRC_CONFIG`=true
333 324 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.
334 325
335 326 ##### `KERNELSRC_USRCONFIG`=""
336 327 Copy own config file to kernel `.config`. If `KERNEL_MENUCONFIG`=true then running after copy.
337 328
338 329 ##### `KERNELSRC_PREBUILT`=false
339 330 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.
340 331
341 332 ##### `RPI_FIRMWARE_DIR`=""
342 333 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.
343 334
344 335 ---
345 336
346 337 #### Reduce disk usage:
347 338 The following list of parameters is ignored if `ENABLE_REDUCE`=false.
348 339
349 340 ##### `REDUCE_APT`=true
350 341 Configure APT to use compressed package repository lists and no package caching files.
351 342
352 343 ##### `REDUCE_DOC`=true
353 344 Remove all doc files (harsh). Configure APT to not include doc files on future `apt-get` package installations.
354 345
355 346 ##### `REDUCE_MAN`=true
356 347 Remove all man pages and info files (harsh). Configure APT to not include man pages on future `apt-get` package installations.
357 348
358 349 ##### `REDUCE_VIM`=false
359 350 Replace `vim-tiny` package by `levee` a tiny vim clone.
360 351
361 352 ##### `REDUCE_BASH`=false
362 353 Remove `bash` package and switch to `dash` shell (experimental).
363 354
364 355 ##### `REDUCE_HWDB`=true
365 356 Remove PCI related hwdb files (experimental).
366 357
367 358 ##### `REDUCE_SSHD`=true
368 359 Replace `openssh-server` with `dropbear`.
369 360
370 361 ##### `REDUCE_LOCALE`=true
371 362 Remove all `locale` translation files.
372 363
373 364 ---
374 365
375 366 #### Encrypted root partition:
376 367 ##### `ENABLE_CRYPTFS`=false
377 368 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.
378 369
379 370 ##### `CRYPTFS_PASSWORD`=""
380 371 Set password of the encrypted root partition. This parameter is mandatory if `ENABLE_CRYPTFS`=true.
381 372
382 373 ##### `CRYPTFS_MAPPING`="secure"
383 374 Set name of dm-crypt managed device-mapper mapping.
384 375
385 376 ##### `CRYPTFS_CIPHER`="aes-xts-plain64:sha512"
386 377 Set cipher specification string. `aes-xts*` ciphers are strongly recommended.
387 378
388 379 ##### `CRYPTFS_XTSKEYSIZE`=512
389 380 Sets key size in bits. The argument has to be a multiple of 8.
390 381
391 382 ---
392 383
393 384 #### Build settings:
394 385 ##### `BASEDIR`=$(pwd)/images/${RELEASE}
395 386 Set a path to a working directory used by the script to generate an image.
396 387
397 388 ##### `IMAGE_NAME`=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}
398 389 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.
399 390
400 391 ## Understanding the script
401 392 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:
402 393
403 394 | Script | Description |
404 395 | --- | --- |
405 396 | `10-bootstrap.sh` | Debootstrap basic system |
406 397 | `11-apt.sh` | Setup APT repositories |
407 398 | `12-locale.sh` | Setup Locales and keyboard settings |
408 399 | `13-kernel.sh` | Build and install RPi2/3 Kernel |
409 400 | `14-fstab.sh` | Setup fstab and initramfs |
410 401 | `15-rpi-config.sh` | Setup RPi2/3 config and cmdline |
411 402 | `20-networking.sh` | Setup Networking |
412 403 | `21-firewall.sh` | Setup Firewall |
413 404 | `30-security.sh` | Setup Users and Security settings |
414 405 | `31-logging.sh` | Setup Logging |
415 406 | `32-sshd.sh` | Setup SSH and public keys |
416 407 | `41-uboot.sh` | Build and Setup U-Boot |
417 408 | `42-fbturbo.sh` | Build and Setup fbturbo Xorg driver |
418 409 | `50-firstboot.sh` | First boot actions |
419 410 | `99-reduce.sh` | Reduce the disk space usage |
420 411
421 412 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.
422 413
423 414 | Directory | Description |
424 415 | --- | --- |
425 416 | `apt` | APT management configuration files |
426 417 | `boot` | Boot and RPi2/3 configuration files |
427 418 | `dpkg` | Package Manager configuration |
428 419 | `etc` | Configuration files and rc scripts |
429 420 | `firstboot` | Scripts that get executed on first boot |
430 421 | `initramfs` | Initramfs scripts |
431 422 | `iptables` | Firewall configuration files |
432 423 | `locales` | Locales configuration |
433 424 | `modules` | Kernel Modules configuration |
434 425 | `mount` | Fstab configuration |
435 426 | `network` | Networking configuration files |
436 427 | `sysctl.d` | Swapping and Network Hardening configuration |
437 428 | `xorg` | fbturbo Xorg driver configuration |
438 429
439 430 ## Custom packages and scripts
440 431 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`.
441 432
442 433 Scripts in the custom.d directory will be executed after all other installation is complete but before the image is created.
443 434
444 435 ## Logging of the bootstrapping process
445 436 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:
446 437
447 438 ```shell
448 439 script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log
449 440 ```
450 441
451 442 ## Flashing the image file
452 443 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`.
453 444
454 445 ##### Flashing examples:
455 446 ```shell
456 447 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie.img /dev/mmcblk0
457 448 dd bs=4M if=./images/jessie/2017-01-23-rpi3-jessie.img of=/dev/mmcblk0
458 449 ```
459 450 If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:
460 451 ```shell
461 452 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie-frmw.img /dev/mmcblk0
462 453 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie-root.img /dev/sdc
463 454 ```
464 455
465 456 ## QEMU emulation
466 457 Start QEMU full system emulation:
467 458 ```shell
468 459 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"
469 460 ```
470 461
471 462 Start QEMU full system emulation and output to console:
472 463 ```shell
473 464 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
474 465 ```
475 466
476 467 Start QEMU full system emulation with SMP and output to console:
477 468 ```shell
478 469 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
479 470 ```
480 471
481 472 Start QEMU full system emulation with cryptfs, initramfs and output to console:
482 473 ```shell
483 474 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
484 475 ```
485 476
486 477 ## Weekly image builds
487 478 The image files are provided by JRWR'S I/O PORT and are built once a Sunday at midnight UTC!
488 479 * [Debian Stretch Raspberry Pi2/3 Weekly Image Builds](https://jrwr.io/doku.php?id=projects:debianpi)
489 480
490 481 ## External links and references
491 482 * [Debian worldwide mirror sites](https://www.debian.org/mirror/list)
492 483 * [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)
493 484 * [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains)
494 485 * [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)
495 486 * [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)
496 487 * [U-BOOT git repository](https://git.denx.de/?p=u-boot.git;a=summary)
497 488 * [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)
498 489 * [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/brcm)
499 490 * [Collabora RPi2 Kernel precompiled](https://repositories.collabora.co.uk/debian/)
Show file before | Show file after | Hide comments
@@ -1,41 +1,41
1 1 #
2 2 # Debootstrap basic system
3 3 #
4 4
5 5 # Load utility functions
6 6 . ./functions.sh
7 7
8 8 VARIANT=""
9 9 COMPONENTS="main"
10 10
11 11 # Use non-free Debian packages if needed
12 12 if [ "$ENABLE_NONFREE" = true ] ; then
13 13 COMPONENTS="main,non-free,contrib"
14 14 fi
15 15
16 16 # Use minbase bootstrap variant which only includes essential packages
17 17 if [ "$ENABLE_MINBASE" = true ] ; then
18 18 VARIANT="--variant=minbase"
19 19 fi
20 20
21 21 # Base debootstrap (unpack only)
22 http_proxy=${APT_PROXY} debootstrap "${APT_EXCLUDES}" --arch="${RELEASE_ARCH}" --foreign ${VARIANT} --components="${COMPONENTS}" --include="${APT_INCLUDES}" "${RELEASE}" "${R}" "http://${APT_SERVER}/debian"
22 http_proxy=${APT_PROXY} debootstrap ${APT_EXCLUDES} --arch="${RELEASE_ARCH}" --foreign ${VARIANT} --components="${COMPONENTS}" --include="${APT_INCLUDES}" "${RELEASE}" "${R}" "http://${APT_SERVER}/debian"
23 23
24 24 # Copy qemu emulator binary to chroot
25 25 install -m 755 -o root -g root "${QEMU_BINARY}" "${R}${QEMU_BINARY}"
26 26
27 27 # Copy debian-archive-keyring.pgp
28 28 mkdir -p "${R}/usr/share/keyrings"
29 29 install_readonly /usr/share/keyrings/debian-archive-keyring.gpg "${R}/usr/share/keyrings/debian-archive-keyring.gpg"
30 30
31 31 # Complete the bootstrapping process
32 32 chroot_exec /debootstrap/debootstrap --second-stage
33 33
34 34 # Mount required filesystems
35 35 mount -t proc none "${R}/proc"
36 36 mount -t sysfs none "${R}/sys"
37 37
38 38 # Mount pseudo terminal slave if supported by Debian release
39 39 if [ -d "${R}/dev/pts" ] ; then
40 40 mount --bind /dev/pts "${R}/dev/pts"
41 41 fi
Show file before | Show file after | Hide comments
@@ -1,55 +1,39
1 1 #
2 2 # Setup APT repositories
3 3 #
4 4
5 5 # Load utility functions
6 6 . ./functions.sh
7 7
8 8 # Install and setup APT proxy configuration
9 9 if [ -z "$APT_PROXY" ] ; then
10 10 install_readonly files/apt/10proxy "${ETC_DIR}/apt/apt.conf.d/10proxy"
11 11 sed -i "s/\"\"/\"${APT_PROXY}\"/" "${ETC_DIR}/apt/apt.conf.d/10proxy"
12 12 fi
13 13
14 14 if [ "$BUILD_KERNEL" = false ] ; then
15 # Install APT pinning configuration for flash-kernel package
16 install_readonly files/apt/flash-kernel "${ETC_DIR}/apt/preferences.d/flash-kernel"
17
18 # Install APT sources.list
19 install_readonly files/apt/sources.list "${ETC_DIR}/apt/sources.list"
20 echo "deb ${COLLABORA_URL} ${RELEASE} rpi2" >> "${ETC_DIR}/apt/sources.list"
21
22 # Upgrade collabora package index and install collabora keyring
23 chroot_exec apt-get -qq -y update
24 chroot_exec apt-get -qq -y --allow-unauthenticated install collabora-obs-archive-keyring
25 else # BUILD_KERNEL=true
26 # Install APT sources.list
27 install_readonly files/apt/sources.list "${ETC_DIR}/apt/sources.list"
28
29 # Use specified APT server and release
30 sed -i "s/\/ftp.debian.org\//\/${APT_SERVER}\//" "${ETC_DIR}/apt/sources.list"
31 sed -i "s/ jessie/ ${RELEASE}/" "${ETC_DIR}/apt/sources.list"
32 fi
33
34 # Allow the installation of non-free Debian packages
35 if [ "$ENABLE_NONFREE" = true ] ; then
36 sed -i "s/ contrib/ contrib non-free/" "${ETC_DIR}/apt/sources.list"
15 echo "Downloading precompiled kernel"
16 echo "error: not configured"
17 exit 1;
18 # BUILD_KERNEL=true
19 else
20 echo "No precompiled kernel repositories were added"
37 21 fi
38 22
39 23 # Upgrade package index and update all installed packages and changed dependencies
40 24 chroot_exec apt-get -qq -y update
41 25 chroot_exec apt-get -qq -y -u dist-upgrade
42 26
43 27 if [ "$APT_INCLUDES_LATE" ] ; then
44 28 chroot_exec apt-get -qq -y install "$(echo "$APT_INCLUDES_LATE" |tr , ' ')"
45 29 fi
46 30
47 31 if [ -d packages ] ; then
48 32 for package in packages/*.deb ; do
49 33 cp "$package" "${R}"/tmp
50 34 chroot_exec dpkg --unpack /tmp/"$(basename "$package")"
51 35 done
52 36 fi
53 37 chroot_exec apt-get -qq -y -f install
54 38
55 39 chroot_exec apt-get -qq -y check
Show file before | Show file after | Hide comments
@@ -1,796 +1,802
1 #!/bin/sh
2
1 #!/bin/bash
3 2 ########################################################################
4 3 # rpi23-gen-image.sh 2015-2017
5 4 #
6 # Advanced Debian "jessie", "stretch" and "buster" bootstrap script for RPi2/3
5 # Advanced Debian "stretch" and "buster" bootstrap script for RPi2/3
7 6 #
8 7 # This program is free software; you can redistribute it and/or
9 8 # modify it under the terms of the GNU General Public License
10 9 # as published by the Free Software Foundation; either version 2
11 10 # of the License, or (at your option) any later version.
12 11 #
13 12 # Copyright (C) 2015 Jan Wagner <mail@jwagner.eu>
14 13 #
15 14 # Big thanks for patches and enhancements by 20+ github contributors!
16 15 ########################################################################
17 16
18 17 # Are we running as root?
19 18 if [ "$(id -u)" -ne "0" ] ; then
20 19 echo "error: this script must be executed with root privileges!"
21 20 exit 1
22 21 fi
23 22
24 23 # Check if ./functions.sh script exists
25 24 if [ ! -r "./functions.sh" ] ; then
26 25 echo "error: './functions.sh' required script not found!"
27 26 exit 1
28 27 fi
29 28
30 29 # Load utility functions
31 30 . ./functions.sh
32 31
33 32 # Load parameters from configuration template file
34 33 if [ -n "$CONFIG_TEMPLATE" ] ; then
35 34 use_template
36 35 fi
37 36
38 37 # Introduce settings
39 38 set -e
40 39 echo -n -e "\n#\n# RPi2/3 Bootstrap Settings\n#\n"
41 40 set -x
42 41
43 42 # Raspberry Pi model configuration
44 43 RPI_MODEL=${RPI_MODEL:=2}
45 44
46 #bcm2708-rpi-0-w.dtb (Used for Pi 0 and PI 0W)
47 RPI0_DTB_FILE=${RPI0_DTB_FILE:=bcm2708-rpi-0-w.dtb}
48 RPI0_UBOOT_CONFIG=${RPI0_UBOOT_CONFIG:=rpi_defconfig}
49
50 #bcm2708-rpi-b.dtb (Used for Pi 1 model A and B)
51 RPI1_DTB_FILE=${RPI1_DTB_FILE:=bcm2708-rpi-b.dtb}
52 RPI1_UBOOT_CONFIG=${RPI1_UBOOT_CONFIG:=rpi_defconfig}
53
54 #bcm2708-rpi-b-plus.dtb (Used for Pi 1 model B+ and A+)
55 RPI1P_DTB_FILE=${RPI1P_DTB_FILE:=bcm2708-rpi-b-plus.dtb}
56 RPI1P_UBOOT_CONFIG=${RPI1P_UBOOT_CONFIG:=rpi_defconfig}
57
58 #bcm2709-rpi-2-b.dtb (Used for Pi 2 model B)
59 RPI2_DTB_FILE=${RPI2_DTB_FILE:=bcm2709-rpi-2-b.dtb}
60 RPI2_UBOOT_CONFIG=${RPI2_UBOOT_CONFIG:=rpi_2_defconfig}
61
62 #bcm2710-rpi-3-b.dtb (Used for Pi 3 model B)
63 RPI3_DTB_FILE=${RPI3_DTB_FILE:=bcm2710-rpi-3-b.dtb}
64 RPI3_UBOOT_CONFIG=${RPI3_UBOOT_CONFIG:=rpi_3_32b_defconfig}
65
66 #bcm2710-rpi-3-b-plus.dtb (Used for Pi 3 model B+)
67 RPI3P_DTB_FILE=${RPI3P_DTB_FILE:=bcm2710-rpi-3-b-plus.dtb}
68 RPI3P_UBOOT_CONFIG=${RPI3P_UBOOT_CONFIG:=rpi_3_32b_defconfig}
69
70 45 # Debian release
71 RELEASE=${RELEASE:=jessie}
72 KERNEL_ARCH=${KERNEL_ARCH:=arm}
73 RELEASE_ARCH=${RELEASE_ARCH:=armhf}
74 CROSS_COMPILE=${CROSS_COMPILE:=arm-linux-gnueabihf-}
75 COLLABORA_KERNEL=${COLLABORA_KERNEL:=3.18.0-trunk-rpi2}
76 if [ "$KERNEL_ARCH" = "arm64" ] ; then
77 KERNEL_DEFCONFIG=${KERNEL_DEFCONFIG:=bcmrpi3_defconfig}
78 KERNEL_IMAGE=${KERNEL_IMAGE:=kernel8.img}
79 fi
46 RELEASE=${RELEASE:=buster}
80 47
81 if [ "$RPI_MODEL" = 0 ] || [ "$RPI_MODEL" = 1 ] || [ "$RPI_MODEL" = 1P ] ; then
82 #RASPBERRY PI 1, PI ZERO, PI ZERO W, AND COMPUTE MODULE DEFAULT Kernel BUILD CONFIGURATION
83 KERNEL_DEFCONFIG=${KERNEL_DEFCONFIG:=bcmrpi_defconfig}
84 KERNEL_IMAGE=${KERNEL_IMAGE:=kernel7.img}
85 else
86 #RASPBERRY PI 2, PI 3, PI 3+, AND COMPUTE MODULE 3 DEFAULT Kernel BUILD CONFIGURATION
87 #https://www.raspberrypi.org/documentation/linux/kernel/building.md
88 KERNEL_DEFCONFIG=${KERNEL_DEFCONFIG:=bcm2709_defconfig}
89 KERNEL_IMAGE=${KERNEL_IMAGE:=kernel7.img}
90 fi
91
92 if [ "$RELEASE_ARCH" = "arm64" ] ; then
93 QEMU_BINARY=${QEMU_BINARY:=/usr/bin/qemu-aarch64-static}
94 else
95 QEMU_BINARY=${QEMU_BINARY:=/usr/bin/qemu-arm-static}
96 fi
48 #Kernel Branch
97 49 KERNEL_BRANCH=${KERNEL_BRANCH:=""}
98 50
99 51 # URLs
100 52 KERNEL_URL=${KERNEL_URL:=https://github.com/raspberrypi/linux}
101 53 FIRMWARE_URL=${FIRMWARE_URL:=https://github.com/raspberrypi/firmware/raw/master/boot}
102 54 WLAN_FIRMWARE_URL=${WLAN_FIRMWARE_URL:=https://github.com/RPi-Distro/firmware-nonfree/raw/master/brcm}
103 55 COLLABORA_URL=${COLLABORA_URL:=https://repositories.collabora.co.uk/debian}
104 56 FBTURBO_URL=${FBTURBO_URL:=https://github.com/ssvb/xf86-video-fbturbo.git}
105 57 UBOOT_URL=${UBOOT_URL:=https://git.denx.de/u-boot.git}
106 VIDEOCORE_URL=${VIDEOCORE_URL=https://github.com/raspberrypi/userland}
58 VIDEOCORE_URL=${VIDEOCORE_URL:=https://github.com/raspberrypi/userland}
107 59 BLUETOOTH_URL=${BLUETOOTH_URL:=https://github.com/RPi-Distro/pi-bluetooth.git}
108 60
109 61 # Build directories
110 62 BASEDIR=${BASEDIR:=$(pwd)/images/${RELEASE}}
111 63 BUILDDIR="${BASEDIR}/build"
112 64
113 65 # Prepare date string for default image file name
114 66 DATE="$(date +%Y-%m-%d)"
115 67 if [ -z "$KERNEL_BRANCH" ] ; then
116 68 IMAGE_NAME=${IMAGE_NAME:=${BASEDIR}/${DATE}-${KERNEL_ARCH}-CURRENT-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}}
117 69 else
118 70 IMAGE_NAME=${IMAGE_NAME:=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}}
119 71 fi
120 72
121 73 # Chroot directories
122 74 R="${BUILDDIR}/chroot"
123 75 ETC_DIR="${R}/etc"
124 76 LIB_DIR="${R}/lib"
125 77 BOOT_DIR="${R}/boot/firmware"
126 78 KERNEL_DIR="${R}/usr/src/linux"
127 79 WLAN_FIRMWARE_DIR="${LIB_DIR}/firmware/brcm"
128 80
129 81 # Firmware directory: Blank if download from github
130 82 RPI_FIRMWARE_DIR=${RPI_FIRMWARE_DIR:=""}
131 83
132 84 # General settings
85 SET_ARCH=${SET_ARCH:=32}
133 86 HOSTNAME=${HOSTNAME:=rpi${RPI_MODEL}-${RELEASE}}
134 87 PASSWORD=${PASSWORD:=raspberry}
135 88 USER_PASSWORD=${USER_PASSWORD:=raspberry}
136 89 DEFLOCAL=${DEFLOCAL:="en_US.UTF-8"}
137 90 TIMEZONE=${TIMEZONE:="Europe/Berlin"}
138 91 EXPANDROOT=${EXPANDROOT:=true}
139 92
140 93 # Keyboard settings
141 94 XKB_MODEL=${XKB_MODEL:=""}
142 95 XKB_LAYOUT=${XKB_LAYOUT:=""}
143 96 XKB_VARIANT=${XKB_VARIANT:=""}
144 97 XKB_OPTIONS=${XKB_OPTIONS:=""}
145 98
146 99 # Network settings (DHCP)
147 100 ENABLE_DHCP=${ENABLE_DHCP:=true}
148 101
149 102 # Network settings (static)
150 103 NET_ADDRESS=${NET_ADDRESS:=""}
151 104 NET_GATEWAY=${NET_GATEWAY:=""}
152 105 NET_DNS_1=${NET_DNS_1:=""}
153 106 NET_DNS_2=${NET_DNS_2:=""}
154 107 NET_DNS_DOMAINS=${NET_DNS_DOMAINS:=""}
155 108 NET_NTP_1=${NET_NTP_1:=""}
156 109 NET_NTP_2=${NET_NTP_2:=""}
157 110
158 111 # APT settings
159 112 APT_PROXY=${APT_PROXY:=""}
160 113 APT_SERVER=${APT_SERVER:="ftp.debian.org"}
161 114
162 115 # Feature settings
163 116 ENABLE_CONSOLE=${ENABLE_CONSOLE:=true}
164 117 ENABLE_I2C=${ENABLE_I2C:=false}
165 118 ENABLE_SPI=${ENABLE_SPI:=false}
166 119 ENABLE_IPV6=${ENABLE_IPV6:=true}
167 120 ENABLE_SSHD=${ENABLE_SSHD:=true}
168 121 ENABLE_NONFREE=${ENABLE_NONFREE:=false}
169 122 ENABLE_WIRELESS=${ENABLE_WIRELESS:=false}
170 123 ENABLE_SOUND=${ENABLE_SOUND:=true}
171 124 ENABLE_DBUS=${ENABLE_DBUS:=true}
172 125 ENABLE_HWRANDOM=${ENABLE_HWRANDOM:=true}
173 126 ENABLE_MINGPU=${ENABLE_MINGPU:=false}
174 127 ENABLE_XORG=${ENABLE_XORG:=false}
175 128 ENABLE_WM=${ENABLE_WM:=""}
176 129 ENABLE_RSYSLOG=${ENABLE_RSYSLOG:=true}
177 130 ENABLE_USER=${ENABLE_USER:=true}
178 131 USER_NAME=${USER_NAME:="pi"}
179 132 ENABLE_ROOT=${ENABLE_ROOT:=false}
180 133 ENABLE_QEMU=${ENABLE_QEMU:=false}
181 134 ENABLE_SYSVINIT=${ENABLE_SYSVINIT:=false}
182 135
183 136 # SSH settings
184 137 SSH_ENABLE_ROOT=${SSH_ENABLE_ROOT:=false}
185 138 SSH_DISABLE_PASSWORD_AUTH=${SSH_DISABLE_PASSWORD_AUTH:=false}
186 139 SSH_LIMIT_USERS=${SSH_LIMIT_USERS:=false}
187 140 SSH_ROOT_PUB_KEY=${SSH_ROOT_PUB_KEY:=""}
188 141 SSH_USER_PUB_KEY=${SSH_USER_PUB_KEY:=""}
189 142
190 143 # Advanced settings
191 144 ENABLE_MINBASE=${ENABLE_MINBASE:=false}
192 145 ENABLE_REDUCE=${ENABLE_REDUCE:=false}
193 146 ENABLE_UBOOT=${ENABLE_UBOOT:=false}
194 147 UBOOTSRC_DIR=${UBOOTSRC_DIR:=""}
195 148 ENABLE_FBTURBO=${ENABLE_FBTURBO:=false}
196 149 ENABLE_VIDEOCORE=${ENABLE_VIDEOCORE:=true}
197 150 VIDEOCORESRC_DIR=${VIDEOCORESRC_DIR:=""}
198 151 FBTURBOSRC_DIR=${FBTURBOSRC_DIR:=""}
199 152 ENABLE_HARDNET=${ENABLE_HARDNET:=false}
200 153 ENABLE_IPTABLES=${ENABLE_IPTABLES:=false}
201 154 ENABLE_SPLITFS=${ENABLE_SPLITFS:=false}
202 155 ENABLE_INITRAMFS=${ENABLE_INITRAMFS:=false}
203 156 ENABLE_IFNAMES=${ENABLE_IFNAMES:=true}
204 157 DISABLE_UNDERVOLT_WARNINGS=${DISABLE_UNDERVOLT_WARNINGS:=}
205 158
206 159 # Kernel compilation settings
207 BUILD_KERNEL=${BUILD_KERNEL:=false}
160 BUILD_KERNEL=${BUILD_KERNEL:=true}
208 161 KERNEL_REDUCE=${KERNEL_REDUCE:=false}
209 162 KERNEL_THREADS=${KERNEL_THREADS:=1}
210 163 KERNEL_HEADERS=${KERNEL_HEADERS:=true}
211 164 KERNEL_MENUCONFIG=${KERNEL_MENUCONFIG:=false}
212 165 KERNEL_REMOVESRC=${KERNEL_REMOVESRC:=true}
213 166 KERNEL_OLDDEFCONFIG=${KERNEL_OLDDEFCONFIG:=false}
214 167 KERNEL_CCACHE=${KERNEL_CCACHE:=false}
215 168
216 if [ "$KERNEL_ARCH" = "arm64" ] ; then
217 KERNEL_BIN_IMAGE=${KERNEL_BIN_IMAGE:="Image"}
218 else
219 KERNEL_BIN_IMAGE=${KERNEL_BIN_IMAGE:="zImage"}
220 fi
221
222 169 # Kernel compilation from source directory settings
223 170 KERNELSRC_DIR=${KERNELSRC_DIR:=""}
224 171 KERNELSRC_CLEAN=${KERNELSRC_CLEAN:=false}
225 172 KERNELSRC_CONFIG=${KERNELSRC_CONFIG:=true}
226 173 KERNELSRC_PREBUILT=${KERNELSRC_PREBUILT:=false}
227 174
228 175 # Reduce disk usage settings
229 176 REDUCE_APT=${REDUCE_APT:=true}
230 177 REDUCE_DOC=${REDUCE_DOC:=true}
231 178 REDUCE_MAN=${REDUCE_MAN:=true}
232 179 REDUCE_VIM=${REDUCE_VIM:=false}
233 180 REDUCE_BASH=${REDUCE_BASH:=false}
234 181 REDUCE_HWDB=${REDUCE_HWDB:=true}
235 182 REDUCE_SSHD=${REDUCE_SSHD:=true}
236 183 REDUCE_LOCALE=${REDUCE_LOCALE:=true}
237 184
238 185 # Encrypted filesystem settings
239 186 ENABLE_CRYPTFS=${ENABLE_CRYPTFS:=false}
240 187 CRYPTFS_PASSWORD=${CRYPTFS_PASSWORD:=""}
241 188 CRYPTFS_MAPPING=${CRYPTFS_MAPPING:="secure"}
242 189 CRYPTFS_CIPHER=${CRYPTFS_CIPHER:="aes-xts-plain64:sha512"}
243 190 CRYPTFS_XTSKEYSIZE=${CRYPTFS_XTSKEYSIZE:=512}
244 191
245 192 # Chroot scripts directory
246 193 CHROOT_SCRIPTS=${CHROOT_SCRIPTS:=""}
247 194
248 195 # Packages required in the chroot build environment
249 196 APT_INCLUDES=${APT_INCLUDES:=""}
250 197 APT_INCLUDES="${APT_INCLUDES},apt-transport-https,apt-utils,ca-certificates,debian-archive-keyring,dialog,sudo,systemd,sysvinit-utils,locales,keyboard-configuration,console-setup"
251 198
252 199 #Packages to exclude from chroot build environment
253 200 APT_EXCLUDES=${APT_EXCLUDES:=""}
254 201
255 202 # Packages required for bootstrapping
256 203 REQUIRED_PACKAGES="debootstrap debian-archive-keyring qemu-user-static binfmt-support dosfstools rsync bmap-tools whois git bc psmisc dbus sudo"
257 204 MISSING_PACKAGES=""
258 205
259 206 # Packages installed for c/c++ build environment in chroot (keep empty)
260 207 COMPILER_PACKAGES=""
261 208
262 209 set +x
263 210
264 211 #If init and systemd-sysv are wanted e.g. halt/reboot/shutdown scripts
265 212 if [ "$ENABLE_SYSVINIT" = false ] ; then
266 213 APT_EXCLUDES="--exclude=${APT_EXCLUDES},init,systemd-sysv"
267 214 fi
268 215
269 216 #Check if apt-cacher-ng has its default port open on and set APT_PROXY
270 217 if [ -n "$(lsof -i :3142)" ] ; then
271 218 HTTP_PROXY=http://127.0.0.1:3142/
219 fi
220
221 #make script easier and more stable to use with convenient setup switch. Just setup SET_ARCH and RPI_MODEL and your good to go!
222 if [ -n "$SET_ARCH" ] ; then
223 echo "Setting Architecture specific settings"
224 ##################################
225 # 64 bit config
226 ##################################
227 if [ "$SET_ARCH" = 64 ] ; then
228 echo "64 bit mode selected - Setting up enviroment"
229 # 64 bit depended settings
230 QEMU_BINARY=${QEMU_BINARY:=/usr/bin/qemu-aarch64-static}
231 KERNEL_ARCH=${KERNEL_ARCH:=arm64}
232 KERNEL_BIN_IMAGE=${KERNEL_BIN_IMAGE:="Image"}
272 233
273 # Set Raspberry Pi model specific configuration
274 if [ "$RPI_MODEL" = 0 ] ; then
275 DTB_FILE=${RPI0_DTB_FILE}
276 UBOOT_CONFIG=${RPI0_UBOOT_CONFIG}
277 elif [ "$RPI_MODEL" = 1 ] ; then
278 DTB_FILE=${RPI1_DTB_FILE}
279 UBOOT_CONFIG=${RPI1_UBOOT_CONFIG}
280 elif [ "$RPI_MODEL" = 1P ] ; then
281 DTB_FILE=${RPI1P_DTB_FILE}
282 UBOOT_CONFIG=${RPI1P_UBOOT_CONFIG}
283 elif [ "$RPI_MODEL" = 2 ] ; then
284 DTB_FILE=${RPI2_DTB_FILE}
285 UBOOT_CONFIG=${RPI2_UBOOT_CONFIG}
286 elif [ "$RPI_MODEL" = 3 ] ; then
287 DTB_FILE=${RPI3_DTB_FILE}
288 UBOOT_CONFIG=${RPI3_UBOOT_CONFIG}
289 elif [ "$RPI_MODEL" = 3P ] ; then
290 DTB_FILE=${RPI3P_DTB_FILE}
291 UBOOT_CONFIG=${RPI3P_UBOOT_CONFIG}
234 if [ "$RPI_MODEL" = 3 ] || [ "$RPI_MODEL" = 3P ] ; then
235 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} crossbuild-essential-arm64"
236 KERNEL_DEFCONFIG=${KERNEL_DEFCONFIG:=bcmrpi3_defconfig}
237 RELEASE_ARCH=${RELEASE_ARCH:=arm64}
238 KERNEL_IMAGE=${KERNEL_IMAGE:=kernel8.img}
239 CROSS_COMPILE=${CROSS_COMPILE:=aarch64-linux-gnu-}
292 240 else
293 echo "error: Raspberry Pi model ${RPI_MODEL} is not supported!"
241 echo "error: Only Raspberry PI 3 and 3B+ support 64bit"
294 242 exit 1
295 243 fi
244 fi
296 245
297 # Check if the internal wireless interface is supported by the RPi model
298 if [ "$ENABLE_WIRELESS" = true ] && ([ "$RPI_MODEL" = 1 ] || [ "$RPI_MODEL" = 1P ] || [ "$RPI_MODEL" = 2 ]); then
246 ##################################
247 # 32 bit config
248 ##################################
249 if [ "$SET_ARCH" = 32 ] ; then
250 echo "32 bit mode selected - Setting up enviroment"
251 #General 32bit configuration
252 QEMU_BINARY=${QEMU_BINARY:=/usr/bin/qemu-arm-static}
253 KERNEL_ARCH=${KERNEL_ARCH:=arm}
254 KERNEL_BIN_IMAGE=${KERNEL_BIN_IMAGE:="zImage"}
255
256 #Raspberry setting grouped by board compability
257 if [ "$RPI_MODEL" = 0 ] || [ "$RPI_MODEL" = 1 ] || [ "$RPI_MODEL" = 1P ] ; then
258 echo "Setting settings for bcm2835 Raspberry PI boards"
259 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} crossbuild-essential-armel"
260 KERNEL_DEFCONFIG=${KERNEL_DEFCONFIG:=bcmrpi_defconfig}
261 RELEASE_ARCH=${RELEASE_ARCH:=armel}
262 KERNEL_IMAGE=${KERNEL_IMAGE:=kernel.img}
263 CROSS_COMPILE=${CROSS_COMPILE:=arm-linux-gnueabi-}
264 fi
265 if [ "$RPI_MODEL" = 2 ] || [ "$RPI_MODEL" = 3 ] || [ "$RPI_MODEL" = 3P ] ; then
266 echo "Setting settings for bcm2837 Raspberry PI boards"
267 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} crossbuild-essential-armhf"
268 KERNEL_DEFCONFIG=${KERNEL_DEFCONFIG:=bcm2709_defconfig}
269 RELEASE_ARCH=${RELEASE_ARCH:=armhf}
270 KERNEL_IMAGE=${KERNEL_IMAGE:=kernel7.img}
271 CROSS_COMPILE=${CROSS_COMPILE:=arm-linux-gnueabihf-}
272 fi
273 fi
274 #SET_ARCH not set
275 else
276 echo "error: Please set '32' or '64' as value for SET_ARCH"
277 exit 1
278 fi
279
280 #Device specific configuration and uboot-config
281 echo "Select DTB-File"
282 case "$RPI_MODEL" in
283 0)
284 DTB_FILE=${DTB_FILE:=bcm2708-rpi-0-w.dtb}
285 UBOOT_CONFIG=${UBOOT_CONFIG:=rpi_defconfig}
286 ;;
287 1)
288 DTB_FILE=${DTB_FILE:=bcm2708-rpi-b.dtb}
289 UBOOT_CONFIG=${UBOOT_CONFIG:=rpi_defconfig}
290 ;;
291 1P)
292 DTB_FILE=${DTB_FILE:=bcm2708-rpi-b-plus.dtb}
293 UBOOT_CONFIG=${UBOOT_CONFIG:=rpi_defconfig}
294 ;;
295 2)
296 DTB_FILE=${DTB_FILE:=bcm2709-rpi-2-b.dtb}
297 UBOOT_CONFIG=${UBOOT_CONFIG:=rpi_2_defconfig}
298 ;;
299 3)
300 DTB_FILE=${DTB_FILE:=bcm2710-rpi-3-b.dtb}
301 UBOOT_CONFIG=${UBOOT_CONFIG:=rpi_3_defconfig}
302 ;;
303 3P)
304 DTB_FILE=${DTB_FILE:=bcm2710-rpi-3-b.dtb}
305 UBOOT_CONFIG=${UBOOT_CONFIG:=rpi_3_defconfig}
306 ;;
307 *)
308 echo "error: Raspberry Pi model $RPI_MODEL is not supported!"
309 exit 1
310 ;;
311 esac
312 echo "$DTB_FILE selected"
299 313
314 # Check if the internal wireless interface is supported by the RPi model
315 if [ "$ENABLE_WIRELESS" = true ] ; then
316 if [ "$RPI_MODEL" = 1 ] || [ "$RPI_MODEL" = 1P ] || [ "$RPI_MODEL" = 2 ] ; then
300 317 echo "error: The selected Raspberry Pi model has no internal wireless interface"
301 318 exit 1
319 else
320 echo "Raspberry Pi $RPI_MODEL has WIFI support"
321 fi
302 322 fi
303 323
304 324 # Check if DISABLE_UNDERVOLT_WARNINGS parameter value is supported
305 325 if [ -n "$DISABLE_UNDERVOLT_WARNINGS" ] ; then
306 326 if [ "$DISABLE_UNDERVOLT_WARNINGS" != 1 ] && [ "$DISABLE_UNDERVOLT_WARNINGS" != 2 ] ; then
307 327 echo "error: DISABLE_UNDERVOLT_WARNINGS=${DISABLE_UNDERVOLT_WARNINGS} is not supported"
308 328 exit 1
309 329 fi
310 330 fi
311 331
312 # Build RPi2/3 Linux kernel if required by Debian release
313 if [ "$RELEASE" = "stretch" ] || [ "$RELEASE" = "buster" ] ; then
314 BUILD_KERNEL=true
315 fi
316
317 332 # Add packages required for kernel cross compilation
318 333 if [ "$BUILD_KERNEL" = true ] ; then
319 334 if [ "$KERNEL_ARCH" = "arm" ] ; then
320 335 if [ "$RELEASE_ARCH" = "armel" ]; then
321 336 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} crossbuild-essential-armel"
322 337 fi
323 338 if [ "$RELEASE_ARCH" = "armhf" ]; then
324 339 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} crossbuild-essential-armhf"
325 340 fi
326 341 fi
327 342 if [ "$RELEASE_ARCH" = "arm64" ]; then
328 343 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} crossbuild-essential-arm64"
329 344 fi
330 345 fi
331 346
332 347 if [ "$ENABLE_VIDEOCORE" = true ] ; then
333 348 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} cmake"
334 349 fi
335 350
336 351 # Add libncurses5 to enable kernel menuconfig
337 352 if [ "$KERNEL_MENUCONFIG" = true ] ; then
338 353 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} libncurses-dev"
339 354 fi
340 355
341 356 # Add ccache compiler cache for (faster) kernel cross (re)compilation
342 357 if [ "$KERNEL_CCACHE" = true ] ; then
343 358 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} ccache"
344 359 fi
345 360
346 361 # Add cryptsetup package to enable filesystem encryption
347 362 if [ "$ENABLE_CRYPTFS" = true ] && [ "$BUILD_KERNEL" = true ] ; then
348 363 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} cryptsetup"
349 364 APT_INCLUDES="${APT_INCLUDES},cryptsetup,busybox,console-setup"
350 365
351 366 if [ -z "$CRYPTFS_PASSWORD" ] ; then
352 367 echo "error: no password defined (CRYPTFS_PASSWORD)!"
353 368 exit 1
354 369 fi
355 370 ENABLE_INITRAMFS=true
356 371 fi
357 372
358 373 # Add initramfs generation tools
359 374 if [ "$ENABLE_INITRAMFS" = true ] && [ "$BUILD_KERNEL" = true ] ; then
360 375 APT_INCLUDES="${APT_INCLUDES},initramfs-tools"
361 376 fi
362 377
363 378 # Add device-tree-compiler required for building the U-Boot bootloader
364 379 if [ "$ENABLE_UBOOT" = true ] ; then
365 380 APT_INCLUDES="${APT_INCLUDES},device-tree-compiler,bison,flex,bc"
366 381 fi
367 382
368 383 # Check if root SSH (v2) public key file exists
369 384 if [ -n "$SSH_ROOT_PUB_KEY" ] ; then
370 385 if [ ! -f "$SSH_ROOT_PUB_KEY" ] ; then
371 386 echo "error: '$SSH_ROOT_PUB_KEY' specified SSH public key file not found (SSH_ROOT_PUB_KEY)!"
372 387 exit 1
373 388 fi
374 389 fi
375 390
376 391 # Check if $USER_NAME SSH (v2) public key file exists
377 392 if [ -n "$SSH_USER_PUB_KEY" ] ; then
378 393 if [ ! -f "$SSH_USER_PUB_KEY" ] ; then
379 394 echo "error: '$SSH_USER_PUB_KEY' specified SSH public key file not found (SSH_USER_PUB_KEY)!"
380 395 exit 1
381 396 fi
382 397 fi
383 398
384 399 # Check if all required packages are installed on the build system
385 400 for package in $REQUIRED_PACKAGES ; do
386 401 if [ "$(dpkg-query -W -f='${Status}' $package)" != "install ok installed" ] ; then
387 402 MISSING_PACKAGES="${MISSING_PACKAGES} $package"
388 403 fi
389 404 done
390 405
391 406 # If there are missing packages ask confirmation for install, or exit
392 407 if [ -n "$MISSING_PACKAGES" ] ; then
393 408 echo "the following packages needed by this script are not installed:"
394 409 echo "$MISSING_PACKAGES"
395 410
396 411 printf "\ndo you want to install the missing packages right now? [y/n] "
397 412 read -r confirm
398 413 [ "$confirm" != "y" ] && exit 1
399 414
400 415 # Make sure all missing required packages are installed
401 416 apt-get -qq -y install "${MISSING_PACKAGES}"
402 417 fi
403 418
404 419 # Check if ./bootstrap.d directory exists
405 420 if [ ! -d "./bootstrap.d/" ] ; then
406 421 echo "error: './bootstrap.d' required directory not found!"
407 422 exit 1
408 423 fi
409 424
410 425 # Check if ./files directory exists
411 426 if [ ! -d "./files/" ] ; then
412 427 echo "error: './files' required directory not found!"
413 428 exit 1
414 429 fi
415 430
416 431 # Check if specified KERNELSRC_DIR directory exists
417 432 if [ -n "$KERNELSRC_DIR" ] && [ ! -d "$KERNELSRC_DIR" ] ; then
418 433 echo "error: '${KERNELSRC_DIR}' specified directory not found (KERNELSRC_DIR)!"
419 434 exit 1
420 435 fi
421 436
422 437 # Check if specified UBOOTSRC_DIR directory exists
423 438 if [ -n "$UBOOTSRC_DIR" ] && [ ! -d "$UBOOTSRC_DIR" ] ; then
424 439 echo "error: '${UBOOTSRC_DIR}' specified directory not found (UBOOTSRC_DIR)!"
425 440 exit 1
426 441 fi
427 442
428 443 # Check if specified VIDEOCORESRC_DIR directory exists
429 444 if [ -n "$VIDEOCORESRC_DIR" ] && [ ! -d "$VIDEOCORESRC_DIR" ] ; then
430 445 echo "error: '${VIDEOCORESRC_DIR}' specified directory not found (VIDEOCORESRC_DIR)!"
431 446 exit 1
432 447 fi
433 448
434 449 # Check if specified FBTURBOSRC_DIR directory exists
435 450 if [ -n "$FBTURBOSRC_DIR" ] && [ ! -d "$FBTURBOSRC_DIR" ] ; then
436 451 echo "error: '${FBTURBOSRC_DIR}' specified directory not found (FBTURBOSRC_DIR)!"
437 452 exit 1
438 453 fi
439 454
440 455 # Check if specified CHROOT_SCRIPTS directory exists
441 456 if [ -n "$CHROOT_SCRIPTS" ] && [ ! -d "$CHROOT_SCRIPTS" ] ; then
442 457 echo "error: ${CHROOT_SCRIPTS} specified directory not found (CHROOT_SCRIPTS)!"
443 458 exit 1
444 459 fi
445 460
446 461 # Check if specified device mapping already exists (will be used by cryptsetup)
447 462 if [ -r "/dev/mapping/${CRYPTFS_MAPPING}" ] ; then
448 463 echo "error: mapping /dev/mapping/${CRYPTFS_MAPPING} already exists, not proceeding"
449 464 exit 1
450 465 fi
451 466
452 467 # Don't clobber an old build
453 468 if [ -e "$BUILDDIR" ] ; then
454 469 echo "error: directory ${BUILDDIR} already exists, not proceeding"
455 470 exit 1
456 471 fi
457 472
458 473 # Setup chroot directory
459 474 mkdir -p "${R}"
460 475
461 476 # Check if build directory has enough of free disk space >512MB
462 477 if [ "$(df --output=avail "${BUILDDIR}" | sed "1d")" -le "524288" ] ; then
463 478 echo "error: ${BUILDDIR} not enough space left to generate the output image!"
464 479 exit 1
465 480 fi
466 481
467 482 set -x
468 483
469 484 # Call "cleanup" function on various signals and errors
470 485 trap cleanup 0 1 2 3 6
471 486
472 487 # Add required packages for the minbase installation
473 488 if [ "$ENABLE_MINBASE" = true ] ; then
474 489 APT_INCLUDES="${APT_INCLUDES},vim-tiny,netbase,net-tools,ifupdown"
475 490 fi
476 491
477 492 # Add parted package, required to get partprobe utility
478 493 if [ "$EXPANDROOT" = true ] ; then
479 494 APT_INCLUDES="${APT_INCLUDES},parted"
480 495 fi
481 496
482 497 # Add dbus package, recommended if using systemd
483 498 if [ "$ENABLE_DBUS" = true ] ; then
484 499 APT_INCLUDES="${APT_INCLUDES},dbus"
485 500 fi
486 501
487 502 # Add iptables IPv4/IPv6 package
488 503 if [ "$ENABLE_IPTABLES" = true ] ; then
489 504 APT_INCLUDES="${APT_INCLUDES},iptables,iptables-persistent"
490 505 fi
491 506
492 507 # Add openssh server package
493 508 if [ "$ENABLE_SSHD" = true ] ; then
494 509 APT_INCLUDES="${APT_INCLUDES},openssh-server"
495 510 fi
496 511
497 512 # Add alsa-utils package
498 513 if [ "$ENABLE_SOUND" = true ] ; then
499 514 APT_INCLUDES="${APT_INCLUDES},alsa-utils"
500 515 fi
501 516
502 517 # Add rng-tools package
503 518 if [ "$ENABLE_HWRANDOM" = true ] ; then
504 519 APT_INCLUDES="${APT_INCLUDES},rng-tools"
505 520 fi
506 521
507 522 # Add fbturbo video driver
508 523 if [ "$ENABLE_FBTURBO" = true ] ; then
509 524 # Enable xorg package dependencies
510 525 ENABLE_XORG=true
511 526 fi
512 527
513 528 # Add user defined window manager package
514 529 if [ -n "$ENABLE_WM" ] ; then
515 530 APT_INCLUDES="${APT_INCLUDES},${ENABLE_WM}"
516 531
517 532 # Enable xorg package dependencies
518 533 ENABLE_XORG=true
519 534 fi
520 535
521 536 # Add xorg package
522 537 if [ "$ENABLE_XORG" = true ] ; then
523 538 APT_INCLUDES="${APT_INCLUDES},xorg,dbus-x11"
524 539 fi
525 540
526 541 # Replace selected packages with smaller clones
527 542 if [ "$ENABLE_REDUCE" = true ] ; then
528 543 # Add levee package instead of vim-tiny
529 544 if [ "$REDUCE_VIM" = true ] ; then
530 545 APT_INCLUDES="$(echo ${APT_INCLUDES} | sed "s/vim-tiny/levee/")"
531 546 fi
532 547
533 548 # Add dropbear package instead of openssh-server
534 549 if [ "$REDUCE_SSHD" = true ] ; then
535 550 APT_INCLUDES="$(echo "${APT_INCLUDES}" | sed "s/openssh-server/dropbear/")"
536 551 fi
537 552 fi
538 553
539 if [ "$RELEASE" != "jessie" ] ; then
540 APT_INCLUDES="${APT_INCLUDES},libnss-systemd"
541 fi
542
543 554 # Configure kernel sources if no KERNELSRC_DIR
544 555 if [ "$BUILD_KERNEL" = true ] && [ -z "$KERNELSRC_DIR" ] ; then
545 556 KERNELSRC_CONFIG=true
546 557 fi
547 558
548 559 # Configure reduced kernel
549 560 if [ "$KERNEL_REDUCE" = true ] ; then
550 561 KERNELSRC_CONFIG=false
551 562 fi
552 563
553 564 # Configure qemu compatible kernel
554 565 if [ "$ENABLE_QEMU" = true ] ; then
555 566 DTB_FILE=vexpress-v2p-ca15_a7.dtb
556 567 UBOOT_CONFIG=vexpress_ca15_tc2_defconfig
557 568 KERNEL_DEFCONFIG="vexpress_defconfig"
558 569 if [ "$KERNEL_MENUCONFIG" = false ] ; then
559 570 KERNEL_OLDDEFCONFIG=true
560 571 fi
561 572 fi
562 573
563 574 # Execute bootstrap scripts
564 575 for SCRIPT in bootstrap.d/*.sh; do
565 576 head -n 3 "$SCRIPT"
566 577 . "$SCRIPT"
567 578 done
568 579
569 580 ## Execute custom bootstrap scripts
570 581 if [ -d "custom.d" ] ; then
571 582 for SCRIPT in custom.d/*.sh; do
572 583 . "$SCRIPT"
573 584 done
574 585 fi
575 586
576 587 # Execute custom scripts inside the chroot
577 588 if [ -n "$CHROOT_SCRIPTS" ] && [ -d "$CHROOT_SCRIPTS" ] ; then
578 589 cp -r "${CHROOT_SCRIPTS}" "${R}/chroot_scripts"
579 590 chroot_exec /bin/bash -x <<'EOF'
580 591 for SCRIPT in /chroot_scripts/* ; do
581 592 if [ -f $SCRIPT -a -x $SCRIPT ] ; then
582 593 $SCRIPT
583 594 fi
584 595 done
585 596 EOF
586 597 rm -rf "${R}/chroot_scripts"
587 598 fi
588 599
589 600 # Remove c/c++ build environment from the chroot
590 601 chroot_remove_cc
591 602
592 # Remove apt-utils
593 if [ "$RELEASE" = "jessie" ] ; then
594 chroot_exec apt-get purge -qq -y --force-yes apt-utils
595 fi
596
597 603 # Generate required machine-id
598 604 MACHINE_ID=$(dbus-uuidgen)
599 605 echo -n "${MACHINE_ID}" > "${R}/var/lib/dbus/machine-id"
600 606 echo -n "${MACHINE_ID}" > "${ETC_DIR}/machine-id"
601 607
602 608 # APT Cleanup
603 609 chroot_exec apt-get -y clean
604 610 chroot_exec apt-get -y autoclean
605 611 chroot_exec apt-get -y autoremove
606 612
607 613 # Unmount mounted filesystems
608 614 umount -l "${R}/proc"
609 615 umount -l "${R}/sys"
610 616
611 617 # Clean up directories
612 618 rm -rf "${R}/run/*"
613 619 rm -rf "${R}/tmp/*"
614 620
615 621 # Clean up files
616 622 rm -f "${ETC_DIR}/ssh/ssh_host_*"
617 623 rm -f "${ETC_DIR}/dropbear/dropbear_*"
618 624 rm -f "${ETC_DIR}/apt/sources.list.save"
619 625 rm -f "${ETC_DIR}/resolvconf/resolv.conf.d/original"
620 626 rm -f "${ETC_DIR}/*-"
621 627 rm -f "${ETC_DIR}/apt/apt.conf.d/10proxy"
622 628 rm -f "${ETC_DIR}/resolv.conf"
623 629 rm -f "${R}/root/.bash_history"
624 630 rm -f "${R}/var/lib/urandom/random-seed"
625 631 rm -f "${R}/initrd.img"
626 632 rm -f "${R}/vmlinuz"
627 633 rm -f "${R}${QEMU_BINARY}"
628 634
629 635 if [ "$ENABLE_QEMU" = true ] ; then
630 636 # Setup QEMU directory
631 637 mkdir "${BASEDIR}/qemu"
632 638
633 639 # Copy kernel image to QEMU directory
634 640 install_readonly "${BOOT_DIR}/${KERNEL_IMAGE}" "${BASEDIR}/qemu/${KERNEL_IMAGE}"
635 641
636 642 # Copy kernel config to QEMU directory
637 643 install_readonly "${R}/boot/config-${KERNEL_VERSION}" "${BASEDIR}/qemu/config-${KERNEL_VERSION}"
638 644
639 645 # Copy kernel dtbs to QEMU directory
640 646 for dtb in "${BOOT_DIR}/"*.dtb ; do
641 647 if [ -f "${dtb}" ] ; then
642 648 install_readonly "${dtb}" "${BASEDIR}/qemu/"
643 649 fi
644 650 done
645 651
646 652 # Copy kernel overlays to QEMU directory
647 653 if [ -d "${BOOT_DIR}/overlays" ] ; then
648 654 # Setup overlays dtbs directory
649 655 mkdir "${BASEDIR}/qemu/overlays"
650 656
651 657 for dtb in "${BOOT_DIR}/overlays/"*.dtb ; do
652 658 if [ -f "${dtb}" ] ; then
653 659 install_readonly "${dtb}" "${BASEDIR}/qemu/overlays/"
654 660 fi
655 661 done
656 662 fi
657 663
658 664 # Copy u-boot files to QEMU directory
659 665 if [ "$ENABLE_UBOOT" = true ] ; then
660 666 if [ -f "${BOOT_DIR}/u-boot.bin" ] ; then
661 667 install_readonly "${BOOT_DIR}/u-boot.bin" "${BASEDIR}/qemu/u-boot.bin"
662 668 fi
663 669 if [ -f "${BOOT_DIR}/uboot.mkimage" ] ; then
664 670 install_readonly "${BOOT_DIR}/uboot.mkimage" "${BASEDIR}/qemu/uboot.mkimage"
665 671 fi
666 672 if [ -f "${BOOT_DIR}/boot.scr" ] ; then
667 673 install_readonly "${BOOT_DIR}/boot.scr" "${BASEDIR}/qemu/boot.scr"
668 674 fi
669 675 fi
670 676
671 677 # Copy initramfs to QEMU directory
672 678 if [ -f "${BOOT_DIR}/initramfs-${KERNEL_VERSION}" ] ; then
673 679 install_readonly "${BOOT_DIR}/initramfs-${KERNEL_VERSION}" "${BASEDIR}/qemu/initramfs-${KERNEL_VERSION}"
674 680 fi
675 681 fi
676 682
677 683 # Calculate size of the chroot directory in KB
678 684 CHROOT_SIZE=$(expr "$(du -s "${R}" | awk '{ print $1 }')")
679 685
680 686 # Calculate the amount of needed 512 Byte sectors
681 687 TABLE_SECTORS=$(expr 1 \* 1024 \* 1024 \/ 512)
682 688 FRMW_SECTORS=$(expr 64 \* 1024 \* 1024 \/ 512)
683 689 ROOT_OFFSET=$(expr "${TABLE_SECTORS}" + "${FRMW_SECTORS}")
684 690
685 691 # The root partition is EXT4
686 692 # This means more space than the actual used space of the chroot is used.
687 693 # As overhead for journaling and reserved blocks 35% are added.
688 694 ROOT_SECTORS=$(expr "$(expr "${CHROOT_SIZE}" + "${CHROOT_SIZE}" \/ 100 \* 35)" \* 1024 \/ 512)
689 695
690 696 # Calculate required image size in 512 Byte sectors
691 697 IMAGE_SECTORS=$(expr "${TABLE_SECTORS}" + "${FRMW_SECTORS}" + "${ROOT_SECTORS}")
692 698
693 699 # Prepare image file
694 700 if [ "$ENABLE_SPLITFS" = true ] ; then
695 701 dd if=/dev/zero of="$IMAGE_NAME-frmw.img" bs=512 count="${TABLE_SECTORS}"
696 702 dd if=/dev/zero of="$IMAGE_NAME-frmw.img" bs=512 count=0 seek="${FRMW_SECTORS}"
697 703 dd if=/dev/zero of="$IMAGE_NAME-root.img" bs=512 count="${TABLE_SECTORS}"
698 704 dd if=/dev/zero of="$IMAGE_NAME-root.img" bs=512 count=0 seek="${ROOT_SECTORS}"
699 705
700 706 # Write firmware/boot partition tables
701 707 sfdisk -q -L -uS -f "$IMAGE_NAME-frmw.img" 2> /dev/null <<EOM
702 708 ${TABLE_SECTORS},${FRMW_SECTORS},c,*
703 709 EOM
704 710
705 711 # Write root partition table
706 712 sfdisk -q -L -uS -f "$IMAGE_NAME-root.img" 2> /dev/null <<EOM
707 713 ${TABLE_SECTORS},${ROOT_SECTORS},83
708 714 EOM
709 715
710 716 # Setup temporary loop devices
711 717 FRMW_LOOP="$(losetup -o 1M --sizelimit 64M -f --show "$IMAGE_NAME"-frmw.img)"
712 718 ROOT_LOOP="$(losetup -o 1M -f --show "$IMAGE_NAME"-root.img)"
713 719 else # ENABLE_SPLITFS=false
714 720 dd if=/dev/zero of="$IMAGE_NAME.img" bs=512 count="${TABLE_SECTORS}"
715 721 dd if=/dev/zero of="$IMAGE_NAME.img" bs=512 count=0 seek="${IMAGE_SECTORS}"
716 722
717 723 # Write partition table
718 724 sfdisk -q -L -uS -f "$IMAGE_NAME.img" 2> /dev/null <<EOM
719 725 ${TABLE_SECTORS},${FRMW_SECTORS},c,*
720 726 ${ROOT_OFFSET},${ROOT_SECTORS},83
721 727 EOM
722 728
723 729 # Setup temporary loop devices
724 730 FRMW_LOOP="$(losetup -o 1M --sizelimit 64M -f --show "$IMAGE_NAME".img)"
725 731 ROOT_LOOP="$(losetup -o 65M -f --show "$IMAGE_NAME".img)"
726 732 fi
727 733
728 734 if [ "$ENABLE_CRYPTFS" = true ] ; then
729 735 # Create dummy ext4 fs
730 736 mkfs.ext4 "$ROOT_LOOP"
731 737
732 738 # Setup password keyfile
733 739 touch .password
734 740 chmod 600 .password
735 741 echo -n ${CRYPTFS_PASSWORD} > .password
736 742
737 743 # Initialize encrypted partition
738 744 echo "YES" | cryptsetup luksFormat "${ROOT_LOOP}" -c "${CRYPTFS_CIPHER}" -s "${CRYPTFS_XTSKEYSIZE}" .password
739 745
740 746 # Open encrypted partition and setup mapping
741 747 cryptsetup luksOpen "${ROOT_LOOP}" -d .password "${CRYPTFS_MAPPING}"
742 748
743 749 # Secure delete password keyfile
744 750 shred -zu .password
745 751
746 752 # Update temporary loop device
747 753 ROOT_LOOP="/dev/mapper/${CRYPTFS_MAPPING}"
748 754
749 755 # Wipe encrypted partition (encryption cipher is used for randomness)
750 756 dd if=/dev/zero of="${ROOT_LOOP}" bs=512 count="$(blockdev --getsz "${ROOT_LOOP}")"
751 757 fi
752 758
753 759 # Build filesystems
754 760 mkfs.vfat "$FRMW_LOOP"
755 761 mkfs.ext4 "$ROOT_LOOP"
756 762
757 763 # Mount the temporary loop devices
758 764 mkdir -p "$BUILDDIR/mount"
759 765 mount "$ROOT_LOOP" "$BUILDDIR/mount"
760 766
761 767 mkdir -p "$BUILDDIR/mount/boot/firmware"
762 768 mount "$FRMW_LOOP" "$BUILDDIR/mount/boot/firmware"
763 769
764 770 # Copy all files from the chroot to the loop device mount point directory
765 771 rsync -a "${R}/" "$BUILDDIR/mount/"
766 772
767 773 # Unmount all temporary loop devices and mount points
768 774 cleanup
769 775
770 776 # Create block map file(s) of image(s)
771 777 if [ "$ENABLE_SPLITFS" = true ] ; then
772 778 # Create block map files for "bmaptool"
773 779 bmaptool create -o "$IMAGE_NAME-frmw.bmap" "$IMAGE_NAME-frmw.img"
774 780 bmaptool create -o "$IMAGE_NAME-root.bmap" "$IMAGE_NAME-root.img"
775 781
776 782 # Image was successfully created
777 783 echo "$IMAGE_NAME-frmw.img ($(expr \( "${TABLE_SECTORS}" + "${FRMW_SECTORS}" \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
778 784 echo "$IMAGE_NAME-root.img ($(expr \( "${TABLE_SECTORS}" + "${ROOT_SECTORS}" \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
779 785 else
780 786 # Create block map file for "bmaptool"
781 787 bmaptool create -o "$IMAGE_NAME.bmap" "$IMAGE_NAME.img"
782 788
783 789 # Image was successfully created
784 790 echo "$IMAGE_NAME.img ($(expr \( "${TABLE_SECTORS}" + "${FRMW_SECTORS}" + "${ROOT_SECTORS}" \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
785 791
786 792 # Create qemu qcow2 image
787 793 if [ "$ENABLE_QEMU" = true ] ; then
788 794 QEMU_IMAGE=${QEMU_IMAGE:=${BASEDIR}/qemu/${DATE}-${KERNEL_ARCH}-CURRENT-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}}
789 795 QEMU_SIZE=16G
790 796
791 797 qemu-img convert -f raw -O qcow2 "$IMAGE_NAME".img "$QEMU_IMAGE".qcow2
792 798 qemu-img resize "$QEMU_IMAGE".qcow2 $QEMU_SIZE
793 799
794 800 echo "$QEMU_IMAGE.qcow2 ($QEMU_SIZE)" ": successfully created"
795 801 fi
796 802 fi
General Comments 0
Vous devez vous connecter pour laisser un commentaire. Se connecter maintenant