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

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

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