README.md
97 lines
| 5.7 KiB
| text/x-minidsrc
|
MarkdownLexer
drtyhlpr
|
r0 | # rpi2-gen-image | ||
|
drtyhlpr
|
r12 | ## Introduction | ||
| `rpi2-gen-image.sh` is an advanced Debian Linux bootstrapping shell script for generating Debian OS images for the Raspberry 2 (RPi2) computer. The script at this time only supports the bootstrapping of the current stable Debian 8 "jessie" release. | ||||
| ## Build dependencies | ||||
| 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. | ||||
| ```debootstrap debian-archive-keyring qemu-user-static dosfstools rsync bmap-tools whois git-core``` | ||||
| ## Command-line parameters | ||||
|
drtyhlpr
|
r19 | The script accepts certain command-line parameters to enable or disable specific OS features, services and configuration settings. These parameters are passed to the `rpi2-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 `rpi2-gen-image.sh` script. | ||
|
drtyhlpr
|
r12 | |||
| #####Command-line examples: | ||||
|
drtyhlpr
|
r1 | ```shell | ||
|
drtyhlpr
|
r4 | ENABLE_UBOOT=true ./rpi2-gen-image.sh | ||
|
drtyhlpr
|
r1 | ENABLE_CONSOLE=false ENABLE_IPV6=false ./rpi2-gen-image.sh | ||
| ENABLE_HARDNET=true ENABLE_IPTABLES=true /rpi2-gen-image.sh | ||||
| APT_SERVER=ftp.de.debian.org APT_PROXY="http://127.0.0.1:3142/" ./rpi2-gen-image.sh | ||||
Jan Wagner
|
r16 | ENABLE_MINBASE=true ./rpi2-gen-image.sh | ||
|
drtyhlpr
|
r1 | ``` | ||
|
drtyhlpr
|
r12 | |||
| #### APT settings: | ||||
| ##### `APT_SERVER`="ftp.debian.org" | ||||
|
drtyhlpr
|
r19 | 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. | ||
|
drtyhlpr
|
r12 | |||
| ##### `APT_PROXY`="" | ||||
| 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. | ||||
| #### General system settings: | ||||
| ##### `HOSTNAME`="rpi2-jessie" | ||||
|
Jan Wagner
|
r16 | Set system host name. It's recommended that the host name is unique in the corresponding subnet. | ||
|
drtyhlpr
|
r12 | |||
| ##### `PASSWORD`="raspberry" | ||||
|
Jan Wagner
|
r16 | Set system `root` password. The same password is used for the created user `pi`. It's **STRONGLY** recommended that you choose a custom password. | ||
|
drtyhlpr
|
r12 | |||
| ##### `DEFLOCAL`="en_US.UTF-8" | ||||
|
Jan Wagner
|
r16 | Set default system locale and keyboard layout. This setting can also be changed inside the running OS using the `dpkg-reconfigure locales` command. The script variant `minbase` (ENABLE_MINBASE=true) doesn't install `locales`. | ||
|
drtyhlpr
|
r12 | |||
| ##### `TIMEZONE`="Europe/Berlin" | ||||
| 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. | ||||
| #### Basic system features: | ||||
| ##### `ENABLE_CONSOLE`=true | ||||
|
Jan Wagner
|
r16 | Enable serial console interface. Recommended if no monitor or keyboard is connected to the RPi2. In case of problems fe. if the network (auto) configuration failed - the serial console can be used to access the system. | ||
|
drtyhlpr
|
r12 | |||
| ##### `ENABLE_IPV6`=true | ||||
|
Jan Wagner
|
r16 | Enable IPv6 support. The network interface configuration is managed via systemd-networkd. | ||
|
drtyhlpr
|
r12 | |||
| ##### `ENABLE_SSHD`=true | ||||
|
Jan Wagner
|
r16 | 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. | ||
|
drtyhlpr
|
r12 | |||
| ##### `ENABLE_SOUND`=true | ||||
|
Jan Wagner
|
r16 | Enable sound hardware and install Advanced Linux Sound Architecture. | ||
|
drtyhlpr
|
r12 | |||
| ##### `ENABLE_HWRANDOM`=true | ||||
|
Jan Wagner
|
r16 | Enable Hardware Random Number Generator. Strong random numbers are important for most network based communications that use encryption. It's recommended to be enabled. | ||
|
drtyhlpr
|
r12 | |||
| ##### `ENABLE_MINGPU`=false | ||||
|
drtyhlpr
|
r19 | Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU. | ||
|
drtyhlpr
|
r12 | |||
| ##### `ENABLE_DBUS`=true | ||||
|
Jan Wagner
|
r16 | Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled. | ||
|
drtyhlpr
|
r12 | |||
| ##### `ENABLE_XORG`=false | ||||
|
Jan Wagner
|
r16 | Install Xorg open-source X Window System. | ||
|
drtyhlpr
|
r12 | |||
| ##### `ENABLE_FLUXBOX`=false | ||||
|
drtyhlpr
|
r19 | Install Fluxbox 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_FLUXBOX` is used. | ||
|
drtyhlpr
|
r12 | |||
| #### Advanced sytem features: | ||||
|
Jan Wagner
|
r16 | ##### `ENABLE_MINBASE`=false | ||
| Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB. | ||||
|
drtyhlpr
|
r12 | ##### `ENABLE_UBOOT`=false | ||
|
drtyhlpr
|
r18 | Replace default RPi2 second stage bootloader (bootcode.bin) with U-Boot bootloader. U-Boot can boot images via the network using the BOOTP/TFTP protocol. | ||
|
drtyhlpr
|
r12 | |||
| ##### `ENABLE_IPTABLES`=false | ||||
|
Jan Wagner
|
r16 | Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service. | ||
|
drtyhlpr
|
r12 | |||
| ##### `ENABLE_HARDNET`=false | ||||
|
Jan Wagner
|
r16 | Enable IPv4/IPv6 network stack hardening settings. | ||
|
drtyhlpr
|
r12 | |||
|
drtyhlpr
|
r13 | ## Logging of the bootstrapping process | ||
| All information related to the bootstrapping process and the commands executed by the `rpi2-gen-image.sh` script can easily be saved into a logfile. The common shell command `script` can be used for this purpose: | ||||
| ```shell | ||||
| script -c 'APT_SERVER=ftp.de.debian.org ./rpi2-gen-image.sh' ./build.log | ||||
| ``` | ||||
|
drtyhlpr
|
r12 | ## Flashing the image file | ||
|
drtyhlpr
|
r19 | After the image file was successfully created by the `rpi2-gen-image.sh` script it can be copied to the microSD card that will be used by the RPi2 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`. | ||
|
drtyhlpr
|
r12 | |||
| #####Flashing examples: | ||||
| ```shell | ||||
| bmaptool copy ./images/jessie/2015-12-13-debian-jessie.img /dev/mmcblk0 | ||||
|
drtyhlpr
|
r13 | dd bs=4M if=./images/jessie/2015-12-13-debian-jessie.img of=/dev/mmcblk0 | ||
|
drtyhlpr
|
r12 | ``` | ||
