项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
技术标签
使用教程
—
环境要求
- 已安装 Docker 与 Docker Compose(需能执行 docker compose 命令)
- 可访问 GitHub 与 Docker Hub 的网络环境
- 首次启动前准备一个随机 MANAGEMENT_JWT_SECRET(至少 32 字节)
- 首次启动前准备一个非默认的 MANAGEMENT_ADMIN_PASSWORD(至少 12 个字符)
安装与启动步骤
-
1获取项目代码
从 GitHub 克隆仓库到本地,docker/docker-compose.yml 就在仓库里,必须一并拉取
git clone https://github.com/zstar1003/ragflow-plus.git -
2进入项目目录
切换到仓库根目录,后续 docker compose 命令基于仓库内的相对路径执行
cd ragflow-plus -
3配置管理后台密钥
首次启动或升级前必须设置独有的随机 MANAGEMENT_JWT_SECRET 和非默认的 MANAGEMENT_ADMIN_PASSWORD,具体配置方式见 docs/security/jwt-secret.md
-
4启动全部服务
使用仓库自带的 compose 文件一键拉起服务,-d 表示后台运行;首次会拉取镜像耗时较长
docker compose -f docker/docker-compose.yml up -d
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
MANAGEMENT_JWT_SECRET | 是 | 管理后台 JWT 签名密钥,必须为独有的随机值,至少 32 字节 | a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 |
MANAGEMENT_ADMIN_PASSWORD | 是 | 管理后台管理员密码,不可使用默认值,至少 12 个字符 | Ragflow@2024Admin |
如何确认成功
执行 docker compose -f docker/docker-compose.yml ps,各容器状态为 running 且日志无密钥报错,即启动成功;访问地址与端口以项目文档 xdxsb.top/ragflow-plus 为准。
常见问题
Q:启动时报 JWT 密钥或管理员密码相关错误怎么办?
A:说明未配置合格的认证参数。请先设置至少 32 字节的随机 MANAGEMENT_JWT_SECRET 和至少 12 个字符的非默认 MANAGEMENT_ADMIN_PASSWORD,再重新启动,详见 docs/security/jwt-secret.md。
Q:使用过程中遇到问题去哪查?
A:先看 docs/question/README.md 常见问题与仓库 issue;仍未解决可用 DeepWiki 或 zread 与 AI 助手交流,或直接提交 issue,会有 AI 助手自动解答。
Q:这个项目可以商用吗?
A:可以商用。项目遵循 AGPLv3,允许 SaaS 和企业内部部署,但作为网络服务提供时需提供完整对应源码;若要闭源商用需取得所有代码版权持有人书面授权。
注意事项
- 首次启动或升级前必须先配置 MANAGEMENT_JWT_SECRET 与 MANAGEMENT_ADMIN_PASSWORD,否则可能出现认证问题。
- 项目基于 AGPLv3,若通过网络服务对外提供,需按第 13 条允许用户获取对应源码。
- 完整安装、升级与操作教程请以官方项目文档 xdxsb.top/ragflow-plus 为准。
- README 未给出对外访问端口与服务地址,请以项目文档说明为准。
核心亮点
- 基于 Ragflow 二次开发,保留成熟文档解析与检索能力,同时精简掉企业级重功能,部署和上手更快
- Python 技术栈,代码结构相对清晰,方便开发者按需裁剪和二次开发
- 聚焦简洁实用,适合个人或小团队快速验证 RAG 知识库方案,维护成本低于原版
不足之处
- 作为二次开发分支,功能完整度和长期维护依赖上游 Ragflow 及作者投入,稳定性待观察
- 社区规模和文档丰富度不及原版 Ragflow,遇到问题可参考的资料较少
适用场景
- 个人或小团队快速搭建私有文档知识库问答系统
- 企业内部资料检索助手的原型验证与快速上线
- 开发者学习 RAG 流程并做定制化二次开发
替代项目
Ragflow、Dify、FastGPT
上一篇:tern
下一篇:RAG_langchain
同类项目推荐
firecrawl
开源
网页抓取像喝水一样简单,开发者省下整周加班
Supercharge your AI agents with data from the web and beyond. Building the library f···
contoso-chat
开源
一键跑通 Azure RAG 应用,从代码到评估部署全流程
This sample has the full End2End process of creating RAG application with Prompty an···
graphify
开源
整个代码库画成一张图,找问题一眼定位
Turn any codebase, with its docs, SQL schemas, configs, and PDFs, into a queryable k···
WeKnora
开源
文档往里一扔,自动变成啥都能答的知识库
Open-source LLM knowledge platform: turn raw documents into a queryable RAG, an auto···
