docs(readme): 更新升级指南文档
- 添加老客户旧版本部署包升级
This commit is contained in:
parent
3bab0ecbce
commit
0496fe7288
115
README.md
115
README.md
@ -19,6 +19,77 @@ git clone https://git.51easyai.com/wangbo/easyai.git; cd easyai; powershell -Exe
|
||||
|
||||
---
|
||||
|
||||
## 更新升级
|
||||
### 老客户(旧版本部署包)升级教程
|
||||
|
||||
如果你当前使用的是较早版本的部署包,**无法在旧包目录里直接执行 `git pull`** 来获取配置文件,建议按下面流程升级:
|
||||
|
||||
1. 先停止并下线旧项目容器:
|
||||
```bash
|
||||
cd ~/easyai
|
||||
docker compose down
|
||||
```
|
||||
如果你的环境使用的是旧命令,请改用:
|
||||
```bash
|
||||
docker-compose down
|
||||
```
|
||||
|
||||
2. 将旧目录重命名备份(示例改名为 `easyai2`):
|
||||
```bash
|
||||
cd ~
|
||||
mv easyai easyai2
|
||||
```
|
||||
|
||||
3. 重新执行一键部署命令,按脚本提示完成初始化输入。
|
||||
|
||||
4. 当脚本询问是否启用 HTTPS 时:
|
||||
- 如果你之前已经有可用证书,填写 `N`(不生成新证书)。
|
||||
- 只有在需要新申请证书时,才选择启用并生成证书。
|
||||
|
||||
5. 完成上述迁移后,后续若有新的配置文件或版本更新,可直接在新的 `easyai` 目录中执行 `./update.sh` 进行更新。
|
||||
|
||||
update.sh 脚本用于自动更新 EasyAI 应用,包含以下功能:
|
||||
- **拉取整个仓库**:执行 `git pull` 获取最新代码(docker-compose.yml、start.sh、.env.*.sample 等全部文件)
|
||||
- 自动补齐缺失的环境配置文件(.env、.env.tools、.env.ASG、.env.AMS,从 .sample 生成且不覆盖已有文件)
|
||||
- 兼容 `docker compose` 和 `docker-compose` 两种命令格式
|
||||
- 自动拉取最新镜像并重启服务
|
||||
|
||||
### 使用步骤
|
||||
1. [首次执行,后续无需重复执行]添加执行权限,命令:
|
||||
```bash
|
||||
chmod +x update.sh
|
||||
```
|
||||
|
||||
2. 执行更新(默认会 `git pull` 拉取整个仓库)
|
||||
```bash
|
||||
./update.sh
|
||||
```
|
||||
|
||||
> **注意**:update.sh 需要在 Git 克隆的目录下运行。若通过 zip 下载而非 git clone,请先使用 `git clone` 获取项目。
|
||||
|
||||
### 使用方式
|
||||
- 执行 `./update.sh` 后会**命令行内选择**更新方式:
|
||||
- `[1]` 更新并拉取仓库(git pull)+ 更新镜像并重启(**默认**,回车即选)
|
||||
- `[2]` 仅更新镜像并重启(跳过 git pull,适用于有本地修改不想被覆盖的场景)
|
||||
- 如果本次**不涉及配置文件更新**(如 `.env*`、`docker-compose.yml`、`easyai-proxy.conf*` 无变更),可直接选择 `[2]`,仅更新后台服务镜像并重启即可。
|
||||
|
||||
- **查看帮助**:`./update.sh -h` 或 `./update.sh --help`
|
||||
|
||||
### 更新说明
|
||||
- 脚本会执行 `git pull` 拉取整个仓库最新代码
|
||||
- 拉取后会检查并补齐缺失的 .env、.env.tools、.env.ASG、.env.AMS(不会覆盖已有文件)
|
||||
- 最后执行 `docker compose pull` 和 `docker compose up -d` 拉取镜像并重启服务
|
||||
|
||||
### Windows 用户(update.ps1)
|
||||
Windows 下使用 `update.ps1`,功能与 Linux 版一致:
|
||||
```powershell
|
||||
.\update.ps1
|
||||
```
|
||||
- 执行后会**命令行内选择**:`[1]` 更新并拉取仓库 + 更新镜像(默认);`[2]` 仅更新镜像
|
||||
- 需在 Git 克隆的 easyai 目录下运行
|
||||
|
||||
---
|
||||
|
||||
## 重要更新记录:
|
||||
|
||||
### 2026.3.20
|
||||
@ -401,50 +472,6 @@ chmod +x https.sh
|
||||
如果需要启用PDF图文解析Markdown功能,需要`env.tools`中的OSS环境变量,具体参考文件中的配置说明:自动解析PDF图文,将图片文件上传到OSS,并解析成Markdown格式,并返回
|
||||
|
||||
|
||||
### 更新升级
|
||||
update.sh 脚本用于自动更新 EasyAI 应用,包含以下功能:
|
||||
- **拉取整个仓库**:执行 `git pull` 获取最新代码(docker-compose.yml、start.sh、.env.*.sample 等全部文件)
|
||||
- 自动补齐缺失的环境配置文件(.env、.env.tools、.env.ASG、.env.AMS,从 .sample 生成且不覆盖已有文件)
|
||||
- 兼容 `docker compose` 和 `docker-compose` 两种命令格式
|
||||
- 自动拉取最新镜像并重启服务
|
||||
|
||||
#### 使用步骤
|
||||
1. [首次执行,后续无需重复执行]添加执行权限,命令:
|
||||
```bash
|
||||
chmod +x update.sh
|
||||
```
|
||||
|
||||
2. 执行更新(默认会 `git pull` 拉取整个仓库)
|
||||
```bash
|
||||
./update.sh
|
||||
```
|
||||
|
||||
> **注意**:update.sh 需要在 Git 克隆的目录下运行。若通过 zip 下载而非 git clone,请先使用 `git clone` 获取项目。
|
||||
|
||||
#### 使用方式
|
||||
- 执行 `./update.sh` 后会**命令行内选择**更新方式:
|
||||
- `[1]` 更新并拉取仓库(git pull)+ 更新镜像并重启(**默认**,回车即选)
|
||||
- `[2]` 仅更新镜像并重启(跳过 git pull,适用于有本地修改不想被覆盖的场景)
|
||||
|
||||
- **查看帮助**:`./update.sh -h` 或 `./update.sh --help`
|
||||
|
||||
#### 更新说明
|
||||
- 脚本会执行 `git pull` 拉取整个仓库最新代码
|
||||
- 拉取后会检查并补齐缺失的 .env、.env.tools、.env.ASG、.env.AMS(不会覆盖已有文件)
|
||||
- 最后执行 `docker compose pull` 和 `docker compose up -d` 拉取镜像并重启服务
|
||||
|
||||
#### Windows 用户(update.ps1)
|
||||
Windows 下使用 `update.ps1`,功能与 Linux 版一致:
|
||||
```powershell
|
||||
.\update.ps1
|
||||
```
|
||||
- 执行后会**命令行内选择**:`[1]` 更新并拉取仓库 + 更新镜像(默认);`[2]` 仅更新镜像
|
||||
- 需在 Git 克隆的 easyai 目录下运行
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 常见问题
|
||||
|
||||
1. 某个服务无法运行
|
||||
|
||||
Loading…
Reference in New Issue
Block a user