diff --git a/README.md b/README.md index a14ff2f..24eab79 100644 --- a/README.md +++ b/README.md @@ -3,16 +3,24 @@

- 📖 官方网站   |   - 🙋‍♂️ 微信交流群 + AI 大模型驱动的开源知识库搭建系统

-> **本仓库为 PandaWiki v3.85.0 二次开发版**，已移除商业订阅限制，开源版即可使用全部功能。 -> 详见 [修改说明](#hammer-二次开发说明) 和 [自行构建部署指南](SELF_BUILD_GUIDE.md)。 +

+ 🔨 二次开发说明  |  + 🚀 快速部署  |  + 🔥 功能特色 +

+ +--- + +> **YouduWiki** 基于 PandaWiki v3.85.0 二次开发，已移除所有商业订阅限制，开源版即享全部功能。 + +--- ## 👋 项目介绍 -PandaWiki 是一款 AI 大模型驱动的**开源知识库搭建系统**，帮助你快速构建智能化的 **产品文档、技术文档、FAQ、博客系统**，借助大模型的力量为你提供 **AI 创作、AI 问答、AI 搜索** 等能力。 +YouduWiki 是一款 AI 大模型驱动的**开源知识库搭建系统**，帮助你快速构建智能化的 **产品文档、技术文档、FAQ、博客系统**。借助大模型的力量，提供 **AI 创作、AI 问答、AI 搜索** 等能力。

@@ -20,125 +28,82 @@ PandaWiki 是一款 AI 大模型驱动的**开源知识库搭建系统**，帮 ## ⚡️ 界面展示 -| PandaWiki 控制台 | Wiki 网站前台 | -| ------------------------------------------------ | ------------------------------------------------ | +| 管理控制台 | Wiki 网站前台 | +|:--------------------------------------------:|:--------------------------------------------:| | | | | | | ## 🔥 功能与特色 -- AI 驱动智能化：AI 辅助创作、AI 辅助问答、AI 辅助搜索。 -- 强大的富文本编辑能力：兼容 Markdown 和 HTML，支持导出为 word、pdf、markdown 等多种格式。 -- 轻松与第三方应用进行集成：支持做成网页挂件挂在其他网站上，支持做成钉钉、飞书、企业微信等聊天机器人。 -- 通过第三方来源导入内容：根据网页 URL 导入、通过网站 Sitemap 导入、通过 RSS 订阅、通过离线文件导入等。 +- **AI 驱动智能化** — AI 辅助创作、AI 问答、AI 语义搜索 +- **强大的富文本编辑** — 兼容 Markdown 和 HTML，支持导出 Word、PDF、Markdown 等格式 +- **第三方集成** — 网页挂件、钉钉 / 飞书 / 企业微信聊天机器人 +- **多源内容导入** — 网页 URL、Sitemap、RSS 订阅、离线文件导入 +- **全功能解锁** — 无知识库数量限制、无文档数限制、支持水印/复制保护/SSO/高级机器人等全部功能 ## 🚀 上手指南 -### 方式一：官方安装脚本（原始版本，有商业限制） - -你需要一台支持 Docker 20.x 以上版本的 Linux 系统来安装 PandaWiki。 - -使用 root 权限登录你的服务器，然后执行以下命令。 +### 方式一：本地镜像部署（推荐） ```bash -bash -c "$(curl -fsSLk https://release.baizhi.cloud/panda-wiki/manager.sh)" +# 1. 构建镜像并导出到 mirror/ +./build-push.sh + +# 2. 将项目传到部署服务器 +scp -r . user@your-server:/home/user/youdu-wiki/ + +# 3. 在服务器上一键部署 +cd /home/user/youdu-wiki +chmod +x deploy.sh +./deploy.sh --load ./mirror ``` -根据命令提示的选项进行安装，命令执行过程将会持续几分钟，请耐心等待。 +约 1 分钟部署完成，终端会输出访问地址和初始密码。 -> 关于安装与部署的更多细节请参考 [安装 PandaWiki](https://pandawiki.docs.baizhi.cloud/node/01971602-bb4e-7c90-99df-6d3c38cfd6d5)。 - -### 方式二：一键部署脚本（本仓库修改版，功能全解锁） - -推荐使用本仓库提供的 `deploy.sh` 一键部署，所有商业功能限制已移除。 +### 方式二：源码构建部署 ```bash -# 1. 将项目传输到服务器 -scp -r PandaWiki-3.85.0 user@your-server:/home/user/ - -# 2. 进入项目目录 -cd /home/user/PandaWiki-3.85.0 - -# 3. 给脚本添加执行权限 chmod +x deploy.sh - -# 4. 一键部署 (自动构建镜像 + 启动全部服务) ./deploy.sh ``` -部署完成后，脚本会自动生成随机密码并保存在 `.env` 文件中，同时输出访问地址和登录信息。 +首次 20-30 分钟（需下载依赖 + 编译），后续缓存构建约 2-5 分钟。 + +### 方式三：远程 Registry 部署 ```bash -# 其他常用操作 -./deploy.sh --status # 查看服务运行状态 -./deploy.sh --restart # 重启所有服务 -./deploy.sh --stop # 停止所有服务 -./deploy.sh --logs # 查看实时日志 -./deploy.sh --skip-build # 跳过构建，直接启动已有镜像 -./deploy.sh --clean # 清理所有容器和数据 (危险!) +# 先构建并推送镜像 +./build-push.sh --push registry.cn-hangzhou.aliyuncs.com/your-ns + +# 服务器上从 Registry 拉取部署 +./deploy.sh --registry registry.cn-hangzhou.aliyuncs.com/your-ns ``` -> 详细部署说明（含 Ubuntu 22.04 内网部署、离线部署、AI 模型配置）请参考： -> - [自行构建开发指南](SELF_BUILD_GUIDE.md) — 修改说明 + 本地开发调试 -> - [Ubuntu 22 部署指南](DEPLOY_UBUNTU22.md) — 生产环境 Docker Compose 部署 - -### 登录 PandaWiki - -在上一步中，安装命令执行结束后，你的终端会输出以下内容。 - -``` -SUCCESS 控制台信息: -SUCCESS 访问地址(内网): http://*.*.*.*:2443 -SUCCESS 访问地址(外网): http://*.*.*.*:2443 -SUCCESS 用户名: admin -SUCCESS 密码: ********************** -``` - -使用浏览器打开上述内容中的 “访问地址”，你将看到 PandaWiki 的控制台登录入口，使用上述内容中的 “用户名” 和 “密码” 登录即可。 +> 详细部署说明：[Ubuntu 22 部署指南](DEPLOY_UBUNTU22.md) | [自行构建开发指南](SELF_BUILD_GUIDE.md) ### 配置 AI 模型 -> PandaWiki 是由 AI 大模型驱动的 Wiki 系统，在未配置大模型的情况下 AI 创作、AI 问答、AI 搜索 等功能无法正常使用。 -> -首次登录时会提示需要先配置 AI 模型，可自行选择一键配置或手动配置。 +首次登录后会提示配置 AI 大模型，支持以下方式接入： -

- -

一键自动配置 AI 模型

+| 方式 | 说明 | +|------|------| +| OpenAI 兼容 API | 任何兼容 `/v1/chat/completions` 接口的服务 | +| Ollama | 本地部署，`ollama pull qwen2.5:7b` 后填入地址 | +| DeepSeek | 官方 API | - -

手动自定义配置 AI 模型

-
+> 在管理后台 → 设置 → 模型管理中配置。 +### 登录 +- 地址: `http://服务器IP:2443`（管理后台）/ `http://服务器IP:3010`（Wiki 前端） +- 用户名: `admin` +- 密码: `.env` 文件中的 `ADMIN_PASSWORD`（首次部署自动生成） -> 推荐使用 [百智云模型广场](https://baizhi.cloud/) 快速接入 AI 模型，注册即可获赠 5 元的模型使用额度。 -> 关于大模型的更多配置细节请参考 [接入 AI 模型](https://pandawiki.docs.baizhi.cloud/node/01971616-811c-70e1-82d9-706a202b8498)。 - -### 创建知识库 - -“知识库” 是一组文档的集合，PandaWiki 将会根据知识库中的文档，为不同的知识库分别创建 “Wiki 网站”。 - - -### 💪 开始使用 - -如果你顺利完成了以上步骤，那么恭喜你，属于你的 PandaWiki 搭建成功，你可以： - -- 访问 **控制台** 来管理你的知识库并上传文档等待学习成功 -- 访问 **Wiki 网站** 使用知识库并测试AI问答效果 - - -### 💬 遇到问题 - -如在使用产品过程中遇到问题，可通过以下方式获取帮助： -- 📘查阅官方文档：[常见问题](https://pandawiki.docs.baizhi.cloud/node/019b4952-4ed3-7514-ba57-c93a8ca13608)，更多内容请参考文档目录。 -- 🤖不想翻文档？试试 [AI 问答](https://pandawiki.docs.baizhi.cloud/node/0197160c-782c-74ad-a4b7-857dae148f84)，快速获取答案。 -- 🤝加入社区：扫码加入下方企业微信群，与更多用户及官方人员交流经验、获得帮助。 - +--- ## 🔨 二次开发说明 -本仓库基于 PandaWiki v3.85.0 进行了以下修改，移除了开源版的所有功能限制： +本仓库基于 PandaWiki v3.85.0 进行了以下修改： ### 修改的文件 @@ -151,7 +116,7 @@ SUCCESS 密码: ********************** ### 解锁功能对照 -| 功能 | 原开源版 (Free) | 本修改版 | +| 功能 | 原开源版 (Free) | YouduWiki | |------|:---:|:---:| | 知识库数量 | 1 个 | 无限制 | | 单库文档数 | 300 篇 | 无限制 | @@ -166,52 +131,34 @@ SUCCESS 密码: ********************** | MCP Server | 不支持 | 支持 | | 文档统计 | 不支持 | 支持 | | 统计数据周期 | 仅 1 天 | 1/7/30/90 天 | -| SSO 登录速率限制 | 有限制 | 无限制 | - -### 构建与部署 - -- **开发调试**: 参照 [SELF_BUILD_GUIDE.md](SELF_BUILD_GUIDE.md) -- **Ubuntu 22 部署**: 参照 [DEPLOY_UBUNTU22.md](DEPLOY_UBUNTU22.md) +| SSO 速率限制 | 有限制 | 无限制 | ### 项目结构 ``` -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 部署指南 +YouduWiki/ +├── backend/ # Go 后端 (API + Consumer) +│ ├── domain/ # 领域模型 ← 版本限制修改 +│ ├── usecase/ # 业务逻辑 ← 统计限制修改 +│ ├── repo/pg/ # 数据访问 ← SSO限制修改 +│ └── handler/ # HTTP 处理器 +├── web/ # 前端 (pnpm monorepo) +│ ├── admin/ # 管理后台 (React + Vite) ← 版本映射修改 +│ └── app/ # Wiki 前端 (Next.js) +├── mirror/ # 镜像导出目录 +├── build-push.sh # 镜像构建 & 导出脚本 +├── deploy.sh # 一键部署脚本 +├── docker-compose.yml # Docker Compose 配置 +├── SELF_BUILD_GUIDE.md # 自行构建开发指南 +└── DEPLOY_UBUNTU22.md # Ubuntu 22 部署指南 ``` -## 社区交流 - -欢迎加入我们的微信群进行交流。 - - - -## 🙋‍♂️ 贡献 - -欢迎提交 [Pull Request](https://github.com/chaitin/PandaWiki/pulls) 或创建 [Issue](https://github.com/chaitin/PandaWiki/issues) 来帮助改进项目。 +--- ## 📝 许可证 -本项目采用 GNU Affero General Public License v3.0 (AGPL-3.0) 许可证。这意味着： +本项目基于 PandaWiki 二次开发，原始项目采用 [AGPL-3.0](LICENSE) 许可证，本修改版同样以 AGPL-3.0 开源。 -- 你可以自由使用、修改和分发本软件 -- 你必须以相同的许可证开源你的修改 -- 如果你通过网络提供服务，也必须开源你的代码 -- 商业使用需要遵守相同的开源要求 - - -## Star History - -[![Star History Chart](https://api.star-history.com/svg?repos=chaitin/PandaWiki&type=Date)](https://www.star-history.com/#chaitin/PandaWiki&Date) +- 你可以自由使用、修改和分发 +- 修改后的代码须以相同许可证开源 +- 通过网络提供服务也须开源代码