|
|
<p align="center">
|
|
|
<img src="https://gitee.com/dromara/zyplayer-doc/raw/master/zyplayer-doc-other/resource/logo.png">
|
|
|
</p>
|
|
|
|
|
|
<h1 align="center">zyplayer-doc</h1>
|
|
|
|
|
|
<p align="center">专注于私有化部署的在线知识库管理平台</p>
|
|
|
|
|
|
# 项目简介
|
|
|
zyplayer-doc是一款适合团队和个人私有化部署使用的WIKI文档管理工具，同时还包含数据库管理、Api接口管理等模块。
|
|
|
|
|
|
适合作为公司内部或个人的知识库、笔记、文档管理工具，将文档发布成对外可访问的形式，可作为公司的产品文档、帮助文档等。
|
|
|
|
|
|
体验地址：[http://zyplayer.com](http://zyplayer.com)
|
|
|
|
|
|
在线文档：[http://doc.zyplayer.com](http://doc.zyplayer.com)
|
|
|
|
|
|
欢迎有想法的同学一起来完善，如果觉得不错就给个Star鼓励下呗！作为给项目快速更新的动力！
|
|
|
|
|
|
欢迎加入微信群与我们一起交流
|
|
|
> 微信群员超过限制只能加好友拉进群，添加微信好友，回复：`加群` 即可
|
|
|
|
|
|
|
|
|
|
|
|
# 快速启动
|
|
|
## 相关依赖
|
|
|
启动本系统仅依赖JAVA和MySQL
|
|
|
- JAVA 1.8+
|
|
|
- MySQL 5.7.x、8.x
|
|
|
|
|
|
数据库安装成功后，需要您**手动创建**一个库：`zyplayer_doc`
|
|
|
|
|
|
```sql
|
|
|
-- 建库语句
|
|
|
create database zyplayer_doc;
|
|
|
```
|
|
|
|
|
|
> 建表SQL脚本无需手动执行，每次启动或更新之后都会检查当前版本，然后自动执行升级SQL脚本，所以每次有版本更新需求只需要下载最新版本启动即可，无需其他特殊操作
|
|
|
|
|
|
## 宝塔面板一键部署
|
|
|
- 安装宝塔面板，前往[宝塔面板](https://www.bt.cn/u/2OCdV3)官网，选择对应的脚本下载安装，宝塔版本：`9.2.0+`
|
|
|
- 登录宝塔面板，在菜单栏中点击 Docker，根据提示安装 Docker 和 Docker Compose 服务，若已有则跳过
|
|
|
- 在Docker-应用商店查询到 zyplayer-doc，点击安装
|
|
|
- 设置域名等基本信息，点击确定
|
|
|
- 提交后面板会自动进行应用初始化，大概需要1-5分钟，初始化完成后即可访问。
|
|
|
|
|
|
|
|
|
## Main方法启动
|
|
|
1. 修改`zyplayer-doc-manage/src/main/resources/application.yml`配置文件里面的数据库账号密码
|
|
|
2. 执行`org.dromara.zyplayer.manage.Application.main`方法启动项目
|
|
|
|
|
|
## JAR方式启动
|
|
|
1. 直接下载：直接下载编译好的jar打包文件，编译后的最新版可到 [发行版下载处](https://gitee.com/dromara/zyplayer-doc/releases) 去下载
|
|
|
2. 自行编译：也可以自己动手编译，双击执行：`zyplayer-doc\build.bat`，将使用maven编译整个项目为可执行的jar文件，编译结果文件放在：`zyplayer-doc\dist\version`文件夹下
|
|
|
3. 修改第一步或第二步结果文件夹下的`application.yml`文件里面数据库帐号密码
|
|
|
4. 双击第一步或第二步结果文件夹下的`startup.bat`启动项目
|
|
|
|
|
|
## Tomcat容器启动
|
|
|
1. 直接下载编译好的war打包文件，编译后的最新版可到 [发行版下载处](https://gitee.com/dromara/zyplayer-doc/releases) 去下载
|
|
|
2. 修改配置文件：`zyplayer-doc.zip\apache-tomcat\webapps\zyplayer-doc\WEB-INF\classes\application.yml`配置文件里面的数据库账号密码
|
|
|
3. 双击`tomcat\bin\startup.bat`启动即可
|
|
|
|
|
|
## 其他
|
|
|
更多启动方式请参考文档：[项目下载与部署](http://doc.zyplayer.com/#/integrate/zyplayer-doc/opensource/279)
|
|
|
|
|
|
启动后访问：[http://127.0.0.1:8083](http://127.0.0.1:8083) ，默认登录账号： **zyplayer** 密码： **123456**
|
|
|
|
|
|
# 各模块介绍
|
|
|
## zyplayer-doc-manage 文档管理后台
|
|
|
1. 具有项目模块导航，人员及权限管理功能，分组管理等功能。
|
|
|
2. 集成了本项目内的各个子模块功能，是各模块的协调管理模块。
|
|
|
|
|
|
## zyplayer-doc-wiki wiki文档工具
|
|
|
1. 在线管理公司、项目及任意形式的文档
|
|
|
2. 文档支持按空间划分，按人员分组授权，支持空间收藏和空间内的文档开放访问。
|
|
|
3. 文档支持编辑、查看、评论、上传附件、历史版本查看、页面权限控制、文档搜索等功能。
|
|
|
4. 文档编辑支持html富文本方式编辑和markdown的方式编辑。
|
|
|
5. 本工具使用的开源工具有：vue、element-ui、mavon-editor、wangeditor等。
|
|
|
6. 参考学习了Atlassian Confluence文档工具进行开发，争取作为该软件的开源免费替代产品，同时作为内部文档管理工具最好的存在。
|
|
|
|
|
|
## zyplayer-doc-db 数据库工具
|
|
|
一款在线管理数据库的工具，你可以将所有的数据源统一管理到这里面，团队间的各成员就不必每人在自己电脑上装一个数据库管理软件，
|
|
|
然后再添加数据源，可以统一修改数据库账号密码而不用群广播通知，新员工进入后对他使用到的数据源进行授权即可使用。
|
|
|
|
|
|
1. 支持MySQL、Doris（MySQL协议）、SQLServer、Oracle、达梦、PostgreSQL、Hive、Impala数据源。
|
|
|
2. 支持数据库表、字段文档查看修改，表文档导出、建表语句DDL导出、表数据导出。
|
|
|
3. 支持SQL执行、表数据预览、不同数据库之间的数据互导，支持多数据源管理。
|
|
|
4. 支持按人员、按数据源对用户授权，可给用户 库表注释查看、注释修改、SQL执行、函数修改等粒度的授权。
|
|
|
5. 支持库函数和存储过程的增删改查，修改记录查询等。
|
|
|
6. 目标是取代Navicat，做一个小而精的开源免费的在线数据库管理工具。
|
|
|
|
|
|
## zyplayer-doc-api API接口文档管理工具
|
|
|
一款支持统一管理Swagger文档、OpenApi文档、自建接口文档的管理工具，具有文档查看、接口请求、全局参数管理等功能，设计走心，前端代码使用最新技术构建，每一行代码都是全新手动敲出来的，超级简单明了，代码简洁美观可读性好、易维护。
|
|
|
|
|
|
1. 支持Swagger的文档展示，接口调试，解析速度快，界面设计走心。
|
|
|
2. 支持将所有的Swagger文档、OpenApi文档、自建接口文档进行统一管理，支持全局参数设置，请求参数缓存，下次自动填充等。
|
|
|
3. 目标是实现一个平台解决所有项目的接口文档统一管理。
|
|
|
|
|
|
## 其他
|
|
|
1. zyplayer-doc-ui 前面各模块的前端UI源码
|
|
|
2. zyplayer-doc-core 一些核心、公用的类
|
|
|
3. zyplayer-doc-data 数据库层面的交互
|
|
|
5. zyplayer-doc-other 一些测试
|
|
|
|
|
|
# 用爱发电
|
|
|
如果您正在使用这个项目并感觉良好，或者是想支持项目继续开发，您可以通过如下`任意`方式支持我们：
|
|
|
1. Star并分享 [zyplayer-doc](https://gitee.com/zyplayer/zyplayer-doc)
|
|
|
2. 保留`关于页面`的项目链接
|
|
|
3. 你也可以选择使用 [商业版](https://doc.zyplayer.com/#/integrate/zyplayer-doc/commercial) 来支持我们
|
|
|
|
|
|
# 界面展示
|
|
|
控制台页面
|
|
|
|
|
|
|
|
|
数据库文档页面
|
|
|
|
|
|
|
|
|
WIKI文档页面
|
|
|
|
|
|
|
|
|
API文档主页面
|
|
|
|
|
|
|
|
|
API文档查看页面
|
|
|
|
|
|
|
|
|
API文档在线调试页面
|
|
|
|