From f78d82040b5ca4e4f358d8520afdcac714de402c Mon Sep 17 00:00:00 2001 From: wxy <3050128610@qq.com> Date: Thu, 21 May 2026 20:22:52 +0800 Subject: [PATCH] update README.md --- README.md | 88 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 87 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d463c33..0b67e8e 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,9 @@ 🙋‍♂️ 微信交流群

+> **本仓库为 PandaWiki v3.85.0 二次开发版**,已移除商业订阅限制,开源版即可使用全部功能。 +> 详见 [修改说明](#hammer-二次开发说明) 和 [自行构建部署指南](SELF_BUILD_GUIDE.md)。 + ## 👋 项目介绍 PandaWiki 是一款 AI 大模型驱动的**开源知识库搭建系统**,帮助你快速构建智能化的 **产品文档、技术文档、FAQ、博客系统**,借助大模型的力量为你提供 **AI 创作、AI 问答、AI 搜索** 等能力。 @@ -31,7 +34,7 @@ PandaWiki 是一款 AI 大模型驱动的**开源知识库搭建系统**,帮 ## 🚀 上手指南 -### 安装 PandaWiki +### 方式一:官方安装脚本(原始版本,有商业限制) 你需要一台支持 Docker 20.x 以上版本的 Linux 系统来安装 PandaWiki。 @@ -45,6 +48,33 @@ bash -c "$(curl -fsSLk https://release.baizhi.cloud/panda-wiki/manager.sh)" > 关于安装与部署的更多细节请参考 [安装 PandaWiki](https://pandawiki.docs.baizhi.cloud/node/01971602-bb4e-7c90-99df-6d3c38cfd6d5)。 +### 方式二:自行构建部署(本仓库修改版,功能全解锁) + +推荐使用本仓库提供的 Docker Compose 方案自行构建,所有商业功能限制已移除。 + +```bash +# 1. 克隆本仓库 +git clone && 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 模型配置)请参考: +> - [自行构建开发指南](SELF_BUILD_GUIDE.md) — 修改说明 + 本地开发调试 +> - [Ubuntu 22 部署指南](DEPLOY_UBUNTU22.md) — 生产环境 Docker Compose 部署 + ### 登录 PandaWiki 在上一步中,安装命令执行结束后,你的终端会输出以下内容。 @@ -99,6 +129,62 @@ SUCCESS 密码: ********************** - 🤝加入社区:扫码加入下方企业微信群,与更多用户及官方人员交流经验、获得帮助。 +## 🔨 二次开发说明 + +本仓库基于 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](SELF_BUILD_GUIDE.md) +- **Ubuntu 22 部署**: 参照 [DEPLOY_UBUNTU22.md](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 部署指南 +``` + ## 社区交流 欢迎加入我们的微信群进行交流。