update README.md.

Signed-off-by: sswiki <1773266885@qq.com>
This commit is contained in:
sswiki
2023-10-27 06:29:02 +00:00
committed by Gitee
parent 2c66ad1b1a
commit abcec4c846
3 changed files with 26 additions and 7 deletions

View File

@@ -1,5 +1,14 @@
<p align="center">
![](zyplayer-doc-other/resource/logo.png)
</p>
<h1 align="center">zyplayer-doc</h1>
<p align="center">专注于私有化部署的在线知识库管理平台</p>
# 项目简介
zyplayer-doc是一款适合团队和个人使用的WIKI文档管理工具同时还包含数据库文档、Api接口文档。
zyplayer-doc是一款适合团队和个人私有化部署使用的WIKI文档管理工具同时还包含数据库管理、Api接口管理等模块
适合作为公司内部或个人的知识库、笔记、文档管理工具,将文档发布成对外可访问的形式,可作为公司的产品文档、帮助文档等。
体验地址:[http://zyplayer.com](http://zyplayer.com)
@@ -10,32 +19,42 @@ zyplayer-doc是一款适合团队和个人使用的WIKI文档管理工具
欢迎加入微信群与我们一起交流
> 微信群员超过限制只能加好友拉进群,添加微信好友,回复:`加群` 即可
![weixinqun.jpg](https://zyplayer.oss-cn-beijing.aliyuncs.com/doc/weixin/weixinqun.png)
![weixinqun.jpg](zyplayer-doc-other/resource/weixinqun.png)
# 快速启动
## 相关依赖
启动本系统仅依赖JAVA和MySQL
- JAVA 1.8+
- MySQL 5.7.x
- MySQL 5.7.x、8.x
建表SQL脚本无需手动执行每次启动或更新之后都会检查当前版本然后自动执行升级SQL脚本所以每次有版本更新需求只需要下载最新版本启动即可无需其他特殊操作
数据库安装成功后,需要您**手动创建**一个库:`zyplayer_doc`
```sql
-- 建库语句
create database zyplayer_doc;
```
> 建表SQL脚本无需手动执行每次启动或更新之后都会检查当前版本然后自动执行升级SQL脚本所以每次有版本更新需求只需要下载最新版本启动即可无需其他特殊操作
## Main方法启动
1. 修改`zyplayer-doc/zyplayer-doc-manage/src/main/resources/application.yml`配置文件里面的数据库账号密码
2. 执行`com.zyplayer.doc.manage.Application.main`方法启动项目
## JAR方式启动
1. 直接下载直接下载编译好的jar打包文件编译后的最新版可到[在线文档](http://doc.zyplayer.com)右上角去下载
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打包文件编译后的最新版可到[在线文档](http://doc.zyplayer.com)右上角去下载
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://127.0.0.1:8083/zyplayer-doc](http://127.0.0.1:8083/zyplayer-doc) ,默认登录账号: **zyplayer** 密码: **123456**
## 其他
更多启动方式请参考文档:[项目下载与部署](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 文档管理后台

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB