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

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

Updated readme info about the build dependencies
drtyhlpr -
r113:12a0578e5f5f
parent child
Show More
Show file before | Show file after | Hide comments
@@ -1,339 +1,352
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```
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 mandetory. Kernel compilation and linking will be performed on the build system using an ARM (armhf) cross-compiler toolchain.
11
12 The script has been tested using the default `crossbuild-essential-armhf` toolchain meta package on Debian Linux `jessie` and `stretch` build systems. Please check the [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains) for futher information.
13
14 If a Debian Linux `jessie` build system is used it will be required to add the [Debian Cross-toolchains repository](http://emdebian.org/tools/debian/) first:
15
16 ```
17 echo "deb http://emdebian.org/tools/debian/ jessie main" > /etc/apt/sources.list.d/crosstools.list
18 sudo -u nobody wget -O - http://emdebian.org/tools/debian/emdebian-toolchain-archive.key | apt-key add -
19 dpkg --add-architecture armhf
20 apt-get update
21 ```
22
10 23 ## Command-line parameters
11 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.
12 25
13 26 #####Command-line examples:
14 27 ```shell
15 28 ENABLE_UBOOT=true ./rpi23-gen-image.sh
16 29 ENABLE_CONSOLE=false ENABLE_IPV6=false ./rpi23-gen-image.sh
17 30 ENABLE_WM=xfce4 ENABLE_FBTURBO=true ENABLE_MINBASE=true ./rpi23-gen-image.sh
18 31 ENABLE_HARDNET=true ENABLE_IPTABLES=true /rpi23-gen-image.sh
19 32 APT_SERVER=ftp.de.debian.org APT_PROXY="http://127.0.0.1:3142/" ./rpi23-gen-image.sh
20 33 ENABLE_MINBASE=true ./rpi23-gen-image.sh
21 34 BUILD_KERNEL=true ENABLE_MINBASE=true ENABLE_IPV6=false ./rpi23-gen-image.sh
22 35 BUILD_KERNEL=true KERNELSRC_DIR=/tmp/linux ./rpi23-gen-image.sh
23 36 ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh
24 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
25 38 RELEASE=stretch BUILD_KERNEL=true ./rpi23-gen-image.sh
26 39 RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
27 40 RELEASE=stretch RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
28 41 ```
29 42
30 43 #### APT settings:
31 44 ##### `APT_SERVER`="ftp.debian.org"
32 45 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.
33 46
34 47 ##### `APT_PROXY`=""
35 48 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.
36 49
37 50 ##### `APT_INCLUDES`=""
38 51 A comma separated list of additional packages to be installed during bootstrapping.
39 52
40 53 #### General system settings:
41 54 ##### `RPI_MODEL`=2
42 55 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.
43 56
44 57 ##### `RELEASE`="jessie"
45 58 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.
46 59
47 60 ##### `HOSTNAME`="rpi$RPI_MODEL-$RELEASE"
48 61 Set system host name. It's recommended that the host name is unique in the corresponding subnet.
49 62
50 63 ##### `PASSWORD`="raspberry"
51 64 Set system `root` password. The same password is used for the created user `pi`. It's **STRONGLY** recommended that you choose a custom password.
52 65
53 66 ##### `DEFLOCAL`="en_US.UTF-8"
54 67 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`.
55 68
56 69 ##### `TIMEZONE`="Europe/Berlin"
57 70 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.
58 71
59 72 ##### `EXPANDROOT`=true
60 73 Expand the root partition and filesystem automatically on first boot.
61 74
62 75 #### Keyboard settings:
63 76 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.
64 77
65 78 ##### `XKB_MODEL`=""
66 79 Set the name of the model of your keyboard type.
67 80
68 81 ##### `XKB_LAYOUT`=""
69 82 Set the supported keyboard layout(s).
70 83
71 84 ##### `XKB_VARIANT`=""
72 85 Set the supported variant(s) of the keyboard layout(s).
73 86
74 87 ##### `XKB_OPTIONS`=""
75 88 Set extra xkb configuration options.
76 89
77 90 #### Networking settings (DHCP):
78 91 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`.`
79 92
80 93 #####`ENABLE_DHCP`=true
81 94 Set the system to use DHCP. This requires an DHCP server.
82 95
83 96 #### Networking settings (static):
84 97 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`.
85 98
86 99 #####`NET_ADDRESS`=""
87 100 Set a static IPv4 or IPv6 address and its prefix, separated by "/", eg. "192.169.0.3/24".
88 101
89 102 #####`NET_GATEWAY`=""
90 103 Set the IP address for the default gateway.
91 104
92 105 #####`NET_DNS_1`=""
93 106 Set the IP address for the first DNS server.
94 107
95 108 #####`NET_DNS_2`=""
96 109 Set the IP address for the second DNS server.
97 110
98 111 #####`NET_DNS_DOMAINS`=""
99 112 Set the default DNS search domains to use for non fully qualified host names.
100 113
101 114 #####`NET_NTP_1`=""
102 115 Set the IP address for the first NTP server.
103 116
104 117 #####`NET_NTP_2`=""
105 118 Set the IP address for the second NTP server.
106 119
107 120 #### Basic system features:
108 121 ##### `ENABLE_CONSOLE`=true
109 122 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.
110 123
111 124 ##### `ENABLE_IPV6`=true
112 125 Enable IPv6 support. The network interface configuration is managed via systemd-networkd.
113 126
114 127 ##### `ENABLE_SSHD`=true
115 128 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.
116 129
117 130 ##### `ENABLE_NONFREE`=false
118 131 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.
119 132
120 133 ##### `ENABLE_WIRELESS`=false
121 134 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`.
122 135
123 136 ##### `ENABLE_RSYSLOG`=true
124 137 If set to false, disable and uninstall rsyslog (so logs will be available only
125 138 in journal files)
126 139
127 140 ##### `ENABLE_SOUND`=true
128 141 Enable sound hardware and install Advanced Linux Sound Architecture.
129 142
130 143 ##### `ENABLE_HWRANDOM`=true
131 144 Enable Hardware Random Number Generator. Strong random numbers are important for most network based communications that use encryption. It's recommended to be enabled.
132 145
133 146 ##### `ENABLE_MINGPU`=false
134 147 Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU.
135 148
136 149 ##### `ENABLE_DBUS`=true
137 150 Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled.
138 151
139 152 ##### `ENABLE_XORG`=false
140 153 Install Xorg open-source X Window System.
141 154
142 155 ##### `ENABLE_WM`=""
143 156 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`.
144 157
145 158 #### Advanced system features:
146 159 ##### `ENABLE_MINBASE`=false
147 160 Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
148 161
149 162 ##### `ENABLE_REDUCE`=false
150 163 Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.
151 164
152 165 ##### `ENABLE_UBOOT`=false
153 166 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.
154 167
155 168 ##### `ENABLE_FBTURBO`=false
156 169 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.
157 170
158 171 ##### `ENABLE_IPTABLES`=false
159 172 Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.
160 173
161 174 ##### `ENABLE_USER`=true
162 175 Create non-root user with password raspberry. Unless overridden with `USER_NAME`=user, username will be `pi`.
163 176
164 177 ##### `USER_NAME`=pi
165 178 Non-root user to create. Ignored if `ENABLE_USER`=false
166 179
167 180 ##### `ENABLE_ROOT`=false
168 181 Set root user password so root login will be enabled
169 182
170 183 ##### `ENABLE_ROOT_SSH`=true
171 184 Enable password root login via SSH. May be a security risk with default
172 185 password, use only in trusted environments.
173 186
174 187 ##### `ENABLE_HARDNET`=false
175 188 Enable IPv4/IPv6 network stack hardening settings.
176 189
177 190 ##### `ENABLE_SPLITFS`=false
178 191 Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.
179 192
180 193 ##### `CHROOT_SCRIPTS`=""
181 194 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.
182 195
183 196 ##### `ENABLE_INITRAMFS`=false
184 197 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.
185 198
186 199 ##### `ENABLE_IFNAMES`=true
187 200 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.
188 201
189 202 #### Kernel compilation:
190 203 ##### `BUILD_KERNEL`=false
191 204 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.
192 205
193 206 ##### `KERNEL_REDUCE`=false
194 207 Reduce the size of the generated kernel by removing unwanted device, network and filesystem drivers (experimental).
195 208
196 209 ##### `KERNEL_THREADS`=1
197 210 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.
198 211
199 212 ##### `KERNEL_HEADERS`=true
200 213 Install kernel headers with built kernel.
201 214
202 215 ##### `KERNEL_MENUCONFIG`=false
203 216 Start `make menuconfig` interactive menu-driven kernel configuration. The script will continue after `make menuconfig` was terminated.
204 217
205 218 ##### `KERNEL_REMOVESRC`=true
206 219 Remove all kernel sources from the generated OS image after it was built and installed.
207 220
208 221 ##### `KERNELSRC_DIR`=""
209 222 Path to a directory of [RaspberryPi Linux kernel sources](https://github.com/raspberrypi/linux) that will be copied, configured, build and installed inside the chroot.
210 223
211 224 ##### `KERNELSRC_CLEAN`=false
212 225 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.
213 226
214 227 ##### `KERNELSRC_CONFIG`=true
215 228 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.
216 229
217 230 ##### `KERNELSRC_USRCONFIG`=""
218 231 Copy own config file to kernel `.config`. If `KERNEL_MENUCONFIG`=true then running after copy.
219 232
220 233 ##### `KERNELSRC_PREBUILT`=false
221 234 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.
222 235
223 236 ##### `RPI_FIRMWARE_DIR`=""
224 237 The directory 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.
225 238
226 239 #### Reduce disk usage:
227 240 The following list of parameters is ignored if `ENABLE_REDUCE`=false.
228 241
229 242 ##### `REDUCE_APT`=true
230 243 Configure APT to use compressed package repository lists and no package caching files.
231 244
232 245 ##### `REDUCE_DOC`=true
233 246 Remove all doc files (harsh). Configure APT to not include doc files on future `apt-get` package installations.
234 247
235 248 ##### `REDUCE_MAN`=true
236 249 Remove all man pages and info files (harsh). Configure APT to not include man pages on future `apt-get` package installations.
237 250
238 251 ##### `REDUCE_VIM`=false
239 252 Replace `vim-tiny` package by `levee` a tiny vim clone.
240 253
241 254 ##### `REDUCE_BASH`=false
242 255 Remove `bash` package and switch to `dash` shell (experimental).
243 256
244 257 ##### `REDUCE_HWDB`=true
245 258 Remove PCI related hwdb files (experimental).
246 259
247 260 ##### `REDUCE_SSHD`=true
248 261 Replace `openssh-server` with `dropbear`.
249 262
250 263 ##### `REDUCE_LOCALE`=true
251 264 Remove all `locale` translation files.
252 265
253 266 #### Encrypted root partition:
254 267
255 268 ##### `ENABLE_CRYPTFS`=false
256 269 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.
257 270
258 271 ##### `CRYPTFS_PASSWORD`=""
259 272 Set password of the encrypted root partition. This parameter is mandatory if `ENABLE_CRYPTFS`=true.
260 273
261 274 ##### `CRYPTFS_MAPPING`="secure"
262 275 Set name of dm-crypt managed device-mapper mapping.
263 276
264 277 ##### `CRYPTFS_CIPHER`="aes-xts-plain64:sha512"
265 278 Set cipher specification string. `aes-xts*` ciphers are strongly recommended.
266 279
267 280 ##### `CRYPTFS_XTSKEYSIZE`=512
268 281 Sets key size in bits. The argument has to be a multiple of 8.
269 282
270 283 ## Understanding the script
271 284 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:
272 285
273 286 | Script | Description |
274 287 | --- | --- |
275 288 | `10-bootstrap.sh` | Debootstrap basic system |
276 289 | `11-apt.sh` | Setup APT repositories |
277 290 | `12-locale.sh` | Setup Locales and keyboard settings |
278 291 | `13-kernel.sh` | Build and install RPi2/3 Kernel |
279 292 | `20-networking.sh` | Setup Networking |
280 293 | `21-firewall.sh` | Setup Firewall |
281 294 | `30-security.sh` | Setup Users and Security settings |
282 295 | `31-logging.sh` | Setup Logging |
283 296 | `41-uboot.sh` | Build and Setup U-Boot |
284 297 | `42-fbturbo.sh` | Build and Setup fbturbo Xorg driver |
285 298 | `50-firstboot.sh` | First boot actions |
286 299 | `99-reduce.sh` | Reduce the disk space usage |
287 300
288 301 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.
289 302
290 303 | Directory | Description |
291 304 | --- | --- |
292 305 | `apt` | APT management configuration files |
293 306 | `boot` | Boot and RPi2/3 configuration files |
294 307 | `dpkg` | Package Manager configuration |
295 308 | `etc` | Configuration files and rc scripts |
296 309 | `firstboot` | Scripts that get executed on first boot |
297 310 | `initramfs` | Initramfs scripts |
298 311 | `iptables` | Firewall configuration files |
299 312 | `locales` | Locales configuration |
300 313 | `modules` | Kernel Modules configuration |
301 314 | `mount` | Fstab configuration |
302 315 | `network` | Networking configuration files |
303 316 | `sysctl.d` | Swapping and Network Hardening configuration |
304 317 | `xorg` | fbturbo Xorg driver configuration |
305 318
306 319 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`.
307 320
308 321 Scripts in the custom.d directory will be executed after all other installation is complete but before the image is created.
309 322
310 323 ## Logging of the bootstrapping process
311 324 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:
312 325
313 326 ```shell
314 327 script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log
315 328 ```
316 329
317 330 ## Flashing the image file
318 331 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`.
319 332
320 333 #####Flashing examples:
321 334 ```shell
322 335 bmaptool copy ./images/jessie/2015-12-13-debian-jessie.img /dev/mmcblk0
323 336 dd bs=4M if=./images/jessie/2015-12-13-debian-jessie.img of=/dev/mmcblk0
324 337 ```
325 338 If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:
326 339 ```shell
327 340 bmaptool copy ./images/jessie/2015-12-13-debian-jessie-frmw.img /dev/mmcblk0
328 341 bmaptool copy ./images/jessie/2015-12-13-debian-jessie-root.img /dev/sdc
329 342 ```
330 343
331 344 ## External links and references
332 345 * [Debian worldwide mirror sites](https://www.debian.org/mirror/list)
333 346 * [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)
334 347 * [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)
335 348 * [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)
336 349 * [U-BOOT git repository](http://git.denx.de/?p=u-boot.git;a=summary)
337 350 * [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)
338 351 * [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/brcm)
339 352 * [Collabora RPi2 Kernel precompiled](https://repositories.collabora.co.uk/debian/)
General Comments 0
Vous devez vous connecter pour laisser un commentaire. Se connecter maintenant