docs: 更新 README.md 以反映最新功能和改进
更新了 README.md 文件,详细描述了用户后台管理系统的功能,包括用户管理、团队管理、用户配置管理、文件管理和知识库管理。此外,调整了文档撰写功能的描述,并优化了使用方式的说明,使其更加清晰和易于理解。
This commit is contained in:
parent
3faa18126e
commit
7a78507da6
51
README.md
51
README.md
|
@ -10,28 +10,38 @@ Ragflow-Plus 是一个基于 Ragflow 的开源项目,主旨是在不影响 Rag
|
||||||
|
|
||||||
### 一. 用户后台管理系统
|
### 一. 用户后台管理系统
|
||||||
|
|
||||||
移除原登陆页用户注册的通道,搭建用户后台管理系统,可对用户进行管理,包括用户管理、团队管理、用户模型配置管理等功能。
|
移除原登陆页用户注册的通道,搭建用户后台管理系统,包含以下功能:
|
||||||
|
|
||||||
特点:新建用户时,新用户会自动加入创建时间最早用户的团队,并默认采取和最早用户相同的模型配置。
|
- 用户管理:新增用户、删除用户
|
||||||
|
特点:新建用户时,新用户会自动加入创建时间最早用户的团队,并默认采取和最早用户相同的模型配置。
|
||||||
|
|
||||||
|
- 团队管理:新增团队、编辑团队、团队成员管理
|
||||||
|
|
||||||
|
- 用户配置管理:查看修改用户的模型参数配置
|
||||||
|
|
||||||
|
- 文件管理:上传文件、删除文件、查询文件
|
||||||
|
|
||||||
|
- 知识库管理:新增知识库、编辑知识库、删除知识库、知识库列表查看、文件解析
|
||||||
|
|
||||||
### 二. 文档撰写功能
|
### 二. 文档撰写功能
|
||||||
新增文档撰写全新的交互方式,支持直接导出为 Word 文档。
|
|
||||||
|
前台系统进一步调整样式,新增文档撰写全新的交互方式,支持直接导出为 Word 文档。
|
||||||
|
|
||||||
## 使用方式
|
## 使用方式
|
||||||
|
|
||||||
#### 1. 使用Docker Compose运行
|
#### 1. 使用Docker Compose运行
|
||||||
|
|
||||||
和运行 ragflow 原始项目一样,项目根目录下执行
|
在项目根目录下执行
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker compose -f docker/docker-compose.yml up -d
|
docker compose -f docker/docker-compose.yml up -d
|
||||||
```
|
```
|
||||||
访问地址:`服务器ip:80`,进入到ragflow原始界面
|
访问地址:`服务器ip:80`,进入到前台界面
|
||||||
|
|
||||||
访问地址:`服务器ip:8888`,进入到管理界面
|
访问地址:`服务器ip:8888`,进入到后台管理界面
|
||||||
|
|
||||||
|
|
||||||
#### 2. 源码运行
|
#### 2. 源码运行(mysql、minio、es等组件仍需docker启动)
|
||||||
|
|
||||||
也可以通过下面的方式单独运行管理系统
|
也可以通过下面的方式单独运行管理系统
|
||||||
|
|
||||||
|
@ -68,33 +78,6 @@ pnpm dev
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
#### 3. 前端文件替换(可选)
|
|
||||||
|
|
||||||
ragflow-plus 还对原有的前端文件进行了若干优化,包含新增加的文档撰写功能,如需体验,可通过以下步骤替换原文件:
|
|
||||||
|
|
||||||
1. 克隆项目
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/zstar1003/ragflow-plus.git
|
|
||||||
```
|
|
||||||
|
|
||||||
2. 打包web文件
|
|
||||||
```bash
|
|
||||||
cd web
|
|
||||||
pnpm run build
|
|
||||||
```
|
|
||||||
|
|
||||||
3. 进入到容器,删除容器中已有的/ragflow/web/dist文件
|
|
||||||
```bash
|
|
||||||
docker exec -it ragflow-server /bin/sh
|
|
||||||
rm -rf /ragflow/web/dist
|
|
||||||
```
|
|
||||||
|
|
||||||
4. 将打包好的web文件拷贝到容器中
|
|
||||||
```bash
|
|
||||||
docker cp dist ragflow-server:/ragflow/web/
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## 交流群
|
## 交流群
|
||||||
如果有其它需求或问题建议,可加入交流群进行讨论。
|
如果有其它需求或问题建议,可加入交流群进行讨论。
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue