34 KiB
项目介绍 · 快速开始 · 最新更新 · 功能概览 · 客户端与生态 · 文档 · 开发指南
项目介绍
WeKnora(维娜拉) 是一款开源的、基于大语言模型(LLM)的知识管理框架,面向企业级文档理解、语义检索与智能推理场景。它把团队分散的文档汇集起来,用于检索、推理,并随资料更新持续维护。
https://github.com/user-attachments/assets/5722b10d-d04d-49ed-a6cc-635a8c77d91f
1 分 52 秒 · 1080p · 无旁白,英文画面文字
查询资料用 RAG,处理多步任务用 Agent,整理知识用 Wiki。三种能力共享同一知识库。
Agent 的工具箱。 技能可从 ClawHub / SkillHub / Git / ZIP 安装,在会话级持久的 Docker / E2B / Cube 沙箱中运行,对话旁可打开交互式终端与图形桌面。借助 BrowserSkill 扩展,Agent 可以操作用户自己的 Chrome / Edge;外部 MCP 服务(支持 OAuth)可以接入,并按工具逐个启用。
除此之外:
- 记忆与知识整理:跨会话长期记忆保存用户确认过的个人信息、偏好与事实;文件夹上传保留原始目录结构;检索分块可以编辑、比对与回滚。
- 数据源与格式:飞书知识库 / 飞书云盘 / Confluence / GitLab / 腾讯 IMA / Notion / 语雀 / 钉钉文档 / Seafile / RSS 自动同步,更多数据源持续接入中;覆盖 PDF、Word、图片、Excel、XMind 等十余种格式,Office 文档由 anydoc 在 Go 进程内解析。
- 渠道与集成:企业微信、飞书、Slack、Telegram 等 IM 频道内直接问答;网站嵌入 Widget 把智能体发布到外部站点;内置 MCP Server 供 Cursor、Claude 等 AI 工具连接;权限范围 API Key 与 Principal 模型用于程序化集成。
- 模型:内置 29 家模型厂商与自动生成的模型目录,兼容 OpenAI、DeepSeek、Qwen(阿里云)、智谱、混元、Gemini、MiniMax、NVIDIA、LiteLLM、Ollama 等。
- 权限与运维:多空间 RBAC(四级角色、资源归属、空间审计日志)、每空间多实例存储后端、运行时任务队列面板与 Worker 池治理,并通过 Langfuse 追踪 Agent 步骤、Token 用量与任务流水线。
- 部署:大模型、向量数据库、存储后端均可替换,支持本地与私有云部署,数据留在你自己的环境中。
快速开始
|
在线使用 微信对话开放平台 在线管理知识库,将问答服务接入公众号、小程序等微信场景。 进入平台 → |
云端部署 腾讯云轻量应用服务器 通过应用模板部署 WeKnora,在自己的云服务器上运行。 前往腾讯云部署 → |
自行部署 部署到自己的环境 使用 Docker 或 Kubernetes 部署,自行配置模型、存储和网络。 使用 Docker Compose 部署 ↓ |
使用 Docker Compose 部署
需要 Docker、Docker Compose 与 Git。
git clone https://github.com/Tencent/WeKnora.git
cd WeKnora
cp .env.example .env # 按需编辑 .env,详见文件内注释
docker compose pull # 拉取最新镜像
docker compose up -d # 启动核心服务
启动成功后访问 http://localhost,按新手引导完成配置即可使用。带样例数据的完整上手流程见快速上手。
[!TIP] 如需使用本地 Ollama 模型,请先运行
ollama serve > /dev/null 2>&1 &。Ollama 向量模型名、OLLAMA_BASE_URL与内存说明见配置文档。
| 服务 | 地址 |
|---|---|
| Web UI | http://localhost |
| 后端 API | http://localhost:8080 |
| 链路追踪 (Langfuse) | http://localhost:3000 |
可选服务
按需添加 --profile 启动额外组件,多个 profile 可叠加使用:
| Profile | 说明 |
|---|---|
| (默认) | 核心服务 |
full |
全部功能 |
neo4j |
知识图谱 (Neo4j) |
minio |
对象存储 (MinIO) |
langfuse |
链路追踪 (Langfuse) |
docker compose --profile neo4j --profile minio pull
docker compose --profile neo4j --profile minio up -d
docker compose down # 停止服务
版本升级
若已有部署并下载了更新的 release:
# 在 .env 中将 WEKNORA_VERSION 设为目标版本(如 0.8.3),或保持 latest
docker compose pull # 拉取与 WEKNORA_VERSION 匹配的镜像
docker compose up -d # 用新镜像重建容器
[!NOTE] 仅执行
docker compose up -d会复用本地缓存镜像,可能导致 Web UI 显示版本与下载的 release 不一致。升级前请先阅读升级须知。
其他部署方式
| 方式 | 适用场景 |
|---|---|
| Docker Compose | 上面的标准部署,功能完整,多服务 |
| Kubernetes (Helm) | 生产集群;Chart 位于 helm/ |
| Lite 单二进制 | 本机或低资源环境,零外部依赖(SQLite + 内存队列);与标准版的差异见 Lite 与标准版区别 |
| 桌面应用 | 带图形界面的 Lite 运行时,免登录启动,macOS 上提供本机沙箱;尚未提供安装包,需自行构建 |
全部部署形态、硬件要求与常见拓扑见安装部署。
[!WARNING] WeKnora 已提供登录鉴权,但在生产环境部署时,我们强烈建议:
- 将 WeKnora 服务部署在内网 / 私有网络环境中,而非公网环境;
- 避免将服务直接暴露在公网上,以防止重要信息泄露风险;
- 为部署环境配置适当的防火墙规则和访问控制;
- 定期更新到最新版本以获取安全补丁和改进。
最新更新
v0.8.3 · 2026-10-14 · 版本说明
- 画廊:集中浏览文档图片,按来源、描述、OCR 与图片属性筛选,查看原图和出处。
- 多模态 Embedding:支持将文字与图片编码到同一向量空间的多模态向量模型,例如腾讯 WeMM-Embedding、Qwen3-VL-Embedding 等;可按需开启图片向量检索,并搭配支持图片输入的重排模型。
- Wiki 图谱:重新组织分组布局与主题说明,支持聚焦分组、切换分组和返回全图。
- 原文引用:从回答直接定位原始文档中的引用片段。
- 对话与工具:无需沙箱即可按需读取附件,未读回答标记、@ 全局搜索、Docker 终端、Lite 本机技能与 MCP 兼容性更新。
- 管理与集成:平台用户管理、仅限邀请注册、管理员模型目录、WeMM 向量、TEI/Pinecone/Cohere 重排、Seafile 数据源与繁体中文。
- 稳定性:集中修复检索、解析、数据源、Wiki、OAuth 和 CLI。注册模式、空工具列表、数据库迁移与向量重建要求见升级须知。
v0.8.2 · 2026-09-24 · 版本说明
智能体可以操作你电脑上的浏览器,知识库可以通过 MCP 接入其他 AI 工具,进行中的对话可以补充要求、分叉或回滚。
- 本地浏览器(BrowserSkill):智能体通过开源 BrowserSkill 扩展操作用户自己的 Chrome / Edge,支持实时任务预览、暂停 / 继续,登录和验证码交给用户处理。
- 内置 MCP Server:按空间发布
/mcp/<endpoint_id>端点,Streamable HTTP,每个端点独立令牌、知识库范围、限流与工具分组;Python 版mcp-server/已弃用。 - 对话控制:运行中追加要求、从任意历史问题分叉、原地回滚并还原沙箱检查点、按会话选择思考强度;生成的文件统一收在新增的产物库中。
- 沙箱:沙箱交互终端与图形桌面;macOS Lite 宿主机沙箱与项目文件夹;侧边栏工具箱集中管理技能、MCP 服务与浏览器连接。
- 模型接入:重构的模型目录(27 家内置厂商,自动补全上下文窗口、最大输出、思考档位与视觉能力);Agent 检索工具合并为
search_knowledge/read_document/list_documents。 - 知识库与平台:Confluence 与钉钉文档数据源;博查与 Serply 网络搜索;日语界面;IM 频道级回复语言;仅白名单出站模式。
[!IMPORTANT] 不兼容变更: 钉钉频道仅支持 Stream 模式,沙箱命令默认以
root执行。详见升级须知。
v0.8.0 · 版本说明
- 技能沙箱运行时:会话级常驻 Docker / E2B / Cube 后端,按空间配置网络策略;移除 Local 宿主机进程后端;Docker 需显式开启。
- 空间技能目录:从 ClawHub / SkillHub / git / zip 安装,按沙箱快照、实时进度、文件浏览/编辑、个人与空间环境变量。
- 跨会话长期记忆:profile / preference / fact / task / interest,自动抽取需确认,
search_memory。 - 解析与数据源:进程内 anydoc Office 解析;GitLab 与腾讯 IMA 数据源;XMind 解析。
- 生态:官方 DeepSeek Harness 插件
@wxg-prc-cpg/dsh-weknora;LiteLLM;Exa 与 Metaso 网络搜索。 - 对话:对话产物、问题大纲与时间戳;上下文压缩与供应商 Prompt Cache 标记。
- 安全:OIDC JWKS 验签、可选复杂密码、文档自动打标签,以及大范围沙箱/安全加固。
更早版本(v0.2.0 – v0.7.2)
- v0.7.2 —— 产品文档站;知识库文件夹树;分块编辑与版本历史;Wiki 页面版本历史;可直接加载的文件链接(
resource_urls=public);飞书云盘数据源;批量打标签;MCP Server 1.1(29 个工具);AWS S3 默认凭据链。 - v0.7.1 —— 云之家 IM;火山引擎重排序;智谱 AI 网络搜索;平台级 API Key;知识库活动审计;FAQ 筛选、打标签与导出;Langfuse OTLP 追踪;一键导出 Markdown。
- v0.7.0 —— 权限范围 API Key 与 Principal 模型;任务队列面板与 Worker 池治理;每空间多实例存储;对话临时附件;
@Skill / @MCP提及;会话内 MCP OAuth;QQBot 与 Lark IM;Redis TLS;weknoraCLI v0.10。 - v0.6.3 —— 网站嵌入 Widget 与发布集成中心(安全模式 Token 交换 + 限流);对话体验全面革新(引用浮层、RAG 流水线进度、流式 Markdown);文档多标签与批量重新解析;Wiki 文件夹与层级导航;RSS 数据源;MCP OAuth2;EPUB / MHTML 解析;Agent 模型就绪校验;模型调试器;会话来源筛选;工作区删除 UI。
- v0.6.2 —— 按批次解析配置(
process_config)+ 上传确认对话框;文档重新解析(reparse)支持覆盖配置;weknoraCLI v0.9(内置 Agent Skills、session stop、auth/profile 统一);知识库框选多选;pgvector 1024 维 HNSW 索引;对话资源 Store 重构;仅保留 Langfuse 追踪(移除 Jaeger)。 - v0.6.1 —— 文档解析追踪时间线(Langfuse 风格 Span 树,逐阶段进度展示 + 解析中止);OpenSearch 向量库驱动;YAML 声明式内置模型配置;系统管理员与统一平台设置 + 审计日志;新用户引导;设置页 UI 重构;
weknoraCLI v0.7 / v0.8(Agent 优先线协议、NDJSON、--dry-run);OpenDataLoader 与 PaddleOCR-VL 解析引擎;MCP Server 多传输(stdio / SSE / HTTP);按模型的思考模式配置;腾讯云 LKEAP 重排 + 原生 Gemini Embedding + MiniMax-M3。 - v0.6.0 —— 空间 RBAC(四级角色矩阵
Owner/Admin/Contributor/Viewer+ 按 KB 归属 + 每空间审计日志)、空间成员管理与多工作区 UX、自助创建工作区;weknoraCLI v0.4 正式版 +mcp serve;KB 检索跨向量库扇出;MCP / 数据源凭据 AES-256-GCM 加密 + docreader gRPC TLS + Token;新增智谱 Embedding 与华为云 OBS;服务端用户偏好;Go 1.26.0。详见多租户与认证。 - v0.5.2 —— Wiki 入库支撑万级文档知识库(任务队列 + 死信队列);MCP 工具人机审批;Anthropic / Apache Doris / 腾讯云 VectorDB / 金山云 KS3 / SearXNG 后端;自适应三层分块 + 实时调试面板;全局 ⌘K 命令面板;语雀连接器 + 微信小程序;
weknoraCLI 早期版本。 - v0.5.1 —— 知识库批量管理;空间级 IM 频道总览;会话搜索 + 用户级置顶;模型 / 网页搜索 / MCP 统一卡片化设置;按 Agent LLM 调用超时;桌面端空间切换。
- v0.5.0 —— Wiki 模式正式版 —— Agent 从原始文档自治生成结构化、相互链接的 Markdown Wiki 页面及知识图谱;Wiki 浏览器 + 可视化图谱。
- v0.4.0 —— WeKnora Cloud(托管模型 + 解析);Chrome 插件;ClawHub Skill;微信 IM;附件处理;Azure OpenAI / 阿里云 OSS;Notion 连接器;百度 + Ollama 网页搜索;VectorStore 管理。
- v0.3.6 —— ASR 语音;飞书数据源自动同步;OIDC;IM 引用回复 + 线程会话;文档自动摘要;Tavily 搜索;并行工具调用;Agent @提及范围限制。
- v0.3.5 —— Telegram / 钉钉 / Mattermost IM;IM 斜杠命令 + QA 队列;推荐问题;VLM 自动描述 MCP 返回图片;Novita AI;来源频道标记。
- v0.3.4 —— 企业微信 / 飞书 / Slack IM;多模态图片;NVIDIA 模型 API;Weaviate;AWS S3;AES-256-GCM API Key 加密;内置 MCP 服务;混合检索优化;
final_answer工具。 - v0.3.3 —— 父子分块;知识库置顶;兜底回复;Rerank 段落清洗;存储桶自动创建;Milvus。
- v0.3.2 —— 知识搜索入口;按来源配置解析与存储引擎;本地存储图片渲染;文档预览;火山引擎 TOS;Mermaid 渲染;对话批量管理;记忆图谱预览。
- v0.3.0 —— 共享空间;Agent Skills + 沙盒执行;自定义 Agent;数据分析 Agent;思考模式;Bing / Google 搜索;API Key 认证;Helm Chart;韩语 i18n;Qdrant。
- v0.2.0 —— Agent 模式(ReACT);多类型知识库(FAQ + 文档);对话策略配置;DuckDuckGo 网页搜索;MCP 工具集成;全新 UI + Agent 模式切换;MQ 异步任务管理。
完整变更记录见 CHANGELOG.md。
功能展示
快速问答与智能推理
两种提问方式。 快速问答基于知识库做 RAG 检索作答,并标注引用来源;智能推理由智能体规划多步任务,检索、阅读文档、调用工具与技能,每一步都在对话中展示。 文档 →
本机浏览器
操作你电脑上的浏览器。 借助腾讯开源的 BrowserSkill 扩展,智能体直接在你的 Chrome 或 Edge 中打开网页、填写表单;遇到登录或验证码时交给你。 文档 →
技能与沙箱
运行技能,生成文件。 支持 Docker、E2B、Cube。同一会话的多轮任务共用一个工作区,生成的文件可预览和下载;还可以在对话旁打开图形桌面或交互终端,查看智能体的每一步操作,必要时亲自接手。 文档 →
工具箱:MCP 服务与技能
智能体可用的工具。 接入外部 MCP 服务,逐个选择启用哪些工具、哪些调用需要审批;从 ClawHub、SkillHub、Git 或 ZIP 安装技能,在空间内统一管理,供各个沙箱复用。 文档 →
自动 Wiki
把文档整理成可浏览的 Wiki。 开启 Wiki 后,从知识库文档中提取人物、产品和概念,生成带来源引用的页面,按目录浏览;在知识图谱中查看页面之间的关系,页面可直接编辑,改动可回溯。 文档 →
可观测性
追踪与运行监控。 Langfuse 追踪智能体每一步的推理、工具调用与 Token 用量;文档解析时间线逐阶段展示进度;任务队列面板列出排队与失败的任务。 文档 →
架构设计
从文档解析、向量化、检索到大模型推理,各环节模块化解耦,组件可替换、可扩展。支持本地与私有云部署,Web UI 开箱即用。延伸阅读:架构总览 · RAG 流水线 · 扩展点。
功能概览
| 领域 | 要点 |
|---|---|
| 问答与 Agent | 快速问答基于知识库作答并附来源引用;智能推理由 ReAct Agent 编排知识库、网络搜索、MCP 工具、技能与本机浏览器。进行中的对话可以补充要求、分叉或回滚,并支持跨会话的长期记忆 |
| Wiki | Agent 生成相互链接的 Wiki 页面与知识图谱;支持浏览器内编辑、版本 diff 与回滚 |
| 技能与沙箱 | 技能目录支持从 ClawHub / SkillHub / Git / ZIP 安装;会话级持久的 Docker / E2B / Cube 沙箱,按配置设置网络策略;对话旁提供交互式终端与图形桌面 |
| 知识库 | FAQ、文档、Wiki 三类知识库;文件夹树;分块编辑与版本历史;按批次设置解析、分块与多模态;自动打标签 |
| 检索 | 关键词 + 向量混合检索、重排序、父子分块与 GraphRAG(Neo4j);端到端评测召回命中率与 BLEU / ROUGE |
| 权限与安全 | 空间 RBAC 四级角色与审计日志;权限范围 API Key;OIDC;凭据 AES-256-GCM 加密;防 SSRF 的出站请求与仅白名单出站模式 |
| 运维 | Langfuse 追踪 Agent 步骤、Token 用量与任务流水线;文档解析时间线;带 Worker 池的任务队列面板;版本升级自动迁移数据库 |
支持的组件
| 组件 | 可选项 |
|---|---|
| 模型厂商 | 内置 29 家,包括 OpenAI / Azure OpenAI / Anthropic / DeepSeek / Qwen(阿里云)/ 智谱 / 混元 / 豆包(火山引擎)/ Gemini / MiniMax / NVIDIA / SiliconFlow / OpenRouter / LiteLLM / Ollama |
| Embedding | Ollama / BGE / GTE / 智谱 / OpenAI 兼容接口 |
| 向量数据库 | PostgreSQL (pgvector) / Elasticsearch / OpenSearch / Milvus / Weaviate / Qdrant / Apache Doris / 腾讯云 VectorDB |
| 对象存储 | 本地 / 腾讯云 COS / MinIO / AWS S3 / 火山引擎 TOS / 阿里云 OSS / 金山云 KS3 / 华为云 OBS |
| 文档格式 | PDF / Word / PPT / Excel / CSV / TXT / Markdown / HTML / EPUB / MHTML / JSON / XMind / 图片 |
| 数据源 | 飞书知识库 / 飞书云盘 / Lark / Confluence / GitLab / 腾讯 IMA / Notion / 语雀 / 钉钉文档 / Seafile / RSS |
| IM 渠道 | 企业微信 / 飞书 / Lark / QQBot / Slack / Telegram / 钉钉 / Mattermost / 微信 / 云之家 |
| 网络搜索 | DuckDuckGo / Bing / Google / Tavily / Baidu / Ollama / SearXNG / Keenable / 智谱 AI / Exa / Metaso / 博查 / Serply |
| 部署 | Docker Compose / Kubernetes (Helm) / Lite 单二进制 / 桌面版;支持离线与私有云部署;界面支持中文、英文、日文、韩文、俄文 |
客户端与生态
| 客户端 | 用途 | |
|---|---|---|
命令行 weknora |
Agent 优先的命令行,覆盖完整 API,附带精选 MCP 工具面与内置 Agent Skills | |
| 内置 MCP Server | 通过 Streamable HTTP 把知识库开放给 Cursor、Claude 等 MCP 客户端;mcp-server/ 下的 Python 服务已弃用 |
|
| 本地浏览器(BrowserSkill) | 让智能体操作用户自己的 Chrome / Edge | |
| Chrome 插件 | 在浏览器中选中文本、图片或整个页面,一键保存为知识条目,无需复制粘贴或手动上传文件 | |
| 微信小程序 | 轻量移动端:配置 WeKnora API、选择知识库、导入 URL,并在微信内向知识库提问 | |
| ClawHub Skill | 发布在 ClawHub 上的 WeKnora 技能,通过 REST API 导入文档、混合检索与管理知识条目 | |
| DeepSeek Harness 插件 | 为 dsh 编码 Agent 提供四个只读工具:检索、读取文档、提问、列出知识库 |
|
| 网站嵌入 Widget | 将智能体发布到外部站点 | |
| Go SDK | 知识库、文档、会话等资源的 CRUD 与 SSE 流式问答 | |
| 微信对话开放平台 | 基于 WeKnora 的托管问答平台,上传知识即可在微信内发布问答服务,无需写代码 |
命令行工具
weknora 是官方命令行工具,可在终端或 AI Agent 中驱动 API。它以 Agent 为先:每条命令默认输出稳定的 JSON 信封(带类型化错误码并映射到退出码),--format text 则面向人类阅读。它还提供精选的 MCP 工具面(weknora mcp serve),并内置 Agent Skills。
weknora profile add prod --host https://kb.example.com --use
weknora auth login
weknora kb list
weknora link --kb my-knowledge-base # 绑定当前目录
weknora doc upload notes.md
weknora chat "总结一下设计文档"
在无界面 / CI 场景下,设置 WEKNORA_API_KEY 与 WEKNORA_HOST 即可跳过 auth login,不会有凭据写入磁盘。安装与 5 分钟上手见 cli/README.md,AI Agent 依赖的操作约定见 cli/AGENTS.md。
文档
完整产品文档见 weknora.weixin.qq.com/docs,按「入门 → 架构 → 功能 → API → 客户端 → 开发」六个板块组织,覆盖约 360 个 API 端点、约 150 个环境变量与 9 大扩展点。
| 从这里开始 | |
|---|---|
| 产品介绍 | 能力总览 |
| 安装部署 | Docker Compose、Helm、Lite 与桌面端 |
| 配置说明 | 环境变量与模型配置 |
| 常见问题排查 | 常见问题与解决办法 |
| API 文档 | REST API 总览 |
| 版本说明 | 各版本变更详解 |
开发指南
频繁修改代码时不需要每次重新构建 Docker 镜像,使用快速开发模式即可:
make dev-start # 启动基础设施
make dev-app # 启动后端(新终端)
make dev-frontend # 启动前端(新终端)
- 前端修改自动热重载(无需重启)
- 后端修改快速重启(5-10 秒,支持 Air 热重载)
- 无需重新构建 Docker 镜像
- 支持 IDE 断点调试
详细说明见开发环境快速入门。
文档站与产品主页的源码位于 website-docs/。使用 Node.js 24 运行 cd website-docs && npm run setup && npm run build && npm run preview 即可同时预览两者;统一的静态产物在 / 提供主页、在 /docs/ 提供文档。Nginx 与 Docker 部署方式见该目录的 README。
贡献指南
欢迎通过 Issue 反馈问题或提交 Pull Request。
- 流程: Fork → 新建分支 → 提交更改 → 创建 PR
- 规范: 使用
gofmt格式化代码,遵循 Conventional Commits 提交(feat:/fix:/docs:/test:/refactor:)
验证方式
对于范围集中的 PR,优先验证本次改动涉及的文件和包:
git fetch origin main
git diff --check origin/main...HEAD
golangci-lint run --new-from-rev=origin/main ./...
go test ./path/to/changed/package -count=1
提交前请对改动过的 Go 文件运行 gofmt。对于前端改动,请在 frontend/ 目录运行相关测试;如果改动涉及 TypeScript 或 Vue 组件,还应运行 npm run type-check。
维护者使用的全仓验证命令仍然是:
make fmt
make lint
make test
make fmt 会格式化整个 Go 仓库,因此请仅在工作区干净时运行,并检查产生的 diff。部分全量测试依赖本地基础设施或服务配置。如果全仓检查因无关的基线问题或环境依赖失败,请在 PR 中写明具体命令和错误,同时提供本次改动范围内通过的定向测试。
贡献者
感谢所有贡献者:
许可证
本项目基于 MIT 协议发布。你可以自由使用、修改和分发本项目代码,但需保留原始版权声明。