CLI 参考

介绍 rustfs 子命令、服务器参数及对应环境变量,以及卷路径语法。

rustfs 二进制文件提供六个子命令。不带子命令运行 rustfs 时会启动服务器。

子命令

命令说明
rustfs server [OPTIONS] <VOLUMES>...启动对象存储服务器(未指定子命令时的默认行为)。
rustfs info [--all] [--json] [system|runtime|build|config|deps]显示系统、运行时、构建、配置或依赖项信息。
rustfs tls inspect --path <DIR>检查 TLS 证书目录布局和解析状态。
rustfs diagnose [OPTIONS] <PATHS>...分析日志文件并报告可能的故障原因。
rustfs inspect <COMMAND>在服务器未运行时检查持久化的存储桶元数据。
rustfs connect <COMMAND>配置出站 RustFS Connect 集成。
Examples
rustfs server /data/rustfs
rustfs info --all --json
rustfs tls inspect --path /etc/rustfs/tls

旧版调用兼容性

RustFS 会预处理参数以保持向后兼容,因此旧版调用方式仍可使用:

旧版形式解释为
rustfs /datarustfs server /data
rustfs --address :9000 /datarustfs server --address :9000 /data
rustfs(无参数)rustfs server,卷从 RUSTFS_VOLUMES 读取
rustfs --inforustfs info
rustfs helprustfs --help

服务器参数

每个服务器参数都有对应的环境变量;两者同时设置时,以参数为准。

参数环境变量默认值说明
<VOLUMES>...(位置参数)RUSTFS_VOLUMES必填存储卷或端点,以空格分隔。
--addressRUSTFS_ADDRESS:9000S3 API 绑定地址(ADDRESS:PORT、IP 或主机名)。
--server-domainsRUSTFS_SERVER_DOMAINS未设置用于虚拟主机风格请求的域名,以逗号分隔。
--access-keyRUSTFS_ACCESS_KEY未设置根访问密钥(与 --access-key-file 冲突)。