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

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

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