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