Skip to content

Latest commit

 

History

History
450 lines (322 loc) · 21 KB

README-CN.md

File metadata and controls

450 lines (322 loc) · 21 KB

介绍

rpi23-gen-image.sh 是一个自动生成树莓派2/3系统镜像的脚本工具, 当前支持自动生成32位 armhf 架构的Debian, 发行版本jessie, stretchbuster. 树莓派3 64位镜像需要使用特定的配置参数 (templates/rpi3-stretch-arm64-4.11.y).

构建环境所依赖的包

一定要安装好下列deb包, 他们是构建过程需要的核心包. 脚本会自动检查, 如果缺少,经用户确认后会自动安装.

debootstrap debian-archive-keyring qemu-user-static binfmt-support dosfstools rsync bmap-tools whois git bc psmisc dbus sudo

推荐通过配置 rpi23-gen-image.sh 脚本编译安装最新的树莓派 Linux 内核, 对于树莓派3, 只能如此. 在构建系统上使用 ARM (armhf) 交叉编译工具链编译内核.

脚本已经在Debian Liux jessiestretch 构建系统下使用默认的 crossbuild-essential-armhf 工具链进行过测试. 获取更多信息请查看 Debian 交叉工具链 Wiki .

如果使用Debian Linux jessie 构建系统, 先要添加交叉编译工具链的源 Debian 交叉工具链仓库:

echo "deb http://emdebian.org/tools/debian/ jessie main" > /etc/apt/sources.list.d/crosstools.list
sudo -u nobody wget -O - http://emdebian.org/tools/debian/emdebian-toolchain-archive.key | apt-key add -
dpkg --add-architecture armhf
apt-get update

命令行参数

脚本可以使用特定的命令行参数来允许或禁止操作系统的某些特性、服务和配置信息. 这些参数通过(简单)脚本变量传递给 rpi23-gen-image.sh. 不同于环境变量, (简单)脚本变量在调用rpi23-gen-image.sh的命令行前面定义.

命令行示例:
ENABLE_UBOOT=true ./rpi23-gen-image.sh
ENABLE_CONSOLE=false ENABLE_IPV6=false ./rpi23-gen-image.sh
ENABLE_WM=xfce4 ENABLE_FBTURBO=true ENABLE_MINBASE=true ./rpi23-gen-image.sh
ENABLE_HARDNET=true ENABLE_IPTABLES=true /rpi23-gen-image.sh
APT_SERVER=ftp.de.debian.org APT_PROXY="http://127.0.0.1:3142/" ./rpi23-gen-image.sh
ENABLE_MINBASE=true ./rpi23-gen-image.sh
BUILD_KERNEL=true ENABLE_MINBASE=true ENABLE_IPV6=false ./rpi23-gen-image.sh
BUILD_KERNEL=true KERNELSRC_DIR=/tmp/linux ./rpi23-gen-image.sh
ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh
ENABLE_CRYPTFS=true CRYPTFS_PASSWORD=changeme EXPANDROOT=false ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh
RELEASE=stretch BUILD_KERNEL=true ./rpi23-gen-image.sh
RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
RELEASE=stretch RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh

参数模板文件

为了避免冗长的命令行参数以及存储感兴趣的参数配置, rpi23-gen-image.sh 支持所谓的参数模板文件 (CONFIG_TEMPLATE=template). 这些文本文件位于 ./templates 目录, 文件中含有将会使用的配置参数. 新的配置模板文件会被添加到 ./templates 目录.

命令行示例:
CONFIG_TEMPLATE=rpi3stretch ./rpi23-gen-image.sh
CONFIG_TEMPLATE=rpi2stretch ./rpi23-gen-image.sh

支持的参数和设置

APT 设置:

APT_SERVER="ftp.debian.org"

设置 Debian 仓库地址. 选择一个 镜像站点. 选一个近的镜像站点会加快镜像生成过程中所需文件的下载速度.

APT_PROXY=""

设置代理服务器地址. 使用本地缓存代理, 比如 apt-cacher-ng 可以缩短镜像生成时间, 因为所需要的 Debian 包文件只需下载一次.

APT_INCLUDES=""

生成镜像过程中最先由debootstrap程序自动安装的附加包, 逗号分隔.

APT_INCLUDES_LATE=""

生成镜像过程中最初的debootstrap完成后, 需要的使用apt命令安装的附加包, 逗号分隔. 特别用在含有 pre-depend 依赖关系的包的, 其依赖关系在打包过程中debootstrap程序中无法正确处理.


