better-initramfs 技术文档

目录

• 安装指南
• 项目的使用说明
• 项目API使用文档
• 项目安装方式

安装指南

使用二进制包安装

1. 访问 下载页面 下载 tarball 文件。
2. 解压下载的文件并阅读 README.binary 和 README.rst 文件以获取更多信息。

从源码构建

1. 克隆 Git 仓库：

   git clone https://bitbucket.org/piotrkarbowski/better-initramfs.git
   

2. 进入项目目录并执行以下命令：

   make bootstrap-all
   make prepare
   make image
   

   这些命令将依次下载并构建所需的工具，最终生成 initramfs 镜像。

项目的使用说明

使用场景

• 从加密存储、软件 RAID、LVM 或它们的组合中启动根文件系统。
• 提供一个最小的救援环境，甚至可以通过 SSH 远程访问 initramfs 进行修复。
• 通过 LABEL 或 UUID 选择根文件系统，避免因添加硬盘导致的根变量问题。
• 调试新内核或内核崩溃问题，检查磁盘是否在 /dev 中，查看内核是否初始化了硬盘控制器。

功能特性

• 支持 BCACHE、LVM、dmcrypt LUKS、软件 RAID。
• 提供救援 shell 和远程救援 shell（通过 SSH）。
• 支持通过 UUID/LABEL 进行恢复、根文件系统和加密根文件系统。
• 支持从 TuxOnIce 和内核挂起（swsusp）中恢复。

项目API使用文档

参数说明

• rescueshell：在挂载根文件系统到 /newroot 之前进入救援 shell。
• sshd：运行 SSH 服务器，允许通过 SSH 访问 initramfs。
• sshd_wait=X：在设置 SSH 后等待 X 秒，适用于在启动真实系统前登录并暂停启动过程。
• sshd_port=X：设置 SSH 监听端口，默认端口为 22。
• binit_net_if=<if>：指定网络配置的接口，可选指定 VLAN。
• binit_net_addr=<addr/cidr> 或 binit_net_addr=dhcp：在指定接口上配置 IP 地址和子网掩码，或使用 DHCP。
• binit_net_route=<addr/cidr>：添加静态路由。
• binit_net_gw=<addr>：配置网关。
• rw：以读写模式挂载根文件系统，默认是只读模式。
• mdev：不检查内核是否支持 devtmpfs，使用 mdev 代替（适用于非常老的内核）。
• softraid：启动 RAID 阵列。
• init=X：在切换到新根后运行 X，默认是 /sbin/init。
• tuxonice：尝试使用 TuxOnIce 恢复。
• swsusp：尝试使用内核挂起（swsusp）恢复。
• resume=<device/path>：指定从哪个设备恢复（使用 tuxonice 或 swsusp）。
• lvm：扫描所有磁盘以激活卷组。
• luks：对 enc_root 变量执行 cryptsetup luksOpen。
• enc_root=<device>：指定加密的根文件系统设备，例如 /dev/sda2。
• root=<device>：指定根文件系统设备，例如 /dev/mapper/enc_root 或 /dev/sdXX。
• rootfstype=<filesystem type>：设置根文件系统的文件系统类型。
• rootdelay=<integer>：设置 initramfs 等待设备的时间（适用于根文件系统在 USB 设备上）。
• rootflags=X：在挂载根文件系统时传递 X 标志。
• luks_no_discards：在 LUKS 层禁用丢弃支持。
• bcache：启动 bcache 设备。

项目安装方式

从二进制包安装

1. 下载二进制包并解压。
2. 阅读 README.binary 和 README.rst 文件以获取安装和使用说明。

从源码构建

1. 克隆 Git 仓库。
2. 执行 make bootstrap-all、make prepare 和 make image 命令以构建 initramfs 镜像。

通过以上步骤，您可以成功安装并使用 better-initramfs 项目。