Skillppx logo

RAGFlow open-source Retrieval-Augmented Generation (RAG) engine — deployment, configuration, management, and troubleshooting.

开源 RAG 引擎，支持本地部署与知识库管理。

已扫描
适合谁
AI 技术开发者、企业知识管理团队
不适合谁
无服务器环境的普通用户、无编程基础的初学者
国内可用性
需网络配置。可能需要网络配置或第三方服务可访问。
安装难度
偏难（★★★）。基于终端操作、依赖、API Key 和本地环境要求的初步判断。

安装与下载

openclaw skills install @openlark/open-ragflow
下载官方 ZIP

Skill 说明

命令、参数、文件名以原文为准

Open RAGFlow

开源的检索增强生成（RAG）引擎，融合了 RAG 与 Agent 能力。全栈架构：Python 后端（Flask）、React/TypeScript 前端，支持 Docker 部署的微服务模式。

使用场景

  • 通过 Docker Compose 或源码自部署/自托管 RAGFlow
  • 配置 RAGFlow（大语言模型提供商、API 密钥、文档引擎、端口等）
  • 使用 RAGFlow CLI 管理知识库、数据集、文档、Agent 和聊天会话
  • 理解 RAGFlow 架构（DeepDoc、Agent 系统、RAG 流水线）
  • 与 RAGFlow REST API 进行集成
  • 排查 RAGFlow 部署或运行时问题

快速参考

  • 官网: https://ragflow.io
  • 云端服务: https://cloud.ragflow.io
  • 文档: https://ragflow.io/docs/dev/
  • 代码仓库: https://github.com/infiniflow/ragflow
  • Discord 社区: https://discord.gg/NjYzJD3GM3
  • Docker Hub: infiniflow/ragflow
  • 许可证: Apache 2.0

何时使用哪种参考资料

  • 部署 / 排查部署问题 → [references/deployment.md](references/deployment.md)
  • 理解架构 / 组件 / 数据流 → [references/architecture.md](references/architecture.md)
  • 使用 CLI 管理数据集、Agent、模型 → [references/cli-reference.md](references/cli-reference.md)

先决条件

  • CPU ≥ 4 核，内存 ≥ 16 GB，磁盘空间 ≥ 50 GB
  • Docker ≥ 24.0.0 且 Docker Compose ≥ v2.26.1
  • Linux 系统需设置 vm.max_map_count ≥ 262144（用于 Elasticsearch）
  • gVisor：可选，仅在启用代码执行器（沙箱）功能时需要

Docker 部署（快速开始）

git clone https://github.com/infiniflow/ragflow.git
cd ragflow/docker
docker compose -f docker-compose.yml up -d
docker logs -f docker-ragflow-cpu-1  # 等待出现启动标语后登录
# 在浏览器中打开 http://YOUR_SERVER_IP

在 docker/service_conf.yaml.template 文件中配置 LLM API 密钥（位于 user_default_llm 下），然后重启服务：

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

中文镜像加速

若 Docker Hub 访问缓慢，可使用以下镜像源：

  • 华为云：swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow
  • 阿里云：registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow

如需设置 HuggingFace 镜像源，请在 docker/.env 中添加：HF_ENDPOINT=https://hf-mirror.com

关键配置文件

文件作用范围
docker/.env环境变量配置：SVR_HTTP_PORT、MYSQL_PASSWORD、MINIO_PASSWORD、DOC_ENGINE、RAGFLOW_IMAGE、HF_ENDPOINT
docker/service_conf.yaml.template后端服务配置：LLM 工厂、API 密钥、嵌入/重排序/ASR/TTS 模型
docker/docker-compose.yml整体服务编排
docker/docker-compose-base.yml仅包含基础设施服务（开发模式用）

部署后 LLM 设置

  1. 通过浏览器登录系统
  2. 编辑 docker/service_conf.yaml.template 文件：
   user_default_llm:
     factory: "OpenAI"   # 或 "DeepSeek"、"Gemini" 等
     api_key: "sk-..."
     base_url: "https://api.openai.com/v1/"
  1. 执行以下命令以应用更改：
