docs(readme): 更新文档移除一键启动脚本说明
- 移除了 Linux/Ubuntu 和 Windows 一键启动脚本的相关说明 - 添加了其他功能配置的概述 - 保留了 PDF 图文解析 Markdown 功能的配置说明
This commit is contained in:
parent
0496fe7288
commit
2d924f5631
84
README.md
84
README.md
@ -384,89 +384,9 @@ docker run -it --rm registry.cn-shanghai.aliyuncs.com/easyaigc/dozzle:latest gen
|
||||
1. 升级了mongoDB的数据挂载方式,使用volume挂载,避免跨平台的一些数据挂载问题
|
||||
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应用
|
||||
|
||||
## Windows 一键启动
|
||||
|
||||
start.ps1 脚本用于 Windows 本机/局域网一键部署 EasyAI 应用。**不要直接双击运行**(会闪退),请按以下方式执行:
|
||||
|
||||
### 权限配置(首次执行必做)
|
||||
|
||||
PowerShell 默认可能禁止运行脚本,需先执行以下任一方式:
|
||||
|
||||
**方式一:临时允许本次运行(推荐)**
|
||||
```powershell
|
||||
powershell -ExecutionPolicy Bypass -File .\start.ps1
|
||||
```
|
||||
|
||||
**方式二:为当前用户永久放开脚本执行权限**
|
||||
```powershell
|
||||
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
|
||||
```
|
||||
执行后再运行 `.\start.ps1` 即可。
|
||||
|
||||
### 启动步骤
|
||||
|
||||
1. 克隆并进入目录
|
||||
```powershell
|
||||
git clone https://git.51easyai.com/wangbo/easyai.git
|
||||
cd easyai
|
||||
```
|
||||
|
||||
2. 在 PowerShell 或 CMD 中运行(二选一)
|
||||
```powershell
|
||||
# 若已设置 ExecutionPolicy,可直接执行
|
||||
.\start.ps1
|
||||
|
||||
# 未设置时使用 Bypass 方式
|
||||
powershell -ExecutionPolicy Bypass -File .\start.ps1
|
||||
```
|
||||
|
||||
3. 按提示选择 [1] 本地访问 或 [2] 局域网访问,脚本将自动配置并启动 Docker 服务。
|
||||
|
||||
4. 若窗口闪退,可查看日志 `start.ps1.log`(与 start.ps1 同目录,或 `%TEMP%\start.ps1.log`)获取退出原因。
|
||||
|
||||
### 启用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格式,并返回
|
||||
|
||||
Loading…
Reference in New Issue
Block a user