📋 官方信息
| 项目名称 | Quivr |
| 仓库地址 | https://github.com/QuivrHQ/quivr |
| 官方网站 | https://www.quivr.app |
| 最新更新 | 2026年10月 |
| 项目定位 | 开源 RAG 框架,构建你的第二大脑,与文档对话 |
🎯 项目背景
Quivr 是一个开源的生成式 AI"第二大脑"框架,由 Stan Girard 创建。它的核心理念是:把你的所有文档(PDF、CSV、文本、网页等)上传到系统中,然后用自然语言与这些文档对话,AI 会自动检索相关内容并给出基于你资料的回答。这就是所谓的 RAG(检索增强生成)技术。
Quivr 基于 LangChain 构建,支持 OpenAI GPT、Anthropic Claude、Ollama 本地模型、Groq 等多种 LLM 后端。它不仅是一个个人知识库工具,还可以作为团队的知识管理平台,支持多人共享知识库。项目在 GitHub 上获得了超过 3 万 Star,是 RAG 领域最受欢迎的开源项目之一。
✨ 核心特性
- 多格式文档支持:PDF、CSV、Excel、Word、PPT、TXT、Markdown 等
- RAG 检索增强:自动文档分块、向量化、语义检索
- 多 LLM 后端:OpenAI、Anthropic、Ollama(本地模型)、Groq、VertexAI
- 团队协作:支持创建多个知识库,与团队成员共享
- 聊天界面:类似 ChatGPT 的对话式界面,支持引用溯源
- API 接口:提供 REST API,可集成到其他应用
- 私有化部署:完整自托管,数据不出本地服务器
- 多用户管理:内置用户注册、登录、权限管理
💻 环境要求
- Docker 部署:Docker 20.10+,Docker Compose v2+,内存 4GB 以上(推荐 8GB)
- 磁盘空间:至少 10GB(含向量数据库和模型)
- API 密钥:需要 OpenAI API Key 或其他 LLM 提供商密钥
- Supabase:使用托管版 Supabase 或本地自托管 Supabase
🚀 详细部署步骤
方式一:Docker Compose 部署(推荐)
# 1. 克隆仓库
git clone https://github.com/QuivrHQ/quivr.git
cd quivr
# 2. 复制环境变量文件
cp .env.example .env
# 3. 编辑 .env 文件,填入必要的配置
# 至少需要配置:
# OPENAI_API_KEY=sk-你的OpenAI密钥
# SUPABASE_URL=你的Supabase项目URL
# SUPABASE_ANON_KEY=你的Supabase匿名密钥
# SUPABASE_SERVICE_KEY=你的Supabase服务密钥
# 4. 拉取镜像并启动
docker compose pull
docker compose up -d --build方式二:使用 Ollama 本地模型
如果你不想使用 OpenAI API,可以用 Ollama 运行本地模型:
# 1. 先启动 Ollama 并拉取模型
ollama pull llama3.1
ollama run llama3.1
# 2. 使用 Ollama 版本的 docker-compose
docker compose -f docker-compose-ollama.yml up -d --build📝 环境变量详细说明
编辑 .env 文件:
# OpenAI 配置(必需)
OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxx
# Supabase 配置(必需,用于数据库和认证)
# 前往 https://supabase.com 创建免费项目
SUPABASE_URL=https://xxxxx.supabase.co
SUPABASE_ANON_KEY=eyJhbGciOi...
SUPABASE_SERVICE_KEY=eyJhbGciOi...
# 前端配置
NEXT_PUBLIC_BACKEND_URL=http://localhost:5050
NEXT_PUBLIC_FRONTEND_URL=http://localhost:3000
# 可选:Anthropic Claude
ANTHROPIC_API_KEY=sk-ant-xxxxxxxx
# 可选:Groq
GROQ_API_KEY=gsk_xxxxxxxx🔧 Supabase 准备
Quivr 使用 Supabase 作为后端数据库和认证服务。你需要:
- 前往 supabase.com 注册账号
- 创建一个新项目(免费套餐即可)
- 在项目设置中获取 URL、anon key、service key
- 运行数据库迁移脚本(Quivr 仓库中提供)
✅ 启动验证
- 前端访问:
http://localhost:3000 - API 访问:
http://localhost:5050 - 首次访问注册账号
- 创建一个 Brain(知识库)
- 上传一份 PDF 文档
- 等待文档处理完成,然后提问测试
⚠️ 常见坑
- Mac 用户需要在 Docker Desktop 设置中开启 VirtioFS 文件共享
- 首次启动需要拉取多个镜像(后端、前端、worker),耐心等待
- 确保 Supabase 项目已启用邮箱认证(Auth → Providers → Email)
- 如果文档上传后一直"Processing",检查 worker 容器日志:
docker compose logs worker
📖 使用方法
创建知识库(Brain)
登录后点击"Create Brain",输入知识库名称和描述。每个 Brain 是一个独立的知识库空间。
上传文档
进入某个 Brain,点击"Upload Content",选择本地文件或粘贴网页 URL。系统会自动分块、向量化并存入数据库。
与文档对话
在聊天界面输入问题,AI 会从你的知识库中检索相关内容,生成带有引用来源的回答。点击引用可以查看原文片段。
❓ 常见问题
Q1: 一定要用 Supabase 吗?
A: 是的,Quivr 目前深度依赖 Supabase 提供数据库、认证和存储功能。你可以使用托管版 Supabase 或自托管。
Q2: 支持中文文档吗?
A: 支持。文档的文本提取和分块不区分语言,Embedding 模型使用 OpenAI 的 text-embedding-3-small,对中文支持良好。
Q3: 本地部署需要多大内存?
A: 使用 OpenAI API 时约需 4GB 内存。如果使用 Ollama 本地模型,建议 16GB 以上内存。
Q4: 如何添加更多文档?
A: 在 Brain 管理页面持续上传即可,系统会自动将新文档添加到向量索引中。
Q5: 免费额度够用吗?
A: Supabase 免费套餐提供 500MB 数据库存储和 2GB 文件存储,个人使用足够。OpenAI API 按用量计费。
🔗 跳转链接
- GitHub 仓库:https://github.com/QuivrHQ/quivr
- 官方网站:https://www.quivr.app
- 官方文档:https://docs.quivr.app
- Supabase:https://supabase.com