Go to file
zstar ae462bc9dc chore: 上传源码部署缺失的trie文件 2025-07-10 15:34:28 +08:00
.github fix:修复图像文本块关联异常问题 (#78) 2025-05-11 21:28:39 +08:00
agentic_reasoning up to v0.17.2_supple (#7) 2025-03-31 10:53:42 +08:00
api chores: 调整解析文件结构,增强可读性 2025-06-12 22:17:41 +08:00
conf up to v0.17.2_supple (#7) 2025-03-31 10:53:42 +08:00
docker build(bulid_order.txt): 更新 Docker 镜像版本至 v0.4.3 2025-06-13 21:08:05 +08:00
docs docs(question): 添加关于后台知识库连接测试的问题和解答 2025-06-23 17:03:38 +08:00
graphrag up to v0.17.2_supple (#7) 2025-03-31 10:53:42 +08:00
management chore: 上传源码部署缺失的trie文件 2025-07-10 15:34:28 +08:00
rag chore: 上传源码部署缺失的trie文件 2025-07-10 15:34:28 +08:00
sdk/python chores: 删除后端agent相关内容 2025-06-06 22:34:14 +08:00
web chores: 调整助理头像 2025-06-13 13:37:50 +08:00
.dockerignore refactor(docker): 重构Docker配置以优化镜像构建和管理 (#37) 2025-04-19 20:43:46 +08:00
.gitattributes 首次提交 2025-03-24 11:19:28 +08:00
.gitignore chore: 上传源码部署缺失的trie文件 2025-07-10 15:34:28 +08:00
.python-version chores: 经测试,docker环境中,聊天窗口动态调节字体仍无法正常工作,特将其移除 2025-06-07 22:35:06 +08:00
CONTRIBUTING.md docs: 创建官网,更新文档 (#67) 2025-04-30 17:29:03 +08:00
Dockerfile refactor(env): 重构环境变量加载方式,修复前端无法动态获取环境变量的问题 2025-06-10 00:20:44 +08:00
LICENSE 切换 LICENSE 2025-04-17 10:02:50 +08:00
README.md docs(faq): 补充RedisDB相关问题 2025-06-17 11:06:53 +08:00
README_EN.md docs(faq): 补充RedisDB相关问题 2025-06-17 11:06:53 +08:00
pyproject.toml refactor(env): 重构环境变量加载方式,修复前端无法动态获取环境变量的问题 2025-06-10 00:20:44 +08:00
requirements.txt build: 相关依赖版本,解决冲突问题issue#158 2025-06-10 00:30:04 +08:00

README_EN.md

Ragflow-Plus

🌟 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:

Ragflow-Plus Project Overview & Guide

📥 How to Use

1. Run with Docker Compose

Run from the root directory:

Using GPU:

docker compose -f docker/docker-compose_gpu.yml up -d

Using CPU::

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

2. Run from Source Code (Docker is still required for MySQL, MinIO, Elasticsearch, Redis, etc.)

  1. Start the Admin System:
  • Start the backend: Navigate to management/server and run:
python app.py
  • Start the frontend: Navigate to management/web and run:
pnpm dev
  1. Start the Frontend Interaction System:
  • Start the backend: From the project root directory, run:
python -m api.ragflow_server
  • Start the frontend: Navigate to web and run:
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:

📜 License and Usage Restrictions

  1. This Repository is Licensed Under AGPLv3
    As it incorporates third-party AGPLv3 code, this project must fully comply with AGPLv3 terms. This means:

    • Any derivative works (including modifications or combined code) must remain under AGPLv3 with source code publicly available.
    • If provided as a network service, users are entitled to obtain the corresponding source code.
  2. Commercial Use

    • Allowed: This software is licensed under AGPLv3, permitting commercial use, including SaaS and on-premises deployment.
    • Unmodified Code: If used as-is (no modifications/derivative works), AGPLv3 compliance remains mandatory:
      • Provide complete source code (even if unaltered).
      • For network services, users must be able to download corresponding source code (AGPLv3 §13).
    • No Closed-Source Commercialization: To use modified versions without releasing source code commercially, written authorization from all copyright holders (including upstream AGPLv3 authors) is required.
  3. Disclaimer
    This project comes with no warranties. Users shall bear all compliance risks. Consult legal professionals for legal advice.

Star History

Stargazers over time