一、zyplayer-doc是什么？

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

您也可以将其作为企业产品的说明文档来使用，支持一键将整个空间的内容开放到互联网，提供有不同风格的开放文档页样式可供选择，以及适配了在手机端、小程序中文档的展示，省去为产品的说明文档而定制开发系统的成本。

系统有开源协议友好的开源版本，可基于源码进行二次开发，也有功能丰富且完整的商业版本，可直接私有化部署使用，对于个人、开源项目或组织、教育用途完全免费。

您可以到项目体验地址：https://zyplayer.com 体验除管理员权限外的其他全部功能，完整功能可自行下载部署后体验，启动后即可直接访问使用。

二、项目的发展历程

项目从2018年初以开源的方式开始了此方向的研究，经过近一年的搭建与开发，2019年1月发布了第一个版本。

在后续两年中陆续发布了十余个版本，期间从WIKI文档、API文档、数据库文档、Dubbo、Elasticsearch等多个方向的文档做了深入的研究和实践，不断了解文档的编辑、查看、使用等全生命周期，深入理解了企业和个人对于文档的使用需求和痛点。

由于项目是以开源的方式发布，所以在其投入的精力和资源都非常有限，为了项目的健康可持续发展、保持稳定的更新及增强系统安全性，我们在2022年初选择了增加一个商业支持的版本，使项目朝着更好用、更现代化的方向不断努力着。

在团队成员的努力下我们保持了每个月两至三次的稳定更新，从商业版一发布就不断得到许多公司的关注与支持，在这一年中已有 100+ 的客户已经部署使用了起来，包括许多上市企业和用户数上千的企业都有在长期使用。我们不断满足客户提出的需求和建议，现在功能已非常丰富完善，能满足绝大部分公司的使用场景以及安全性、可靠性的要求。

还有很多公司在使用开源版做二次开发使用，期间对于他们提出的疑问和Bug我们都进行了积极的解答和处理。我们选择的是非常友好的Apache-2.0开源协议，几乎没有任何的二开限制。我们也在持续维护开源版本，期间有多位开发者（@diantu、@sh1yu 等）为项目做出了很多贡献，我们也一起进行了很多的技术探讨和交流，我们希望在文档管理私有化部署这一块能贡献一点自己的力量，让大家的文档多一分安全保障。

三、如何快速部署体验？

我们在软件的启动运行阶段做了非常多的工作，使其能以极简的方式配置并启动运行起来，只需准备好依赖的JAVA和MySQL后双击 startup.bat 即可使用。

1. 下载Java并安装

版本号：JAVA 1.8 及以上，本项目使用JAVA语言开发，启动时会依赖JAVA的运行时环境。

2. 安装数据库依赖

私有化部署后应用产生的所有数据都存储在您自己的MySQL数据库中，数据库我们支持 MySQL5.7.x、MySQL8.x 的版本，数据库安装成功后，需要您手动创建一个库：zyplayer_doc。

- 建库语句 
create database zyplayer_doc;

建表SQL脚本无需手动执行，首次启动或更新之后都会自动检查当前版本，然后自动执行升级的SQL脚本。

3. 下载安装文件

在官方文档页 https://doc.zyplayer.com 即可下载最新版本的安装文件，也可选择使用Docker方式安装。

4. 解压和修改配置

解压下载的压缩包， 修改文件夹下 application.properties 里面的数据库链接和帐号密码。

5. 启动软件

双击文件夹下的 startup.bat 启动项目，启动后访问：http://127.0.0.1:8083 ，默认账号：zyplayer 密码：123456，如果一切顺利，项目就部署完成了，登录系统后请务必修改默认的帐号密码。

四、zyplayer-doc都有哪些功能？

1、文档按空间划分，空间可任意组合成新的开放文集

知识库是按空间进行划分的，也可对空间进行分组管理，空间可设置为空间成员可见、企业内公开和互联网公开，具有非常细粒度的组织权限划分。

空间内可创建和管理不同类型的文档，如富文本、Markdown、表格、API文档、Office文档、大纲文档、本地上传文件等，有友好的文档查看页面和功能丰富的编辑器。

