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

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

Fixed: RPi3 stretch support, uboot updated compiler and src dir
drtyhlpr -
r139:3f5e1cfcfee6
parent child
Show More
Show file before | Show file after | Hide comments
@@ -1,409 +1,412
1 1 # rpi23-gen-image
2 2 ## Introduction
3 3 `rpi23-gen-image.sh` is an advanced Debian Linux bootstrapping shell script for generating Debian OS images for Raspberry Pi 2 (RPi2) and Raspberry Pi 3 (RPi3) computers. The script at this time supports the bootstrapping of the Debian (armhf) releases `jessie` and `stretch`. Raspberry Pi 3 images are currently generated for 32-bit mode only.
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```
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 mandetory. Kernel compilation and linking will be performed on the build system using an ARM (armhf) cross-compiler toolchain.
11 11
12 12 The script has been tested using the default `crossbuild-essential-armhf` toolchain meta package on Debian Linux `jessie` and `stretch` build systems. Please check the [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains) for further information.
13 13
14 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 15
16 16 ```
17 17 echo "deb http://emdebian.org/tools/debian/ jessie main" > /etc/apt/sources.list.d/crosstools.list
18 18 sudo -u nobody wget -O - http://emdebian.org/tools/debian/emdebian-toolchain-archive.key | apt-key add -
19 19 dpkg --add-architecture armhf
20 20 apt-get update
21 21 ```
22 22
23 23 ## Command-line parameters
24 24 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 25
26 26 #####Command-line examples:
27 27 ```shell
28 28 ENABLE_UBOOT=true ./rpi23-gen-image.sh
29 29 ENABLE_CONSOLE=false ENABLE_IPV6=false ./rpi23-gen-image.sh
30 30 ENABLE_WM=xfce4 ENABLE_FBTURBO=true ENABLE_MINBASE=true ./rpi23-gen-image.sh
31 31 ENABLE_HARDNET=true ENABLE_IPTABLES=true /rpi23-gen-image.sh
32 32 APT_SERVER=ftp.de.debian.org APT_PROXY="http://127.0.0.1:3142/" ./rpi23-gen-image.sh
33 33 ENABLE_MINBASE=true ./rpi23-gen-image.sh
34 34 BUILD_KERNEL=true ENABLE_MINBASE=true ENABLE_IPV6=false ./rpi23-gen-image.sh
35 35 BUILD_KERNEL=true KERNELSRC_DIR=/tmp/linux ./rpi23-gen-image.sh
36 36 ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh
37 37 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 38 RELEASE=stretch BUILD_KERNEL=true ./rpi23-gen-image.sh
39 39 RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
40 40 RELEASE=stretch RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
41 41 ```
42 42
43 43 ## Configuration template files
44 44 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 45
46 46 #####Command-line examples:
47 47 ```shell
48 48 CONFIG_TEMPLATE=rpi3stretch ./rpi23-gen-image.sh
49 49 CONFIG_TEMPLATE=rpi2stretch ./rpi23-gen-image.sh
50 50 ```
51 51
52 52 ## Supported parameters and settings
53 53 #### APT settings:
54 54 ##### `APT_SERVER`="ftp.debian.org"
55 55 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 56
57 57 ##### `APT_PROXY`=""
58 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.
59 59
60 60 ##### `APT_INCLUDES`=""
61 61 A comma separated list of additional packages to be installed during bootstrapping.
62 62
63 63 ---
64 64
65 65 #### General system settings:
66 66 ##### `RPI_MODEL`=2
67 67 Specifiy the target Raspberry Pi hardware model. The script at this time supports the Raspberry Pi models `2` and `3`. `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` is used.
68 68
69 69 ##### `RELEASE`="jessie"
70 70 Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases "jessie" and "stretch". `BUILD_KERNEL`=true will automatically be set if the Debian release `stretch` is used.
71 71
72 72 ##### `HOSTNAME`="rpi$RPI_MODEL-$RELEASE"
73 73 Set system host name. It's recommended that the host name is unique in the corresponding subnet.
74 74
75 75 ##### `PASSWORD`="raspberry"
76 76 Set system `root` password. It's **STRONGLY** recommended that you choose a custom password.
77 77
78 78 ##### `USER_PASSWORD`="raspberry"
79 79 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.
80 80
81 81 ##### `DEFLOCAL`="en_US.UTF-8"
82 82 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`.
83 83
84 84 ##### `TIMEZONE`="Europe/Berlin"
85 85 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.
86 86
87 87 ##### `EXPANDROOT`=true
88 88 Expand the root partition and filesystem automatically on first boot.
89 89
90 90 ---
91 91
92 92 #### Keyboard settings:
93 93 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.
94 94
95 95 ##### `XKB_MODEL`=""
96 96 Set the name of the model of your keyboard type.
97 97
98 98 ##### `XKB_LAYOUT`=""
99 99 Set the supported keyboard layout(s).
100 100
101 101 ##### `XKB_VARIANT`=""
102 102 Set the supported variant(s) of the keyboard layout(s).
103 103
104 104 ##### `XKB_OPTIONS`=""
105 105 Set extra xkb configuration options.
106 106
107 107 ---
108 108
109 109 #### Networking settings (DHCP):
110 110 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`.`
111 111
112 112 #####`ENABLE_DHCP`=true
113 113 Set the system to use DHCP. This requires an DHCP server.
114 114
115 115 ---
116 116
117 117 #### Networking settings (static):
118 118 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`.
119 119
120 120 #####`NET_ADDRESS`=""
121 121 Set a static IPv4 or IPv6 address and its prefix, separated by "/", eg. "192.169.0.3/24".
122 122
123 123 #####`NET_GATEWAY`=""
124 124 Set the IP address for the default gateway.
125 125
126 126 #####`NET_DNS_1`=""
127 127 Set the IP address for the first DNS server.
128 128
129 129 #####`NET_DNS_2`=""
130 130 Set the IP address for the second DNS server.
131 131
132 132 #####`NET_DNS_DOMAINS`=""
133 133 Set the default DNS search domains to use for non fully qualified host names.
134 134
135 135 #####`NET_NTP_1`=""
136 136 Set the IP address for the first NTP server.
137 137
138 138 #####`NET_NTP_2`=""
139 139 Set the IP address for the second NTP server.
140 140
141 141 ---
142 142
143 143 #### Basic system features:
144 144 ##### `ENABLE_CONSOLE`=true
145 145 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.
146 146
147 147 ##### `ENABLE_I2C`=false
148 148 Enable I2C interface on the RPi2/3. Please check the [RPi2/3 pinout diagrams](http://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.
149 149
150 150 ##### `ENABLE_SPI`=false
151 151 Enable SPI interface on the RPi2/3. Please check the [RPi2/3 pinout diagrams](http://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.
152 152
153 153 ##### `ENABLE_IPV6`=true
154 154 Enable IPv6 support. The network interface configuration is managed via systemd-networkd.
155 155
156 156 ##### `ENABLE_SSHD`=true
157 157 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.
158 158
159 159 ##### `ENABLE_NONFREE`=false
160 160 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.
161 161
162 162 ##### `ENABLE_WIRELESS`=false
163 163 Download and install the [closed-source firmware binary blob](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/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`.
164 164
165 165 ##### `ENABLE_RSYSLOG`=true
166 166 If set to false, disable and uninstall rsyslog (so logs will be available only
167 167 in journal files)
168 168
169 169 ##### `ENABLE_SOUND`=true
170 170 Enable sound hardware and install Advanced Linux Sound Architecture.
171 171
172 172 ##### `ENABLE_HWRANDOM`=true
173 173 Enable Hardware Random Number Generator. Strong random numbers are important for most network based communications that use encryption. It's recommended to be enabled.
174 174
175 175 ##### `ENABLE_MINGPU`=false
176 176 Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU.
177 177
178 178 ##### `ENABLE_DBUS`=true
179 179 Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled.
180 180
181 181 ##### `ENABLE_XORG`=false
182 182 Install Xorg open-source X Window System.
183 183
184 184 ##### `ENABLE_WM`=""
185 185 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`.
186 186
187 187 ---
188 188
189 189 #### Advanced system features:
190 190 ##### `ENABLE_MINBASE`=false
191 191 Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
192 192
193 193 ##### `ENABLE_REDUCE`=false
194 194 Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.
195 195
196 196 ##### `ENABLE_UBOOT`=false
197 197 Replace the default RPi2/3 second stage bootloader (bootcode.bin) with [U-Boot bootloader](http://git.denx.de/?p=u-boot.git;a=summary). U-Boot can boot images via the network using the BOOTP/TFTP protocol.
198 198
199 ##### `UBOOTSRC_DIR`=""
200 Path to a directory of [U-Boot bootloader sources](http://git.denx.de/?p=u-boot.git;a=summary) that will be copied, configured, build and installed inside the chroot.
201
199 202 ##### `ENABLE_FBTURBO`=false
200 203 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.
201 204
202 205 ##### `ENABLE_IPTABLES`=false
203 206 Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.
204 207
205 208 ##### `ENABLE_USER`=true
206 209 Create non-root user with password `USER_PASSWORD`=raspberry. Unless overridden with `USER_NAME`=user, username will be `pi`.
207 210
208 211 ##### `USER_NAME`=pi
209 212 Non-root user to create. Ignored if `ENABLE_USER`=false
210 213
211 214 ##### `ENABLE_ROOT`=false
212 215 Set root user password so root login will be enabled
213 216
214 217 ##### `ENABLE_HARDNET`=false
215 218 Enable IPv4/IPv6 network stack hardening settings.
216 219
217 220 ##### `ENABLE_SPLITFS`=false
218 221 Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.
219 222
220 223 ##### `CHROOT_SCRIPTS`=""
221 224 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.
222 225
223 226 ##### `ENABLE_INITRAMFS`=false
224 227 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.
225 228
226 229 ##### `ENABLE_IFNAMES`=true
227 230 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 release `stretch` is used.
228 231
229 232 ##### `DISABLE_UNDERVOLT_WARNINGS`=
230 233 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.
231 234
232 235 ---
233 236
234 237 #### SSH settings:
235 238 ##### `SSH_ENABLE_ROOT`=false
236 239 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`.
237 240
238 241 ##### `SSH_DISABLE_PASSWORD_AUTH`=false
239 242 Disable password based SSH authentication. Only public key based SSH (v2) authentication will be supported.
240 243
241 244 ##### `SSH_LIMIT_USERS`=false
242 245 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.
243 246
244 247 ##### `SSH_ROOT_PUB_KEY`=""
245 248 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`.
246 249
247 250 ##### `SSH_USER_PUB_KEY`=""
248 251 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.
249 252
250 253 ---
251 254
252 255 #### Kernel compilation:
253 256 ##### `BUILD_KERNEL`=false
254 257 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.
255 258
256 259 ##### `KERNEL_REDUCE`=false
257 260 Reduce the size of the generated kernel by removing unwanted device, network and filesystem drivers (experimental).
258 261
259 262 ##### `KERNEL_THREADS`=1
260 263 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.
261 264
262 265 ##### `KERNEL_HEADERS`=true
263 266 Install kernel headers with built kernel.
264 267
265 268 ##### `KERNEL_MENUCONFIG`=false
266 269 Start `make menuconfig` interactive menu-driven kernel configuration. The script will continue after `make menuconfig` was terminated.
267 270
268 271 ##### `KERNEL_REMOVESRC`=true
269 272 Remove all kernel sources from the generated OS image after it was built and installed.
270 273
271 274 ##### `KERNELSRC_DIR`=""
272 275 Path to a directory of [RaspberryPi Linux kernel sources](https://github.com/raspberrypi/linux) that will be copied, configured, build and installed inside the chroot.
273 276
274 277 ##### `KERNELSRC_CLEAN`=false
275 278 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.
276 279
277 280 ##### `KERNELSRC_CONFIG`=true
278 281 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.
279 282
280 283 ##### `KERNELSRC_USRCONFIG`=""
281 284 Copy own config file to kernel `.config`. If `KERNEL_MENUCONFIG`=true then running after copy.
282 285
283 286 ##### `KERNELSRC_PREBUILT`=false
284 287 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.
285 288
286 289 ##### `RPI_FIRMWARE_DIR`=""
287 290 The directory 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.
288 291
289 292 ---
290 293
291 294 #### Reduce disk usage:
292 295 The following list of parameters is ignored if `ENABLE_REDUCE`=false.
293 296
294 297 ##### `REDUCE_APT`=true
295 298 Configure APT to use compressed package repository lists and no package caching files.
296 299
297 300 ##### `REDUCE_DOC`=true
298 301 Remove all doc files (harsh). Configure APT to not include doc files on future `apt-get` package installations.
299 302
300 303 ##### `REDUCE_MAN`=true
301 304 Remove all man pages and info files (harsh). Configure APT to not include man pages on future `apt-get` package installations.
302 305
303 306 ##### `REDUCE_VIM`=false
304 307 Replace `vim-tiny` package by `levee` a tiny vim clone.
305 308
306 309 ##### `REDUCE_BASH`=false
307 310 Remove `bash` package and switch to `dash` shell (experimental).
308 311
309 312 ##### `REDUCE_HWDB`=true
310 313 Remove PCI related hwdb files (experimental).
311 314
312 315 ##### `REDUCE_SSHD`=true
313 316 Replace `openssh-server` with `dropbear`.
314 317
315 318 ##### `REDUCE_LOCALE`=true
316 319 Remove all `locale` translation files.
317 320
318 321 ---
319 322
320 323 #### Encrypted root partition:
321 324 ##### `ENABLE_CRYPTFS`=false
322 325 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.
323 326
324 327 ##### `CRYPTFS_PASSWORD`=""
325 328 Set password of the encrypted root partition. This parameter is mandatory if `ENABLE_CRYPTFS`=true.
326 329
327 330 ##### `CRYPTFS_MAPPING`="secure"
328 331 Set name of dm-crypt managed device-mapper mapping.
329 332
330 333 ##### `CRYPTFS_CIPHER`="aes-xts-plain64:sha512"
331 334 Set cipher specification string. `aes-xts*` ciphers are strongly recommended.
332 335
333 336 ##### `CRYPTFS_XTSKEYSIZE`=512
334 337 Sets key size in bits. The argument has to be a multiple of 8.
335 338
336 339 ## Understanding the script
337 340 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:
338 341
339 342 | Script | Description |
340 343 | --- | --- |
341 344 | `10-bootstrap.sh` | Debootstrap basic system |
342 345 | `11-apt.sh` | Setup APT repositories |
343 346 | `12-locale.sh` | Setup Locales and keyboard settings |
344 347 | `13-kernel.sh` | Build and install RPi2/3 Kernel |
345 348 | `14-rpi-config.sh` | Setup RPi2/3 config and cmdline |
346 349 | `20-networking.sh` | Setup Networking |
347 350 | `21-firewall.sh` | Setup Firewall |
348 351 | `30-security.sh` | Setup Users and Security settings |
349 352 | `31-logging.sh` | Setup Logging |
350 353 | `32-sshd.sh` | Setup SSH and public keys |
351 354 | `41-uboot.sh` | Build and Setup U-Boot |
352 355 | `42-fbturbo.sh` | Build and Setup fbturbo Xorg driver |
353 356 | `50-firstboot.sh` | First boot actions |
354 357 | `99-reduce.sh` | Reduce the disk space usage |
355 358
356 359 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.
357 360
358 361 | Directory | Description |
359 362 | --- | --- |
360 363 | `apt` | APT management configuration files |
361 364 | `boot` | Boot and RPi2/3 configuration files |
362 365 | `dpkg` | Package Manager configuration |
363 366 | `etc` | Configuration files and rc scripts |
364 367 | `firstboot` | Scripts that get executed on first boot |
365 368 | `initramfs` | Initramfs scripts |
366 369 | `iptables` | Firewall configuration files |
367 370 | `locales` | Locales configuration |
368 371 | `modules` | Kernel Modules configuration |
369 372 | `mount` | Fstab configuration |
370 373 | `network` | Networking configuration files |
371 374 | `sysctl.d` | Swapping and Network Hardening configuration |
372 375 | `xorg` | fbturbo Xorg driver configuration |
373 376
374 377 ## Custom packages and scripts
375 378 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`.
376 379
377 380 Scripts in the custom.d directory will be executed after all other installation is complete but before the image is created.
378 381
379 382 ## Logging of the bootstrapping process
380 383 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:
381 384
382 385 ```shell
383 386 script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log
384 387 ```
385 388
386 389 ## Flashing the image file
387 390 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`.
388 391
389 392 #####Flashing examples:
390 393 ```shell
391 394 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie.img /dev/mmcblk0
392 395 dd bs=4M if=./images/jessie/2017-01-23-rpi3-jessie.img of=/dev/mmcblk0
393 396 ```
394 397 If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:
395 398 ```shell
396 399 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie-frmw.img /dev/mmcblk0
397 400 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie-root.img /dev/sdc
398 401 ```
399 402
400 403 ## External links and references
401 404 * [Debian worldwide mirror sites](https://www.debian.org/mirror/list)
402 405 * [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)
403 406 * [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains)
404 407 * [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)
405 408 * [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)
406 409 * [U-BOOT git repository](http://git.denx.de/?p=u-boot.git;a=summary)
407 410 * [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)
408 411 * [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/brcm)
409 412 * [Collabora RPi2 Kernel precompiled](https://repositories.collabora.co.uk/debian/)
Show file before | Show file after | Hide comments
@@ -1,68 +1,74
1 1 #
2 2 # Build and Setup U-Boot
3 3 #
4 4
5 5 # Load utility functions
6 6 . ./functions.sh
7 7
8 8 # Install gcc/c++ build environment inside the chroot
9 9 if [ "$ENABLE_UBOOT" = true ] || [ "$ENABLE_FBTURBO" = true ] ; then
10 10 COMPILER_PACKAGES=$(chroot_exec apt-get -s install ${COMPILER_PACKAGES} | grep "^Inst " | awk -v ORS=" " '{ print $2 }')
11 11 chroot_exec apt-get -q -y --force-yes --no-install-recommends install ${COMPILER_PACKAGES}
12 12 fi
13 13
14 14 # Fetch and build U-Boot bootloader
15 15 if [ "$ENABLE_UBOOT" = true ] ; then
16 # Fetch U-Boot bootloader sources
17 git -C "${R}/tmp" clone "${UBOOT_URL}"
16 # Copy existing U-Boot sources into chroot directory
17 if [ -n "$UBOOTSRC_DIR" ] && [ -d "$UBOOTSRC_DIR" ] ; then
18 # Copy local U-Boot sources
19 cp -r "${UBOOTSRC_DIR}" "${R}/tmp"
20 else
21 # Fetch U-Boot sources
22 git -C "${R}/tmp" clone "${UBOOT_URL}"
23 fi
18 24
19 25 # Build and install U-Boot inside chroot
20 26 chroot_exec make -j${KERNEL_THREADS} -C /tmp/u-boot/ ${UBOOT_CONFIG} all
21 27
22 28 # Copy compiled bootloader binary and set config.txt to load it
23 29 install_exec "${R}/tmp/u-boot/tools/mkimage" "${R}/usr/sbin/mkimage"
24 30 install_readonly "${R}/tmp/u-boot/u-boot.bin" "${BOOT_DIR}/u-boot.bin"
25 31 printf "\n# boot u-boot kernel\nkernel=u-boot.bin\n" >> "${BOOT_DIR}/config.txt"
26 32
27 33 # Install and setup U-Boot command file
28 34 install_readonly files/boot/uboot.mkimage "${BOOT_DIR}/uboot.mkimage"
29 35 printf "# Set the kernel boot command line\nsetenv bootargs \"earlyprintk ${CMDLINE}\"\n\n$(cat ${BOOT_DIR}/uboot.mkimage)" > "${BOOT_DIR}/uboot.mkimage"
30 36
31 37 if [ "$ENABLE_INITRAMFS" = true ] ; then
32 38 # Convert generated initramfs for U-Boot using mkimage
33 39 chroot_exec /usr/sbin/mkimage -A "${KERNEL_ARCH}" -T ramdisk -C none -n "initramfs-${KERNEL_VERSION}" -d "/boot/firmware/initramfs-${KERNEL_VERSION}" "/boot/firmware/initramfs-${KERNEL_VERSION}.uboot"
34 40
35 41 # Remove original initramfs file
36 42 rm -f "${BOOT_DIR}/initramfs-${KERNEL_VERSION}"
37 43
38 44 # Configure U-Boot to load generated initramfs
39 45 printf "# Set initramfs file\nsetenv initramfs initramfs-${KERNEL_VERSION}.uboot\n\n$(cat ${BOOT_DIR}/uboot.mkimage)" > "${BOOT_DIR}/uboot.mkimage"
40 46 printf "\nbootz \${kernel_addr_r} \${ramdisk_addr_r} \${fdt_addr_r}" >> "${BOOT_DIR}/uboot.mkimage"
41 47 else # ENABLE_INITRAMFS=false
42 48 # Remove initramfs from U-Boot mkfile
43 49 sed -i '/.*initramfs.*/d' "${BOOT_DIR}/uboot.mkimage"
44 50
45 51 if [ "$BUILD_KERNEL" = false ] ; then
46 52 # Remove dtbfile from U-Boot mkfile
47 53 sed -i '/.*dtbfile.*/d' "${BOOT_DIR}/uboot.mkimage"
48 54 printf "\nbootz \${kernel_addr_r}" >> "${BOOT_DIR}/uboot.mkimage"
49 55 else
50 56 printf "\nbootz \${kernel_addr_r} - \${fdt_addr_r}" >> "${BOOT_DIR}/uboot.mkimage"
51 57 fi
52 58 fi
53 59
54 60 # Set mkfile to use the correct dtb file
55 61 sed -i "s/^\(setenv dtbfile \).*/\1${DTB_FILE}/" "${BOOT_DIR}/uboot.mkimage"
56 62
57 63 # Set mkfile to use kernel image
58 64 sed -i "s/^\(fatload mmc 0:1 \${kernel_addr_r} \).*/\1${KERNEL_IMAGE}/" "${BOOT_DIR}/uboot.mkimage"
59 65
60 66 # Remove all leading blank lines
61 67 sed -i "/./,\$!d" "${BOOT_DIR}/uboot.mkimage"
62 68
63 69 # Generate U-Boot bootloader image
64 70 chroot_exec /usr/sbin/mkimage -A "${KERNEL_ARCH}" -O linux -T script -C none -a 0x00000000 -e 0x00000000 -n "RPi${RPI_MODEL}" -d /boot/firmware/uboot.mkimage /boot/firmware/boot.scr
65 71
66 72 # Remove U-Boot sources
67 73 rm -fr "${R}/tmp/u-boot"
68 74 fi
Show file before | Show file after | Hide comments
@@ -1,614 +1,621
1 1 #!/bin/sh
2 2
3 3 ########################################################################
4 4 # rpi23-gen-image.sh 2015-2017
5 5 #
6 6 # Advanced Debian "jessie" and "stretch" bootstrap script for RPi2/3
7 7 #
8 8 # This program is free software; you can redistribute it and/or
9 9 # modify it under the terms of the GNU General Public License
10 10 # as published by the Free Software Foundation; either version 2
11 11 # of the License, or (at your option) any later version.
12 12 #
13 13 # Copyright (C) 2015 Jan Wagner <mail@jwagner.eu>
14 14 #
15 15 # Big thanks for patches and enhancements by 10+ github contributors!
16 16 ########################################################################
17 17
18 18 # Are we running as root?
19 19 if [ "$(id -u)" -ne "0" ] ; then
20 20 echo "error: this script must be executed with root privileges!"
21 21 exit 1
22 22 fi
23 23
24 24 # Check if ./functions.sh script exists
25 25 if [ ! -r "./functions.sh" ] ; then
26 26 echo "error: './functions.sh' required script not found!"
27 27 exit 1
28 28 fi
29 29
30 30 # Load utility functions
31 31 . ./functions.sh
32 32
33 33 # Load parameters from configuration template file
34 34 if [ ! -z "$CONFIG_TEMPLATE" ] ; then
35 35 use_template
36 36 fi
37 37
38 38 # Introduce settings
39 39 set -e
40 40 echo -n -e "\n#\n# RPi2/3 Bootstrap Settings\n#\n"
41 41 set -x
42 42
43 43 # Raspberry Pi model configuration
44 44 RPI_MODEL=${RPI_MODEL:=2}
45 45 RPI2_DTB_FILE=${RPI2_DTB_FILE:=bcm2709-rpi-2-b.dtb}
46 46 RPI2_UBOOT_CONFIG=${RPI2_UBOOT_CONFIG:=rpi_2_defconfig}
47 47 RPI3_DTB_FILE=${RPI3_DTB_FILE:=bcm2710-rpi-3-b.dtb}
48 48 RPI3_UBOOT_CONFIG=${RPI3_UBOOT_CONFIG:=rpi_3_32b_defconfig}
49 49
50 50 # Debian release
51 51 RELEASE=${RELEASE:=jessie}
52 52 KERNEL_ARCH=${KERNEL_ARCH:=arm}
53 53 RELEASE_ARCH=${RELEASE_ARCH:=armhf}
54 54 CROSS_COMPILE=${CROSS_COMPILE:=arm-linux-gnueabihf-}
55 55 COLLABORA_KERNEL=${COLLABORA_KERNEL:=3.18.0-trunk-rpi2}
56 56 KERNEL_DEFCONFIG=${KERNEL_DEFCONFIG:=bcm2709_defconfig}
57 57 KERNEL_IMAGE=${KERNEL_IMAGE:=kernel7.img}
58 58 QEMU_BINARY=${QEMU_BINARY:=/usr/bin/qemu-arm-static}
59 59
60 60 # URLs
61 61 KERNEL_URL=${KERNEL_URL:=https://github.com/raspberrypi/linux}
62 62 FIRMWARE_URL=${FIRMWARE_URL:=https://github.com/raspberrypi/firmware/raw/master/boot}
63 63 WLAN_FIRMWARE_URL=${WLAN_FIRMWARE_URL:=https://github.com/RPi-Distro/firmware-nonfree/raw/master/brcm80211/brcm}
64 64 COLLABORA_URL=${COLLABORA_URL:=https://repositories.collabora.co.uk/debian}
65 65 FBTURBO_URL=${FBTURBO_URL:=https://github.com/ssvb/xf86-video-fbturbo.git}
66 66 UBOOT_URL=${UBOOT_URL:=git://git.denx.de/u-boot.git}
67 67
68 68 # Build directories
69 69 BASEDIR="$(pwd)/images/${RELEASE}"
70 70 BUILDDIR="${BASEDIR}/build"
71 71
72 72 # Chroot directories
73 73 R="${BUILDDIR}/chroot"
74 74 ETC_DIR="${R}/etc"
75 75 LIB_DIR="${R}/lib"
76 76 BOOT_DIR="${R}/boot/firmware"
77 77 KERNEL_DIR="${R}/usr/src/linux"
78 78 WLAN_FIRMWARE_DIR="${R}/lib/firmware/brcm"
79 79
80 80 # Firmware directory: Blank if download from github
81 81 RPI_FIRMWARE_DIR=${RPI_FIRMWARE_DIR:=""}
82 82
83 83 # General settings
84 84 HOSTNAME=${HOSTNAME:=rpi${RPI_MODEL}-${RELEASE}}
85 85 PASSWORD=${PASSWORD:=raspberry}
86 86 USER_PASSWORD=${USER_PASSWORD:=raspberry}
87 87 DEFLOCAL=${DEFLOCAL:="en_US.UTF-8"}
88 88 TIMEZONE=${TIMEZONE:="Europe/Berlin"}
89 89 EXPANDROOT=${EXPANDROOT:=true}
90 90
91 91 # Keyboard settings
92 92 XKB_MODEL=${XKB_MODEL:=""}
93 93 XKB_LAYOUT=${XKB_LAYOUT:=""}
94 94 XKB_VARIANT=${XKB_VARIANT:=""}
95 95 XKB_OPTIONS=${XKB_OPTIONS:=""}
96 96
97 97 # Network settings (DHCP)
98 98 ENABLE_DHCP=${ENABLE_DHCP:=true}
99 99
100 100 # Network settings (static)
101 101 NET_ADDRESS=${NET_ADDRESS:=""}
102 102 NET_GATEWAY=${NET_GATEWAY:=""}
103 103 NET_DNS_1=${NET_DNS_1:=""}
104 104 NET_DNS_2=${NET_DNS_2:=""}
105 105 NET_DNS_DOMAINS=${NET_DNS_DOMAINS:=""}
106 106 NET_NTP_1=${NET_NTP_1:=""}
107 107 NET_NTP_2=${NET_NTP_2:=""}
108 108
109 109 # APT settings
110 110 APT_PROXY=${APT_PROXY:=""}
111 111 APT_SERVER=${APT_SERVER:="ftp.debian.org"}
112 112
113 113 # Feature settings
114 114 ENABLE_CONSOLE=${ENABLE_CONSOLE:=true}
115 115 ENABLE_I2C=${ENABLE_I2C:=false}
116 116 ENABLE_SPI=${ENABLE_SPI:=false}
117 117 ENABLE_IPV6=${ENABLE_IPV6:=true}
118 118 ENABLE_SSHD=${ENABLE_SSHD:=true}
119 119 ENABLE_NONFREE=${ENABLE_NONFREE:=false}
120 120 ENABLE_WIRELESS=${ENABLE_WIRELESS:=false}
121 121 ENABLE_SOUND=${ENABLE_SOUND:=true}
122 122 ENABLE_DBUS=${ENABLE_DBUS:=true}
123 123 ENABLE_HWRANDOM=${ENABLE_HWRANDOM:=true}
124 124 ENABLE_MINGPU=${ENABLE_MINGPU:=false}
125 125 ENABLE_XORG=${ENABLE_XORG:=false}
126 126 ENABLE_WM=${ENABLE_WM:=""}
127 127 ENABLE_RSYSLOG=${ENABLE_RSYSLOG:=true}
128 128 ENABLE_USER=${ENABLE_USER:=true}
129 129 USER_NAME=${USER_NAME:="pi"}
130 130 ENABLE_ROOT=${ENABLE_ROOT:=false}
131 131
132 132 # SSH settings
133 133 SSH_ENABLE_ROOT=${SSH_ENABLE_ROOT:=false}
134 134 SSH_DISABLE_PASSWORD_AUTH=${SSH_DISABLE_PASSWORD_AUTH:=false}
135 135 SSH_LIMIT_USERS=${SSH_LIMIT_USERS:=false}
136 136 SSH_ROOT_PUB_KEY=${SSH_ROOT_PUB_KEY:=""}
137 137 SSH_USER_PUB_KEY=${SSH_USER_PUB_KEY:=""}
138 138
139 139 # Advanced settings
140 140 ENABLE_MINBASE=${ENABLE_MINBASE:=false}
141 141 ENABLE_REDUCE=${ENABLE_REDUCE:=false}
142 142 ENABLE_UBOOT=${ENABLE_UBOOT:=false}
143 UBOOTSRC_DIR=${UBOOTSRC_DIR:=""}
143 144 ENABLE_FBTURBO=${ENABLE_FBTURBO:=false}
144 145 ENABLE_HARDNET=${ENABLE_HARDNET:=false}
145 146 ENABLE_IPTABLES=${ENABLE_IPTABLES:=false}
146 147 ENABLE_SPLITFS=${ENABLE_SPLITFS:=false}
147 148 ENABLE_INITRAMFS=${ENABLE_INITRAMFS:=false}
148 149 ENABLE_IFNAMES=${ENABLE_IFNAMES:=true}
149 150 DISABLE_UNDERVOLT_WARNINGS=${DISABLE_UNDERVOLT_WARNINGS:=}
150 151
151 152 # Kernel compilation settings
152 153 BUILD_KERNEL=${BUILD_KERNEL:=false}
153 154 KERNEL_REDUCE=${KERNEL_REDUCE:=false}
154 155 KERNEL_THREADS=${KERNEL_THREADS:=1}
155 156 KERNEL_HEADERS=${KERNEL_HEADERS:=true}
156 157 KERNEL_MENUCONFIG=${KERNEL_MENUCONFIG:=false}
157 158 KERNEL_REMOVESRC=${KERNEL_REMOVESRC:=true}
158 159
159 160 # Kernel compilation from source directory settings
160 161 KERNELSRC_DIR=${KERNELSRC_DIR:=""}
161 162 KERNELSRC_CLEAN=${KERNELSRC_CLEAN:=false}
162 163 KERNELSRC_CONFIG=${KERNELSRC_CONFIG:=true}
163 164 KERNELSRC_PREBUILT=${KERNELSRC_PREBUILT:=false}
164 165
165 166 # Reduce disk usage settings
166 167 REDUCE_APT=${REDUCE_APT:=true}
167 168 REDUCE_DOC=${REDUCE_DOC:=true}
168 169 REDUCE_MAN=${REDUCE_MAN:=true}
169 170 REDUCE_VIM=${REDUCE_VIM:=false}
170 171 REDUCE_BASH=${REDUCE_BASH:=false}
171 172 REDUCE_HWDB=${REDUCE_HWDB:=true}
172 173 REDUCE_SSHD=${REDUCE_SSHD:=true}
173 174 REDUCE_LOCALE=${REDUCE_LOCALE:=true}
174 175
175 176 # Encrypted filesystem settings
176 177 ENABLE_CRYPTFS=${ENABLE_CRYPTFS:=false}
177 178 CRYPTFS_PASSWORD=${CRYPTFS_PASSWORD:=""}
178 179 CRYPTFS_MAPPING=${CRYPTFS_MAPPING:="secure"}
179 180 CRYPTFS_CIPHER=${CRYPTFS_CIPHER:="aes-xts-plain64:sha512"}
180 181 CRYPTFS_XTSKEYSIZE=${CRYPTFS_XTSKEYSIZE:=512}
181 182
182 183 # Stop the Crypto Wars
183 184 DISABLE_FBI=${DISABLE_FBI:=false}
184 185
185 186 # Chroot scripts directory
186 187 CHROOT_SCRIPTS=${CHROOT_SCRIPTS:=""}
187 188
188 189 # Packages required in the chroot build environment
189 190 APT_INCLUDES=${APT_INCLUDES:=""}
190 191 APT_INCLUDES="${APT_INCLUDES},apt-transport-https,apt-utils,ca-certificates,debian-archive-keyring,dialog,sudo,systemd,sysvinit-utils"
191 192
192 193 # Packages required for bootstrapping
193 194 REQUIRED_PACKAGES="debootstrap debian-archive-keyring qemu-user-static binfmt-support dosfstools rsync bmap-tools whois git bc psmisc dbus"
194 195 MISSING_PACKAGES=""
195 196
196 197 set +x
197 198
198 199 # Set Raspberry Pi model specific configuration
199 200 if [ "$RPI_MODEL" = 2 ] ; then
200 201 DTB_FILE=${RPI2_DTB_FILE}
201 202 UBOOT_CONFIG=${RPI2_UBOOT_CONFIG}
202 203 elif [ "$RPI_MODEL" = 3 ] ; then
203 204 DTB_FILE=${RPI3_DTB_FILE}
204 205 UBOOT_CONFIG=${RPI3_UBOOT_CONFIG}
205 206 BUILD_KERNEL=true
206 207 else
207 208 echo "error: Raspberry Pi model ${RPI_MODEL} is not supported!"
208 209 exit 1
209 210 fi
210 211
211 212 # Check if the internal wireless interface is supported by the RPi model
212 213 if [ "$ENABLE_WIRELESS" = true ] && [ "$RPI_MODEL" != 3 ] ; then
213 214 echo "error: The selected Raspberry Pi model has no internal wireless interface"
214 215 exit 1
215 216 fi
216 217
217 218 # Check if DISABLE_UNDERVOLT_WARNINGS parameter value is supported
218 219 if [ ! -z "$DISABLE_UNDERVOLT_WARNINGS" ] ; then
219 220 if [ "$DISABLE_UNDERVOLT_WARNINGS" != 1 ] && [ "$DISABLE_UNDERVOLT_WARNINGS" != 2 ] ; then
220 221 echo "error: DISABLE_UNDERVOLT_WARNINGS=${DISABLE_UNDERVOLT_WARNINGS} is not supported"
221 222 exit 1
222 223 fi
223 224 fi
224 225
225 226 # Set compiler packages and build RPi2/3 Linux kernel if required by Debian release
226 227 if [ "$RELEASE" = "jessie" ] ; then
227 228 COMPILER_PACKAGES="linux-compiler-gcc-4.8-arm g++ make bc"
228 229 elif [ "$RELEASE" = "stretch" ] ; then
229 COMPILER_PACKAGES="linux-compiler-gcc-5-arm g++ make bc"
230 COMPILER_PACKAGES="g++ make bc"
230 231 BUILD_KERNEL=true
231 232 else
232 233 echo "error: Debian release ${RELEASE} is not supported!"
233 234 exit 1
234 235 fi
235 236
236 237 # Add packages required for kernel cross compilation
237 238 if [ "$BUILD_KERNEL" = true ] ; then
238 239 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} crossbuild-essential-armhf"
239 240 fi
240 241
241 242 # Add libncurses5 to enable kernel menuconfig
242 243 if [ "$KERNEL_MENUCONFIG" = true ] ; then
243 244 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} libncurses5-dev"
244 245 fi
245 246
246 247 # Stop the Crypto Wars
247 248 if [ "$DISABLE_FBI" = true ] ; then
248 249 ENABLE_CRYPTFS=true
249 250 fi
250 251
251 252 # Add cryptsetup package to enable filesystem encryption
252 253 if [ "$ENABLE_CRYPTFS" = true ] && [ "$BUILD_KERNEL" = true ] ; then
253 254 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} cryptsetup"
254 255 APT_INCLUDES="${APT_INCLUDES},cryptsetup"
255 256
256 257 if [ -z "$CRYPTFS_PASSWORD" ] ; then
257 258 echo "error: no password defined (CRYPTFS_PASSWORD)!"
258 259 exit 1
259 260 fi
260 261 ENABLE_INITRAMFS=true
261 262 fi
262 263
263 264 # Add initramfs generation tools
264 265 if [ "$ENABLE_INITRAMFS" = true ] && [ "$BUILD_KERNEL" = true ] ; then
265 266 APT_INCLUDES="${APT_INCLUDES},initramfs-tools"
266 267 fi
267 268
268 269 # Add device-tree-compiler required for building the U-Boot bootloader
269 270 if [ "$ENABLE_UBOOT" = true ] ; then
270 271 APT_INCLUDES="${APT_INCLUDES},device-tree-compiler"
271 272 fi
272 273
273 274 # Check if root SSH (v2) public key file exists
274 275 if [ ! -z "$SSH_ROOT_PUB_KEY" ] ; then
275 276 if [ ! -f "$SSH_ROOT_PUB_KEY" ] ; then
276 277 echo "error: '$SSH_ROOT_PUB_KEY' specified SSH public key file not found (SSH_ROOT_PUB_KEY)!"
277 278 exit 1
278 279 fi
279 280 fi
280 281
281 282 # Check if $USER_NAME SSH (v2) public key file exists
282 283 if [ ! -z "$SSH_USER_PUB_KEY" ] ; then
283 284 if [ ! -f "$SSH_USER_PUB_KEY" ] ; then
284 285 echo "error: '$SSH_USER_PUB_KEY' specified SSH public key file not found (SSH_USER_PUB_KEY)!"
285 286 exit 1
286 287 fi
287 288 fi
288 289
289 290 # Check if all required packages are installed on the build system
290 291 for package in $REQUIRED_PACKAGES ; do
291 292 if [ "`dpkg-query -W -f='${Status}' $package`" != "install ok installed" ] ; then
292 293 MISSING_PACKAGES="${MISSING_PACKAGES} $package"
293 294 fi
294 295 done
295 296
296 297 # If there are missing packages ask confirmation for install, or exit
297 298 if [ -n "$MISSING_PACKAGES" ] ; then
298 299 echo "the following packages needed by this script are not installed:"
299 300 echo "$MISSING_PACKAGES"
300 301
301 302 echo -n "\ndo you want to install the missing packages right now? [y/n] "
302 303 read confirm
303 304 [ "$confirm" != "y" ] && exit 1
304 305
305 306 # Make sure all missing required packages are installed
306 307 apt-get -qq -y install ${MISSING_PACKAGES}
307 308 fi
308 309
309 310 # Check if ./bootstrap.d directory exists
310 311 if [ ! -d "./bootstrap.d/" ] ; then
311 312 echo "error: './bootstrap.d' required directory not found!"
312 313 exit 1
313 314 fi
314 315
315 316 # Check if ./files directory exists
316 317 if [ ! -d "./files/" ] ; then
317 318 echo "error: './files' required directory not found!"
318 319 exit 1
319 320 fi
320 321
321 322 # Check if specified KERNELSRC_DIR directory exists
322 323 if [ -n "$KERNELSRC_DIR" ] && [ ! -d "$KERNELSRC_DIR" ] ; then
323 324 echo "error: '${KERNELSRC_DIR}' specified directory not found (KERNELSRC_DIR)!"
324 325 exit 1
325 326 fi
326 327
328 # Check if specified UBOOTSRC_DIR directory exists
329 if [ -n "$UBOOTSRC_DIR" ] && [ ! -d "$UBOOTSRC_DIR" ] ; then
330 echo "error: '${UBOOTSRC_DIR}' specified directory not found (UBOOTSRC_DIR)!"
331 exit 1
332 fi
333
327 334 # Check if specified CHROOT_SCRIPTS directory exists
328 335 if [ -n "$CHROOT_SCRIPTS" ] && [ ! -d "$CHROOT_SCRIPTS" ] ; then
329 336 echo "error: ${CHROOT_SCRIPTS} specified directory not found (CHROOT_SCRIPTS)!"
330 337 exit 1
331 338 fi
332 339
333 340 # Check if specified device mapping already exists (will be used by cryptsetup)
334 341 if [ -r "/dev/mapping/${CRYPTFS_MAPPING}" ] ; then
335 342 echo "error: mapping /dev/mapping/${CRYPTFS_MAPPING} already exists, not proceeding"
336 343 exit 1
337 344 fi
338 345
339 346 # Don't clobber an old build
340 347 if [ -e "$BUILDDIR" ] ; then
341 348 echo "error: directory ${BUILDDIR} already exists, not proceeding"
342 349 exit 1
343 350 fi
344 351
345 352 # Setup chroot directory
346 353 mkdir -p "${R}"
347 354
348 355 # Check if build directory has enough of free disk space >512MB
349 356 if [ "$(df --output=avail ${BUILDDIR} | sed "1d")" -le "524288" ] ; then
350 357 echo "error: ${BUILDDIR} not enough space left to generate the output image!"
351 358 exit 1
352 359 fi
353 360
354 361 set -x
355 362
356 363 # Call "cleanup" function on various signals and errors
357 364 trap cleanup 0 1 2 3 6
358 365
359 366 # Add required packages for the minbase installation
360 367 if [ "$ENABLE_MINBASE" = true ] ; then
361 368 APT_INCLUDES="${APT_INCLUDES},vim-tiny,netbase,net-tools,ifupdown"
362 369 fi
363 370
364 371 # Add required locales packages
365 372 if [ "$DEFLOCAL" != "en_US.UTF-8" ] ; then
366 373 APT_INCLUDES="${APT_INCLUDES},locales,keyboard-configuration,console-setup"
367 374 fi
368 375
369 376 # Add parted package, required to get partprobe utility
370 377 if [ "$EXPANDROOT" = true ] ; then
371 378 APT_INCLUDES="${APT_INCLUDES},parted"
372 379 fi
373 380
374 381 # Add dbus package, recommended if using systemd
375 382 if [ "$ENABLE_DBUS" = true ] ; then
376 383 APT_INCLUDES="${APT_INCLUDES},dbus"
377 384 fi
378 385
379 386 # Add iptables IPv4/IPv6 package
380 387 if [ "$ENABLE_IPTABLES" = true ] ; then
381 388 APT_INCLUDES="${APT_INCLUDES},iptables"
382 389 fi
383 390
384 391 # Add openssh server package
385 392 if [ "$ENABLE_SSHD" = true ] ; then
386 393 APT_INCLUDES="${APT_INCLUDES},openssh-server"
387 394 fi
388 395
389 396 # Add alsa-utils package
390 397 if [ "$ENABLE_SOUND" = true ] ; then
391 398 APT_INCLUDES="${APT_INCLUDES},alsa-utils"
392 399 fi
393 400
394 401 # Add rng-tools package
395 402 if [ "$ENABLE_HWRANDOM" = true ] ; then
396 403 APT_INCLUDES="${APT_INCLUDES},rng-tools"
397 404 fi
398 405
399 406 # Add fbturbo video driver
400 407 if [ "$ENABLE_FBTURBO" = true ] ; then
401 408 # Enable xorg package dependencies
402 409 ENABLE_XORG=true
403 410 fi
404 411
405 412 # Add user defined window manager package
406 413 if [ -n "$ENABLE_WM" ] ; then
407 414 APT_INCLUDES="${APT_INCLUDES},${ENABLE_WM}"
408 415
409 416 # Enable xorg package dependencies
410 417 ENABLE_XORG=true
411 418 fi
412 419
413 420 # Add xorg package
414 421 if [ "$ENABLE_XORG" = true ] ; then
415 422 APT_INCLUDES="${APT_INCLUDES},xorg"
416 423 fi
417 424
418 425 # Replace selected packages with smaller clones
419 426 if [ "$ENABLE_REDUCE" = true ] ; then
420 427 # Add levee package instead of vim-tiny
421 428 if [ "$REDUCE_VIM" = true ] ; then
422 429 APT_INCLUDES="$(echo ${APT_INCLUDES} | sed "s/vim-tiny/levee/")"
423 430 fi
424 431
425 432 # Add dropbear package instead of openssh-server
426 433 if [ "$REDUCE_SSHD" = true ] ; then
427 434 APT_INCLUDES="$(echo ${APT_INCLUDES} | sed "s/openssh-server/dropbear/")"
428 435 fi
429 436 fi
430 437
431 438 # Configure kernel sources if no KERNELSRC_DIR
432 439 if [ "$BUILD_KERNEL" = true ] && [ -z "$KERNELSRC_DIR" ] ; then
433 440 KERNELSRC_CONFIG=true
434 441 fi
435 442
436 443 # Configure reduced kernel
437 444 if [ "$KERNEL_REDUCE" = true ] ; then
438 445 KERNELSRC_CONFIG=false
439 446 fi
440 447
441 448 # Execute bootstrap scripts
442 449 for SCRIPT in bootstrap.d/*.sh; do
443 450 head -n 3 "$SCRIPT"
444 451 . "$SCRIPT"
445 452 done
446 453
447 454 ## Execute custom bootstrap scripts
448 455 if [ -d "custom.d" ] ; then
449 456 for SCRIPT in custom.d/*.sh; do
450 457 . "$SCRIPT"
451 458 done
452 459 fi
453 460
454 461 # Execute custom scripts inside the chroot
455 462 if [ -n "$CHROOT_SCRIPTS" ] && [ -d "$CHROOT_SCRIPTS" ] ; then
456 463 cp -r "${CHROOT_SCRIPTS}" "${R}/chroot_scripts"
457 464 chroot_exec /bin/bash -x <<'EOF'
458 465 for SCRIPT in /chroot_scripts/* ; do
459 466 if [ -f $SCRIPT -a -x $SCRIPT ] ; then
460 467 $SCRIPT
461 468 fi
462 469 done
463 470 EOF
464 471 rm -rf "${R}/chroot_scripts"
465 472 fi
466 473
467 474 # Remove apt-utils
468 475 if [ "$RELEASE" = "jessie" ] ; then
469 476 chroot_exec apt-get purge -qq -y --force-yes apt-utils
470 477 fi
471 478
472 479 # Generate required machine-id
473 480 MACHINE_ID=$(dbus-uuidgen)
474 481 echo -n "${MACHINE_ID}" > "${R}/var/lib/dbus/machine-id"
475 482 echo -n "${MACHINE_ID}" > "${ETC_DIR}/machine-id"
476 483
477 484 # APT Cleanup
478 485 chroot_exec apt-get -y clean
479 486 chroot_exec apt-get -y autoclean
480 487 chroot_exec apt-get -y autoremove
481 488
482 489 # Unmount mounted filesystems
483 490 umount -l "${R}/proc"
484 491 umount -l "${R}/sys"
485 492
486 493 # Clean up directories
487 494 rm -rf "${R}/run/*"
488 495 rm -rf "${R}/tmp/*"
489 496
490 497 # Clean up files
491 498 rm -f "${ETC_DIR}/ssh/ssh_host_*"
492 499 rm -f "${ETC_DIR}/dropbear/dropbear_*"
493 500 rm -f "${ETC_DIR}/apt/sources.list.save"
494 501 rm -f "${ETC_DIR}/resolvconf/resolv.conf.d/original"
495 502 rm -f "${ETC_DIR}/*-"
496 503 rm -f "${ETC_DIR}/apt/apt.conf.d/10proxy"
497 504 rm -f "${ETC_DIR}/resolv.conf"
498 505 rm -f "${R}/root/.bash_history"
499 506 rm -f "${R}/var/lib/urandom/random-seed"
500 507 rm -f "${R}/initrd.img"
501 508 rm -f "${R}/vmlinuz"
502 509 rm -f "${R}${QEMU_BINARY}"
503 510
504 511 # Calculate size of the chroot directory in KB
505 512 CHROOT_SIZE=$(expr `du -s "${R}" | awk '{ print $1 }'`)
506 513
507 514 # Calculate the amount of needed 512 Byte sectors
508 515 TABLE_SECTORS=$(expr 1 \* 1024 \* 1024 \/ 512)
509 516 FRMW_SECTORS=$(expr 64 \* 1024 \* 1024 \/ 512)
510 517 ROOT_OFFSET=$(expr ${TABLE_SECTORS} + ${FRMW_SECTORS})
511 518
512 519 # The root partition is EXT4
513 520 # This means more space than the actual used space of the chroot is used.
514 521 # As overhead for journaling and reserved blocks 25% are added.
515 522 ROOT_SECTORS=$(expr $(expr ${CHROOT_SIZE} + ${CHROOT_SIZE} \/ 100 \* 25) \* 1024 \/ 512)
516 523
517 524 # Calculate required image size in 512 Byte sectors
518 525 IMAGE_SECTORS=$(expr ${TABLE_SECTORS} + ${FRMW_SECTORS} + ${ROOT_SECTORS})
519 526
520 527 # Prepare date string for image file name
521 528 DATE="$(date +%Y-%m-%d)"
522 529
523 530 # Prepare image file
524 531 if [ "$ENABLE_SPLITFS" = true ] ; then
525 532 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img" bs=512 count=${TABLE_SECTORS}
526 533 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img" bs=512 count=0 seek=${FRMW_SECTORS}
527 534 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img" bs=512 count=${TABLE_SECTORS}
528 535 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img" bs=512 count=0 seek=${ROOT_SECTORS}
529 536
530 537 # Write firmware/boot partition tables
531 538 sfdisk -q -L -uS -f "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img" 2> /dev/null <<EOM
532 539 ${TABLE_SECTORS},${FRMW_SECTORS},c,*
533 540 EOM
534 541
535 542 # Write root partition table
536 543 sfdisk -q -L -uS -f "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img" 2> /dev/null <<EOM
537 544 ${TABLE_SECTORS},${ROOT_SECTORS},83
538 545 EOM
539 546
540 547 # Setup temporary loop devices
541 548 FRMW_LOOP="$(losetup -o 1M --sizelimit 64M -f --show $BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img)"
542 549 ROOT_LOOP="$(losetup -o 1M -f --show $BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img)"
543 550 else # ENABLE_SPLITFS=false
544 551 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img" bs=512 count=${TABLE_SECTORS}
545 552 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img" bs=512 count=0 seek=${IMAGE_SECTORS}
546 553
547 554 # Write partition table
548 555 sfdisk -q -L -uS -f "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img" 2> /dev/null <<EOM
549 556 ${TABLE_SECTORS},${FRMW_SECTORS},c,*
550 557 ${ROOT_OFFSET},${ROOT_SECTORS},83
551 558 EOM
552 559
553 560 # Setup temporary loop devices
554 561 FRMW_LOOP="$(losetup -o 1M --sizelimit 64M -f --show $BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img)"
555 562 ROOT_LOOP="$(losetup -o 65M -f --show $BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img)"
556 563 fi
557 564
558 565 if [ "$ENABLE_CRYPTFS" = true ] ; then
559 566 # Create dummy ext4 fs
560 567 mkfs.ext4 "$ROOT_LOOP"
561 568
562 569 # Setup password keyfile
563 570 echo -n ${CRYPTFS_PASSWORD} > .password
564 571 chmod 600 .password
565 572
566 573 # Initialize encrypted partition
567 574 echo "YES" | cryptsetup luksFormat "${ROOT_LOOP}" -c "${CRYPTFS_CIPHER}" -s "${CRYPTFS_XTSKEYSIZE}" .password
568 575
569 576 # Open encrypted partition and setup mapping
570 577 cryptsetup luksOpen "${ROOT_LOOP}" -d .password "${CRYPTFS_MAPPING}"
571 578
572 579 # Secure delete password keyfile
573 580 shred -zu .password
574 581
575 582 # Update temporary loop device
576 583 ROOT_LOOP="/dev/mapper/${CRYPTFS_MAPPING}"
577 584
578 585 # Wipe encrypted partition (encryption cipher is used for randomness)
579 586 dd if=/dev/zero of="${ROOT_LOOP}" bs=512 count=$(blockdev --getsz "${ROOT_LOOP}")
580 587 fi
581 588
582 589 # Build filesystems
583 590 mkfs.vfat "$FRMW_LOOP"
584 591 mkfs.ext4 "$ROOT_LOOP"
585 592
586 593 # Mount the temporary loop devices
587 594 mkdir -p "$BUILDDIR/mount"
588 595 mount "$ROOT_LOOP" "$BUILDDIR/mount"
589 596
590 597 mkdir -p "$BUILDDIR/mount/boot/firmware"
591 598 mount "$FRMW_LOOP" "$BUILDDIR/mount/boot/firmware"
592 599
593 600 # Copy all files from the chroot to the loop device mount point directory
594 601 rsync -a "${R}/" "$BUILDDIR/mount/"
595 602
596 603 # Unmount all temporary loop devices and mount points
597 604 cleanup
598 605
599 606 # Create block map file(s) of image(s)
600 607 if [ "$ENABLE_SPLITFS" = true ] ; then
601 608 # Create block map files for "bmaptool"
602 609 bmaptool create -o "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.bmap" "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img"
603 610 bmaptool create -o "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.bmap" "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img"
604 611
605 612 # Image was successfully created
606 613 echo "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img ($(expr \( ${TABLE_SECTORS} + ${FRMW_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
607 614 echo "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img ($(expr \( ${TABLE_SECTORS} + ${ROOT_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
608 615 else
609 616 # Create block map file for "bmaptool"
610 617 bmaptool create -o "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.bmap" "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img"
611 618
612 619 # Image was successfully created
613 620 echo "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img ($(expr \( ${TABLE_SECTORS} + ${FRMW_SECTORS} + ${ROOT_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
614 621 fi
General Comments 0
Vous devez vous connecter pour laisser un commentaire. Se connecter maintenant