优化说明文档
This commit is contained in:
parent
920b7039e6
commit
a47aa8a2f5
180
README.md
180
README.md
@ -1,95 +1,7 @@
|
||||
## Linux/Ubuntu 一键启动
|
||||
start.sh 脚本用于服务器一键安装启动EasyAI应用
|
||||
|
||||
### 首次安装部署步骤，并使用服务器公网IP进行访问
|
||||
1. 克隆脚本和相关文件到服务器
|
||||
```bash
|
||||
git clone https://git.51easyai.com/wangbo/easyai.git
|
||||
# 进入easyai目录
|
||||
cd easyai
|
||||
```
|
||||
|
||||
2. 去掉所有文件后缀的.sample后缀，修改env中环境变量，将下面两个环境变量修改为你的服务器的公网ip，本地局域网方式使用局域网IP
|
||||
```bash
|
||||
NUXT_PUBLIC_BASE_APIURL=http://<你的服务器公网IP或者局域网地址>:3001
|
||||
NUXT_PUBLIC_BASE_SOCKETURL=ws://<你的服务器公网IP或者局域网地址>:3002
|
||||
```
|
||||
3. 开放服务器的3001、3002和3010端口
|
||||
4. [首次执行，后续无需重复执行]添加脚本的执行权限，命令：
|
||||
```bash
|
||||
chmod +x start.sh
|
||||
```
|
||||
5. 执行start.sh脚本，即可自动安装依赖和启动EasyAI应用
|
||||
```bash
|
||||
./start.sh
|
||||
```
|
||||
6. 脚本运行完成无错误，并且提示`EasyAI应用启动成功`表示应用启动成功，打开浏览器输入服务器的公网ip：3010或者局域网IP：3010，即可访问EasyAI应用
|
||||
|
||||
### 启用HTTPS
|
||||
1. [更改为你的域名]修改`easyai-proxy.conf`中域名`51easyai.com`为你的域名[可以使用Ctrl+F批量替换51easyai.com为你的域名]
|
||||
2. [修改.env文件]修改如下两个环境变量为如下的对应的值
|
||||
```bash
|
||||
NUXT_PUBLIC_BASE_APIURL=/api
|
||||
NUXT_PUBLIC_BASE_SOCKETURL=wss://<你的域名>/socket.io
|
||||
```
|
||||
3. [首次执行，后续无需重复执行]添加执行权限，命令：
|
||||
```bash
|
||||
chmod +x https.sh
|
||||
```
|
||||
4. 启用HTTPS
|
||||
```bash
|
||||
./https.sh
|
||||
```
|
||||
|
||||
### 配置PDF图文解析Markdown功能
|
||||
如果需要启用PDF图文解析Markdown功能，需要`env.tools`中的OSS环境变量，具体参考文件中的配置说明：自动解析PDF图文，将图片文件上传到OSS，并解析成Markdown格式，并返回
|
||||
|
||||
|
||||
### 更新升级
|
||||
update.sh 脚本用于自动更新 EasyAI 应用，包含以下功能：
|
||||
- 自动检查和更新 `docker-compose.yml` 文件（从远程仓库获取最新版本）
|
||||
- 兼容 `docker compose` 和 `docker-compose` 两种命令格式
|
||||
- 自动拉取最新镜像并重启服务
|
||||
|
||||
#### 使用步骤
|
||||
1. [首次执行，后续无需重复执行]添加执行权限，命令：
|
||||
```bash
|
||||
chmod +x update.sh
|
||||
```
|
||||
|
||||
2. 执行更新（默认会检查并更新 docker-compose.yml）
|
||||
```bash
|
||||
./update.sh
|
||||
```
|
||||
|
||||
#### 参数选项
|
||||
- **跳过 docker-compose.yml 更新**：如果你已经手动修改了 `docker-compose.yml` 文件，可以使用 `-s` 或 `--skip-compose-update` 参数跳过更新
|
||||
```bash
|
||||
# 跳过 docker-compose.yml 更新，仅更新容器镜像
|
||||
./update.sh -s
|
||||
# 或
|
||||
./update.sh --skip-compose-update
|
||||
```
|
||||
|
||||
- **查看帮助信息**：
|
||||
```bash
|
||||
./update.sh -h
|
||||
# 或
|
||||
./update.sh --help
|
||||
```
|
||||
|
||||
#### 更新说明
|
||||
- 脚本会自动从远程仓库下载最新的 `docker-compose.yml` 文件
|
||||
- 如果本地文件与远程文件不同，会将原文件备份为 `docker-compose.yml.bak`
|
||||
- 如果本地文件已是最新版本，则跳过更新
|
||||
- 更新完成后会自动执行 `docker-compose pull` 和 `docker-compose up -d` 来重启服务
|
||||
|
||||
|
||||
|
||||
## 重要更新记录：
|
||||
|
||||
|
||||
### 2025.1.29
|
||||
### 2025.1.29
|
||||
|
||||
1. 优化日志管理功能，使用单独的容器和模块来进行管理，不占用主进程文件写入性能
|
||||
2. 更新步骤：
|
||||
@ -196,6 +108,96 @@ docker run -it --rm registry.cn-shanghai.aliyuncs.com/easyaigc/dozzle:latest gen
|
||||
2. .env增加了版本、日志和token参数的配置
|
||||
|
||||
|
||||
## Linux/Ubuntu 一键启动
|
||||
start.sh 脚本用于服务器一键安装启动EasyAI应用
|
||||
|
||||
### 首次安装部署步骤，并使用服务器公网IP进行访问
|
||||
1. 克隆脚本和相关文件到服务器
|
||||
```bash
|
||||
git clone https://git.51easyai.com/wangbo/easyai.git
|
||||
# 进入easyai目录
|
||||
cd easyai
|
||||
```
|
||||
|
||||
2. 去掉所有文件后缀的.sample后缀，修改env中环境变量，将下面两个环境变量修改为你的服务器的公网ip，本地局域网方式使用局域网IP
|
||||
```bash
|
||||
NUXT_PUBLIC_BASE_APIURL=http://<你的服务器公网IP或者局域网地址>:3001
|
||||
NUXT_PUBLIC_BASE_SOCKETURL=ws://<你的服务器公网IP或者局域网地址>:3002
|
||||
```
|
||||
3. 开放服务器的3001、3002和3010端口
|
||||
4. [首次执行，后续无需重复执行]添加脚本的执行权限，命令：
|
||||
```bash
|
||||
chmod +x start.sh
|
||||
```
|
||||
5. 执行start.sh脚本，即可自动安装依赖和启动EasyAI应用
|
||||
```bash
|
||||
./start.sh
|
||||
```
|
||||
6. 脚本运行完成无错误，并且提示`EasyAI应用启动成功`表示应用启动成功，打开浏览器输入服务器的公网ip：3010或者局域网IP：3010，即可访问EasyAI应用
|
||||
|
||||
### 启用HTTPS
|
||||
1. [更改为你的域名]修改`easyai-proxy.conf`中域名`51easyai.com`为你的域名[可以使用Ctrl+F批量替换51easyai.com为你的域名]
|
||||
2. [修改.env文件]修改如下两个环境变量为如下的对应的值
|
||||
```bash
|
||||
NUXT_PUBLIC_BASE_APIURL=/api
|
||||
NUXT_PUBLIC_BASE_SOCKETURL=wss://<你的域名>/socket.io
|
||||
```
|
||||
3. [首次执行，后续无需重复执行]添加执行权限，命令：
|
||||
```bash
|
||||
chmod +x https.sh
|
||||
```
|
||||
4. 启用HTTPS
|
||||
```bash
|
||||
./https.sh
|
||||
```
|
||||
|
||||
### 配置PDF图文解析Markdown功能
|
||||
如果需要启用PDF图文解析Markdown功能，需要`env.tools`中的OSS环境变量，具体参考文件中的配置说明：自动解析PDF图文，将图片文件上传到OSS，并解析成Markdown格式，并返回
|
||||
|
||||
|
||||
### 更新升级
|
||||
update.sh 脚本用于自动更新 EasyAI 应用，包含以下功能：
|
||||
- 自动检查和更新 `docker-compose.yml` 文件（从远程仓库获取最新版本）
|
||||
- 兼容 `docker compose` 和 `docker-compose` 两种命令格式
|
||||
- 自动拉取最新镜像并重启服务
|
||||
|
||||
#### 使用步骤
|
||||
1. [首次执行，后续无需重复执行]添加执行权限，命令：
|
||||
```bash
|
||||
chmod +x update.sh
|
||||
```
|
||||
|
||||
2. 执行更新（默认会检查并更新 docker-compose.yml）
|
||||
```bash
|
||||
./update.sh
|
||||
```
|
||||
|
||||
#### 参数选项
|
||||
- **跳过 docker-compose.yml 更新**：如果你已经手动修改了 `docker-compose.yml` 文件，可以使用 `-s` 或 `--skip-compose-update` 参数跳过更新
|
||||
```bash
|
||||
# 跳过 docker-compose.yml 更新，仅更新容器镜像
|
||||
./update.sh -s
|
||||
# 或
|
||||
./update.sh --skip-compose-update
|
||||
```
|
||||
|
||||
- **查看帮助信息**：
|
||||
```bash
|
||||
./update.sh -h
|
||||
# 或
|
||||
./update.sh --help
|
||||
```
|
||||
|
||||
#### 更新说明
|
||||
- 脚本会自动从远程仓库下载最新的 `docker-compose.yml` 文件
|
||||
- 如果本地文件与远程文件不同，会将原文件备份为 `docker-compose.yml.bak`
|
||||
- 如果本地文件已是最新版本，则跳过更新
|
||||
- 更新完成后会自动执行 `docker-compose pull` 和 `docker-compose up -d` 来重启服务
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 常见问题
|
||||
|
||||
1. 某个服务无法运行
|
||||
|
||||
Loading…
Reference in New Issue
Block a user