通用系统设置:

RPI_MODEL=2

指定树莓派型号. 当前支持树莓派 23. 设为 3BUILD_KERNEL 自动设为true .

RELEASE="jessie"

设置 Debian 发行版. 脚本当前支持 Debian 发行版 "jessie", "stretch" 和 "buster" 的自动生成. 设为stretchbusterBUILD_KERNEL 自动设为true.

RELEASE_ARCH="armhf"

设置期望的 Debian 发行架构.

HOSTNAME="rpi$RPI_MODEL-$RELEASE"

设置主机名称. 建议所在的子网中主机名称是唯一的.

PASSWORD="raspberry"

设置系统的 root 用户密码. 强烈建议选择一个自定义密码 .

USER_PASSWORD="raspberry"

设置由 USER_NAME=pi 参数创建的普通用户的密码. 如果 ENABLE_USER=false 则忽略. 强烈建议选择一个自定义密码.

DEFLOCAL="en_US.UTF-8"

设置系统默认 locale. 将来可以在运行的系统中执行 dpkg-reconfigure locales 命令更改此项设置. 设置这项脚本会自动安装 locales, keyboard-configurationconsole-setup 三个包.

TIMEZONE="Europe/Berlin"

设置系统默认时区. 可以在/usr/share/zoneinfo/ 目录中找到全部可用时区. 将来可以在运行的系统中执行 dpkg-reconfigure tzdata 命令更改此项设置.

EXPANDROOT=true

第一次运行时自动扩展根分区和文件系统.


键盘设置:

这些选项用来配置键盘布局文件 /etc/default/keyboard 影响控制台和X窗口. 将来可以在运行的系统中执行 dpkg-reconfigure keyboard-configuration 命令更改此项设置.

XKB_MODEL=""

设置键盘类型, 大陆常见pc104.

XKB_LAYOUT=""

设置键盘布局, 大陆常见us.

XKB_VARIANT=""

设置键盘布局变种.

XKB_OPTIONS=""

设置其它 XKB 配置选项.


网络设置 (动态):

设置网络为自动获取IP地址. 配置文件位于 /etc/systemd/network/eth.network. 在Debian stretch中, 默认位置更改为 /lib/systemd/network.

ENABLE_DHCP=true

设置系统使用 DHCP 获取动态IP. 需要有一个 DHCP 服务器.


网络设置 (静态):

设置系统为手动配置IP地址. 配置文件位于 /etc/systemd/network/eth.network. 在Debian stretch 中, 默认位置更改为 /lib/systemd/network. 当 ENABLE_DHCP=false 时下面这些静态IP设置才起作用.

NET_ADDRESS=""

设置静态 IPv4 或 IPv6, 使用CIDR "/"形式, 如 "192.169.0.3/24".

NET_GATEWAY=""

设置默认网关的地址.

NET_DNS_1=""

设置主域名服务器地址.

NET_DNS_2=""

设置辅域名服务器地址.

NET_DNS_DOMAINS=""

设置默认的域名搜索后缀, 当主机名称不是一个完整域名(FQDN)时使用.

NET_NTP_1=""

设置主时间服务器地址.

NET_NTP_2=""

设置辅时间服务器地址.


基本系统特性:

ENABLE_CONSOLE=true

允许串行控制台接口. 没有连接显示器键盘的树莓派推荐打开, 此时如果网络无法连接至树莓派, 可以使用串行控制台连至系统.

ENABLE_I2C=false

允许树莓派2/3的 I2C 接口. 请对照 树莓派2/3 引脚示意图 正确连接 GPIO 引脚.

ENABLE_SPI=false

允许树莓派2/3的 SPI 接口. 请对照 树莓派2/3 引脚示意图 正确连接 GPIO 引脚.

ENABLE_IPV6=true

允许 IPv6 . 通过 systemd-networkd 配置管理网络接口.

ENABLE_SSHD=true

安装并且允许 OpenSSH 服务. 此服务默认禁止 root 用户远程登录. 使用普通用户 pi 远程登录然后使用 su -sudo 来取得root权限.

ENABLE_NONFREE=false

允许安装仓库中的 non-free 类的软件包. 需要安装闭源的固件, 二进制大对象 blob.

ENABLE_WIRELESS=false

下载安装树莓派3无线接口所需要的闭源固件 二进制blob 树莓派3无线接口固件. 如果 RPI_MODEL 不是 3 则忽略.

ENABLE_RSYSLOG=true

