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

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

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