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

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

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