##// END OF EJS Templates
Describe BASEDIR in README
Denis Mosolov -
r137:8155d6044389
parent child
Show More
@@ -1,409 +1,415
1 # rpi23-gen-image
1 # rpi23-gen-image
2 ## Introduction
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 (armhf) 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 ## Build dependencies
5 ## Build dependencies
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.
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 ```debootstrap debian-archive-keyring qemu-user-static binfmt-support dosfstools rsync bmap-tools whois git bc psmisc dbus```
8 ```debootstrap debian-archive-keyring qemu-user-static binfmt-support dosfstools rsync bmap-tools whois git bc psmisc dbus```
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.
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 further 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 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:
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 echo "deb http://emdebian.org/tools/debian/ jessie main" > /etc/apt/sources.list.d/crosstools.list
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 -
18 sudo -u nobody wget -O - http://emdebian.org/tools/debian/emdebian-toolchain-archive.key | apt-key add -
19 dpkg --add-architecture armhf
19 dpkg --add-architecture armhf
20 apt-get update
20 apt-get update
21 ```
21 ```
22
22
23 ## Command-line parameters
23 ## Command-line parameters
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.
24 The script accepts certain command-line parameters to enable or disable specific OS features, services and configuration settings. These parameters are passed to the `rpi23-gen-image.sh` script via (simple) shell-variables. Unlike environment shell-variables (simple) shell-variables are defined at the beginning of the command-line call of the `rpi23-gen-image.sh` script.
25
25
26 #####Command-line examples:
26 #####Command-line examples:
27 ```shell
27 ```shell
28 ENABLE_UBOOT=true ./rpi23-gen-image.sh
28 ENABLE_UBOOT=true ./rpi23-gen-image.sh
29 ENABLE_CONSOLE=false ENABLE_IPV6=false ./rpi23-gen-image.sh
29 ENABLE_CONSOLE=false ENABLE_IPV6=false ./rpi23-gen-image.sh
30 ENABLE_WM=xfce4 ENABLE_FBTURBO=true ENABLE_MINBASE=true ./rpi23-gen-image.sh
30 ENABLE_WM=xfce4 ENABLE_FBTURBO=true ENABLE_MINBASE=true ./rpi23-gen-image.sh
31 ENABLE_HARDNET=true ENABLE_IPTABLES=true /rpi23-gen-image.sh
31 ENABLE_HARDNET=true ENABLE_IPTABLES=true /rpi23-gen-image.sh
32 APT_SERVER=ftp.de.debian.org APT_PROXY="http://127.0.0.1:3142/" ./rpi23-gen-image.sh
32 APT_SERVER=ftp.de.debian.org APT_PROXY="http://127.0.0.1:3142/" ./rpi23-gen-image.sh
33 ENABLE_MINBASE=true ./rpi23-gen-image.sh
33 ENABLE_MINBASE=true ./rpi23-gen-image.sh
34 BUILD_KERNEL=true ENABLE_MINBASE=true ENABLE_IPV6=false ./rpi23-gen-image.sh
34 BUILD_KERNEL=true ENABLE_MINBASE=true ENABLE_IPV6=false ./rpi23-gen-image.sh
35 BUILD_KERNEL=true KERNELSRC_DIR=/tmp/linux ./rpi23-gen-image.sh
35 BUILD_KERNEL=true KERNELSRC_DIR=/tmp/linux ./rpi23-gen-image.sh
36 ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh
36 ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh
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
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 RELEASE=stretch BUILD_KERNEL=true ./rpi23-gen-image.sh
38 RELEASE=stretch BUILD_KERNEL=true ./rpi23-gen-image.sh
39 RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
39 RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
40 RELEASE=stretch RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
40 RELEASE=stretch RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
41 ```
41 ```
42
42
43 ## Configuration template files
43 ## Configuration template files
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.
44 To avoid long lists of command-line parameters and to help to store the favourite parameter configurations the `rpi23-gen-image.sh` script supports so called configuration template files (`CONFIG_TEMPLATE`=template). These are simple text files located in the `./templates` directory that contain the list of configuration parameters that will be used. New configuration template files can be added to the `./templates` directory.
45
45
46 #####Command-line examples:
46 #####Command-line examples:
47 ```shell
47 ```shell
48 CONFIG_TEMPLATE=rpi3stretch ./rpi23-gen-image.sh
48 CONFIG_TEMPLATE=rpi3stretch ./rpi23-gen-image.sh
49 CONFIG_TEMPLATE=rpi2stretch ./rpi23-gen-image.sh
49 CONFIG_TEMPLATE=rpi2stretch ./rpi23-gen-image.sh
50 ```
50 ```
51
51
52 ## Supported parameters and settings
52 ## Supported parameters and settings
53 #### APT settings:
53 #### APT settings:
54 ##### `APT_SERVER`="ftp.debian.org"
54 ##### `APT_SERVER`="ftp.debian.org"
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.
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 ##### `APT_PROXY`=""
57 ##### `APT_PROXY`=""
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.
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 ##### `APT_INCLUDES`=""
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 during bootstrapping.
62
62
63 ---
63 ---
64
64
65 #### General system settings:
65 #### General system settings:
66 ##### `RPI_MODEL`=2
66 ##### `RPI_MODEL`=2
67 Specifiy the target Raspberry Pi hardware model. The script at this time supports the Raspberry Pi models `2` and `3`. `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` is used.
67 Specifiy the target Raspberry Pi hardware model. The script at this time supports the Raspberry Pi models `2` and `3`. `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` is used.
68
68
69 ##### `RELEASE`="jessie"
69 ##### `RELEASE`="jessie"
70 Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases "jessie" and "stretch". `BUILD_KERNEL`=true will automatically be set if the Debian release `stretch` is used.
70 Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases "jessie" and "stretch". `BUILD_KERNEL`=true will automatically be set if the Debian release `stretch` is used.
71
71
72 ##### `HOSTNAME`="rpi$RPI_MODEL-$RELEASE"
72 ##### `HOSTNAME`="rpi$RPI_MODEL-$RELEASE"
73 Set system host name. It's recommended that the host name is unique in the corresponding subnet.
73 Set system host name. It's recommended that the host name is unique in the corresponding subnet.
74
74
75 ##### `PASSWORD`="raspberry"
75 ##### `PASSWORD`="raspberry"
76 Set system `root` password. It's **STRONGLY** recommended that you choose a custom password.
76 Set system `root` password. It's **STRONGLY** recommended that you choose a custom password.
77
77
78 ##### `USER_PASSWORD`="raspberry"
78 ##### `USER_PASSWORD`="raspberry"
79 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.
79 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.
80
80
81 ##### `DEFLOCAL`="en_US.UTF-8"
81 ##### `DEFLOCAL`="en_US.UTF-8"
82 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`.
82 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`.
83
83
84 ##### `TIMEZONE`="Europe/Berlin"
84 ##### `TIMEZONE`="Europe/Berlin"
85 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.
85 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.
86
86
87 ##### `EXPANDROOT`=true
87 ##### `EXPANDROOT`=true
88 Expand the root partition and filesystem automatically on first boot.
88 Expand the root partition and filesystem automatically on first boot.
89
89
90 ---
90 ---
91
91
92 #### Keyboard settings:
92 #### Keyboard settings:
93 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.
93 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.
94
94
95 ##### `XKB_MODEL`=""
95 ##### `XKB_MODEL`=""
96 Set the name of the model of your keyboard type.
96 Set the name of the model of your keyboard type.
97
97
98 ##### `XKB_LAYOUT`=""
98 ##### `XKB_LAYOUT`=""
99 Set the supported keyboard layout(s).
99 Set the supported keyboard layout(s).
100
100
101 ##### `XKB_VARIANT`=""
101 ##### `XKB_VARIANT`=""
102 Set the supported variant(s) of the keyboard layout(s).
102 Set the supported variant(s) of the keyboard layout(s).
103
103
104 ##### `XKB_OPTIONS`=""
104 ##### `XKB_OPTIONS`=""
105 Set extra xkb configuration options.
105 Set extra xkb configuration options.
106
106
107 ---
107 ---
108
108
109 #### Networking settings (DHCP):
109 #### Networking settings (DHCP):
110 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`.`
110 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`.`
111
111
112 #####`ENABLE_DHCP`=true
112 #####`ENABLE_DHCP`=true
113 Set the system to use DHCP. This requires an DHCP server.
113 Set the system to use DHCP. This requires an DHCP server.
114
114
115 ---
115 ---
116
116
117 #### Networking settings (static):
117 #### Networking settings (static):
118 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`.
118 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`.
119
119
120 #####`NET_ADDRESS`=""
120 #####`NET_ADDRESS`=""
121 Set a static IPv4 or IPv6 address and its prefix, separated by "/", eg. "192.169.0.3/24".
121 Set a static IPv4 or IPv6 address and its prefix, separated by "/", eg. "192.169.0.3/24".
122
122
123 #####`NET_GATEWAY`=""
123 #####`NET_GATEWAY`=""
124 Set the IP address for the default gateway.
124 Set the IP address for the default gateway.
125
125
126 #####`NET_DNS_1`=""
126 #####`NET_DNS_1`=""
127 Set the IP address for the first DNS server.
127 Set the IP address for the first DNS server.
128
128
129 #####`NET_DNS_2`=""
129 #####`NET_DNS_2`=""
130 Set the IP address for the second DNS server.
130 Set the IP address for the second DNS server.
131
131
132 #####`NET_DNS_DOMAINS`=""
132 #####`NET_DNS_DOMAINS`=""
133 Set the default DNS search domains to use for non fully qualified host names.
133 Set the default DNS search domains to use for non fully qualified host names.
134
134
135 #####`NET_NTP_1`=""
135 #####`NET_NTP_1`=""
136 Set the IP address for the first NTP server.
136 Set the IP address for the first NTP server.
137
137
138 #####`NET_NTP_2`=""
138 #####`NET_NTP_2`=""
139 Set the IP address for the second NTP server.
139 Set the IP address for the second NTP server.
140
140
141 ---
141 ---
142
142
143 #### Basic system features:
143 #### Basic system features:
144 ##### `ENABLE_CONSOLE`=true
144 ##### `ENABLE_CONSOLE`=true
145 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.
145 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.
146
146
147 ##### `ENABLE_I2C`=false
147 ##### `ENABLE_I2C`=false
148 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.
148 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.
149
149
150 ##### `ENABLE_SPI`=false
150 ##### `ENABLE_SPI`=false
151 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.
151 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.
152
152
153 ##### `ENABLE_IPV6`=true
153 ##### `ENABLE_IPV6`=true
154 Enable IPv6 support. The network interface configuration is managed via systemd-networkd.
154 Enable IPv6 support. The network interface configuration is managed via systemd-networkd.
155
155
156 ##### `ENABLE_SSHD`=true
156 ##### `ENABLE_SSHD`=true
157 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.
157 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.
158
158
159 ##### `ENABLE_NONFREE`=false
159 ##### `ENABLE_NONFREE`=false
160 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.
160 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.
161
161
162 ##### `ENABLE_WIRELESS`=false
162 ##### `ENABLE_WIRELESS`=false
163 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`.
163 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`.
164
164
165 ##### `ENABLE_RSYSLOG`=true
165 ##### `ENABLE_RSYSLOG`=true
166 If set to false, disable and uninstall rsyslog (so logs will be available only
166 If set to false, disable and uninstall rsyslog (so logs will be available only
167 in journal files)
167 in journal files)
168
168
169 ##### `ENABLE_SOUND`=true
169 ##### `ENABLE_SOUND`=true
170 Enable sound hardware and install Advanced Linux Sound Architecture.
170 Enable sound hardware and install Advanced Linux Sound Architecture.
171
171
172 ##### `ENABLE_HWRANDOM`=true
172 ##### `ENABLE_HWRANDOM`=true
173 Enable Hardware Random Number Generator. Strong random numbers are important for most network based communications that use encryption. It's recommended to be enabled.
173 Enable Hardware Random Number Generator. Strong random numbers are important for most network based communications that use encryption. It's recommended to be enabled.
174
174
175 ##### `ENABLE_MINGPU`=false
175 ##### `ENABLE_MINGPU`=false
176 Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU.
176 Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU.
177
177
178 ##### `ENABLE_DBUS`=true
178 ##### `ENABLE_DBUS`=true
179 Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled.
179 Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled.
180
180
181 ##### `ENABLE_XORG`=false
181 ##### `ENABLE_XORG`=false
182 Install Xorg open-source X Window System.
182 Install Xorg open-source X Window System.
183
183
184 ##### `ENABLE_WM`=""
184 ##### `ENABLE_WM`=""
185 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`.
185 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`.
186
186
187 ---
187 ---
188
188
189 #### Advanced system features:
189 #### Advanced system features:
190 ##### `ENABLE_MINBASE`=false
190 ##### `ENABLE_MINBASE`=false
191 Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
191 Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
192
192
193 ##### `ENABLE_REDUCE`=false
193 ##### `ENABLE_REDUCE`=false
194 Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.
194 Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.
195
195
196 ##### `ENABLE_UBOOT`=false
196 ##### `ENABLE_UBOOT`=false
197 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.
197 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.
198
198
199 ##### `ENABLE_FBTURBO`=false
199 ##### `ENABLE_FBTURBO`=false
200 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.
200 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.
201
201
202 ##### `ENABLE_IPTABLES`=false
202 ##### `ENABLE_IPTABLES`=false
203 Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.
203 Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.
204
204
205 ##### `ENABLE_USER`=true
205 ##### `ENABLE_USER`=true
206 Create non-root user with password `USER_PASSWORD`=raspberry. Unless overridden with `USER_NAME`=user, username will be `pi`.
206 Create non-root user with password `USER_PASSWORD`=raspberry. Unless overridden with `USER_NAME`=user, username will be `pi`.
207
207
208 ##### `USER_NAME`=pi
208 ##### `USER_NAME`=pi
209 Non-root user to create. Ignored if `ENABLE_USER`=false
209 Non-root user to create. Ignored if `ENABLE_USER`=false
210
210
211 ##### `ENABLE_ROOT`=false
211 ##### `ENABLE_ROOT`=false
212 Set root user password so root login will be enabled
212 Set root user password so root login will be enabled
213
213
214 ##### `ENABLE_HARDNET`=false
214 ##### `ENABLE_HARDNET`=false
215 Enable IPv4/IPv6 network stack hardening settings.
215 Enable IPv4/IPv6 network stack hardening settings.
216
216
217 ##### `ENABLE_SPLITFS`=false
217 ##### `ENABLE_SPLITFS`=false
218 Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.
218 Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.
219
219
220 ##### `CHROOT_SCRIPTS`=""
220 ##### `CHROOT_SCRIPTS`=""
221 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.
221 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.
222
222
223 ##### `ENABLE_INITRAMFS`=false
223 ##### `ENABLE_INITRAMFS`=false
224 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.
224 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.
225
225
226 ##### `ENABLE_IFNAMES`=true
226 ##### `ENABLE_IFNAMES`=true
227 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.
227 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.
228
228
229 ##### `DISABLE_UNDERVOLT_WARNINGS`=
229 ##### `DISABLE_UNDERVOLT_WARNINGS`=
230 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.
230 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.
231
231
232 ---
232 ---
233
233
234 #### SSH settings:
234 #### SSH settings:
235 ##### `SSH_ENABLE_ROOT`=false
235 ##### `SSH_ENABLE_ROOT`=false
236 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`.
236 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`.
237
237
238 ##### `SSH_DISABLE_PASSWORD_AUTH`=false
238 ##### `SSH_DISABLE_PASSWORD_AUTH`=false
239 Disable password based SSH authentication. Only public key based SSH (v2) authentication will be supported.
239 Disable password based SSH authentication. Only public key based SSH (v2) authentication will be supported.
240
240
241 ##### `SSH_LIMIT_USERS`=false
241 ##### `SSH_LIMIT_USERS`=false
242 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.
242 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.
243
243
244 ##### `SSH_ROOT_PUB_KEY`=""
244 ##### `SSH_ROOT_PUB_KEY`=""
245 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`.
245 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`.
246
246
247 ##### `SSH_USER_PUB_KEY`=""
247 ##### `SSH_USER_PUB_KEY`=""
248 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.
248 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.
249
249
250 ---
250 ---
251
251
252 #### Kernel compilation:
252 #### Kernel compilation:
253 ##### `BUILD_KERNEL`=false
253 ##### `BUILD_KERNEL`=false
254 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.
254 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.
255
255
256 ##### `KERNEL_REDUCE`=false
256 ##### `KERNEL_REDUCE`=false
257 Reduce the size of the generated kernel by removing unwanted device, network and filesystem drivers (experimental).
257 Reduce the size of the generated kernel by removing unwanted device, network and filesystem drivers (experimental).
258
258
259 ##### `KERNEL_THREADS`=1
259 ##### `KERNEL_THREADS`=1
260 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.
260 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.
261
261
262 ##### `KERNEL_HEADERS`=true
262 ##### `KERNEL_HEADERS`=true
263 Install kernel headers with built kernel.
263 Install kernel headers with built kernel.
264
264
265 ##### `KERNEL_MENUCONFIG`=false
265 ##### `KERNEL_MENUCONFIG`=false
266 Start `make menuconfig` interactive menu-driven kernel configuration. The script will continue after `make menuconfig` was terminated.
266 Start `make menuconfig` interactive menu-driven kernel configuration. The script will continue after `make menuconfig` was terminated.
267
267
268 ##### `KERNEL_REMOVESRC`=true
268 ##### `KERNEL_REMOVESRC`=true
269 Remove all kernel sources from the generated OS image after it was built and installed.
269 Remove all kernel sources from the generated OS image after it was built and installed.
270
270
271 ##### `KERNELSRC_DIR`=""
271 ##### `KERNELSRC_DIR`=""
272 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.
272 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.
273
273
274 ##### `KERNELSRC_CLEAN`=false
274 ##### `KERNELSRC_CLEAN`=false
275 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.
275 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.
276
276
277 ##### `KERNELSRC_CONFIG`=true
277 ##### `KERNELSRC_CONFIG`=true
278 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.
278 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.
279
279
280 ##### `KERNELSRC_USRCONFIG`=""
280 ##### `KERNELSRC_USRCONFIG`=""
281 Copy own config file to kernel `.config`. If `KERNEL_MENUCONFIG`=true then running after copy.
281 Copy own config file to kernel `.config`. If `KERNEL_MENUCONFIG`=true then running after copy.
282
282
283 ##### `KERNELSRC_PREBUILT`=false
283 ##### `KERNELSRC_PREBUILT`=false
284 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.
284 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.
285
285
286 ##### `RPI_FIRMWARE_DIR`=""
286 ##### `RPI_FIRMWARE_DIR`=""
287 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.
287 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.
288
288
289 ---
289 ---
290
290
291 #### Reduce disk usage:
291 #### Reduce disk usage:
292 The following list of parameters is ignored if `ENABLE_REDUCE`=false.
292 The following list of parameters is ignored if `ENABLE_REDUCE`=false.
293
293
294 ##### `REDUCE_APT`=true
294 ##### `REDUCE_APT`=true
295 Configure APT to use compressed package repository lists and no package caching files.
295 Configure APT to use compressed package repository lists and no package caching files.
296
296
297 ##### `REDUCE_DOC`=true
297 ##### `REDUCE_DOC`=true
298 Remove all doc files (harsh). Configure APT to not include doc files on future `apt-get` package installations.
298 Remove all doc files (harsh). Configure APT to not include doc files on future `apt-get` package installations.
299
299
300 ##### `REDUCE_MAN`=true
300 ##### `REDUCE_MAN`=true
301 Remove all man pages and info files (harsh). Configure APT to not include man pages on future `apt-get` package installations.
301 Remove all man pages and info files (harsh). Configure APT to not include man pages on future `apt-get` package installations.
302
302
303 ##### `REDUCE_VIM`=false
303 ##### `REDUCE_VIM`=false
304 Replace `vim-tiny` package by `levee` a tiny vim clone.
304 Replace `vim-tiny` package by `levee` a tiny vim clone.
305
305
306 ##### `REDUCE_BASH`=false
306 ##### `REDUCE_BASH`=false
307 Remove `bash` package and switch to `dash` shell (experimental).
307 Remove `bash` package and switch to `dash` shell (experimental).
308
308
309 ##### `REDUCE_HWDB`=true
309 ##### `REDUCE_HWDB`=true
310 Remove PCI related hwdb files (experimental).
310 Remove PCI related hwdb files (experimental).
311
311
312 ##### `REDUCE_SSHD`=true
312 ##### `REDUCE_SSHD`=true
313 Replace `openssh-server` with `dropbear`.
313 Replace `openssh-server` with `dropbear`.
314
314
315 ##### `REDUCE_LOCALE`=true
315 ##### `REDUCE_LOCALE`=true
316 Remove all `locale` translation files.
316 Remove all `locale` translation files.
317
317
318 ---
318 ---
319
319
320 #### Encrypted root partition:
320 #### Encrypted root partition:
321 ##### `ENABLE_CRYPTFS`=false
321 ##### `ENABLE_CRYPTFS`=false
322 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.
322 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.
323
323
324 ##### `CRYPTFS_PASSWORD`=""
324 ##### `CRYPTFS_PASSWORD`=""
325 Set password of the encrypted root partition. This parameter is mandatory if `ENABLE_CRYPTFS`=true.
325 Set password of the encrypted root partition. This parameter is mandatory if `ENABLE_CRYPTFS`=true.
326
326
327 ##### `CRYPTFS_MAPPING`="secure"
327 ##### `CRYPTFS_MAPPING`="secure"
328 Set name of dm-crypt managed device-mapper mapping.
328 Set name of dm-crypt managed device-mapper mapping.
329
329
330 ##### `CRYPTFS_CIPHER`="aes-xts-plain64:sha512"
330 ##### `CRYPTFS_CIPHER`="aes-xts-plain64:sha512"
331 Set cipher specification string. `aes-xts*` ciphers are strongly recommended.
331 Set cipher specification string. `aes-xts*` ciphers are strongly recommended.
332
332
333 ##### `CRYPTFS_XTSKEYSIZE`=512
333 ##### `CRYPTFS_XTSKEYSIZE`=512
334 Sets key size in bits. The argument has to be a multiple of 8.
334 Sets key size in bits. The argument has to be a multiple of 8.
335
335
336 ---
337
338 #### Build settings:
339 ##### `BASEDIR`=$(pwd)/images/${RELEASE}
340 Path to a directory where the script stores all temporary files during generating the image.
341
336 ## Understanding the script
342 ## Understanding the script
337 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:
343 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:
338
344
339 | Script | Description |
345 | Script | Description |
340 | --- | --- |
346 | --- | --- |
341 | `10-bootstrap.sh` | Debootstrap basic system |
347 | `10-bootstrap.sh` | Debootstrap basic system |
342 | `11-apt.sh` | Setup APT repositories |
348 | `11-apt.sh` | Setup APT repositories |
343 | `12-locale.sh` | Setup Locales and keyboard settings |
349 | `12-locale.sh` | Setup Locales and keyboard settings |
344 | `13-kernel.sh` | Build and install RPi2/3 Kernel |
350 | `13-kernel.sh` | Build and install RPi2/3 Kernel |
345 | `14-rpi-config.sh` | Setup RPi2/3 config and cmdline |
351 | `14-rpi-config.sh` | Setup RPi2/3 config and cmdline |
346 | `20-networking.sh` | Setup Networking |
352 | `20-networking.sh` | Setup Networking |
347 | `21-firewall.sh` | Setup Firewall |
353 | `21-firewall.sh` | Setup Firewall |
348 | `30-security.sh` | Setup Users and Security settings |
354 | `30-security.sh` | Setup Users and Security settings |
349 | `31-logging.sh` | Setup Logging |
355 | `31-logging.sh` | Setup Logging |
350 | `32-sshd.sh` | Setup SSH and public keys |
356 | `32-sshd.sh` | Setup SSH and public keys |
351 | `41-uboot.sh` | Build and Setup U-Boot |
357 | `41-uboot.sh` | Build and Setup U-Boot |
352 | `42-fbturbo.sh` | Build and Setup fbturbo Xorg driver |
358 | `42-fbturbo.sh` | Build and Setup fbturbo Xorg driver |
353 | `50-firstboot.sh` | First boot actions |
359 | `50-firstboot.sh` | First boot actions |
354 | `99-reduce.sh` | Reduce the disk space usage |
360 | `99-reduce.sh` | Reduce the disk space usage |
355
361
356 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.
362 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.
357
363
358 | Directory | Description |
364 | Directory | Description |
359 | --- | --- |
365 | --- | --- |
360 | `apt` | APT management configuration files |
366 | `apt` | APT management configuration files |
361 | `boot` | Boot and RPi2/3 configuration files |
367 | `boot` | Boot and RPi2/3 configuration files |
362 | `dpkg` | Package Manager configuration |
368 | `dpkg` | Package Manager configuration |
363 | `etc` | Configuration files and rc scripts |
369 | `etc` | Configuration files and rc scripts |
364 | `firstboot` | Scripts that get executed on first boot |
370 | `firstboot` | Scripts that get executed on first boot |
365 | `initramfs` | Initramfs scripts |
371 | `initramfs` | Initramfs scripts |
366 | `iptables` | Firewall configuration files |
372 | `iptables` | Firewall configuration files |
367 | `locales` | Locales configuration |
373 | `locales` | Locales configuration |
368 | `modules` | Kernel Modules configuration |
374 | `modules` | Kernel Modules configuration |
369 | `mount` | Fstab configuration |
375 | `mount` | Fstab configuration |
370 | `network` | Networking configuration files |
376 | `network` | Networking configuration files |
371 | `sysctl.d` | Swapping and Network Hardening configuration |
377 | `sysctl.d` | Swapping and Network Hardening configuration |
372 | `xorg` | fbturbo Xorg driver configuration |
378 | `xorg` | fbturbo Xorg driver configuration |
373
379
374 ## Custom packages and scripts
380 ## Custom packages and scripts
375 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`.
381 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`.
376
382
377 Scripts in the custom.d directory will be executed after all other installation is complete but before the image is created.
383 Scripts in the custom.d directory will be executed after all other installation is complete but before the image is created.
378
384
379 ## Logging of the bootstrapping process
385 ## Logging of the bootstrapping process
380 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:
386 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:
381
387
382 ```shell
388 ```shell
383 script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log
389 script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log
384 ```
390 ```
385
391
386 ## Flashing the image file
392 ## Flashing the image file
387 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`.
393 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`.
388
394
389 #####Flashing examples:
395 #####Flashing examples:
390 ```shell
396 ```shell
391 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie.img /dev/mmcblk0
397 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie.img /dev/mmcblk0
392 dd bs=4M if=./images/jessie/2017-01-23-rpi3-jessie.img of=/dev/mmcblk0
398 dd bs=4M if=./images/jessie/2017-01-23-rpi3-jessie.img of=/dev/mmcblk0
393 ```
399 ```
394 If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:
400 If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:
395 ```shell
401 ```shell
396 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie-frmw.img /dev/mmcblk0
402 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie-frmw.img /dev/mmcblk0
397 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie-root.img /dev/sdc
403 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie-root.img /dev/sdc
398 ```
404 ```
399
405
400 ## External links and references
406 ## External links and references
401 * [Debian worldwide mirror sites](https://www.debian.org/mirror/list)
407 * [Debian worldwide mirror sites](https://www.debian.org/mirror/list)
402 * [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)
408 * [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)
403 * [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains)
409 * [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains)
404 * [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)
410 * [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)
405 * [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)
411 * [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)
406 * [U-BOOT git repository](http://git.denx.de/?p=u-boot.git;a=summary)
412 * [U-BOOT git repository](http://git.denx.de/?p=u-boot.git;a=summary)
407 * [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)
413 * [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)
408 * [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/brcm)
414 * [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/brcm)
409 * [Collabora RPi2 Kernel precompiled](https://repositories.collabora.co.uk/debian/)
415 * [Collabora RPi2 Kernel precompiled](https://repositories.collabora.co.uk/debian/)
@@ -1,614 +1,614
1 #!/bin/sh
1 #!/bin/sh
2
2
3 ########################################################################
3 ########################################################################
4 # rpi23-gen-image.sh 2015-2017
4 # rpi23-gen-image.sh 2015-2017
5 #
5 #
6 # Advanced Debian "jessie" and "stretch" bootstrap script for RPi2/3
6 # Advanced Debian "jessie" and "stretch" bootstrap script for RPi2/3
7 #
7 #
8 # This program is free software; you can redistribute it and/or
8 # This program is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU General Public License
9 # modify it under the terms of the GNU General Public License
10 # as published by the Free Software Foundation; either version 2
10 # as published by the Free Software Foundation; either version 2
11 # of the License, or (at your option) any later version.
11 # of the License, or (at your option) any later version.
12 #
12 #
13 # Copyright (C) 2015 Jan Wagner <mail@jwagner.eu>
13 # Copyright (C) 2015 Jan Wagner <mail@jwagner.eu>
14 #
14 #
15 # Big thanks for patches and enhancements by 10+ github contributors!
15 # Big thanks for patches and enhancements by 10+ github contributors!
16 ########################################################################
16 ########################################################################
17
17
18 # Are we running as root?
18 # Are we running as root?
19 if [ "$(id -u)" -ne "0" ] ; then
19 if [ "$(id -u)" -ne "0" ] ; then
20 echo "error: this script must be executed with root privileges!"
20 echo "error: this script must be executed with root privileges!"
21 exit 1
21 exit 1
22 fi
22 fi
23
23
24 # Check if ./functions.sh script exists
24 # Check if ./functions.sh script exists
25 if [ ! -r "./functions.sh" ] ; then
25 if [ ! -r "./functions.sh" ] ; then
26 echo "error: './functions.sh' required script not found!"
26 echo "error: './functions.sh' required script not found!"
27 exit 1
27 exit 1
28 fi
28 fi
29
29
30 # Load utility functions
30 # Load utility functions
31 . ./functions.sh
31 . ./functions.sh
32
32
33 # Load parameters from configuration template file
33 # Load parameters from configuration template file
34 if [ ! -z "$CONFIG_TEMPLATE" ] ; then
34 if [ ! -z "$CONFIG_TEMPLATE" ] ; then
35 use_template
35 use_template
36 fi
36 fi
37
37
38 # Introduce settings
38 # Introduce settings
39 set -e
39 set -e
40 echo -n -e "\n#\n# RPi2/3 Bootstrap Settings\n#\n"
40 echo -n -e "\n#\n# RPi2/3 Bootstrap Settings\n#\n"
41 set -x
41 set -x
42
42
43 # Raspberry Pi model configuration
43 # Raspberry Pi model configuration
44 RPI_MODEL=${RPI_MODEL:=2}
44 RPI_MODEL=${RPI_MODEL:=2}
45 RPI2_DTB_FILE=${RPI2_DTB_FILE:=bcm2709-rpi-2-b.dtb}
45 RPI2_DTB_FILE=${RPI2_DTB_FILE:=bcm2709-rpi-2-b.dtb}
46 RPI2_UBOOT_CONFIG=${RPI2_UBOOT_CONFIG:=rpi_2_defconfig}
46 RPI2_UBOOT_CONFIG=${RPI2_UBOOT_CONFIG:=rpi_2_defconfig}
47 RPI3_DTB_FILE=${RPI3_DTB_FILE:=bcm2710-rpi-3-b.dtb}
47 RPI3_DTB_FILE=${RPI3_DTB_FILE:=bcm2710-rpi-3-b.dtb}
48 RPI3_UBOOT_CONFIG=${RPI3_UBOOT_CONFIG:=rpi_3_32b_defconfig}
48 RPI3_UBOOT_CONFIG=${RPI3_UBOOT_CONFIG:=rpi_3_32b_defconfig}
49
49
50 # Debian release
50 # Debian release
51 RELEASE=${RELEASE:=jessie}
51 RELEASE=${RELEASE:=jessie}
52 KERNEL_ARCH=${KERNEL_ARCH:=arm}
52 KERNEL_ARCH=${KERNEL_ARCH:=arm}
53 RELEASE_ARCH=${RELEASE_ARCH:=armhf}
53 RELEASE_ARCH=${RELEASE_ARCH:=armhf}
54 CROSS_COMPILE=${CROSS_COMPILE:=arm-linux-gnueabihf-}
54 CROSS_COMPILE=${CROSS_COMPILE:=arm-linux-gnueabihf-}
55 COLLABORA_KERNEL=${COLLABORA_KERNEL:=3.18.0-trunk-rpi2}
55 COLLABORA_KERNEL=${COLLABORA_KERNEL:=3.18.0-trunk-rpi2}
56 KERNEL_DEFCONFIG=${KERNEL_DEFCONFIG:=bcm2709_defconfig}
56 KERNEL_DEFCONFIG=${KERNEL_DEFCONFIG:=bcm2709_defconfig}
57 KERNEL_IMAGE=${KERNEL_IMAGE:=kernel7.img}
57 KERNEL_IMAGE=${KERNEL_IMAGE:=kernel7.img}
58 QEMU_BINARY=${QEMU_BINARY:=/usr/bin/qemu-arm-static}
58 QEMU_BINARY=${QEMU_BINARY:=/usr/bin/qemu-arm-static}
59
59
60 # URLs
60 # URLs
61 KERNEL_URL=${KERNEL_URL:=https://github.com/raspberrypi/linux}
61 KERNEL_URL=${KERNEL_URL:=https://github.com/raspberrypi/linux}
62 FIRMWARE_URL=${FIRMWARE_URL:=https://github.com/raspberrypi/firmware/raw/master/boot}
62 FIRMWARE_URL=${FIRMWARE_URL:=https://github.com/raspberrypi/firmware/raw/master/boot}
63 WLAN_FIRMWARE_URL=${WLAN_FIRMWARE_URL:=https://github.com/RPi-Distro/firmware-nonfree/raw/master/brcm80211/brcm}
63 WLAN_FIRMWARE_URL=${WLAN_FIRMWARE_URL:=https://github.com/RPi-Distro/firmware-nonfree/raw/master/brcm80211/brcm}
64 COLLABORA_URL=${COLLABORA_URL:=https://repositories.collabora.co.uk/debian}
64 COLLABORA_URL=${COLLABORA_URL:=https://repositories.collabora.co.uk/debian}
65 FBTURBO_URL=${FBTURBO_URL:=https://github.com/ssvb/xf86-video-fbturbo.git}
65 FBTURBO_URL=${FBTURBO_URL:=https://github.com/ssvb/xf86-video-fbturbo.git}
66 UBOOT_URL=${UBOOT_URL:=git://git.denx.de/u-boot.git}
66 UBOOT_URL=${UBOOT_URL:=git://git.denx.de/u-boot.git}
67
67
68 # Build directories
68 # Build directories
69 BASEDIR="$(pwd)/images/${RELEASE}"
69 BASEDIR=${BASEDIR:=$(pwd)/images/${RELEASE}}
70 BUILDDIR="${BASEDIR}/build"
70 BUILDDIR="${BASEDIR}/build"
71
71
72 # Chroot directories
72 # Chroot directories
73 R="${BUILDDIR}/chroot"
73 R="${BUILDDIR}/chroot"
74 ETC_DIR="${R}/etc"
74 ETC_DIR="${R}/etc"
75 LIB_DIR="${R}/lib"
75 LIB_DIR="${R}/lib"
76 BOOT_DIR="${R}/boot/firmware"
76 BOOT_DIR="${R}/boot/firmware"
77 KERNEL_DIR="${R}/usr/src/linux"
77 KERNEL_DIR="${R}/usr/src/linux"
78 WLAN_FIRMWARE_DIR="${R}/lib/firmware/brcm"
78 WLAN_FIRMWARE_DIR="${R}/lib/firmware/brcm"
79
79
80 # Firmware directory: Blank if download from github
80 # Firmware directory: Blank if download from github
81 RPI_FIRMWARE_DIR=${RPI_FIRMWARE_DIR:=""}
81 RPI_FIRMWARE_DIR=${RPI_FIRMWARE_DIR:=""}
82
82
83 # General settings
83 # General settings
84 HOSTNAME=${HOSTNAME:=rpi${RPI_MODEL}-${RELEASE}}
84 HOSTNAME=${HOSTNAME:=rpi${RPI_MODEL}-${RELEASE}}
85 PASSWORD=${PASSWORD:=raspberry}
85 PASSWORD=${PASSWORD:=raspberry}
86 USER_PASSWORD=${USER_PASSWORD:=raspberry}
86 USER_PASSWORD=${USER_PASSWORD:=raspberry}
87 DEFLOCAL=${DEFLOCAL:="en_US.UTF-8"}
87 DEFLOCAL=${DEFLOCAL:="en_US.UTF-8"}
88 TIMEZONE=${TIMEZONE:="Europe/Berlin"}
88 TIMEZONE=${TIMEZONE:="Europe/Berlin"}
89 EXPANDROOT=${EXPANDROOT:=true}
89 EXPANDROOT=${EXPANDROOT:=true}
90
90
91 # Keyboard settings
91 # Keyboard settings
92 XKB_MODEL=${XKB_MODEL:=""}
92 XKB_MODEL=${XKB_MODEL:=""}
93 XKB_LAYOUT=${XKB_LAYOUT:=""}
93 XKB_LAYOUT=${XKB_LAYOUT:=""}
94 XKB_VARIANT=${XKB_VARIANT:=""}
94 XKB_VARIANT=${XKB_VARIANT:=""}
95 XKB_OPTIONS=${XKB_OPTIONS:=""}
95 XKB_OPTIONS=${XKB_OPTIONS:=""}
96
96
97 # Network settings (DHCP)
97 # Network settings (DHCP)
98 ENABLE_DHCP=${ENABLE_DHCP:=true}
98 ENABLE_DHCP=${ENABLE_DHCP:=true}
99
99
100 # Network settings (static)
100 # Network settings (static)
101 NET_ADDRESS=${NET_ADDRESS:=""}
101 NET_ADDRESS=${NET_ADDRESS:=""}
102 NET_GATEWAY=${NET_GATEWAY:=""}
102 NET_GATEWAY=${NET_GATEWAY:=""}
103 NET_DNS_1=${NET_DNS_1:=""}
103 NET_DNS_1=${NET_DNS_1:=""}
104 NET_DNS_2=${NET_DNS_2:=""}
104 NET_DNS_2=${NET_DNS_2:=""}
105 NET_DNS_DOMAINS=${NET_DNS_DOMAINS:=""}
105 NET_DNS_DOMAINS=${NET_DNS_DOMAINS:=""}
106 NET_NTP_1=${NET_NTP_1:=""}
106 NET_NTP_1=${NET_NTP_1:=""}
107 NET_NTP_2=${NET_NTP_2:=""}
107 NET_NTP_2=${NET_NTP_2:=""}
108
108
109 # APT settings
109 # APT settings
110 APT_PROXY=${APT_PROXY:=""}
110 APT_PROXY=${APT_PROXY:=""}
111 APT_SERVER=${APT_SERVER:="ftp.debian.org"}
111 APT_SERVER=${APT_SERVER:="ftp.debian.org"}
112
112
113 # Feature settings
113 # Feature settings
114 ENABLE_CONSOLE=${ENABLE_CONSOLE:=true}
114 ENABLE_CONSOLE=${ENABLE_CONSOLE:=true}
115 ENABLE_I2C=${ENABLE_I2C:=false}
115 ENABLE_I2C=${ENABLE_I2C:=false}
116 ENABLE_SPI=${ENABLE_SPI:=false}
116 ENABLE_SPI=${ENABLE_SPI:=false}
117 ENABLE_IPV6=${ENABLE_IPV6:=true}
117 ENABLE_IPV6=${ENABLE_IPV6:=true}
118 ENABLE_SSHD=${ENABLE_SSHD:=true}
118 ENABLE_SSHD=${ENABLE_SSHD:=true}
119 ENABLE_NONFREE=${ENABLE_NONFREE:=false}
119 ENABLE_NONFREE=${ENABLE_NONFREE:=false}
120 ENABLE_WIRELESS=${ENABLE_WIRELESS:=false}
120 ENABLE_WIRELESS=${ENABLE_WIRELESS:=false}
121 ENABLE_SOUND=${ENABLE_SOUND:=true}
121 ENABLE_SOUND=${ENABLE_SOUND:=true}
122 ENABLE_DBUS=${ENABLE_DBUS:=true}
122 ENABLE_DBUS=${ENABLE_DBUS:=true}
123 ENABLE_HWRANDOM=${ENABLE_HWRANDOM:=true}
123 ENABLE_HWRANDOM=${ENABLE_HWRANDOM:=true}
124 ENABLE_MINGPU=${ENABLE_MINGPU:=false}
124 ENABLE_MINGPU=${ENABLE_MINGPU:=false}
125 ENABLE_XORG=${ENABLE_XORG:=false}
125 ENABLE_XORG=${ENABLE_XORG:=false}
126 ENABLE_WM=${ENABLE_WM:=""}
126 ENABLE_WM=${ENABLE_WM:=""}
127 ENABLE_RSYSLOG=${ENABLE_RSYSLOG:=true}
127 ENABLE_RSYSLOG=${ENABLE_RSYSLOG:=true}
128 ENABLE_USER=${ENABLE_USER:=true}
128 ENABLE_USER=${ENABLE_USER:=true}
129 USER_NAME=${USER_NAME:="pi"}
129 USER_NAME=${USER_NAME:="pi"}
130 ENABLE_ROOT=${ENABLE_ROOT:=false}
130 ENABLE_ROOT=${ENABLE_ROOT:=false}
131
131
132 # SSH settings
132 # SSH settings
133 SSH_ENABLE_ROOT=${SSH_ENABLE_ROOT:=false}
133 SSH_ENABLE_ROOT=${SSH_ENABLE_ROOT:=false}
134 SSH_DISABLE_PASSWORD_AUTH=${SSH_DISABLE_PASSWORD_AUTH:=false}
134 SSH_DISABLE_PASSWORD_AUTH=${SSH_DISABLE_PASSWORD_AUTH:=false}
135 SSH_LIMIT_USERS=${SSH_LIMIT_USERS:=false}
135 SSH_LIMIT_USERS=${SSH_LIMIT_USERS:=false}
136 SSH_ROOT_PUB_KEY=${SSH_ROOT_PUB_KEY:=""}
136 SSH_ROOT_PUB_KEY=${SSH_ROOT_PUB_KEY:=""}
137 SSH_USER_PUB_KEY=${SSH_USER_PUB_KEY:=""}
137 SSH_USER_PUB_KEY=${SSH_USER_PUB_KEY:=""}
138
138
139 # Advanced settings
139 # Advanced settings
140 ENABLE_MINBASE=${ENABLE_MINBASE:=false}
140 ENABLE_MINBASE=${ENABLE_MINBASE:=false}
141 ENABLE_REDUCE=${ENABLE_REDUCE:=false}
141 ENABLE_REDUCE=${ENABLE_REDUCE:=false}
142 ENABLE_UBOOT=${ENABLE_UBOOT:=false}
142 ENABLE_UBOOT=${ENABLE_UBOOT:=false}
143 ENABLE_FBTURBO=${ENABLE_FBTURBO:=false}
143 ENABLE_FBTURBO=${ENABLE_FBTURBO:=false}
144 ENABLE_HARDNET=${ENABLE_HARDNET:=false}
144 ENABLE_HARDNET=${ENABLE_HARDNET:=false}
145 ENABLE_IPTABLES=${ENABLE_IPTABLES:=false}
145 ENABLE_IPTABLES=${ENABLE_IPTABLES:=false}
146 ENABLE_SPLITFS=${ENABLE_SPLITFS:=false}
146 ENABLE_SPLITFS=${ENABLE_SPLITFS:=false}
147 ENABLE_INITRAMFS=${ENABLE_INITRAMFS:=false}
147 ENABLE_INITRAMFS=${ENABLE_INITRAMFS:=false}
148 ENABLE_IFNAMES=${ENABLE_IFNAMES:=true}
148 ENABLE_IFNAMES=${ENABLE_IFNAMES:=true}
149 DISABLE_UNDERVOLT_WARNINGS=${DISABLE_UNDERVOLT_WARNINGS:=}
149 DISABLE_UNDERVOLT_WARNINGS=${DISABLE_UNDERVOLT_WARNINGS:=}
150
150
151 # Kernel compilation settings
151 # Kernel compilation settings
152 BUILD_KERNEL=${BUILD_KERNEL:=false}
152 BUILD_KERNEL=${BUILD_KERNEL:=false}
153 KERNEL_REDUCE=${KERNEL_REDUCE:=false}
153 KERNEL_REDUCE=${KERNEL_REDUCE:=false}
154 KERNEL_THREADS=${KERNEL_THREADS:=1}
154 KERNEL_THREADS=${KERNEL_THREADS:=1}
155 KERNEL_HEADERS=${KERNEL_HEADERS:=true}
155 KERNEL_HEADERS=${KERNEL_HEADERS:=true}
156 KERNEL_MENUCONFIG=${KERNEL_MENUCONFIG:=false}
156 KERNEL_MENUCONFIG=${KERNEL_MENUCONFIG:=false}
157 KERNEL_REMOVESRC=${KERNEL_REMOVESRC:=true}
157 KERNEL_REMOVESRC=${KERNEL_REMOVESRC:=true}
158
158
159 # Kernel compilation from source directory settings
159 # Kernel compilation from source directory settings
160 KERNELSRC_DIR=${KERNELSRC_DIR:=""}
160 KERNELSRC_DIR=${KERNELSRC_DIR:=""}
161 KERNELSRC_CLEAN=${KERNELSRC_CLEAN:=false}
161 KERNELSRC_CLEAN=${KERNELSRC_CLEAN:=false}
162 KERNELSRC_CONFIG=${KERNELSRC_CONFIG:=true}
162 KERNELSRC_CONFIG=${KERNELSRC_CONFIG:=true}
163 KERNELSRC_PREBUILT=${KERNELSRC_PREBUILT:=false}
163 KERNELSRC_PREBUILT=${KERNELSRC_PREBUILT:=false}
164
164
165 # Reduce disk usage settings
165 # Reduce disk usage settings
166 REDUCE_APT=${REDUCE_APT:=true}
166 REDUCE_APT=${REDUCE_APT:=true}
167 REDUCE_DOC=${REDUCE_DOC:=true}
167 REDUCE_DOC=${REDUCE_DOC:=true}
168 REDUCE_MAN=${REDUCE_MAN:=true}
168 REDUCE_MAN=${REDUCE_MAN:=true}
169 REDUCE_VIM=${REDUCE_VIM:=false}
169 REDUCE_VIM=${REDUCE_VIM:=false}
170 REDUCE_BASH=${REDUCE_BASH:=false}
170 REDUCE_BASH=${REDUCE_BASH:=false}
171 REDUCE_HWDB=${REDUCE_HWDB:=true}
171 REDUCE_HWDB=${REDUCE_HWDB:=true}
172 REDUCE_SSHD=${REDUCE_SSHD:=true}
172 REDUCE_SSHD=${REDUCE_SSHD:=true}
173 REDUCE_LOCALE=${REDUCE_LOCALE:=true}
173 REDUCE_LOCALE=${REDUCE_LOCALE:=true}
174
174
175 # Encrypted filesystem settings
175 # Encrypted filesystem settings
176 ENABLE_CRYPTFS=${ENABLE_CRYPTFS:=false}
176 ENABLE_CRYPTFS=${ENABLE_CRYPTFS:=false}
177 CRYPTFS_PASSWORD=${CRYPTFS_PASSWORD:=""}
177 CRYPTFS_PASSWORD=${CRYPTFS_PASSWORD:=""}
178 CRYPTFS_MAPPING=${CRYPTFS_MAPPING:="secure"}
178 CRYPTFS_MAPPING=${CRYPTFS_MAPPING:="secure"}
179 CRYPTFS_CIPHER=${CRYPTFS_CIPHER:="aes-xts-plain64:sha512"}
179 CRYPTFS_CIPHER=${CRYPTFS_CIPHER:="aes-xts-plain64:sha512"}
180 CRYPTFS_XTSKEYSIZE=${CRYPTFS_XTSKEYSIZE:=512}
180 CRYPTFS_XTSKEYSIZE=${CRYPTFS_XTSKEYSIZE:=512}
181
181
182 # Stop the Crypto Wars
182 # Stop the Crypto Wars
183 DISABLE_FBI=${DISABLE_FBI:=false}
183 DISABLE_FBI=${DISABLE_FBI:=false}
184
184
185 # Chroot scripts directory
185 # Chroot scripts directory
186 CHROOT_SCRIPTS=${CHROOT_SCRIPTS:=""}
186 CHROOT_SCRIPTS=${CHROOT_SCRIPTS:=""}
187
187
188 # Packages required in the chroot build environment
188 # Packages required in the chroot build environment
189 APT_INCLUDES=${APT_INCLUDES:=""}
189 APT_INCLUDES=${APT_INCLUDES:=""}
190 APT_INCLUDES="${APT_INCLUDES},apt-transport-https,apt-utils,ca-certificates,debian-archive-keyring,dialog,sudo,systemd,sysvinit-utils"
190 APT_INCLUDES="${APT_INCLUDES},apt-transport-https,apt-utils,ca-certificates,debian-archive-keyring,dialog,sudo,systemd,sysvinit-utils"
191
191
192 # Packages required for bootstrapping
192 # Packages required for bootstrapping
193 REQUIRED_PACKAGES="debootstrap debian-archive-keyring qemu-user-static binfmt-support dosfstools rsync bmap-tools whois git bc psmisc dbus"
193 REQUIRED_PACKAGES="debootstrap debian-archive-keyring qemu-user-static binfmt-support dosfstools rsync bmap-tools whois git bc psmisc dbus"
194 MISSING_PACKAGES=""
194 MISSING_PACKAGES=""
195
195
196 set +x
196 set +x
197
197
198 # Set Raspberry Pi model specific configuration
198 # Set Raspberry Pi model specific configuration
199 if [ "$RPI_MODEL" = 2 ] ; then
199 if [ "$RPI_MODEL" = 2 ] ; then
200 DTB_FILE=${RPI2_DTB_FILE}
200 DTB_FILE=${RPI2_DTB_FILE}
201 UBOOT_CONFIG=${RPI2_UBOOT_CONFIG}
201 UBOOT_CONFIG=${RPI2_UBOOT_CONFIG}
202 elif [ "$RPI_MODEL" = 3 ] ; then
202 elif [ "$RPI_MODEL" = 3 ] ; then
203 DTB_FILE=${RPI3_DTB_FILE}
203 DTB_FILE=${RPI3_DTB_FILE}
204 UBOOT_CONFIG=${RPI3_UBOOT_CONFIG}
204 UBOOT_CONFIG=${RPI3_UBOOT_CONFIG}
205 BUILD_KERNEL=true
205 BUILD_KERNEL=true
206 else
206 else
207 echo "error: Raspberry Pi model ${RPI_MODEL} is not supported!"
207 echo "error: Raspberry Pi model ${RPI_MODEL} is not supported!"
208 exit 1
208 exit 1
209 fi
209 fi
210
210
211 # Check if the internal wireless interface is supported by the RPi model
211 # Check if the internal wireless interface is supported by the RPi model
212 if [ "$ENABLE_WIRELESS" = true ] && [ "$RPI_MODEL" != 3 ] ; then
212 if [ "$ENABLE_WIRELESS" = true ] && [ "$RPI_MODEL" != 3 ] ; then
213 echo "error: The selected Raspberry Pi model has no internal wireless interface"
213 echo "error: The selected Raspberry Pi model has no internal wireless interface"
214 exit 1
214 exit 1
215 fi
215 fi
216
216
217 # Check if DISABLE_UNDERVOLT_WARNINGS parameter value is supported
217 # Check if DISABLE_UNDERVOLT_WARNINGS parameter value is supported
218 if [ ! -z "$DISABLE_UNDERVOLT_WARNINGS" ] ; then
218 if [ ! -z "$DISABLE_UNDERVOLT_WARNINGS" ] ; then
219 if [ "$DISABLE_UNDERVOLT_WARNINGS" != 1 ] && [ "$DISABLE_UNDERVOLT_WARNINGS" != 2 ] ; then
219 if [ "$DISABLE_UNDERVOLT_WARNINGS" != 1 ] && [ "$DISABLE_UNDERVOLT_WARNINGS" != 2 ] ; then
220 echo "error: DISABLE_UNDERVOLT_WARNINGS=${DISABLE_UNDERVOLT_WARNINGS} is not supported"
220 echo "error: DISABLE_UNDERVOLT_WARNINGS=${DISABLE_UNDERVOLT_WARNINGS} is not supported"
221 exit 1
221 exit 1
222 fi
222 fi
223 fi
223 fi
224
224
225 # Set compiler packages and build RPi2/3 Linux kernel if required by Debian release
225 # Set compiler packages and build RPi2/3 Linux kernel if required by Debian release
226 if [ "$RELEASE" = "jessie" ] ; then
226 if [ "$RELEASE" = "jessie" ] ; then
227 COMPILER_PACKAGES="linux-compiler-gcc-4.8-arm g++ make bc"
227 COMPILER_PACKAGES="linux-compiler-gcc-4.8-arm g++ make bc"
228 elif [ "$RELEASE" = "stretch" ] ; then
228 elif [ "$RELEASE" = "stretch" ] ; then
229 COMPILER_PACKAGES="linux-compiler-gcc-5-arm g++ make bc"
229 COMPILER_PACKAGES="linux-compiler-gcc-5-arm g++ make bc"
230 BUILD_KERNEL=true
230 BUILD_KERNEL=true
231 else
231 else
232 echo "error: Debian release ${RELEASE} is not supported!"
232 echo "error: Debian release ${RELEASE} is not supported!"
233 exit 1
233 exit 1
234 fi
234 fi
235
235
236 # Add packages required for kernel cross compilation
236 # Add packages required for kernel cross compilation
237 if [ "$BUILD_KERNEL" = true ] ; then
237 if [ "$BUILD_KERNEL" = true ] ; then
238 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} crossbuild-essential-armhf"
238 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} crossbuild-essential-armhf"
239 fi
239 fi
240
240
241 # Add libncurses5 to enable kernel menuconfig
241 # Add libncurses5 to enable kernel menuconfig
242 if [ "$KERNEL_MENUCONFIG" = true ] ; then
242 if [ "$KERNEL_MENUCONFIG" = true ] ; then
243 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} libncurses5-dev"
243 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} libncurses5-dev"
244 fi
244 fi
245
245
246 # Stop the Crypto Wars
246 # Stop the Crypto Wars
247 if [ "$DISABLE_FBI" = true ] ; then
247 if [ "$DISABLE_FBI" = true ] ; then
248 ENABLE_CRYPTFS=true
248 ENABLE_CRYPTFS=true
249 fi
249 fi
250
250
251 # Add cryptsetup package to enable filesystem encryption
251 # Add cryptsetup package to enable filesystem encryption
252 if [ "$ENABLE_CRYPTFS" = true ] && [ "$BUILD_KERNEL" = true ] ; then
252 if [ "$ENABLE_CRYPTFS" = true ] && [ "$BUILD_KERNEL" = true ] ; then
253 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} cryptsetup"
253 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} cryptsetup"
254 APT_INCLUDES="${APT_INCLUDES},cryptsetup"
254 APT_INCLUDES="${APT_INCLUDES},cryptsetup"
255
255
256 if [ -z "$CRYPTFS_PASSWORD" ] ; then
256 if [ -z "$CRYPTFS_PASSWORD" ] ; then
257 echo "error: no password defined (CRYPTFS_PASSWORD)!"
257 echo "error: no password defined (CRYPTFS_PASSWORD)!"
258 exit 1
258 exit 1
259 fi
259 fi
260 ENABLE_INITRAMFS=true
260 ENABLE_INITRAMFS=true
261 fi
261 fi
262
262
263 # Add initramfs generation tools
263 # Add initramfs generation tools
264 if [ "$ENABLE_INITRAMFS" = true ] && [ "$BUILD_KERNEL" = true ] ; then
264 if [ "$ENABLE_INITRAMFS" = true ] && [ "$BUILD_KERNEL" = true ] ; then
265 APT_INCLUDES="${APT_INCLUDES},initramfs-tools"
265 APT_INCLUDES="${APT_INCLUDES},initramfs-tools"
266 fi
266 fi
267
267
268 # Add device-tree-compiler required for building the U-Boot bootloader
268 # Add device-tree-compiler required for building the U-Boot bootloader
269 if [ "$ENABLE_UBOOT" = true ] ; then
269 if [ "$ENABLE_UBOOT" = true ] ; then
270 APT_INCLUDES="${APT_INCLUDES},device-tree-compiler"
270 APT_INCLUDES="${APT_INCLUDES},device-tree-compiler"
271 fi
271 fi
272
272
273 # Check if root SSH (v2) public key file exists
273 # Check if root SSH (v2) public key file exists
274 if [ ! -z "$SSH_ROOT_PUB_KEY" ] ; then
274 if [ ! -z "$SSH_ROOT_PUB_KEY" ] ; then
275 if [ ! -f "$SSH_ROOT_PUB_KEY" ] ; then
275 if [ ! -f "$SSH_ROOT_PUB_KEY" ] ; then
276 echo "error: '$SSH_ROOT_PUB_KEY' specified SSH public key file not found (SSH_ROOT_PUB_KEY)!"
276 echo "error: '$SSH_ROOT_PUB_KEY' specified SSH public key file not found (SSH_ROOT_PUB_KEY)!"
277 exit 1
277 exit 1
278 fi
278 fi
279 fi
279 fi
280
280
281 # Check if $USER_NAME SSH (v2) public key file exists
281 # Check if $USER_NAME SSH (v2) public key file exists
282 if [ ! -z "$SSH_USER_PUB_KEY" ] ; then
282 if [ ! -z "$SSH_USER_PUB_KEY" ] ; then
283 if [ ! -f "$SSH_USER_PUB_KEY" ] ; then
283 if [ ! -f "$SSH_USER_PUB_KEY" ] ; then
284 echo "error: '$SSH_USER_PUB_KEY' specified SSH public key file not found (SSH_USER_PUB_KEY)!"
284 echo "error: '$SSH_USER_PUB_KEY' specified SSH public key file not found (SSH_USER_PUB_KEY)!"
285 exit 1
285 exit 1
286 fi
286 fi
287 fi
287 fi
288
288
289 # Check if all required packages are installed on the build system
289 # Check if all required packages are installed on the build system
290 for package in $REQUIRED_PACKAGES ; do
290 for package in $REQUIRED_PACKAGES ; do
291 if [ "`dpkg-query -W -f='${Status}' $package`" != "install ok installed" ] ; then
291 if [ "`dpkg-query -W -f='${Status}' $package`" != "install ok installed" ] ; then
292 MISSING_PACKAGES="${MISSING_PACKAGES} $package"
292 MISSING_PACKAGES="${MISSING_PACKAGES} $package"
293 fi
293 fi
294 done
294 done
295
295
296 # If there are missing packages ask confirmation for install, or exit
296 # If there are missing packages ask confirmation for install, or exit
297 if [ -n "$MISSING_PACKAGES" ] ; then
297 if [ -n "$MISSING_PACKAGES" ] ; then
298 echo "the following packages needed by this script are not installed:"
298 echo "the following packages needed by this script are not installed:"
299 echo "$MISSING_PACKAGES"
299 echo "$MISSING_PACKAGES"
300
300
301 echo -n "\ndo you want to install the missing packages right now? [y/n] "
301 echo -n "\ndo you want to install the missing packages right now? [y/n] "
302 read confirm
302 read confirm
303 [ "$confirm" != "y" ] && exit 1
303 [ "$confirm" != "y" ] && exit 1
304
304
305 # Make sure all missing required packages are installed
305 # Make sure all missing required packages are installed
306 apt-get -qq -y install ${MISSING_PACKAGES}
306 apt-get -qq -y install ${MISSING_PACKAGES}
307 fi
307 fi
308
308
309 # Check if ./bootstrap.d directory exists
309 # Check if ./bootstrap.d directory exists
310 if [ ! -d "./bootstrap.d/" ] ; then
310 if [ ! -d "./bootstrap.d/" ] ; then
311 echo "error: './bootstrap.d' required directory not found!"
311 echo "error: './bootstrap.d' required directory not found!"
312 exit 1
312 exit 1
313 fi
313 fi
314
314
315 # Check if ./files directory exists
315 # Check if ./files directory exists
316 if [ ! -d "./files/" ] ; then
316 if [ ! -d "./files/" ] ; then
317 echo "error: './files' required directory not found!"
317 echo "error: './files' required directory not found!"
318 exit 1
318 exit 1
319 fi
319 fi
320
320
321 # Check if specified KERNELSRC_DIR directory exists
321 # Check if specified KERNELSRC_DIR directory exists
322 if [ -n "$KERNELSRC_DIR" ] && [ ! -d "$KERNELSRC_DIR" ] ; then
322 if [ -n "$KERNELSRC_DIR" ] && [ ! -d "$KERNELSRC_DIR" ] ; then
323 echo "error: '${KERNELSRC_DIR}' specified directory not found (KERNELSRC_DIR)!"
323 echo "error: '${KERNELSRC_DIR}' specified directory not found (KERNELSRC_DIR)!"
324 exit 1
324 exit 1
325 fi
325 fi
326
326
327 # Check if specified CHROOT_SCRIPTS directory exists
327 # Check if specified CHROOT_SCRIPTS directory exists
328 if [ -n "$CHROOT_SCRIPTS" ] && [ ! -d "$CHROOT_SCRIPTS" ] ; then
328 if [ -n "$CHROOT_SCRIPTS" ] && [ ! -d "$CHROOT_SCRIPTS" ] ; then
329 echo "error: ${CHROOT_SCRIPTS} specified directory not found (CHROOT_SCRIPTS)!"
329 echo "error: ${CHROOT_SCRIPTS} specified directory not found (CHROOT_SCRIPTS)!"
330 exit 1
330 exit 1
331 fi
331 fi
332
332
333 # Check if specified device mapping already exists (will be used by cryptsetup)
333 # Check if specified device mapping already exists (will be used by cryptsetup)
334 if [ -r "/dev/mapping/${CRYPTFS_MAPPING}" ] ; then
334 if [ -r "/dev/mapping/${CRYPTFS_MAPPING}" ] ; then
335 echo "error: mapping /dev/mapping/${CRYPTFS_MAPPING} already exists, not proceeding"
335 echo "error: mapping /dev/mapping/${CRYPTFS_MAPPING} already exists, not proceeding"
336 exit 1
336 exit 1
337 fi
337 fi
338
338
339 # Don't clobber an old build
339 # Don't clobber an old build
340 if [ -e "$BUILDDIR" ] ; then
340 if [ -e "$BUILDDIR" ] ; then
341 echo "error: directory ${BUILDDIR} already exists, not proceeding"
341 echo "error: directory ${BUILDDIR} already exists, not proceeding"
342 exit 1
342 exit 1
343 fi
343 fi
344
344
345 # Setup chroot directory
345 # Setup chroot directory
346 mkdir -p "${R}"
346 mkdir -p "${R}"
347
347
348 # Check if build directory has enough of free disk space >512MB
348 # Check if build directory has enough of free disk space >512MB
349 if [ "$(df --output=avail ${BUILDDIR} | sed "1d")" -le "524288" ] ; then
349 if [ "$(df --output=avail ${BUILDDIR} | sed "1d")" -le "524288" ] ; then
350 echo "error: ${BUILDDIR} not enough space left to generate the output image!"
350 echo "error: ${BUILDDIR} not enough space left to generate the output image!"
351 exit 1
351 exit 1
352 fi
352 fi
353
353
354 set -x
354 set -x
355
355
356 # Call "cleanup" function on various signals and errors
356 # Call "cleanup" function on various signals and errors
357 trap cleanup 0 1 2 3 6
357 trap cleanup 0 1 2 3 6
358
358
359 # Add required packages for the minbase installation
359 # Add required packages for the minbase installation
360 if [ "$ENABLE_MINBASE" = true ] ; then
360 if [ "$ENABLE_MINBASE" = true ] ; then
361 APT_INCLUDES="${APT_INCLUDES},vim-tiny,netbase,net-tools,ifupdown"
361 APT_INCLUDES="${APT_INCLUDES},vim-tiny,netbase,net-tools,ifupdown"
362 fi
362 fi
363
363
364 # Add required locales packages
364 # Add required locales packages
365 if [ "$DEFLOCAL" != "en_US.UTF-8" ] ; then
365 if [ "$DEFLOCAL" != "en_US.UTF-8" ] ; then
366 APT_INCLUDES="${APT_INCLUDES},locales,keyboard-configuration,console-setup"
366 APT_INCLUDES="${APT_INCLUDES},locales,keyboard-configuration,console-setup"
367 fi
367 fi
368
368
369 # Add parted package, required to get partprobe utility
369 # Add parted package, required to get partprobe utility
370 if [ "$EXPANDROOT" = true ] ; then
370 if [ "$EXPANDROOT" = true ] ; then
371 APT_INCLUDES="${APT_INCLUDES},parted"
371 APT_INCLUDES="${APT_INCLUDES},parted"
372 fi
372 fi
373
373
374 # Add dbus package, recommended if using systemd
374 # Add dbus package, recommended if using systemd
375 if [ "$ENABLE_DBUS" = true ] ; then
375 if [ "$ENABLE_DBUS" = true ] ; then
376 APT_INCLUDES="${APT_INCLUDES},dbus"
376 APT_INCLUDES="${APT_INCLUDES},dbus"
377 fi
377 fi
378
378
379 # Add iptables IPv4/IPv6 package
379 # Add iptables IPv4/IPv6 package
380 if [ "$ENABLE_IPTABLES" = true ] ; then
380 if [ "$ENABLE_IPTABLES" = true ] ; then
381 APT_INCLUDES="${APT_INCLUDES},iptables"
381 APT_INCLUDES="${APT_INCLUDES},iptables"
382 fi
382 fi
383
383
384 # Add openssh server package
384 # Add openssh server package
385 if [ "$ENABLE_SSHD" = true ] ; then
385 if [ "$ENABLE_SSHD" = true ] ; then
386 APT_INCLUDES="${APT_INCLUDES},openssh-server"
386 APT_INCLUDES="${APT_INCLUDES},openssh-server"
387 fi
387 fi
388
388
389 # Add alsa-utils package
389 # Add alsa-utils package
390 if [ "$ENABLE_SOUND" = true ] ; then
390 if [ "$ENABLE_SOUND" = true ] ; then
391 APT_INCLUDES="${APT_INCLUDES},alsa-utils"
391 APT_INCLUDES="${APT_INCLUDES},alsa-utils"
392 fi
392 fi
393
393
394 # Add rng-tools package
394 # Add rng-tools package
395 if [ "$ENABLE_HWRANDOM" = true ] ; then
395 if [ "$ENABLE_HWRANDOM" = true ] ; then
396 APT_INCLUDES="${APT_INCLUDES},rng-tools"
396 APT_INCLUDES="${APT_INCLUDES},rng-tools"
397 fi
397 fi
398
398
399 # Add fbturbo video driver
399 # Add fbturbo video driver
400 if [ "$ENABLE_FBTURBO" = true ] ; then
400 if [ "$ENABLE_FBTURBO" = true ] ; then
401 # Enable xorg package dependencies
401 # Enable xorg package dependencies
402 ENABLE_XORG=true
402 ENABLE_XORG=true
403 fi
403 fi
404
404
405 # Add user defined window manager package
405 # Add user defined window manager package
406 if [ -n "$ENABLE_WM" ] ; then
406 if [ -n "$ENABLE_WM" ] ; then
407 APT_INCLUDES="${APT_INCLUDES},${ENABLE_WM}"
407 APT_INCLUDES="${APT_INCLUDES},${ENABLE_WM}"
408
408
409 # Enable xorg package dependencies
409 # Enable xorg package dependencies
410 ENABLE_XORG=true
410 ENABLE_XORG=true
411 fi
411 fi
412
412
413 # Add xorg package
413 # Add xorg package
414 if [ "$ENABLE_XORG" = true ] ; then
414 if [ "$ENABLE_XORG" = true ] ; then
415 APT_INCLUDES="${APT_INCLUDES},xorg"
415 APT_INCLUDES="${APT_INCLUDES},xorg"
416 fi
416 fi
417
417
418 # Replace selected packages with smaller clones
418 # Replace selected packages with smaller clones
419 if [ "$ENABLE_REDUCE" = true ] ; then
419 if [ "$ENABLE_REDUCE" = true ] ; then
420 # Add levee package instead of vim-tiny
420 # Add levee package instead of vim-tiny
421 if [ "$REDUCE_VIM" = true ] ; then
421 if [ "$REDUCE_VIM" = true ] ; then
422 APT_INCLUDES="$(echo ${APT_INCLUDES} | sed "s/vim-tiny/levee/")"
422 APT_INCLUDES="$(echo ${APT_INCLUDES} | sed "s/vim-tiny/levee/")"
423 fi
423 fi
424
424
425 # Add dropbear package instead of openssh-server
425 # Add dropbear package instead of openssh-server
426 if [ "$REDUCE_SSHD" = true ] ; then
426 if [ "$REDUCE_SSHD" = true ] ; then
427 APT_INCLUDES="$(echo ${APT_INCLUDES} | sed "s/openssh-server/dropbear/")"
427 APT_INCLUDES="$(echo ${APT_INCLUDES} | sed "s/openssh-server/dropbear/")"
428 fi
428 fi
429 fi
429 fi
430
430
431 # Configure kernel sources if no KERNELSRC_DIR
431 # Configure kernel sources if no KERNELSRC_DIR
432 if [ "$BUILD_KERNEL" = true ] && [ -z "$KERNELSRC_DIR" ] ; then
432 if [ "$BUILD_KERNEL" = true ] && [ -z "$KERNELSRC_DIR" ] ; then
433 KERNELSRC_CONFIG=true
433 KERNELSRC_CONFIG=true
434 fi
434 fi
435
435
436 # Configure reduced kernel
436 # Configure reduced kernel
437 if [ "$KERNEL_REDUCE" = true ] ; then
437 if [ "$KERNEL_REDUCE" = true ] ; then
438 KERNELSRC_CONFIG=false
438 KERNELSRC_CONFIG=false
439 fi
439 fi
440
440
441 # Execute bootstrap scripts
441 # Execute bootstrap scripts
442 for SCRIPT in bootstrap.d/*.sh; do
442 for SCRIPT in bootstrap.d/*.sh; do
443 head -n 3 "$SCRIPT"
443 head -n 3 "$SCRIPT"
444 . "$SCRIPT"
444 . "$SCRIPT"
445 done
445 done
446
446
447 ## Execute custom bootstrap scripts
447 ## Execute custom bootstrap scripts
448 if [ -d "custom.d" ] ; then
448 if [ -d "custom.d" ] ; then
449 for SCRIPT in custom.d/*.sh; do
449 for SCRIPT in custom.d/*.sh; do
450 . "$SCRIPT"
450 . "$SCRIPT"
451 done
451 done
452 fi
452 fi
453
453
454 # Execute custom scripts inside the chroot
454 # Execute custom scripts inside the chroot
455 if [ -n "$CHROOT_SCRIPTS" ] && [ -d "$CHROOT_SCRIPTS" ] ; then
455 if [ -n "$CHROOT_SCRIPTS" ] && [ -d "$CHROOT_SCRIPTS" ] ; then
456 cp -r "${CHROOT_SCRIPTS}" "${R}/chroot_scripts"
456 cp -r "${CHROOT_SCRIPTS}" "${R}/chroot_scripts"
457 chroot_exec /bin/bash -x <<'EOF'
457 chroot_exec /bin/bash -x <<'EOF'
458 for SCRIPT in /chroot_scripts/* ; do
458 for SCRIPT in /chroot_scripts/* ; do
459 if [ -f $SCRIPT -a -x $SCRIPT ] ; then
459 if [ -f $SCRIPT -a -x $SCRIPT ] ; then
460 $SCRIPT
460 $SCRIPT
461 fi
461 fi
462 done
462 done
463 EOF
463 EOF
464 rm -rf "${R}/chroot_scripts"
464 rm -rf "${R}/chroot_scripts"
465 fi
465 fi
466
466
467 # Remove apt-utils
467 # Remove apt-utils
468 if [ "$RELEASE" = "jessie" ] ; then
468 if [ "$RELEASE" = "jessie" ] ; then
469 chroot_exec apt-get purge -qq -y --force-yes apt-utils
469 chroot_exec apt-get purge -qq -y --force-yes apt-utils
470 fi
470 fi
471
471
472 # Generate required machine-id
472 # Generate required machine-id
473 MACHINE_ID=$(dbus-uuidgen)
473 MACHINE_ID=$(dbus-uuidgen)
474 echo -n "${MACHINE_ID}" > "${R}/var/lib/dbus/machine-id"
474 echo -n "${MACHINE_ID}" > "${R}/var/lib/dbus/machine-id"
475 echo -n "${MACHINE_ID}" > "${ETC_DIR}/machine-id"
475 echo -n "${MACHINE_ID}" > "${ETC_DIR}/machine-id"
476
476
477 # APT Cleanup
477 # APT Cleanup
478 chroot_exec apt-get -y clean
478 chroot_exec apt-get -y clean
479 chroot_exec apt-get -y autoclean
479 chroot_exec apt-get -y autoclean
480 chroot_exec apt-get -y autoremove
480 chroot_exec apt-get -y autoremove
481
481
482 # Unmount mounted filesystems
482 # Unmount mounted filesystems
483 umount -l "${R}/proc"
483 umount -l "${R}/proc"
484 umount -l "${R}/sys"
484 umount -l "${R}/sys"
485
485
486 # Clean up directories
486 # Clean up directories
487 rm -rf "${R}/run/*"
487 rm -rf "${R}/run/*"
488 rm -rf "${R}/tmp/*"
488 rm -rf "${R}/tmp/*"
489
489
490 # Clean up files
490 # Clean up files
491 rm -f "${ETC_DIR}/ssh/ssh_host_*"
491 rm -f "${ETC_DIR}/ssh/ssh_host_*"
492 rm -f "${ETC_DIR}/dropbear/dropbear_*"
492 rm -f "${ETC_DIR}/dropbear/dropbear_*"
493 rm -f "${ETC_DIR}/apt/sources.list.save"
493 rm -f "${ETC_DIR}/apt/sources.list.save"
494 rm -f "${ETC_DIR}/resolvconf/resolv.conf.d/original"
494 rm -f "${ETC_DIR}/resolvconf/resolv.conf.d/original"
495 rm -f "${ETC_DIR}/*-"
495 rm -f "${ETC_DIR}/*-"
496 rm -f "${ETC_DIR}/apt/apt.conf.d/10proxy"
496 rm -f "${ETC_DIR}/apt/apt.conf.d/10proxy"
497 rm -f "${ETC_DIR}/resolv.conf"
497 rm -f "${ETC_DIR}/resolv.conf"
498 rm -f "${R}/root/.bash_history"
498 rm -f "${R}/root/.bash_history"
499 rm -f "${R}/var/lib/urandom/random-seed"
499 rm -f "${R}/var/lib/urandom/random-seed"
500 rm -f "${R}/initrd.img"
500 rm -f "${R}/initrd.img"
501 rm -f "${R}/vmlinuz"
501 rm -f "${R}/vmlinuz"
502 rm -f "${R}${QEMU_BINARY}"
502 rm -f "${R}${QEMU_BINARY}"
503
503
504 # Calculate size of the chroot directory in KB
504 # Calculate size of the chroot directory in KB
505 CHROOT_SIZE=$(expr `du -s "${R}" | awk '{ print $1 }'`)
505 CHROOT_SIZE=$(expr `du -s "${R}" | awk '{ print $1 }'`)
506
506
507 # Calculate the amount of needed 512 Byte sectors
507 # Calculate the amount of needed 512 Byte sectors
508 TABLE_SECTORS=$(expr 1 \* 1024 \* 1024 \/ 512)
508 TABLE_SECTORS=$(expr 1 \* 1024 \* 1024 \/ 512)
509 FRMW_SECTORS=$(expr 64 \* 1024 \* 1024 \/ 512)
509 FRMW_SECTORS=$(expr 64 \* 1024 \* 1024 \/ 512)
510 ROOT_OFFSET=$(expr ${TABLE_SECTORS} + ${FRMW_SECTORS})
510 ROOT_OFFSET=$(expr ${TABLE_SECTORS} + ${FRMW_SECTORS})
511
511
512 # The root partition is EXT4
512 # The root partition is EXT4
513 # This means more space than the actual used space of the chroot is used.
513 # This means more space than the actual used space of the chroot is used.
514 # As overhead for journaling and reserved blocks 25% are added.
514 # As overhead for journaling and reserved blocks 25% are added.
515 ROOT_SECTORS=$(expr $(expr ${CHROOT_SIZE} + ${CHROOT_SIZE} \/ 100 \* 25) \* 1024 \/ 512)
515 ROOT_SECTORS=$(expr $(expr ${CHROOT_SIZE} + ${CHROOT_SIZE} \/ 100 \* 25) \* 1024 \/ 512)
516
516
517 # Calculate required image size in 512 Byte sectors
517 # Calculate required image size in 512 Byte sectors
518 IMAGE_SECTORS=$(expr ${TABLE_SECTORS} + ${FRMW_SECTORS} + ${ROOT_SECTORS})
518 IMAGE_SECTORS=$(expr ${TABLE_SECTORS} + ${FRMW_SECTORS} + ${ROOT_SECTORS})
519
519
520 # Prepare date string for image file name
520 # Prepare date string for image file name
521 DATE="$(date +%Y-%m-%d)"
521 DATE="$(date +%Y-%m-%d)"
522
522
523 # Prepare image file
523 # Prepare image file
524 if [ "$ENABLE_SPLITFS" = true ] ; then
524 if [ "$ENABLE_SPLITFS" = true ] ; then
525 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img" bs=512 count=${TABLE_SECTORS}
525 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img" bs=512 count=${TABLE_SECTORS}
526 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img" bs=512 count=0 seek=${FRMW_SECTORS}
526 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img" bs=512 count=0 seek=${FRMW_SECTORS}
527 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img" bs=512 count=${TABLE_SECTORS}
527 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img" bs=512 count=${TABLE_SECTORS}
528 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img" bs=512 count=0 seek=${ROOT_SECTORS}
528 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img" bs=512 count=0 seek=${ROOT_SECTORS}
529
529
530 # Write firmware/boot partition tables
530 # Write firmware/boot partition tables
531 sfdisk -q -L -uS -f "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img" 2> /dev/null <<EOM
531 sfdisk -q -L -uS -f "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img" 2> /dev/null <<EOM
532 ${TABLE_SECTORS},${FRMW_SECTORS},c,*
532 ${TABLE_SECTORS},${FRMW_SECTORS},c,*
533 EOM
533 EOM
534
534
535 # Write root partition table
535 # Write root partition table
536 sfdisk -q -L -uS -f "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img" 2> /dev/null <<EOM
536 sfdisk -q -L -uS -f "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img" 2> /dev/null <<EOM
537 ${TABLE_SECTORS},${ROOT_SECTORS},83
537 ${TABLE_SECTORS},${ROOT_SECTORS},83
538 EOM
538 EOM
539
539
540 # Setup temporary loop devices
540 # Setup temporary loop devices
541 FRMW_LOOP="$(losetup -o 1M --sizelimit 64M -f --show $BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img)"
541 FRMW_LOOP="$(losetup -o 1M --sizelimit 64M -f --show $BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img)"
542 ROOT_LOOP="$(losetup -o 1M -f --show $BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img)"
542 ROOT_LOOP="$(losetup -o 1M -f --show $BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img)"
543 else # ENABLE_SPLITFS=false
543 else # ENABLE_SPLITFS=false
544 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img" bs=512 count=${TABLE_SECTORS}
544 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img" bs=512 count=${TABLE_SECTORS}
545 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img" bs=512 count=0 seek=${IMAGE_SECTORS}
545 dd if=/dev/zero of="$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img" bs=512 count=0 seek=${IMAGE_SECTORS}
546
546
547 # Write partition table
547 # Write partition table
548 sfdisk -q -L -uS -f "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img" 2> /dev/null <<EOM
548 sfdisk -q -L -uS -f "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img" 2> /dev/null <<EOM
549 ${TABLE_SECTORS},${FRMW_SECTORS},c,*
549 ${TABLE_SECTORS},${FRMW_SECTORS},c,*
550 ${ROOT_OFFSET},${ROOT_SECTORS},83
550 ${ROOT_OFFSET},${ROOT_SECTORS},83
551 EOM
551 EOM
552
552
553 # Setup temporary loop devices
553 # Setup temporary loop devices
554 FRMW_LOOP="$(losetup -o 1M --sizelimit 64M -f --show $BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img)"
554 FRMW_LOOP="$(losetup -o 1M --sizelimit 64M -f --show $BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img)"
555 ROOT_LOOP="$(losetup -o 65M -f --show $BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img)"
555 ROOT_LOOP="$(losetup -o 65M -f --show $BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img)"
556 fi
556 fi
557
557
558 if [ "$ENABLE_CRYPTFS" = true ] ; then
558 if [ "$ENABLE_CRYPTFS" = true ] ; then
559 # Create dummy ext4 fs
559 # Create dummy ext4 fs
560 mkfs.ext4 "$ROOT_LOOP"
560 mkfs.ext4 "$ROOT_LOOP"
561
561
562 # Setup password keyfile
562 # Setup password keyfile
563 echo -n ${CRYPTFS_PASSWORD} > .password
563 echo -n ${CRYPTFS_PASSWORD} > .password
564 chmod 600 .password
564 chmod 600 .password
565
565
566 # Initialize encrypted partition
566 # Initialize encrypted partition
567 echo "YES" | cryptsetup luksFormat "${ROOT_LOOP}" -c "${CRYPTFS_CIPHER}" -s "${CRYPTFS_XTSKEYSIZE}" .password
567 echo "YES" | cryptsetup luksFormat "${ROOT_LOOP}" -c "${CRYPTFS_CIPHER}" -s "${CRYPTFS_XTSKEYSIZE}" .password
568
568
569 # Open encrypted partition and setup mapping
569 # Open encrypted partition and setup mapping
570 cryptsetup luksOpen "${ROOT_LOOP}" -d .password "${CRYPTFS_MAPPING}"
570 cryptsetup luksOpen "${ROOT_LOOP}" -d .password "${CRYPTFS_MAPPING}"
571
571
572 # Secure delete password keyfile
572 # Secure delete password keyfile
573 shred -zu .password
573 shred -zu .password
574
574
575 # Update temporary loop device
575 # Update temporary loop device
576 ROOT_LOOP="/dev/mapper/${CRYPTFS_MAPPING}"
576 ROOT_LOOP="/dev/mapper/${CRYPTFS_MAPPING}"
577
577
578 # Wipe encrypted partition (encryption cipher is used for randomness)
578 # Wipe encrypted partition (encryption cipher is used for randomness)
579 dd if=/dev/zero of="${ROOT_LOOP}" bs=512 count=$(blockdev --getsz "${ROOT_LOOP}")
579 dd if=/dev/zero of="${ROOT_LOOP}" bs=512 count=$(blockdev --getsz "${ROOT_LOOP}")
580 fi
580 fi
581
581
582 # Build filesystems
582 # Build filesystems
583 mkfs.vfat "$FRMW_LOOP"
583 mkfs.vfat "$FRMW_LOOP"
584 mkfs.ext4 "$ROOT_LOOP"
584 mkfs.ext4 "$ROOT_LOOP"
585
585
586 # Mount the temporary loop devices
586 # Mount the temporary loop devices
587 mkdir -p "$BUILDDIR/mount"
587 mkdir -p "$BUILDDIR/mount"
588 mount "$ROOT_LOOP" "$BUILDDIR/mount"
588 mount "$ROOT_LOOP" "$BUILDDIR/mount"
589
589
590 mkdir -p "$BUILDDIR/mount/boot/firmware"
590 mkdir -p "$BUILDDIR/mount/boot/firmware"
591 mount "$FRMW_LOOP" "$BUILDDIR/mount/boot/firmware"
591 mount "$FRMW_LOOP" "$BUILDDIR/mount/boot/firmware"
592
592
593 # Copy all files from the chroot to the loop device mount point directory
593 # Copy all files from the chroot to the loop device mount point directory
594 rsync -a "${R}/" "$BUILDDIR/mount/"
594 rsync -a "${R}/" "$BUILDDIR/mount/"
595
595
596 # Unmount all temporary loop devices and mount points
596 # Unmount all temporary loop devices and mount points
597 cleanup
597 cleanup
598
598
599 # Create block map file(s) of image(s)
599 # Create block map file(s) of image(s)
600 if [ "$ENABLE_SPLITFS" = true ] ; then
600 if [ "$ENABLE_SPLITFS" = true ] ; then
601 # Create block map files for "bmaptool"
601 # Create block map files for "bmaptool"
602 bmaptool create -o "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.bmap" "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img"
602 bmaptool create -o "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.bmap" "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img"
603 bmaptool create -o "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.bmap" "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img"
603 bmaptool create -o "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.bmap" "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img"
604
604
605 # Image was successfully created
605 # Image was successfully created
606 echo "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img ($(expr \( ${TABLE_SECTORS} + ${FRMW_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
606 echo "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-frmw.img ($(expr \( ${TABLE_SECTORS} + ${FRMW_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
607 echo "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img ($(expr \( ${TABLE_SECTORS} + ${ROOT_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
607 echo "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}-root.img ($(expr \( ${TABLE_SECTORS} + ${ROOT_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
608 else
608 else
609 # Create block map file for "bmaptool"
609 # Create block map file for "bmaptool"
610 bmaptool create -o "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.bmap" "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img"
610 bmaptool create -o "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.bmap" "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img"
611
611
612 # Image was successfully created
612 # Image was successfully created
613 echo "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img ($(expr \( ${TABLE_SECTORS} + ${FRMW_SECTORS} + ${ROOT_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
613 echo "$BASEDIR/${DATE}-rpi${RPI_MODEL}-${RELEASE}.img ($(expr \( ${TABLE_SECTORS} + ${FRMW_SECTORS} + ${ROOT_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
614 fi
614 fi
General Comments 0
Vous devez vous connecter pour laisser un commentaire. Se connecter maintenant