如果设置为 false, 禁用并卸载 rsyslog, 则只能通过日志文件查看logs.

ENABLE_SOUND=true

允许声卡并且安装 ALSA.

ENABLE_HWRANDOM=true

允许硬件随机数发生器. 强随机数对大多数使用加密的网络通信是非常重要的. 推荐允许此设置.

ENABLE_MINGPU=false

最小化显存 (16MB, no X), 目前无法完全禁用GPU.

ENABLE_DBUS=true

安装并允许 D-Bus 消息总线. 虽然 systemd 可以在没有 D-bus的情况下工作, 但是推荐允许D-Bus.

ENABLE_XORG=false

是否安装 Xorg, 开源 X11 系统.

ENABLE_WM=""

安装用户指定的X Window 窗口管理器. 如果设置了ENABLE_WM, 系统确定所有被依赖的X11相关软件包都安装好了以后ENABLE_XORG会自动设置为true, rpi23-gen-image.sh 脚本已经通过下列窗口管理器的测试: blackbox, openbox, fluxbox, jwm, dwm, xfce4, awesome.


高级系统特性:

ENABLE_MINBASE=false

使用 debootstrap 脚本变量 minbase, 只含有必不可少的核心包和apt. 体积大约 65 MB.

ENABLE_REDUCE=false

卸载包、删除文件以减小体积 详情查看 REDUCE_* 参数.

ENABLE_UBOOT=false

使用 U-Boot 引导器 替代树莓派2/3 默认的第二阶段引导器(bootcode.bin). U-Boot 可以通过网络使用 BOOTP/TFTP 协议引导镜像文件.

UBOOTSRC_DIR=""

存放已下载 U-Boot 引导器源文件 的目录(u-boot).

ENABLE_FBTURBO=false

安装并且允许 硬件加速的 Xorg 显卡驱动 fbturbo. 当前仅支持窗口的移动和滚动的硬件加速.

FBTURBOSRC_DIR=""

设置存放已下载的 硬件加速的 Xorg 显卡驱动 的目录 (xf86-video-fbturbo) , 可以复制到chroot内配置、构建和安装.

ENABLE_IPTABLES=false

允许 iptables 防火墙. 使用最简单的规则集: 允许所有出站连接;禁止除OpenSSH外的所有入站连接.

ENABLE_USER=true

创建普通用户, 默认用户名pi, 默认密码raspberry. 可以使用 USER_NAME=user 更改默认用户名;使用 USER_PASSWORD=raspberry 更改默认密码.

USER_NAME=pi

创建普通用户pi. 如果ENABLE_USER=false 此参数被忽略.

ENABLE_ROOT=false

允许root用户登录, 需要设置 root 用户密码.

ENABLE_HARDNET=false

允许加固 IPv4/IPv6 协议栈, 防止DoS攻击.

ENABLE_SPLITFS=false

允许将根分区放在USB驱动器中. 将会生成两个镜像文件, 一个挂载为 /boot/firmware , 另一个挂载为 /.

CHROOT_SCRIPTS=""

设置自定义脚本目录的路径, 该目录中的脚本在镜像文件构建完成之前在chroot中运行. 这个目录里的可执行文件按着字典序运行.

ENABLE_INITRAMFS=false

创建 Linux 启动时加载的 initramfs .如果 ENABLE_CRYPTFS=true 那么 ENABLE_INITRAMFS 自动设为true . 如果 BUILD_KERNEL=false 此参数被忽略.

ENABLE_IFNAMES=true

允许一致/可预测网络接口命名, 支持 Debian 发行版 stretchbuster .

DISABLE_UNDERVOLT_WARNINGS=

禁止树莓派2/3 的低电压警告. 设为 1 禁止警告. 设为 2 额外允许低电压下的turbo增强模式.


SSH 设置:

SSH_ENABLE_ROOT=false

允许root通过密码验证方式远程登录系统. 如果没有修改默认密码, 这将是个巨大的安全隐患. ENABLE_ROOT 必须设为 true.

SSH_DISABLE_PASSWORD_AUTH=false

禁用SSH的密码验证方式, 只支持SSH (v2)的公钥认证.

SSH_LIMIT_USERS=false

限制通过SSH远程登录的用户. 只允许由 USER_NAME=pi 参数创建的普通用户, 以及当 SSH_ENABLE_ROOT=true 时 root 用户远程登录. 如果使用的守护程序是 dropbear (通过 REDUCE_SSHD=true 设置) 则忽略此参数.

SSH_ROOT_PUB_KEY=""

