8.6 KiB
本仓库为 PandaWiki v3.85.0 二次开发版，已移除商业订阅限制，开源版即可使用全部功能。 详见 修改说明 和 自行构建部署指南。
👋 项目介绍
PandaWiki 是一款 AI 大模型驱动的开源知识库搭建系统，帮助你快速构建智能化的 产品文档、技术文档、FAQ、博客系统，借助大模型的力量为你提供 AI 创作、AI 问答、AI 搜索 等能力。
⚡️ 界面展示
| PandaWiki 控制台 | Wiki 网站前台 |
|---|---|
 |
 |
 |
 |
🔥 功能与特色
- AI 驱动智能化：AI 辅助创作、AI 辅助问答、AI 辅助搜索。
- 强大的富文本编辑能力：兼容 Markdown 和 HTML，支持导出为 word、pdf、markdown 等多种格式。
- 轻松与第三方应用进行集成：支持做成网页挂件挂在其他网站上，支持做成钉钉、飞书、企业微信等聊天机器人。
- 通过第三方来源导入内容：根据网页 URL 导入、通过网站 Sitemap 导入、通过 RSS 订阅、通过离线文件导入等。
🚀 上手指南
方式一：官方安装脚本（原始版本，有商业限制）
你需要一台支持 Docker 20.x 以上版本的 Linux 系统来安装 PandaWiki。
使用 root 权限登录你的服务器，然后执行以下命令。
bash -c "$(curl -fsSLk https://release.baizhi.cloud/panda-wiki/manager.sh)"
根据命令提示的选项进行安装，命令执行过程将会持续几分钟，请耐心等待。
关于安装与部署的更多细节请参考 安装 PandaWiki。
方式二：自行构建部署（本仓库修改版，功能全解锁）
推荐使用本仓库提供的 Docker Compose 方案自行构建，所有商业功能限制已移除。
# 1. 克隆本仓库
git clone <your-repo-url> && cd PandaWiki
# 2. 创建环境变量配置
cp .env.example .env # 修改密码等敏感信息
# 3. 构建 Docker 镜像
docker build -f backend/Dockerfile.api -t panda-wiki-api:latest ./backend
docker build -f backend/Dockerfile.consumer -t panda-wiki-consumer:latest ./backend
# 4. 启动全部服务
docker compose up -d
# 5. 访问
# 管理后台: http://服务器IP:2443
# 用户名: admin，密码见 .env 中 ADMIN_PASSWORD
详细部署说明（含 Ubuntu 22.04 内网部署、离线部署、AI 模型配置）请参考：
- 自行构建开发指南 — 修改说明 + 本地开发调试
- Ubuntu 22 部署指南 — 生产环境 Docker Compose 部署
登录 PandaWiki
在上一步中，安装命令执行结束后，你的终端会输出以下内容。
SUCCESS 控制台信息:
SUCCESS 访问地址(内网): http://*.*.*.*:2443
SUCCESS 访问地址(外网): http://*.*.*.*:2443
SUCCESS 用户名: admin
SUCCESS 密码: **********************
使用浏览器打开上述内容中的 “访问地址”，你将看到 PandaWiki 的控制台登录入口，使用上述内容中的 “用户名” 和 “密码” 登录即可。
配置 AI 模型
PandaWiki 是由 AI 大模型驱动的 Wiki 系统，在未配置大模型的情况下 AI 创作、AI 问答、AI 搜索 等功能无法正常使用。
首次登录时会提示需要先配置 AI 模型，可自行选择一键配置或手动配置。
一键自动配置 AI 模型
手动自定义配置 AI 模型
推荐使用 百智云模型广场 快速接入 AI 模型，注册即可获赠 5 元的模型使用额度。 关于大模型的更多配置细节请参考 接入 AI 模型。
创建知识库
“知识库” 是一组文档的集合，PandaWiki 将会根据知识库中的文档，为不同的知识库分别创建 “Wiki 网站”。
💪 开始使用
如果你顺利完成了以上步骤，那么恭喜你，属于你的 PandaWiki 搭建成功，你可以：
- 访问 控制台 来管理你的知识库并上传文档等待学习成功
- 访问 Wiki 网站 使用知识库并测试AI问答效果
💬 遇到问题
如在使用产品过程中遇到问题，可通过以下方式获取帮助：
🔨 二次开发说明
本仓库基于 PandaWiki v3.85.0 进行了以下修改，移除了开源版的所有功能限制：
修改的文件
| 文件 | 修改内容 |
|---|---|
backend/domain/license.go |
默认限制全解锁：知识库/文档/管理员数量不限，所有高级功能开关设为 true |
backend/usecase/stat.go |
移除统计天数的版本校验，1/7/30/90 天统计全开放 |
backend/repo/pg/auth.go |
移除非企业版的 SSO 认证速率限制 |
web/admin/src/constant/version.ts |
前端版本功能映射更新，Free 版显示全部功能为可用 |
解锁功能对照
| 功能 | 原开源版 (Free) | 本修改版 |
|---|---|---|
| 知识库数量 | 1 个 | 无限制 |
| 单库文档数 | 300 篇 | 无限制 |
| 管理员数量 | 1 人 | 无限制 |
| 管理员分权控制 | 不支持 | 支持 |
| 自定义版权信息 | 不支持 | 支持 |
| 页面水印 | 不支持 | 支持 |
| 内容复制保护 | 不支持 | 支持 |
| 评论审核 | 不支持 | 支持 |
| 高级机器人配置 | 不支持 | 支持 |
| AI 问答机器人设置 | 不支持 | 支持 |
| MCP Server | 不支持 | 支持 |
| 文档统计 | 不支持 | 支持 |
| 统计数据周期 | 仅 1 天 | 1/7/30/90 天 |
| SSO 登录速率限制 | 有限制 | 无限制 |
构建与部署
- 开发调试: 参照 SELF_BUILD_GUIDE.md
- Ubuntu 22 部署: 参照 DEPLOY_UBUNTU22.md
项目结构
PandaWiki/
├── backend/ # Go 后端 (API + Consumer)
│ ├── cmd/ # 入口程序
│ ├── domain/ # 领域模型 ← 版本限制修改位置
│ ├── usecase/ # 业务逻辑 ← 统计限制修改位置
│ ├── repo/ # 数据访问层 ← SSO限制修改位置
│ └── handler/ # HTTP 处理器
├── web/ # 前端 (pnpm monorepo)
│ ├── admin/ # 管理后台 (React + Vite) ← 版本映射修改位置
│ └── app/ # Wiki 用户端 (Next.js)
├── sdk/ # SDK
├── docker-compose.yml # Docker Compose 部署配置
├── SELF_BUILD_GUIDE.md # 自行构建开发指南
└── DEPLOY_UBUNTU22.md # Ubuntu 22 部署指南
社区交流
欢迎加入我们的微信群进行交流。
🙋♂️ 贡献
欢迎提交 Pull Request 或创建 Issue 来帮助改进项目。
📝 许可证
本项目采用 GNU Affero General Public License v3.0 (AGPL-3.0) 许可证。这意味着：
- 你可以自由使用、修改和分发本软件
- 你必须以相同的许可证开源你的修改
- 如果你通过网络提供服务，也必须开源你的代码
- 商业使用需要遵守相同的开源要求