Lib.rs

systeroid 使用 procfs 实现，procfs 是在引导时通常映射到名为 /proc 的挂载点的虚拟文件系统。这意味着检查某些内核参数的值需要在此虚拟文件系统中打开一个文件，读取其内容，解析它们，然后关闭文件。在 Linux 中，这些动态可配置的内核选项位于 /proc/sys 下，其中包含表示内核各部分的目录和可读/写虚拟文件。例如，要启用/禁用 IP 转发，可以在 /proc/sys/net/ipv4/ip_forward 中写入 1 或 0，或者可以使用 systeroid ip_forward=1 命令来更改参数的值。

尽管 systeroid 不需要显式指定参数部分，但了解各部分及其影响区域很重要。以下是根据 Linux 内核文档 可用的内核部分

• 要求
• 安装
  • Cargo
  • Arch Linux
  • Alpine Linux
  • 二进制发布
  • 从源码构建
  • Docker
    • 镜像
    • 用法
    • 构建
• 用法
  • 选项
  • 示例
    • 列出参数
    • 按部分过滤
    • 显示值
    • 设置值
    • 从文件加载值
    • 从系统目录加载值
    • 搜索参数
    • 显示参数信息
    • 详细日志
• TUI
  • 用法
  • 键绑定
  • 示例
    • 启动
    • 显示帮助
    • 滚动
    • 切换内核部分
    • 搜索
    • 设置值
    • 保存值
    • 运行命令
    • 复制到剪贴板
    • 更改颜色
    • 查看参数文档
    • 设置刷新率
    • 日志
• 配置
• 资源
  • 参考
  • 标志
  • 社交媒体链接
  • 媒体
  • 资助
• 贡献
• 许可证
• 版权

要求

• Rust (>=1.64.0) (查看 从源码构建)
• libxcb (用于 复制到剪贴板)
• linux-documentation (用于 查看文档)

要安装运行时依赖项

• 在Arch Linux上： pacman -S libxcb libxkbcommon linux-docs
• 在Debian/Ubuntu上： apt-get install libx11-dev libxcb-shape0-dev libxcb-xfixes0-dev libxkbcommon-dev linux-doc
• 在Fedora上： dnf install libX11-devel kernel-doc

安装

Cargo

systeroid 可在 crates.io 上获得

cargo install systeroid
cargo install systeroid-tui

Arch Linux

systeroid 可通过 社区仓库 使用 pacman 安装

pacman -S systeroid

Alpine Linux

systeroid 可在 Alpine Edge 上获得。在启用 社区仓库 后，可以通过 apk 安装。

apk add systeroid

二进制发布

查看由 持续部署工作流 自动化的可用 发布。

从源码构建

# clone the repository
git clone https://github.com/orhun/systeroid && cd systeroid/

# binaries will be located at:
# - target/release/systeroid
# - target/release/systeroid-tui
CARGO_TARGET_DIR=target cargo build --release

另请参阅 要求。

Docker

镜像

Docker 构建是 自动化的，镜像可在以下注册表中获得

• Docker Hub
• GitHub 容器注册表

用法

以下命令可以用来交互式地查看选定参数的文档

docker run --rm -it "orhunp/systeroid:${TAG:-latest}" --tui

Docker容器共享主机系统的内核及其设置，因此对/proc和/sys的访问受到限制，这是出于安全考虑。因此，在容器内调整内核参数是不可能的（也不推荐）。请参阅*。

构建

可以从Dockerfile构建自定义Docker镜像。

docker build -t systeroid .

用法

systeroid [options] [variable[=value] ...] --load[=<file>]

选项

-a, --all           display all variables (-A,-X)
-T, --tree          display the variables in a tree-like format
-J, --json          display the variables in JSON format
    --deprecated    include deprecated variables while listing
-e, --ignore        ignore unknown variable errors
-N, --names         print only variable names
-n, --values        print only variable values
-b, --binary        print only variable values without new line
-p, --load          read values from file (-f)
-S, --system        read values from all system directories
-r, --pattern <expr>
                    use a regex for matching variable names
