项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 3658
技术标签
使用教程
⚠ 本教程由 AI 依据该项目 README 整理;原始文档不完整,部分步骤为通用流程推断,实际安装请以项目官方文档为准。
⚠ 该项目 README 未提供完整安装说明,以下步骤为通用流程,请以官方文档为准。
环境要求
- 已安装 Docker 与 Docker Compose
- 已安装 Git(用于克隆仓库)
- 可选:OpenAI 兼容的 API Key(用于 Graphify / 模型能力)
- 可选:Google OAuth 客户端(MCP 受保护资源场景)
安装与启动步骤
-
1克隆仓库
把 OpenDeepWiki 源码拉到本地,README 未给出其他下载方式,克隆后进入项目根目录。
git clone https://github.com/AIDotNet/OpenDeepWiki.git cd OpenDeepWiki -
2准备环境变量
README 提到的可选项都通过环境变量注入(如 MCP_ENABLED、OPENAI_API_KEY)。仓库自带 compose.yaml,按需修改其中变量取值。
-
3启动 Docker 服务
README 只表明存在 compose.yaml 与前后端 Dockerfile,未给出具体启动命令;此处按 Compose 常规方式启动,失败请以官网文档为准。
docker compose up -d -
4检查容器状态
确认后端与前端容器均已正常运行,若有容器反复重启,用日志排查环境变量或端口占用问题。
docker compose ps docker compose logs -f -
5接入 MCP 客户端
在支持 MCP 的客户端中按 README 示例配置服务器地址,路径形式或查询串形式二选一即可。
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
MCP_ENABLED | 否 | 设为 false 可关闭 MCP 端点 | true |
OPENAI_API_KEY | 否 | OpenAI 兼容服务的密钥,供 Graphify 等能力使用 | sk-xxxxxxxx |
OPENAI_BASE_URL | 否 | OpenAI 兼容服务的接口地址 | https://api.openai.com/v1 |
GRAPHIFY_BACKEND | 否 | 启用 Graphify 产物生成时选择的后端 | openai |
GRAPHIFY_MODEL | 否 | Graphify 使用的模型名称 | gpt-4o-mini |
GOOGLE_CLIENT_ID | 否 | 开启 MCP OAuth 保护资源时使用 | your-google-client-id |
如何确认成功
执行 docker compose ps 看到容器处于运行状态,并访问 http://localhost:8080/api/mcp 能返回响应即视为启动成功。
常见问题
Q:README 的 Quick Start 章节是空的,怎么安装?
A:仓库确实未在 README 中写出完整安装步骤,仅说明提供 compose.yaml 和前后端 Dockerfile。建议以官网 opendeep.wiki 及 scripts/sealos 目录下的部署指南为准。
Q:MCP 端点地址应该怎么写?
A:支持两种写法:路径式 http://localhost:8080/api/mcp/AIDotNet/OpenDeepWiki,或查询串式 http://localhost:8080/api/mcp?owner=AIDotNet&name=OpenDeepWiki。
Q:不想暴露 MCP 接口怎么办?
A:把环境变量 MCP_ENABLED 设为 false 即可关闭 MCP 端点。
Q:如何开启 Graphify 产物生成?
A:后端镜像已内置 graphifyy,只需配置一组可选 provider 变量,例如 GRAPHIFY_BACKEND 与 GRAPHIFY_MODEL,或 OPENAI_BASE_URL/OPENAI_API_KEY,也可用 OLLAMA_BASE_URL/OLLAMA_MODEL。
注意事项
- README 中 Quick Start With Docker 一节为空,实际启动命令需以官网文档为准,本教程的 docker compose 命令属于合理推断。
- 8080 端口来自 README 的 MCP 示例地址;前端监听端口 README 未说明,请查看 web/Dockerfile 或 compose.yaml 确认。
- 后端容器定义在 src/OpenDeepWiki/Dockerfile,前端容器定义在 web/Dockerfile,可据此自行构建镜像。
- Sealos 一键部署可参考 scripts/sealos/README.zh-CN.md。
核心亮点
- 集成ChatGPT等大模型,支持文档微调,问答精准度高
- 模块化架构,C#与TypeScript双语言,易于扩展和二次开发
- 支持文档版本管理与协作编辑,适合团队知识沉淀
不足之处
- 文档/社区待观察
- 项目仍处于成长阶段,生态和周边工具尚不完善
适用场景
- 企业内部知识库与智能问答系统
- 技术团队文档中心与自动化帮助文档
- 面向特定领域的定制化智能客服
替代项目
DeepWiki、Danswer、RAGFlow
同类项目推荐
colpali-cookbooks
开源
手把手教你微调 ColPali,让多模态文档检索更精准
Recipes for learning, fine-tuning, and adapting ColPali to your multimodal RAG use c···
graphrag-practice-chinese
开源
让 GraphRAG 更懂中文,替换模型+优化提示词,开箱即用
GraphRAG的应用实例,项目特点在于提供了替换OpenAI模型的方法,并通过修改原有提示和切分···
RAG_Techniques
开源
一站式学透 RAG 进阶技巧,从入门到实战快速上手
This repository showcases various advanced techniques for Retrieval-Augmented Genera···
beever-atlas
开源
把 Wiki 变成能聊天的知识库,问一句就出答案
Your First LLM-Wiki Conversation Knowledge Base
book-of-ai-search
开源
手把手从零写AI搜索引擎,搞懂原理还能改代码。
《动手写 AI 搜索引擎》
HyperGraphRAG
开源
用超图知识结构,让RAG复杂推理更准
[NeurIPS 2025] Official resources of "HyperGraphRAG: Retrieval-Augmented Generation ···
Awesome-RAG
开源
一站式收藏 RAG 前沿资源,快速掌握增强生成技术
Awesome RAG: A resource of Retrieval-Augmented Generation (RAG) for LLMs, focusing o···
RAG-using-Llama3-Langchain-and-C···
开源
三步搭起本地知识库问答,让Llama3学会翻书再回答
RAG using Llama3, Langchain and ChromaDB
Novel-Assistant
开源
让本地文档秒变智能问答库,随问随答
로컬 또는 클라우드 LLM을 사용해 문서 폴더 기반으로 검색·답변하는 RAG 어시스턴트
