update docs

docs/docker-compose安装指南.md

@@ -1,77 +1,119 @@
-## Docker-Compose 部署教程
+## Docker-Compose 快速部署指南
-本文教你如何在命令行使用docker-compose + sqlite来快速部署Xboard  
+
-如果你需要使用Mysql，你需要自行处理好Mysql的安装。
+### 环境要求
-### 部署 (使用docker-compose 2分钟部署)
+- Docker (最新稳定版)
-> 在此提供Xboard安装、快速体验Xboard的步骤。   
+- 至少 1GB 可用内存
-使用docker compose + sqlite 快速部署站点（**无需安装Mysql以及redis**）
+- 至少 10GB 可用磁盘空间
-1. 安装docker
+- 系统支持: Linux/macOS/Windows
-```
+- 开放端口: 7001 (默认)
+
+### 部署步骤
+
+#### 1. 安装 Docker
+```bash
+# 安装 Docker
 curl -sSL https://get.docker.com | bash
-```  
+
-Centos系统可能需要执行下面命令来启动Docker。
+# CentOS 系统需要执行以下命令启动 Docker
-```
 systemctl enable docker
 systemctl start docker
 ```
-2. 获取Docker compose 文件
+
-```
+#### 2. 获取部署文件
+```bash
 git clone -b docker-compose --depth 1 https://github.com/cedar2025/Xboard
 cd Xboard
 ```
-3. 执行数据库安装命令
+
-> 选择 **启用sqlite** 和 **Docker内置的Redis**
+#### 3. 初始化安装
-```
+> 提供两种安装方式，选择其一即可：
-docker compose run -it --rm -e enable_sqlite=true -e enable_redis=true -e admin_account=your_admin_email@example.com xboard php artisan xboard:install
+
-```
+**方式一：快速安装** (推荐)
-> 或者根据自己的需要在运行时选择
+```bash
+# 使用 SQLite + Docker内置Redis
+docker compose run -it --rm \
+    -e enable_sqlite=true \
+    -e enable_redis=true \
+    -e admin_account=admin@demo.com \
+    xboard php artisan xboard:install
 ```
+
+**方式二：自定义安装**
+```bash
+# 根据提示自定义配置
 docker compose run -it --rm xboard php artisan xboard:install
 ```
-> 执行这条命令之后，会返回你的后台地址和管理员账号密码（你需要记录下来）  
-> 你需要执行下面的 **启动xborad** 步骤之后才能访问后台
 
-4. 启动Xboard
+> **重要提示：** 
-```
+> - 安装完成后会显示后台地址和管理员账号密码，请务必保存
+> - 如需使用 MySQL，请先自行安装并配置 MySQL 后再部署
+
+#### 4. 启动服务
+```bash
 docker compose up -d
 ```
-> 安装完成之后即可访问你的站点
-5. 访问站点 
-> 启动之后网站端口默认为7001, 你可以配置nginx反向代理使用80端口  
 
-网站地址:   http://你的IP:7001/   
+#### 5. 访问站点
-在此你已经成功部署了, 你可以访问网址体验Xboard的完整功能， 
+- 网站地址：`http://服务器IP:7001`
+- 后台地址：安装时提供的地址
 
-> 如果你需要使用mysql，请自行安装Mysql后重新部署
+### 更新指南
 
-### **更新**
+#### 方式一：快速更新（保持最新版本）
-1. 修改版本
+```bash
-```
 cd Xboard
-vi docker-compose.yaml
-```
-> 修改docker-compose.yaml 当中image后面的版本号为你需要的版本  
-> 如果为版本为latest 则可以忽略这一步，直接进行第二步
-
-2. 更新数据库（可以执行多次都是安全的）
-```
 docker compose pull
 docker compose down
 docker compose run -it --rm xboard php artisan xboard:update
 docker compose up -d
 ```
-> 即可更新成功
 
-### **回滚**
+#### 方式二：更新至指定版本
-> 此回滚不回滚数据库，是否回滚数据库请查看相关文档
+1. 修改版本号
-1. 回退版本  
+```bash
-```
+# 编辑 docker-compose.yaml，修改 image 的版本号
 vi docker-compose.yaml
 ```
-> 修改docker-compose.yaml 当中image后面的版本号为更新前的版本号
+
-2. 启动
+2. 执行更新
-```
+```bash
+docker compose pull
+docker compose down
+docker compose run -it --rm xboard php artisan xboard:update
 docker compose up -d
 ```
 
-### 注意
+### 版本回滚
-启用webman后做的任何代码修改都需要重启生效
+```bash
+# 1. 修改 docker-compose.yaml 中的版本号为目标版本
+vi docker-compose.yaml
+
+# 2. 重启服务
+docker compose up -d
+```
+
+### 常见问题
+
+1. **端口配置**
+- 默认端口为 7001
+- 可通过 Nginx 反向代理使用 80/443 端口
+- 如需修改端口，请编辑 docker-compose.yaml
+
+2. **数据持久化**
+- 数据默认存储在 ./data 目录
+- 建议定期备份 data 目录
+
+3. **性能优化**
+- 启用 webman 后的代码修改需要重启服务才能生效
+- 可根据实际需求调整容器资源限制
+
+### 安全建议
+1. 及时更新到最新版本
+2. 修改默认管理员账号
+3. 使用强密码
+4. 建议配置 SSL 证书
+5. 定期备份数据
+
+### 技术支持
+- GitHub Issues: https://github.com/cedar2025/Xboard/issues
+- 官方文档：[文档链接]