文档以树的形式进行管理，支持无限层级的文档划分组织，任意节点都可包含子文档，可对文档进行收藏置顶展示，支持文档全文检索，以空格分割的多关键字检索等，文档的访问数据具有统计分析功能，每天凌晨自动汇总前一天、周、月的数据，文档删除后可在回收站进行恢复和彻底删除。

2、支持一键将空间、文集开放至互联网可访问，可设置独立的文档查看域名

在空间设置页可将编写的文档发布至互联网，发布后获得链接的用户均可访问该空间内的文档，可用于企业产品文档、知识分享等场景使用。

开放文档具有多种展示主题，可设置密码访问、付费阅读、文档试读、动态密码访问等，满足用户绝大部分文档公开分享的场景使用。

也可以新规划几个域名，将域名映射到本系统的服务器上，在设置页绑定之后通过此域名访问本系统时将直接打开当前开放文档，不会再跳转登录等页面，可用于文档站的建设。

3、支持富文本、Markdown、表格、API文档、Office文档、大纲 编辑器

具有丰富的文档编辑类型支持，满足绝大部分在线文档编辑、查看、管理的场景，每一种编辑器都经过了长时间的打磨，兼具功能丰富和简洁美观的优点。

其中自研的Markdown编辑器除基础的格式外还支持了VuePress的提示组件、代码块高亮、多页签组件，还有分栏、卡片、名片、时间线、科学公式、Echarts图表、思维导图、流程图、时序图、PlantUML图 等一系列组件，还支持使用Vue编写更多自建组件使用。

Office文档支持Word、PPT、Excel、PDF格式文档的多人在线协同编辑查看，编辑体验和本地编辑器无异。

API文档支持接口文档的在线编辑、调试、公开分享等，作为系统内一种可选的文档类型，让API文档的管理不再独立和分散，基于内网部署也让您的API更加安全，可以更放心的编写内部或对外分享的API接口文档。

4、全屏演示、评论、附件、通知和编辑历史管理

在文档右上角操作区包含有各种功能操作按钮，针对单个文档的查看和管理更加方便快捷。

全屏演示功能可在内部投屏讲解时使用，文档更聚焦，文字也做了更大字号的显示。评论功能可对文档整体进行评论、发表意见，附件管理页可上传任意格式的文件，便于相关资源的分享与下载，历史管理页可查看每次保存的文档记录，也可查看或回滚指定的历史记录，便于文档的追溯和还原。

文档的通知包含了所有修改、评论、点赞等操作，让文档所属者及时掌握文档的变化。更多菜单里还包含开放文档的查看、单个文档的分享、页面展示的设置、模板设置、文档下载和文档信息等操作按钮。

5、支持文档版本控制

在空间设置页可开启版本控制功能，每完成一个版本文档的编写即可手动创建一个版本，各版本内的文档均可独立管理，用户在查看开放文档时也可在右上角切换版本查看对应版本的文档。

6、支持丰富的存储协议，以及登录安全控制

系统中图片或附件的存储支持文件系统、阿里云OSS、腾讯云COS、华为云OBS、MinIO、以及支持了Amazon S3协议的存储服务。

系统登录支持文档内置登录、SSO登录接入，可管理控制账号的密码复杂度，登录安全验证支持图形验证码、飞书、钉钉、企业微信的安全校验码，对于员工账号的登录安全做到最可靠的控制。

7、系统的其他功能

支持用户管理、用户权限管理、用户禁用启用等操作，部门以树的形式管理，部门可用于空间添加协作部门使用，可开启用户注册功能，开启后用户可自行在注册页面通过邮箱注册账号使用。

开放文档均支持开启付费阅读，让您的文档能产生实际的收入。

支持文档单页分享、文档导出、整个空间文档的导出、模板管理。

支持文档访问数据统计，有昨日数据、访问趋势分析、页面访问排行、活跃用户排行等一系列统计分析功能。

支持使用Vue编写自建组件，编写的组件可在Markdown文档中直接引用，可添加 iframe 嵌入任意网页，或是公用的广告组件等。

开放文档支持划词反馈，便于用户对于您文档的纠正、反馈和互动。