a6a6cad664
- 新增全面的中文项目说明书文档 - 包含项目概述、技术架构、功能特性等完整内容 - 基于实际代码库结构和现有文档编写 - 涵盖安装部署、开发指南、API文档等关键信息 - 提供安全策略、贡献指南和社区支持说明 Co-Authored-By: naocanmonster@gmail.com <naocanmonster@gmail.com> |
||
|---|---|---|
| .github | ||
| backend | ||
| images | ||
| sdk/rag | ||
| web | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| README.md | ||
| SECURITY.md | ||
| 项目说明书.md | ||
README.md
👋 项目介绍
PandaWiki 是一款 AI 大模型驱动的开源知识库搭建系统，帮助你快速构建智能化的 产品文档、技术文档、FAQ、博客系统，借助大模型的力量为你提供 AI 创作、AI 问答、AI 搜索 等能力。
⚡️ 界面展示
| PandaWiki 控制台 | Wiki 网站前台 |
|---|---|
 |
 |
 |
 |
🔥 功能与特色
- AI 驱动智能化：AI 辅助创作、AI 辅助问答、AI 辅助搜索。
- 强大的富文本编辑能力：兼容 Markdown 和 HTML，支持导出为 word、pdf、markdown 等多种格式。
- 轻松与第三方应用进行集成：支持做成网页挂件挂在其他网站上，支持做成钉钉、飞书、企业微信等聊天机器人。
- 通过第三方来源导入内容：根据网页 URL 导入、通过网站 Sitemap 导入、通过 RSS 订阅、通过离线文件导入等。
🚀 上手指南
安装 PandaWiki
你需要一台支持 Docker 20.x 以上版本的 Linux 系统来安装 PandaWiki。
使用 root 权限登录你的服务器，然后执行以下命令。
bash -c "$(curl -fsSLk https://release.baizhi.cloud/panda-wiki/manager.sh)"
根据命令提示的选项进行安装，命令执行过程将会持续几分钟，请耐心等待。
关于安装与部署的更多细节请参考 安装 PandaWiki。
登录 PandaWiki
在上一步中，安装命令执行结束后，你的终端会输出以下内容。
SUCCESS 控制台信息:
SUCCESS 访问地址(内网): http://*.*.*.*:2443
SUCCESS 访问地址(外网): http://*.*.*.*:2443
SUCCESS 用户名: admin
SUCCESS 密码: **********************
使用浏览器打开上述内容中的 “访问地址”，你将看到 PandaWiki 的控制台登录入口，使用上述内容中的 “用户名” 和 “密码” 登录即可。
配置 AI 模型
PandaWiki 是由 AI 大模型驱动的 Wiki 系统，在未配置大模型的情况下 AI 创作、AI 问答、AI 搜索 等功能无法正常使用。
首次登录时会提示需要先配置 AI 模型，根据下方图片配置 “Chat 模型”。
推荐使用 百智云模型广场 快速接入 AI 模型，注册即可获赠 5 元的模型使用额度。 关于大模型的更多配置细节请参考 接入 AI 模型。
创建知识库
一切配置就绪后，你需要先创建一个 “知识库”。
“知识库” 是一组文档的集合，PandaWiki 将会根据知识库中的文档，为不同的知识库分别创建 “Wiki 网站”。
关于知识库的更多配置细节请参考 知识库设置。
💪 开始使用
如果你顺利完成了以上步骤，那么恭喜你，属于你的 PandaWiki 搭建成功，你可以：
- 访问 控制台 来管理你的知识库内容
- 访问 Wiki 网站 让你的用户使用知识库
社区交流
欢迎加入我们的微信群进行交流。
🙋♂️ 贡献
欢迎提交 Pull Request 或创建 Issue 来帮助改进项目。
📝 许可证
本项目采用 GNU Affero General Public License v3.0 (AGPL-3.0) 许可证。这意味着：
- 你可以自由使用、修改和分发本软件
- 你必须以相同的许可证开源你的修改
- 如果你通过网络提供服务，也必须开源你的代码
- 商业使用需要遵守相同的开源要求