补充文档

This commit is contained in:
jiangzeyin 2019-04-23 20:50:53 +08:00
parent 4e6f3b547d
commit 1199c63939
8 changed files with 105 additions and 28 deletions

View File

@ -8,7 +8,7 @@
2. 多节点统一管理(插件模式) 2. 多节点统一管理(插件模式)
3. 证书解析支持cer 证书(感谢@JAVA jesion) 3. 证书解析支持cer 证书(感谢@JAVA jesion)
4. 新增记录用户操作日志[采用H2数据库](感谢@〓下页) 4. 新增记录用户操作日志[采用H2数据库](感谢@〓下页)
5. 节点分发功能、合并管理项目 5. 节点分发功能、合并管理项目(感谢@其锋)
### 解决BUG、优化功能 ### 解决BUG、优化功能

32
FQA.md
View File

@ -2,23 +2,23 @@
### 如何修改程序运行端口 ### 如何修改程序运行端口
修改管理程序命令文件中 --server.port=2122 > 修改管理程序命令文件中 --server.port=2122
### 如何修改程序日志路径 ### 如何修改程序日志路径
修改管理程序命令文件中 --jpom.log=/jpom/log/ > 修改管理程序命令文件中 --jpom.log=/jpom/log/
### 如何修改会话超时时长 ### 如何修改会话超时时长
在管理程序命令文件中 ARGS 变量添加 --tomcat.sessionTimeOut=1800 > 在管理程序命令文件中 ARGS 变量添加 --tomcat.sessionTimeOut=1800
### 如何修改Jpom数据存储目录 ### 如何修改Jpom数据存储目录
修改外部配置文件中的 jpom.path 属性 > 修改外部配置文件中的 jpom.path 属性
### 忘记系统管理员密码 ### 忘记系统管理员密码
删除Server端的数据目录中的 user.json 文件即可,删除此文件不影响其他数据 > 删除Server端的数据目录中的 user.json 文件即可,删除此文件不影响其他数据
### 在linux 系统中执行Jpom.sh 提示 ### 在linux 系统中执行Jpom.sh 提示
@ -29,19 +29,22 @@
执行如下命令:(https://blog.csdn.net/perter_liao/article/details/76757605) 执行如下命令:(https://blog.csdn.net/perter_liao/article/details/76757605)
1.编辑文件 1.编辑文件
#vim filename文件名 vim filename文件名
2.进入末行模式按esc键 2.进入末行模式按esc键
3.设置文件格式 3.设置文件格式
set fileformat=unix :set fileformat=unix
4.保存退出 4.保存退出
wq :wq
5.#sh filename 5.#sh filename
OK! OK!
### windows 中执行管理bat命令乱码或者执行失败
> 请修改文件编码为当前系统默认的编码windows中默认为GB2312
### 启动Jpom提示 ### 启动Jpom提示
![jpom](/doc/error/jdk-error.png) ![jpom](/doc/error/jdk-error.png)
@ -52,19 +55,6 @@
[查看>>](/doc/nginx-config.md) [查看>>](/doc/nginx-config.md)
### 启动提示数据目录权限不足
> jpom 数据目录权限不足...
请检查当前用户是否拥有对应目录的读写权限
[https://gitee.com/keepbx/Jpom/wikis/pages?sort_id=1395625&doc_id=264493](https://gitee.com/keepbx/Jpom/wikis/pages?sort_id=1395625&doc_id=264493)
### 启动提示JDK没有找到tools.jar
[https://gitee.com/keepbx/Jpom/wikis/pages?sort_id=1398788&doc_id=264493](https://gitee.com/keepbx/Jpom/wikis/pages?sort_id=1398788&doc_id=264493)
### Jpom添加项目、启动、查看项目报错 ### Jpom添加项目、启动、查看项目报错
1.运行的java进程有32位和64位的 1.运行的java进程有32位和64位的

View File

@ -147,12 +147,13 @@ Agent.sh status 查看Jpom插件端运行状态
### 常见问题、操作说明 ### 常见问题、操作说明
| 安装 | 说明 | | 说明1 | 说明2 |
| -- | -- | | -- | -- |
| [安装文档>>](/doc/install.md) | [用户角色说明>>](/doc/userRole.md) | | [安装文档>>](/doc/install.md) | [用户角色说明>>](/doc/userRole.md) |
| [常见问题>>](/FQA.md) | [阿里云Oss配置>>](/doc/CodePipeline-Oss.md) | | [常见问题>>](/FQA.md) | [阿里云Oss配置>>](/doc/CodePipeline-Oss.md) |
| [启动失败问题>>](https://gitee.com/keepbx/Jpom/wikis/pages?sort_id=1395625&doc_id=264493) | [更新日志>>](/CHANGELOG.md) | | [启动失败问题>>](/doc/startFail.md) | [更新日志>>](/CHANGELOG.md) |
| | [开发计划>>](/PLANS.md) | | | [开发计划>>](/PLANS.md) |
| [项目属性说明>>](/doc/project.md) | [删除项目说明>>](/doc/deleteProject.md) |
### 交流讨论 、提供bug反馈或建议 ### 交流讨论 、提供bug反馈或建议

7
doc/deleteProject.md Normal file
View File

@ -0,0 +1,7 @@
## 删除项目的说明
1. 正在运行的项目不能删除
2. 项目删除并不会删除项目的jar目录的文件而只是删除关系
3. 删除后可以在项目回收站中查看被删除的项目所有信息
如果是节点分发的项目不能在项目配置页面删除,需要到节点分发中删除

56
doc/project.md Normal file
View File

@ -0,0 +1,56 @@
## 项目属性说明
### 1. 项目名称
> 为项目取一个动听的名字
### 2. 分组名称
> 是为了在多个项目中区分和在项目列表中快速选择
### 3. 项目ID
> 一旦创建后是无法修改的(Jpom中以项目ID为参照判断程序运行状态)
### 4. 运行方式
> Jpom目前支持两种运行方式 jar和classpath jar即为运行jar包java -jar classpath即为运行多个jar(java -classpath)
### 5. 项目路径
> 为在白名单中配置的信息
> 在创建项目时候需要选择对应的一个目录以来决定项目的实际jar包信息会存放在对应的目录之下
### 6. 项目Jar包即为项目存放jar包的文件夹路径注意是文件夹而不是文件
> 注意项目的实际jar存放的路径是以 选择的项目路径+填写的项目jar包路径如图选择的项目路径为(D:/dev) 填写的项目jar包为(sss)
> 那么项目实际的jar会存放在 D:/dev/sss 文件夹中
> 同时注意最终的项目实际路径限制如下:
> 1. 如果实际路径为一个已经存在的文件,是不可以创建对应的项目的
> 2. 如果实际路径是一个已经存在的文件夹,那么项目的文件会直接使用的
> 3. 如果在修改项目jar包含子项目路径时遇到新的实际路径已经存在那么程序复制原实际路径中的所有文件到新的实际路径中存在相同的则覆盖
### 7. MainClass
> 程序的主类当项目运行方式为Jar时此项必填
### 8. WebHooks
> 当关闭Jpom时程序会自动请求对应的路径(get方式请求)
### 9. Build标识
> 需要和阿里云oss配置配合使用
### 10. Jvm参数
> 设置java虚拟机参数
> 如:-Xmin=512m -Xmax=512m
### 11. Args参数
> 程序运行的main方式参数
> 如:--service.port=8080

23
doc/startFail.md Normal file
View File

@ -0,0 +1,23 @@
## 启动失败常见问题
### 1. 文件夹没有读写权限
> 这种错误是因为在linux或者mac系统中当前账户没有对应目录的权限请检查当前账户是否有对应目录的读写权限
![输入图片说明](https://images.gitee.com/uploads/images/2019/0326/110600_12eb4b84_804942.png "屏幕截图.png")
![输入图片说明](https://images.gitee.com/uploads/images/2019/0326/110946_324cf533_804942.png "屏幕截图.png")
### 2. JDK没有找到tools.jar
> 这种错误是因为当前JDK环境中没有对应tools.jar 解决方案就是根据当前java版本号下载对应的tools.jar 放于对应目录即可
![输入图片说明](https://images.gitee.com/uploads/images/2019/0326/155336_123b4b27_804942.png "屏幕截图.png")
### 3. 初始化数据库失败
> 请根据具体的异常信息进行处理,一般存在数据库文件被占用、账号密码错误等
> 如果出现某些字段错误,请及时联系我们。确认最新的解决方案

View File

@ -16,6 +16,8 @@ import java.io.InputStream;
/** /**
* 初始化数据库
*
* @author jiangzeyin * @author jiangzeyin
* @date 2019/4/19 * @date 2019/4/19
*/ */
@ -28,7 +30,7 @@ public class InitDb {
setting.set("url", DbConfig.getInstance().getDbUrl()); setting.set("url", DbConfig.getInstance().getDbUrl());
setting.set("user", "jpom"); setting.set("user", "jpom");
setting.set("pass", "jpom"); setting.set("pass", "jpom");
// // 调试模式显示sql 信息
if (JpomManifest.getInstance().isDebug()) { if (JpomManifest.getInstance().isDebug()) {
setting.set("showSql", "true"); setting.set("showSql", "true");
setting.set("sqlLevel", "INFO"); setting.set("sqlLevel", "INFO");
@ -41,7 +43,7 @@ public class InitDb {
String sql = IoUtil.read(inputStream, CharsetUtil.CHARSET_UTF_8); String sql = IoUtil.read(inputStream, CharsetUtil.CHARSET_UTF_8);
Db.use().execute(sql); Db.use().execute(sql);
} catch (Exception e) { } catch (Exception e) {
DefaultSystemLog.ERROR().error("初始化数据失败", e); DefaultSystemLog.ERROR().error("初始化数据失败", e);
System.exit(0); System.exit(0);
} }
} }

View File

@ -49,8 +49,6 @@
<systemPath>${java.home}/../lib/tools.jar</systemPath> <systemPath>${java.home}/../lib/tools.jar</systemPath>
</dependency> </dependency>
<dependency> <dependency>
<groupId>junit</groupId> <groupId>junit</groupId>
<artifactId>junit</artifactId> <artifactId>junit</artifactId>