-q, --quiet         do not print variable after the value is set
-w, --write         only enable writing a value to variable
-E, --explain       provide a detailed explanation for variable
-D, --docs <path>   set the path of the kernel documentation
-P, --no-pager      do not pipe output into a pager
-v, --verbose       enable verbose logging
    --tui           show terminal user interface
-c, --config <path> set the path of the configuration file
-h, --help          display this help and exit (-d)
-V, --version       output version information and exit

大多数参数/标志都继承自sysctl，因此它们具有相同的功能。

示例

列出参数

# list all parameters
systeroid -A

# list parameters in a tree-like format
systeroid -T

# list parameters in JSON format
systeroid -J

要禁用颜色，设置NO_COLOR环境变量。

按部分过滤

# only list parameters in the "kernel" section
systeroid kernel

# only list parameters in the "vm" and "user" sections
systeroid vm user

显示值

# print the name and value of a parameter (in "name=value" format)
systeroid kernel.hostname

# print only the value of a parameter
systeroid -n kernel.hostname

# print the name and values of the multiple parameters
systeroid kernel.hostname user.max_user_namespaces

设置值

# set the value of a parameter
systeroid kernel.domainname="example.com"

# set the values of multiple parameters and ignore errors
systeroid -e kernel.dmesg_restrict=0 vm.panic_on_oom=1 unknown_param="test"

# set the values of multiple parameters and enforce the "name=value" format
systeroid -w fs.dir-notify-enable=1 net.mptcp.enabled=1 vm.oom_kill_allocating_task

从文件加载值

可以从INI文件设置参数值。

sysctl.conf:

# Use kernel.sysrq = 1 to allow all keys.
# See https://www.kernel.org/doc/html/latest/admin-guide/sysrq.html for a list
# of values and keys.
kernel.sysrq = 16

# Append the PID to the core filename
kernel.core_uses_pid = 1

; Enable hard and soft link protection
; (If a line begins with a single '-', any attempts to set the value that fail will be ignored.)
-fs.protected_hardlinks = 1
fs.protected_symlinks = 1

加载它

systeroid --load sysctl.conf

如果没有指定文件，则默认从/etc/sysctl.conf加载值

systeroid --load

指定“-”作为文件名意味着从标准输入读取数据

systeroid --load -

从系统目录加载值

以下列出了默认系统目录列表

• /etc/sysctl.d
• /run/sysctl.d
• /usr/local/lib/sysctl.d
• /usr/lib/sysctl.d
• /lib/sysctl.d
• /etc/sysctl.conf

使用--system标志来加载这些目录中以“.conf”扩展名命名的文件

systeroid --system

搜索参数

# search parameters using regex patterns
systeroid -r 'net.ipv4.conf.(eth|wlan)0.arp'
systeroid -r '^net.ipv6'

结合搜索和列表的示例输出

$ systeroid --names --pattern 'kernel.*_max$' --tree

kernel
├── ngroups_max
├── pid_max
└── sched_util_clamp_max

显示参数信息

systeroid可以从内核文档中导出参数信息。如果你不知道参数是用于什么的话，这很有用。

# show information about a parameter
systeroid --explain oom_dump_tasks

内核文档应位于以下路径之一，以便在首次启动时进行解析

• /usr/share/doc/linux
• /usr/share/doc/linux-doc
• /usr/share/doc/linux-docs
• /usr/share/doc/kernel-doc-*/Documentation

然后解析的数据将缓存到$HOME/.cache/systeroid-core中，并从中使用，直到文档更新。可以通过设置NO_CACHE环境变量来禁用缓存机制。

这是由于不同系统可能安装了不同版本的内核，因此如果systeroid捆绑固定集的参数描述，则文档可能太新或太旧。通过解析方法，文档始终保持最新。

但是，这意味着你需要