##// END OF EJS Templates
Updated: Beautified readme
drtyhlpr -
r134:57431b8f4a60
parent child
Show More
@@ -60,6 +60,8 Set Proxy server address. Using a local Proxy-Cache like `apt-cacher-ng` will sp
60 ##### `APT_INCLUDES`=""
60 ##### `APT_INCLUDES`=""
61 A comma separated list of additional packages to be installed during bootstrapping.
61 A comma separated list of additional packages to be installed during bootstrapping.
62
62
63 ---
64
63 #### General system settings:
65 #### General system settings:
64 ##### `RPI_MODEL`=2
66 ##### `RPI_MODEL`=2
65 Specifiy the target Raspberry Pi hardware model. The script at this time supports the Raspberry Pi models `2` and `3`. `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` is used.
67 Specifiy the target Raspberry Pi hardware model. The script at this time supports the Raspberry Pi models `2` and `3`. `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` is used.
@@ -85,6 +87,8 Set default system timezone. All available timezones can be found in the `/usr/s
85 ##### `EXPANDROOT`=true
87 ##### `EXPANDROOT`=true
86 Expand the root partition and filesystem automatically on first boot.
88 Expand the root partition and filesystem automatically on first boot.
87
89
90 ---
91
88 #### Keyboard settings:
92 #### Keyboard settings:
89 These options are used to configure keyboard layout in `/etc/default/keyboard` for console and Xorg. These settings can also be changed inside the running OS using the `dpkg-reconfigure keyboard-configuration` command.
93 These options are used to configure keyboard layout in `/etc/default/keyboard` for console and Xorg. These settings can also be changed inside the running OS using the `dpkg-reconfigure keyboard-configuration` command.
90
94
@@ -100,12 +104,16 Set the supported variant(s) of the keyboard layout(s).
100 ##### `XKB_OPTIONS`=""
104 ##### `XKB_OPTIONS`=""
101 Set extra xkb configuration options.
105 Set extra xkb configuration options.
102
106
107 ---
108
103 #### Networking settings (DHCP):
109 #### Networking settings (DHCP):
104 This parameter is used to set up networking auto configuration in `/etc/systemd/network/eth.network`. The default location of network configuration files in the Debian `stretch` release was changed to `/lib/systemd/network`.`
110 This parameter is used to set up networking auto configuration in `/etc/systemd/network/eth.network`. The default location of network configuration files in the Debian `stretch` release was changed to `/lib/systemd/network`.`
105
111
106 #####`ENABLE_DHCP`=true
112 #####`ENABLE_DHCP`=true
107 Set the system to use DHCP. This requires an DHCP server.
113 Set the system to use DHCP. This requires an DHCP server.
108
114
115 ---
116
109 #### Networking settings (static):
117 #### Networking settings (static):
110 These parameters are used to set up a static networking configuration in `/etc/systemd/network/eth.network`. The following static networking parameters are only supported if `ENABLE_DHCP` was set to `false`. The default location of network configuration files in the Debian `stretch` release was changed to `/lib/systemd/network`.
118 These parameters are used to set up a static networking configuration in `/etc/systemd/network/eth.network`. The following static networking parameters are only supported if `ENABLE_DHCP` was set to `false`. The default location of network configuration files in the Debian `stretch` release was changed to `/lib/systemd/network`.
111
119
@@ -130,6 +138,8 Set the IP address for the first NTP server.
130 #####`NET_NTP_2`=""
138 #####`NET_NTP_2`=""
131 Set the IP address for the second NTP server.
139 Set the IP address for the second NTP server.
132
140
141 ---
142
133 #### Basic system features:
143 #### Basic system features:
134 ##### `ENABLE_CONSOLE`=true
144 ##### `ENABLE_CONSOLE`=true
135 Enable serial console interface. Recommended if no monitor or keyboard is connected to the RPi2/3. In case of problems fe. if the network (auto) configuration failed - the serial console can be used to access the system.
145 Enable serial console interface. Recommended if no monitor or keyboard is connected to the RPi2/3. In case of problems fe. if the network (auto) configuration failed - the serial console can be used to access the system.
@@ -174,6 +184,8 Install Xorg open-source X Window System.
174 ##### `ENABLE_WM`=""
184 ##### `ENABLE_WM`=""
175 Install a user defined window manager for the X Window System. To make sure all X related package dependencies are getting installed `ENABLE_XORG` will automatically get enabled if `ENABLE_WM` is used. The `rpi23-gen-image.sh` script has been tested with the following list of window managers: `blackbox`, `openbox`, `fluxbox`, `jwm`, `dwm`, `xfce4`, `awesome`.
185 Install a user defined window manager for the X Window System. To make sure all X related package dependencies are getting installed `ENABLE_XORG` will automatically get enabled if `ENABLE_WM` is used. The `rpi23-gen-image.sh` script has been tested with the following list of window managers: `blackbox`, `openbox`, `fluxbox`, `jwm`, `dwm`, `xfce4`, `awesome`.
176
186
187 ---
188
177 #### Advanced system features:
189 #### Advanced system features:
178 ##### `ENABLE_MINBASE`=false
190 ##### `ENABLE_MINBASE`=false
179 Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
191 Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
@@ -217,6 +229,8 Enable automatic assignment of predictable, stable network interface names for a
217 ##### `DISABLE_UNDERVOLT_WARNINGS`=
229 ##### `DISABLE_UNDERVOLT_WARNINGS`=
218 Disable RPi2/3 under-voltage warnings and overlays. Setting the parameter to `1` will disable the warning overlay. Setting it to `2` will additionally allow RPi2/3 turbo mode when low-voltage is present.
230 Disable RPi2/3 under-voltage warnings and overlays. Setting the parameter to `1` will disable the warning overlay. Setting it to `2` will additionally allow RPi2/3 turbo mode when low-voltage is present.
219
231
232 ---
233
220 #### SSH settings:
234 #### SSH settings:
221 ##### `SSH_ENABLE_ROOT`=false
235 ##### `SSH_ENABLE_ROOT`=false
222 Enable password root login via SSH. This may be a security risk with default password, use only in trusted environments. `ENABLE_ROOT` must be set to `true`.
236 Enable password root login via SSH. This may be a security risk with default password, use only in trusted environments. `ENABLE_ROOT` must be set to `true`.
@@ -233,6 +247,8 Add SSH (v2) public key(s) from specified file to `authorized_keys` file to enab
233 ##### `SSH_USER_PUB_KEY`=""
247 ##### `SSH_USER_PUB_KEY`=""
234 Add SSH (v2) public key(s) from specified file to `authorized_keys` file to enable public key based SSH (v2) authentication of user `USER_NAME`=pi. The specified file can also contain multiple SSH (v2) public keys. SSH protocol version 1 is not supported.
248 Add SSH (v2) public key(s) from specified file to `authorized_keys` file to enable public key based SSH (v2) authentication of user `USER_NAME`=pi. The specified file can also contain multiple SSH (v2) public keys. SSH protocol version 1 is not supported.
235
249
250 ---
251
236 #### Kernel compilation:
252 #### Kernel compilation:
237 ##### `BUILD_KERNEL`=false
253 ##### `BUILD_KERNEL`=false
238 Build and install the latest RPi2/3 Linux kernel. Currently only the default RPi2/3 kernel configuration is used. `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` is used.
254 Build and install the latest RPi2/3 Linux kernel. Currently only the default RPi2/3 kernel configuration is used. `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` is used.
@@ -270,6 +286,8 With this parameter set to true the script expects the existing kernel sources d
270 ##### `RPI_FIRMWARE_DIR`=""
286 ##### `RPI_FIRMWARE_DIR`=""
271 The directory containing a local copy of the firmware from the [RaspberryPi firmware project](https://github.com/raspberrypi/firmware). Default is to download the latest firmware directly from the project.
287 The directory containing a local copy of the firmware from the [RaspberryPi firmware project](https://github.com/raspberrypi/firmware). Default is to download the latest firmware directly from the project.
272
288
289 ---
290
273 #### Reduce disk usage:
291 #### Reduce disk usage:
274 The following list of parameters is ignored if `ENABLE_REDUCE`=false.
292 The following list of parameters is ignored if `ENABLE_REDUCE`=false.
275
293
@@ -297,8 +315,9 Replace `openssh-server` with `dropbear`.
297 ##### `REDUCE_LOCALE`=true
315 ##### `REDUCE_LOCALE`=true
298 Remove all `locale` translation files.
316 Remove all `locale` translation files.
299
317
300 #### Encrypted root partition:
318 ---
301
319
320 #### Encrypted root partition:
302 ##### `ENABLE_CRYPTFS`=false
321 ##### `ENABLE_CRYPTFS`=false
303 Enable full system encryption with dm-crypt. Setup a fully LUKS encrypted root partition (aes-xts-plain64:sha512) and generate required initramfs. The /boot directory will not be encrypted. This parameter will be ignored if `BUILD_KERNEL`=false. `ENABLE_CRYPTFS` is experimental. SSH-to-initramfs is currently not supported but will be soon - feel free to help.
322 Enable full system encryption with dm-crypt. Setup a fully LUKS encrypted root partition (aes-xts-plain64:sha512) and generate required initramfs. The /boot directory will not be encrypted. This parameter will be ignored if `BUILD_KERNEL`=false. `ENABLE_CRYPTFS` is experimental. SSH-to-initramfs is currently not supported but will be soon - feel free to help.
304
323
General Comments 0
Vous devez vous connecter pour laisser un commentaire. Se connecter maintenant