rag-web-ui

上传文档,即刻拥有一个能聊天的知识库助手

RAG Web UI 是一个基于检索增强生成(RAG)技术的智能对话系统,旨在为开发者提供一套开箱即用的知识库问答界面。它解决了从零搭建 RAG 应用时前端和后端割裂、配置复杂的问题,将文档上传、向量检索、大模型对话等核心流程整合在一个 Web 应用中。项目采用 TypeScript 编写,技术栈现代,支持多种文档格式,提供可视化配置界面,用户无需深入底层即可快速部署一个具备上下文感知能力的聊天机器人。其核心能力包括文档解析、向量化存储、相似度检索、对话生成以及可定制的 UI 组件,适合用于企业内部知识库、客服助手、个人学习助手等场景。

开源 free 搜索知识
访问官网 ↗ GitHub ↗ 文档 ↗
GitHub 星标 ★ 3293
维护状态 低维护
是否开源 是
定价模式 free

项目数据

分类搜索知识
开发团队rag-web-ui
所属国家
官网地址
定价模式free
价格说明开源项目,基于Apache-2.0许可证,可自行部署使用,无付费版本。
访问状态
是否开源是
开源协议Apache-2.0
主要语言TypeScript
技术栈/模型ai,deepseek,langchain,ollama,rag
GitHub 星标★ 3293
30天Star增速
HF 下载量
上线时间2025-01-14 00:00:00
最近更新2026-09-23 00:00:00
维护状态低维护
中文支持
访问方式
移动端支持
综合评分
收录时间2026-08-09
浏览次数1

使用教程

难度:入门 约 10 分钟 部署方式:Docker 4 步

环境要求

  • Python 3.9 及以上(后端运行环境)
  • Node.js 18 及以上(前端运行环境)
  • 已安装 Docker 与 Docker Compose 命令
  • 具备可用的 LLM 服务凭证(如 OpenAI / DeepSeek API Key,或本地 Ollama)

安装与启动步骤

  1. 1克隆代码仓库

    把项目源码拉到本地并进入项目根目录,后续所有命令都在该目录下执行。

    git clone https://github.com/rag-web-ui/rag-web-ui.git
    cd rag-web-ui
  2. 2复制环境变量模板

    把仓库自带的 .env.example 复制成 .env,这是后续所有配置的入口文件。

    cp .env.example .env
  3. 3填写核心配置

    编辑 .env:必填 MySQL 地址账号密码、SECRET_KEY;再按所用模型填 LLM、Embedding、向量库、MinIO 参数。

  4. 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

项目介绍

rag-web-ui 是搜索知识领域的开源项目,由 rag-web-ui 开发,2025 年首次发布。

在全站 13,090 个收录项目中,它的 GitHub 星标数(3,293)位列前 30%,在搜索知识分类的 585 个项目里位列前 14%。

近 42 天,它的 GitHub 星标从 3,257 增加到 3,293,净增 36。

项目已超过三个月没有代码更新,维护节奏明显放缓,最近一次代码更新于 2026-09-23。基于Apache-2.0许可证,可自行部署使用,无付费版本。

它主要面向的使用场景是:企业内部知识库问答,员工快速查询规章制度或技术文档。同类可对比的替代方案包括 Dify、FastGPT、RAGFlow。

上一篇:VideoRAG

下一篇:trieve

同类项目推荐

firecrawl 开源

网页抓取像喝水一样简单,开发者省下整周加班

The web data API to search, scrape, and interact at scale.

★ 183325 2026-08-09
contoso-chat 开源

一键跑通 Azure RAG 应用,从代码到评估部署全流程

This sample has the full End2End process of creating RAG application with Prompty an···

★ 766 2026-08-09
graphify 开源

整个代码库画成一张图,找问题一眼定位

Turn any codebase, with its docs, SQL schemas, configs, and PDFs, into a queryable k···

★ 120493 2026-08-09
ragflow 开源

让大模型用上你的私有知识,搭建可靠的企业级RAG应用

RAGFlow is a leading open-source Retrieval-Augmented Generation (RAG) engine that fu···

★ 91170 2026-08-09