zyplayer-doc 是一款适合企业和个人使用的 WIKI 知识库管理工具，提供在线化的知识库管理功能，专为私有化部署而设计，最大程度上保证企业或个人的数据安全，可以完全以内网的方式来部署使用。

也可以将其作为企业产品的说明文档来使用，支持一键将整个空间的内容开放到互联网，并提供有不同风格的开放文档页样式可供选择，省去为了产品的说明文档而去定制开发一个系统的成本。

也完全可以用它来替换 VuePress、Docsify、Docute、Hexo、GitBook 等文档网站生成器，当然，他们都是了不起的存在，都有着自己的特殊的强大的功能特性，某些特性在这里可能暂时无法得到满足，所以还需要自行对比选择。但，何不来尝试折腾一下这个纯国产的工具项目呢~期待有一天我们也能与其站在同一个竞技赛场上！

🎨️ 功能亮点

•  简洁清爽

简洁的用户界面，极简化的启动配置，现代化的操作交互，专注于写作与知识积累。

• 功能丰富

项目囊括了绝大部分文档使用的场景，文档的编辑、协作、开放访问全部支持。

• 数据安全

以极低的成本快速将项目部署至自己的服务器中使用，数据始终掌握在自己手中。

• 易学易用

支持富文本编辑器和Markdown编辑的组合，同时还支持表格文档等，满足大部分使用习惯。

• 友好开放

提供有开源协议友好的开源版，提供最好的服务。

• 健康稳定

经验丰富的团队开发迭代，稳定的更新发布周期，最前沿的技术支撑。

🧰 私有化部署

前提依赖：

• JAVA 1.8+
• MySQL 5.7.x、8.x
• Maven 3.6+

1、手动创建一个库：zyplayer_doc

建表SQL脚本无需手动执行，每次启动或更新之后都会检查当前版本，然后自动执行升级SQL脚本，所以每次有版本更新需求只需要下载最新版本启动即可，无需其他特殊操作。

-- 建库语句create database zyplayer_doc;
2、使用 Gi t命令 clone 项目源码到服务器

git clone https://gitee.com/zyplayer/zyplayer-doc.git

3、配置数据库修改配置文件里面的数据库账号、密码，文件路径如下：

zyplayer-doc-manage/src/main/resources/application.yml

项目配置

如 wiki 文件上传的存放目录，wiki 文档 git 版本管理文件的存放目录等，你需要将其修改为你正式的存放地址，如图所示：

、编译打包
Windows 执行脚本：

zyplayer-doc\build.bat

Linux执行脚本：

zyplayer-doc\build.sh

编译结果文件放在：zyplayer-doc\dist 文件夹下。

6、启动

在zyplayer-doc\dist\{zyplayer-doc-版本号}里找到启动脚本：

• Windows 直接双击 startup.bat 启动
• Linux在终端运行 startup.sh 启动

6、浏览器访问启动后访问：http://localhost:8083默认账号：zyplayer

默认密码：123456