##// END OF EJS Templates
APT_exclude enhancment
Unknown -
r275:71dc766609bd
parent child
Show More
@@ -1,490 +1,493
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`, `stretch` and `buster`. Raspberry Pi 3 images are generated for 32-bit mode only. Raspberry Pi 3 64-bit images can be generated using custom configuration parameters (```templates/rpi3-stretch-arm64-4.11.y```).
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`, `stretch` and `buster`. Raspberry Pi 3 images are generated for 32-bit mode only. Raspberry Pi 3 64-bit images can be generated using custom configuration parameters (```templates/rpi3-stretch-arm64-4.11.y```).
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 sudo```
8 ```debootstrap debian-archive-keyring qemu-user-static binfmt-support dosfstools rsync bmap-tools whois git bc psmisc dbus sudo```
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 mandatory. 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 mandatory. 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 by debootstrap during bootstrapping.
61 A comma separated list of additional packages to be installed by debootstrap during bootstrapping.
62
62
63 ##### `APT_INCLUDES_LATE`=""
63 ##### `APT_INCLUDES_LATE`=""
64 A comma separated list of additional packages to be installed by apt after bootstrapping and after APT sources are set up. This is useful for packages with pre-depends, which debootstrap do not handle well.
64 A comma separated list of additional packages to be installed by apt after bootstrapping and after APT sources are set up. This is useful for packages with pre-depends, which debootstrap do not handle well.
65
65
66 ---
66 ---
67
67
68 #### General system settings:
68 #### General system settings:
69 ##### `RPI_MODEL`=2
69 ##### `RPI_MODEL`=2
70 Specifiy the target Raspberry Pi hardware model. The script at this time supports the following Raspberry Pi models:
70 Specifiy the target Raspberry Pi hardware model. The script at this time supports the following Raspberry Pi models:
71 `0` = Used for Raspberry Pi 0 and Raspberry Pi 0 W
71 `0` = Used for Raspberry Pi 0 and Raspberry Pi 0 W
72 `1` = Used for Pi 1 model A and B
72 `1` = Used for Pi 1 model A and B
73 `1P` = Used for Pi 1 model B+ and A+
73 `1P` = Used for Pi 1 model B+ and A+
74 `2` = Used for Pi 2 model B
74 `2` = Used for Pi 2 model B
75 `3` = Used for Pi 3 model B
75 `3` = Used for Pi 3 model B
76 `3P` = Used for Pi 3 model B+
76 `3P` = Used for Pi 3 model B+
77 `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` or `3P` is used.
77 `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` or `3P` is used.
78
78
79 ##### `RELEASE`="jessie"
79 ##### `RELEASE`="jessie"
80 Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases "jessie", "stretch" and "buster". `BUILD_KERNEL`=true will automatically be set if the Debian releases `stretch` or `buster` are used.
80 Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases "jessie", "stretch" and "buster". `BUILD_KERNEL`=true will automatically be set if the Debian releases `stretch` or `buster` are used.
81
81
82 ##### `RELEASE_ARCH`="armhf"
82 ##### `RELEASE_ARCH`="armhf"
83 Set the desired Debian release architecture.
83 Set the desired Debian release architecture.
84
84
85 ##### `HOSTNAME`="rpi$RPI_MODEL-$RELEASE"
85 ##### `HOSTNAME`="rpi$RPI_MODEL-$RELEASE"
86 Set system host name. It's recommended that the host name is unique in the corresponding subnet.
86 Set system host name. It's recommended that the host name is unique in the corresponding subnet.
87
87
88 ##### `PASSWORD`="raspberry"
88 ##### `PASSWORD`="raspberry"
89 Set system `root` password. It's **STRONGLY** recommended that you choose a custom password.
89 Set system `root` password. It's **STRONGLY** recommended that you choose a custom password.
90
90
91 ##### `USER_PASSWORD`="raspberry"
91 ##### `USER_PASSWORD`="raspberry"
92 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.
92 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.
93
93
94 ##### `DEFLOCAL`="en_US.UTF-8"
94 ##### `DEFLOCAL`="en_US.UTF-8"
95 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`.
95 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`.
96
96
97 ##### `TIMEZONE`="Europe/Berlin"
97 ##### `TIMEZONE`="Europe/Berlin"
98 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.
98 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.
99
99
100 ##### `EXPANDROOT`=true
100 ##### `EXPANDROOT`=true
101 Expand the root partition and filesystem automatically on first boot.
101 Expand the root partition and filesystem automatically on first boot.
102
102
103 ##### `ENABLE_QEMU`=false
103 ##### `ENABLE_QEMU`=false
104 Generate kernel (`vexpress_defconfig`), file system image (`qcow2`) and DTB files that can be used for QEMU full system emulation (`vexpress-A15`). The output files are stored in the `$(pwd)/images/qemu` directory. You can find more information about running the generated image in the QEMU section of this readme file.
104 Generate kernel (`vexpress_defconfig`), file system image (`qcow2`) and DTB files that can be used for QEMU full system emulation (`vexpress-A15`). The output files are stored in the `$(pwd)/images/qemu` directory. You can find more information about running the generated image in the QEMU section of this readme file.
105
105
106 ---
106 ---
107
107
108 #### Keyboard settings:
108 #### Keyboard settings:
109 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.
109 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.
110
110
111 ##### `XKB_MODEL`=""
111 ##### `XKB_MODEL`=""
112 Set the name of the model of your keyboard type.
112 Set the name of the model of your keyboard type.
113
113
114 ##### `XKB_LAYOUT`=""
114 ##### `XKB_LAYOUT`=""
115 Set the supported keyboard layout(s).
115 Set the supported keyboard layout(s).
116
116
117 ##### `XKB_VARIANT`=""
117 ##### `XKB_VARIANT`=""
118 Set the supported variant(s) of the keyboard layout(s).
118 Set the supported variant(s) of the keyboard layout(s).
119
119
120 ##### `XKB_OPTIONS`=""
120 ##### `XKB_OPTIONS`=""
121 Set extra xkb configuration options.
121 Set extra xkb configuration options.
122
122
123 ---
123 ---
124
124
125 #### Networking settings (DHCP):
125 #### Networking settings (DHCP):
126 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`.`
126 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`.`
127
127
128 ##### `ENABLE_DHCP`=true
128 ##### `ENABLE_DHCP`=true
129 Set the system to use DHCP. This requires an DHCP server.
129 Set the system to use DHCP. This requires an DHCP server.
130
130
131 ---
131 ---
132
132
133 #### Networking settings (static):
133 #### Networking settings (static):
134 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`.
134 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`.
135
135
136 ##### `NET_ADDRESS`=""
136 ##### `NET_ADDRESS`=""
137 Set a static IPv4 or IPv6 address and its prefix, separated by "/", eg. "192.169.0.3/24".
137 Set a static IPv4 or IPv6 address and its prefix, separated by "/", eg. "192.169.0.3/24".
138
138
139 ##### `NET_GATEWAY`=""
139 ##### `NET_GATEWAY`=""
140 Set the IP address for the default gateway.
140 Set the IP address for the default gateway.
141
141
142 ##### `NET_DNS_1`=""
142 ##### `NET_DNS_1`=""
143 Set the IP address for the first DNS server.
143 Set the IP address for the first DNS server.
144
144
145 ##### `NET_DNS_2`=""
145 ##### `NET_DNS_2`=""
146 Set the IP address for the second DNS server.
146 Set the IP address for the second DNS server.
147
147
148 ##### `NET_DNS_DOMAINS`=""
148 ##### `NET_DNS_DOMAINS`=""
149 Set the default DNS search domains to use for non fully qualified host names.
149 Set the default DNS search domains to use for non fully qualified host names.
150
150
151 ##### `NET_NTP_1`=""
151 ##### `NET_NTP_1`=""
152 Set the IP address for the first NTP server.
152 Set the IP address for the first NTP server.
153
153
154 ##### `NET_NTP_2`=""
154 ##### `NET_NTP_2`=""
155 Set the IP address for the second NTP server.
155 Set the IP address for the second NTP server.
156
156
157 ---
157 ---
158
158
159 #### Basic system features:
159 #### Basic system features:
160 ##### `ENABLE_CONSOLE`=true
160 ##### `ENABLE_CONSOLE`=true
161 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.
161 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.
162
162
163 ##### `ENABLE_I2C`=false
163 ##### `ENABLE_I2C`=false
164 Enable I2C interface on the RPi2/3. Please check the [RPi2/3 pinout diagrams](https://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.
164 Enable I2C interface on the RPi2/3. Please check the [RPi2/3 pinout diagrams](https://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.
165
165
166 ##### `ENABLE_SPI`=false
166 ##### `ENABLE_SPI`=false
167 Enable SPI interface on the RPi2/3. Please check the [RPi2/3 pinout diagrams](https://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.
167 Enable SPI interface on the RPi2/3. Please check the [RPi2/3 pinout diagrams](https://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.
168
168
169 ##### `ENABLE_IPV6`=true
169 ##### `ENABLE_IPV6`=true
170 Enable IPv6 support. The network interface configuration is managed via systemd-networkd.
170 Enable IPv6 support. The network interface configuration is managed via systemd-networkd.
171
171
172 ##### `ENABLE_SSHD`=true
172 ##### `ENABLE_SSHD`=true
173 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.
173 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.
174
174
175 ##### `ENABLE_NONFREE`=false
175 ##### `ENABLE_NONFREE`=false
176 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.
176 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.
177
177
178 ##### `ENABLE_WIRELESS`=false
178 ##### `ENABLE_WIRELESS`=false
179 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`.
179 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`.
180
180
181 ##### `ENABLE_RSYSLOG`=true
181 ##### `ENABLE_RSYSLOG`=true
182 If set to false, disable and uninstall rsyslog (so logs will be available only
182 If set to false, disable and uninstall rsyslog (so logs will be available only
183 in journal files)
183 in journal files)
184
184
185 ##### `ENABLE_SOUND`=true
185 ##### `ENABLE_SOUND`=true
186 Enable sound hardware and install Advanced Linux Sound Architecture.
186 Enable sound hardware and install Advanced Linux Sound Architecture.
187
187
188 ##### `ENABLE_HWRANDOM`=true
188 ##### `ENABLE_HWRANDOM`=true
189 Enable Hardware Random Number Generator. Strong random numbers are important for most network based communications that use encryption. It's recommended to be enabled.
189 Enable Hardware Random Number Generator. Strong random numbers are important for most network based communications that use encryption. It's recommended to be enabled.
190
190
191 ##### `ENABLE_MINGPU`=false
191 ##### `ENABLE_MINGPU`=false
192 Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU.
192 Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU.
193
193
194 ##### `ENABLE_DBUS`=true
194 ##### `ENABLE_DBUS`=true
195 Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled.
195 Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled.
196
196
197 ##### `ENABLE_XORG`=false
197 ##### `ENABLE_XORG`=false
198 Install Xorg open-source X Window System.
198 Install Xorg open-source X Window System.
199
199
200 ##### `ENABLE_WM`=""
200 ##### `ENABLE_WM`=""
201 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`.
201 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`.
202
202
203 ##### `ENABLE_SYSVINIT`=false
204 Support for halt,init,poweroff,reboot,runlevel,shutdown,telinit commands
205
203 ---
206 ---
204
207
205 #### Advanced system features:
208 #### Advanced system features:
206 ##### `ENABLE_MINBASE`=false
209 ##### `ENABLE_MINBASE`=false
207 Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
210 Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
208
211
209 ##### `ENABLE_REDUCE`=false
212 ##### `ENABLE_REDUCE`=false
210 Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.
213 Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.
211
214
212 ##### `ENABLE_UBOOT`=false
215 ##### `ENABLE_UBOOT`=false
213 Replace the default RPi2/3 second stage bootloader (bootcode.bin) with [U-Boot bootloader](https://git.denx.de/?p=u-boot.git;a=summary). U-Boot can boot images via the network using the BOOTP/TFTP protocol.
216 Replace the default RPi2/3 second stage bootloader (bootcode.bin) with [U-Boot bootloader](https://git.denx.de/?p=u-boot.git;a=summary). U-Boot can boot images via the network using the BOOTP/TFTP protocol.
214
217
215 ##### `UBOOTSRC_DIR`=""
218 ##### `UBOOTSRC_DIR`=""
216 Path to a directory (`u-boot`) of [U-Boot bootloader sources](https://git.denx.de/?p=u-boot.git;a=summary) that will be copied, configured, build and installed inside the chroot.
219 Path to a directory (`u-boot`) of [U-Boot bootloader sources](https://git.denx.de/?p=u-boot.git;a=summary) that will be copied, configured, build and installed inside the chroot.
217
220
218 ##### `ENABLE_FBTURBO`=false
221 ##### `ENABLE_FBTURBO`=false
219 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.
222 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.
220
223
221 ##### `FBTURBOSRC_DIR`=""
224 ##### `FBTURBOSRC_DIR`=""
222 Path to a directory (`xf86-video-fbturbo`) of [hardware accelerated Xorg video driver sources](https://github.com/ssvb/xf86-video-fbturbo) that will be copied, configured, build and installed inside the chroot.
225 Path to a directory (`xf86-video-fbturbo`) of [hardware accelerated Xorg video driver sources](https://github.com/ssvb/xf86-video-fbturbo) that will be copied, configured, build and installed inside the chroot.
223
226
224 ##### `ENABLE_IPTABLES`=false
227 ##### `ENABLE_IPTABLES`=false
225 Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.
228 Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.
226
229
227 ##### `ENABLE_USER`=true
230 ##### `ENABLE_USER`=true
228 Create non-root user with password `USER_PASSWORD`=raspberry. Unless overridden with `USER_NAME`=user, username will be `pi`.
231 Create non-root user with password `USER_PASSWORD`=raspberry. Unless overridden with `USER_NAME`=user, username will be `pi`.
229
232
230 ##### `USER_NAME`=pi
233 ##### `USER_NAME`=pi
231 Non-root user to create. Ignored if `ENABLE_USER`=false
234 Non-root user to create. Ignored if `ENABLE_USER`=false
232
235
233 ##### `ENABLE_ROOT`=false
236 ##### `ENABLE_ROOT`=false
234 Set root user password so root login will be enabled
237 Set root user password so root login will be enabled
235
238
236 ##### `ENABLE_HARDNET`=false
239 ##### `ENABLE_HARDNET`=false
237 Enable IPv4/IPv6 network stack hardening settings.
240 Enable IPv4/IPv6 network stack hardening settings.
238
241
239 ##### `ENABLE_SPLITFS`=false
242 ##### `ENABLE_SPLITFS`=false
240 Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.
243 Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.
241
244
242 ##### `CHROOT_SCRIPTS`=""
245 ##### `CHROOT_SCRIPTS`=""
243 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.
246 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.
244
247
245 ##### `ENABLE_INITRAMFS`=false
248 ##### `ENABLE_INITRAMFS`=false
246 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.
249 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.
247
250
248 ##### `ENABLE_IFNAMES`=true
251 ##### `ENABLE_IFNAMES`=true
249 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 releases `stretch` or `buster` are used.
252 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 releases `stretch` or `buster` are used.
250
253
251 ##### `DISABLE_UNDERVOLT_WARNINGS`=
254 ##### `DISABLE_UNDERVOLT_WARNINGS`=
252 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.
255 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.
253
256
254 ---
257 ---
255
258
256 #### SSH settings:
259 #### SSH settings:
257 ##### `SSH_ENABLE_ROOT`=false
260 ##### `SSH_ENABLE_ROOT`=false
258 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`.
261 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`.
259
262
260 ##### `SSH_DISABLE_PASSWORD_AUTH`=false
263 ##### `SSH_DISABLE_PASSWORD_AUTH`=false
261 Disable password based SSH authentication. Only public key based SSH (v2) authentication will be supported.
264 Disable password based SSH authentication. Only public key based SSH (v2) authentication will be supported.
262
265
263 ##### `SSH_LIMIT_USERS`=false
266 ##### `SSH_LIMIT_USERS`=false
264 Limit the users that are allowed to login via SSH. Only allow user `USER_NAME`=pi and root if `SSH_ENABLE_ROOT`=true to login. This parameter will be ignored if `dropbear` SSH is used (`REDUCE_SSHD`=true).
267 Limit the users that are allowed to login via SSH. Only allow user `USER_NAME`=pi and root if `SSH_ENABLE_ROOT`=true to login. This parameter will be ignored if `dropbear` SSH is used (`REDUCE_SSHD`=true).
265
268
266 ##### `SSH_ROOT_PUB_KEY`=""
269 ##### `SSH_ROOT_PUB_KEY`=""
267 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`.
270 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`.
268
271
269 ##### `SSH_USER_PUB_KEY`=""
272 ##### `SSH_USER_PUB_KEY`=""
270 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.
273 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.
271
274
272 ---
275 ---
273
276
274 #### Kernel compilation:
277 #### Kernel compilation:
275 ##### `BUILD_KERNEL`=false
278 ##### `BUILD_KERNEL`=false
276 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.
279 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.
277
280
278 ##### `CROSS_COMPILE`="arm-linux-gnueabihf-"
281 ##### `CROSS_COMPILE`="arm-linux-gnueabihf-"
279 This sets the cross compile enviornment for the compiler.
282 This sets the cross compile enviornment for the compiler.
280
283
281 ##### `KERNEL_ARCH`="arm"
284 ##### `KERNEL_ARCH`="arm"
282 This sets the kernel architecture for the compiler.
285 This sets the kernel architecture for the compiler.
283
286
284 ##### `KERNEL_IMAGE`="kernel7.img"
287 ##### `KERNEL_IMAGE`="kernel7.img"
285 Name of the image file in the boot partition. If not set, `KERNEL_IMAGE` will be set to "kernel8.img" automatically if building for arm64.
288 Name of the image file in the boot partition. If not set, `KERNEL_IMAGE` will be set to "kernel8.img" automatically if building for arm64.
286
289
287 ##### `KERNEL_BRANCH`=""
290 ##### `KERNEL_BRANCH`=""
288 Name of the requested branch from the GIT location for the RPi Kernel. Default is using the current default branch from the GIT site.
291 Name of the requested branch from the GIT location for the RPi Kernel. Default is using the current default branch from the GIT site.
289
292
290 ##### `QEMU_BINARY`="/usr/bin/qemu-arm-static"
293 ##### `QEMU_BINARY`="/usr/bin/qemu-arm-static"
291 Sets the QEMU enviornment for the Debian archive. If not set, `QEMU_BINARY` will be set to "/usr/bin/qemu-aarch64-static" automatically if building for arm64.
294 Sets the QEMU enviornment for the Debian archive. If not set, `QEMU_BINARY` will be set to "/usr/bin/qemu-aarch64-static" automatically if building for arm64.
292
295
293 ##### `KERNEL_DEFCONFIG`="bcm2709_defconfig"
296 ##### `KERNEL_DEFCONFIG`="bcm2709_defconfig"
294 Sets the default config for kernel compiling. If not set, `KERNEL_DEFCONFIG` will be set to "bcmrpi3\_defconfig" automatically if building for arm64.
297 Sets the default config for kernel compiling. If not set, `KERNEL_DEFCONFIG` will be set to "bcmrpi3\_defconfig" automatically if building for arm64.
295
298
296 ##### `KERNEL_REDUCE`=false
299 ##### `KERNEL_REDUCE`=false
297 Reduce the size of the generated kernel by removing unwanted device, network and filesystem drivers (experimental).
300 Reduce the size of the generated kernel by removing unwanted device, network and filesystem drivers (experimental).
298
301
299 ##### `KERNEL_THREADS`=1
302 ##### `KERNEL_THREADS`=1
300 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.
303 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.
301
304
302 ##### `KERNEL_HEADERS`=true
305 ##### `KERNEL_HEADERS`=true
303 Install kernel headers with built kernel.
306 Install kernel headers with built kernel.
304
307
305 ##### `KERNEL_MENUCONFIG`=false
308 ##### `KERNEL_MENUCONFIG`=false
306 Start `make menuconfig` interactive menu-driven kernel configuration. The script will continue after `make menuconfig` was terminated.
309 Start `make menuconfig` interactive menu-driven kernel configuration. The script will continue after `make menuconfig` was terminated.
307
310
308 ##### `KERNEL_OLDDEFCONFIG`=false
311 ##### `KERNEL_OLDDEFCONFIG`=false
309 Run `make olddefconfig` to automatically set all new kernel configuration options to their recommended default values.
312 Run `make olddefconfig` to automatically set all new kernel configuration options to their recommended default values.
310
313
311 ##### `KERNEL_CCACHE`=false
314 ##### `KERNEL_CCACHE`=false
312 Compile the kernel using ccache. This speeds up kernel recompilation by caching previous compilations and detecting when the same compilation is being done again.
315 Compile the kernel using ccache. This speeds up kernel recompilation by caching previous compilations and detecting when the same compilation is being done again.
313
316
314 ##### `KERNEL_REMOVESRC`=true
317 ##### `KERNEL_REMOVESRC`=true
315 Remove all kernel sources from the generated OS image after it was built and installed.
318 Remove all kernel sources from the generated OS image after it was built and installed.
316
319
317 ##### `KERNELSRC_DIR`=""
320 ##### `KERNELSRC_DIR`=""
318 Path to a directory (`linux`) of [RaspberryPi Linux kernel sources](https://github.com/raspberrypi/linux) that will be copied, configured, build and installed inside the chroot.
321 Path to a directory (`linux`) of [RaspberryPi Linux kernel sources](https://github.com/raspberrypi/linux) that will be copied, configured, build and installed inside the chroot.
319
322
320 ##### `KERNELSRC_CLEAN`=false
323 ##### `KERNELSRC_CLEAN`=false
321 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.
324 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.
322
325
323 ##### `KERNELSRC_CONFIG`=true
326 ##### `KERNELSRC_CONFIG`=true
324 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.
327 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.
325
328
326 ##### `KERNELSRC_USRCONFIG`=""
329 ##### `KERNELSRC_USRCONFIG`=""
327 Copy own config file to kernel `.config`. If `KERNEL_MENUCONFIG`=true then running after copy.
330 Copy own config file to kernel `.config`. If `KERNEL_MENUCONFIG`=true then running after copy.
328
331
329 ##### `KERNELSRC_PREBUILT`=false
332 ##### `KERNELSRC_PREBUILT`=false
330 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.
333 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.
331
334
332 ##### `RPI_FIRMWARE_DIR`=""
335 ##### `RPI_FIRMWARE_DIR`=""
333 The directory (`firmware`) containing a local copy of the firmware from the [RaspberryPi firmware project](https://github.com/raspberrypi/firmware). Default is to download the latest firmware directly from the project.
336 The directory (`firmware`) containing a local copy of the firmware from the [RaspberryPi firmware project](https://github.com/raspberrypi/firmware). Default is to download the latest firmware directly from the project.
334
337
335 ---
338 ---
336
339
337 #### Reduce disk usage:
340 #### Reduce disk usage:
338 The following list of parameters is ignored if `ENABLE_REDUCE`=false.
341 The following list of parameters is ignored if `ENABLE_REDUCE`=false.
339
342
340 ##### `REDUCE_APT`=true
343 ##### `REDUCE_APT`=true
341 Configure APT to use compressed package repository lists and no package caching files.
344 Configure APT to use compressed package repository lists and no package caching files.
342
345
343 ##### `REDUCE_DOC`=true
346 ##### `REDUCE_DOC`=true
344 Remove all doc files (harsh). Configure APT to not include doc files on future `apt-get` package installations.
347 Remove all doc files (harsh). Configure APT to not include doc files on future `apt-get` package installations.
345
348
346 ##### `REDUCE_MAN`=true
349 ##### `REDUCE_MAN`=true
347 Remove all man pages and info files (harsh). Configure APT to not include man pages on future `apt-get` package installations.
350 Remove all man pages and info files (harsh). Configure APT to not include man pages on future `apt-get` package installations.
348
351
349 ##### `REDUCE_VIM`=false
352 ##### `REDUCE_VIM`=false
350 Replace `vim-tiny` package by `levee` a tiny vim clone.
353 Replace `vim-tiny` package by `levee` a tiny vim clone.
351
354
352 ##### `REDUCE_BASH`=false
355 ##### `REDUCE_BASH`=false
353 Remove `bash` package and switch to `dash` shell (experimental).
356 Remove `bash` package and switch to `dash` shell (experimental).
354
357
355 ##### `REDUCE_HWDB`=true
358 ##### `REDUCE_HWDB`=true
356 Remove PCI related hwdb files (experimental).
359 Remove PCI related hwdb files (experimental).
357
360
358 ##### `REDUCE_SSHD`=true
361 ##### `REDUCE_SSHD`=true
359 Replace `openssh-server` with `dropbear`.
362 Replace `openssh-server` with `dropbear`.
360
363
361 ##### `REDUCE_LOCALE`=true
364 ##### `REDUCE_LOCALE`=true
362 Remove all `locale` translation files.
365 Remove all `locale` translation files.
363
366
364 ---
367 ---
365
368
366 #### Encrypted root partition:
369 #### Encrypted root partition:
367 ##### `ENABLE_CRYPTFS`=false
370 ##### `ENABLE_CRYPTFS`=false
368 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.
371 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.
369
372
370 ##### `CRYPTFS_PASSWORD`=""
373 ##### `CRYPTFS_PASSWORD`=""
371 Set password of the encrypted root partition. This parameter is mandatory if `ENABLE_CRYPTFS`=true.
374 Set password of the encrypted root partition. This parameter is mandatory if `ENABLE_CRYPTFS`=true.
372
375
373 ##### `CRYPTFS_MAPPING`="secure"
376 ##### `CRYPTFS_MAPPING`="secure"
374 Set name of dm-crypt managed device-mapper mapping.
377 Set name of dm-crypt managed device-mapper mapping.
375
378
376 ##### `CRYPTFS_CIPHER`="aes-xts-plain64:sha512"
379 ##### `CRYPTFS_CIPHER`="aes-xts-plain64:sha512"
377 Set cipher specification string. `aes-xts*` ciphers are strongly recommended.
380 Set cipher specification string. `aes-xts*` ciphers are strongly recommended.
378
381
379 ##### `CRYPTFS_XTSKEYSIZE`=512
382 ##### `CRYPTFS_XTSKEYSIZE`=512
380 Sets key size in bits. The argument has to be a multiple of 8.
383 Sets key size in bits. The argument has to be a multiple of 8.
381
384
382 ---
385 ---
383
386
384 #### Build settings:
387 #### Build settings:
385 ##### `BASEDIR`=$(pwd)/images/${RELEASE}
388 ##### `BASEDIR`=$(pwd)/images/${RELEASE}
386 Set a path to a working directory used by the script to generate an image.
389 Set a path to a working directory used by the script to generate an image.
387
390
388 ##### `IMAGE_NAME`=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}
391 ##### `IMAGE_NAME`=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}
389 Set a filename for the output file(s). Note: the script will create $IMAGE_NAME.img if `ENABLE_SPLITFS`=false or $IMAGE_NAME-frmw.img and $IMAGE_NAME-root.img if `ENABLE_SPLITFS`=true. Note 2: If the KERNEL_BRANCH is not set, the word "CURRENT" is used.
392 Set a filename for the output file(s). Note: the script will create $IMAGE_NAME.img if `ENABLE_SPLITFS`=false or $IMAGE_NAME-frmw.img and $IMAGE_NAME-root.img if `ENABLE_SPLITFS`=true. Note 2: If the KERNEL_BRANCH is not set, the word "CURRENT" is used.
390
393
391 ## Understanding the script
394 ## Understanding the script
392 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:
395 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:
393
396
394 | Script | Description |
397 | Script | Description |
395 | --- | --- |
398 | --- | --- |
396 | `10-bootstrap.sh` | Debootstrap basic system |
399 | `10-bootstrap.sh` | Debootstrap basic system |
397 | `11-apt.sh` | Setup APT repositories |
400 | `11-apt.sh` | Setup APT repositories |
398 | `12-locale.sh` | Setup Locales and keyboard settings |
401 | `12-locale.sh` | Setup Locales and keyboard settings |
399 | `13-kernel.sh` | Build and install RPi2/3 Kernel |
402 | `13-kernel.sh` | Build and install RPi2/3 Kernel |
400 | `14-fstab.sh` | Setup fstab and initramfs |
403 | `14-fstab.sh` | Setup fstab and initramfs |
401 | `15-rpi-config.sh` | Setup RPi2/3 config and cmdline |
404 | `15-rpi-config.sh` | Setup RPi2/3 config and cmdline |
402 | `20-networking.sh` | Setup Networking |
405 | `20-networking.sh` | Setup Networking |
403 | `21-firewall.sh` | Setup Firewall |
406 | `21-firewall.sh` | Setup Firewall |
404 | `30-security.sh` | Setup Users and Security settings |
407 | `30-security.sh` | Setup Users and Security settings |
405 | `31-logging.sh` | Setup Logging |
408 | `31-logging.sh` | Setup Logging |
406 | `32-sshd.sh` | Setup SSH and public keys |
409 | `32-sshd.sh` | Setup SSH and public keys |
407 | `41-uboot.sh` | Build and Setup U-Boot |
410 | `41-uboot.sh` | Build and Setup U-Boot |
408 | `42-fbturbo.sh` | Build and Setup fbturbo Xorg driver |
411 | `42-fbturbo.sh` | Build and Setup fbturbo Xorg driver |
409 | `50-firstboot.sh` | First boot actions |
412 | `50-firstboot.sh` | First boot actions |
410 | `99-reduce.sh` | Reduce the disk space usage |
413 | `99-reduce.sh` | Reduce the disk space usage |
411
414
412 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.
415 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.
413
416
414 | Directory | Description |
417 | Directory | Description |
415 | --- | --- |
418 | --- | --- |
416 | `apt` | APT management configuration files |
419 | `apt` | APT management configuration files |
417 | `boot` | Boot and RPi2/3 configuration files |
420 | `boot` | Boot and RPi2/3 configuration files |
418 | `dpkg` | Package Manager configuration |
421 | `dpkg` | Package Manager configuration |
419 | `etc` | Configuration files and rc scripts |
422 | `etc` | Configuration files and rc scripts |
420 | `firstboot` | Scripts that get executed on first boot |
423 | `firstboot` | Scripts that get executed on first boot |
421 | `initramfs` | Initramfs scripts |
424 | `initramfs` | Initramfs scripts |
422 | `iptables` | Firewall configuration files |
425 | `iptables` | Firewall configuration files |
423 | `locales` | Locales configuration |
426 | `locales` | Locales configuration |
424 | `modules` | Kernel Modules configuration |
427 | `modules` | Kernel Modules configuration |
425 | `mount` | Fstab configuration |
428 | `mount` | Fstab configuration |
426 | `network` | Networking configuration files |
429 | `network` | Networking configuration files |
427 | `sysctl.d` | Swapping and Network Hardening configuration |
430 | `sysctl.d` | Swapping and Network Hardening configuration |
428 | `xorg` | fbturbo Xorg driver configuration |
431 | `xorg` | fbturbo Xorg driver configuration |
429
432
430 ## Custom packages and scripts
433 ## Custom packages and scripts
431 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`.
434 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`.
432
435
433 Scripts in the custom.d directory will be executed after all other installation is complete but before the image is created.
436 Scripts in the custom.d directory will be executed after all other installation is complete but before the image is created.
434
437
435 ## Logging of the bootstrapping process
438 ## Logging of the bootstrapping process
436 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:
439 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:
437
440
438 ```shell
441 ```shell
439 script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log
442 script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log
440 ```
443 ```
441
444
442 ## Flashing the image file
445 ## Flashing the image file
443 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`.
446 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`.
444
447
445 ##### Flashing examples:
448 ##### Flashing examples:
446 ```shell
449 ```shell
447 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie.img /dev/mmcblk0
450 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie.img /dev/mmcblk0
448 dd bs=4M if=./images/jessie/2017-01-23-rpi3-jessie.img of=/dev/mmcblk0
451 dd bs=4M if=./images/jessie/2017-01-23-rpi3-jessie.img of=/dev/mmcblk0
449 ```
452 ```
450 If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:
453 If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:
451 ```shell
454 ```shell
452 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie-frmw.img /dev/mmcblk0
455 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie-frmw.img /dev/mmcblk0
453 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie-root.img /dev/sdc
456 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie-root.img /dev/sdc
454 ```
457 ```
455
458
456 ## QEMU emulation
459 ## QEMU emulation
457 Start QEMU full system emulation:
460 Start QEMU full system emulation:
458 ```shell
461 ```shell
459 qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=tty1"
462 qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=tty1"
460 ```
463 ```
461
464
462 Start QEMU full system emulation and output to console:
465 Start QEMU full system emulation and output to console:
463 ```shell
466 ```shell
464 qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio
467 qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio
465 ```
468 ```
466
469
467 Start QEMU full system emulation with SMP and output to console:
470 Start QEMU full system emulation with SMP and output to console:
468 ```shell
471 ```shell
469 qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -smp cpus=2,maxcpus=2 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio
472 qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -smp cpus=2,maxcpus=2 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio
470 ```
473 ```
471
474
472 Start QEMU full system emulation with cryptfs, initramfs and output to console:
475 Start QEMU full system emulation with cryptfs, initramfs and output to console:
473 ```shell
476 ```shell
474 qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -initrd "initramfs-${KERNEL_VERSION}" -append "root=/dev/mapper/secure cryptdevice=/dev/mmcblk0p2:secure rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio
477 qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -initrd "initramfs-${KERNEL_VERSION}" -append "root=/dev/mapper/secure cryptdevice=/dev/mmcblk0p2:secure rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio
475 ```
478 ```
476
479
477 ## Weekly image builds
480 ## Weekly image builds
478 The image files are provided by JRWR'S I/O PORT and are built once a Sunday at midnight UTC!
481 The image files are provided by JRWR'S I/O PORT and are built once a Sunday at midnight UTC!
479 * [Debian Stretch Raspberry Pi2/3 Weekly Image Builds](https://jrwr.io/doku.php?id=projects:debianpi)
482 * [Debian Stretch Raspberry Pi2/3 Weekly Image Builds](https://jrwr.io/doku.php?id=projects:debianpi)
480
483
481 ## External links and references
484 ## External links and references
482 * [Debian worldwide mirror sites](https://www.debian.org/mirror/list)
485 * [Debian worldwide mirror sites](https://www.debian.org/mirror/list)
483 * [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)
486 * [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)
484 * [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains)
487 * [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains)
485 * [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)
488 * [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)
486 * [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)
489 * [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)
487 * [U-BOOT git repository](https://git.denx.de/?p=u-boot.git;a=summary)
490 * [U-BOOT git repository](https://git.denx.de/?p=u-boot.git;a=summary)
488 * [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)
491 * [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)
489 * [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/brcm)
492 * [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/brcm)
490 * [Collabora RPi2 Kernel precompiled](https://repositories.collabora.co.uk/debian/)
493 * [Collabora RPi2 Kernel precompiled](https://repositories.collabora.co.uk/debian/)
@@ -1,774 +1,783
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", "stretch" and "buster" bootstrap script for RPi2/3
6 # Advanced Debian "jessie", "stretch" and "buster" 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 20+ github contributors!
15 # Big thanks for patches and enhancements by 20+ 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
45
46 #bcm2708-rpi-0-w.dtb (Used for Pi 0 and PI 0W)
46 #bcm2708-rpi-0-w.dtb (Used for Pi 0 and PI 0W)
47 RPI0_DTB_FILE=${RPI0_DTB_FILE:=bcm2708-rpi-0-w.dtb}
47 RPI0_DTB_FILE=${RPI0_DTB_FILE:=bcm2708-rpi-0-w.dtb}
48 RPI0_UBOOT_CONFIG=${RPI0_UBOOT_CONFIG:=rpi_defconfig}
48 RPI0_UBOOT_CONFIG=${RPI0_UBOOT_CONFIG:=rpi_defconfig}
49
49
50 #bcm2708-rpi-b.dtb (Used for Pi 1 model A and B)
50 #bcm2708-rpi-b.dtb (Used for Pi 1 model A and B)
51 RPI1_DTB_FILE=${RPI1_DTB_FILE:=bcm2708-rpi-b.dtb}
51 RPI1_DTB_FILE=${RPI1_DTB_FILE:=bcm2708-rpi-b.dtb}
52 RPI1_UBOOT_CONFIG=${RPI1_UBOOT_CONFIG:=rpi_defconfig}
52 RPI1_UBOOT_CONFIG=${RPI1_UBOOT_CONFIG:=rpi_defconfig}
53
53
54 #bcm2708-rpi-b-plus.dtb (Used for Pi 1 model B+ and A+)
54 #bcm2708-rpi-b-plus.dtb (Used for Pi 1 model B+ and A+)
55 RPI1P_DTB_FILE=${RPI1P_DTB_FILE:=bcm2708-rpi-b-plus.dtb}
55 RPI1P_DTB_FILE=${RPI1P_DTB_FILE:=bcm2708-rpi-b-plus.dtb}
56 RPI1P_UBOOT_CONFIG=${RPI1P_UBOOT_CONFIG:=rpi_defconfig}
56 RPI1P_UBOOT_CONFIG=${RPI1P_UBOOT_CONFIG:=rpi_defconfig}
57
57
58 #bcm2709-rpi-2-b.dtb (Used for Pi 2 model B)
58 #bcm2709-rpi-2-b.dtb (Used for Pi 2 model B)
59 RPI2_DTB_FILE=${RPI2_DTB_FILE:=bcm2709-rpi-2-b.dtb}
59 RPI2_DTB_FILE=${RPI2_DTB_FILE:=bcm2709-rpi-2-b.dtb}
60 RPI2_UBOOT_CONFIG=${RPI2_UBOOT_CONFIG:=rpi_2_defconfig}
60 RPI2_UBOOT_CONFIG=${RPI2_UBOOT_CONFIG:=rpi_2_defconfig}
61
61
62 #bcm2710-rpi-3-b.dtb (Used for Pi 3 model B)
62 #bcm2710-rpi-3-b.dtb (Used for Pi 3 model B)
63 RPI3_DTB_FILE=${RPI3_DTB_FILE:=bcm2710-rpi-3-b.dtb}
63 RPI3_DTB_FILE=${RPI3_DTB_FILE:=bcm2710-rpi-3-b.dtb}
64 RPI3_UBOOT_CONFIG=${RPI3_UBOOT_CONFIG:=rpi_3_32b_defconfig}
64 RPI3_UBOOT_CONFIG=${RPI3_UBOOT_CONFIG:=rpi_3_32b_defconfig}
65
65
66 #bcm2710-rpi-3-b-plus.dtb (Used for Pi 3 model B+)
66 #bcm2710-rpi-3-b-plus.dtb (Used for Pi 3 model B+)
67 RPI3P_DTB_FILE=${RPI3P_DTB_FILE:=bcm2710-rpi-3-b-plus.dtb}
67 RPI3P_DTB_FILE=${RPI3P_DTB_FILE:=bcm2710-rpi-3-b-plus.dtb}
68 RPI3P_UBOOT_CONFIG=${RPI3P_UBOOT_CONFIG:=rpi_3_32b_defconfig}
68 RPI3P_UBOOT_CONFIG=${RPI3P_UBOOT_CONFIG:=rpi_3_32b_defconfig}
69
69
70 # Debian release
70 # Debian release
71 RELEASE=${RELEASE:=jessie}
71 RELEASE=${RELEASE:=jessie}
72 KERNEL_ARCH=${KERNEL_ARCH:=arm}
72 KERNEL_ARCH=${KERNEL_ARCH:=arm}
73 RELEASE_ARCH=${RELEASE_ARCH:=armhf}
73 RELEASE_ARCH=${RELEASE_ARCH:=armhf}
74 CROSS_COMPILE=${CROSS_COMPILE:=arm-linux-gnueabihf-}
74 CROSS_COMPILE=${CROSS_COMPILE:=arm-linux-gnueabihf-}
75 COLLABORA_KERNEL=${COLLABORA_KERNEL:=3.18.0-trunk-rpi2}
75 COLLABORA_KERNEL=${COLLABORA_KERNEL:=3.18.0-trunk-rpi2}
76 if [ "$KERNEL_ARCH" = "arm64" ] ; then
76 if [ "$KERNEL_ARCH" = "arm64" ] ; then
77 KERNEL_DEFCONFIG=${KERNEL_DEFCONFIG:=bcmrpi3_defconfig}
77 KERNEL_DEFCONFIG=${KERNEL_DEFCONFIG:=bcmrpi3_defconfig}
78 KERNEL_IMAGE=${KERNEL_IMAGE:=kernel8.img}
78 KERNEL_IMAGE=${KERNEL_IMAGE:=kernel8.img}
79 fi
79 fi
80
80
81 if [ "$RPI_MODEL" = 0 ] || [ "$RPI_MODEL" = 1 ] || [ "$RPI_MODEL" = 1P ] ; then
81 if [ "$RPI_MODEL" = 0 ] || [ "$RPI_MODEL" = 1 ] || [ "$RPI_MODEL" = 1P ] ; then
82 #RASPBERRY PI 1, PI ZERO, PI ZERO W, AND COMPUTE MODULE DEFAULT Kernel BUILD CONFIGURATION
82 #RASPBERRY PI 1, PI ZERO, PI ZERO W, AND COMPUTE MODULE DEFAULT Kernel BUILD CONFIGURATION
83 KERNEL_DEFCONFIG=${KERNEL_DEFCONFIG:=bcmrpi_defconfig}
83 KERNEL_DEFCONFIG=${KERNEL_DEFCONFIG:=bcmrpi_defconfig}
84 KERNEL_IMAGE=${KERNEL_IMAGE:=kernel7.img}
84 KERNEL_IMAGE=${KERNEL_IMAGE:=kernel7.img}
85 else
85 else
86 #RASPBERRY PI 2, PI 3, PI 3+, AND COMPUTE MODULE 3 DEFAULT Kernel BUILD CONFIGURATION
86 #RASPBERRY PI 2, PI 3, PI 3+, AND COMPUTE MODULE 3 DEFAULT Kernel BUILD CONFIGURATION
87 #https://www.raspberrypi.org/documentation/linux/kernel/building.md
87 #https://www.raspberrypi.org/documentation/linux/kernel/building.md
88 KERNEL_DEFCONFIG=${KERNEL_DEFCONFIG:=bcm2709_defconfig}
88 KERNEL_DEFCONFIG=${KERNEL_DEFCONFIG:=bcm2709_defconfig}
89 KERNEL_IMAGE=${KERNEL_IMAGE:=kernel7.img}
89 KERNEL_IMAGE=${KERNEL_IMAGE:=kernel7.img}
90 fi
90 fi
91
91
92 if [ "$RELEASE_ARCH" = "arm64" ] ; then
92 if [ "$RELEASE_ARCH" = "arm64" ] ; then
93 QEMU_BINARY=${QEMU_BINARY:=/usr/bin/qemu-aarch64-static}
93 QEMU_BINARY=${QEMU_BINARY:=/usr/bin/qemu-aarch64-static}
94 else
94 else
95 QEMU_BINARY=${QEMU_BINARY:=/usr/bin/qemu-arm-static}
95 QEMU_BINARY=${QEMU_BINARY:=/usr/bin/qemu-arm-static}
96 fi
96 fi
97 KERNEL_BRANCH=${KERNEL_BRANCH:=""}
97 KERNEL_BRANCH=${KERNEL_BRANCH:=""}
98
98
99 # URLs
99 # URLs
100 KERNEL_URL=${KERNEL_URL:=https://github.com/raspberrypi/linux}
100 KERNEL_URL=${KERNEL_URL:=https://github.com/raspberrypi/linux}
101 FIRMWARE_URL=${FIRMWARE_URL:=https://github.com/raspberrypi/firmware/raw/master/boot}
101 FIRMWARE_URL=${FIRMWARE_URL:=https://github.com/raspberrypi/firmware/raw/master/boot}
102 WLAN_FIRMWARE_URL=${WLAN_FIRMWARE_URL:=https://github.com/RPi-Distro/firmware-nonfree/raw/master/brcm}
102 WLAN_FIRMWARE_URL=${WLAN_FIRMWARE_URL:=https://github.com/RPi-Distro/firmware-nonfree/raw/master/brcm}
103 COLLABORA_URL=${COLLABORA_URL:=https://repositories.collabora.co.uk/debian}
103 COLLABORA_URL=${COLLABORA_URL:=https://repositories.collabora.co.uk/debian}
104 FBTURBO_URL=${FBTURBO_URL:=https://github.com/ssvb/xf86-video-fbturbo.git}
104 FBTURBO_URL=${FBTURBO_URL:=https://github.com/ssvb/xf86-video-fbturbo.git}
105 UBOOT_URL=${UBOOT_URL:=https://git.denx.de/u-boot.git}
105 UBOOT_URL=${UBOOT_URL:=https://git.denx.de/u-boot.git}
106
106
107 # Build directories
107 # Build directories
108 BASEDIR=${BASEDIR:=$(pwd)/images/${RELEASE}}
108 BASEDIR=${BASEDIR:=$(pwd)/images/${RELEASE}}
109 BUILDDIR="${BASEDIR}/build"
109 BUILDDIR="${BASEDIR}/build"
110
110
111 # Prepare date string for default image file name
111 # Prepare date string for default image file name
112 DATE="$(date +%Y-%m-%d)"
112 DATE="$(date +%Y-%m-%d)"
113 if [ -z "$KERNEL_BRANCH" ] ; then
113 if [ -z "$KERNEL_BRANCH" ] ; then
114 IMAGE_NAME=${IMAGE_NAME:=${BASEDIR}/${DATE}-${KERNEL_ARCH}-CURRENT-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}}
114 IMAGE_NAME=${IMAGE_NAME:=${BASEDIR}/${DATE}-${KERNEL_ARCH}-CURRENT-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}}
115 else
115 else
116 IMAGE_NAME=${IMAGE_NAME:=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}}
116 IMAGE_NAME=${IMAGE_NAME:=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}}
117 fi
117 fi
118
118
119 # Chroot directories
119 # Chroot directories
120 R="${BUILDDIR}/chroot"
120 R="${BUILDDIR}/chroot"
121 ETC_DIR="${R}/etc"
121 ETC_DIR="${R}/etc"
122 LIB_DIR="${R}/lib"
122 LIB_DIR="${R}/lib"
123 BOOT_DIR="${R}/boot/firmware"
123 BOOT_DIR="${R}/boot/firmware"
124 KERNEL_DIR="${R}/usr/src/linux"
124 KERNEL_DIR="${R}/usr/src/linux"
125 WLAN_FIRMWARE_DIR="${R}/lib/firmware/brcm"
125 WLAN_FIRMWARE_DIR="${R}/lib/firmware/brcm"
126
126
127 # Firmware directory: Blank if download from github
127 # Firmware directory: Blank if download from github
128 RPI_FIRMWARE_DIR=${RPI_FIRMWARE_DIR:=""}
128 RPI_FIRMWARE_DIR=${RPI_FIRMWARE_DIR:=""}
129
129
130 # General settings
130 # General settings
131 HOSTNAME=${HOSTNAME:=rpi${RPI_MODEL}-${RELEASE}}
131 HOSTNAME=${HOSTNAME:=rpi${RPI_MODEL}-${RELEASE}}
132 PASSWORD=${PASSWORD:=raspberry}
132 PASSWORD=${PASSWORD:=raspberry}
133 USER_PASSWORD=${USER_PASSWORD:=raspberry}
133 USER_PASSWORD=${USER_PASSWORD:=raspberry}
134 DEFLOCAL=${DEFLOCAL:="en_US.UTF-8"}
134 DEFLOCAL=${DEFLOCAL:="en_US.UTF-8"}
135 TIMEZONE=${TIMEZONE:="Europe/Berlin"}
135 TIMEZONE=${TIMEZONE:="Europe/Berlin"}
136 EXPANDROOT=${EXPANDROOT:=true}
136 EXPANDROOT=${EXPANDROOT:=true}
137
137
138 # Keyboard settings
138 # Keyboard settings
139 XKB_MODEL=${XKB_MODEL:=""}
139 XKB_MODEL=${XKB_MODEL:=""}
140 XKB_LAYOUT=${XKB_LAYOUT:=""}
140 XKB_LAYOUT=${XKB_LAYOUT:=""}
141 XKB_VARIANT=${XKB_VARIANT:=""}
141 XKB_VARIANT=${XKB_VARIANT:=""}
142 XKB_OPTIONS=${XKB_OPTIONS:=""}
142 XKB_OPTIONS=${XKB_OPTIONS:=""}
143
143
144 # Network settings (DHCP)
144 # Network settings (DHCP)
145 ENABLE_DHCP=${ENABLE_DHCP:=true}
145 ENABLE_DHCP=${ENABLE_DHCP:=true}
146
146
147 # Network settings (static)
147 # Network settings (static)
148 NET_ADDRESS=${NET_ADDRESS:=""}
148 NET_ADDRESS=${NET_ADDRESS:=""}
149 NET_GATEWAY=${NET_GATEWAY:=""}
149 NET_GATEWAY=${NET_GATEWAY:=""}
150 NET_DNS_1=${NET_DNS_1:=""}
150 NET_DNS_1=${NET_DNS_1:=""}
151 NET_DNS_2=${NET_DNS_2:=""}
151 NET_DNS_2=${NET_DNS_2:=""}
152 NET_DNS_DOMAINS=${NET_DNS_DOMAINS:=""}
152 NET_DNS_DOMAINS=${NET_DNS_DOMAINS:=""}
153 NET_NTP_1=${NET_NTP_1:=""}
153 NET_NTP_1=${NET_NTP_1:=""}
154 NET_NTP_2=${NET_NTP_2:=""}
154 NET_NTP_2=${NET_NTP_2:=""}
155
155
156 # APT settings
156 # APT settings
157 APT_PROXY=${APT_PROXY:=""}
157 APT_PROXY=${APT_PROXY:=""}
158 APT_SERVER=${APT_SERVER:="ftp.debian.org"}
158 APT_SERVER=${APT_SERVER:="ftp.debian.org"}
159
159
160 # Feature settings
160 # Feature settings
161 ENABLE_CONSOLE=${ENABLE_CONSOLE:=true}
161 ENABLE_CONSOLE=${ENABLE_CONSOLE:=true}
162 ENABLE_I2C=${ENABLE_I2C:=false}
162 ENABLE_I2C=${ENABLE_I2C:=false}
163 ENABLE_SPI=${ENABLE_SPI:=false}
163 ENABLE_SPI=${ENABLE_SPI:=false}
164 ENABLE_IPV6=${ENABLE_IPV6:=true}
164 ENABLE_IPV6=${ENABLE_IPV6:=true}
165 ENABLE_SSHD=${ENABLE_SSHD:=true}
165 ENABLE_SSHD=${ENABLE_SSHD:=true}
166 ENABLE_NONFREE=${ENABLE_NONFREE:=false}
166 ENABLE_NONFREE=${ENABLE_NONFREE:=false}
167 ENABLE_WIRELESS=${ENABLE_WIRELESS:=false}
167 ENABLE_WIRELESS=${ENABLE_WIRELESS:=false}
168 ENABLE_SOUND=${ENABLE_SOUND:=true}
168 ENABLE_SOUND=${ENABLE_SOUND:=true}
169 ENABLE_DBUS=${ENABLE_DBUS:=true}
169 ENABLE_DBUS=${ENABLE_DBUS:=true}
170 ENABLE_HWRANDOM=${ENABLE_HWRANDOM:=true}
170 ENABLE_HWRANDOM=${ENABLE_HWRANDOM:=true}
171 ENABLE_MINGPU=${ENABLE_MINGPU:=false}
171 ENABLE_MINGPU=${ENABLE_MINGPU:=false}
172 ENABLE_XORG=${ENABLE_XORG:=false}
172 ENABLE_XORG=${ENABLE_XORG:=false}
173 ENABLE_WM=${ENABLE_WM:=""}
173 ENABLE_WM=${ENABLE_WM:=""}
174 ENABLE_RSYSLOG=${ENABLE_RSYSLOG:=true}
174 ENABLE_RSYSLOG=${ENABLE_RSYSLOG:=true}
175 ENABLE_USER=${ENABLE_USER:=true}
175 ENABLE_USER=${ENABLE_USER:=true}
176 USER_NAME=${USER_NAME:="pi"}
176 USER_NAME=${USER_NAME:="pi"}
177 ENABLE_ROOT=${ENABLE_ROOT:=false}
177 ENABLE_ROOT=${ENABLE_ROOT:=false}
178 ENABLE_QEMU=${ENABLE_QEMU:=false}
178 ENABLE_QEMU=${ENABLE_QEMU:=false}
179 ENABLE_SYSVINIT=${ENABLE_SYSVINIT:=false}
179
180
180 # SSH settings
181 # SSH settings
181 SSH_ENABLE_ROOT=${SSH_ENABLE_ROOT:=false}
182 SSH_ENABLE_ROOT=${SSH_ENABLE_ROOT:=false}
182 SSH_DISABLE_PASSWORD_AUTH=${SSH_DISABLE_PASSWORD_AUTH:=false}
183 SSH_DISABLE_PASSWORD_AUTH=${SSH_DISABLE_PASSWORD_AUTH:=false}
183 SSH_LIMIT_USERS=${SSH_LIMIT_USERS:=false}
184 SSH_LIMIT_USERS=${SSH_LIMIT_USERS:=false}
184 SSH_ROOT_PUB_KEY=${SSH_ROOT_PUB_KEY:=""}
185 SSH_ROOT_PUB_KEY=${SSH_ROOT_PUB_KEY:=""}
185 SSH_USER_PUB_KEY=${SSH_USER_PUB_KEY:=""}
186 SSH_USER_PUB_KEY=${SSH_USER_PUB_KEY:=""}
186
187
187 # Advanced settings
188 # Advanced settings
188 ENABLE_MINBASE=${ENABLE_MINBASE:=false}
189 ENABLE_MINBASE=${ENABLE_MINBASE:=false}
189 ENABLE_REDUCE=${ENABLE_REDUCE:=false}
190 ENABLE_REDUCE=${ENABLE_REDUCE:=false}
190 ENABLE_UBOOT=${ENABLE_UBOOT:=false}
191 ENABLE_UBOOT=${ENABLE_UBOOT:=false}
191 UBOOTSRC_DIR=${UBOOTSRC_DIR:=""}
192 UBOOTSRC_DIR=${UBOOTSRC_DIR:=""}
192 ENABLE_FBTURBO=${ENABLE_FBTURBO:=false}
193 ENABLE_FBTURBO=${ENABLE_FBTURBO:=false}
193 FBTURBOSRC_DIR=${FBTURBOSRC_DIR:=""}
194 FBTURBOSRC_DIR=${FBTURBOSRC_DIR:=""}
194 ENABLE_HARDNET=${ENABLE_HARDNET:=false}
195 ENABLE_HARDNET=${ENABLE_HARDNET:=false}
195 ENABLE_IPTABLES=${ENABLE_IPTABLES:=false}
196 ENABLE_IPTABLES=${ENABLE_IPTABLES:=false}
196 ENABLE_SPLITFS=${ENABLE_SPLITFS:=false}
197 ENABLE_SPLITFS=${ENABLE_SPLITFS:=false}
197 ENABLE_INITRAMFS=${ENABLE_INITRAMFS:=false}
198 ENABLE_INITRAMFS=${ENABLE_INITRAMFS:=false}
198 ENABLE_IFNAMES=${ENABLE_IFNAMES:=true}
199 ENABLE_IFNAMES=${ENABLE_IFNAMES:=true}
199 DISABLE_UNDERVOLT_WARNINGS=${DISABLE_UNDERVOLT_WARNINGS:=}
200 DISABLE_UNDERVOLT_WARNINGS=${DISABLE_UNDERVOLT_WARNINGS:=}
200
201
201 # Kernel compilation settings
202 # Kernel compilation settings
202 BUILD_KERNEL=${BUILD_KERNEL:=false}
203 BUILD_KERNEL=${BUILD_KERNEL:=false}
203 KERNEL_REDUCE=${KERNEL_REDUCE:=false}
204 KERNEL_REDUCE=${KERNEL_REDUCE:=false}
204 KERNEL_THREADS=${KERNEL_THREADS:=1}
205 KERNEL_THREADS=${KERNEL_THREADS:=1}
205 KERNEL_HEADERS=${KERNEL_HEADERS:=true}
206 KERNEL_HEADERS=${KERNEL_HEADERS:=true}
206 KERNEL_MENUCONFIG=${KERNEL_MENUCONFIG:=false}
207 KERNEL_MENUCONFIG=${KERNEL_MENUCONFIG:=false}
207 KERNEL_REMOVESRC=${KERNEL_REMOVESRC:=true}
208 KERNEL_REMOVESRC=${KERNEL_REMOVESRC:=true}
208 KERNEL_OLDDEFCONFIG=${KERNEL_OLDDEFCONFIG:=false}
209 KERNEL_OLDDEFCONFIG=${KERNEL_OLDDEFCONFIG:=false}
209 KERNEL_CCACHE=${KERNEL_CCACHE:=false}
210 KERNEL_CCACHE=${KERNEL_CCACHE:=false}
210
211
211 if [ "$KERNEL_ARCH" = "arm64" ] ; then
212 if [ "$KERNEL_ARCH" = "arm64" ] ; then
212 KERNEL_BIN_IMAGE=${KERNEL_BIN_IMAGE:="Image"}
213 KERNEL_BIN_IMAGE=${KERNEL_BIN_IMAGE:="Image"}
213 else
214 else
214 KERNEL_BIN_IMAGE=${KERNEL_BIN_IMAGE:="zImage"}
215 KERNEL_BIN_IMAGE=${KERNEL_BIN_IMAGE:="zImage"}
215 fi
216 fi
216
217
217 # Kernel compilation from source directory settings
218 # Kernel compilation from source directory settings
218 KERNELSRC_DIR=${KERNELSRC_DIR:=""}
219 KERNELSRC_DIR=${KERNELSRC_DIR:=""}
219 KERNELSRC_CLEAN=${KERNELSRC_CLEAN:=false}
220 KERNELSRC_CLEAN=${KERNELSRC_CLEAN:=false}
220 KERNELSRC_CONFIG=${KERNELSRC_CONFIG:=true}
221 KERNELSRC_CONFIG=${KERNELSRC_CONFIG:=true}
221 KERNELSRC_PREBUILT=${KERNELSRC_PREBUILT:=false}
222 KERNELSRC_PREBUILT=${KERNELSRC_PREBUILT:=false}
222
223
223 # Reduce disk usage settings
224 # Reduce disk usage settings
224 REDUCE_APT=${REDUCE_APT:=true}
225 REDUCE_APT=${REDUCE_APT:=true}
225 REDUCE_DOC=${REDUCE_DOC:=true}
226 REDUCE_DOC=${REDUCE_DOC:=true}
226 REDUCE_MAN=${REDUCE_MAN:=true}
227 REDUCE_MAN=${REDUCE_MAN:=true}
227 REDUCE_VIM=${REDUCE_VIM:=false}
228 REDUCE_VIM=${REDUCE_VIM:=false}
228 REDUCE_BASH=${REDUCE_BASH:=false}
229 REDUCE_BASH=${REDUCE_BASH:=false}
229 REDUCE_HWDB=${REDUCE_HWDB:=true}
230 REDUCE_HWDB=${REDUCE_HWDB:=true}
230 REDUCE_SSHD=${REDUCE_SSHD:=true}
231 REDUCE_SSHD=${REDUCE_SSHD:=true}
231 REDUCE_LOCALE=${REDUCE_LOCALE:=true}
232 REDUCE_LOCALE=${REDUCE_LOCALE:=true}
232
233
233 # Encrypted filesystem settings
234 # Encrypted filesystem settings
234 ENABLE_CRYPTFS=${ENABLE_CRYPTFS:=false}
235 ENABLE_CRYPTFS=${ENABLE_CRYPTFS:=false}
235 CRYPTFS_PASSWORD=${CRYPTFS_PASSWORD:=""}
236 CRYPTFS_PASSWORD=${CRYPTFS_PASSWORD:=""}
236 CRYPTFS_MAPPING=${CRYPTFS_MAPPING:="secure"}
237 CRYPTFS_MAPPING=${CRYPTFS_MAPPING:="secure"}
237 CRYPTFS_CIPHER=${CRYPTFS_CIPHER:="aes-xts-plain64:sha512"}
238 CRYPTFS_CIPHER=${CRYPTFS_CIPHER:="aes-xts-plain64:sha512"}
238 CRYPTFS_XTSKEYSIZE=${CRYPTFS_XTSKEYSIZE:=512}
239 CRYPTFS_XTSKEYSIZE=${CRYPTFS_XTSKEYSIZE:=512}
239
240
240 # Chroot scripts directory
241 # Chroot scripts directory
241 CHROOT_SCRIPTS=${CHROOT_SCRIPTS:=""}
242 CHROOT_SCRIPTS=${CHROOT_SCRIPTS:=""}
242
243
243 # Packages required in the chroot build environment
244 # Packages required in the chroot build environment
244 APT_INCLUDES=${APT_INCLUDES:=""}
245 APT_INCLUDES=${APT_INCLUDES:=""}
245 APT_INCLUDES="${APT_INCLUDES},apt-transport-https,apt-utils,ca-certificates,debian-archive-keyring,dialog,sudo,systemd,sysvinit-utils"
246 APT_INCLUDES="${APT_INCLUDES},apt-transport-https,apt-utils,ca-certificates,debian-archive-keyring,dialog,sudo,systemd,sysvinit-utils"
246
247
248 #Packages to exclude from chroot build environment
249 APT_EXCLUDES=${APT_EXCLUDES:=""}
250
247 # Packages required for bootstrapping
251 # Packages required for bootstrapping
248 REQUIRED_PACKAGES="debootstrap debian-archive-keyring qemu-user-static binfmt-support dosfstools rsync bmap-tools whois git bc psmisc dbus sudo"
252 REQUIRED_PACKAGES="debootstrap debian-archive-keyring qemu-user-static binfmt-support dosfstools rsync bmap-tools whois git bc psmisc dbus sudo"
249 MISSING_PACKAGES=""
253 MISSING_PACKAGES=""
250
254
251 # Packages installed for c/c++ build environment in chroot (keep empty)
255 # Packages installed for c/c++ build environment in chroot (keep empty)
252 COMPILER_PACKAGES=""
256 COMPILER_PACKAGES=""
253
257
254 set +x
258 set +x
255
259
260 #If init and systemd-sysv are wanted e.g. halt/reboot/shutdown scripts
261 if [ "$ENABLE_SYSVINIT" = false ] ; then
262 APT_EXCLUDES="${APT_EXCLUDES},init,systemd-sysv"
263 fi
264
256 # Set Raspberry Pi model specific configuration
265 # Set Raspberry Pi model specific configuration
257 if [ "$RPI_MODEL" = 0 ] ; then
266 if [ "$RPI_MODEL" = 0 ] ; then
258 DTB_FILE=${RPI0_DTB_FILE}
267 DTB_FILE=${RPI0_DTB_FILE}
259 UBOOT_CONFIG=${RPI0_UBOOT_CONFIG}
268 UBOOT_CONFIG=${RPI0_UBOOT_CONFIG}
260 elif [ "$RPI_MODEL" = 1 ] ; then
269 elif [ "$RPI_MODEL" = 1 ] ; then
261 DTB_FILE=${RPI1_DTB_FILE}
270 DTB_FILE=${RPI1_DTB_FILE}
262 UBOOT_CONFIG=${RPI1_UBOOT_CONFIG}
271 UBOOT_CONFIG=${RPI1_UBOOT_CONFIG}
263 elif [ "$RPI_MODEL" = 1P ] ; then
272 elif [ "$RPI_MODEL" = 1P ] ; then
264 DTB_FILE=${RPI1P_DTB_FILE}
273 DTB_FILE=${RPI1P_DTB_FILE}
265 UBOOT_CONFIG=${RPI1P_UBOOT_CONFIG}
274 UBOOT_CONFIG=${RPI1P_UBOOT_CONFIG}
266 elif [ "$RPI_MODEL" = 2 ] ; then
275 elif [ "$RPI_MODEL" = 2 ] ; then
267 DTB_FILE=${RPI2_DTB_FILE}
276 DTB_FILE=${RPI2_DTB_FILE}
268 UBOOT_CONFIG=${RPI2_UBOOT_CONFIG}
277 UBOOT_CONFIG=${RPI2_UBOOT_CONFIG}
269 elif [ "$RPI_MODEL" = 3 ] ; then
278 elif [ "$RPI_MODEL" = 3 ] ; then
270 DTB_FILE=${RPI3_DTB_FILE}
279 DTB_FILE=${RPI3_DTB_FILE}
271 UBOOT_CONFIG=${RPI3_UBOOT_CONFIG}
280 UBOOT_CONFIG=${RPI3_UBOOT_CONFIG}
272 elif [ "$RPI_MODEL" = 3P ] ; then
281 elif [ "$RPI_MODEL" = 3P ] ; then
273 DTB_FILE=${RPI3P_DTB_FILE}
282 DTB_FILE=${RPI3P_DTB_FILE}
274 UBOOT_CONFIG=${RPI3P_UBOOT_CONFIG}
283 UBOOT_CONFIG=${RPI3P_UBOOT_CONFIG}
275 else
284 else
276 echo "error: Raspberry Pi model ${RPI_MODEL} is not supported!"
285 echo "error: Raspberry Pi model ${RPI_MODEL} is not supported!"
277 exit 1
286 exit 1
278 fi
287 fi
279
288
280 # Check if the internal wireless interface is supported by the RPi model
289 # Check if the internal wireless interface is supported by the RPi model
281 if [ "$ENABLE_WIRELESS" = true ] && ([ "$RPI_MODEL" = 1 ] || [ "$RPI_MODEL" = 1P ] || [ "$RPI_MODEL" = 2 ]); then
290 if [ "$ENABLE_WIRELESS" = true ] && ([ "$RPI_MODEL" = 1 ] || [ "$RPI_MODEL" = 1P ] || [ "$RPI_MODEL" = 2 ]); then
282
291
283 echo "error: The selected Raspberry Pi model has no internal wireless interface"
292 echo "error: The selected Raspberry Pi model has no internal wireless interface"
284 exit 1
293 exit 1
285 fi
294 fi
286
295
287 # Check if DISABLE_UNDERVOLT_WARNINGS parameter value is supported
296 # Check if DISABLE_UNDERVOLT_WARNINGS parameter value is supported
288 if [ ! -z "$DISABLE_UNDERVOLT_WARNINGS" ] ; then
297 if [ ! -z "$DISABLE_UNDERVOLT_WARNINGS" ] ; then
289 if [ "$DISABLE_UNDERVOLT_WARNINGS" != 1 ] && [ "$DISABLE_UNDERVOLT_WARNINGS" != 2 ] ; then
298 if [ "$DISABLE_UNDERVOLT_WARNINGS" != 1 ] && [ "$DISABLE_UNDERVOLT_WARNINGS" != 2 ] ; then
290 echo "error: DISABLE_UNDERVOLT_WARNINGS=${DISABLE_UNDERVOLT_WARNINGS} is not supported"
299 echo "error: DISABLE_UNDERVOLT_WARNINGS=${DISABLE_UNDERVOLT_WARNINGS} is not supported"
291 exit 1
300 exit 1
292 fi
301 fi
293 fi
302 fi
294
303
295 # Build RPi2/3 Linux kernel if required by Debian release
304 # Build RPi2/3 Linux kernel if required by Debian release
296 if [ "$RELEASE" = "stretch" ] || [ "$RELEASE" = "buster" ] ; then
305 if [ "$RELEASE" = "stretch" ] || [ "$RELEASE" = "buster" ] ; then
297 BUILD_KERNEL=true
306 BUILD_KERNEL=true
298 fi
307 fi
299
308
300 # Add packages required for kernel cross compilation
309 # Add packages required for kernel cross compilation
301 if [ "$BUILD_KERNEL" = true ] ; then
310 if [ "$BUILD_KERNEL" = true ] ; then
302 if [ "$KERNEL_ARCH" = "arm" ] ; then
311 if [ "$KERNEL_ARCH" = "arm" ] ; then
303 if [ "$RELEASE_ARCH" = "armel" ]; then
312 if [ "$RELEASE_ARCH" = "armel" ]; then
304 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} crossbuild-essential-armel"
313 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} crossbuild-essential-armel"
305 fi
314 fi
306 if [ "$RELEASE_ARCH" = "armhf" ]; then
315 if [ "$RELEASE_ARCH" = "armhf" ]; then
307 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} crossbuild-essential-armhf"
316 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} crossbuild-essential-armhf"
308 fi
317 fi
309 if [ "$RELEASE_ARCH" = "arm64" ]; then
318 if [ "$RELEASE_ARCH" = "arm64" ]; then
310 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} crossbuild-essential-arm64"
319 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} crossbuild-essential-arm64"
311 fi
320 fi
312 fi
321 fi
313 fi
322 fi
314
323
315 # Add libncurses5 to enable kernel menuconfig
324 # Add libncurses5 to enable kernel menuconfig
316 if [ "$KERNEL_MENUCONFIG" = true ] ; then
325 if [ "$KERNEL_MENUCONFIG" = true ] ; then
317 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} libncurses5-dev"
326 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} libncurses5-dev"
318 fi
327 fi
319
328
320 # Add ccache compiler cache for (faster) kernel cross (re)compilation
329 # Add ccache compiler cache for (faster) kernel cross (re)compilation
321 if [ "$KERNEL_CCACHE" = true ] ; then
330 if [ "$KERNEL_CCACHE" = true ] ; then
322 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} ccache"
331 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} ccache"
323 fi
332 fi
324
333
325 # Add cryptsetup package to enable filesystem encryption
334 # Add cryptsetup package to enable filesystem encryption
326 if [ "$ENABLE_CRYPTFS" = true ] && [ "$BUILD_KERNEL" = true ] ; then
335 if [ "$ENABLE_CRYPTFS" = true ] && [ "$BUILD_KERNEL" = true ] ; then
327 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} cryptsetup"
336 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} cryptsetup"
328 APT_INCLUDES="${APT_INCLUDES},cryptsetup,busybox,console-setup"
337 APT_INCLUDES="${APT_INCLUDES},cryptsetup,busybox,console-setup"
329
338
330 if [ -z "$CRYPTFS_PASSWORD" ] ; then
339 if [ -z "$CRYPTFS_PASSWORD" ] ; then
331 echo "error: no password defined (CRYPTFS_PASSWORD)!"
340 echo "error: no password defined (CRYPTFS_PASSWORD)!"
332 exit 1
341 exit 1
333 fi
342 fi
334 ENABLE_INITRAMFS=true
343 ENABLE_INITRAMFS=true
335 fi
344 fi
336
345
337 # Add initramfs generation tools
346 # Add initramfs generation tools
338 if [ "$ENABLE_INITRAMFS" = true ] && [ "$BUILD_KERNEL" = true ] ; then
347 if [ "$ENABLE_INITRAMFS" = true ] && [ "$BUILD_KERNEL" = true ] ; then
339 APT_INCLUDES="${APT_INCLUDES},initramfs-tools"
348 APT_INCLUDES="${APT_INCLUDES},initramfs-tools"
340 fi
349 fi
341
350
342 # Add device-tree-compiler required for building the U-Boot bootloader
351 # Add device-tree-compiler required for building the U-Boot bootloader
343 if [ "$ENABLE_UBOOT" = true ] ; then
352 if [ "$ENABLE_UBOOT" = true ] ; then
344 APT_INCLUDES="${APT_INCLUDES},device-tree-compiler,bison,flex"
353 APT_INCLUDES="${APT_INCLUDES},device-tree-compiler,bison,flex"
345 fi
354 fi
346
355
347 # Check if root SSH (v2) public key file exists
356 # Check if root SSH (v2) public key file exists
348 if [ ! -z "$SSH_ROOT_PUB_KEY" ] ; then
357 if [ ! -z "$SSH_ROOT_PUB_KEY" ] ; then
349 if [ ! -f "$SSH_ROOT_PUB_KEY" ] ; then
358 if [ ! -f "$SSH_ROOT_PUB_KEY" ] ; then
350 echo "error: '$SSH_ROOT_PUB_KEY' specified SSH public key file not found (SSH_ROOT_PUB_KEY)!"
359 echo "error: '$SSH_ROOT_PUB_KEY' specified SSH public key file not found (SSH_ROOT_PUB_KEY)!"
351 exit 1
360 exit 1
352 fi
361 fi
353 fi
362 fi
354
363
355 # Check if $USER_NAME SSH (v2) public key file exists
364 # Check if $USER_NAME SSH (v2) public key file exists
356 if [ ! -z "$SSH_USER_PUB_KEY" ] ; then
365 if [ ! -z "$SSH_USER_PUB_KEY" ] ; then
357 if [ ! -f "$SSH_USER_PUB_KEY" ] ; then
366 if [ ! -f "$SSH_USER_PUB_KEY" ] ; then
358 echo "error: '$SSH_USER_PUB_KEY' specified SSH public key file not found (SSH_USER_PUB_KEY)!"
367 echo "error: '$SSH_USER_PUB_KEY' specified SSH public key file not found (SSH_USER_PUB_KEY)!"
359 exit 1
368 exit 1
360 fi
369 fi
361 fi
370 fi
362
371
363 # Check if all required packages are installed on the build system
372 # Check if all required packages are installed on the build system
364 for package in $REQUIRED_PACKAGES ; do
373 for package in $REQUIRED_PACKAGES ; do
365 if [ "`dpkg-query -W -f='${Status}' $package`" != "install ok installed" ] ; then
374 if [ "`dpkg-query -W -f='${Status}' $package`" != "install ok installed" ] ; then
366 MISSING_PACKAGES="${MISSING_PACKAGES} $package"
375 MISSING_PACKAGES="${MISSING_PACKAGES} $package"
367 fi
376 fi
368 done
377 done
369
378
370 # If there are missing packages ask confirmation for install, or exit
379 # If there are missing packages ask confirmation for install, or exit
371 if [ -n "$MISSING_PACKAGES" ] ; then
380 if [ -n "$MISSING_PACKAGES" ] ; then
372 echo "the following packages needed by this script are not installed:"
381 echo "the following packages needed by this script are not installed:"
373 echo "$MISSING_PACKAGES"
382 echo "$MISSING_PACKAGES"
374
383
375 echo -n "\ndo you want to install the missing packages right now? [y/n] "
384 echo -n "\ndo you want to install the missing packages right now? [y/n] "
376 read confirm
385 read confirm
377 [ "$confirm" != "y" ] && exit 1
386 [ "$confirm" != "y" ] && exit 1
378
387
379 # Make sure all missing required packages are installed
388 # Make sure all missing required packages are installed
380 apt-get -qq -y install ${MISSING_PACKAGES}
389 apt-get -qq -y install ${MISSING_PACKAGES}
381 fi
390 fi
382
391
383 # Check if ./bootstrap.d directory exists
392 # Check if ./bootstrap.d directory exists
384 if [ ! -d "./bootstrap.d/" ] ; then
393 if [ ! -d "./bootstrap.d/" ] ; then
385 echo "error: './bootstrap.d' required directory not found!"
394 echo "error: './bootstrap.d' required directory not found!"
386 exit 1
395 exit 1
387 fi
396 fi
388
397
389 # Check if ./files directory exists
398 # Check if ./files directory exists
390 if [ ! -d "./files/" ] ; then
399 if [ ! -d "./files/" ] ; then
391 echo "error: './files' required directory not found!"
400 echo "error: './files' required directory not found!"
392 exit 1
401 exit 1
393 fi
402 fi
394
403
395 # Check if specified KERNELSRC_DIR directory exists
404 # Check if specified KERNELSRC_DIR directory exists
396 if [ -n "$KERNELSRC_DIR" ] && [ ! -d "$KERNELSRC_DIR" ] ; then
405 if [ -n "$KERNELSRC_DIR" ] && [ ! -d "$KERNELSRC_DIR" ] ; then
397 echo "error: '${KERNELSRC_DIR}' specified directory not found (KERNELSRC_DIR)!"
406 echo "error: '${KERNELSRC_DIR}' specified directory not found (KERNELSRC_DIR)!"
398 exit 1
407 exit 1
399 fi
408 fi
400
409
401 # Check if specified UBOOTSRC_DIR directory exists
410 # Check if specified UBOOTSRC_DIR directory exists
402 if [ -n "$UBOOTSRC_DIR" ] && [ ! -d "$UBOOTSRC_DIR" ] ; then
411 if [ -n "$UBOOTSRC_DIR" ] && [ ! -d "$UBOOTSRC_DIR" ] ; then
403 echo "error: '${UBOOTSRC_DIR}' specified directory not found (UBOOTSRC_DIR)!"
412 echo "error: '${UBOOTSRC_DIR}' specified directory not found (UBOOTSRC_DIR)!"
404 exit 1
413 exit 1
405 fi
414 fi
406
415
407 # Check if specified FBTURBOSRC_DIR directory exists
416 # Check if specified FBTURBOSRC_DIR directory exists
408 if [ -n "$FBTURBOSRC_DIR" ] && [ ! -d "$FBTURBOSRC_DIR" ] ; then
417 if [ -n "$FBTURBOSRC_DIR" ] && [ ! -d "$FBTURBOSRC_DIR" ] ; then
409 echo "error: '${FBTURBOSRC_DIR}' specified directory not found (FBTURBOSRC_DIR)!"
418 echo "error: '${FBTURBOSRC_DIR}' specified directory not found (FBTURBOSRC_DIR)!"
410 exit 1
419 exit 1
411 fi
420 fi
412
421
413 # Check if specified CHROOT_SCRIPTS directory exists
422 # Check if specified CHROOT_SCRIPTS directory exists
414 if [ -n "$CHROOT_SCRIPTS" ] && [ ! -d "$CHROOT_SCRIPTS" ] ; then
423 if [ -n "$CHROOT_SCRIPTS" ] && [ ! -d "$CHROOT_SCRIPTS" ] ; then
415 echo "error: ${CHROOT_SCRIPTS} specified directory not found (CHROOT_SCRIPTS)!"
424 echo "error: ${CHROOT_SCRIPTS} specified directory not found (CHROOT_SCRIPTS)!"
416 exit 1
425 exit 1
417 fi
426 fi
418
427
419 # Check if specified device mapping already exists (will be used by cryptsetup)
428 # Check if specified device mapping already exists (will be used by cryptsetup)
420 if [ -r "/dev/mapping/${CRYPTFS_MAPPING}" ] ; then
429 if [ -r "/dev/mapping/${CRYPTFS_MAPPING}" ] ; then
421 echo "error: mapping /dev/mapping/${CRYPTFS_MAPPING} already exists, not proceeding"
430 echo "error: mapping /dev/mapping/${CRYPTFS_MAPPING} already exists, not proceeding"
422 exit 1
431 exit 1
423 fi
432 fi
424
433
425 # Don't clobber an old build
434 # Don't clobber an old build
426 if [ -e "$BUILDDIR" ] ; then
435 if [ -e "$BUILDDIR" ] ; then
427 echo "error: directory ${BUILDDIR} already exists, not proceeding"
436 echo "error: directory ${BUILDDIR} already exists, not proceeding"
428 exit 1
437 exit 1
429 fi
438 fi
430
439
431 # Setup chroot directory
440 # Setup chroot directory
432 mkdir -p "${R}"
441 mkdir -p "${R}"
433
442
434 # Check if build directory has enough of free disk space >512MB
443 # Check if build directory has enough of free disk space >512MB
435 if [ "$(df --output=avail ${BUILDDIR} | sed "1d")" -le "524288" ] ; then
444 if [ "$(df --output=avail ${BUILDDIR} | sed "1d")" -le "524288" ] ; then
436 echo "error: ${BUILDDIR} not enough space left to generate the output image!"
445 echo "error: ${BUILDDIR} not enough space left to generate the output image!"
437 exit 1
446 exit 1
438 fi
447 fi
439
448
440 set -x
449 set -x
441
450
442 # Call "cleanup" function on various signals and errors
451 # Call "cleanup" function on various signals and errors
443 trap cleanup 0 1 2 3 6
452 trap cleanup 0 1 2 3 6
444
453
445 # Add required packages for the minbase installation
454 # Add required packages for the minbase installation
446 if [ "$ENABLE_MINBASE" = true ] ; then
455 if [ "$ENABLE_MINBASE" = true ] ; then
447 APT_INCLUDES="${APT_INCLUDES},vim-tiny,netbase,net-tools,ifupdown"
456 APT_INCLUDES="${APT_INCLUDES},vim-tiny,netbase,net-tools,ifupdown"
448 fi
457 fi
449
458
450 # Add required locales packages
459 # Add required locales packages
451 if [ "$DEFLOCAL" != "en_US.UTF-8" ] ; then
460 if [ "$DEFLOCAL" != "en_US.UTF-8" ] ; then
452 APT_INCLUDES="${APT_INCLUDES},locales,keyboard-configuration,console-setup"
461 APT_INCLUDES="${APT_INCLUDES},locales,keyboard-configuration,console-setup"
453 fi
462 fi
454
463
455 # Add parted package, required to get partprobe utility
464 # Add parted package, required to get partprobe utility
456 if [ "$EXPANDROOT" = true ] ; then
465 if [ "$EXPANDROOT" = true ] ; then
457 APT_INCLUDES="${APT_INCLUDES},parted"
466 APT_INCLUDES="${APT_INCLUDES},parted"
458 fi
467 fi
459
468
460 # Add dbus package, recommended if using systemd
469 # Add dbus package, recommended if using systemd
461 if [ "$ENABLE_DBUS" = true ] ; then
470 if [ "$ENABLE_DBUS" = true ] ; then
462 APT_INCLUDES="${APT_INCLUDES},dbus"
471 APT_INCLUDES="${APT_INCLUDES},dbus"
463 fi
472 fi
464
473
465 # Add iptables IPv4/IPv6 package
474 # Add iptables IPv4/IPv6 package
466 if [ "$ENABLE_IPTABLES" = true ] ; then
475 if [ "$ENABLE_IPTABLES" = true ] ; then
467 APT_INCLUDES="${APT_INCLUDES},iptables"
476 APT_INCLUDES="${APT_INCLUDES},iptables"
468 fi
477 fi
469
478
470 # Add openssh server package
479 # Add openssh server package
471 if [ "$ENABLE_SSHD" = true ] ; then
480 if [ "$ENABLE_SSHD" = true ] ; then
472 APT_INCLUDES="${APT_INCLUDES},openssh-server"
481 APT_INCLUDES="${APT_INCLUDES},openssh-server"
473 fi
482 fi
474
483
475 # Add alsa-utils package
484 # Add alsa-utils package
476 if [ "$ENABLE_SOUND" = true ] ; then
485 if [ "$ENABLE_SOUND" = true ] ; then
477 APT_INCLUDES="${APT_INCLUDES},alsa-utils"
486 APT_INCLUDES="${APT_INCLUDES},alsa-utils"
478 fi
487 fi
479
488
480 # Add rng-tools package
489 # Add rng-tools package
481 if [ "$ENABLE_HWRANDOM" = true ] ; then
490 if [ "$ENABLE_HWRANDOM" = true ] ; then
482 APT_INCLUDES="${APT_INCLUDES},rng-tools"
491 APT_INCLUDES="${APT_INCLUDES},rng-tools"
483 fi
492 fi
484
493
485 # Add fbturbo video driver
494 # Add fbturbo video driver
486 if [ "$ENABLE_FBTURBO" = true ] ; then
495 if [ "$ENABLE_FBTURBO" = true ] ; then
487 # Enable xorg package dependencies
496 # Enable xorg package dependencies
488 ENABLE_XORG=true
497 ENABLE_XORG=true
489 fi
498 fi
490
499
491 # Add user defined window manager package
500 # Add user defined window manager package
492 if [ -n "$ENABLE_WM" ] ; then
501 if [ -n "$ENABLE_WM" ] ; then
493 APT_INCLUDES="${APT_INCLUDES},${ENABLE_WM}"
502 APT_INCLUDES="${APT_INCLUDES},${ENABLE_WM}"
494
503
495 # Enable xorg package dependencies
504 # Enable xorg package dependencies
496 ENABLE_XORG=true
505 ENABLE_XORG=true
497 fi
506 fi
498
507
499 # Add xorg package
508 # Add xorg package
500 if [ "$ENABLE_XORG" = true ] ; then
509 if [ "$ENABLE_XORG" = true ] ; then
501 APT_INCLUDES="${APT_INCLUDES},xorg,dbus-x11"
510 APT_INCLUDES="${APT_INCLUDES},xorg,dbus-x11"
502 fi
511 fi
503
512
504 # Replace selected packages with smaller clones
513 # Replace selected packages with smaller clones
505 if [ "$ENABLE_REDUCE" = true ] ; then
514 if [ "$ENABLE_REDUCE" = true ] ; then
506 # Add levee package instead of vim-tiny
515 # Add levee package instead of vim-tiny
507 if [ "$REDUCE_VIM" = true ] ; then
516 if [ "$REDUCE_VIM" = true ] ; then
508 APT_INCLUDES="$(echo ${APT_INCLUDES} | sed "s/vim-tiny/levee/")"
517 APT_INCLUDES="$(echo ${APT_INCLUDES} | sed "s/vim-tiny/levee/")"
509 fi
518 fi
510
519
511 # Add dropbear package instead of openssh-server
520 # Add dropbear package instead of openssh-server
512 if [ "$REDUCE_SSHD" = true ] ; then
521 if [ "$REDUCE_SSHD" = true ] ; then
513 APT_INCLUDES="$(echo ${APT_INCLUDES} | sed "s/openssh-server/dropbear/")"
522 APT_INCLUDES="$(echo ${APT_INCLUDES} | sed "s/openssh-server/dropbear/")"
514 fi
523 fi
515 fi
524 fi
516
525
517 if [ "$RELEASE" != "jessie" ] ; then
526 if [ "$RELEASE" != "jessie" ] ; then
518 APT_INCLUDES="${APT_INCLUDES},libnss-systemd"
527 APT_INCLUDES="${APT_INCLUDES},libnss-systemd"
519 fi
528 fi
520
529
521 # Configure kernel sources if no KERNELSRC_DIR
530 # Configure kernel sources if no KERNELSRC_DIR
522 if [ "$BUILD_KERNEL" = true ] && [ -z "$KERNELSRC_DIR" ] ; then
531 if [ "$BUILD_KERNEL" = true ] && [ -z "$KERNELSRC_DIR" ] ; then
523 KERNELSRC_CONFIG=true
532 KERNELSRC_CONFIG=true
524 fi
533 fi
525
534
526 # Configure reduced kernel
535 # Configure reduced kernel
527 if [ "$KERNEL_REDUCE" = true ] ; then
536 if [ "$KERNEL_REDUCE" = true ] ; then
528 KERNELSRC_CONFIG=false
537 KERNELSRC_CONFIG=false
529 fi
538 fi
530
539
531 # Configure qemu compatible kernel
540 # Configure qemu compatible kernel
532 if [ "$ENABLE_QEMU" = true ] ; then
541 if [ "$ENABLE_QEMU" = true ] ; then
533 DTB_FILE=vexpress-v2p-ca15_a7.dtb
542 DTB_FILE=vexpress-v2p-ca15_a7.dtb
534 UBOOT_CONFIG=vexpress_ca15_tc2_defconfig
543 UBOOT_CONFIG=vexpress_ca15_tc2_defconfig
535 KERNEL_DEFCONFIG="vexpress_defconfig"
544 KERNEL_DEFCONFIG="vexpress_defconfig"
536 if [ "$KERNEL_MENUCONFIG" = false ] ; then
545 if [ "$KERNEL_MENUCONFIG" = false ] ; then
537 KERNEL_OLDDEFCONFIG=true
546 KERNEL_OLDDEFCONFIG=true
538 fi
547 fi
539 fi
548 fi
540
549
541 # Execute bootstrap scripts
550 # Execute bootstrap scripts
542 for SCRIPT in bootstrap.d/*.sh; do
551 for SCRIPT in bootstrap.d/*.sh; do
543 head -n 3 "$SCRIPT"
552 head -n 3 "$SCRIPT"
544 . "$SCRIPT"
553 . "$SCRIPT"
545 done
554 done
546
555
547 ## Execute custom bootstrap scripts
556 ## Execute custom bootstrap scripts
548 if [ -d "custom.d" ] ; then
557 if [ -d "custom.d" ] ; then
549 for SCRIPT in custom.d/*.sh; do
558 for SCRIPT in custom.d/*.sh; do
550 . "$SCRIPT"
559 . "$SCRIPT"
551 done
560 done
552 fi
561 fi
553
562
554 # Execute custom scripts inside the chroot
563 # Execute custom scripts inside the chroot
555 if [ -n "$CHROOT_SCRIPTS" ] && [ -d "$CHROOT_SCRIPTS" ] ; then
564 if [ -n "$CHROOT_SCRIPTS" ] && [ -d "$CHROOT_SCRIPTS" ] ; then
556 cp -r "${CHROOT_SCRIPTS}" "${R}/chroot_scripts"
565 cp -r "${CHROOT_SCRIPTS}" "${R}/chroot_scripts"
557 chroot_exec /bin/bash -x <<'EOF'
566 chroot_exec /bin/bash -x <<'EOF'
558 for SCRIPT in /chroot_scripts/* ; do
567 for SCRIPT in /chroot_scripts/* ; do
559 if [ -f $SCRIPT -a -x $SCRIPT ] ; then
568 if [ -f $SCRIPT -a -x $SCRIPT ] ; then
560 $SCRIPT
569 $SCRIPT
561 fi
570 fi
562 done
571 done
563 EOF
572 EOF
564 rm -rf "${R}/chroot_scripts"
573 rm -rf "${R}/chroot_scripts"
565 fi
574 fi
566
575
567 # Remove c/c++ build environment from the chroot
576 # Remove c/c++ build environment from the chroot
568 chroot_remove_cc
577 chroot_remove_cc
569
578
570 # Remove apt-utils
579 # Remove apt-utils
571 if [ "$RELEASE" = "jessie" ] ; then
580 if [ "$RELEASE" = "jessie" ] ; then
572 chroot_exec apt-get purge -qq -y --force-yes apt-utils
581 chroot_exec apt-get purge -qq -y --force-yes apt-utils
573 fi
582 fi
574
583
575 # Generate required machine-id
584 # Generate required machine-id
576 MACHINE_ID=$(dbus-uuidgen)
585 MACHINE_ID=$(dbus-uuidgen)
577 echo -n "${MACHINE_ID}" > "${R}/var/lib/dbus/machine-id"
586 echo -n "${MACHINE_ID}" > "${R}/var/lib/dbus/machine-id"
578 echo -n "${MACHINE_ID}" > "${ETC_DIR}/machine-id"
587 echo -n "${MACHINE_ID}" > "${ETC_DIR}/machine-id"
579
588
580 # APT Cleanup
589 # APT Cleanup
581 chroot_exec apt-get -y clean
590 chroot_exec apt-get -y clean
582 chroot_exec apt-get -y autoclean
591 chroot_exec apt-get -y autoclean
583 chroot_exec apt-get -y autoremove
592 chroot_exec apt-get -y autoremove
584
593
585 # Unmount mounted filesystems
594 # Unmount mounted filesystems
586 umount -l "${R}/proc"
595 umount -l "${R}/proc"
587 umount -l "${R}/sys"
596 umount -l "${R}/sys"
588
597
589 # Clean up directories
598 # Clean up directories
590 rm -rf "${R}/run/*"
599 rm -rf "${R}/run/*"
591 rm -rf "${R}/tmp/*"
600 rm -rf "${R}/tmp/*"
592
601
593 # Clean up files
602 # Clean up files
594 rm -f "${ETC_DIR}/ssh/ssh_host_*"
603 rm -f "${ETC_DIR}/ssh/ssh_host_*"
595 rm -f "${ETC_DIR}/dropbear/dropbear_*"
604 rm -f "${ETC_DIR}/dropbear/dropbear_*"
596 rm -f "${ETC_DIR}/apt/sources.list.save"
605 rm -f "${ETC_DIR}/apt/sources.list.save"
597 rm -f "${ETC_DIR}/resolvconf/resolv.conf.d/original"
606 rm -f "${ETC_DIR}/resolvconf/resolv.conf.d/original"
598 rm -f "${ETC_DIR}/*-"
607 rm -f "${ETC_DIR}/*-"
599 rm -f "${ETC_DIR}/apt/apt.conf.d/10proxy"
608 rm -f "${ETC_DIR}/apt/apt.conf.d/10proxy"
600 rm -f "${ETC_DIR}/resolv.conf"
609 rm -f "${ETC_DIR}/resolv.conf"
601 rm -f "${R}/root/.bash_history"
610 rm -f "${R}/root/.bash_history"
602 rm -f "${R}/var/lib/urandom/random-seed"
611 rm -f "${R}/var/lib/urandom/random-seed"
603 rm -f "${R}/initrd.img"
612 rm -f "${R}/initrd.img"
604 rm -f "${R}/vmlinuz"
613 rm -f "${R}/vmlinuz"
605 rm -f "${R}${QEMU_BINARY}"
614 rm -f "${R}${QEMU_BINARY}"
606
615
607 if [ "$ENABLE_QEMU" = true ] ; then
616 if [ "$ENABLE_QEMU" = true ] ; then
608 # Setup QEMU directory
617 # Setup QEMU directory
609 mkdir "${BASEDIR}/qemu"
618 mkdir "${BASEDIR}/qemu"
610
619
611 # Copy kernel image to QEMU directory
620 # Copy kernel image to QEMU directory
612 install_readonly "${BOOT_DIR}/${KERNEL_IMAGE}" "${BASEDIR}/qemu/${KERNEL_IMAGE}"
621 install_readonly "${BOOT_DIR}/${KERNEL_IMAGE}" "${BASEDIR}/qemu/${KERNEL_IMAGE}"
613
622
614 # Copy kernel config to QEMU directory
623 # Copy kernel config to QEMU directory
615 install_readonly "${R}/boot/config-${KERNEL_VERSION}" "${BASEDIR}/qemu/config-${KERNEL_VERSION}"
624 install_readonly "${R}/boot/config-${KERNEL_VERSION}" "${BASEDIR}/qemu/config-${KERNEL_VERSION}"
616
625
617 # Copy kernel dtbs to QEMU directory
626 # Copy kernel dtbs to QEMU directory
618 for dtb in "${BOOT_DIR}/"*.dtb ; do
627 for dtb in "${BOOT_DIR}/"*.dtb ; do
619 if [ -f "${dtb}" ] ; then
628 if [ -f "${dtb}" ] ; then
620 install_readonly "${dtb}" "${BASEDIR}/qemu/"
629 install_readonly "${dtb}" "${BASEDIR}/qemu/"
621 fi
630 fi
622 done
631 done
623
632
624 # Copy kernel overlays to QEMU directory
633 # Copy kernel overlays to QEMU directory
625 if [ -d "${BOOT_DIR}/overlays" ] ; then
634 if [ -d "${BOOT_DIR}/overlays" ] ; then
626 # Setup overlays dtbs directory
635 # Setup overlays dtbs directory
627 mkdir "${BASEDIR}/qemu/overlays"
636 mkdir "${BASEDIR}/qemu/overlays"
628
637
629 for dtb in "${BOOT_DIR}/overlays/"*.dtb ; do
638 for dtb in "${BOOT_DIR}/overlays/"*.dtb ; do
630 if [ -f "${dtb}" ] ; then
639 if [ -f "${dtb}" ] ; then
631 install_readonly "${dtb}" "${BASEDIR}/qemu/overlays/"
640 install_readonly "${dtb}" "${BASEDIR}/qemu/overlays/"
632 fi
641 fi
633 done
642 done
634 fi
643 fi
635
644
636 # Copy u-boot files to QEMU directory
645 # Copy u-boot files to QEMU directory
637 if [ "$ENABLE_UBOOT" = true ] ; then
646 if [ "$ENABLE_UBOOT" = true ] ; then
638 if [ -f "${BOOT_DIR}/u-boot.bin" ] ; then
647 if [ -f "${BOOT_DIR}/u-boot.bin" ] ; then
639 install_readonly "${BOOT_DIR}/u-boot.bin" "${BASEDIR}/qemu/u-boot.bin"
648 install_readonly "${BOOT_DIR}/u-boot.bin" "${BASEDIR}/qemu/u-boot.bin"
640 fi
649 fi
641 if [ -f "${BOOT_DIR}/uboot.mkimage" ] ; then
650 if [ -f "${BOOT_DIR}/uboot.mkimage" ] ; then
642 install_readonly "${BOOT_DIR}/uboot.mkimage" "${BASEDIR}/qemu/uboot.mkimage"
651 install_readonly "${BOOT_DIR}/uboot.mkimage" "${BASEDIR}/qemu/uboot.mkimage"
643 fi
652 fi
644 if [ -f "${BOOT_DIR}/boot.scr" ] ; then
653 if [ -f "${BOOT_DIR}/boot.scr" ] ; then
645 install_readonly "${BOOT_DIR}/boot.scr" "${BASEDIR}/qemu/boot.scr"
654 install_readonly "${BOOT_DIR}/boot.scr" "${BASEDIR}/qemu/boot.scr"
646 fi
655 fi
647 fi
656 fi
648
657
649 # Copy initramfs to QEMU directory
658 # Copy initramfs to QEMU directory
650 if [ -f "${BOOT_DIR}/initramfs-${KERNEL_VERSION}" ] ; then
659 if [ -f "${BOOT_DIR}/initramfs-${KERNEL_VERSION}" ] ; then
651 install_readonly "${BOOT_DIR}/initramfs-${KERNEL_VERSION}" "${BASEDIR}/qemu/initramfs-${KERNEL_VERSION}"
660 install_readonly "${BOOT_DIR}/initramfs-${KERNEL_VERSION}" "${BASEDIR}/qemu/initramfs-${KERNEL_VERSION}"
652 fi
661 fi
653 fi
662 fi
654
663
655 # Calculate size of the chroot directory in KB
664 # Calculate size of the chroot directory in KB
656 CHROOT_SIZE=$(expr `du -s "${R}" | awk '{ print $1 }'`)
665 CHROOT_SIZE=$(expr `du -s "${R}" | awk '{ print $1 }'`)
657
666
658 # Calculate the amount of needed 512 Byte sectors
667 # Calculate the amount of needed 512 Byte sectors
659 TABLE_SECTORS=$(expr 1 \* 1024 \* 1024 \/ 512)
668 TABLE_SECTORS=$(expr 1 \* 1024 \* 1024 \/ 512)
660 FRMW_SECTORS=$(expr 64 \* 1024 \* 1024 \/ 512)
669 FRMW_SECTORS=$(expr 64 \* 1024 \* 1024 \/ 512)
661 ROOT_OFFSET=$(expr ${TABLE_SECTORS} + ${FRMW_SECTORS})
670 ROOT_OFFSET=$(expr ${TABLE_SECTORS} + ${FRMW_SECTORS})
662
671
663 # The root partition is EXT4
672 # The root partition is EXT4
664 # This means more space than the actual used space of the chroot is used.
673 # This means more space than the actual used space of the chroot is used.
665 # As overhead for journaling and reserved blocks 35% are added.
674 # As overhead for journaling and reserved blocks 35% are added.
666 ROOT_SECTORS=$(expr $(expr ${CHROOT_SIZE} + ${CHROOT_SIZE} \/ 100 \* 35) \* 1024 \/ 512)
675 ROOT_SECTORS=$(expr $(expr ${CHROOT_SIZE} + ${CHROOT_SIZE} \/ 100 \* 35) \* 1024 \/ 512)
667
676
668 # Calculate required image size in 512 Byte sectors
677 # Calculate required image size in 512 Byte sectors
669 IMAGE_SECTORS=$(expr ${TABLE_SECTORS} + ${FRMW_SECTORS} + ${ROOT_SECTORS})
678 IMAGE_SECTORS=$(expr ${TABLE_SECTORS} + ${FRMW_SECTORS} + ${ROOT_SECTORS})
670
679
671 # Prepare image file
680 # Prepare image file
672 if [ "$ENABLE_SPLITFS" = true ] ; then
681 if [ "$ENABLE_SPLITFS" = true ] ; then
673 dd if=/dev/zero of="$IMAGE_NAME-frmw.img" bs=512 count=${TABLE_SECTORS}
682 dd if=/dev/zero of="$IMAGE_NAME-frmw.img" bs=512 count=${TABLE_SECTORS}
674 dd if=/dev/zero of="$IMAGE_NAME-frmw.img" bs=512 count=0 seek=${FRMW_SECTORS}
683 dd if=/dev/zero of="$IMAGE_NAME-frmw.img" bs=512 count=0 seek=${FRMW_SECTORS}
675 dd if=/dev/zero of="$IMAGE_NAME-root.img" bs=512 count=${TABLE_SECTORS}
684 dd if=/dev/zero of="$IMAGE_NAME-root.img" bs=512 count=${TABLE_SECTORS}
676 dd if=/dev/zero of="$IMAGE_NAME-root.img" bs=512 count=0 seek=${ROOT_SECTORS}
685 dd if=/dev/zero of="$IMAGE_NAME-root.img" bs=512 count=0 seek=${ROOT_SECTORS}
677
686
678 # Write firmware/boot partition tables
687 # Write firmware/boot partition tables
679 sfdisk -q -L -uS -f "$IMAGE_NAME-frmw.img" 2> /dev/null <<EOM
688 sfdisk -q -L -uS -f "$IMAGE_NAME-frmw.img" 2> /dev/null <<EOM
680 ${TABLE_SECTORS},${FRMW_SECTORS},c,*
689 ${TABLE_SECTORS},${FRMW_SECTORS},c,*
681 EOM
690 EOM
682
691
683 # Write root partition table
692 # Write root partition table
684 sfdisk -q -L -uS -f "$IMAGE_NAME-root.img" 2> /dev/null <<EOM
693 sfdisk -q -L -uS -f "$IMAGE_NAME-root.img" 2> /dev/null <<EOM
685 ${TABLE_SECTORS},${ROOT_SECTORS},83
694 ${TABLE_SECTORS},${ROOT_SECTORS},83
686 EOM
695 EOM
687
696
688 # Setup temporary loop devices
697 # Setup temporary loop devices
689 FRMW_LOOP="$(losetup -o 1M --sizelimit 64M -f --show $IMAGE_NAME-frmw.img)"
698 FRMW_LOOP="$(losetup -o 1M --sizelimit 64M -f --show $IMAGE_NAME-frmw.img)"
690 ROOT_LOOP="$(losetup -o 1M -f --show $IMAGE_NAME-root.img)"
699 ROOT_LOOP="$(losetup -o 1M -f --show $IMAGE_NAME-root.img)"
691 else # ENABLE_SPLITFS=false
700 else # ENABLE_SPLITFS=false
692 dd if=/dev/zero of="$IMAGE_NAME.img" bs=512 count=${TABLE_SECTORS}
701 dd if=/dev/zero of="$IMAGE_NAME.img" bs=512 count=${TABLE_SECTORS}
693 dd if=/dev/zero of="$IMAGE_NAME.img" bs=512 count=0 seek=${IMAGE_SECTORS}
702 dd if=/dev/zero of="$IMAGE_NAME.img" bs=512 count=0 seek=${IMAGE_SECTORS}
694
703
695 # Write partition table
704 # Write partition table
696 sfdisk -q -L -uS -f "$IMAGE_NAME.img" 2> /dev/null <<EOM
705 sfdisk -q -L -uS -f "$IMAGE_NAME.img" 2> /dev/null <<EOM
697 ${TABLE_SECTORS},${FRMW_SECTORS},c,*
706 ${TABLE_SECTORS},${FRMW_SECTORS},c,*
698 ${ROOT_OFFSET},${ROOT_SECTORS},83
707 ${ROOT_OFFSET},${ROOT_SECTORS},83
699 EOM
708 EOM
700
709
701 # Setup temporary loop devices
710 # Setup temporary loop devices
702 FRMW_LOOP="$(losetup -o 1M --sizelimit 64M -f --show $IMAGE_NAME.img)"
711 FRMW_LOOP="$(losetup -o 1M --sizelimit 64M -f --show $IMAGE_NAME.img)"
703 ROOT_LOOP="$(losetup -o 65M -f --show $IMAGE_NAME.img)"
712 ROOT_LOOP="$(losetup -o 65M -f --show $IMAGE_NAME.img)"
704 fi
713 fi
705
714
706 if [ "$ENABLE_CRYPTFS" = true ] ; then
715 if [ "$ENABLE_CRYPTFS" = true ] ; then
707 # Create dummy ext4 fs
716 # Create dummy ext4 fs
708 mkfs.ext4 "$ROOT_LOOP"
717 mkfs.ext4 "$ROOT_LOOP"
709
718
710 # Setup password keyfile
719 # Setup password keyfile
711 touch .password
720 touch .password
712 chmod 600 .password
721 chmod 600 .password
713 echo -n ${CRYPTFS_PASSWORD} > .password
722 echo -n ${CRYPTFS_PASSWORD} > .password
714
723
715 # Initialize encrypted partition
724 # Initialize encrypted partition
716 echo "YES" | cryptsetup luksFormat "${ROOT_LOOP}" -c "${CRYPTFS_CIPHER}" -s "${CRYPTFS_XTSKEYSIZE}" .password
725 echo "YES" | cryptsetup luksFormat "${ROOT_LOOP}" -c "${CRYPTFS_CIPHER}" -s "${CRYPTFS_XTSKEYSIZE}" .password
717
726
718 # Open encrypted partition and setup mapping
727 # Open encrypted partition and setup mapping
719 cryptsetup luksOpen "${ROOT_LOOP}" -d .password "${CRYPTFS_MAPPING}"
728 cryptsetup luksOpen "${ROOT_LOOP}" -d .password "${CRYPTFS_MAPPING}"
720
729
721 # Secure delete password keyfile
730 # Secure delete password keyfile
722 shred -zu .password
731 shred -zu .password
723
732
724 # Update temporary loop device
733 # Update temporary loop device
725 ROOT_LOOP="/dev/mapper/${CRYPTFS_MAPPING}"
734 ROOT_LOOP="/dev/mapper/${CRYPTFS_MAPPING}"
726
735
727 # Wipe encrypted partition (encryption cipher is used for randomness)
736 # Wipe encrypted partition (encryption cipher is used for randomness)
728 dd if=/dev/zero of="${ROOT_LOOP}" bs=512 count=$(blockdev --getsz "${ROOT_LOOP}")
737 dd if=/dev/zero of="${ROOT_LOOP}" bs=512 count=$(blockdev --getsz "${ROOT_LOOP}")
729 fi
738 fi
730
739
731 # Build filesystems
740 # Build filesystems
732 mkfs.vfat "$FRMW_LOOP"
741 mkfs.vfat "$FRMW_LOOP"
733 mkfs.ext4 "$ROOT_LOOP"
742 mkfs.ext4 "$ROOT_LOOP"
734
743
735 # Mount the temporary loop devices
744 # Mount the temporary loop devices
736 mkdir -p "$BUILDDIR/mount"
745 mkdir -p "$BUILDDIR/mount"
737 mount "$ROOT_LOOP" "$BUILDDIR/mount"
746 mount "$ROOT_LOOP" "$BUILDDIR/mount"
738
747
739 mkdir -p "$BUILDDIR/mount/boot/firmware"
748 mkdir -p "$BUILDDIR/mount/boot/firmware"
740 mount "$FRMW_LOOP" "$BUILDDIR/mount/boot/firmware"
749 mount "$FRMW_LOOP" "$BUILDDIR/mount/boot/firmware"
741
750
742 # Copy all files from the chroot to the loop device mount point directory
751 # Copy all files from the chroot to the loop device mount point directory
743 rsync -a "${R}/" "$BUILDDIR/mount/"
752 rsync -a "${R}/" "$BUILDDIR/mount/"
744
753
745 # Unmount all temporary loop devices and mount points
754 # Unmount all temporary loop devices and mount points
746 cleanup
755 cleanup
747
756
748 # Create block map file(s) of image(s)
757 # Create block map file(s) of image(s)
749 if [ "$ENABLE_SPLITFS" = true ] ; then
758 if [ "$ENABLE_SPLITFS" = true ] ; then
750 # Create block map files for "bmaptool"
759 # Create block map files for "bmaptool"
751 bmaptool create -o "$IMAGE_NAME-frmw.bmap" "$IMAGE_NAME-frmw.img"
760 bmaptool create -o "$IMAGE_NAME-frmw.bmap" "$IMAGE_NAME-frmw.img"
752 bmaptool create -o "$IMAGE_NAME-root.bmap" "$IMAGE_NAME-root.img"
761 bmaptool create -o "$IMAGE_NAME-root.bmap" "$IMAGE_NAME-root.img"
753
762
754 # Image was successfully created
763 # Image was successfully created
755 echo "$IMAGE_NAME-frmw.img ($(expr \( ${TABLE_SECTORS} + ${FRMW_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
764 echo "$IMAGE_NAME-frmw.img ($(expr \( ${TABLE_SECTORS} + ${FRMW_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
756 echo "$IMAGE_NAME-root.img ($(expr \( ${TABLE_SECTORS} + ${ROOT_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
765 echo "$IMAGE_NAME-root.img ($(expr \( ${TABLE_SECTORS} + ${ROOT_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
757 else
766 else
758 # Create block map file for "bmaptool"
767 # Create block map file for "bmaptool"
759 bmaptool create -o "$IMAGE_NAME.bmap" "$IMAGE_NAME.img"
768 bmaptool create -o "$IMAGE_NAME.bmap" "$IMAGE_NAME.img"
760
769
761 # Image was successfully created
770 # Image was successfully created
762 echo "$IMAGE_NAME.img ($(expr \( ${TABLE_SECTORS} + ${FRMW_SECTORS} + ${ROOT_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
771 echo "$IMAGE_NAME.img ($(expr \( ${TABLE_SECTORS} + ${FRMW_SECTORS} + ${ROOT_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
763
772
764 # Create qemu qcow2 image
773 # Create qemu qcow2 image
765 if [ "$ENABLE_QEMU" = true ] ; then
774 if [ "$ENABLE_QEMU" = true ] ; then
766 QEMU_IMAGE=${QEMU_IMAGE:=${BASEDIR}/qemu/${DATE}-${KERNEL_ARCH}-CURRENT-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}}
775 QEMU_IMAGE=${QEMU_IMAGE:=${BASEDIR}/qemu/${DATE}-${KERNEL_ARCH}-CURRENT-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}}
767 QEMU_SIZE=16G
776 QEMU_SIZE=16G
768
777
769 qemu-img convert -f raw -O qcow2 $IMAGE_NAME.img $QEMU_IMAGE.qcow2
778 qemu-img convert -f raw -O qcow2 $IMAGE_NAME.img $QEMU_IMAGE.qcow2
770 qemu-img resize $QEMU_IMAGE.qcow2 $QEMU_SIZE
779 qemu-img resize $QEMU_IMAGE.qcow2 $QEMU_SIZE
771
780
772 echo "$QEMU_IMAGE.qcow2 ($QEMU_SIZE)" ": successfully created"
781 echo "$QEMU_IMAGE.qcow2 ($QEMU_SIZE)" ": successfully created"
773 fi
782 fi
774 fi
783 fi
General Comments 0
Vous devez vous connecter pour laisser un commentaire. Se connecter maintenant