From ba4adb9516797c3ade675d6c8af4c2aa15c29f3a Mon Sep 17 00:00:00 2001
From: cnphpbb <moqiruyi@126.com>
Date: Sat, 6 Sep 2025 12:49:45 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E6=B7=BB=E5=8A=A0=20RustFS=20Docker=20?=
 =?UTF-8?q?=E9=83=A8=E7=BD=B2=E8=AF=B4=E6=98=8E=E6=96=87=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

添加详细的 Docker 部署说明文档，包含配置参数解释、部署步骤和注意事项
---
 rustfs/readme.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 rustfs/readme.md

diff --git a/rustfs/readme.md b/rustfs/readme.md
new file mode 100644
index 0000000..79c2bd1
--- /dev/null
+++ b/rustfs/readme.md
@@ -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` 目录下
\ No newline at end of file