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

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

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