从指定文件(可包含多个公钥)添加 SSH (v2) 公钥到 authorized_keys 文件, 使得 root 用户可以使用SSH (v2)的公钥验证方式远程登录, 不支持SSH (v1). ENABLE_ROOT SSH_ENABLE_ROOT 必须同时设为 true.

SSH_USER_PUB_KEY=""

从指定文件(可包含多个公钥)添加 SSH (v2) 公钥到 authorized_keys 文件, 使得由 USER_NAME=pi 参数创建的普通用户可以使用SSH (v2)的公钥验证方式远程登录, 不支持SSH (v1).


内核编译:

BUILD_KERNEL=false

构建安装最新的树莓派 2/3 Linux 内核, 当前只支持默认内核配置. 如果设置为树莓派3那么自动设置BUILD_KERNEL=true .

CROSS_COMPILE="arm-linux-gnueabihf-"

设置交叉编译器.

KERNEL_ARCH="arm"

设置内核架构.

KERNEL_IMAGE="kernel7.img"

内核镜像名称, 如果没有设置, 编译32位内核默认“kernel7.img” 64位内核默认 "kernel8.img".

KERNEL_BRANCH=""

GIT里的树莓派内核源代码分支名称, 默认使用当前默认分支.

QEMU_BINARY="/usr/bin/qemu-arm-static"

设置构建系统中的QEMU程序位置. 如果没有设置, 32位内核默认 “/usr/bin/qemu-arm-static” 64位内核默认 "/usr/bin/qemu-aarch64-static".

KERNEL_DEFCONFIG="bcm2709_defconfig"

设置编译内核的默认配置. 如果没有设置, 32位内核默认"bcm2709_defconfig" 64位内核默认"bcmrpi3_defconfig".

KERNEL_REDUCE=false

缩小内核体积, 移除不想要的设备驱动、网络驱动和文件系统驱动 (实验性质).

KERNEL_THREADS=1

编译内核时的并发线程数量. 如果使用默认设置, 系统会自动检测CPU的内核数量, 设置线程数量, 加速内核编译.

KERNEL_HEADERS=true

安装内核相应的头文件.

KERNEL_MENUCONFIG=false

运行make menuconfig使用菜单界面配置内核. 退出配置菜单后脚本继续运行.

KERNEL_REMOVESRC=true

编译安装完成后, 删掉内核源代码, 产生的镜像不含内核源代码.

KERNELSRC_DIR=""

已下载好的 Github上的树莓派官方内核 源码所在目录 (linux) 的路径, 可以复制到chroot内配置、构建和安装.

KERNELSRC_CLEAN=false

KERNELSRC_DIR被复制到 chroot 之后开始编译之前(使用 make mrproper)清理内核源代码. 如果 KERNELSRC_DIR 没有设置或者 KERNELSRC_PREBUILT=true时忽略此设置.

KERNELSRC_CONFIG=true

在编译前使用 make bcm2709_defconfig (也可以选择 make menuconfig) 配置内核源代码. 如果KERNELSRC_DIR指定的源码存放目录不存在,这个参数自动设为 true. 如果 KERNELSRC_PREBUILT=true 忽略此参数.

KERNELSRC_USRCONFIG=""

复制自己的配置文件到内核的 .config. 如果 KERNEL_MENUCONFIG=true 拷贝完成后自动运行 make menuconfig.

KERNELSRC_PREBUILT=false

如果这个参数设为true 表示内核源代码目录中包含成功交叉编译好的内核. 忽略 KERNELSRC_CLEAN, KERNELSRC_CONFIG, KERNELSRC_USRCONFIG and KERNEL_MENUCONFIG 这四个参数,不再执行交叉编译操作.

RPI_FIRMWARE_DIR=""

指定目录 (firmware) 含有已经从 Github上的树莓派官方固件下载到本地的固件. 默认直接从网上下载最新的固件.


缩小体积:

如果 ENABLE_REDUCE=false 则忽略下列参数.

REDUCE_APT=true

配置 APT,压缩仓库文件列表,不缓存下载的包文件.

REDUCE_DOC=true

移除所有的doc文档文件(harsh). 配置 APT, 将来使用apt-get安装deb包时不包括doc文件.

REDUCE_MAN=true

移除所有的man手册页和info文件 (harsh). 配置 APT, 将来使用apt-get安装deb包时不包括man手册页.

REDUCE_VIM=false

使用vim的小型克隆 levee 替代 vim-tiny.

REDUCE_BASH=false

