zstar
parent
41d575221f
commit
215c1a3a3b
|
|
@ -1,48 +0,0 @@
|
|||
# Contribution guidelines
|
||||
|
||||
This document offers guidelines and major considerations for submitting your contributions to RAGFlow.
|
||||
|
||||
- To report a bug, file a [GitHub issue](https://github.com/infiniflow/ragflow/issues/new/choose) with us.
|
||||
- For further questions, you can explore existing discussions or initiate a new one in [Discussions](https://github.com/orgs/infiniflow/discussions).
|
||||
|
||||
## What you can contribute
|
||||
|
||||
The list below mentions some contributions you can make, but it is not a complete list.
|
||||
|
||||
- Proposing or implementing new features
|
||||
- Fixing a bug
|
||||
- Adding test cases or demos
|
||||
- Posting a blog or tutorial
|
||||
- Updates to existing documents, codes, or annotations.
|
||||
- Suggesting more user-friendly error codes
|
||||
|
||||
## File a pull request (PR)
|
||||
|
||||
### General workflow
|
||||
|
||||
1. Fork our GitHub repository.
|
||||
2. Clone your fork to your local machine:
|
||||
`git clone git@github.com:<yourname>/ragflow.git`
|
||||
3. Create a local branch:
|
||||
`git checkout -b my-branch`
|
||||
4. Provide sufficient information in your commit message
|
||||
`git commit -m 'Provide sufficient info in your commit message'`
|
||||
5. Commit changes to your local branch, and push to GitHub: (include necessary commit message)
|
||||
`git push origin my-branch.`
|
||||
6. Submit a pull request for review.
|
||||
|
||||
### Before filing a PR
|
||||
|
||||
- Consider splitting a large PR into multiple smaller, standalone PRs to keep a traceable development history.
|
||||
- Ensure that your PR addresses just one issue, or keep any unrelated changes small.
|
||||
- Add test cases when contributing new features. They demonstrate that your code functions correctly and protect against potential issues from future changes.
|
||||
|
||||
### Describing your PR
|
||||
|
||||
- Ensure that your PR title is concise and clear, providing all the required information.
|
||||
- Refer to a corresponding GitHub issue in your PR description if applicable.
|
||||
- Include sufficient design details for *breaking changes* or *API changes* in your description.
|
||||
|
||||
### Reviewing & merging a PR
|
||||
|
||||
Ensure that your PR passes all Continuous Integration (CI) tests before merging it.
|
||||
83
README.md
83
README.md
|
|
@ -1,33 +1,40 @@
|
|||
<div align="center">
|
||||
<img src="assets/ragflow-plus.png" width="400" alt="Ragflow-Plus">
|
||||
<img src="https://img.shields.io/badge/版本-0.2.1-blue" alt="版本">
|
||||
<a href="LICENSE"><img src="https://img.shields.io/badge/许可证-AGPL3.0-green" alt="许可证"></a>
|
||||
</div>
|
||||
|
||||
## 项目介绍
|
||||
<div align="center">
|
||||
<h4>
|
||||
<a href="README.md">🇨🇳 中文</a>
|
||||
<span> | </span>
|
||||
<a href="README_EN.md">🇬🇧 English</a>
|
||||
</h4>
|
||||
</div>
|
||||
|
||||
Ragflow-Plus 是一个基于 Ragflow 的二次开发项目，目的是解决实际应用中的一些问题。
|
||||
---
|
||||
|
||||
## 新增功能介绍
|
||||
## 🌟 简介
|
||||
|
||||
### 一. 用户后台管理系统
|
||||
Ragflow-Plus 是一个基于 Ragflow 的二次开发项目，目的是解决实际应用中的一些问题，主要有以下特点：
|
||||
|
||||
移除原登陆页用户注册的通道，搭建用户后台管理系统，包含以下功能：
|
||||
- 管理模式
|
||||
额外搭建后台管理系统，支持管理员执行用户管理、团队管理、配置管理、文件管理、知识库管理等功能
|
||||
- 权限回收
|
||||
前台系统对用户权限进行收缩，进一步简化界面
|
||||
- 解析增强
|
||||
使用MinerU替代DeepDoc算法，使文件解析效果更好，并支持图片解析
|
||||
- 图文输出
|
||||
支持模型在回答时，输出引用文本块关联的相关图片
|
||||
- 文档撰写模式
|
||||
支持全新的文档模式交互体验
|
||||
|
||||
- 用户管理：新增用户、删除用户
|
||||
特点：新建用户时，新用户会自动加入创建时间最早用户的团队，并默认采取和最早用户相同的模型配置。
|
||||
视频演示及操作教程：
|
||||
|
||||
- 团队管理：新增团队、编辑团队、团队成员管理
|
||||
[](https://www.bilibili.com/video/BV1UJLezaEEE)
|
||||
|
||||
- 用户配置管理：查看修改用户的模型参数配置
|
||||
|
||||
- 文件管理：上传文件、删除文件、查询文件
|
||||
|
||||
- 知识库管理：新增知识库、编辑知识库、删除知识库、知识库列表查看、文件解析
|
||||
|
||||
### 二. 文档撰写功能
|
||||
|
||||
前台系统进一步调整样式，新增文档撰写全新的交互方式，支持直接导出为 Word 文档。
|
||||
|
||||
## 使用方式
|
||||
## 📥使用方式
|
||||
|
||||
#### 1. 使用Docker Compose运行
|
||||
|
||||
|
|
@ -47,55 +54,53 @@ docker compose -f docker/docker-compose.yml up -d
|
|||
|
||||
访问地址：`服务器ip:8888`，进入到后台管理界面
|
||||
|
||||
具体操作方式可参考视频：[https://www.bilibili.com/video/BV1UJLezaEEE](https://www.bilibili.com/video/BV1UJLezaEEE)
|
||||
|
||||
图文教程：[https://blog.csdn.net/qq1198768105/article/details/147475488](https://blog.csdn.net/qq1198768105/article/details/147475488)
|
||||
|
||||
#### 2. 源码运行(mysql、minio、es等组件仍需docker启动)
|
||||
|
||||
启动后台管理系统：
|
||||
1. 启动后台管理系统：
|
||||
|
||||
启动后端：
|
||||
|
||||
进入到`management/server`，启动后端：
|
||||
- 启动后端：进入到`management/server`，执行：
|
||||
|
||||
```bash
|
||||
python app.py
|
||||
```
|
||||
|
||||
启动前端：
|
||||
|
||||
进入到`management\web`，启动前端：
|
||||
- 启动前端：进入到`management\web`，执行：
|
||||
|
||||
```bash
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
启动前台交互系统：
|
||||
2. 启动前台交互系统：
|
||||
|
||||
启动后端：
|
||||
|
||||
项目根目录下执行：
|
||||
- 启动后端：项目根目录下执行：
|
||||
|
||||
```bash
|
||||
python -m api.ragflow_server
|
||||
```
|
||||
|
||||
启动前端：
|
||||
|
||||
进入到`web`，启动前端：
|
||||
- 启动前端：进入到`web`，执行：
|
||||
|
||||
```bash
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
## 🛠️ 如何贡献
|
||||
|
||||
## 交流群
|
||||
1. Fork 本仓库
|
||||
2. 创建您的特性分支 (`git checkout -b feature/AmazingFeature`)
|
||||
3. 提交您的更改 (`git commit -m 'Add some AmazingFeature'`)
|
||||
4. 推送到分支 (`git push origin feature/AmazingFeature`)
|
||||
5. 打开一个 Pull Request
|
||||
|
||||
|
||||
## 📄 交流群
|
||||
如果有其它需求或问题建议，可加入交流群进行讨论。
|
||||
|
||||
由于群聊超过200人，无法通过扫码加入，如需加群，加我微信zstar1003，备注"加群"即可。
|
||||
|
||||
## 鸣谢
|
||||
## 🚀 鸣谢
|
||||
|
||||
本项目基于以下开源项目开发：
|
||||
|
||||
|
|
@ -103,10 +108,12 @@ pnpm dev
|
|||
|
||||
- [v3-admin-vite](https://github.com/un-pany/v3-admin-vite)
|
||||
|
||||
## 更新信息获取
|
||||
- [minerU](https://github.com/opendatalab/MinerU)
|
||||
|
||||
## 💻 更新信息获取
|
||||
|
||||
目前该项目仍在持续更新中，更新日志会在我的微信公众号[我有一计]上发布，欢迎关注。
|
||||
|
||||
## Star History
|
||||
## ✨ Star History
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,114 @@
|
|||
<div align="center">
|
||||
<img src="assets/ragflow-plus.png" width="400" alt="Ragflow-Plus">
|
||||
<img src="https://img.shields.io/badge/version-0.2.1-blue" alt="Version">
|
||||
<a href="LICENSE"><img src="https://img.shields.io/badge/license-AGPL3.0-green" alt="License"></a>
|
||||
</div>
|
||||
|
||||
<div align="center">
|
||||
<h4>
|
||||
<a href="README.md">🇨🇳 Chinese</a>
|
||||
<span> | </span>
|
||||
<a href="README_EN.md">🇬🇧 English</a>
|
||||
</h4>
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## 🌟 Introduction
|
||||
|
||||
**Ragflow-Plus** is a secondary development project based on **Ragflow**, aiming to address practical application issues with the following features:
|
||||
|
||||
- **Management Mode**
|
||||
An additional backend management system is provided for user, team, config, file, and knowledge base management.
|
||||
|
||||
- **Permission Restriction**
|
||||
The frontend interface is simplified by reducing user access permissions.
|
||||
|
||||
- **Enhanced Parsing**
|
||||
Replaces the DeepDoc algorithm with **MinerU** for improved file parsing and support for image analysis.
|
||||
|
||||
- **Image & Text Output**
|
||||
Supports linking reference images to answer text blocks during responses.
|
||||
|
||||
- **Document Writing Mode**
|
||||
Offers a brand-new interactive document editing experience.
|
||||
|
||||
🎬 **Demo Video & Tutorial:**
|
||||
|
||||
[](https://www.bilibili.com/video/BV1UJLezaEEE)
|
||||
|
||||
## 📥 How to Use
|
||||
|
||||
### 1. Run with Docker Compose
|
||||
|
||||
Run from the root directory:
|
||||
|
||||
**Using GPU:**
|
||||
```bash
|
||||
docker compose -f docker/docker-compose_gpu.yml up -d
|
||||
```
|
||||
|
||||
**Using CPU::**
|
||||
|
||||
```bash
|
||||
docker compose -f docker/docker-compose.yml up -d
|
||||
```
|
||||
Access the frontend UI at: `your-server-ip:80`
|
||||
Access the admin dashboard at: `your-server-ip:8888`
|
||||
|
||||
📘 Step-by-step tutorial: [https://blog.csdn.net/qq1198768105/article/details/147475488](https://blog.csdn.net/qq1198768105/article/details/147475488)
|
||||
|
||||
#### 2. Run from Source Code (Docker is still required for MySQL, MinIO, Elasticsearch, etc.)
|
||||
|
||||
1. Start the Admin System:
|
||||
|
||||
- **Start the backend**: Navigate to `management/server` and run:
|
||||
```bash
|
||||
python app.py
|
||||
```
|
||||
|
||||
- **Start the frontend**: Navigate to `management/web` and run:
|
||||
```bash
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
2. Start the Frontend Interaction System:
|
||||
- **Start the backend**: From the project root directory, run:
|
||||
```bash
|
||||
python -m api.ragflow_server
|
||||
```
|
||||
|
||||
- **Start the frontend**: Navigate to `web` and run:
|
||||
```bash
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
## 🛠️ How to Contribute
|
||||
|
||||
1. Fork this repository
|
||||
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
|
||||
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
|
||||
4. Push to the branch (`git push origin feature/AmazingFeature`)
|
||||
5. Open a Pull Request
|
||||
|
||||
## 📄 Community Group
|
||||
|
||||
If you have additional needs, suggestions, or questions, feel free to join our community group for discussion.
|
||||
|
||||
⚠️ Note: Since the group has over 200 members, QR code join is disabled. To join, please add me on WeChat (ID: **zstar1003**) and include the note "Join Group".
|
||||
|
||||
## 🚀 Acknowledgments
|
||||
|
||||
This project is developed based on the following open-source projects:
|
||||
|
||||
- [ragflow](https://github.com/infiniflow/ragflow)
|
||||
- [v3-admin-vite](https://github.com/un-pany/v3-admin-vite)
|
||||
- [minerU](https://github.com/opendatalab/MinerU)
|
||||
|
||||
## 💻 Stay Updated
|
||||
|
||||
This project is under continuous development. Update logs will be posted on my WeChat public account **[我有一计]** — feel free to follow!
|
||||
|
||||
## ✨ Star History
|
||||
|
||||
|
||||
|
|
@ -1 +1,13 @@
|
|||
docker build -t zstar1003/ragflowplus:v0.2.1 .
|
||||
docker 镜像相关命令：
|
||||
前台镜像构建相关：
|
||||
docker build -t zstar1003/ragflowplus:v0.2.1 .
|
||||
docker tag zstar1003/ragflowplus:v0.2.1 zstar1003/ragflowplus:v0.2.1
|
||||
docker push zstar1003/ragflowplus:v0.2.1
|
||||
|
||||
后台镜像构建相关：
|
||||
cd management
|
||||
docker-compose build
|
||||
docker tag zstar1003/ragflowplus-management-web:v0.2.1 zstar1003/ragflowplus-management-web:v0.2.1
|
||||
docker tag zstar1003/ragflowplus-management-server:v0.2.1 zstar1003/ragflowplus-management-server:v0.2.1
|
||||
docker push zstar1003/ragflowplus-management-web:v0.2.1
|
||||
docker push zstar1003/ragflowplus-management-server:v0.2.1
|
||||
|
|
|
|||
Loading…
Reference in New Issue