PandaWiki README

The project's README from github.com/chaitin/PandaWiki. As one markdown file: README.md.

📖 官方网站   |   🙋‍♂️ 微信交流群

👋 项目介绍

PandaWiki 是一款 AI 大模型驱动的开源知识库搭建系统,帮助你快速构建智能化的 产品文档、技术文档、FAQ、博客系统,借助大模型的力量为你提供 AI 创作、AI 问答、AI 搜索 等能力。

⚡️ 界面展示

PandaWiki 控制台 Wiki 网站前台

🔥 功能与特色

🚀 上手指南

安装 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 模型,可自行选择一键配置或手动配置。

一键自动配置 AI 模型

手动自定义配置 AI 模型

推荐使用 百智云模型广场 快速接入 AI 模型,注册即可获赠 5 元的模型使用额度。 关于大模型的更多配置细节请参考 接入 AI 模型。

创建知识库

“知识库” 是一组文档的集合,PandaWiki 将会根据知识库中的文档,为不同的知识库分别创建 “Wiki 网站”。

💪 开始使用

如果你顺利完成了以上步骤,那么恭喜你,属于你的 PandaWiki 搭建成功,你可以:

💬 遇到问题

如在使用产品过程中遇到问题,可通过以下方式获取帮助:

社区交流

欢迎加入我们的微信群进行交流。

🙋‍♂️ 贡献

欢迎提交 Pull Request 或创建 Issue 来帮助改进项目。

📝 许可证

本项目采用 GNU Affero General Public License v3.0 (AGPL-3.0) 许可证。这意味着:

Star History

Star History Chart

PandaWiki (chaitin/PandaWiki)

Searching Database…

10.3K ·GitHub
这是什么?PandaWiki 是一个由大语言模型驱动的开源知识库系统:可以用它快速搭建产品文档、技术文档、FAQ 或博客,内置 AI 辅助写作、AI 问答和 AI 搜索。
这是需要注册使用的托管服务,还是我自己在服务器上部署的东西?需要自己部署:它是一个自托管(self-hosted)的 Web 系统,部署在你自己的 Linux 服务器上。所有操作都在浏览器控制台里完成,你创建的每个知识库都会有自己独立的 Wiki 网站。
我需要自己准备 AI 模型吗?需要。在首次登录后配置好模型之前,AI 写作、AI 问答和 AI 搜索都是禁用状态——可以一键配置,也可以手动配置。README 推荐使用百智云模型市场,注册后赠送 5 元额度。
安装之前有什么要求或要注意的坑吗?就 README 来说只支持 Linux:需要一台运行 Docker 20.x 或更高版本的机器,而且安装要以 root 身份执行。没有提到 Windows 或 macOS 的安装方式。
我实际能用它做出什么?产品文档、技术文档、FAQ 页面和博客——任何一批适合放在公开网站上、并希望附带 AI 问答和搜索功能的文档都可以。
我怎么把内容放进知识库?通过导入:PandaWiki 可以从网页 URL、网站的 sitemap、RSS 订阅源或本地文件拉取内容。导入后,文档会存入知识库,AI 也会基于这些内容进行学习。
它能触达自己 Wiki 网站之外的用户吗?可以——你可以把它作为网页组件嵌入到任何其他网站,或者把知识库做成钉钉、飞书或企业微信(WeCom)的聊天机器人。
我可以用什么格式写作,又能导出成什么格式?内置的富文本编辑器兼容 Markdown 和 HTML,文档可以导出为 Word、PDF、Markdown 等多种格式。
What are similar projects?docmost, zilan, wiki, LangBot, outline, docs, BookStack, showdoc
Creator
chaitin
Size
41.8 MB
Stars
10.3K
Age
1y
Commits · 90 Days