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

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

Fix: typos
drtyhlpr -
r468:9c894e71047f
parent child
Show More
Show file before | Show file after | Hide comments
@@ -1,501 +1,500
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 ##### `APT_INCLUDES`=""
51 ##### `APT_INCLUDES`=""
52 A comma separated list of additional packages to be installed by debootstrap during bootstrapping.
52 A comma-separated list of additional packages to be installed by debootstrap during bootstrapping.
53
53
54 ##### `APT_INCLUDES_LATE`=""
54 ##### `APT_INCLUDES_LATE`=""
55 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.
55 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.
56
56
57 ---
57 ---
58
58
59 #### General system settings:
59 #### General system settings:
60 ##### `SET_ARCH`=32
60 ##### `SET_ARCH`=32
61 Set Architecture to default 32bit. If you want to to compile 64bit (RPI3 or RPI3+) set it to `64`. This option will set every needed crosscompiler or boeard specific option for a successful build.
61 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.
62
62
63 ##### `RPI_MODEL`=2
63 ##### `RPI_MODEL`=2
64 Specifiy the target Raspberry Pi hardware model. The script at this time supports the following Raspberry Pi models:
64 Specify the target Raspberry Pi hardware model. The script at this time supports the following Raspberry Pi models:
65 - `0` = Used for Raspberry Pi 0 and Raspberry Pi 0 W
65 - `0` = Raspberry Pi 0 and Raspberry Pi 0 W
66 - `1` = Used for Pi 1 model A and B
66 - `1` = Raspberry Pi 1 model A and B
67 - `1P` = Used for Pi 1 model B+ and A+
67 - `1P` = Raspberry Pi 1 model B+ and A+
68 - `2` = Used for Pi 2 model B
68 - `2` = Raspberry Pi 2 model B
69 - `3` = Used for Pi 3 model B
69 - `3` = Raspberry Pi 3 model B
70 - `3P` = Used for Pi 3 model B+
70 - `3P` = Raspberry Pi 3 model B+
71 - `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` or `3P` is used.
72
71
73 ##### `RELEASE`="buster"
72 ##### `RELEASE`="buster"
74 Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases `stretch` and `buster`.
73 Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases `stretch` and `buster`.
75
74
76 ##### `RELEASE_ARCH`="armhf"
75 ##### `RELEASE_ARCH`="armhf"
77 Set the desired Debian release architecture.
76 Set the desired Debian release architecture.
78
77
79 ##### `HOSTNAME`="rpi$RPI_MODEL-$RELEASE"
78 ##### `HOSTNAME`="rpi$RPI_MODEL-$RELEASE"
80 Set system host name. It's recommended that the host name is unique in the corresponding subnet.
79 Set system hostname. It's recommended that the hostname is unique in the corresponding subnet.
81
80
82 ##### `PASSWORD`="raspberry"
81 ##### `PASSWORD`="raspberry"
83 Set system `root` password. It's **STRONGLY** recommended that you choose a custom password.
82 Set system `root` password. It's **STRONGLY** recommended that you choose a custom password.
84
83
85 ##### `USER_PASSWORD`="raspberry"
84 ##### `USER_PASSWORD`="raspberry"
86 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.
85 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.
87
86
88 ##### `DEFLOCAL`="en_US.UTF-8"
87 ##### `DEFLOCAL`="en_US.UTF-8"
89 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`.
88 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`.
90
89
91 ##### `TIMEZONE`="Europe/Berlin"
90 ##### `TIMEZONE`="Europe/Berlin"
92 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.
91 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.
93
92
94 ##### `EXPANDROOT`=true
93 ##### `EXPANDROOT`=true
95 Expand the root partition and filesystem automatically on first boot.
94 Expand the root partition and filesystem automatically on first boot.
96
95
97 ##### `ENABLE_QEMU`=false
96 ##### `ENABLE_QEMU`=false
98 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.
97 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.
99
98
100 ---
99 ---
101
100
102 #### Keyboard settings:
101 #### Keyboard settings:
103 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.
102 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.
104
103
105 ##### `XKB_MODEL`=""
104 ##### `XKB_MODEL`=""
106 Set the name of the model of your keyboard type.
105 Set the name of the model of your keyboard type.
107
106
108 ##### `XKB_LAYOUT`=""
107 ##### `XKB_LAYOUT`=""
109 Set the supported keyboard layout(s).
108 Set the supported keyboard layout(s).
110
109
111 ##### `XKB_VARIANT`=""
110 ##### `XKB_VARIANT`=""
112 Set the supported variant(s) of the keyboard layout(s).
111 Set the supported variant(s) of the keyboard layout(s).
113
112
114 ##### `XKB_OPTIONS`=""
113 ##### `XKB_OPTIONS`=""
115 Set extra xkb configuration options.
114 Set extra xkb configuration options.
116
115
117 ---
116 ---
118
117
119 #### Networking settings (DHCP):
118 #### Networking settings (DHCP):
120 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`.`
119 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`.`
121
120
122 ##### `ENABLE_DHCP`=true
121 ##### `ENABLE_DHCP`=true
123 Set the system to use DHCP. This requires an DHCP server.
122 Set the system to use DHCP. This requires an DHCP server.
124
123
125 ---
124 ---
126
125
127 #### Networking settings (static):
126 #### Networking settings (static):
128 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`.
127 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`.
129
128
130 ##### `NET_ADDRESS`=""
129 ##### `NET_ADDRESS`=""
131 Set a static IPv4 or IPv6 address and its prefix, separated by "/", eg. "192.169.0.3/24".
130 Set a static IPv4 or IPv6 address and its prefix, separated by "/", eg. "192.169.0.3/24".
132
131
133 ##### `NET_GATEWAY`=""
132 ##### `NET_GATEWAY`=""
134 Set the IP address for the default gateway.
133 Set the IP address for the default gateway.
135
134
136 ##### `NET_DNS_1`=""
135 ##### `NET_DNS_1`=""
137 Set the IP address for the first DNS server.
136 Set the IP address for the first DNS server.
138
137
139 ##### `NET_DNS_2`=""
138 ##### `NET_DNS_2`=""
140 Set the IP address for the second DNS server.
139 Set the IP address for the second DNS server.
141
140
142 ##### `NET_DNS_DOMAINS`=""
141 ##### `NET_DNS_DOMAINS`=""
143 Set the default DNS search domains to use for non fully qualified host names.
142 Set the default DNS search domains to use for non fully qualified hostnames.
144
143
145 ##### `NET_NTP_1`=""
144 ##### `NET_NTP_1`=""
146 Set the IP address for the first NTP server.
145 Set the IP address for the first NTP server.
147
146
148 ##### `NET_NTP_2`=""
147 ##### `NET_NTP_2`=""
149 Set the IP address for the second NTP server.
148 Set the IP address for the second NTP server.
150
149
151 ---
150 ---
152
151
153 #### Basic system features:
152 #### Basic system features:
154 ##### `ENABLE_CONSOLE`=true
153 ##### `ENABLE_CONSOLE`=true
155 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.
154 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.
156
155
157 ##### `ENABLE_PRINTK`=false
156 ##### `ENABLE_PRINTK`=false
158 Enables printing kernel messages to konsole. printk is `3 4 1 3` as in raspbian.
157 Enables printing kernel messages to konsole. printk is `3 4 1 3` as in raspbian.
159
158
160 ##### `ENABLE_BLUETOOTH`=false
159 ##### `ENABLE_BLUETOOTH`=false
161 Enable onboard Bluetooth interface on the RPi0/3/3P. See: https://spellfoundry.com/2016/05/29/configuring-gpio-serial-port-raspbian-jessie-including-pi-3/
160 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/).
162
161
163 ##### `ENABLE_MINIUART_OVERLAY`=false
162 ##### `ENABLE_MINIUART_OVERLAY`=false
164 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.
163 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.
165
164
166 ##### `ENABLE_TURBO`=false
165 ##### `ENABLE_TURBO`=false
167 Enable Turbo mode. This setting locks cpu at 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.
166 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.
168
167
169 ##### `ENABLE_I2C`=false
168 ##### `ENABLE_I2C`=false
170 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.
169 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.
171
170
172 ##### `ENABLE_SPI`=false
171 ##### `ENABLE_SPI`=false
173 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.
172 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.
174
173
175 ##### `ENABLE_IPV6`=true
174 ##### `ENABLE_IPV6`=true
176 Enable IPv6 support. The network interface configuration is managed via systemd-networkd.
175 Enable IPv6 support. The network interface configuration is managed via systemd-networkd.
177
176
178 ##### `ENABLE_SSHD`=true
177 ##### `ENABLE_SSHD`=true
179 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.
178 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.
180
179
181 ##### `ENABLE_NONFREE`=false
180 ##### `ENABLE_NONFREE`=false
182 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.
181 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.
183
182
184 ##### `ENABLE_WIRELESS`=false
183 ##### `ENABLE_WIRELESS`=false
185 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`.
184 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`.
186
185
187 ##### `ENABLE_RSYSLOG`=true
186 ##### `ENABLE_RSYSLOG`=true
188 If set to false, disable and uninstall rsyslog (so logs will be available only in journal files)
187 If set to false, disable and uninstall rsyslog (so logs will be available only in journal files)
189
188
190 ##### `ENABLE_SOUND`=true
189 ##### `ENABLE_SOUND`=true
191 Enable sound hardware and install Advanced Linux Sound Architecture.
190 Enable sound hardware and install Advanced Linux Sound Architecture.
192
191
193 ##### `ENABLE_HWRANDOM`=true
192 ##### `ENABLE_HWRANDOM`=true
194 Enable Hardware Random Number Generator. Strong random numbers are important for most network based communications that use encryption. It's recommended to be enabled.
193 Enable Hardware Random Number Generator. Strong random numbers are important for most network-based communications that use encryption. It's recommended to be enabled.
195
194
196 ##### `ENABLE_MINGPU`=false
195 ##### `ENABLE_MINGPU`=false
197 Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU.
196 Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU.
198
197
199 ##### `ENABLE_DBUS`=true
198 ##### `ENABLE_DBUS`=true
200 Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled.
199 Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled.
201
200
202 ##### `ENABLE_XORG`=false
201 ##### `ENABLE_XORG`=false
203 Install Xorg open-source X Window System.
202 Install Xorg open-source X Window System.
204
203
205 ##### `ENABLE_WM`=""
204 ##### `ENABLE_WM`=""
206 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`.
205 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`.
207
206
208 ##### `ENABLE_SYSVINIT`=false
207 ##### `ENABLE_SYSVINIT`=false
209 Support for halt,init,poweroff,reboot,runlevel,shutdown,telinit commands
208 Support for halt,init,poweroff,reboot,runlevel,shutdown,telinit commands
210
209
211 ---
210 ---
212
211
213 #### Advanced system features:
212 #### Advanced system features:
214 ##### `ENABLE_MINBASE`=false
213 ##### `ENABLE_MINBASE`=false
215 Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
214 Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
216
215
217 ##### `ENABLE_REDUCE`=false
216 ##### `ENABLE_REDUCE`=false
218 Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.
217 Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.
219
218
220 ##### `ENABLE_UBOOT`=false
219 ##### `ENABLE_UBOOT`=false
221 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.
220 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.
222
221
223 ##### `UBOOTSRC_DIR`=""
222 ##### `UBOOTSRC_DIR`=""
224 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.
223 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.
225
224
226 ##### `ENABLE_FBTURBO`=false
225 ##### `ENABLE_FBTURBO`=false
227 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.
226 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.
228
227
229 ##### `FBTURBOSRC_DIR`=""
228 ##### `FBTURBOSRC_DIR`=""
230 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.
229 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.
231
230
232 ##### `ENABLE_VIDEOCORE`=false
231 ##### `ENABLE_VIDEOCORE`=false
233 Install and enable the [Source code for 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.
232 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.
234
233
235 ##### `VIDEOCORESRC_DIR`=""
234 ##### `VIDEOCORESRC_DIR`=""
236 Path to a directory (`userland`) 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.
235 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.
237
236
238 ##### `ENABLE_IPTABLES`=false
237 ##### `ENABLE_IPTABLES`=false
239 Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.
238 Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.
240
239
241 ##### `ENABLE_USER`=true
240 ##### `ENABLE_USER`=true
242 Create non-root user with password `USER_PASSWORD`=raspberry. Unless overridden with `USER_NAME`=user, username will be `pi`.
241 Create non-root user with password `USER_PASSWORD`=raspberry. Unless overridden with `USER_NAME`=user, the username will be `pi`.
243
242
244 ##### `USER_NAME`=pi
243 ##### `USER_NAME`=pi
245 Non-root user to create. Ignored if `ENABLE_USER`=false
244 Non-root user to create. Ignored if `ENABLE_USER`=false
246
245
247 ##### `ENABLE_ROOT`=false
246 ##### `ENABLE_ROOT`=false
248 Set root user password so root login will be enabled
247 Set root user password so root login will be enabled
249
248
250 ##### `ENABLE_HARDNET`=false
249 ##### `ENABLE_HARDNET`=false
251 Enable IPv4/IPv6 network stack hardening settings.
250 Enable IPv4/IPv6 network stack hardening settings.
252
251
253 ##### `ENABLE_SPLITFS`=false
252 ##### `ENABLE_SPLITFS`=false
254 Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.
253 Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.
255
254
256 ##### `CHROOT_SCRIPTS`=""
255 ##### `CHROOT_SCRIPTS`=""
257 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.
256 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.
258
257
259 ##### `ENABLE_INITRAMFS`=false
258 ##### `ENABLE_INITRAMFS`=false
260 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.
259 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.
261
260
262 ##### `ENABLE_IFNAMES`=true
261 ##### `ENABLE_IFNAMES`=true
263 Enable automatic assignment of predictable, stable network interface names for all local Ethernet, WLAN interfaces. This might create complex and long interface names.
262 Enable automatic assignment of predictable, stable network interface names for all local Ethernet, WLAN interfaces. This might create complex and long interface names.
264
263
265 ##### `DISABLE_UNDERVOLT_WARNINGS`=
264 ##### `DISABLE_UNDERVOLT_WARNINGS`=
266 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.
265 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.
267
266
268 ---
267 ---
269
268
270 #### SSH settings:
269 #### SSH settings:
271 ##### `SSH_ENABLE_ROOT`=false
270 ##### `SSH_ENABLE_ROOT`=false
272 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`.
271 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`.
273
272
274 ##### `SSH_DISABLE_PASSWORD_AUTH`=false
273 ##### `SSH_DISABLE_PASSWORD_AUTH`=false
275 Disable password based SSH authentication. Only public key based SSH (v2) authentication will be supported.
274 Disable password-based SSH authentication. Only public key based SSH (v2) authentication will be supported.
276
275
277 ##### `SSH_LIMIT_USERS`=false
276 ##### `SSH_LIMIT_USERS`=false
278 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).
277 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).
279
278
280 ##### `SSH_ROOT_PUB_KEY`=""
279 ##### `SSH_ROOT_PUB_KEY`=""
281 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`.
280 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`.
282
281
283 ##### `SSH_USER_PUB_KEY`=""
282 ##### `SSH_USER_PUB_KEY`=""
284 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.
283 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.
285
284
286 ---
285 ---
287
286
288 #### Kernel compilation:
287 #### Kernel compilation:
289 ##### `BUILD_KERNEL`=true
288 ##### `BUILD_KERNEL`=true
290 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.
289 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.
291
290
292 ##### `CROSS_COMPILE`="arm-linux-gnueabihf-"
291 ##### `CROSS_COMPILE`="arm-linux-gnueabihf-"
293 This sets the cross compile enviornment for the compiler.
292 This sets the cross-compile environment for the compiler.
294
293
295 ##### `KERNEL_ARCH`="arm"
294 ##### `KERNEL_ARCH`="arm"
296 This sets the kernel architecture for the compiler.
295 This sets the kernel architecture for the compiler.
297
296
298 ##### `KERNEL_IMAGE`="kernel7.img"
297 ##### `KERNEL_IMAGE`="kernel7.img"
299 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.
298 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.
300
299
301 ##### `KERNEL_BRANCH`=""
300 ##### `KERNEL_BRANCH`=""
302 Name of the requested branch from the GIT location for the RPi Kernel. Default is using the current default branch from the GIT site.
301 Name of the requested branch from the GIT location for the RPi Kernel. Default is using the current default branch from the GIT site.
303
302
304 ##### `QEMU_BINARY`="/usr/bin/qemu-arm-static"
303 ##### `QEMU_BINARY`="/usr/bin/qemu-arm-static"
305 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.
304 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.
306
305
307 ##### `KERNEL_DEFCONFIG`="bcm2709_defconfig"
306 ##### `KERNEL_DEFCONFIG`="bcm2709_defconfig"
308 Sets the default config for kernel compiling. If not set, `KERNEL_DEFCONFIG` will be set to "bcmrpi3\_defconfig" automatically if building for arm64.
307 Sets the default config for kernel compiling. If not set, `KERNEL_DEFCONFIG` will be set to "bcmrpi3\_defconfig" automatically if building for arm64.
309
308
310 ##### `KERNEL_REDUCE`=false
309 ##### `KERNEL_REDUCE`=false
311 Reduce the size of the generated kernel by removing unwanted device, network and filesystem drivers (experimental).
310 Reduce the size of the generated kernel by removing unwanted devices, network and filesystem drivers (experimental).
312
311
313 ##### `KERNEL_THREADS`=1
312 ##### `KERNEL_THREADS`=1
314 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.
313 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.
315
314
316 ##### `KERNEL_HEADERS`=true
315 ##### `KERNEL_HEADERS`=true
317 Install kernel headers with built kernel.
316 Install kernel headers with the built kernel.
318
317
319 ##### `KERNEL_MENUCONFIG`=false
318 ##### `KERNEL_MENUCONFIG`=false
320 Start `make menuconfig` interactive menu-driven kernel configuration. The script will continue after `make menuconfig` was terminated.
319 Start `make menuconfig` interactive menu-driven kernel configuration. The script will continue after `make menuconfig` was terminated.
321
320
322 ##### `KERNEL_OLDDEFCONFIG`=false
321 ##### `KERNEL_OLDDEFCONFIG`=false
323 Run `make olddefconfig` to automatically set all new kernel configuration options to their recommended default values.
322 Run `make olddefconfig` to automatically set all new kernel configuration options to their recommended default values.
324
323
325 ##### `KERNEL_CCACHE`=false
324 ##### `KERNEL_CCACHE`=false
326 Compile the kernel using ccache. This speeds up kernel recompilation by caching previous compilations and detecting when the same compilation is being done again.
325 Compile the kernel using ccache. This speeds up kernel recompilation by caching previous compilations and detecting when the same compilation is being done again.
327
326
328 ##### `KERNEL_REMOVESRC`=true
327 ##### `KERNEL_REMOVESRC`=true
329 Remove all kernel sources from the generated OS image after it was built and installed.
328 Remove all kernel sources from the generated OS image after it was built and installed.
330
329
331 ##### `KERNELSRC_DIR`=""
330 ##### `KERNELSRC_DIR`=""
332 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.
331 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.
333
332
334 ##### `KERNELSRC_CLEAN`=false
333 ##### `KERNELSRC_CLEAN`=false
335 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.
334 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.
336
335
337 ##### `KERNELSRC_CONFIG`=true
336 ##### `KERNELSRC_CONFIG`=true
338 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.
337 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.
339
338
340 ##### `KERNELSRC_USRCONFIG`=""
339 ##### `KERNELSRC_USRCONFIG`=""
341 Copy own config file to kernel `.config`. If `KERNEL_MENUCONFIG`=true then running after copy.
340 Copy own config file to kernel `.config`. If `KERNEL_MENUCONFIG`=true then running after copy.
342
341
343 ##### `KERNELSRC_PREBUILT`=false
342 ##### `KERNELSRC_PREBUILT`=false
344 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.
343 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.
345
344
346 ##### `RPI_FIRMWARE_DIR`=""
345 ##### `RPI_FIRMWARE_DIR`=""
347 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.
346 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.
348
347
349 ---
348 ---
350
349
351 #### Reduce disk usage:
350 #### Reduce disk usage:
352 The following list of parameters is ignored if `ENABLE_REDUCE`=false.
351 The following list of parameters is ignored if `ENABLE_REDUCE`=false.
353
352
354 ##### `REDUCE_APT`=true
353 ##### `REDUCE_APT`=true
355 Configure APT to use compressed package repository lists and no package caching files.
354 Configure APT to use compressed package repository lists and no package caching files.
356
355
357 ##### `REDUCE_DOC`=true
356 ##### `REDUCE_DOC`=true
358 Remove all doc files (harsh). Configure APT to not include doc files on future `apt-get` package installations.
357 Remove all doc files (harsh). Configure APT to not include doc files on future `apt-get` package installations.
359
358
360 ##### `REDUCE_MAN`=true
359 ##### `REDUCE_MAN`=true
361 Remove all man pages and info files (harsh). Configure APT to not include man pages on future `apt-get` package installations.
360 Remove all man pages and info files (harsh). Configure APT to not include man pages on future `apt-get` package installations.
362
361
363 ##### `REDUCE_VIM`=false
362 ##### `REDUCE_VIM`=false
364 Replace `vim-tiny` package by `levee` a tiny vim clone.
363 Replace `vim-tiny` package by `levee` a tiny vim clone.
365
364
366 ##### `REDUCE_BASH`=false
365 ##### `REDUCE_BASH`=false
367 Remove `bash` package and switch to `dash` shell (experimental).
366 Remove `bash` package and switch to `dash` shell (experimental).
368
367
369 ##### `REDUCE_HWDB`=true
368 ##### `REDUCE_HWDB`=true
370 Remove PCI related hwdb files (experimental).
369 Remove PCI related hwdb files (experimental).
371
370
372 ##### `REDUCE_SSHD`=true
371 ##### `REDUCE_SSHD`=true
373 Replace `openssh-server` with `dropbear`.
372 Replace `openssh-server` with `dropbear`.
374
373
375 ##### `REDUCE_LOCALE`=true
374 ##### `REDUCE_LOCALE`=true
376 Remove all `locale` translation files.
375 Remove all `locale` translation files.
377
376
378 ---
377 ---
379
378
380 #### Encrypted root partition:
379 #### Encrypted root partition:
381 ##### `ENABLE_CRYPTFS`=false
380 ##### `ENABLE_CRYPTFS`=false
382 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.
381 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.
383
382
384 ##### `CRYPTFS_PASSWORD`=""
383 ##### `CRYPTFS_PASSWORD`=""
385 Set password of the encrypted root partition. This parameter is mandatory if `ENABLE_CRYPTFS`=true.
384 Set password of the encrypted root partition. This parameter is mandatory if `ENABLE_CRYPTFS`=true.
386
385
387 ##### `CRYPTFS_MAPPING`="secure"
386 ##### `CRYPTFS_MAPPING`="secure"
388 Set name of dm-crypt managed device-mapper mapping.
387 Set name of dm-crypt managed device-mapper mapping.
389
388
390 ##### `CRYPTFS_CIPHER`="aes-xts-plain64:sha512"
389 ##### `CRYPTFS_CIPHER`="aes-xts-plain64:sha512"
391 Set cipher specification string. `aes-xts*` ciphers are strongly recommended.
390 Set cipher specification string. `aes-xts*` ciphers are strongly recommended.
392
391
393 ##### `CRYPTFS_XTSKEYSIZE`=512
392 ##### `CRYPTFS_XTSKEYSIZE`=512
394 Sets key size in bits. The argument has to be a multiple of 8.
393 Sets key size in bits. The argument has to be a multiple of 8.
395
394
396 ---
395 ---
397
396
398 #### Build settings:
397 #### Build settings:
399 ##### `BASEDIR`=$(pwd)/images/${RELEASE}
398 ##### `BASEDIR`=$(pwd)/images/${RELEASE}
400 Set a path to a working directory used by the script to generate an image.
399 Set a path to a working directory used by the script to generate an image.
401
400
402 ##### `IMAGE_NAME`=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}
401 ##### `IMAGE_NAME`=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}
403 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.
402 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.
404
403
405 ## Understanding the script
404 ## Understanding the script
406 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:
405 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:
407
406
408 | Script | Description |
407 | Script | Description |
409 | --- | --- |
408 | --- | --- |
410 | `10-bootstrap.sh` | Debootstrap basic system |
409 | `10-bootstrap.sh` | Debootstrap basic system |
411 | `11-apt.sh` | Setup APT repositories |
410 | `11-apt.sh` | Setup APT repositories |
412 | `12-locale.sh` | Setup Locales and keyboard settings |
411 | `12-locale.sh` | Setup Locales and keyboard settings |
413 | `13-kernel.sh` | Build and install RPi 0/1/2/3 Kernel |
412 | `13-kernel.sh` | Build and install RPi 0/1/2/3 Kernel |
414 | `14-fstab.sh` | Setup fstab and initramfs |
413 | `14-fstab.sh` | Setup fstab and initramfs |
415 | `15-rpi-config.sh` | Setup RPi 0/1/2/3 config and cmdline |
414 | `15-rpi-config.sh` | Setup RPi 0/1/2/3 config and cmdline |
416 | `20-networking.sh` | Setup Networking |
415 | `20-networking.sh` | Setup Networking |
417 | `21-firewall.sh` | Setup Firewall |
416 | `21-firewall.sh` | Setup Firewall |
418 | `30-security.sh` | Setup Users and Security settings |
417 | `30-security.sh` | Setup Users and Security settings |
419 | `31-logging.sh` | Setup Logging |
418 | `31-logging.sh` | Setup Logging |
420 | `32-sshd.sh` | Setup SSH and public keys |
419 | `32-sshd.sh` | Setup SSH and public keys |
421 | `41-uboot.sh` | Build and Setup U-Boot |
420 | `41-uboot.sh` | Build and Setup U-Boot |
422 | `42-fbturbo.sh` | Build and Setup fbturbo Xorg driver |
421 | `42-fbturbo.sh` | Build and Setup fbturbo Xorg driver |
423 | `43-videocore.sh` | Build and Setup videocore libraries |
422 | `43-videocore.sh` | Build and Setup videocore libraries |
424 | `50-firstboot.sh` | First boot actions |
423 | `50-firstboot.sh` | First boot actions |
425 | `99-reduce.sh` | Reduce the disk space usage |
424 | `99-reduce.sh` | Reduce the disk space usage |
426
425
427 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.
426 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.
428
427
429 | Directory | Description |
428 | Directory | Description |
430 | --- | --- |
429 | --- | --- |
431 | `apt` | APT management configuration files |
430 | `apt` | APT management configuration files |
432 | `boot` | Boot and RPi 0/1/2/3 configuration files |
431 | `boot` | Boot and RPi 0/1/2/3 configuration files |
433 | `dpkg` | Package Manager configuration |
432 | `dpkg` | Package Manager configuration |
434 | `etc` | Configuration files and rc scripts |
433 | `etc` | Configuration files and rc scripts |
435 | `firstboot` | Scripts that get executed on first boot |
434 | `firstboot` | Scripts that get executed on first boot |
436 | `initramfs` | Initramfs scripts |
435 | `initramfs` | Initramfs scripts |
437 | `iptables` | Firewall configuration files |
436 | `iptables` | Firewall configuration files |
438 | `locales` | Locales configuration |
437 | `locales` | Locales configuration |
439 | `modules` | Kernel Modules configuration |
438 | `modules` | Kernel Modules configuration |
440 | `mount` | Fstab configuration |
439 | `mount` | Fstab configuration |
441 | `network` | Networking configuration files |
440 | `network` | Networking configuration files |
442 | `sysctl.d` | Swapping and Network Hardening configuration |
441 | `sysctl.d` | Swapping and Network Hardening configuration |
443 | `xorg` | fbturbo Xorg driver configuration |
442 | `xorg` | fbturbo Xorg driver configuration |
444
443
445 ## Custom packages and scripts
444 ## Custom packages and scripts
446 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`.
445 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`.
447
446
448 Scripts in the custom.d directory will be executed after all other installation is complete but before the image is created.
447 Scripts in the custom.d directory will be executed after all other installation is complete but before the image is created.
449
448
450 ## Logging of the bootstrapping process
449 ## Logging of the bootstrapping process
451 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:
450 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:
452
451
453 ```shell
452 ```shell
454 script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log
453 script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log
455 ```
454 ```
456
455
457 ## Flashing the image file
456 ## Flashing the image file
458 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`.
457 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`.
459
458
460 ##### Flashing examples:
459 ##### Flashing examples:
461 ```shell
460 ```shell
462 bmaptool copy ./images/buster/2017-01-23-rpi3-buster.img /dev/mmcblk0
461 bmaptool copy ./images/buster/2017-01-23-rpi3-buster.img /dev/mmcblk0
463 dd bs=4M if=./images/buster/2017-01-23-rpi3-buster.img of=/dev/mmcblk0
462 dd bs=4M if=./images/buster/2017-01-23-rpi3-buster.img of=/dev/mmcblk0
464 ```
463 ```
465 If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:
464 If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:
466 ```shell
465 ```shell
467 bmaptool copy ./images/buster/2017-01-23-rpi3-buster-frmw.img /dev/mmcblk0
466 bmaptool copy ./images/buster/2017-01-23-rpi3-buster-frmw.img /dev/mmcblk0
468 bmaptool copy ./images/buster/2017-01-23-rpi3-buster-root.img /dev/sdc
467 bmaptool copy ./images/buster/2017-01-23-rpi3-buster-root.img /dev/sdc
469 ```
468 ```
470
469
471 ## QEMU emulation
470 ## QEMU emulation
472 Start QEMU full system emulation:
471 Start QEMU full system emulation:
473 ```shell
472 ```shell
474 qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=tty1"
473 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"
475 ```
474 ```
476
475
477 Start QEMU full system emulation and output to console:
476 Start QEMU full system emulation and output to console:
478 ```shell
477 ```shell
479 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
478 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
480 ```
479 ```
481
480
482 Start QEMU full system emulation with SMP and output to console:
481 Start QEMU full system emulation with SMP and output to console:
483 ```shell
482 ```shell
484 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
483 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
485 ```
484 ```
486
485
487 Start QEMU full system emulation with cryptfs, initramfs and output to console:
486 Start QEMU full system emulation with cryptfs, initramfs and output to console:
488 ```shell
487 ```shell
489 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
488 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
490 ```
489 ```
491
490
492 ## External links and references
491 ## External links and references
493 * [Debian worldwide mirror sites](https://www.debian.org/mirror/list)
492 * [Debian worldwide mirror sites](https://www.debian.org/mirror/list)
494 * [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)
493 * [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)
495 * [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains)
494 * [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains)
496 * [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)
495 * [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)
497 * [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)
496 * [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)
498 * [U-BOOT git repository](https://git.denx.de/?p=u-boot.git;a=summary)
497 * [U-BOOT git repository](https://git.denx.de/?p=u-boot.git;a=summary)
499 * [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)
498 * [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)
500 * [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/brcm)
499 * [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/brcm)
501 * [Collabora RPi2 Kernel precompiled](https://repositories.collabora.co.uk/debian/)
500 * [Collabora RPi2 Kernel precompiled](https://repositories.collabora.co.uk/debian/)
General Comments 0
Vous devez vous connecter pour laisser un commentaire. Se connecter maintenant