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

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

https://github.com/drtyhlpr/rpi23-gen-image/issues/199...
Unknown -
r618:ab85e220d741
parent child
Show More
Show file before | Show file after | Hide comments
@@ -1,544 +1,544
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 all Raspberry Pi computers. The script at this time supports the bootstrapping of the Debian (armhf/armel) releases `stretch` and `buster`. Raspberry Pi 0/1/2/3 images are generated for 32-bit mode only. Raspberry Pi 3 supports 64-bit images that can be generated using custom configuration parameters (```templates/rpi3-stretch-arm64-4.14.y```).
3 `rpi23-gen-image.sh` is an advanced Debian Linux bootstrapping shell script for generating Debian OS images for all Raspberry Pi computers. The script at this time supports the bootstrapping of the Debian (armhf/armel) releases `stretch` and `buster`. Raspberry Pi 0/1/2/3 images are generated for 32-bit mode only. Raspberry Pi 3 supports 64-bit images that can be generated using custom configuration parameters (```templates/rpi3-stretch-arm64-4.14.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 Raspberry 3 this is mandatory. Kernel compilation and linking will be performed on the build system using an ARM (armhf/armel) 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 Raspberry 3 this is mandatory. Kernel compilation and linking will be performed on the build system using an ARM (armhf/armel) cross-compiler toolchain.
11
11
12 The script has been tested using the default `crossbuild-essential-armhf` and `crossbuild-essential-armel` toolchain meta packages on Debian Linux `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` and `crossbuild-essential-armel` toolchain meta packages on Debian Linux `stretch` build systems. Please check the [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains) for further information.
13
13
14 ## Command-line parameters
14 ## Command-line parameters
15 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.
15 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.
16
16
17 ##### Command-line examples:
17 ##### Command-line examples:
18 ```shell
18 ```shell
19 ENABLE_UBOOT=true ./rpi23-gen-image.sh
19 ENABLE_UBOOT=true ./rpi23-gen-image.sh
20 ENABLE_CONSOLE=false ENABLE_IPV6=false ./rpi23-gen-image.sh
20 ENABLE_CONSOLE=false ENABLE_IPV6=false ./rpi23-gen-image.sh
21 ENABLE_WM=xfce4 ENABLE_FBTURBO=true ENABLE_MINBASE=true ./rpi23-gen-image.sh
21 ENABLE_WM=xfce4 ENABLE_FBTURBO=true ENABLE_MINBASE=true ./rpi23-gen-image.sh
22 ENABLE_HARDNET=true ENABLE_IPTABLES=true /rpi23-gen-image.sh
22 ENABLE_HARDNET=true ENABLE_IPTABLES=true /rpi23-gen-image.sh
23 APT_SERVER=ftp.de.debian.org APT_PROXY="http://127.0.0.1:3142/" ./rpi23-gen-image.sh
23 APT_SERVER=ftp.de.debian.org APT_PROXY="http://127.0.0.1:3142/" ./rpi23-gen-image.sh
24 ENABLE_MINBASE=true ./rpi23-gen-image.sh
24 ENABLE_MINBASE=true ./rpi23-gen-image.sh
25 BUILD_KERNEL=true ENABLE_MINBASE=true ENABLE_IPV6=false ./rpi23-gen-image.sh
25 BUILD_KERNEL=true ENABLE_MINBASE=true ENABLE_IPV6=false ./rpi23-gen-image.sh
26 BUILD_KERNEL=true KERNELSRC_DIR=/tmp/linux ./rpi23-gen-image.sh
26 BUILD_KERNEL=true KERNELSRC_DIR=/tmp/linux ./rpi23-gen-image.sh
27 ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh
27 ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh
28 ENABLE_CRYPTFS=true CRYPTFS_PASSWORD=changeme EXPANDROOT=false ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh
28 ENABLE_CRYPTFS=true CRYPTFS_PASSWORD=changeme EXPANDROOT=false ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh
29 RELEASE=stretch BUILD_KERNEL=true ./rpi23-gen-image.sh
29 RELEASE=stretch BUILD_KERNEL=true ./rpi23-gen-image.sh
30 RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
30 RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
31 RELEASE=stretch RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
31 RELEASE=stretch RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
32 ```
32 ```
33
33
34 ## Configuration template files
34 ## Configuration template files
35 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.
35 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.
36
36
37 ##### Command-line examples:
37 ##### Command-line examples:
38 ```shell
38 ```shell
39 CONFIG_TEMPLATE=rpi3stretch ./rpi23-gen-image.sh
39 CONFIG_TEMPLATE=rpi3stretch ./rpi23-gen-image.sh
40 CONFIG_TEMPLATE=rpi2stretch ./rpi23-gen-image.sh
40 CONFIG_TEMPLATE=rpi2stretch ./rpi23-gen-image.sh
41 ```
41 ```
42
42
43 ## Supported parameters and settings
43 ## Supported parameters and settings
44 #### APT settings:
44 #### APT settings:
45 ##### `APT_SERVER`="ftp.debian.org"
45 ##### `APT_SERVER`="ftp.debian.org"
46 Set Debian packages server address. Choose a server from the list of Debian worldwide [mirror sites](https://www.debian.org/mirror/list). Using a nearby server will probably speed-up all required downloads within the bootstrapping process.
46 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.
47
47
48 ##### `APT_PROXY`=""
48 ##### `APT_PROXY`=""
49 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. If `apt-cacher-ng` is running on default `http://127.0.0.1:3142` it is autodetected and you don't need to set this.
49 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. If `apt-cacher-ng` is running on default `http://127.0.0.1:3142` it is autodetected and you don't need to set this.
50
50
51 ##### `KEEP_APT_PROXY`=false
51 ##### `KEEP_APT_PROXY`=false
52 Keep the APT_PROXY settings used in the bootsrapping process in the generated image.
52 Keep the APT_PROXY settings used in the bootsrapping process in the generated image.
53
53
54 ##### `APT_INCLUDES`=""
54 ##### `APT_INCLUDES`=""
55 A comma-separated list of additional packages to be installed by debootstrap during bootstrapping.
55 A comma-separated list of additional packages to be installed by debootstrap during bootstrapping.
56
56
57 ##### `APT_INCLUDES_LATE`=""
57 ##### `APT_INCLUDES_LATE`=""
58 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.
58 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.
59
59
60 ---
60 ---
61
61
62 #### General system settings:
62 #### General system settings:
63 ##### `SET_ARCH`=32
63 ##### `SET_ARCH`=32
64 Set Architecture to default 32bit. If you want to compile 64-bit (RPI3 or RPI3+) set it to `64`. This option will set every needed cross-compiler or board specific option for a successful build.
64 Set Architecture to default 32bit. If you want to compile 64-bit (RPI3 or RPI3+) set it to `64`. This option will set every needed cross-compiler or board specific option for a successful build.
65
65
66 ##### `RPI_MODEL`=2
66 ##### `RPI_MODEL`=2
67 Specify the target Raspberry Pi hardware model. The script at this time supports the following Raspberry Pi models:
67 Specify the target Raspberry Pi hardware model. The script at this time supports the following Raspberry Pi models:
68 - `0` = Raspberry Pi 0 and Raspberry Pi 0 W
68 - `0` = Raspberry Pi 0 and Raspberry Pi 0 W
69 - `1` = Raspberry Pi 1 model A and B
69 - `1` = Raspberry Pi 1 model A and B
70 - `1P` = Raspberry Pi 1 model B+ and A+
70 - `1P` = Raspberry Pi 1 model B+ and A+
71 - `2` = Raspberry Pi 2 model B
71 - `2` = Raspberry Pi 2 model B
72 - `3` = Raspberry Pi 3 model B
72 - `3` = Raspberry Pi 3 model B
73 - `3P` = Raspberry Pi 3 model B+
73 - `3P` = Raspberry Pi 3 model B+
74
74
75 ##### `RELEASE`="buster"
75 ##### `RELEASE`="buster"
76 Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases `stretch` and `buster`.
76 Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases `stretch` and `buster`.
77
77
78 ##### `RELEASE_ARCH`="armhf"
78 ##### `RELEASE_ARCH`="armhf"
79 Set the desired Debian release architecture.
79 Set the desired Debian release architecture.
80
80
81 ##### `HOSTNAME`="rpi$RPI_MODEL-$RELEASE"
81 ##### `HOSTNAME`="rpi$RPI_MODEL-$RELEASE"
82 Set system hostname. It's recommended that the hostname is unique in the corresponding subnet.
82 Set system hostname. It's recommended that the hostname is unique in the corresponding subnet.
83
83
84 ##### `PASSWORD`="raspberry"
84 ##### `PASSWORD`="raspberry"
85 Set system `root` password. It's **STRONGLY** recommended that you choose a custom password.
85 Set system `root` password. It's **STRONGLY** recommended that you choose a custom password.
86
86
87 ##### `USER_PASSWORD`="raspberry"
87 ##### `USER_PASSWORD`="raspberry"
88 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.
88 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.
89
89
90 ##### `DEFLOCAL`="en_US.UTF-8"
90 ##### `DEFLOCAL`="en_US.UTF-8"
91 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`.
91 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`.
92
92
93 ##### `TIMEZONE`="Europe/Berlin"
93 ##### `TIMEZONE`="Europe/Berlin"
94 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.
94 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.
95
95
96 ##### `EXPANDROOT`=true
96 ##### `EXPANDROOT`=true
97 Expand the root partition and filesystem automatically on first boot.
97 Expand the root partition and filesystem automatically on first boot.
98
98
99 ##### `ENABLE_QEMU`=false
99 ##### `ENABLE_QEMU`=false
100 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.
100 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.
101
101
102 ---
102 ---
103
103
104 #### Keyboard settings:
104 #### Keyboard settings:
105 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.
105 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.
106
106
107 ##### `XKB_MODEL`=""
107 ##### `XKB_MODEL`=""
108 Set the name of the model of your keyboard type.
108 Set the name of the model of your keyboard type.
109
109
110 ##### `XKB_LAYOUT`=""
110 ##### `XKB_LAYOUT`=""
111 Set the supported keyboard layout(s).
111 Set the supported keyboard layout(s).
112
112
113 ##### `XKB_VARIANT`=""
113 ##### `XKB_VARIANT`=""
114 Set the supported variant(s) of the keyboard layout(s).
114 Set the supported variant(s) of the keyboard layout(s).
115
115
116 ##### `XKB_OPTIONS`=""
116 ##### `XKB_OPTIONS`=""
117 Set extra xkb configuration options.
117 Set extra xkb configuration options.
118
118
119 ---
119 ---
120
120
121 #### Networking settings (DHCP):
121 #### Networking settings (DHCP):
122 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`.`
122 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`.`
123
123
124 ##### `ENABLE_DHCP`=true
124 ##### `ENABLE_DHCP`=true
125 Set the system to use DHCP. This requires an DHCP server.
125 Set the system to use DHCP. This requires an DHCP server.
126
126
127 ---
127 ---
128
128
129 #### Networking settings (static):
129 #### Networking settings (static):
130 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`.
130 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`.
131
131
132 ##### `NET_ADDRESS`=""
132 ##### `NET_ADDRESS`=""
133 Set a static IPv4 or IPv6 address and its prefix, separated by "/", eg. "192.169.0.3/24".
133 Set a static IPv4 or IPv6 address and its prefix, separated by "/", eg. "192.169.0.3/24".
134
134
135 ##### `NET_GATEWAY`=""
135 ##### `NET_GATEWAY`=""
136 Set the IP address for the default gateway.
136 Set the IP address for the default gateway.
137
137
138 ##### `NET_DNS_1`=""
138 ##### `NET_DNS_1`=""
139 Set the IP address for the first DNS server.
139 Set the IP address for the first DNS server.
140
140
141 ##### `NET_DNS_2`=""
141 ##### `NET_DNS_2`=""
142 Set the IP address for the second DNS server.
142 Set the IP address for the second DNS server.
143
143
144 ##### `NET_DNS_DOMAINS`=""
144 ##### `NET_DNS_DOMAINS`=""
145 Set the default DNS search domains to use for non fully qualified hostnames.
145 Set the default DNS search domains to use for non fully qualified hostnames.
146
146
147 ##### `NET_NTP_1`=""
147 ##### `NET_NTP_1`=""
148 Set the IP address for the first NTP server.
148 Set the IP address for the first NTP server.
149
149
150 ##### `NET_NTP_2`=""
150 ##### `NET_NTP_2`=""
151 Set the IP address for the second NTP server.
151 Set the IP address for the second NTP server.
152
152
153 ---
153 ---
154
154
155 #### Basic system features:
155 #### Basic system features:
156 ##### `ENABLE_CONSOLE`=true
156 ##### `ENABLE_CONSOLE`=true
157 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. On RPI `0` `3` `3P` the CPU speed is locked at lowest speed.
157 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. On RPI `0` `3` `3P` the CPU speed is locked at lowest speed.
158
158
159 ##### `ENABLE_PRINTK`=false
159 ##### `ENABLE_PRINTK`=false
160 Enables printing kernel messages to konsole. printk is `3 4 1 3` as in raspbian.
160 Enables printing kernel messages to konsole. printk is `3 4 1 3` as in raspbian.
161
161
162 ##### `ENABLE_BLUETOOTH`=false
162 ##### `ENABLE_BLUETOOTH`=false
163 Enable onboard Bluetooth interface on the RPi0/3/3P. See: [Configuring the GPIO serial port on Raspbian jessie and stretch](https://spellfoundry.com/2016/05/29/configuring-gpio-serial-port-raspbian-jessie-including-pi-3/).
163 Enable onboard Bluetooth interface on the RPi0/3/3P. See: [Configuring the GPIO serial port on Raspbian jessie and stretch](https://spellfoundry.com/2016/05/29/configuring-gpio-serial-port-raspbian-jessie-including-pi-3/).
164
164
165 ##### `ENABLE_MINIUART_OVERLAY`=false
165 ##### `ENABLE_MINIUART_OVERLAY`=false
166 Enable Bluetooth to use this. Adds overlay to swap UART0 with UART1. Enabling (slower) Bluetooth and full speed serial console. - RPI `0` `3` `3P` have a fast `hardware UART0` (ttyAMA0) and a `mini UART1` (ttyS0)! RPI `1` `1P` `2` only have a `hardware UART0`. `UART0` is considered better, because is faster and more stable than `mini UART1`. By default the Bluetooth modem is mapped to the `hardware UART0` and `mini UART` is used for console. The `mini UART` is a problem for the serial console, because its baudrate depends on the CPU frequency, which is changing on runtime. Resulting in a volatile baudrate and thus in an unusable serial console.
166 Enable Bluetooth to use this. Adds overlay to swap UART0 with UART1. Enabling (slower) Bluetooth and full speed serial console. - RPI `0` `3` `3P` have a fast `hardware UART0` (ttyAMA0) and a `mini UART1` (ttyS0)! RPI `1` `1P` `2` only have a `hardware UART0`. `UART0` is considered better, because is faster and more stable than `mini UART1`. By default the Bluetooth modem is mapped to the `hardware UART0` and `mini UART` is used for console. The `mini UART` is a problem for the serial console, because its baudrate depends on the CPU frequency, which is changing on runtime. Resulting in a volatile baudrate and thus in an unusable serial console.
167
167
168 ##### `ENABLE_TURBO`=false
168 ##### `ENABLE_TURBO`=false
169 Enable Turbo mode. This setting locks cpu at the highest frequency. As setting ENABLE_CONSOLE=true locks RPI to lowest CPU speed, this is can be used additionally to lock cpu hat max speed. Need a good power supply and probably cooling for the Raspberry PI.
169 Enable Turbo mode. This setting locks cpu at the highest frequency. As setting ENABLE_CONSOLE=true locks RPI to lowest CPU speed, this is can be used additionally to lock cpu hat max speed. Need a good power supply and probably cooling for the Raspberry PI.
170
170
171 ##### `ENABLE_I2C`=false
171 ##### `ENABLE_I2C`=false
172 Enable I2C interface on the RPi 0/1/2/3. Please check the [RPi 0/1/2/3 pinout diagrams](https://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.
172 Enable I2C interface on the RPi 0/1/2/3. Please check the [RPi 0/1/2/3 pinout diagrams](https://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.
173
173
174 ##### `ENABLE_SPI`=false
174 ##### `ENABLE_SPI`=false
175 Enable SPI interface on the RPi 0/1/2/3. Please check the [RPi 0/1/2/3 pinout diagrams](https://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.
175 Enable SPI interface on the RPi 0/1/2/3. Please check the [RPi 0/1/2/3 pinout diagrams](https://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.
176
176
177 ##### `ENABLE_IPV6`=true
177 ##### `ENABLE_IPV6`=true
178 Enable IPv6 support. The network interface configuration is managed via systemd-networkd.
178 Enable IPv6 support. The network interface configuration is managed via systemd-networkd.
179
179
180 ##### `ENABLE_SSHD`=true
180 ##### `ENABLE_SSHD`=true
181 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.
181 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.
182
182
183 ##### `ENABLE_NONFREE`=false
183 ##### `ENABLE_NONFREE`=false
184 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.
184 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.
185
185
186 ##### `ENABLE_WIRELESS`=false
186 ##### `ENABLE_WIRELESS`=false
187 Download and install the [closed-source firmware binary blob](https://github.com/RPi-Distro/firmware-nonfree/raw/master/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`.
187 Download and install the [closed-source firmware binary blob](https://github.com/RPi-Distro/firmware-nonfree/raw/master/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`.
188
188
189 ##### `ENABLE_RSYSLOG`=true
189 ##### `ENABLE_RSYSLOG`=true
190 If set to false, disable and uninstall rsyslog (so logs will be available only in journal files)
190 If set to false, disable and uninstall rsyslog (so logs will be available only in journal files)
191
191
192 ##### `ENABLE_SOUND`=true
192 ##### `ENABLE_SOUND`=true
193 Enable sound hardware and install Advanced Linux Sound Architecture.
193 Enable sound hardware and install Advanced Linux Sound Architecture.
194
194
195 ##### `ENABLE_HWRANDOM`=true
195 ##### `ENABLE_HWRANDOM`=true
196 Enable Hardware Random Number Generator. Strong random numbers are important for most network-based communications that use encryption. It's recommended to be enabled.
196 Enable Hardware Random Number Generator. Strong random numbers are important for most network-based communications that use encryption. It's recommended to be enabled.
197
197
198 ##### `ENABLE_MINGPU`=false
198 ##### `ENABLE_MINGPU`=false
199 Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU.
199 Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU.
200
200
201 ##### `ENABLE_DBUS`=true
201 ##### `ENABLE_DBUS`=true
202 Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled.
202 Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled.
203
203
204 ##### `ENABLE_XORG`=false
204 ##### `ENABLE_XORG`=false
205 Install Xorg open-source X Window System.
205 Install Xorg open-source X Window System.
206
206
207 ##### `ENABLE_WM`=""
207 ##### `ENABLE_WM`=""
208 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`.
208 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`.
209
209
210 ##### `ENABLE_SYSVINIT`=false
210 ##### `ENABLE_SYSVINIT`=false
211 Support for halt,init,poweroff,reboot,runlevel,shutdown,telinit commands
211 Support for halt,init,poweroff,reboot,runlevel,shutdown,telinit commands
212
212
213 ---
213 ---
214
214
215 #### Advanced system features:
215 #### Advanced system features:
216 ##### `ENABLE_SYSTEMDSWAP`=false
216 ##### `ENABLE_SYSTEMDSWAP`=false
217 Enables [Systemd-swap service](https://github.com/Nefelim4ag/systemd-swap). Usefull if `KERNEL_ZSWAP` is enabled.
217 Enables [Systemd-swap service](https://github.com/Nefelim4ag/systemd-swap). Usefull if `KERNEL_ZSWAP` is enabled.
218
218
219 ##### `ENABLE_MINBASE`=false
219 ##### `ENABLE_MINBASE`=false
220 Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
220 Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
221
221
222 ##### `ENABLE_REDUCE`=false
222 ##### `ENABLE_REDUCE`=false
223 Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.
223 Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.
224
224
225 ##### `ENABLE_UBOOT`=false
225 ##### `ENABLE_UBOOT`=false
226 Replace the default RPi 0/1/2/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.
226 Replace the default RPi 0/1/2/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.
227
227
228 ##### `UBOOTSRC_DIR`=""
228 ##### `UBOOTSRC_DIR`=""
229 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.
229 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.
230
230
231 ##### `ENABLE_FBTURBO`=false
231 ##### `ENABLE_FBTURBO`=false
232 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.
232 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.
233
233
234 ##### `FBTURBOSRC_DIR`=""
234 ##### `FBTURBOSRC_DIR`=""
235 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.
235 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.
236
236
237 ##### `ENABLE_VIDEOCORE`=false
237 ##### `ENABLE_VIDEOCORE`=false
238 Install and enable the [ARM side libraries for interfacing to Raspberry Pi GPU](https://github.com/raspberrypi/userland) `vcgencmd`. Please note that this driver is currently limited to hardware accelerated window moving and scrolling.
238 Install and enable the [ARM side libraries for interfacing to Raspberry Pi GPU](https://github.com/raspberrypi/userland) `vcgencmd`. Please note that this driver is currently limited to hardware accelerated window moving and scrolling.
239
239
240 ##### `VIDEOCORESRC_DIR`=""
240 ##### `VIDEOCORESRC_DIR`=""
241 Path to a directory (`userland`) of [ARM side libraries for interfacing to Raspberry Pi GPU](https://github.com/raspberrypi/userland) that will be copied, configured, build and installed inside the chroot.
241 Path to a directory (`userland`) of [ARM side libraries for interfacing to Raspberry Pi GPU](https://github.com/raspberrypi/userland) that will be copied, configured, build and installed inside the chroot.
242
242
243 ##### `ENABLE_NEXMON`=false
243 ##### `ENABLE_NEXMON`=false
244 Install and enable the [Source code for a C-based firmware patching framework for Broadcom/Cypress WiFi chips that enables you to write your own firmware patches, for example, to enable monitor mode with radiotap headers and frame injection](https://github.com/seemoo-lab/nexmon.git).
244 Install and enable the [Source code for a C-based firmware patching framework for Broadcom/Cypress WiFi chips that enables you to write your own firmware patches, for example, to enable monitor mode with radiotap headers and frame injection](https://github.com/seemoo-lab/nexmon.git).
245
245
246 ##### `NEXMONSRC_DIR`=""
246 ##### `NEXMONSRC_DIR`=""
247 Path to a directory (`nexmon`) of [Source code for ARM side libraries for interfacing to Raspberry Pi GPU](https://github.com/raspberrypi/userland) that will be copied, configured, build and installed inside the chroot.
247 Path to a directory (`nexmon`) of [Source code for ARM side libraries for interfacing to Raspberry Pi GPU](https://github.com/raspberrypi/userland) that will be copied, configured, build and installed inside the chroot.
248
248
249 ##### `ENABLE_IPTABLES`=false
249 ##### `ENABLE_IPTABLES`=false
250 Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.
250 Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.
251
251
252 ##### `ENABLE_USER`=true
252 ##### `ENABLE_USER`=true
253 Create non-root user with password `USER_PASSWORD`=raspberry. Unless overridden with `USER_NAME`=user, the username will be `pi`.
253 Create non-root user with password `USER_PASSWORD`=raspberry. Unless overridden with `USER_NAME`=user, the username will be `pi`.
254
254
255 ##### `USER_NAME`=pi
255 ##### `USER_NAME`=pi
256 Non-root user to create. Ignored if `ENABLE_USER`=false
256 Non-root user to create. Ignored if `ENABLE_USER`=false
257
257
258 ##### `ENABLE_ROOT`=false
258 ##### `ENABLE_ROOT`=false
259 Set root user password so root login will be enabled
259 Set root user password so root login will be enabled
260
260
261 ##### `ENABLE_HARDNET`=false
261 ##### `ENABLE_HARDNET`=false
262 Enable IPv4/IPv6 network stack hardening settings.
262 Enable IPv4/IPv6 network stack hardening settings.
263
263
264 ##### `ENABLE_SPLITFS`=false
264 ##### `ENABLE_SPLITFS`=false
265 Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.
265 Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.
266
266
267 ##### `CHROOT_SCRIPTS`=""
267 ##### `CHROOT_SCRIPTS`=""
268 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.
268 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.
269
269
270 ##### `ENABLE_INITRAMFS`=false
270 ##### `ENABLE_INITRAMFS`=false
271 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.
271 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.
272
272
273 ##### `ENABLE_IFNAMES`=true
273 ##### `ENABLE_IFNAMES`=true
274 Enable automatic assignment of predictable, stable network interface names for all local Ethernet, WLAN interfaces. This might create complex and long interface names.
274 Enable automatic assignment of predictable, stable network interface names for all local Ethernet, WLAN interfaces. This might create complex and long interface names.
275
275
276 ##### `ENABLE_SPLASH`=true
276 ##### `ENABLE_SPLASH`=true
277 Enable default Raspberry Pi boot up rainbow splash screen.
277 Enable default Raspberry Pi boot up rainbow splash screen.
278
278
279 ##### `ENABLE_LOGO`=true
279 ##### `ENABLE_LOGO`=true
280 Enable default Raspberry Pi console logo (image of four raspberries in the top left corner).
280 Enable default Raspberry Pi console logo (image of four raspberries in the top left corner).
281
281
282 ##### `ENABLE_SILENT_BOOT`=false
282 ##### `ENABLE_SILENT_BOOT`=false
283 Set the verbosity of console messages shown during boot up to a strict minimum.
283 Set the verbosity of console messages shown during boot up to a strict minimum.
284
284
285 ##### `DISABLE_UNDERVOLT_WARNINGS`=
285 ##### `DISABLE_UNDERVOLT_WARNINGS`=
286 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.
286 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.
287
287
288 ---
288 ---
289
289
290 #### SSH settings:
290 #### SSH settings:
291 ##### `SSH_ENABLE_ROOT`=false
291 ##### `SSH_ENABLE_ROOT`=false
292 Enable password-based root login via SSH. This may be a security risk with the default password set, use only in trusted environments. `ENABLE_ROOT` must be set to `true`.
292 Enable password-based root login via SSH. This may be a security risk with the default password set, use only in trusted environments. `ENABLE_ROOT` must be set to `true`.
293
293
294 ##### `SSH_DISABLE_PASSWORD_AUTH`=false
294 ##### `SSH_DISABLE_PASSWORD_AUTH`=false
295 Disable password-based SSH authentication. Only public key based SSH (v2) authentication will be supported.
295 Disable password-based SSH authentication. Only public key based SSH (v2) authentication will be supported.
296
296
297 ##### `SSH_LIMIT_USERS`=false
297 ##### `SSH_LIMIT_USERS`=false
298 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).
298 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).
299
299
300 ##### `SSH_ROOT_PUB_KEY`=""
300 ##### `SSH_ROOT_PUB_KEY`=""
301 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`.
301 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`.
302
302
303 ##### `SSH_USER_PUB_KEY`=""
303 ##### `SSH_USER_PUB_KEY`=""
304 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.
304 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.
305
305
306 ---
306 ---
307
307
308 #### Kernel compilation:
308 #### Kernel compilation:
309 ##### `BUILD_KERNEL`=true
309 ##### `BUILD_KERNEL`=true
310 Build and install the latest RPi 0/1/2/3 Linux kernel. Currently only the default RPi 0/1/2/3 kernel configuration is used.
310 Build and install the latest RPi 0/1/2/3 Linux kernel. Currently only the default RPi 0/1/2/3 kernel configuration is used.
311
311
312 ##### `CROSS_COMPILE`="arm-linux-gnueabihf-"
312 ##### `CROSS_COMPILE`="arm-linux-gnueabihf-"
313 This sets the cross-compile environment for the compiler.
313 This sets the cross-compile environment for the compiler.
314
314
315 ##### `KERNEL_ARCH`="arm"
315 ##### `KERNEL_ARCH`="arm"
316 This sets the kernel architecture for the compiler.
316 This sets the kernel architecture for the compiler.
317
317
318 ##### `KERNEL_IMAGE`="kernel7.img"
318 ##### `KERNEL_IMAGE`="kernel7.img"
319 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.
319 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.
320
320
321 ##### `KERNEL_BRANCH`=""
321 ##### `KERNEL_BRANCH`=""
322 Name of the requested branch from the GIT location for the RPi Kernel. Default is using the current default branch from the GIT site.
322 Name of the requested branch from the GIT location for the RPi Kernel. Default is using the current default branch from the GIT site.
323
323
324 ##### `QEMU_BINARY`="/usr/bin/qemu-arm-static"
324 ##### `QEMU_BINARY`="/usr/bin/qemu-arm-static"
325 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.
325 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.
326
326
327 ##### `KERNEL_DEFCONFIG`="bcm2709_defconfig"
327 ##### `KERNEL_DEFCONFIG`="bcm2709_defconfig"
328 Sets the default config for kernel compiling. If not set, `KERNEL_DEFCONFIG` will be set to "bcmrpi3\_defconfig" automatically if building for arm64.
328 Sets the default config for kernel compiling. If not set, `KERNEL_DEFCONFIG` will be set to "bcmrpi3\_defconfig" automatically if building for arm64.
329
329
330 ##### `KERNEL_REDUCE`=false
330 ##### `KERNEL_REDUCE`=false
331 Reduce the size of the generated kernel by removing unwanted devices, network and filesystem drivers (experimental).
331 Reduce the size of the generated kernel by removing unwanted devices, network and filesystem drivers (experimental).
332
332
333 ##### `KERNEL_THREADS`=1
333 ##### `KERNEL_THREADS`=1
334 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.
334 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.
335
335
336 ##### `KERNEL_HEADERS`=true
336 ##### `KERNEL_HEADERS`=true
337 Install kernel headers with the built kernel.
337 Install kernel headers with the built kernel.
338
338
339 ##### `KERNEL_MENUCONFIG`=false
339 ##### `KERNEL_MENUCONFIG`=false
340 Start `make menuconfig` interactive menu-driven kernel configuration. The script will continue after `make menuconfig` was terminated.
340 Start `make menuconfig` interactive menu-driven kernel configuration. The script will continue after `make menuconfig` was terminated.
341
341
342 ##### `KERNEL_OLDDEFCONFIG`=false
342 ##### `KERNEL_OLDDEFCONFIG`=false
343 Run `make olddefconfig` to automatically set all new kernel configuration options to their recommended default values.
343 Run `make olddefconfig` to automatically set all new kernel configuration options to their recommended default values.
344
344
345 ##### `KERNEL_CCACHE`=false
345 ##### `KERNEL_CCACHE`=false
346 Compile the kernel using ccache. This speeds up kernel recompilation by caching previous compilations and detecting when the same compilation is being done again.
346 Compile the kernel using ccache. This speeds up kernel recompilation by caching previous compilations and detecting when the same compilation is being done again.
347
347
348 ##### `KERNEL_REMOVESRC`=true
348 ##### `KERNEL_REMOVESRC`=true
349 Remove all kernel sources from the generated OS image after it was built and installed.
349 Remove all kernel sources from the generated OS image after it was built and installed.
350
350
351 ##### `KERNELSRC_DIR`=""
351 ##### `KERNELSRC_DIR`=""
352 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.
352 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.
353
353
354 ##### `KERNELSRC_CLEAN`=false
354 ##### `KERNELSRC_CLEAN`=false
355 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.
355 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.
356
356
357 ##### `KERNELSRC_CONFIG`=true
357 ##### `KERNELSRC_CONFIG`=true
358 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.
358 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.
359
359
360 ##### `KERNELSRC_USRCONFIG`=""
360 ##### `KERNELSRC_USRCONFIG`=""
361 Copy own config file to kernel `.config`. If `KERNEL_MENUCONFIG`=true then running after copy.
361 Copy own config file to kernel `.config`. If `KERNEL_MENUCONFIG`=true then running after copy.
362
362
363 ##### `KERNELSRC_PREBUILT`=false
363 ##### `KERNELSRC_PREBUILT`=false
364 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.
364 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.
365
365
366 ##### `RPI_FIRMWARE_DIR`=""
366 ##### `RPI_FIRMWARE_DIR`=""
367 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.
367 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.
368
368
369 ##### `KERNEL_DEFAULT_GOV`="ONDEMAND"
369 ##### `KERNEL_DEFAULT_GOV`="ONDEMAND"
370 Set the default cpu governor at kernel compilation. Supported values are: PERFORMANCE POWERSAVE USERSPACE ONDEMAND CONSERVATIVE SCHEDUTIL
370 Set the default cpu governor at kernel compilation. Supported values are: PERFORMANCE POWERSAVE USERSPACE ONDEMAND CONSERVATIVE SCHEDUTIL
371
371
372 ##### `KERNEL_NF`=false
372 ##### `KERNEL_NF`=false
373 Enable Netfilter modules as kernel modules
373 Enable Netfilter modules as kernel modules
374
374
375 ##### `KERNEL_VIRT`=false
375 ##### `KERNEL_VIRT`=false
376 Enable Kernel KVM support (/dev/kvm)
376 Enable Kernel KVM support (/dev/kvm)
377
377
378 ##### `KERNEL_ZSWAP`=false
378 ##### `KERNEL_ZSWAP`=false
379 Enable Kernel Zswap support. Best use on high RAM load and mediocre CPU load usecases
379 Enable Kernel Zswap support. Best use on high RAM load and mediocre CPU load usecases
380
380
381 ##### `KERNEL_BPF`=true
381 ##### `KERNEL_BPF`=true
382 Allow attaching eBPF programs to a cgroup using the bpf syscall (CONFIG_BPF_SYSCALL CONFIG_CGROUP_BPF) [systemd compilations about it - File /lib/systemd/system/systemd-journald.server:36 configures an IP firewall (IPAddressDeny=all), but the local system does not support BPF/cgroup based firewalls]
382 Allow attaching eBPF programs to a cgroup using the bpf syscall (CONFIG_BPF_SYSCALL CONFIG_CGROUP_BPF) [systemd compilations about it - File /lib/systemd/system/systemd-journald.server:36 configures an IP firewall (IPAddressDeny=all), but the local system does not support BPF/cgroup based firewalls]
383
383
384 ##### `KERNEL_SECURITY`=false
384 ##### `KERNEL_SECURITY`=false
385 Enables Apparmor, integrity subsystem, auditing
385 Enables Apparmor, integrity subsystem, auditing
386 ---
386 ---
387
387
388 #### Reduce disk usage:
388 #### Reduce disk usage:
389 The following list of parameters is ignored if `ENABLE_REDUCE`=false.
389 The following list of parameters is ignored if `ENABLE_REDUCE`=false.
390
390
391 ##### `REDUCE_APT`=true
391 ##### `REDUCE_APT`=true
392 Configure APT to use compressed package repository lists and no package caching files.
392 Configure APT to use compressed package repository lists and no package caching files.
393
393
394 ##### `REDUCE_DOC`=true
394 ##### `REDUCE_DOC`=true
395 Remove all doc files (harsh). Configure APT to not include doc files on future `apt-get` package installations.
395 Remove all doc files (harsh). Configure APT to not include doc files on future `apt-get` package installations.
396
396
397 ##### `REDUCE_MAN`=true
397 ##### `REDUCE_MAN`=true
398 Remove all man pages and info files (harsh). Configure APT to not include man pages on future `apt-get` package installations.
398 Remove all man pages and info files (harsh). Configure APT to not include man pages on future `apt-get` package installations.
399
399
400 ##### `REDUCE_VIM`=false
400 ##### `REDUCE_VIM`=false
401 Replace `vim-tiny` package by `levee` a tiny vim clone.
401 Replace `vim-tiny` package by `levee` a tiny vim clone.
402
402
403 ##### `REDUCE_BASH`=false
403 ##### `REDUCE_BASH`=false
404 Remove `bash` package and switch to `dash` shell (experimental).
404 Remove `bash` package and switch to `dash` shell (experimental).
405
405
406 ##### `REDUCE_HWDB`=true
406 ##### `REDUCE_HWDB`=true
407 Remove PCI related hwdb files (experimental).
407 Remove PCI related hwdb files (experimental).
408
408
409 ##### `REDUCE_SSHD`=true
409 ##### `REDUCE_SSHD`=true
410 Replace `openssh-server` with `dropbear`.
410 Replace `openssh-server` with `dropbear`.
411
411
412 ##### `REDUCE_LOCALE`=true
412 ##### `REDUCE_LOCALE`=true
413 Remove all `locale` translation files.
413 Remove all `locale` translation files.
414
414
415 ---
415 ---
416
416
417 #### Encrypted root partition:
417 #### Encrypted root partition:
418 ##### `ENABLE_CRYPTFS`=false
418 ##### `ENABLE_CRYPTFS`=false
419 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.
419 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.
420
420
421 ##### `CRYPTFS_PASSWORD`=""
421 ##### `CRYPTFS_PASSWORD`=""
422 Set password of the encrypted root partition. This parameter is mandatory if `ENABLE_CRYPTFS`=true.
422 Set password of the encrypted root partition. This parameter is mandatory if `ENABLE_CRYPTFS`=true.
423
423
424 ##### `CRYPTFS_MAPPING`="secure"
424 ##### `CRYPTFS_MAPPING`="secure"
425 Set name of dm-crypt managed device-mapper mapping.
425 Set name of dm-crypt managed device-mapper mapping.
426
426
427 ##### `CRYPTFS_CIPHER`="aes-xts-plain64:sha512"
427 ##### `CRYPTFS_CIPHER`="aes-xts-plain64:sha512"
428 Set cipher specification string. `aes-xts*` ciphers are strongly recommended.
428 Set cipher specification string. `aes-xts*` ciphers are strongly recommended.
429
429
430 ##### `CRYPTFS_XTSKEYSIZE`=512
430 ##### `CRYPTFS_XTSKEYSIZE`=512
431 Sets key size in bits. The argument has to be a multiple of 8.
431 Sets key size in bits. The argument has to be a multiple of 8.
432
432
433 ##### `CRYPTFS_DROPBEAR`=false
433 ##### `CRYPTFS_DROPBEAR`=false
434 Enable Dropbear Initramfs support
434 Enable Dropbear Initramfs support
435
435
436 ##### `CRYPTFS_DROPBEAR_PUBKEY`=""
436 ##### `CRYPTFS_DROPBEAR_PUBKEY`=""
437 Provide path to dropbear Public RSA-OpenSSH Key
437 Provide path to dropbear Public RSA-OpenSSH Key
438
438
439 ---
439 ---
440
440
441 #### Build settings:
441 #### Build settings:
442 ##### `BASEDIR`=$(pwd)/images/${RELEASE}
442 ##### `BASEDIR`=$(pwd)/images/${RELEASE}
443 Set a path to a working directory used by the script to generate an image.
443 Set a path to a working directory used by the script to generate an image.
444
444
445 ##### `IMAGE_NAME`=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}
445 ##### `IMAGE_NAME`=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}
446 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.
446 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.
447
447
448 ## Understanding the script
448 ## Understanding the script
449 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:
449 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:
450
450
451 | Script | Description |
451 | Script | Description |
452 | --- | --- |
452 | --- | --- |
453 | `10-bootstrap.sh` | Debootstrap basic system |
453 | `10-bootstrap.sh` | Debootstrap basic system |
454 | `11-apt.sh` | Setup APT repositories |
454 | `11-apt.sh` | Setup APT repositories |
455 | `12-locale.sh` | Setup Locales and keyboard settings |
455 | `12-locale.sh` | Setup Locales and keyboard settings |
456 | `13-kernel.sh` | Build and install RPi 0/1/2/3 Kernel |
456 | `13-kernel.sh` | Build and install RPi 0/1/2/3 Kernel |
457 | `14-fstab.sh` | Setup fstab and initramfs |
457 | `14-fstab.sh` | Setup fstab and initramfs |
458 | `15-rpi-config.sh` | Setup RPi 0/1/2/3 config and cmdline |
458 | `15-rpi-config.sh` | Setup RPi 0/1/2/3 config and cmdline |
459 | `20-networking.sh` | Setup Networking |
459 | `20-networking.sh` | Setup Networking |
460 | `21-firewall.sh` | Setup Firewall |
460 | `21-firewall.sh` | Setup Firewall |
461 | `30-security.sh` | Setup Users and Security settings |
461 | `30-security.sh` | Setup Users and Security settings |
462 | `31-logging.sh` | Setup Logging |
462 | `31-logging.sh` | Setup Logging |
463 | `32-sshd.sh` | Setup SSH and public keys |
463 | `32-sshd.sh` | Setup SSH and public keys |
464 | `41-uboot.sh` | Build and Setup U-Boot |
464 | `41-uboot.sh` | Build and Setup U-Boot |
465 | `42-fbturbo.sh` | Build and Setup fbturbo Xorg driver |
465 | `42-fbturbo.sh` | Build and Setup fbturbo Xorg driver |
466 | `43-videocore.sh` | Build and Setup videocore libraries |
466 | `43-videocore.sh` | Build and Setup videocore libraries |
467 | `50-firstboot.sh` | First boot actions |
467 | `50-firstboot.sh` | First boot actions |
468 | `99-reduce.sh` | Reduce the disk space usage |
468 | `99-reduce.sh` | Reduce the disk space usage |
469
469
470 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.
470 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.
471
471
472 | Directory | Description |
472 | Directory | Description |
473 | --- | --- |
473 | --- | --- |
474 | `apt` | APT management configuration files |
474 | `apt` | APT management configuration files |
475 | `boot` | Boot and RPi 0/1/2/3 configuration files |
475 | `boot` | Boot and RPi 0/1/2/3 configuration files |
476 | `dpkg` | Package Manager configuration |
476 | `dpkg` | Package Manager configuration |
477 | `etc` | Configuration files and rc scripts |
477 | `etc` | Configuration files and rc scripts |
478 | `firstboot` | Scripts that get executed on first boot |
478 | `firstboot` | Scripts that get executed on first boot |
479 | `initramfs` | Initramfs scripts |
479 | `initramfs` | Initramfs scripts |
480 | `iptables` | Firewall configuration files |
480 | `iptables` | Firewall configuration files |
481 | `locales` | Locales configuration |
481 | `locales` | Locales configuration |
482 | `modules` | Kernel Modules configuration |
482 | `modules` | Kernel Modules configuration |
483 | `mount` | Fstab configuration |
483 | `mount` | Fstab configuration |
484 | `network` | Networking configuration files |
484 | `network` | Networking configuration files |
485 | `sysctl.d` | Swapping and Network Hardening configuration |
485 | `sysctl.d` | Swapping and Network Hardening configuration |
486 | `xorg` | fbturbo Xorg driver configuration |
486 | `xorg` | fbturbo Xorg driver configuration |
487
487
488 ## Custom packages and scripts
488 ## Custom packages and scripts
489 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`.
489 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`.
490
490
491 Scripts in the custom.d directory will be executed after all other installation is complete but before the image is created.
491 Scripts in the custom.d directory will be executed after all other installation is complete but before the image is created.
492
492
493 ## Logging of the bootstrapping process
493 ## Logging of the bootstrapping process
494 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:
494 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:
495
495
496 ```shell
496 ```shell
497 script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log
497 script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log
498 ```
498 ```
499
499
500 ## Flashing the image file
500 ## Flashing the image file
501 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 RPi 0/1/2/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`.
501 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 RPi 0/1/2/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`.
502
502
503 ##### Flashing examples:
503 ##### Flashing examples:
504 ```shell
504 ```shell
505 bmaptool copy ./images/buster/2017-01-23-rpi3-buster.img /dev/mmcblk0
505 bmaptool copy ./images/buster/2017-01-23-rpi3-buster.img /dev/mmcblk0
506 dd bs=4M if=./images/buster/2017-01-23-rpi3-buster.img of=/dev/mmcblk0
506 dd bs=4M if=./images/buster/2017-01-23-rpi3-buster.img of=/dev/mmcblk0
507 ```
507 ```
508 If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:
508 If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:
509 ```shell
509 ```shell
510 bmaptool copy ./images/buster/2017-01-23-rpi3-buster-frmw.img /dev/mmcblk0
510 bmaptool copy ./images/buster/2017-01-23-rpi3-buster-frmw.img /dev/mmcblk0
511 bmaptool copy ./images/buster/2017-01-23-rpi3-buster-root.img /dev/sdc
511 bmaptool copy ./images/buster/2017-01-23-rpi3-buster-root.img /dev/sdc
512 ```
512 ```
513
513
514 ## QEMU emulation
514 ## QEMU emulation
515 Start QEMU full system emulation:
515 Start QEMU full system emulation:
516 ```shell
516 ```shell
517 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"
517 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"
518 ```
518 ```
519
519
520 Start QEMU full system emulation and output to console:
520 Start QEMU full system emulation and output to console:
521 ```shell
521 ```shell
522 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
522 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
523 ```
523 ```
524
524
525 Start QEMU full system emulation with SMP and output to console:
525 Start QEMU full system emulation with SMP and output to console:
526 ```shell
526 ```shell
527 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
527 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
528 ```
528 ```
529
529
530 Start QEMU full system emulation with cryptfs, initramfs and output to console:
530 Start QEMU full system emulation with cryptfs, initramfs and output to console:
531 ```shell
531 ```shell
532 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
532 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
533 ```
533 ```
534
534
535 ## External links and references
535 ## External links and references
536 * [Debian worldwide mirror sites](https://www.debian.org/mirror/list)
536 * [Debian worldwide mirror sites](https://www.debian.org/mirror/list)
537 * [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)
537 * [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)
538 * [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains)
538 * [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains)
539 * [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)
539 * [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)
540 * [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)
540 * [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)
541 * [U-BOOT git repository](https://git.denx.de/?p=u-boot.git;a=summary)
541 * [U-BOOT git repository](https://git.denx.de/?p=u-boot.git;a=summary)
542 * [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)
542 * [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)
543 * [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/brcm)
543 * [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm)
544 * [Collabora RPi2 Kernel precompiled](https://repositories.collabora.co.uk/debian/)
544 * [Collabora RPi2 Kernel precompiled](https://repositories.collabora.co.uk/debian/)
General Comments 0
Vous devez vous connecter pour laisser un commentaire. Se connecter maintenant