RAGflow/README_EN.md

3.5 KiB

Ragflow-Plus Version License

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

💻 Stay Updated

This project is under continuous development. Update logs will be posted on my WeChat public account [我有一计] — feel free to follow!

Star History

Stargazers over time