2024年必备的开源协作笔记与知识库：zyplayer-doc

一、zyplayer-doc是什么

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

支持将编写的文档一键发布为企业产品的帮助文档，支持以单文档、目录、空间、文集的方式开放至互联网，可用于独立的帮助中心站点，嵌入自有产品、APP、小程序或微信公众号菜单中用作帮助文档，或者用于展厅、大屏中滚动播放展示。

系统有开源协议友好的开源版本，源码完整开放无需任何授权，无任何商业用途的二次开发限制，可高度定制修改。也有功能丰富且完整的商业版本，可直接私有化部署使用，对于个人、开源项目或组织、教育用途完全免费。

二、适用场景

• 企业知识库： 可用于企业内部知识积累与协作的文档管理平台，所有修改可追溯，全局内容搜索查找文档更便捷。云端管理防止文档丢失，企业人员流动不会导致企业知识资产的流失。

• 产品帮助文档： 可将编辑好的文档一键开放给外部访问，产品文档的维护和分享更加便捷。可用于独立的文档站点，嵌入自有产品、APP、小程序或微信公众号菜单中用作产品帮助文档，或者用于展厅、大屏中滚动播放展示。

• 个人笔记与知识库： 可以私有化部署在自己电脑上或云端，用作个人的笔记软件使用，不再担心个人隐私信息泄露，不再担心云服务厂商突然的停服、泄露、收费或倒闭断供，导致自己长期积累的知识全部丢失。

• 知识分享与博客： 可非常方便的将自己的知识进行公开分享，或者作为自己产品的帮助文档使用，可实时编辑与发布生效。也可以当作博客系统来使用，目录树的层级模式让阅读与查找更加便捷。

三、功能与亮点

• 团队协作编辑： 完善的权限体系，支持空间、用户、部门、文档粒度的权限管控，包含管理员、协作者、查看者角色。

• 丰富的编辑器： 支持在线编辑富文本、Markdown、表格、Office文档、API接口、思维导图、任意的文本文件等。

• 一键对外开放： 支持将文档以空间、单文档、文集的方式对外公开，可独立的站点或URL访问，也可嵌入自有产品中。

• 空间数据分析： 空间支持访问趋势分析、页面访问排行、用户活跃排行的数据分析，支持按日周月维度的统计查看。

• 文档版本控制： 空间和文集支持版本的控制，让文档和产品具有版本的对应关系，防止更新后旧版本的文档无法访问。

• 文档导入导出： 系统支持任意格式文件的导入，支持空间整体的导入、导出与复制，支持文档的跨空间复制与迁移。

• 多种存储方式： 可使用文件系统、阿里云OSS、腾讯云COS、华为云OBS、MinIO、以及所有支持S3协议的对象存储。

• 全屏水印管理： 支持内部文档、开放文档的全屏水印独立配置，支持上传的图片中添加水印，防止数据泄露与复制。

• 全局内容搜索： 可对知识库中的内容进行全局自动分词搜索，包含Word、PPT、Excel、PDF与扫描件、图片文字搜索。

• 知识库AI问答： 接入AI产品后可基于知识库中的内容进行AI问答，AI问答来源安全可控，更加智能的内容搜索体验。

• 更安全的登录： 支持常规登录、LDAP、OAuth2、飞书、钉钉、企业微信账号体系的登录，支持双因素认证与开放注册。

• 国际化多语言： 具有完善的多语言体系，支持系统级别、用户个人、每个开放空间或文集选择指定的语言分别展示。

• 文档付费阅读： 可快速的接入与开启开放文档的付费阅读功能，无需对接三方支付，可自行定价，让知识产生价值。

• 系统全局管控： 系统中展示的LOGO、标题、备案信息、主题色、三方验证接口、全局CSS、网页代码均可自行配置。

• 自建组件支持： 支持管理与编辑自定义的Vue组件在文档内容中渲染并展示，让文档的展示内容具有无限的可能。

四、快速部署

软件的部署比较简单，安装必要的JAVA环境依赖和一个MySQL数据库，去官网下载最新的安装包，然后修改数据库配置后执行 ./startup.sh 即可启动起来，或者使用Docker部署：docker pull zyplayer/zyplayer-doc:latest，也可以使用 1Panel 、宝塔面板、NAS 等方式部署，详细的部署方法可在官方文档中查看： https://doc.zyplayer.com

五、功能介绍

1、知识库管理

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

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

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

2、公开分享与开放文集

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

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

3、丰富的编辑器

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

其中自研的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 嵌入任意网页，或是公用的广告组件等。

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