docs: 添加 RustFS Docker 部署说明文档

添加详细的 Docker 部署说明文档,包含配置参数解释、部署步骤和注意事项
This commit is contained in:
2025-09-06 12:49:45 +08:00
parent beea176c09
commit ba4adb9516

52
rustfs/readme.md Normal file
View File

@@ -0,0 +1,52 @@
# RustFS Docker 部署说明
本目录提供了使用 Docker 部署 RustFS 服务的配置文件。
## 简介
RustFS 是一个基于 Rust 开发的文件存储服务,本部署方式使用 Docker 容器化运行,可以通过 `rustfs.env` 文件进行配置。
## 安装前提
- 已安装 Docker 和 Docker Compose
- 具有读写权限的主机目录用于持久化存储
## 配置说明
主要配置文件为 `rustfs.env``env.cfg`,可以根据需要修改以下参数:
### rustfs.env
- `RUSTFS_ACCESS_KEY`: 访问密钥默认rustfsadmin
- `RUSTFS_SECRET_KEY`: 密钥默认rustfsadmin
- `RUSTFS_VOLUMES`: 存储卷路径
- `RUSTFS_ADDRESS`: 服务监听地址
- `RUSTFS_CONSOLE_ENABLE`: 是否启用控制台
- `RUST_LOG`: 日志级别
- `RUSTFS_OBS_LOG_DIRECTORY`: 日志目录
### env.cfg
- `IMAGE_TAG`: Docker 镜像标签
- `IMAGE_TAG_LTS`: LTS 版本镜像标签
- `Volumes_Path`: 数据卷主机路径
- `RUSTFS_SERVER_DOMAINS`: 服务域名
- `RUSTFS_CONSOLE_ENABLE`: 是否启用控制台
- `RUSTFS_SECRET_KEY`: 密钥
- `RUSTFS_ACCESS_KEY`: 访问密钥
## 部署步骤
1. 修改配置文件中的参数(根据需要)
2. 使用 Docker Compose 启动服务:
```bash
docker-compose -f stack.yml up -d
```
## 访问服务
- 服务默认监听端口50900
- 可以通过配置的域名rustfs.example.com访问
## 停止服务
```bash
docker-compose -f stack.yml down
```
## 注意事项
- 首次启动会自动创建必要的目录结构
- 建议修改默认的访问密钥和密钥以提高安全性
- 数据存储在主机的 `${Volumes_Path}/data` 目录下