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

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

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