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

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

fix: QEMU default value typo
drtyhlpr -
r264:03e1b7cf07cf
parent child
Show More
Show file before | Show file after | Hide comments
@@ -1,485 +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
103 ##### `ENABLE_QEMU`=false
104 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 105
106 106 ---
107 107
108 108 #### Keyboard settings:
109 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.
110 110
111 111 ##### `XKB_MODEL`=""
112 112 Set the name of the model of your keyboard type.
113 113
114 114 ##### `XKB_LAYOUT`=""
115 115 Set the supported keyboard layout(s).
116 116
117 117 ##### `XKB_VARIANT`=""
118 118 Set the supported variant(s) of the keyboard layout(s).
119 119
120 120 ##### `XKB_OPTIONS`=""
121 121 Set extra xkb configuration options.
122 122
123 123 ---
124 124
125 125 #### Networking settings (DHCP):
126 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`.`
127 127
128 128 ##### `ENABLE_DHCP`=true
129 129 Set the system to use DHCP. This requires an DHCP server.
130 130
131 131 ---
132 132
133 133 #### Networking settings (static):
134 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`.
135 135
136 136 ##### `NET_ADDRESS`=""
137 137 Set a static IPv4 or IPv6 address and its prefix, separated by "/", eg. "192.169.0.3/24".
138 138
139 139 ##### `NET_GATEWAY`=""
140 140 Set the IP address for the default gateway.
141 141
142 142 ##### `NET_DNS_1`=""
143 143 Set the IP address for the first DNS server.
144 144
145 145 ##### `NET_DNS_2`=""
146 146 Set the IP address for the second DNS server.
147 147
148 148 ##### `NET_DNS_DOMAINS`=""
149 149 Set the default DNS search domains to use for non fully qualified host names.
150 150
151 151 ##### `NET_NTP_1`=""
152 152 Set the IP address for the first NTP server.
153 153
154 154 ##### `NET_NTP_2`=""
155 155 Set the IP address for the second NTP server.
156 156
157 157 ---
158 158
159 159 #### Basic system features:
160 160 ##### `ENABLE_CONSOLE`=true
161 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.
162 162
163 163 ##### `ENABLE_I2C`=false
164 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.
165 165
166 166 ##### `ENABLE_SPI`=false
167 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.
168 168
169 169 ##### `ENABLE_IPV6`=true
170 170 Enable IPv6 support. The network interface configuration is managed via systemd-networkd.
171 171
172 172 ##### `ENABLE_SSHD`=true
173 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.
174 174
175 175 ##### `ENABLE_NONFREE`=false
176 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.
177 177
178 178 ##### `ENABLE_WIRELESS`=false
179 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`.
180 180
181 181 ##### `ENABLE_RSYSLOG`=true
182 182 If set to false, disable and uninstall rsyslog (so logs will be available only
183 183 in journal files)
184 184
185 185 ##### `ENABLE_SOUND`=true
186 186 Enable sound hardware and install Advanced Linux Sound Architecture.
187 187
188 188 ##### `ENABLE_HWRANDOM`=true
189 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.
190 190
191 191 ##### `ENABLE_MINGPU`=false
192 192 Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU.
193 193
194 194 ##### `ENABLE_DBUS`=true
195 195 Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled.
196 196
197 197 ##### `ENABLE_XORG`=false
198 198 Install Xorg open-source X Window System.
199 199
200 200 ##### `ENABLE_WM`=""
201 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`.
202 202
203 203 ---
204 204
205 205 #### Advanced system features:
206 206 ##### `ENABLE_MINBASE`=false
207 207 Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
208 208
209 209 ##### `ENABLE_REDUCE`=false
210 210 Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.
211 211
212 212 ##### `ENABLE_UBOOT`=false
213 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.
214 214
215 215 ##### `UBOOTSRC_DIR`=""
216 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.
217 217
218 218 ##### `ENABLE_FBTURBO`=false
219 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.
220 220
221 221 ##### `FBTURBOSRC_DIR`=""
222 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.
223 223
224 224 ##### `ENABLE_IPTABLES`=false
225 225 Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.
226 226
227 227 ##### `ENABLE_USER`=true
228 228 Create non-root user with password `USER_PASSWORD`=raspberry. Unless overridden with `USER_NAME`=user, username will be `pi`.
229 229
230 230 ##### `USER_NAME`=pi
231 231 Non-root user to create. Ignored if `ENABLE_USER`=false
232 232
233 233 ##### `ENABLE_ROOT`=false
234 234 Set root user password so root login will be enabled
235 235
236 236 ##### `ENABLE_HARDNET`=false
237 237 Enable IPv4/IPv6 network stack hardening settings.
238 238
239 239 ##### `ENABLE_SPLITFS`=false
240 240 Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.
241 241
242 242 ##### `CHROOT_SCRIPTS`=""
243 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.
244 244
245 245 ##### `ENABLE_INITRAMFS`=false
246 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.
247 247
248 248 ##### `ENABLE_IFNAMES`=true
249 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.
250 250
251 251 ##### `DISABLE_UNDERVOLT_WARNINGS`=
252 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.
253 253
254 254 ---
255 255
256 256 #### SSH settings:
257 257 ##### `SSH_ENABLE_ROOT`=false
258 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`.
259 259
260 260 ##### `SSH_DISABLE_PASSWORD_AUTH`=false
261 261 Disable password based SSH authentication. Only public key based SSH (v2) authentication will be supported.
262 262
263 263 ##### `SSH_LIMIT_USERS`=false
264 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).
265 265
266 266 ##### `SSH_ROOT_PUB_KEY`=""
267 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`.
268 268
269 269 ##### `SSH_USER_PUB_KEY`=""
270 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.
271 271
272 272 ---
273 273
274 274 #### Kernel compilation:
275 275 ##### `BUILD_KERNEL`=false
276 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.
277 277
278 278 ##### `CROSS_COMPILE`="arm-linux-gnueabihf-"
279 279 This sets the cross compile enviornment for the compiler.
280 280
281 281 ##### `KERNEL_ARCH`="arm"
282 282 This sets the kernel architecture for the compiler.
283 283
284 284 ##### `KERNEL_IMAGE`="kernel7.img"
285 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.
286 286
287 287 ##### `KERNEL_BRANCH`=""
288 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.
289 289
290 290 ##### `QEMU_BINARY`="/usr/bin/qemu-arm-static"
291 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.
292 292
293 293 ##### `KERNEL_DEFCONFIG`="bcm2709_defconfig"
294 294 Sets the default config for kernel compiling. If not set, `KERNEL_DEFCONFIG` will be set to "bcmrpi3\_defconfig" automatically if building for arm64.
295 295
296 296 ##### `KERNEL_REDUCE`=false
297 297 Reduce the size of the generated kernel by removing unwanted device, network and filesystem drivers (experimental).
298 298
299 299 ##### `KERNEL_THREADS`=1
300 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.
301 301
302 302 ##### `KERNEL_HEADERS`=true
303 303 Install kernel headers with built kernel.
304 304
305 305 ##### `KERNEL_MENUCONFIG`=false
306 306 Start `make menuconfig` interactive menu-driven kernel configuration. The script will continue after `make menuconfig` was terminated.
307 307
308 308 ##### `KERNEL_OLDDEFCONFIG`=false
309 309 Run `make olddefconfig` to automatically set all new kernel configuration options to their recommended default values.
310 310
311 311 ##### `KERNEL_CCACHE`=false
312 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.
313 313
314 314 ##### `KERNEL_REMOVESRC`=true
315 315 Remove all kernel sources from the generated OS image after it was built and installed.
316 316
317 317 ##### `KERNELSRC_DIR`=""
318 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.
319 319
320 320 ##### `KERNELSRC_CLEAN`=false
321 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.
322 322
323 323 ##### `KERNELSRC_CONFIG`=true
324 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.
325 325
326 326 ##### `KERNELSRC_USRCONFIG`=""
327 327 Copy own config file to kernel `.config`. If `KERNEL_MENUCONFIG`=true then running after copy.
328 328
329 329 ##### `KERNELSRC_PREBUILT`=false
330 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.
331 331
332 332 ##### `RPI_FIRMWARE_DIR`=""
333 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.
334 334
335 335 ---
336 336
337 337 #### Reduce disk usage:
338 338 The following list of parameters is ignored if `ENABLE_REDUCE`=false.
339 339
340 340 ##### `REDUCE_APT`=true
341 341 Configure APT to use compressed package repository lists and no package caching files.
342 342
343 343 ##### `REDUCE_DOC`=true
344 344 Remove all doc files (harsh). Configure APT to not include doc files on future `apt-get` package installations.
345 345
346 346 ##### `REDUCE_MAN`=true
347 347 Remove all man pages and info files (harsh). Configure APT to not include man pages on future `apt-get` package installations.
348 348
349 349 ##### `REDUCE_VIM`=false
350 350 Replace `vim-tiny` package by `levee` a tiny vim clone.
351 351
352 352 ##### `REDUCE_BASH`=false
353 353 Remove `bash` package and switch to `dash` shell (experimental).
354 354
355 355 ##### `REDUCE_HWDB`=true
356 356 Remove PCI related hwdb files (experimental).
357 357
358 358 ##### `REDUCE_SSHD`=true
359 359 Replace `openssh-server` with `dropbear`.
360 360
361 361 ##### `REDUCE_LOCALE`=true
362 362 Remove all `locale` translation files.
363 363
364 364 ---
365 365
366 366 #### Encrypted root partition:
367 367 ##### `ENABLE_CRYPTFS`=false
368 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.
369 369
370 370 ##### `CRYPTFS_PASSWORD`=""
371 371 Set password of the encrypted root partition. This parameter is mandatory if `ENABLE_CRYPTFS`=true.
372 372
373 373 ##### `CRYPTFS_MAPPING`="secure"
374 374 Set name of dm-crypt managed device-mapper mapping.
375 375
376 376 ##### `CRYPTFS_CIPHER`="aes-xts-plain64:sha512"
377 377 Set cipher specification string. `aes-xts*` ciphers are strongly recommended.
378 378
379 379 ##### `CRYPTFS_XTSKEYSIZE`=512
380 380 Sets key size in bits. The argument has to be a multiple of 8.
381 381
382 382 ---
383 383
384 384 #### Build settings:
385 385 ##### `BASEDIR`=$(pwd)/images/${RELEASE}
386 386 Set a path to a working directory used by the script to generate an image.
387 387
388 388 ##### `IMAGE_NAME`=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}
389 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.
390 390
391 391 ## Understanding the script
392 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:
393 393
394 394 | Script | Description |
395 395 | --- | --- |
396 396 | `10-bootstrap.sh` | Debootstrap basic system |
397 397 | `11-apt.sh` | Setup APT repositories |
398 398 | `12-locale.sh` | Setup Locales and keyboard settings |
399 399 | `13-kernel.sh` | Build and install RPi2/3 Kernel |
400 400 | `14-fstab.sh` | Setup fstab and initramfs |
401 401 | `15-rpi-config.sh` | Setup RPi2/3 config and cmdline |
402 402 | `20-networking.sh` | Setup Networking |
403 403 | `21-firewall.sh` | Setup Firewall |
404 404 | `30-security.sh` | Setup Users and Security settings |
405 405 | `31-logging.sh` | Setup Logging |
406 406 | `32-sshd.sh` | Setup SSH and public keys |
407 407 | `41-uboot.sh` | Build and Setup U-Boot |
408 408 | `42-fbturbo.sh` | Build and Setup fbturbo Xorg driver |
409 409 | `50-firstboot.sh` | First boot actions |
410 410 | `99-reduce.sh` | Reduce the disk space usage |
411 411
412 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.
413 413
414 414 | Directory | Description |
415 415 | --- | --- |
416 416 | `apt` | APT management configuration files |
417 417 | `boot` | Boot and RPi2/3 configuration files |
418 418 | `dpkg` | Package Manager configuration |
419 419 | `etc` | Configuration files and rc scripts |
420 420 | `firstboot` | Scripts that get executed on first boot |
421 421 | `initramfs` | Initramfs scripts |
422 422 | `iptables` | Firewall configuration files |
423 423 | `locales` | Locales configuration |
424 424 | `modules` | Kernel Modules configuration |
425 425 | `mount` | Fstab configuration |
426 426 | `network` | Networking configuration files |
427 427 | `sysctl.d` | Swapping and Network Hardening configuration |
428 428 | `xorg` | fbturbo Xorg driver configuration |
429 429
430 430 ## Custom packages and scripts
431 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`.
432 432
433 433 Scripts in the custom.d directory will be executed after all other installation is complete but before the image is created.
434 434
435 435 ## Logging of the bootstrapping process
436 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:
437 437
438 438 ```shell
439 439 script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log
440 440 ```
441 441
442 442 ## Flashing the image file
443 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`.
444 444
445 445 ##### Flashing examples:
446 446 ```shell
447 447 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie.img /dev/mmcblk0
448 448 dd bs=4M if=./images/jessie/2017-01-23-rpi3-jessie.img of=/dev/mmcblk0
449 449 ```
450 450 If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:
451 451 ```shell
452 452 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie-frmw.img /dev/mmcblk0
453 453 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie-root.img /dev/sdc
454 454 ```
455 455
456 456 ## QEMU emulation
457 457 Start QEMU full system emulation:
458 458 ```shell
459 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 460 ```
461 461
462 462 Start QEMU full system emulation and output to console:
463 463 ```shell
464 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 465 ```
466 466
467 467 Start QEMU full system emulation with cryptfs, initramfs and output to console:
468 468 ```shell
469 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 470 ```
471 471
472 472 ## Weekly image builds
473 473 The image files are provided by JRWR'S I/O PORT and are built once a Sunday at midnight UTC!
474 474 * [Debian Stretch Raspberry Pi2/3 Weekly Image Builds](https://jrwr.io/doku.php?id=projects:debianpi)
475 475
476 476 ## External links and references
477 477 * [Debian worldwide mirror sites](https://www.debian.org/mirror/list)
478 478 * [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)
479 479 * [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains)
480 480 * [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)
481 481 * [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)
482 482 * [U-BOOT git repository](https://git.denx.de/?p=u-boot.git;a=summary)
483 483 * [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)
484 484 * [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/brcm)
485 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