Jpom/README.md

167 lines
7.9 KiB
Markdown
Raw Normal View History

2019-01-04 15:34:10 +08:00
# Jpom(Java Project Online Management)Java项目在线管理
2018-06-25 22:55:37 +08:00
2019-04-15 09:48:28 +08:00
<a target="_blank" href="https://gitee.com/keepbx/Jpom">
<img src='https://img.shields.io/github/license/jiangzeyin/jpom.svg?style=flat' alt='license'></img>
</a>
<a target="_blank" href="https://gitee.com/keepbx/Jpom">
<img src='https://img.shields.io/badge/JDK-1.8+-green.svg' alt='jdk'></img>
</a>
2019-04-14 22:49:36 +08:00
<a target="_blank" href="https://travis-ci.org/jiangzeyin/Jpom">
<img src='https://travis-ci.org/jiangzeyin/Jpom.svg?branch=master' alt='travis'></img>
</a>
2019-04-15 16:02:27 +08:00
<a target="_blank" href="https://www.codacy.com/app/jiangzeyin/Jpom?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=jiangzeyin/Jpom&amp;utm_campaign=Badge_Grade">
<img src="https://api.codacy.com/project/badge/Grade/9c97dc9925c84404b63e15fefbacc984"></img>
2019-04-15 09:48:28 +08:00
</a>
2019-04-14 22:49:36 +08:00
<a target="_blank" href="https://shang.qq.com/wpa/qunwpa?idkey=7be1882a2e2f07cd4af28bbb1f13362af270ba4615f2a6c7aaf9605fc0563d1b">
<img src='https://img.shields.io/badge/QQ%E7%BE%A4-136715345-yellowgreen.svg' alt='136715345'></img>
</a>
<a target="_blank" href="https://gitee.com/keepbx/Jpom">
<img src='https://img.shields.io/badge/Gitee-%E7%A0%81%E4%BA%91-yellow.svg' alt='gitee'></img>
</a>
<a target="_blank" href="https://github.com/jiangzeyin/Jpom">
<img src='https://img.shields.io/badge/Github-Github-red.svg' alt='github'></img>
</a>
<a target="_blank" href="https://gitee.com/keepbx/Jpom">
<img src='https://gitee.com/keepbx/Jpom/badge/star.svg?theme=dark' alt='gitee star'></img>
</a>
2019-04-14 22:55:46 +08:00
#### 你为什么需要[Jpom](https://gitee.com/keepbx/Jpom)
2019-02-26 09:11:02 +08:00
> SpringBoot、Jboot等框架开发的项目通常是以Jar的方式在后台运行的如果只有一两个项目管理起来不是太麻烦但是当项目多了以后管理起来就不是那么方便了当项目出现问题时能够通过Jpom即时排查问题问题解决后还可以直接上传修改后的Jar项目的堆栈信息服务器CPU、内存使用情况一目了然不必再登录服务器管理。
2019-02-26 09:11:02 +08:00
> 当多个项目运行在同一台服务器时运维人员通常也不只一个如果每个人都登录服务器管理项目难免会造成一些不必要的麻烦甚至给服务器的安全性带来问题服务器密码知道的人越多越容易泄露因为不需要登录服务器管理项目维护人员不需要知道服务器的登录密码只需要有Jpom的账号就行Jpom本身可以通过权限管理给不同用户不同的权限这样也使得项目的稳定性得到提升。
2019-04-23 16:22:27 +08:00
> Jpom可以在Linux和Windows服务器上运行并且Jpom采用多节点模式随时开启关闭节点服务器节点分发减少运维人员上传、修改操作
2019-04-15 09:48:28 +08:00
2019-03-08 10:23:37 +08:00
### Jpom 目标
2019-04-14 22:55:46 +08:00
> 一款简而轻的低侵入式Java运维、监控软件
2019-02-28 10:16:56 +08:00
#### 项目主要功能及特点
2019-02-22 13:32:24 +08:00
2019-04-12 18:35:24 +08:00
1. 创建、修改、删除项目、Jar包管理
2019-04-15 09:48:28 +08:00
2. 实时查看控制台日志、备份日志、删除日志、导出日志
2019-04-12 18:35:24 +08:00
3. cpu、ram 监控、导出堆栈信息、查看项目进程端口、服务器状态监控
2019-04-22 11:04:19 +08:00
4. 多节点管理、多节点自动分发
5. 多用户管理,用户项目权限独立(上传、删除权限可控制),完善的操作日志
2019-05-27 16:11:27 +08:00
6. 系统路径[白名单模式](/doc/whitelist.md),杜绝用户误操作系统文件
7. [在线管理Nginx配置](/doc/nginx-manager.md)、ssl证书文件
2019-04-15 09:48:28 +08:00
8. [阿里云 CodePipeline + Oss在线管理](/doc/CodePipeline-Oss.md)
2018-12-29 15:54:44 +08:00
2019-04-14 23:33:28 +08:00
#### 基本操作演示
2018-12-29 15:54:44 +08:00
2019-04-23 19:23:15 +08:00
[![jpom-server](http://s.keepbx.cn/jpom-server.gif)](http://s.keepbx.cn/jpom-server.gif)
2019-04-23 15:54:42 +08:00
2019-04-23 19:23:15 +08:00
[![jpom-node-agent](http://s.keepbx.cn/jpom-node-agent.gif)](http://s.keepbx.cn/jpom-node-agent.gif)
2018-12-29 15:54:44 +08:00
2019-03-26 11:23:16 +08:00
### 下载安装
2019-01-03 17:43:53 +08:00
2019-04-23 17:11:20 +08:00
> [帮助文档](/doc/install.md)
2019-03-21 15:53:11 +08:00
1. 下载安装包 [https://gitee.com/keepbx/Jpom/attach_files](https://gitee.com/keepbx/Jpom/attach_files)
2019-04-23 15:54:42 +08:00
2. 解压文件
2019-05-09 19:38:21 +08:00
3. 安装插件端([流程说明](/doc/install.md#安装插件端)
2019-04-23 15:54:42 +08:00
1. agent-x.x.x-release 目录为插件端的全部安装文件
2. 上传到对应服务器
3. 命令运行Agent.sh、Agent.bat
2019-05-09 19:38:21 +08:00
4. 安装服务端([流程说明](/doc/install.md#安装服务端)
2019-04-23 15:54:42 +08:00
1. server-x.x.x-release 目录为服务端的全部安装文件
2. 上传到对应服务器
3. 命令运行Server.sh、Server.bat
2019-03-21 15:32:47 +08:00
2019-03-26 11:23:16 +08:00
### 编译安装
2019-01-02 10:52:16 +08:00
2019-04-23 17:11:20 +08:00
> [帮助文档](/doc/install.md)
2019-04-15 09:48:28 +08:00
1. 访问[Jpom](https://gitee.com/keepbx/Jpom)的码云主页,拉取最新完整代码(建议使用master分支)
2019-04-14 23:33:28 +08:00
2. 进入项目目录执行:`mvn clean package`
2019-05-09 19:38:21 +08:00
3. 安装插件端([流程说明](/doc/install.md#安装插件端)
2019-04-19 10:42:31 +08:00
1. 查看插件端安装包 modules/agent/target/agent-x.x.x-release
2. 打包上传服务器运行
3. 命令运行Agent.sh、Agent.bat
2019-05-09 19:38:21 +08:00
4. 安装服务端([流程说明](/doc/install.md#安装服务端)
2019-04-19 10:42:31 +08:00
1. 查看插件端安装包 modules/server/target/server-x.x.x-release
2. 打包上传服务器运行
3. 命令运行Server.sh、Server.bat
2019-01-03 19:34:46 +08:00
2019-03-26 11:23:16 +08:00
### 编译运行
2019-01-03 19:34:46 +08:00
2019-04-15 09:48:28 +08:00
1. 访问[Jpom](https://gitee.com/keepbx/Jpom)的码云主页,拉取最新完整代码(建议使用master分支)
2019-04-19 10:42:31 +08:00
2. 运行插件端
1. 运行`cn.keepbx.jpom.JpomAgentApplication`
2. 注意控制台打印的默认账号密码信息
3. 运行服务端
1. 运行`cn.keepbx.jpom.JpomServerApplication`
2. 浏览器访问http://127.0.0.1:2122
2019-01-02 10:52:16 +08:00
2019-04-08 14:18:23 +08:00
### 管理命令
2019-04-19 10:42:31 +08:00
1. windows中Agent.bat 、Server.bat
2019-04-08 14:18:23 +08:00
```
2019-04-19 10:42:31 +08:00
# 服务端
Server.bat 启动管理面板(按照面板提示输入操作)
# 插件端
Agent.bat 启动管理面板(按照面板提示输入操作)
2019-04-08 14:18:23 +08:00
```
2019-04-23 16:22:27 +08:00
2. linux中Agent.sh 、Server.sh
2019-04-08 14:18:23 +08:00
```
2019-04-19 10:42:31 +08:00
# 服务端
Server.sh start 启动Jpom服务端
Server.sh stop 停止Jpom服务端
Server.sh restart 重启Jpom服务端
Server.sh status 查看Jpom服务端运行状态
# 插件端
Agent.sh start 启动Jpom插件端
Agent.sh stop 停止Jpom插件端
Agent.sh restart 重启Jpom插件端
Agent.sh status 查看Jpom插件端运行状态
2019-04-08 14:18:23 +08:00
```
### 视频教程
[教程列表](https://mp.weixin.qq.com/mp/homepage?__biz=Mzg2OTEzMDIwNg==&hid=5&sn=3712b3edbe0af22c88ac3178a840a799)
2019-04-08 14:18:23 +08:00
[直播回放](https://yq.aliyun.com/live/970)
2019-03-21 16:48:40 +08:00
### Jpom 的参数配置
2019-04-23 19:23:15 +08:00
在项目运行的根路径下的`extConfig.yml`文件
1. 插件端示例:[`extConfig.yml`](/modules/agent/src/main/resources/bin/extConfig.yml)
2. 服务端示例:[`extConfig.yml`](/modules/server/src/main/resources/bin/extConfig.yml)
2019-03-21 16:48:40 +08:00
2019-02-28 20:07:21 +08:00
### 演示项目
2019-03-26 14:11:15 +08:00
[https://jpom.keepbx.cn](https://jpom.keepbx.cn)
2019-04-08 15:51:22 +08:00
```
账号demo
密码demo123
```
2019-03-21 16:16:13 +08:00
> 演示系统有部分功能做了限制,完整功能请自行部署体验
2019-04-14 22:59:21 +08:00
> 如果出现登录不上,请联系我们,联系方式在最底部
2019-03-13 13:46:30 +08:00
1. [Jboot案例代码](https://gitee.com/keepbx/Jpom-demo-case/tree/master/jboot-test)
2019-04-08 23:29:07 +08:00
2. [SpringBoot案例代码(ClassPath)](https://gitee.com/keepbx/Jpom-demo-case/tree/master/springboot-test)
3. [SpringBoot案例代码(Jar)](https://gitee.com/keepbx/Jpom-demo-case/tree/master/springboot-test-jar)
2019-02-28 20:07:21 +08:00
2019-04-23 19:23:15 +08:00
### 常见问题、操作说明
2019-03-26 11:18:02 +08:00
2019-06-04 17:43:43 +08:00
| 必看 | 选看1 | 选看2 |
| -- | -- | -- |
2019-06-06 14:41:23 +08:00
| [安装文档>>](/doc/install.md) | [常见问题>>](/FQA.md) |[更新日志>>](/CHANGELOG.md) |
| [启动失败问题>>](/doc/startFail.md) | [阿里云Oss配置>>](/doc/CodePipeline-Oss.md)| [自定义公共Js>>](/doc/addScript.md) |
2019-06-06 15:54:13 +08:00
| [项目属性说明>>](/doc/project.md) | [删除项目说明>>](/doc/deleteProject.md) | [控制台日志策略>>](/doc/conlose-log.md) |
2019-06-04 17:43:43 +08:00
| [白名单规则>>](/doc/whitelist.md) | [Nginx管理规则>>](/doc/nginx-manager.md) | |
| [用户角色说明>>](/doc/userRole.md) | [推荐Nginx配置>>](/doc/nginx-config.md) | |
2019-06-06 15:54:13 +08:00
| [部署说明>>](/doc/deploy-doc.md) | [开发计划>>](/PLANS.md) | |
2019-04-25 16:24:08 +08:00
2019-03-12 15:38:00 +08:00
2019-04-14 22:59:21 +08:00
### 交流讨论 、提供bug反馈或建议
2019-01-04 14:50:27 +08:00
2019-03-21 15:27:15 +08:00
1. QQ群[136715345](https://shang.qq.com/wpa/qunwpa?idkey=93ff8d8a37a436b752fe38d32075bb1b32a8e0b3d3ff19d0b541ca840433f561)
2. 微信公众号:[CodeGzh](/doc/CodeGzh-QrCode.jpg)
2019-04-14 22:59:21 +08:00
3. 码云: [issues](https://gitee.com/keepbx/Jpom/issues)
2019-04-12 18:54:16 +08:00