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

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

Add IMAGE_NAME
Denis Mosolov -
r138:9cc6bc7aa1ed
parent child
Show More
Show file before | Show file after | Hide comments
@@ -1,415 +1,418
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 199 ##### `ENABLE_FBTURBO`=false
200 200 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 201
202 202 ##### `ENABLE_IPTABLES`=false
203 203 Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.
204 204
205 205 ##### `ENABLE_USER`=true
206 206 Create non-root user with password `USER_PASSWORD`=raspberry. Unless overridden with `USER_NAME`=user, username will be `pi`.
207 207
208 208 ##### `USER_NAME`=pi
209 209 Non-root user to create. Ignored if `ENABLE_USER`=false
210 210
211 211 ##### `ENABLE_ROOT`=false
212 212 Set root user password so root login will be enabled
213 213
214 214 ##### `ENABLE_HARDNET`=false
215 215 Enable IPv4/IPv6 network stack hardening settings.
216 216
217 217 ##### `ENABLE_SPLITFS`=false
218 218 Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.
219 219
220 220 ##### `CHROOT_SCRIPTS`=""
221 221 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 222
223 223 ##### `ENABLE_INITRAMFS`=false
224 224 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 225
226 226 ##### `ENABLE_IFNAMES`=true
227 227 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 228
229 229 ##### `DISABLE_UNDERVOLT_WARNINGS`=
230 230 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 231
232 232 ---
233 233
234 234 #### SSH settings:
235 235 ##### `SSH_ENABLE_ROOT`=false
236 236 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 237
238 238 ##### `SSH_DISABLE_PASSWORD_AUTH`=false
239 239 Disable password based SSH authentication. Only public key based SSH (v2) authentication will be supported.
240 240
241 241 ##### `SSH_LIMIT_USERS`=false
242 242 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 243
244 244 ##### `SSH_ROOT_PUB_KEY`=""
245 245 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 246
247 247 ##### `SSH_USER_PUB_KEY`=""
248 248 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 249
250 250 ---
251 251
252 252 #### Kernel compilation:
253 253 ##### `BUILD_KERNEL`=false
254 254 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 255
256 256 ##### `KERNEL_REDUCE`=false
257 257 Reduce the size of the generated kernel by removing unwanted device, network and filesystem drivers (experimental).
258 258
259 259 ##### `KERNEL_THREADS`=1
260 260 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 261
262 262 ##### `KERNEL_HEADERS`=true
263 263 Install kernel headers with built kernel.
264 264
265 265 ##### `KERNEL_MENUCONFIG`=false
266 266 Start `make menuconfig` interactive menu-driven kernel configuration. The script will continue after `make menuconfig` was terminated.
267 267
268 268 ##### `KERNEL_REMOVESRC`=true
269 269 Remove all kernel sources from the generated OS image after it was built and installed.
270 270
271 271 ##### `KERNELSRC_DIR`=""
272 272 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 273
274 274 ##### `KERNELSRC_CLEAN`=false
275 275 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 276
277 277 ##### `KERNELSRC_CONFIG`=true
278 278 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 279
280 280 ##### `KERNELSRC_USRCONFIG`=""
281 281 Copy own config file to kernel `.config`. If `KERNEL_MENUCONFIG`=true then running after copy.
282 282
283 283 ##### `KERNELSRC_PREBUILT`=false
284 284 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 285
286 286 ##### `RPI_FIRMWARE_DIR`=""
287 287 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 288
289 289 ---
290 290
291 291 #### Reduce disk usage:
292 292 The following list of parameters is ignored if `ENABLE_REDUCE`=false.
293 293
294 294 ##### `REDUCE_APT`=true
295 295 Configure APT to use compressed package repository lists and no package caching files.
296 296
297 297 ##### `REDUCE_DOC`=true
298 298 Remove all doc files (harsh). Configure APT to not include doc files on future `apt-get` package installations.
299 299
300 300 ##### `REDUCE_MAN`=true
301 301 Remove all man pages and info files (harsh). Configure APT to not include man pages on future `apt-get` package installations.
302 302
303 303 ##### `REDUCE_VIM`=false
304 304 Replace `vim-tiny` package by `levee` a tiny vim clone.
305 305
306 306 ##### `REDUCE_BASH`=false
307 307 Remove `bash` package and switch to `dash` shell (experimental).
308 308
309 309 ##### `REDUCE_HWDB`=true
310 310 Remove PCI related hwdb files (experimental).
311 311
312 312 ##### `REDUCE_SSHD`=true
313 313 Replace `openssh-server` with `dropbear`.
314 314
315 315 ##### `REDUCE_LOCALE`=true
316 316 Remove all `locale` translation files.
317 317
318 318 ---
319 319
320 320 #### Encrypted root partition:
321 321 ##### `ENABLE_CRYPTFS`=false
322 322 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 323
324 324 ##### `CRYPTFS_PASSWORD`=""
325 325 Set password of the encrypted root partition. This parameter is mandatory if `ENABLE_CRYPTFS`=true.
326 326
327 327 ##### `CRYPTFS_MAPPING`="secure"
328 328 Set name of dm-crypt managed device-mapper mapping.
329 329
330 330 ##### `CRYPTFS_CIPHER`="aes-xts-plain64:sha512"
331 331 Set cipher specification string. `aes-xts*` ciphers are strongly recommended.
332 332
333 333 ##### `CRYPTFS_XTSKEYSIZE`=512
334 334 Sets key size in bits. The argument has to be a multiple of 8.
335 335
336 336 ---
337 337
338 338 #### Build settings:
339 339 ##### `BASEDIR`=$(pwd)/images/${RELEASE}
340 Path to a directory where the script stores all temporary files during generating the image.
340 Set a path to a working directory used by the script to generate an image.
341
342 ##### `IMAGE_NAME`=${BASEDIR}/${DATE}-rpi${RPI_MODEL}-${RELEASE}
343 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.
341 344
342 345 ## Understanding the script
343 346 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:
344 347
345 348 | Script | Description |
346 349 | --- | --- |
347 350 | `10-bootstrap.sh` | Debootstrap basic system |
348 351 | `11-apt.sh` | Setup APT repositories |
349 352 | `12-locale.sh` | Setup Locales and keyboard settings |
350 353 | `13-kernel.sh` | Build and install RPi2/3 Kernel |
351 354 | `14-rpi-config.sh` | Setup RPi2/3 config and cmdline |
352 355 | `20-networking.sh` | Setup Networking |
353 356 | `21-firewall.sh` | Setup Firewall |
354 357 | `30-security.sh` | Setup Users and Security settings |
355 358 | `31-logging.sh` | Setup Logging |
356 359 | `32-sshd.sh` | Setup SSH and public keys |
357 360 | `41-uboot.sh` | Build and Setup U-Boot |
358 361 | `42-fbturbo.sh` | Build and Setup fbturbo Xorg driver |
359 362 | `50-firstboot.sh` | First boot actions |
360 363 | `99-reduce.sh` | Reduce the disk space usage |
361 364
362 365 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.
363 366
364 367 | Directory | Description |
365 368 | --- | --- |
366 369 | `apt` | APT management configuration files |
367 370 | `boot` | Boot and RPi2/3 configuration files |
368 371 | `dpkg` | Package Manager configuration |
369 372 | `etc` | Configuration files and rc scripts |
370 373 | `firstboot` | Scripts that get executed on first boot |
371 374 | `initramfs` | Initramfs scripts |
372 375 | `iptables` | Firewall configuration files |
373 376 | `locales` | Locales configuration |
374 377 | `modules` | Kernel Modules configuration |
375 378 | `mount` | Fstab configuration |
376 379 | `network` | Networking configuration files |
377 380 | `sysctl.d` | Swapping and Network Hardening configuration |
378 381 | `xorg` | fbturbo Xorg driver configuration |
379 382
380 383 ## Custom packages and scripts
381 384 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`.
382 385
383 386 Scripts in the custom.d directory will be executed after all other installation is complete but before the image is created.
384 387
385 388 ## Logging of the bootstrapping process
386 389 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:
387 390
388 391 ```shell
389 392 script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log
390 393 ```
391 394
392 395 ## Flashing the image file
393 396 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`.
394 397
395 398 #####Flashing examples:
396 399 ```shell
397 400 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie.img /dev/mmcblk0
398 401 dd bs=4M if=./images/jessie/2017-01-23-rpi3-jessie.img of=/dev/mmcblk0
399 402 ```
400 403 If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:
401 404 ```shell
402 405 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie-frmw.img /dev/mmcblk0
403 406 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie-root.img /dev/sdc
404 407 ```
405 408
406 409 ## External links and references
407 410 * [Debian worldwide mirror sites](https://www.debian.org/mirror/list)
408 411 * [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)
409 412 * [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains)
410 413 * [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)
411 414 * [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)
412 415 * [U-BOOT git repository](http://git.denx.de/?p=u-boot.git;a=summary)
413 416 * [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)
414 417 * [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/brcm)
415 418 * [Collabora RPi2 Kernel precompiled](https://repositories.collabora.co.uk/debian/)
Show file before | Show file after | Hide comments
@@ -1,614 +1,614
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=${BASEDIR:=$(pwd)/images/${RELEASE}}
70 70 BUILDDIR="${BASEDIR}/build"
71 # Prepare date string for default image file name
72 DATE="$(date +%Y-%m-%d)"
73 IMAGE_NAME=${IMAGE_NAME:=${BASEDIR}/${DATE}-rpi${RPI_MODEL}-${RELEASE}}
71 74
72 75 # Chroot directories
73 76 R="${BUILDDIR}/chroot"
74 77 ETC_DIR="${R}/etc"
75 78 LIB_DIR="${R}/lib"
76 79 BOOT_DIR="${R}/boot/firmware"
77 80 KERNEL_DIR="${R}/usr/src/linux"
78 81 WLAN_FIRMWARE_DIR="${R}/lib/firmware/brcm"
79 82
80 83 # Firmware directory: Blank if download from github
81 84 RPI_FIRMWARE_DIR=${RPI_FIRMWARE_DIR:=""}
82 85
83 86 # General settings
84 87 HOSTNAME=${HOSTNAME:=rpi${RPI_MODEL}-${RELEASE}}
85 88 PASSWORD=${PASSWORD:=raspberry}
86 89 USER_PASSWORD=${USER_PASSWORD:=raspberry}
87 90 DEFLOCAL=${DEFLOCAL:="en_US.UTF-8"}
88 91 TIMEZONE=${TIMEZONE:="Europe/Berlin"}
89 92 EXPANDROOT=${EXPANDROOT:=true}
90 93
91 94 # Keyboard settings
92 95 XKB_MODEL=${XKB_MODEL:=""}
93 96 XKB_LAYOUT=${XKB_LAYOUT:=""}
94 97 XKB_VARIANT=${XKB_VARIANT:=""}
95 98 XKB_OPTIONS=${XKB_OPTIONS:=""}
96 99
97 100 # Network settings (DHCP)
98 101 ENABLE_DHCP=${ENABLE_DHCP:=true}
99 102
100 103 # Network settings (static)
101 104 NET_ADDRESS=${NET_ADDRESS:=""}
102 105 NET_GATEWAY=${NET_GATEWAY:=""}
103 106 NET_DNS_1=${NET_DNS_1:=""}
104 107 NET_DNS_2=${NET_DNS_2:=""}
105 108 NET_DNS_DOMAINS=${NET_DNS_DOMAINS:=""}
106 109 NET_NTP_1=${NET_NTP_1:=""}
107 110 NET_NTP_2=${NET_NTP_2:=""}
108 111
109 112 # APT settings
110 113 APT_PROXY=${APT_PROXY:=""}
111 114 APT_SERVER=${APT_SERVER:="ftp.debian.org"}
112 115
113 116 # Feature settings
114 117 ENABLE_CONSOLE=${ENABLE_CONSOLE:=true}
115 118 ENABLE_I2C=${ENABLE_I2C:=false}
116 119 ENABLE_SPI=${ENABLE_SPI:=false}
117 120 ENABLE_IPV6=${ENABLE_IPV6:=true}
118 121 ENABLE_SSHD=${ENABLE_SSHD:=true}
119 122 ENABLE_NONFREE=${ENABLE_NONFREE:=false}
120 123 ENABLE_WIRELESS=${ENABLE_WIRELESS:=false}
121 124 ENABLE_SOUND=${ENABLE_SOUND:=true}
122 125 ENABLE_DBUS=${ENABLE_DBUS:=true}
123 126 ENABLE_HWRANDOM=${ENABLE_HWRANDOM:=true}
124 127 ENABLE_MINGPU=${ENABLE_MINGPU:=false}
125 128 ENABLE_XORG=${ENABLE_XORG:=false}
126 129 ENABLE_WM=${ENABLE_WM:=""}
127 130 ENABLE_RSYSLOG=${ENABLE_RSYSLOG:=true}
128 131 ENABLE_USER=${ENABLE_USER:=true}
129 132 USER_NAME=${USER_NAME:="pi"}
130 133 ENABLE_ROOT=${ENABLE_ROOT:=false}
131 134
132 135 # SSH settings
133 136 SSH_ENABLE_ROOT=${SSH_ENABLE_ROOT:=false}
134 137 SSH_DISABLE_PASSWORD_AUTH=${SSH_DISABLE_PASSWORD_AUTH:=false}
135 138 SSH_LIMIT_USERS=${SSH_LIMIT_USERS:=false}
136 139 SSH_ROOT_PUB_KEY=${SSH_ROOT_PUB_KEY:=""}
137 140 SSH_USER_PUB_KEY=${SSH_USER_PUB_KEY:=""}
138 141
139 142 # Advanced settings
140 143 ENABLE_MINBASE=${ENABLE_MINBASE:=false}
141 144 ENABLE_REDUCE=${ENABLE_REDUCE:=false}
142 145 ENABLE_UBOOT=${ENABLE_UBOOT:=false}
143 146 ENABLE_FBTURBO=${ENABLE_FBTURBO:=false}
144 147 ENABLE_HARDNET=${ENABLE_HARDNET:=false}
145 148 ENABLE_IPTABLES=${ENABLE_IPTABLES:=false}
146 149 ENABLE_SPLITFS=${ENABLE_SPLITFS:=false}
147 150 ENABLE_INITRAMFS=${ENABLE_INITRAMFS:=false}
148 151 ENABLE_IFNAMES=${ENABLE_IFNAMES:=true}
149 152 DISABLE_UNDERVOLT_WARNINGS=${DISABLE_UNDERVOLT_WARNINGS:=}
150 153
151 154 # Kernel compilation settings
152 155 BUILD_KERNEL=${BUILD_KERNEL:=false}
153 156 KERNEL_REDUCE=${KERNEL_REDUCE:=false}
154 157 KERNEL_THREADS=${KERNEL_THREADS:=1}
155 158 KERNEL_HEADERS=${KERNEL_HEADERS:=true}
156 159 KERNEL_MENUCONFIG=${KERNEL_MENUCONFIG:=false}
157 160 KERNEL_REMOVESRC=${KERNEL_REMOVESRC:=true}
158 161
159 162 # Kernel compilation from source directory settings
160 163 KERNELSRC_DIR=${KERNELSRC_DIR:=""}
161 164 KERNELSRC_CLEAN=${KERNELSRC_CLEAN:=false}
162 165 KERNELSRC_CONFIG=${KERNELSRC_CONFIG:=true}
163 166 KERNELSRC_PREBUILT=${KERNELSRC_PREBUILT:=false}
164 167
165 168 # Reduce disk usage settings
166 169 REDUCE_APT=${REDUCE_APT:=true}
167 170 REDUCE_DOC=${REDUCE_DOC:=true}
168 171 REDUCE_MAN=${REDUCE_MAN:=true}
169 172 REDUCE_VIM=${REDUCE_VIM:=false}
170 173 REDUCE_BASH=${REDUCE_BASH:=false}
171 174 REDUCE_HWDB=${REDUCE_HWDB:=true}
172 175 REDUCE_SSHD=${REDUCE_SSHD:=true}
173 176 REDUCE_LOCALE=${REDUCE_LOCALE:=true}
174 177
175 178 # Encrypted filesystem settings
176 179 ENABLE_CRYPTFS=${ENABLE_CRYPTFS:=false}
177 180 CRYPTFS_PASSWORD=${CRYPTFS_PASSWORD:=""}
178 181 CRYPTFS_MAPPING=${CRYPTFS_MAPPING:="secure"}
179 182 CRYPTFS_CIPHER=${CRYPTFS_CIPHER:="aes-xts-plain64:sha512"}
180 183 CRYPTFS_XTSKEYSIZE=${CRYPTFS_XTSKEYSIZE:=512}
181 184
182 185 # Stop the Crypto Wars
183 186 DISABLE_FBI=${DISABLE_FBI:=false}
184 187
185 188 # Chroot scripts directory
186 189 CHROOT_SCRIPTS=${CHROOT_SCRIPTS:=""}
187 190
188 191 # Packages required in the chroot build environment
189 192 APT_INCLUDES=${APT_INCLUDES:=""}
190 193 APT_INCLUDES="${APT_INCLUDES},apt-transport-https,apt-utils,ca-certificates,debian-archive-keyring,dialog,sudo,systemd,sysvinit-utils"
191 194
192 195 # Packages required for bootstrapping
193 196 REQUIRED_PACKAGES="debootstrap debian-archive-keyring qemu-user-static binfmt-support dosfstools rsync bmap-tools whois git bc psmisc dbus"
194 197 MISSING_PACKAGES=""
195 198
196 199 set +x
197 200
198 201 # Set Raspberry Pi model specific configuration
199 202 if [ "$RPI_MODEL" = 2 ] ; then
200 203 DTB_FILE=${RPI2_DTB_FILE}
201 204 UBOOT_CONFIG=${RPI2_UBOOT_CONFIG}
202 205 elif [ "$RPI_MODEL" = 3 ] ; then
203 206 DTB_FILE=${RPI3_DTB_FILE}
204 207 UBOOT_CONFIG=${RPI3_UBOOT_CONFIG}
205 208 BUILD_KERNEL=true
206 209 else
207 210 echo "error: Raspberry Pi model ${RPI_MODEL} is not supported!"
208 211 exit 1
209 212 fi
210 213
211 214 # Check if the internal wireless interface is supported by the RPi model
212 215 if [ "$ENABLE_WIRELESS" = true ] && [ "$RPI_MODEL" != 3 ] ; then
213 216 echo "error: The selected Raspberry Pi model has no internal wireless interface"
214 217 exit 1
215 218 fi
216 219
217 220 # Check if DISABLE_UNDERVOLT_WARNINGS parameter value is supported
218 221 if [ ! -z "$DISABLE_UNDERVOLT_WARNINGS" ] ; then
219 222 if [ "$DISABLE_UNDERVOLT_WARNINGS" != 1 ] && [ "$DISABLE_UNDERVOLT_WARNINGS" != 2 ] ; then
220 223 echo "error: DISABLE_UNDERVOLT_WARNINGS=${DISABLE_UNDERVOLT_WARNINGS} is not supported"
221 224 exit 1
222 225 fi
223 226 fi
224 227
225 228 # Set compiler packages and build RPi2/3 Linux kernel if required by Debian release
226 229 if [ "$RELEASE" = "jessie" ] ; then
227 230 COMPILER_PACKAGES="linux-compiler-gcc-4.8-arm g++ make bc"
228 231 elif [ "$RELEASE" = "stretch" ] ; then
229 232 COMPILER_PACKAGES="linux-compiler-gcc-5-arm g++ make bc"
230 233 BUILD_KERNEL=true
231 234 else
232 235 echo "error: Debian release ${RELEASE} is not supported!"
233 236 exit 1
234 237 fi
235 238
236 239 # Add packages required for kernel cross compilation
237 240 if [ "$BUILD_KERNEL" = true ] ; then
238 241 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} crossbuild-essential-armhf"
239 242 fi
240 243
241 244 # Add libncurses5 to enable kernel menuconfig
242 245 if [ "$KERNEL_MENUCONFIG" = true ] ; then
243 246 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} libncurses5-dev"
244 247 fi
245 248
246 249 # Stop the Crypto Wars
247 250 if [ "$DISABLE_FBI" = true ] ; then
248 251 ENABLE_CRYPTFS=true
249 252 fi
250 253
251 254 # Add cryptsetup package to enable filesystem encryption
252 255 if [ "$ENABLE_CRYPTFS" = true ] && [ "$BUILD_KERNEL" = true ] ; then
253 256 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} cryptsetup"
254 257 APT_INCLUDES="${APT_INCLUDES},cryptsetup"
255 258
256 259 if [ -z "$CRYPTFS_PASSWORD" ] ; then
257 260 echo "error: no password defined (CRYPTFS_PASSWORD)!"
258 261 exit 1
259 262 fi
260 263 ENABLE_INITRAMFS=true
261 264 fi
262 265
263 266 # Add initramfs generation tools
264 267 if [ "$ENABLE_INITRAMFS" = true ] && [ "$BUILD_KERNEL" = true ] ; then
265 268 APT_INCLUDES="${APT_INCLUDES},initramfs-tools"
266 269 fi
267 270
268 271 # Add device-tree-compiler required for building the U-Boot bootloader
269 272 if [ "$ENABLE_UBOOT" = true ] ; then
270 273 APT_INCLUDES="${APT_INCLUDES},device-tree-compiler"
271 274 fi
272 275
273 276 # Check if root SSH (v2) public key file exists
274 277 if [ ! -z "$SSH_ROOT_PUB_KEY" ] ; then
275 278 if [ ! -f "$SSH_ROOT_PUB_KEY" ] ; then
276 279 echo "error: '$SSH_ROOT_PUB_KEY' specified SSH public key file not found (SSH_ROOT_PUB_KEY)!"
277 280 exit 1
278 281 fi
279 282 fi
280 283
281 284 # Check if $USER_NAME SSH (v2) public key file exists
282 285 if [ ! -z "$SSH_USER_PUB_KEY" ] ; then
283 286 if [ ! -f "$SSH_USER_PUB_KEY" ] ; then
284 287 echo "error: '$SSH_USER_PUB_KEY' specified SSH public key file not found (SSH_USER_PUB_KEY)!"
285 288 exit 1
286 289 fi
287 290 fi
288 291
289 292 # Check if all required packages are installed on the build system
290 293 for package in $REQUIRED_PACKAGES ; do
291 294 if [ "`dpkg-query -W -f='${Status}' $package`" != "install ok installed" ] ; then
292 295 MISSING_PACKAGES="${MISSING_PACKAGES} $package"
293 296 fi
294 297 done
295 298
296 299 # If there are missing packages ask confirmation for install, or exit
297 300 if [ -n "$MISSING_PACKAGES" ] ; then
298 301 echo "the following packages needed by this script are not installed:"
299 302 echo "$MISSING_PACKAGES"
300 303
301 304 echo -n "\ndo you want to install the missing packages right now? [y/n] "
302 305 read confirm
303 306 [ "$confirm" != "y" ] && exit 1
304 307
305 308 # Make sure all missing required packages are installed
306 309 apt-get -qq -y install ${MISSING_PACKAGES}
307 310 fi
308 311
309 312 # Check if ./bootstrap.d directory exists
310 313 if [ ! -d "./bootstrap.d/" ] ; then
311 314 echo "error: './bootstrap.d' required directory not found!"
312 315 exit 1
313 316 fi
314 317
315 318 # Check if ./files directory exists
316 319 if [ ! -d "./files/" ] ; then
317 320 echo "error: './files' required directory not found!"
318 321 exit 1
319 322 fi
320 323
321 324 # Check if specified KERNELSRC_DIR directory exists
322 325 if [ -n "$KERNELSRC_DIR" ] && [ ! -d "$KERNELSRC_DIR" ] ; then
323 326 echo "error: '${KERNELSRC_DIR}' specified directory not found (KERNELSRC_DIR)!"
324 327 exit 1
325 328 fi
326 329
327 330 # Check if specified CHROOT_SCRIPTS directory exists
328 331 if [ -n "$CHROOT_SCRIPTS" ] && [ ! -d "$CHROOT_SCRIPTS" ] ; then
329 332 echo "error: ${CHROOT_SCRIPTS} specified directory not found (CHROOT_SCRIPTS)!"
330 333 exit 1
331 334 fi
332 335
333 336 # Check if specified device mapping already exists (will be used by cryptsetup)
334 337 if [ -r "/dev/mapping/${CRYPTFS_MAPPING}" ] ; then
335 338 echo "error: mapping /dev/mapping/${CRYPTFS_MAPPING} already exists, not proceeding"
336 339 exit 1
337 340 fi
338 341
339 342 # Don't clobber an old build
340 343 if [ -e "$BUILDDIR" ] ; then
341 344 echo "error: directory ${BUILDDIR} already exists, not proceeding"
342 345 exit 1
343 346 fi
344 347
345 348 # Setup chroot directory
346 349 mkdir -p "${R}"
347 350
348 351 # Check if build directory has enough of free disk space >512MB
349 352 if [ "$(df --output=avail ${BUILDDIR} | sed "1d")" -le "524288" ] ; then
350 353 echo "error: ${BUILDDIR} not enough space left to generate the output image!"
351 354 exit 1
352 355 fi
353 356
354 357 set -x
355 358
356 359 # Call "cleanup" function on various signals and errors
357 360 trap cleanup 0 1 2 3 6
358 361
359 362 # Add required packages for the minbase installation
360 363 if [ "$ENABLE_MINBASE" = true ] ; then
361 364 APT_INCLUDES="${APT_INCLUDES},vim-tiny,netbase,net-tools,ifupdown"
362 365 fi
363 366
364 367 # Add required locales packages
365 368 if [ "$DEFLOCAL" != "en_US.UTF-8" ] ; then
366 369 APT_INCLUDES="${APT_INCLUDES},locales,keyboard-configuration,console-setup"
367 370 fi
368 371
369 372 # Add parted package, required to get partprobe utility
370 373 if [ "$EXPANDROOT" = true ] ; then
371 374 APT_INCLUDES="${APT_INCLUDES},parted"
372 375 fi
373 376
374 377 # Add dbus package, recommended if using systemd
375 378 if [ "$ENABLE_DBUS" = true ] ; then
376 379 APT_INCLUDES="${APT_INCLUDES},dbus"
377 380 fi
378 381
379 382 # Add iptables IPv4/IPv6 package
380 383 if [ "$ENABLE_IPTABLES" = true ] ; then
381 384 APT_INCLUDES="${APT_INCLUDES},iptables"
382 385 fi
383 386
384 387 # Add openssh server package
385 388 if [ "$ENABLE_SSHD" = true ] ; then
386 389 APT_INCLUDES="${APT_INCLUDES},openssh-server"
387 390 fi
388 391
389 392 # Add alsa-utils package
390 393 if [ "$ENABLE_SOUND" = true ] ; then
391 394 APT_INCLUDES="${APT_INCLUDES},alsa-utils"
392 395 fi
393 396
394 397 # Add rng-tools package
395 398 if [ "$ENABLE_HWRANDOM" = true ] ; then
396 399 APT_INCLUDES="${APT_INCLUDES},rng-tools"
397 400 fi
398 401
399 402 # Add fbturbo video driver
400 403 if [ "$ENABLE_FBTURBO" = true ] ; then
401 404 # Enable xorg package dependencies
402 405 ENABLE_XORG=true
403 406 fi
404 407
405 408 # Add user defined window manager package
406 409 if [ -n "$ENABLE_WM" ] ; then
407 410 APT_INCLUDES="${APT_INCLUDES},${ENABLE_WM}"
408 411
409 412 # Enable xorg package dependencies
410 413 ENABLE_XORG=true
411 414 fi
412 415
413 416 # Add xorg package
414 417 if [ "$ENABLE_XORG" = true ] ; then
415 418 APT_INCLUDES="${APT_INCLUDES},xorg"
416 419 fi
417 420
418 421 # Replace selected packages with smaller clones
419 422 if [ "$ENABLE_REDUCE" = true ] ; then
420 423 # Add levee package instead of vim-tiny
421 424 if [ "$REDUCE_VIM" = true ] ; then
422 425 APT_INCLUDES="$(echo ${APT_INCLUDES} | sed "s/vim-tiny/levee/")"
423 426 fi
424 427
425 428 # Add dropbear package instead of openssh-server
426 429 if [ "$REDUCE_SSHD" = true ] ; then
427 430 APT_INCLUDES="$(echo ${APT_INCLUDES} | sed "s/openssh-server/dropbear/")"
428 431 fi
429 432 fi
430 433
431 434 # Configure kernel sources if no KERNELSRC_DIR
432 435 if [ "$BUILD_KERNEL" = true ] && [ -z "$KERNELSRC_DIR" ] ; then
433 436 KERNELSRC_CONFIG=true
434 437 fi
435 438
436 439 # Configure reduced kernel
437 440 if [ "$KERNEL_REDUCE" = true ] ; then
438 441 KERNELSRC_CONFIG=false
439 442 fi
440 443
441 444 # Execute bootstrap scripts
442 445 for SCRIPT in bootstrap.d/*.sh; do
443 446 head -n 3 "$SCRIPT"
444 447 . "$SCRIPT"
445 448 done
446 449
447 450 ## Execute custom bootstrap scripts
448 451 if [ -d "custom.d" ] ; then
449 452 for SCRIPT in custom.d/*.sh; do
450 453 . "$SCRIPT"
451 454 done
452 455 fi
453 456
454 457 # Execute custom scripts inside the chroot
455 458 if [ -n "$CHROOT_SCRIPTS" ] && [ -d "$CHROOT_SCRIPTS" ] ; then
456 459 cp -r "${CHROOT_SCRIPTS}" "${R}/chroot_scripts"
457 460 chroot_exec /bin/bash -x <<'EOF'
458 461 for SCRIPT in /chroot_scripts/* ; do
459 462 if [ -f $SCRIPT -a -x $SCRIPT ] ; then
460 463 $SCRIPT
461 464 fi
462 465 done
463 466 EOF
464 467 rm -rf "${R}/chroot_scripts"
465 468 fi
466 469
467 470 # Remove apt-utils
468 471 if [ "$RELEASE" = "jessie" ] ; then
469 472 chroot_exec apt-get purge -qq -y --force-yes apt-utils
470 473 fi
471 474
472 475 # Generate required machine-id
473 476 MACHINE_ID=$(dbus-uuidgen)
474 477 echo -n "${MACHINE_ID}" > "${R}/var/lib/dbus/machine-id"
475 478 echo -n "${MACHINE_ID}" > "${ETC_DIR}/machine-id"
476 479
477 480 # APT Cleanup
478 481 chroot_exec apt-get -y clean
479 482 chroot_exec apt-get -y autoclean
480 483 chroot_exec apt-get -y autoremove
481 484
482 485 # Unmount mounted filesystems
483 486 umount -l "${R}/proc"
484 487 umount -l "${R}/sys"
485 488
486 489 # Clean up directories
487 490 rm -rf "${R}/run/*"
488 491 rm -rf "${R}/tmp/*"
489 492
490 493 # Clean up files
491 494 rm -f "${ETC_DIR}/ssh/ssh_host_*"
492 495 rm -f "${ETC_DIR}/dropbear/dropbear_*"
493 496 rm -f "${ETC_DIR}/apt/sources.list.save"
494 497 rm -f "${ETC_DIR}/resolvconf/resolv.conf.d/original"
495 498 rm -f "${ETC_DIR}/*-"
496 499 rm -f "${ETC_DIR}/apt/apt.conf.d/10proxy"
497 500 rm -f "${ETC_DIR}/resolv.conf"
498 501 rm -f "${R}/root/.bash_history"
499 502 rm -f "${R}/var/lib/urandom/random-seed"
500 503 rm -f "${R}/initrd.img"
501 504 rm -f "${R}/vmlinuz"
502 505 rm -f "${R}${QEMU_BINARY}"
503 506
504 507 # Calculate size of the chroot directory in KB
505 508 CHROOT_SIZE=$(expr `du -s "${R}" | awk '{ print $1 }'`)
506 509
507 510 # Calculate the amount of needed 512 Byte sectors
508 511 TABLE_SECTORS=$(expr 1 \* 1024 \* 1024 \/ 512)
509 512 FRMW_SECTORS=$(expr 64 \* 1024 \* 1024 \/ 512)
510 513 ROOT_OFFSET=$(expr ${TABLE_SECTORS} + ${FRMW_SECTORS})
511 514
512 515 # The root partition is EXT4
513 516 # This means more space than the actual used space of the chroot is used.
514 517 # As overhead for journaling and reserved blocks 25% are added.
515 518 ROOT_SECTORS=$(expr $(expr ${CHROOT_SIZE} + ${CHROOT_SIZE} \/ 100 \* 25) \* 1024 \/ 512)
516 519
517 520 # Calculate required image size in 512 Byte sectors
518 521 IMAGE_SECTORS=$(expr ${TABLE_SECTORS} + ${FRMW_SECTORS} + ${ROOT_SECTORS})
519 522
520 # Prepare date string for image file name
521 DATE="$(date +%Y-%m-%d)"
522
523 523 # Prepare image file
524 524 if [ "$ENABLE_SPLITFS" = true ] ; then
525 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img" bs=512 count=${TABLE_SECTORS}
526 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img" bs=512 count=0 seek=${FRMW_SECTORS}
527 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img" bs=512 count=${TABLE_SECTORS}
528 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img" bs=512 count=0 seek=${ROOT_SECTORS}
525 dd if=/dev/zero of="$IMAGE_NAME-frmw.img" bs=512 count=${TABLE_SECTORS}
526 dd if=/dev/zero of="$IMAGE_NAME-frmw.img" bs=512 count=0 seek=${FRMW_SECTORS}
527 dd if=/dev/zero of="$IMAGE_NAME-root.img" bs=512 count=${TABLE_SECTORS}
528 dd if=/dev/zero of="$IMAGE_NAME-root.img" bs=512 count=0 seek=${ROOT_SECTORS}
529 529
530 530 # Write firmware/boot partition tables
531 sfdisk -q -L -uS -f "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img" 2> /dev/null <<EOM
531 sfdisk -q -L -uS -f "$IMAGE_NAME-frmw.img" 2> /dev/null <<EOM
532 532 ${TABLE_SECTORS},${FRMW_SECTORS},c,*
533 533 EOM
534 534
535 535 # Write root partition table
536 sfdisk -q -L -uS -f "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img" 2> /dev/null <<EOM
536 sfdisk -q -L -uS -f "$IMAGE_NAME-root.img" 2> /dev/null <<EOM
537 537 ${TABLE_SECTORS},${ROOT_SECTORS},83
538 538 EOM
539 539
540 540 # Setup temporary loop devices
541 FRMW_LOOP="$(losetup -o 1M --sizelimit 64M -f --show $BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img)"
542 ROOT_LOOP="$(losetup -o 1M -f --show $BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img)"
541 FRMW_LOOP="$(losetup -o 1M --sizelimit 64M -f --show $IMAGE_NAME-frmw.img)"
542 ROOT_LOOP="$(losetup -o 1M -f --show $IMAGE_NAME-root.img)"
543 543 else # ENABLE_SPLITFS=false
544 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img" bs=512 count=${TABLE_SECTORS}
545 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img" bs=512 count=0 seek=${IMAGE_SECTORS}
544 dd if=/dev/zero of="$IMAGE_NAME.img" bs=512 count=${TABLE_SECTORS}
545 dd if=/dev/zero of="$IMAGE_NAME.img" bs=512 count=0 seek=${IMAGE_SECTORS}
546 546
547 547 # Write partition table
548 sfdisk -q -L -uS -f "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img" 2> /dev/null <<EOM
548 sfdisk -q -L -uS -f "$IMAGE_NAME.img" 2> /dev/null <<EOM
549 549 ${TABLE_SECTORS},${FRMW_SECTORS},c,*
550 550 ${ROOT_OFFSET},${ROOT_SECTORS},83
551 551 EOM
552 552
553 553 # Setup temporary loop devices
554 FRMW_LOOP="$(losetup -o 1M --sizelimit 64M -f --show $BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img)"
555 ROOT_LOOP="$(losetup -o 65M -f --show $BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img)"
554 FRMW_LOOP="$(losetup -o 1M --sizelimit 64M -f --show $IMAGE_NAME.img)"
555 ROOT_LOOP="$(losetup -o 65M -f --show $IMAGE_NAME.img)"
556 556 fi
557 557
558 558 if [ "$ENABLE_CRYPTFS" = true ] ; then
559 559 # Create dummy ext4 fs
560 560 mkfs.ext4 "$ROOT_LOOP"
561 561
562 562 # Setup password keyfile
563 563 echo -n ${CRYPTFS_PASSWORD} > .password
564 564 chmod 600 .password
565 565
566 566 # Initialize encrypted partition
567 567 echo "YES" | cryptsetup luksFormat "${ROOT_LOOP}" -c "${CRYPTFS_CIPHER}" -s "${CRYPTFS_XTSKEYSIZE}" .password
568 568
569 569 # Open encrypted partition and setup mapping
570 570 cryptsetup luksOpen "${ROOT_LOOP}" -d .password "${CRYPTFS_MAPPING}"
571 571
572 572 # Secure delete password keyfile
573 573 shred -zu .password
574 574
575 575 # Update temporary loop device
576 576 ROOT_LOOP="/dev/mapper/${CRYPTFS_MAPPING}"
577 577
578 578 # Wipe encrypted partition (encryption cipher is used for randomness)
579 579 dd if=/dev/zero of="${ROOT_LOOP}" bs=512 count=$(blockdev --getsz "${ROOT_LOOP}")
580 580 fi
581 581
582 582 # Build filesystems
583 583 mkfs.vfat "$FRMW_LOOP"
584 584 mkfs.ext4 "$ROOT_LOOP"
585 585
586 586 # Mount the temporary loop devices
587 587 mkdir -p "$BUILDDIR/mount"
588 588 mount "$ROOT_LOOP" "$BUILDDIR/mount"
589 589
590 590 mkdir -p "$BUILDDIR/mount/boot/firmware"
591 591 mount "$FRMW_LOOP" "$BUILDDIR/mount/boot/firmware"
592 592
593 593 # Copy all files from the chroot to the loop device mount point directory
594 594 rsync -a "${R}/" "$BUILDDIR/mount/"
595 595
596 596 # Unmount all temporary loop devices and mount points
597 597 cleanup
598 598
599 599 # Create block map file(s) of image(s)
600 600 if [ "$ENABLE_SPLITFS" = true ] ; then
601 601 # Create block map files for "bmaptool"
602 bmaptool create -o "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.bmap" "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img"
603 bmaptool create -o "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.bmap" "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img"
602 bmaptool create -o "$IMAGE_NAME-frmw.bmap" "$IMAGE_NAME-frmw.img"
603 bmaptool create -o "$IMAGE_NAME-root.bmap" "$IMAGE_NAME-root.img"
604 604
605 605 # Image was successfully created
606 echo "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img ($(expr \( ${TABLE_SECTORS} + ${FRMW_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
607 echo "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img ($(expr \( ${TABLE_SECTORS} + ${ROOT_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
606 echo "$IMAGE_NAME-frmw.img ($(expr \( ${TABLE_SECTORS} + ${FRMW_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
607 echo "$IMAGE_NAME-root.img ($(expr \( ${TABLE_SECTORS} + ${ROOT_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
608 608 else
609 609 # Create block map file for "bmaptool"
610 bmaptool create -o "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.bmap" "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img"
610 bmaptool create -o "$IMAGE_NAME.bmap" "$IMAGE_NAME.img"
611 611
612 612 # Image was successfully created
613 echo "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img ($(expr \( ${TABLE_SECTORS} + ${FRMW_SECTORS} + ${ROOT_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
613 echo "$IMAGE_NAME.img ($(expr \( ${TABLE_SECTORS} + ${FRMW_SECTORS} + ${ROOT_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
614 614 fi
General Comments 0
Vous devez vous connecter pour laisser un commentaire. Se connecter maintenant