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

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

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