Skip to content

基于ragflow二次开发的后台管理系统,可以独立运行,支持批量管理知识库、聊天、智能体、用户等,解决ragflow在后台管理上的痛点。

License

Notifications You must be signed in to change notification settings

tedhappy/ragflow-admin

Repository files navigation

RAGFlow logo

RAGFlow Admin

English | 简体中文

Latest Release RAGFlow Version License

A standalone administration console for RAGFlow


🔎 Overview

RAGFlow Admin is a lightweight, standalone administration console for RAGFlow — the leading open-source RAG engine with deep document understanding. It provides a modern web interface for centralized management of datasets, documents, chat assistants, agents, and users.

Why RAGFlow Admin?

RAGFlow is a powerful RAG engine, but its built-in management interface has some limitations for production use:

Pain Point RAGFlow Admin Solution
Single dataset view Cross-dataset dashboard for unified management
No batch operations Bulk upload, parse, stop, and delete across datasets
Hidden task queue Real-time task monitoring with queue position and progress
Complex user management Centralized user admin panel with statistics
Limited operational insight Dashboard with health checks and usage metrics
Steep learning curve Intuitive UI designed for administrators

✨ Features

Core Management

Feature Description
📚 Dataset Management View all datasets across users, create, delete with batch operations
📄 Document Management Upload, parse, stop, delete documents with real-time progress tracking
📊 Task Queue Global task monitoring across all datasets with queue position, filtering and batch control

Extended Capabilities

Feature Description
💬 Chat Management View and manage chat assistants and conversation sessions
🤖 Agent Management List and manage AI agents across users
👥 User Management View RAGFlow users with statistics (requires MySQL access)
🔍 System Monitoring Dashboard with service health checks and usage statistics
🌐 i18n Support Full internationalization (English & Chinese)

🖼️ Screenshots

Dashboard

Dashboard

Task Queue

Task Queue

Dataset Management

Datasets

Document Management

Documents

Chat Management

Chats

User Management

Users

Settings

Settings

🚀 Getting Started

Prerequisites

  • A running RAGFlow instance (v0.15+)
  • Docker 20.10+ & Docker Compose 2.0+ (for Docker deployment)
  • Python 3.10+ & Node.js 18+ (for source deployment)

🐳 Docker Deployment (Recommended)

$ git clone https://github.com/tedhappy/ragflow-admin.git
$ cd ragflow-admin/docker
$ docker compose -f docker-compose.yml up -d

Check server status:

$ docker logs -f ragflow-admin

Open http://localhost:8000, login with admin/admin, and configure MySQL via Settings page.

See docker/README.md for advanced configuration.

🔧 Source Deployment (Development)

1. Clone and Configure

$ git clone https://github.com/tedhappy/ragflow-admin.git
$ cd ragflow-admin
$ cp conf/config.example.yaml conf/config.yaml

2. Start Backend

$ pip install -r requirements.txt
$ python -m api.server

3. Start Frontend

$ cd web
$ npm install
$ npm run dev

Open http://localhost:8000 to access the admin console.

🏗️ Architecture

ragflow-admin/
├── api/                        # Backend (Python/Quart)
│   ├── apps/                   # API route handlers
│   ├── services/               # Business logic
│   └── server.py               # Application entry point
│
├── web/                        # Frontend (React/UmiJS)
│   └── src/
│       ├── pages/              # Page components
│       ├── components/         # Reusable UI components
│       ├── services/           # API client
│       └── locales/            # i18n translations
│
├── docker/                     # Docker configuration
│   ├── docker-compose.yml      # Docker Compose file
│   ├── .env                    # Environment variables
│   ├── entrypoint.sh           # Container entrypoint
│   ├── spa_server.py           # Frontend SPA server
│   └── README.md               # Docker deployment guide
│
├── conf/                       # Configuration files
├── Dockerfile                  # Docker build file
└── docs/                       # Documentation

🛠️ Tech Stack

Layer Technology
Backend Python 3.10+ / Quart
RAGFlow Integration ragflow-sdk
Frontend React 18 / UmiJS 4 / TypeScript
UI Components Ant Design 5
Styling TailwindCSS 4
State Management React Query / Zustand
i18n i18next
Database MySQL

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the 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

Related Links

📄 License

This project is licensed under the Apache License 2.0.


If you find this project helpful, please consider giving it a ⭐️

About

基于ragflow二次开发的后台管理系统,可以独立运行,支持批量管理知识库、聊天、智能体、用户等,解决ragflow在后台管理上的痛点。

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published