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

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

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