ApeRAG

ApeRAG is a production-ready RAG (Retrieval-Augmented Generation) platform that combines Graph RAG, vector search, and full-text search with advanced AI agents. Build sophisticated AI applications with hybrid retrieval, multimodal document processing, intelligent agents, and enterprise-grade management features.

ApeRAG is the best choice for building your own Knowledge Graph, Context Engineering, and deploying intelligent AI agents that can autonomously search and reason across your knowledge base.

阅读中文文档

• Quick Start
• Key Features
• Kubernetes Deployment (Recommended for Production)
• Development
• Build Docker Image
• Acknowledgments
• License

Quick Start

Before installing ApeRAG, make sure your machine meets the following minimum system requirements:

• CPU >= 2 Core
• RAM >= 4 GiB
• Docker & Docker Compose

The easiest way to start ApeRAG is through Docker Compose. Before running the following commands, make sure that Docker and Docker Compose are installed on your machine:

git clone https://github.com/apecloud/ApeRAG.git
cd ApeRAG
cp envs/env.template .env
docker-compose up -d --pull always

After running, you can access ApeRAG in your browser at:

• Web Interface: http://localhost:3000/web/
• API Documentation: http://localhost:8000/docs

MCP (Model Context Protocol) Support

ApeRAG supports MCP (Model Context Protocol) integration, allowing AI assistants to interact with your knowledge base directly. After starting the services, configure your MCP client with:

{
  "mcpServers": {
    "aperag-mcp": {
      "url": "http://localhost:8000/mcp/",
      "headers": {
        "Authorization": "Bearer your-api-key-here"
      }
    }
  }
}

Authentication (by priority):

1. HTTP Authorization Header (Recommended): Authorization: Bearer your-api-key
2. Environment Variable (Fallback): APERAG_API_KEY=your-api-key

Important: Use your deployed API origin if not local (e.g. https://your-host/mcp/). Replace your-api-key-here with a valid API key from your ApeRAG settings.

The MCP server provides:

• Collection browsing: List and explore your knowledge collections
• Hybrid search: Search using vector, full-text, and graph methods
• Intelligent querying: Ask natural language questions about your documents

Enhanced Document Parsing

For enhanced document parsing capabilities, ApeRAG supports an advanced document parsing service powered by MinerU, which provides superior parsing for complex documents, tables, and formulas.

Enhanced Document Parsing Commands

# Enable advanced document parsing service
DOCRAY_HOST=http://aperag-docray:8639 docker compose --profile docray up -d

# Enable advanced parsing with GPU acceleration 
DOCRAY_HOST=http://aperag-docray-gpu:8639 docker compose --profile docray-gpu up -d

Or use the Makefile shortcuts (requires GNU Make):

# Enable advanced document parsing service
make compose-up WITH_DOCRAY=1

# Enable advanced parsing with GPU acceleration (recommended)
make compose-up WITH_DOCRAY=1 WITH_GPU=1