使用 dash 代替 bash (实验性质).

REDUCE_HWDB=true

移除与 PCI 相关的 hwdb 文件 (实验性质).

REDUCE_SSHD=true

使用dropbear代替 openssh-server.

REDUCE_LOCALE=true

移除所有的 locale 本地化文件.


加密根分区:

ENABLE_CRYPTFS=false

使用dm-crypt进行全盘加密. 创建一个 LUKS 加密根分区 (加密方法 aes-xts-plain64:sha512) 并生成所需要的 initramfs. /boot 目录不会被加密. 当BUILD_KERNEL=false时忽略此参数. ENABLE_CRYPTFS 这个参数当前是实验性质的. SSH-to-initramfs 当前不支持,正在进行中.

CRYPTFS_PASSWORD=""

设置根分区的加密密码. 如果 ENABLE_CRYPTFS=true,请务必设置此参数.

CRYPTFS_MAPPING="secure"

设置device-mapper映射名称.

CRYPTFS_CIPHER="aes-xts-plain64:sha512"

加密算法. 推荐 aes-xts*加密法.

CRYPTFS_XTSKEYSIZE=512

设置密钥长度,8的倍数,以bit为单位.


Build settings构建设置:

BASEDIR=$(pwd)/images/${RELEASE}

设置产生镜像的目录.

IMAGE_NAME=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}

设置镜像文件名. 如果ENABLE_SPLITFS=false则文件名$IMAGE_NAME.img 如果ENABLE_SPLITFS=true则文件名$IMAGE_NAME-frmw.img 和 $IMAGE_NAME-root.img. 如果没有设置 KERNEL_BRANCH 则使用 "CURRENT" .

理解脚本

制作镜像的每个阶段所实现的功能都由各自的脚本完成, 位于 bootstrap.d 目录. 按着字典序执行:

脚本 说明
10-bootstrap.sh 生成基本系统
11-apt.sh 设置 APT 仓库源
12-locale.sh 设置 Locales 和 keyboard
13-kernel.sh 编译安装树莓派 2/3 内核
14-fstab.sh 设置 fstab 和 initramfs
15-rpi-config.sh 设置 RPi2/3 config and cmdline
20-networking.sh 设置网络
21-firewall.sh 设置防火墙
30-security.sh 设置用户以及安全相关
31-logging.sh 设置日志
32-sshd.sh 设置 SSH 和公钥
41-uboot.sh 编译设置 U-Boot
42-fbturbo.sh 编译设置 fbturbo Xorg 驱动
50-firstboot.sh 首次启动执行的任务
99-reduce.sh 缩小体积

所有需要拷贝到镜像文件的配置文件都位于 files 目录. 最好不要手动更改这些配置文件.

目录 说明
apt APT 管理配置文件
boot 引导文件 树莓派2/3配置文件
dpkg 包管理配置文件
etc 配置文件以及 rc 启动脚本
firstboot 首次引导执行的脚本
initramfs Initramfs 脚本
iptables 防火墙配置文件
locales Locales 配置
modules 内核模块配置
mount Fstab 配置
network 网络配置文件
sysctl.d 交换文件以及IP协议加固配置文件
xorg fbturbo Xorg 驱动配置

自定义包和脚本

packages 目录里放置自定义deb包, 比如系统仓库里没有的软件.在安装完系统仓库中的包之后安装. 自定义包所依赖的deb包会自动从系统仓库下载. 不要把自定义包添加到 APT_INCLUDES 参数中. custom.d 目录中的脚本会在其它安装都完成后, 创建镜像文件之前执行.

记录镜像产生过程的信息

所有镜像产生过程的信息、rpi23-gen-image.sh 脚本执行的命令都可以通过shell的 script 命令保存到日志文件中:

script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log

烧录镜像文件

rpi23-gen-image.sh 所生成的镜像文件需要使用 bmaptooldd 烧录到 microSD 卡. bmaptool 速度快比 dd 聪明.

烧录示例:
bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie.img /dev/mmcblk0
dd bs=4M if=./images/jessie/2017-01-23-rpi3-jessie.img of=/dev/mmcblk0

如果设置过 ENABLE_SPLITFS, 烧录 -frmw 文件到 microSD 卡, 烧录 -root 文件到 USB 驱动器:

bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie-frmw.img /dev/mmcblk0
bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie-root.img /dev/sdc

每周镜像

这些镜像由JRWR'S I/O PORT提供, 每周日午夜UTC 0点编译!

External links and references外部链接, 各种资源