[开源]专注于私有化部署的在线知识库管理平台、Wiki文档管理工具
![[开源]专注于私有化部署的在线知识库管理平台、Wiki文档管理工具](https://yy123.ink/api/img/1782602694821-qz62ft.jpg)
一、开源项目简介

zyplayer-doc
专注于私有化部署的在线知识库管理平台
zyplayer-doc是一款适合团队和个人私有化部署使用的WIKI文档管理工具,同时还包含数据库管理、Api接口管理等模块。
适合作为公司内部或个人的知识库、笔记、文档管理工具,将文档发布成对外可访问的形式,可作为公司的产品文档、帮助文档等。
二、开源协议
使用Apache-2.0开源协议
三、界面展示
界面展示
控制台页面 
WIKI文档页面 
标准版界面展示










来源:zyplayer-doc 官网
四、功能概述
zyplayer-doc是一款专注于个人与企业私有化部署使用的知识库、WIKI文档管理系统,丰富的功能可满足企业几乎所有的文档管理场景需求。
数据安全可控
数据安全大于一切,我们专注于提供私有化部署的文档管理系统,数据始终掌握在自己手中
丰富的编辑器
支持在线编辑富文本、Markdown、表格、Office文档、API接口、思维导图、任意的文本文件等
团队协作编辑
完善的权限体系,支持空间、用户、部门、文档粒度的权限管控,包含管理员、协作者、查看者角色
多种登录方式
支持常规登录、LDAP、OAuth2、飞书、钉钉、企业微信账号体系的登录,支持双因素认证与开放注册
一键对外开放
支持将文档以空间、单文档、文集的方式对外公开,用途多样,支持基于知识库内容的AI问答
项目健康稳定
我们有稳定的付费客户支持,有经验丰富的团队开发迭代,稳定的更新发布周期,使用更有保障
来源:zyplayer-doc 官网
五、技术选型
站在巨人的肩膀上
此项目基于以下开源软件构建
后端:
Spring-Boot、 MyBatis、 Druid、 MyBatis-Plus、 Hutool、 Fastjson、 Easy Excel、 Swagger、 Dubbo、 JGit、等等...
前端:
Vue、vite、element-ui、pinia、wangeditor、mavon-editor、qrcodejs2、vant、vue-router、axios、vue-hljs、brace、echarts、sql-formatter、vue-clipboard2、等等...
快速启动
相关依赖
启动本系统仅依赖JAVA和MySQL
-
JAVA 1.8+
-
MySQL 5.7.x、8.x
数据库安装成功后,需要您手动创建一个库:zyplayer_doc
建表SQL脚本无需手动执行,每次启动或更新之后都会检查当前版本,然后自动执行升级SQL脚本,所以每次有版本更新需求只需要下载最新版本启动即可,无需其他特殊操作
宝塔面板一键部署
-
安装宝塔面板,前往宝塔面板官网,选择对应的脚本下载安装,宝塔版本:9.2.0+
-
登录宝塔面板,在菜单栏中点击 Docker,根据提示安装 Docker 和 Docker Compose 服务,若已有则跳过
-
在Docker-应用商店查询到 zyplayer-doc,点击安装
-
设置域名等基本信息,点击确定
-
提交后面板会自动进行应用初始化,大概需要1-5分钟,初始化完成后即可访问。

Main方法启动
-
修改zyplayer-doc-manage/src/main/resources/application.yml配置文件里面的数据库账号密码
-
执行org.dromara.zyplayer.manage.Application.main方法启动项目
JAR方式启动
-
直接下载:直接下载编译好的jar打包文件,编译后的最新版可到 发行版下载处 去下载
-
自行编译:也可以自己动手编译,双击执行:zyplayer-doc\build.bat,将使用maven编译整个项目为可执行的jar文件,编译结果文件放在:zyplayer-doc\dist\version文件夹下
-
修改第一步或第二步结果文件夹下的application.yml文件里面数据库帐号密码
-
双击第一步或第二步结果文件夹下的startup.bat启动项目
Tomcat容器启动
-
直接下载编译好的war打包文件,编译后的最新版可到 发行版下载处 去下载
-
修改配置文件:zyplayer-doc.zip\apache-tomcat\webapps\zyplayer-doc\WEB-INF\classes\application.yml配置文件里面的数据库账号密码
-
双击tomcat\bin\startup.bat启动即可
其他
更多启动方式请参考文档:项目下载与部署
启动后访问:http://127.0.0.1:8083 ,默认登录账号: zyplayer 密码: 123456