
rag-web-ui
上传文档,即刻拥有一个能聊天的知识库助手
项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 3297
使用教程
环境要求
- Python 3.9 及以上(后端运行环境)
- Node.js 18 及以上(前端运行环境)
- 已安装 Docker 与 Docker Compose 命令
- 具备可用的 LLM 服务凭证(如 OpenAI / DeepSeek API Key,或本地 Ollama)
安装与启动步骤
-
1克隆代码仓库
把项目源码拉到本地并进入项目根目录,后续所有命令都在该目录下执行。
git clone https://github.com/rag-web-ui/rag-web-ui.git cd rag-web-ui -
2复制环境变量模板
把仓库自带的 .env.example 复制成 .env,这是后续所有配置的入口文件。
cp .env.example .env -
3填写核心配置
编辑 .env:必填 MySQL 地址账号密码、SECRET_KEY;再按所用模型填 LLM、Embedding、向量库、MinIO 参数。
-
4启动全部服务
用 Docker Compose 构建镜像并后台启动服务,首次构建会拉取依赖,耗时较长属正常。
docker compose up -d --build
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
SECRET_KEY | 是 | JWT 签名密钥,用于用户登录令牌加密,必填。 | sk-xxxxxxxxxxxxxxxx |
MYSQL_SERVER | 是 | MySQL 服务地址,默认 localhost,容器部署时需指向数据库容器。 | localhost |
MYSQL_USER | 是 | MySQL 用户名,README 默认值为 postgres。 | postgres |
CHAT_PROVIDER | 是 | 对话大模型服务商,可选 openai、deepseek、ollama、minimax。 | openai |
OPENAI_API_KEY | 否 | 使用 OpenAI 或 OpenAI Embedding 时必填的 API 密钥。 | sk-xxxxxxxxxxxxxxxx |
VECTOR_STORE_TYPE | 是 | 向量库类型,默认 chroma,也可切换为 qdrant。 | chroma |
如何确认成功
执行 docker compose ps,确认各容器处于运行状态且日志无报错,即表示服务启动成功。
常见问题
Q:不想用 OpenAI,可以用本地模型吗?
A:可以。把 CHAT_PROVIDER 设为 ollama,并配置 OLLAMA_API_BASE(默认 http://localhost:11434)和 OLLAMA_MODEL(默认 llama2)。
Q:想换成 DeepSeek 对话怎么配?
A:将 CHAT_PROVIDER 设为 deepseek,再填写 DEEPSEEK_API_KEY、DEEPSEEK_API_BASE 和 DEEPSEEK_MODEL 三个参数。
Q:向量数据库必须用 Chroma 吗?
A:不是。VECTOR_STORE_TYPE 默认 chroma,可改为 qdrant,并配置 QDRANT_URL(默认 http://localhost:6333)。
Q:MySQL 默认账号密码是什么?
A:README 中默认用户和密码均为 postgres,数据库名为 ragwebui,生产环境务必修改。
注意事项
- .env 中含 API Key 与数据库密码,请勿提交到 Git 仓库。
- 正式环境请修改 MySQL 默认密码并重新生成 SECRET_KEY。
- 对象存储 MinIO 默认 Access/Secret Key 均为 minioadmin,需按需替换。
- 可选设置 TZ 调整时区,默认 Asia/Shanghai。
核心亮点
- 开箱即用,提供完整的 Web 界面,无需前端开发即可快速部署 RAG 对话系统
- 支持多种文档格式(如 PDF、Word、TXT),内置解析和向量化流程,简化数据接入
- 基于 TypeScript,代码结构清晰,易于二次开发和集成到现有项目
不足之处
- 文档/社区待观察
- 对于超大规模知识库,检索性能和准确率可能受限于底层向量数据库的配置
适用场景
- 企业内部知识库问答,员工快速查询规章制度或技术文档
- 个人学习助手,上传教材或笔记,进行智能问答和复习
- 客服自动回复,基于产品手册或FAQ构建智能客服机器人
替代项目
Dify、FastGPT、RAGFlow
同类项目推荐
RAGU
开源
用图结构增强检索,让 AI 回答更懂关联关系。
[EMNLP 2026] Modular GraphRAG framework
coding_agent_session_search
开源
一个终端工具,搜遍所有 AI 编码助手的聊天记录。
Unified TUI and CLI to index and search your local coding agent session history acro···
storm
开源
输入主题,自动生成带引用的长文报告
An LLM-powered knowledge curation system that researches a topic and generates a ful···
raptor
开源
把文档建树,检索时既能看细节又能看全局
The official implementation of RAPTOR: Recursive Abstractive Processing for Tree-Org···
fess
开源
自建一个搜索,公司文档网页全都能翻
Open-source, self-hosted enterprise & site search server built on OpenSearch. Crawls···
PapersChat
开源
和你的论文对话,还能顺手查遍 ArXiv 和 PubMed
An agentic AI application that allows you to chat with your papers and gather also i···
php-rag
开源
用 PHP 给 LLM 接上你的文档库,问答更精准
This application uses LLMs like DeepSeek, GPT-5, Claude, Gemini or Llama, Mixtral (l···
gfm-rag
开源
给 RAG 装上图神经网络,让检索更懂关系
[NeurIPS'25, ICLR'26] Graph Foundation Model for Retrieval Augmented Generation
local-rag
开源
本地私有化部署,让敏感文档也能安全做 RAG 问答
Ingest files for retrieval augmented generation (RAG) with open-source Large Languag···