本文主要是介绍搭建zyplayer-doc个人WIKI文档管理工具,问题记录及简单使用,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
目录
- 项目简介
- 各模块介绍
- 项目部署
- 准备工作
- 修改配置及数据库初始化
- 编译部署
- 编译后文件
- 前后端在同一个部署包当中(无需单独部署前端)
- 环境部署目录规划
- 启动脚本编写
- 登录
- 部署问题记录
- 错误: 找不到或无法加载主类
- Failed to instantiate [javax.sql.DataSource]
- 项目简单使用
- 创建个人用户
- 基本模块使用
- 数据库文档
- WIKI文档
- API接口文档
zyplayer-doc官网地址,以下项目简介和模块介绍均取自官网
项目简介
zyplayer-doc是一款适合团队和个人使用的WIKI文档管理工具,同时还包含数据库文档、Api接口文档。
各模块介绍
-
zyplayer-doc-manage 文档管理后台
- 具有项目模块导航,人员及权限管理功能,分组管理等功能。
- 集成了本项目内的各个子模块功能,是各模块的协调管理模块。
-
zyplayer-doc-wiki wiki文档工具
- 在线管理公司、项目及任意形式的文档
- 文档支持按空间划分,按人员分组授权,支持空间收藏和空间内的文档开放访问。
- 文档支持编辑、查看、评论、上传附件、历史版本查看、页面权限控制、文档搜索等功能。
- 文档编辑支持html富文本方式编辑和markdown的方式编辑。
- 本工具使用的开源工具有:vue、element-ui、mavon-editor、wangeditor等。
- 参考学习了Atlassian Confluence文档工具进行开发,争取作为该软件的开源免费替代产品,同时作为内部文档管理工具最好的存在。
-
zyplayer-doc-db 数据库工具
一款在线管理数据库的工具,你可以将所有的数据源统一管理到这里面,团队间的各成员就不必每人在自己电脑上装一个数据库管理软件,
然后再添加数据源,可以统一修改数据库账号密码而不用群广播通知,新员工进入后对他使用到的数据源进行授权即可使用。- 支持MySQL、Doris(MySQL协议)、SQLServer、Oracle、达梦、PostgreSQL、Hive、Impala数据源。
- 支持数据库表、字段文档查看修改,表文档导出、建表语句DDL导出、表数据导出。
- 支持SQL执行、表数据预览、不同数据库之间的数据互导,支持多数据源管理。
- 支持按人员、按数据源对用户授权,可给用户 库表注释查看、注释修改、SQL执行、函数修改等粒度的授权。
- 支持库函数和存储过程的增删改查,修改记录查询等。
- 目标是取代Navicat,做一个小而精的开源免费的在线数据库管理工具。
-
zyplayer-doc-api API接口文档管理工具
一款支持统一管理Swagger文档、OpenApi文档、自建接口文档的管理工具,具有文档查看、接口请求、全局参数管理等功能,设计走心,前端代码使用最新技术构建,每一行代码都是全新手动敲出来的,超级简单明了,代码简洁美观可读性好、易维护。- 支持Swagger的文档展示,接口调试,解析速度快,界面设计走心。
- 支持将所有的Swagger文档、OpenApi文档、自建接口文档进行统一管理,支持全局参数设置,请求参数缓存,下次自动填充等。
- 目标是实现一个平台解决所有项目的接口文档统一管理。
-
其他
- zyplayer-doc-ui 前面各模块的前端UI源码
- zyplayer-doc-core 一些核心、公用的类
- zyplayer-doc-data 数据库层面的交互
- zyplayer-doc-other 一些测试
项目部署
准备工作
修改配置及数据库初始化
- zyplayer-doc-manage/src/main/resources/application.yml
-
指定合适的端口号
-
修改数据库信息,针对
mysql8
,url最好加上allowPublicKeyRetrieval=true
,如下:jdbc:mysql://192.168.38.10:3306/wiki_doc_db?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&autoReconnect=true&useSSL=false&rewriteBatchedStatements=true&allowPublicKeyRetrieval=true
-
指定文件相关存储路径
-
- 初始化数据库:
zyplayer-doc-manage/src/main/resources/sql
- 在数据库依次执行full.sql、1.1.2.sql、1.1.4.sql
官网说明:下载的master分支,目前对应的版本是1.1.5,启动后不会执行升级脚本,也不执行最初的初始化脚本
目前只有1.1.2和1.1.4会触发执行升级sql脚本,full.sql不会被触发,直接手动数据库执行一下,也花不了多少时间
- 在数据库依次执行full.sql、1.1.2.sql、1.1.4.sql
- 指定日志路径为绝对路径:
zyplayer-doc-manage/src/main/resources/logback.xml
编译部署
编译后文件
- 部署包(包含了前后端部署文件)
前后端在同一个部署包当中(无需单独部署前端)
环境部署目录规划
个人习惯通过指定main方法启动,因此划分很多目录,指定jar包启动简单些,但是如果配置不对,就需要重新打包,看个人习惯吧
启动脚本编写
- 包含了停止和启动两部分
#! /bin/bash
pid=$(ps -ef | grep "com.zyplayer.doc.manage.Application" | grep -v grep | awk '{print $2}')
if [ -n "$pid" ]; thenecho "stop wiki doc, pid:$pid"kill -9 "$pid"
fiAPP_HOME=/home/wiki/app/wiki
CLASS_PATH=${APP_HOME}/conf:${APP_HOME}/libs/*
exec nohup java -cp ${CLASS_PATH} -Dloader.main=com.zyplayer.doc.manage.Application org.springframework.boot.loader.PropertiesLauncher >/dev/null 2>&1 &
echo "wiki doc started"
- 启动服务
登录
启动成功,登录用户和密码为:zyplayer/123456
部署问题记录
错误: 找不到或无法加载主类
估计和zyplayer-doc的打包方式有关系,最终解决方式参照上面的启动脚本编写,即java -cp ${CLASS_PATH} com.zyplayer.doc.manage.Application
改成java -cp ${CLASS_PATH} -Dloader.main=com.zyplayer.doc.manage.Application org.springframework.boot.loader.PropertiesLauncher
Failed to instantiate [javax.sql.DataSource]
错误大概如下,复现不了了,原因就是连接数据库失败导致的,因为数据库使用的是mysql8,在url上拼接allowpublickeyretrieval=true
即可,奇怪的是去掉之后,也不报错了
Error creating bean with name 'manageDatasource' ...Failed to instantiate [javax.sql.DataSource]:
- Caused by: com.mysql.cj.exceptions.UnableToConnectException: Public Key Retrieval is not allowed
- 在JDBC连接串中加入
allowPublicKeyRetrieval=true
参数;
项目简单使用
创建个人用户
创建用户,默认是停用状态,别忘点开正常:
分配权限:
基本模块使用
数据库文档
一个人配置好,大家都可以用的,省的每次配置了
WIKI文档
感觉就是md编辑器,可以创建工作空间(公共,私人)
API接口文档
之所以去了解zyplayer-doc
,就是因为该模块介绍,感觉管理swagger很方便。平常开发项目比较多,版本比较多,浏览器收藏了很多swagger接口地址,就比较乱,突然发现有这么一个管理工具,就想尝试下,然并卵,后续有待研究,先午休一会吧
- 按照示例要求填写
可以跳转了,不能在线调试?
可以调试,离成功还差一点
这篇关于搭建zyplayer-doc个人WIKI文档管理工具,问题记录及简单使用的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!