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

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

Merge branch 'master' into rpifegen
vidal -
r197:40d2d0cd1ed8 Fusion
parent child
Show More
Show file before | Show file after | Hide comments
@@ -1,452 +1,452
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 generated for 32-bit mode only. Raspberry Pi 3 64-bit images can be generated using custom configuration parameters (```templates/rpi3-stretch-arm64-4.11.y```).
4 4
5 5 ## Build dependencies
6 6 The following list of Debian packages must be installed on the build system because they are essentially required for the bootstrapping process. The script will check if all required packages are installed and missing packages will be installed automatically if confirmed by the user.
7 7
8 8 ```debootstrap debian-archive-keyring qemu-user-static binfmt-support dosfstools rsync bmap-tools whois git bc psmisc dbus sudo```
9 9
10 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.
10 It is recommended to configure the `rpi23-gen-image.sh` script to build and install the latest Raspberry Pi Linux kernel. For the RPi3 this is mandatory. Kernel compilation and linking will be performed on the build system using an ARM (armhf) cross-compiler toolchain.
11 11
12 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 by debootstrap during bootstrapping.
62 62
63 63 ##### `APT_INCLUDES_LATE`=""
64 64 A comma separated list of additional packages to be installed by apt after bootstrapping and after APT sources are set up. This is useful for packages with pre-depends, which debootstrap do not handle well.
65 65
66 66 ---
67 67
68 68 #### General system settings:
69 69 ##### `RPI_MODEL`=2
70 70 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.
71 71
72 72 ##### `RELEASE`="jessie"
73 73 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.
74 74
75 75 ##### `RELEASE_ARCH`="armhf"
76 76 Set the desired Debian release architecture.
77 77
78 78 ##### `HOSTNAME`="rpi$RPI_MODEL-$RELEASE"
79 79 Set system host name. It's recommended that the host name is unique in the corresponding subnet.
80 80
81 81 ##### `PASSWORD`="raspberry"
82 82 Set system `root` password. It's **STRONGLY** recommended that you choose a custom password.
83 83
84 84 ##### `USER_PASSWORD`="raspberry"
85 85 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.
86 86
87 87 ##### `DEFLOCAL`="en_US.UTF-8"
88 88 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`.
89 89
90 90 ##### `TIMEZONE`="Europe/Berlin"
91 91 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.
92 92
93 93 ##### `EXPANDROOT`=true
94 94 Expand the root partition and filesystem automatically on first boot.
95 95
96 96 ---
97 97
98 98 #### Keyboard settings:
99 99 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.
100 100
101 101 ##### `XKB_MODEL`=""
102 102 Set the name of the model of your keyboard type.
103 103
104 104 ##### `XKB_LAYOUT`=""
105 105 Set the supported keyboard layout(s).
106 106
107 107 ##### `XKB_VARIANT`=""
108 108 Set the supported variant(s) of the keyboard layout(s).
109 109
110 110 ##### `XKB_OPTIONS`=""
111 111 Set extra xkb configuration options.
112 112
113 113 ---
114 114
115 115 #### Networking settings (DHCP):
116 116 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`.`
117 117
118 118 ##### `ENABLE_DHCP`=true
119 119 Set the system to use DHCP. This requires an DHCP server.
120 120
121 121 ---
122 122
123 123 #### Networking settings (static):
124 124 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`.
125 125
126 126 ##### `NET_ADDRESS`=""
127 127 Set a static IPv4 or IPv6 address and its prefix, separated by "/", eg. "192.169.0.3/24".
128 128
129 129 ##### `NET_GATEWAY`=""
130 130 Set the IP address for the default gateway.
131 131
132 132 ##### `NET_DNS_1`=""
133 133 Set the IP address for the first DNS server.
134 134
135 135 ##### `NET_DNS_2`=""
136 136 Set the IP address for the second DNS server.
137 137
138 138 ##### `NET_DNS_DOMAINS`=""
139 139 Set the default DNS search domains to use for non fully qualified host names.
140 140
141 141 ##### `NET_NTP_1`=""
142 142 Set the IP address for the first NTP server.
143 143
144 144 ##### `NET_NTP_2`=""
145 145 Set the IP address for the second NTP server.
146 146
147 147 ---
148 148
149 149 #### Basic system features:
150 150 ##### `ENABLE_CONSOLE`=true
151 151 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.
152 152
153 153 ##### `ENABLE_I2C`=false
154 154 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.
155 155
156 156 ##### `ENABLE_SPI`=false
157 157 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.
158 158
159 159 ##### `ENABLE_IPV6`=true
160 160 Enable IPv6 support. The network interface configuration is managed via systemd-networkd.
161 161
162 162 ##### `ENABLE_SSHD`=true
163 163 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.
164 164
165 165 ##### `ENABLE_NONFREE`=false
166 166 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.
167 167
168 168 ##### `ENABLE_WIRELESS`=false
169 169 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`.
170 170
171 171 ##### `ENABLE_RSYSLOG`=true
172 172 If set to false, disable and uninstall rsyslog (so logs will be available only
173 173 in journal files)
174 174
175 175 ##### `ENABLE_SOUND`=true
176 176 Enable sound hardware and install Advanced Linux Sound Architecture.
177 177
178 178 ##### `ENABLE_HWRANDOM`=true
179 179 Enable Hardware Random Number Generator. Strong random numbers are important for most network based communications that use encryption. It's recommended to be enabled.
180 180
181 181 ##### `ENABLE_MINGPU`=false
182 182 Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU.
183 183
184 184 ##### `ENABLE_DBUS`=true
185 185 Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled.
186 186
187 187 ##### `ENABLE_XORG`=false
188 188 Install Xorg open-source X Window System.
189 189
190 190 ##### `ENABLE_WM`=""
191 191 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`.
192 192
193 193 ---
194 194
195 195 #### Advanced system features:
196 196 ##### `ENABLE_MINBASE`=false
197 197 Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
198 198
199 199 ##### `ENABLE_REDUCE`=false
200 200 Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.
201 201
202 202 ##### `ENABLE_UBOOT`=false
203 203 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.
204 204
205 205 ##### `UBOOTSRC_DIR`=""
206 206 Path to a directory (`u-boot`) 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.
207 207
208 208 ##### `ENABLE_FBTURBO`=false
209 209 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.
210 210
211 211 ##### `FBTURBOSRC_DIR`=""
212 212 Path to a directory (`xf86-video-fbturbo`) of [hardware accelerated Xorg video driver sources](https://github.com/ssvb/xf86-video-fbturbo) that will be copied, configured, build and installed inside the chroot.
213 213
214 214 ##### `ENABLE_IPTABLES`=false
215 215 Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.
216 216
217 217 ##### `ENABLE_USER`=true
218 218 Create non-root user with password `USER_PASSWORD`=raspberry. Unless overridden with `USER_NAME`=user, username will be `pi`.
219 219
220 220 ##### `USER_NAME`=pi
221 221 Non-root user to create. Ignored if `ENABLE_USER`=false
222 222
223 223 ##### `ENABLE_ROOT`=false
224 224 Set root user password so root login will be enabled
225 225
226 226 ##### `ENABLE_HARDNET`=false
227 227 Enable IPv4/IPv6 network stack hardening settings.
228 228
229 229 ##### `ENABLE_SPLITFS`=false
230 230 Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.
231 231
232 232 ##### `CHROOT_SCRIPTS`=""
233 233 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.
234 234
235 235 ##### `ENABLE_INITRAMFS`=false
236 236 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.
237 237
238 238 ##### `ENABLE_IFNAMES`=true
239 239 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.
240 240
241 241 ##### `DISABLE_UNDERVOLT_WARNINGS`=
242 242 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.
243 243
244 244 ---
245 245
246 246 #### SSH settings:
247 247 ##### `SSH_ENABLE_ROOT`=false
248 248 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`.
249 249
250 250 ##### `SSH_DISABLE_PASSWORD_AUTH`=false
251 251 Disable password based SSH authentication. Only public key based SSH (v2) authentication will be supported.
252 252
253 253 ##### `SSH_LIMIT_USERS`=false
254 254 Limit the users that are allowed to login via SSH. Only allow user `USER_NAME`=pi and root if `SSH_ENABLE_ROOT`=true to login. This parameter will be ignored if `dropbear` SSH is used (`REDUCE_SSHD`=true).
255 255
256 256 ##### `SSH_ROOT_PUB_KEY`=""
257 257 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`.
258 258
259 259 ##### `SSH_USER_PUB_KEY`=""
260 260 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.
261 261
262 262 ---
263 263
264 264 #### Kernel compilation:
265 265 ##### `BUILD_KERNEL`=false
266 266 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.
267 267
268 268 ##### `CROSS_COMPILE`="arm-linux-gnueabihf-"
269 269 This sets the cross compile enviornment for the compiler.
270 270
271 271 ##### `KERNEL_ARCH`="arm"
272 272 This sets the kernel architecture for the compiler.
273 273
274 274 ##### `KERNEL_IMAGE`="kernel7.img"
275 275 Name of the image file in the boot partition. If not set, `KERNEL_IMAGE` will be set to "kernel8.img" automatically if building for arm64.
276 276
277 277 ##### `KERNEL_BRANCH`=""
278 278 Name of the requested branch from the GIT location for the RPi Kernel. Default is using the current default branch from the GIT site.
279 279
280 280 ##### `QEMU_BINARY`="/usr/bin/qemu-arm-static"
281 281 Sets the QEMU enviornment for the Debian archive. If not set, `QEMU_BINARY` will be set to "/usr/bin/qemu-aarch64-static" automatically if building for arm64.
282 282
283 283 ##### `KERNEL_DEFCONFIG`="bcm2709_defconfig"
284 284 Sets the default config for kernel compiling. If not set, `KERNEL_DEFCONFIG` will be set to "bcmrpi3\_defconfig" automatically if building for arm64.
285 285
286 286 ##### `KERNEL_REDUCE`=false
287 287 Reduce the size of the generated kernel by removing unwanted device, network and filesystem drivers (experimental).
288 288
289 289 ##### `KERNEL_THREADS`=1
290 290 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.
291 291
292 292 ##### `KERNEL_HEADERS`=true
293 293 Install kernel headers with built kernel.
294 294
295 295 ##### `KERNEL_MENUCONFIG`=false
296 296 Start `make menuconfig` interactive menu-driven kernel configuration. The script will continue after `make menuconfig` was terminated.
297 297
298 298 ##### `KERNEL_REMOVESRC`=true
299 299 Remove all kernel sources from the generated OS image after it was built and installed.
300 300
301 301 ##### `KERNELSRC_DIR`=""
302 302 Path to a directory (`linux`) of [RaspberryPi Linux kernel sources](https://github.com/raspberrypi/linux) that will be copied, configured, build and installed inside the chroot.
303 303
304 304 ##### `KERNELSRC_CLEAN`=false
305 305 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.
306 306
307 307 ##### `KERNELSRC_CONFIG`=true
308 308 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.
309 309
310 310 ##### `KERNELSRC_USRCONFIG`=""
311 311 Copy own config file to kernel `.config`. If `KERNEL_MENUCONFIG`=true then running after copy.
312 312
313 313 ##### `KERNELSRC_PREBUILT`=false
314 314 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.
315 315
316 316 ##### `RPI_FIRMWARE_DIR`=""
317 317 The directory (`firmware`) containing a local copy of the firmware from the [RaspberryPi firmware project](https://github.com/raspberrypi/firmware). Default is to download the latest firmware directly from the project.
318 318
319 319 ---
320 320
321 321 #### Reduce disk usage:
322 322 The following list of parameters is ignored if `ENABLE_REDUCE`=false.
323 323
324 324 ##### `REDUCE_APT`=true
325 325 Configure APT to use compressed package repository lists and no package caching files.
326 326
327 327 ##### `REDUCE_DOC`=true
328 328 Remove all doc files (harsh). Configure APT to not include doc files on future `apt-get` package installations.
329 329
330 330 ##### `REDUCE_MAN`=true
331 331 Remove all man pages and info files (harsh). Configure APT to not include man pages on future `apt-get` package installations.
332 332
333 333 ##### `REDUCE_VIM`=false
334 334 Replace `vim-tiny` package by `levee` a tiny vim clone.
335 335
336 336 ##### `REDUCE_BASH`=false
337 337 Remove `bash` package and switch to `dash` shell (experimental).
338 338
339 339 ##### `REDUCE_HWDB`=true
340 340 Remove PCI related hwdb files (experimental).
341 341
342 342 ##### `REDUCE_SSHD`=true
343 343 Replace `openssh-server` with `dropbear`.
344 344
345 345 ##### `REDUCE_LOCALE`=true
346 346 Remove all `locale` translation files.
347 347
348 348 ---
349 349
350 350 #### Encrypted root partition:
351 351 ##### `ENABLE_CRYPTFS`=false
352 352 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.
353 353
354 354 ##### `CRYPTFS_PASSWORD`=""
355 355 Set password of the encrypted root partition. This parameter is mandatory if `ENABLE_CRYPTFS`=true.
356 356
357 357 ##### `CRYPTFS_MAPPING`="secure"
358 358 Set name of dm-crypt managed device-mapper mapping.
359 359
360 360 ##### `CRYPTFS_CIPHER`="aes-xts-plain64:sha512"
361 361 Set cipher specification string. `aes-xts*` ciphers are strongly recommended.
362 362
363 363 ##### `CRYPTFS_XTSKEYSIZE`=512
364 364 Sets key size in bits. The argument has to be a multiple of 8.
365 365
366 366 ---
367 367
368 368 #### Build settings:
369 369 ##### `BASEDIR`=$(pwd)/images/${RELEASE}
370 370 Set a path to a working directory used by the script to generate an image.
371 371
372 372 ##### `IMAGE_NAME`=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}
373 373 Set a filename for the output file(s). Note: the script will create $IMAGE_NAME.img if `ENABLE_SPLITFS`=false or $IMAGE_NAME-frmw.img and $IMAGE_NAME-root.img if `ENABLE_SPLITFS`=true. Note 2: If the KERNEL_BRANCH is not set, the word "CURRENT" is used.
374 374
375 375 ## Understanding the script
376 376 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:
377 377
378 378 | Script | Description |
379 379 | --- | --- |
380 380 | `10-bootstrap.sh` | Debootstrap basic system |
381 381 | `11-apt.sh` | Setup APT repositories |
382 382 | `12-locale.sh` | Setup Locales and keyboard settings |
383 383 | `13-kernel.sh` | Build and install RPi2/3 Kernel |
384 384 | `14-fstab.sh` | Setup fstab and initramfs |
385 385 | `15-rpi-config.sh` | Setup RPi2/3 config and cmdline |
386 386 | `20-networking.sh` | Setup Networking |
387 387 | `21-firewall.sh` | Setup Firewall |
388 388 | `30-security.sh` | Setup Users and Security settings |
389 389 | `31-logging.sh` | Setup Logging |
390 390 | `32-sshd.sh` | Setup SSH and public keys |
391 391 | `41-uboot.sh` | Build and Setup U-Boot |
392 392 | `42-fbturbo.sh` | Build and Setup fbturbo Xorg driver |
393 393 | `50-firstboot.sh` | First boot actions |
394 394 | `99-reduce.sh` | Reduce the disk space usage |
395 395
396 396 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.
397 397
398 398 | Directory | Description |
399 399 | --- | --- |
400 400 | `apt` | APT management configuration files |
401 401 | `boot` | Boot and RPi2/3 configuration files |
402 402 | `dpkg` | Package Manager configuration |
403 403 | `etc` | Configuration files and rc scripts |
404 404 | `firstboot` | Scripts that get executed on first boot |
405 405 | `initramfs` | Initramfs scripts |
406 406 | `iptables` | Firewall configuration files |
407 407 | `locales` | Locales configuration |
408 408 | `modules` | Kernel Modules configuration |
409 409 | `mount` | Fstab configuration |
410 410 | `network` | Networking configuration files |
411 411 | `sysctl.d` | Swapping and Network Hardening configuration |
412 412 | `xorg` | fbturbo Xorg driver configuration |
413 413
414 414 ## Custom packages and scripts
415 415 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`.
416 416
417 417 Scripts in the custom.d directory will be executed after all other installation is complete but before the image is created.
418 418
419 419 ## Logging of the bootstrapping process
420 420 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:
421 421
422 422 ```shell
423 423 script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log
424 424 ```
425 425
426 426 ## Flashing the image file
427 427 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`.
428 428
429 429 ##### Flashing examples:
430 430 ```shell
431 431 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie.img /dev/mmcblk0
432 432 dd bs=4M if=./images/jessie/2017-01-23-rpi3-jessie.img of=/dev/mmcblk0
433 433 ```
434 434 If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:
435 435 ```shell
436 436 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie-frmw.img /dev/mmcblk0
437 437 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie-root.img /dev/sdc
438 438 ```
439 439 ## Weekly image builds
440 440 The image files are provided by JRWR'S I/O PORT and are built once a Sunday at midnight UTC!
441 441 * [Debian Stretch Raspberry Pi2/3 Weekly Image Builds](https://jrwr.io/doku.php?id=projects:debianpi)
442 442
443 443 ## External links and references
444 444 * [Debian worldwide mirror sites](https://www.debian.org/mirror/list)
445 445 * [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)
446 446 * [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains)
447 447 * [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)
448 448 * [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)
449 449 * [U-BOOT git repository](http://git.denx.de/?p=u-boot.git;a=summary)
450 450 * [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)
451 451 * [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/brcm)
452 452 * [Collabora RPi2 Kernel precompiled](https://repositories.collabora.co.uk/debian/)
Show file before | Show file after | Hide comments
@@ -1,183 +1,183
1 1 #
2 2 # Build and Setup RPi2/3 Kernel
3 3 #
4 4
5 5 # Load utility functions
6 6 . ./functions.sh
7 7
8 8 # Fetch and build latest raspberry kernel
9 9 if [ "$BUILD_KERNEL" = true ] ; then
10 10 # Setup source directory
11 mkdir -p "${R}/usr/src"
11 mkdir -p "${R}/usr/src/linux"
12 12
13 13 # Copy existing kernel sources into chroot directory
14 14 if [ -n "$KERNELSRC_DIR" ] && [ -d "$KERNELSRC_DIR" ] ; then
15 15 # Copy kernel sources
16 cp -r "${KERNELSRC_DIR}" "${R}/usr/src"
16 cp -r "${KERNELSRC_DIR}/*" "${R}/usr/src/linux"
17 17
18 18 # Clean the kernel sources
19 19 if [ "$KERNELSRC_CLEAN" = true ] && [ "$KERNELSRC_PREBUILT" = false ] ; then
20 20 make -C "${KERNEL_DIR}" ARCH="${KERNEL_ARCH}" CROSS_COMPILE="${CROSS_COMPILE}" mrproper
21 21 fi
22 22 else # KERNELSRC_DIR=""
23 23 # Create temporary directory for kernel sources
24 24 temp_dir=$(as_nobody mktemp -d)
25 25
26 26 # Fetch current RPi2/3 kernel sources
27 27 if [ -z "${KERNEL_BRANCH}" ] ; then
28 as_nobody -u nobody git -C "${temp_dir}" clone --depth=1 "${KERNEL_URL}"
28 as_nobody -u nobody git -C "${temp_dir}" clone --depth=1 "${KERNEL_URL}" linux
29 29 else
30 as_nobody -u nobody git -C "${temp_dir}" clone --depth=1 --branch "${KERNEL_BRANCH}" "${KERNEL_URL}"
30 as_nobody -u nobody git -C "${temp_dir}" clone --depth=1 --branch "${KERNEL_BRANCH}" "${KERNEL_URL}" linux
31 31 fi
32 32
33 33 # Copy downloaded kernel sources
34 mv "${temp_dir}/linux" "${R}/usr/src/"
34 mv "${temp_dir}/linux/*" "${R}/usr/src/linux/"
35 35
36 36 # Remove temporary directory for kernel sources
37 37 rm -fr "${temp_dir}"
38 38
39 39 # Set permissions of the kernel sources
40 40 chown -R root:root "${R}/usr/src"
41 41 fi
42 42
43 43 # Calculate optimal number of kernel building threads
44 44 if [ "$KERNEL_THREADS" = "1" ] && [ -r /proc/cpuinfo ] ; then
45 45 KERNEL_THREADS=$(grep -c processor /proc/cpuinfo)
46 46 fi
47 47
48 48 # Configure and build kernel
49 49 if [ "$KERNELSRC_PREBUILT" = false ] ; then
50 50 # Remove device, network and filesystem drivers from kernel configuration
51 51 if [ "$KERNEL_REDUCE" = true ] ; then
52 52 make -C "${KERNEL_DIR}" ARCH="${KERNEL_ARCH}" CROSS_COMPILE="${CROSS_COMPILE}" "${KERNEL_DEFCONFIG}"
53 53 sed -i\
54 54 -e "s/\(^CONFIG_SND.*\=\).*/\1n/"\
55 55 -e "s/\(^CONFIG_SOUND.*\=\).*/\1n/"\
56 56 -e "s/\(^CONFIG_AC97.*\=\).*/\1n/"\
57 57 -e "s/\(^CONFIG_VIDEO_.*\=\).*/\1n/"\
58 58 -e "s/\(^CONFIG_MEDIA_TUNER.*\=\).*/\1n/"\
59 59 -e "s/\(^CONFIG_DVB.*\=\)[ym]/\1n/"\
60 60 -e "s/\(^CONFIG_REISERFS.*\=\).*/\1n/"\
61 61 -e "s/\(^CONFIG_JFS.*\=\).*/\1n/"\
62 62 -e "s/\(^CONFIG_XFS.*\=\).*/\1n/"\
63 63 -e "s/\(^CONFIG_GFS2.*\=\).*/\1n/"\
64 64 -e "s/\(^CONFIG_OCFS2.*\=\).*/\1n/"\
65 65 -e "s/\(^CONFIG_BTRFS.*\=\).*/\1n/"\
66 66 -e "s/\(^CONFIG_HFS.*\=\).*/\1n/"\
67 67 -e "s/\(^CONFIG_JFFS2.*\=\)[ym]/\1n/"\
68 68 -e "s/\(^CONFIG_UBIFS.*\=\).*/\1n/"\
69 69 -e "s/\(^CONFIG_SQUASHFS.*\=\)[ym]/\1n/"\
70 70 -e "s/\(^CONFIG_W1.*\=\)[ym]/\1n/"\
71 71 -e "s/\(^CONFIG_HAMRADIO.*\=\).*/\1n/"\
72 72 -e "s/\(^CONFIG_CAN.*\=\).*/\1n/"\
73 73 -e "s/\(^CONFIG_IRDA.*\=\).*/\1n/"\
74 74 -e "s/\(^CONFIG_BT_.*\=\).*/\1n/"\
75 75 -e "s/\(^CONFIG_WIMAX.*\=\)[ym]/\1n/"\
76 76 -e "s/\(^CONFIG_6LOWPAN.*\=\).*/\1n/"\
77 77 -e "s/\(^CONFIG_IEEE802154.*\=\).*/\1n/"\
78 78 -e "s/\(^CONFIG_NFC.*\=\).*/\1n/"\
79 79 -e "s/\(^CONFIG_FB_TFT=.*\=\).*/\1n/"\
80 80 -e "s/\(^CONFIG_TOUCHSCREEN.*\=\).*/\1n/"\
81 81 -e "s/\(^CONFIG_USB_GSPCA_.*\=\).*/\1n/"\
82 82 -e "s/\(^CONFIG_DRM.*\=\).*/\1n/"\
83 83 "${KERNEL_DIR}/.config"
84 84 fi
85 85
86 86 if [ "$KERNELSRC_CONFIG" = true ] ; then
87 87 # Load default raspberry kernel configuration
88 88 make -C "${KERNEL_DIR}" ARCH="${KERNEL_ARCH}" CROSS_COMPILE="${CROSS_COMPILE}" "${KERNEL_DEFCONFIG}"
89 89
90 90 if [ ! -z "$KERNELSRC_USRCONFIG" ] ; then
91 91 cp $KERNELSRC_USRCONFIG ${KERNEL_DIR}/.config
92 92 fi
93 93
94 94 # Start menu-driven kernel configuration (interactive)
95 95 if [ "$KERNEL_MENUCONFIG" = true ] ; then
96 96 make -C "${KERNEL_DIR}" ARCH="${KERNEL_ARCH}" CROSS_COMPILE="${CROSS_COMPILE}" menuconfig
97 97 fi
98 98 fi
99 99
100 100 # Cross compile kernel and modules
101 101 make -C "${KERNEL_DIR}" -j${KERNEL_THREADS} ARCH="${KERNEL_ARCH}" CROSS_COMPILE="${CROSS_COMPILE}" "${KERNEL_BIN_IMAGE}" modules dtbs
102 102 fi
103 103
104 104 # Check if kernel compilation was successful
105 105 if [ ! -r "${KERNEL_DIR}/arch/${KERNEL_ARCH}/boot/${KERNEL_BIN_IMAGE}" ] ; then
106 106 echo "error: kernel compilation failed! (kernel image not found)"
107 107 cleanup
108 108 exit 1
109 109 fi
110 110
111 111 # Install kernel modules
112 112 if [ "$ENABLE_REDUCE" = true ] ; then
113 113 make -C "${KERNEL_DIR}" ARCH="${KERNEL_ARCH}" CROSS_COMPILE="${CROSS_COMPILE}" INSTALL_MOD_STRIP=1 INSTALL_MOD_PATH=../../.. modules_install
114 114 else
115 115 make -C "${KERNEL_DIR}" ARCH="${KERNEL_ARCH}" CROSS_COMPILE="${CROSS_COMPILE}" INSTALL_MOD_PATH=../../.. modules_install
116 116
117 117 # Install kernel firmware
118 118 make -C "${KERNEL_DIR}" ARCH="${KERNEL_ARCH}" CROSS_COMPILE="${CROSS_COMPILE}" INSTALL_FW_PATH=../../../lib firmware_install
119 119 fi
120 120
121 121 # Install kernel headers
122 122 if [ "$KERNEL_HEADERS" = true ] && [ "$KERNEL_REDUCE" = false ] ; then
123 123 make -C "${KERNEL_DIR}" ARCH="${KERNEL_ARCH}" CROSS_COMPILE="${CROSS_COMPILE}" INSTALL_HDR_PATH=../.. headers_install
124 124 fi
125 125
126 126 # Prepare boot (firmware) directory
127 127 mkdir "${BOOT_DIR}"
128 128
129 129 # Get kernel release version
130 130 KERNEL_VERSION=`cat "${KERNEL_DIR}/include/config/kernel.release"`
131 131
132 132 # Copy kernel configuration file to the boot directory
133 133 install_readonly "${KERNEL_DIR}/.config" "${R}/boot/config-${KERNEL_VERSION}"
134 134
135 135 # Copy dts and dtb device tree sources and binaries
136 136 mkdir "${BOOT_DIR}/overlays"
137 137
138 138 # Ensure the proper .dtb is located
139 139 if [ "$KERNEL_ARCH" = "arm" ] ; then
140 140 install_readonly "${KERNEL_DIR}/arch/${KERNEL_ARCH}/boot/dts/"*.dtb "${BOOT_DIR}/"
141 141 else
142 142 install_readonly "${KERNEL_DIR}/arch/${KERNEL_ARCH}/boot/dts/broadcom/"*.dtb "${BOOT_DIR}/"
143 143 fi
144 144
145 145 install_readonly "${KERNEL_DIR}/arch/${KERNEL_ARCH}/boot/dts/overlays/"*.dtb* "${BOOT_DIR}/overlays/"
146 146 install_readonly "${KERNEL_DIR}/arch/${KERNEL_ARCH}/boot/dts/overlays/README" "${BOOT_DIR}/overlays/README"
147 147
148 148 if [ "$ENABLE_UBOOT" = false ] ; then
149 149 # Convert and copy kernel image to the boot directory
150 150 "${KERNEL_DIR}/scripts/mkknlimg" "${KERNEL_DIR}/arch/${KERNEL_ARCH}/boot/${KERNEL_BIN_IMAGE}" "${BOOT_DIR}/${KERNEL_IMAGE}"
151 151 else
152 152 # Copy kernel image to the boot directory
153 153 install_readonly "${KERNEL_DIR}/arch/${KERNEL_ARCH}/boot/${KERNEL_BIN_IMAGE}" "${BOOT_DIR}/${KERNEL_IMAGE}"
154 154 fi
155 155
156 156 # Remove kernel sources
157 157 if [ "$KERNEL_REMOVESRC" = true ] ; then
158 158 rm -fr "${KERNEL_DIR}"
159 159 else
160 160 make -C "${KERNEL_DIR}" ARCH="${KERNEL_ARCH}" CROSS_COMPILE="${CROSS_COMPILE}" modules_prepare
161 161
162 162 # Create symlinks for kernel modules
163 163 chroot_exec ln -sf /usr/src/linux "/lib/modules/${KERNEL_VERSION}/build"
164 164 chroot_exec ln -sf /usr/src/linux "/lib/modules/${KERNEL_VERSION}/source"
165 165 fi
166 166
167 167 else # BUILD_KERNEL=false
168 168 # Kernel installation
169 169 chroot_exec apt-get -qq -y --no-install-recommends install linux-image-"${COLLABORA_KERNEL}" raspberrypi-bootloader-nokernel
170 170
171 171 # Install flash-kernel last so it doesn't try (and fail) to detect the platform in the chroot
172 172 chroot_exec apt-get -qq -y install flash-kernel
173 173
174 174 # Check if kernel installation was successful
175 175 VMLINUZ="$(ls -1 ${R}/boot/vmlinuz-* | sort | tail -n 1)"
176 176 if [ -z "$VMLINUZ" ] ; then
177 177 echo "error: kernel installation failed! (/boot/vmlinuz-* not found)"
178 178 cleanup
179 179 exit 1
180 180 fi
181 181 # Copy vmlinuz kernel to the boot directory
182 182 install_readonly "${VMLINUZ}" "${BOOT_DIR}/${KERNEL_IMAGE}"
183 183 fi
General Comments 0
Vous devez vous connecter pour laisser un commentaire. Se connecter maintenant