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
What is this?PandaWiki is an open-source knowledge base system powered by large language models: use it to quickly build product docs, technical docs, FAQs or a blog, with AI-assisted writing, AI Q&A and AI search built in.
Is this a hosted service I sign up for, or something I run on my own server?You run it yourself: it's a self-hosted web system you deploy on your own Linux server. You manage everything from a browser console, and each knowledge base you create gets its own Wiki website.
Do I need to bring my own AI model?Yes. AI writing, AI Q&A and AI search stay disabled until you configure a model after first login — one-click or manual. The README recommends the Baizhi Cloud (百智云) model marketplace, which grants 5 yuan of credit on sign-up.
Are there any requirements or gotchas before installing?It's Linux-only as far as the README goes: you need a machine running Docker 20.x or higher, and the install runs as root. No Windows or macOS install path is mentioned.
What can I actually build with it?Product documentation, technical docs, FAQ pages and blogs — any collection of documents that benefits from a public site with AI answers and search on top.
How do I get content into a knowledge base?Import it: PandaWiki can pull content from web page URLs, a site's sitemap, RSS feeds, or offline files. Once imported, the documents are stored in the knowledge base and the AI learns from them.
Can it reach users outside its own wiki site?Yes — you can embed it as a web widget on any other website, or turn a knowledge base into a chatbot for DingTalk, Feishu or WeCom (WeChat Work).
What formats can I write in and export to?The built-in rich text editor is compatible with Markdown and HTML, and documents can be exported to Word, PDF, Markdown and several other formats.
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