RAGflow/README.md

95 lines
2.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Ragflow-Plus
## 项目介绍
在原有 Ragflow 的基础中,该项目做了一些二开,以解决实际应用中的一些痛点。
## 名字说明
Ragflow-Plus该名字不是说比 Ragflow 项目牛的意思,而是对标 Dify-Plus 作为 Ragflow 的二开项目,以解决行业应用时共同的痛点问题。
## 新增功能介绍
### 一. 用户后台管理系统
移除原登陆页用户注册的通道,搭建用户后台管理系统,可对用户进行管理,包括用户注册、查询、删除、修改等功能。
### 二. 优化对话显示
微调了对话界面的样式,使其观感更为友好
### 三. 文档撰写功能
新增文档撰写全新的交互方式,支持直接导出为 Word 文档
## 使用方式
### 前端文件替换
1. 克隆项目
```bash
git clone https://github.com/zstar1003/ragflow-plus.git
```
2. 打包web文件
```bash
cd web
npm 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/
```
### 管理系统运行方式
```bash
docker compose -f management/docker-compose.yml up -d
```
访问地址:`服务器ip:8080`,进入到管理界面
## Agent功能恢复
由于在我的应用场景中不需要Agent功能故隐藏了Agent按钮的入口如需恢复Agent功能可修改`web\src\layouts\components\header\index.tsx`,对以下内容取消注释:
```tsx
{ path: '/flow', name: t('flow'), icon: GraphIcon },
```
同时可将排列样式进行重置,以还原原本的样式布局,修改`web\src\layouts\components\header\index.less`文件替换为ragflow原始样式`https://github.com/infiniflow/ragflow/blob/main/web/src/layouts/components/header/index.less`
## Todo List
- [x] 搭建用户后台管理
- [ ] 知识库批量上传解析
- [ ] 文档撰写图表支持
## 交流群
如果有其它需求或问题建议,可加入交流群进行讨论
<div align="center">
<img src="assets/group.jpg" width="300" alt="交流群">
</div>
## License
版权说明:本项目在 Ragflow 项目基础上进行二开,需要遵守 Ragflow 的开源协议,如下
This repository is available under the [Ragflow
Open Source License](LICENSE), which is essentially Apache 2.0 with a few additional restrictions.
## 鸣谢
本项目基于以下开源项目开发:
- [ragflow](https://github.com/infiniflow/ragflow)
- [v3-admin-vite](https://github.com/un-pany/v3-admin-vite)