docker compose -f docker-compose.yml up -d

CLI 快速参考

所有 CLI 命令均以分号 ; 结尾。完整参考请见：[references/cli-reference.md](references/cli-reference.md)。

# 数据集操作
LIST DATASETS;
CREATE DATASET 'my_kb' WITH EMBEDDING 'text-embedding-ada-002' PARSER 'pdf';
DROP DATASET 'my_kb';
LIST FILES OF DATASET 'my_kb';

# 文档操作
IMPORT '/path/to/doc.pdf' INTO DATASET 'my_kb';
PARSE DATASET 'my_kb' SYNC;
PARSE DATASET 'my_kb' ASYNC;

# 搜索
SEARCH 'What is RAG?' ON DATASETS 'my_kb';

# 模型管理
CREATE MODEL PROVIDER 'openai' 'sk-...';
SET DEFAULT LLM 'gpt-4';
LIST MODEL PROVIDERS;
LIST DEFAULT MODELS;

# Agent 与聊天会话
LIST AGENTS;
LIST CHATS;
CREATE CHAT 'my_session';
DROP CHAT 'my_session';

# 连接测试
PING;
SHOW CURRENT USER;

切换文档引擎（Elasticsearch → Infinity）

docker compose -f docker/docker-compose.yml down -v  # 警告：此操作将清除所有数据
# 修改 docker/.env：设置 DOC_ENGINE=infinity
docker compose -f docker-compose.yml up -d

Infinity 引擎更轻量，但目前不正式支持 Linux/arm64 平台。

架构概览

Web UI (React+TS+vitejs+shadcn) → Flask API (/api/) → RAG Core (/rag/) + Agent (/agent/)
                                                          ↓
基础设施：MySQL + Elasticsearch/Infinity + Redis + MinIO
  • 后端 (/api/)：Flask 蓝图 —— kb、dialog、document、canvas、file、user
  • RAG 核心 (/rag/)：DeepDoc 解析、LLM/嵌入/重排序 抽象层、文本切块、GraphRAG
  • Agent 系统 (/agent/)：基于画布的工作流构建器，支持组件（LLM、检索、代码执行器、MCP、搜索、SQL）
  • 前端 (/web/)：React 18 + TypeScript + Vite

详细组件说明请参见：[references/architecture.md](references/architecture.md)

从源码开发

git clone https://github.com/infiniflow/ragflow.git && cd ragflow
uv sync --python 3.12 && uv run python3 download_deps.py
docker compose -f docker/docker-compose-base.yml up -d
# 添加至 /etc/hosts：127.0.0.1 es01 infinity mysql minio redis sandbox-executor-manager
source .venv/bin/activate && export PYTHONPATH=$(pwd)
bash docker/launch_backend_service.sh
# 另开终端：
cd web && npm install && npm run dev

故障排查快速参考

问题解决方法
浏览器提示 network abnormal等待 Docker 日志显示 RAGFlow 启动标语 —— 服务器正在初始化
中国地区 Docker 拉取超时使用 RAGFLOW_IMAGE 镜像源（华为云 / 阿里云）
HuggingFace 无法访问设置 export HF_ENDPOINT=https://hf-mirror.com
ARM64 平台从源码构建 Docker 镜像（无官方 ARM64 镜像）
端口冲突修改 docker-compose.yml 中的 80:80 为 <PORT>:80
Elasticsearch 退出码 137增加 Docker 内存分配
vm.max_map_count 过低执行 sudo sysctl -w vm.max_map_count=262144

API 与 SDK

  • REST API：http://SERVER_IP/api/ — Swagger 文档位于 /api/docs
  • Python SDK：位于 sdk/python/ 目录下
  • CLI 客户端：python admin/client/ragflow_cli.py <command>
  • 使用指南：[https://ragflow.io/docs/dev/](https://ragflow.io/docs/dev/)
O
@openlark

已收录 25 个 Skill

相关推荐