Jpom/README.md

164 lines
6.6 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
> 在服务器中管理jar包运行如SpringBoot、Jboot等项目如果是打包为Jar那么我们一般是使用shell、bat 命令来管理,
> 在单服务器中多项目新增、更新、删除、排查日志等操作如此都不是很方便。
> 再者想不使用电脑控制重启、关闭、开启项目。直接使用管理员软件登录服务器管理显然不是最简单的方法
> 甚至在没有专业的服务器管理软件电脑前Jpom都是你们选择
2018-12-29 15:54:44 +08:00
2019-03-21 15:53:11 +08:00
### 在这里[Jpom](https://gitee.com/keepbx/Jpom) 项目将如上问题统一解决
2018-12-29 15:54:44 +08:00
2019-02-19 11:24:52 +08:00
![GitHub](https://img.shields.io/github/license/jiangzeyin/jpom.svg?style=flat)
![jdk](https://img.shields.io/badge/JDK-1.8+-green.svg)
2019-04-01 09:35:21 +08:00
[![travis](https://travis-ci.org/jiangzeyin/jpom.svg?branch=master)](https://travis-ci.org/jiangzeyin/Jpom)
[![QQ群](https://img.shields.io/badge/QQ%E7%BE%A4-924715723-yellowgreen.svg)](https://shang.qq.com/wpa/qunwpa?idkey=4cc97b039a6554fbdd2a54648eb4a6ce1e1602edcf56a408dcb8877b3f658129)
[![码云](https://img.shields.io/badge/Gitee-%E7%A0%81%E4%BA%91-yellow.svg)](https://gitee.com/keepbx/Jpom)
[![Github](https://img.shields.io/badge/Github-Github-red.svg)](https://github.com/jiangzeyin/Jpom)
2019-02-19 11:24:52 +08:00
> Jpom采用SpringBoot开发web项目(前台采用layui)+websocket来统一管理只要能使用浏览器就ok同时Jpom可以在linux和windows服务器上运行
2018-12-29 15:54:44 +08:00
2019-02-22 17:28:33 +08:00
![logo](/doc/logo.png)
2019-02-26 09:11:02 +08:00
#### 你为什么需要Jpom
> SpringBoot、Jboot等框架开发的项目通常是以Jar的方式在后台运行的如果只有一两个项目管理起来不是太麻烦但是当项目多了以后管理起来就不是那么方便了当项目出现问题时能够通过Jpom即时排查问题问题解决后还可以直接上传修改后的Jar项目的堆栈信息服务器CPU、内存使用情况一目了然不必再登录服务器管理。
2019-02-26 09:11:02 +08:00
> 当多个项目运行在同一台服务器时运维人员通常也不只一个如果每个人都登录服务器管理项目难免会造成一些不必要的麻烦甚至给服务器的安全性带来问题服务器密码知道的人越多越容易泄露因为不需要登录服务器管理项目维护人员不需要知道服务器的登录密码只需要有Jpom的账号就行Jpom本身可以通过权限管理给不同用户不同的权限这样也使得项目的稳定性得到提升。
2019-03-08 10:23:37 +08:00
### Jpom 目标
> 一款低侵入式Java运维、监控软件,要做到简而轻、低侵入
2019-03-08 10:23:37 +08:00
2019-02-28 10:16:56 +08:00
#### 项目主要功能及特点
2019-02-22 13:32:24 +08:00
2018-12-29 15:54:44 +08:00
1. 创建、修改、删除项目
2. 实时查看控制台
3. jar包文件夹管理
4. cpu、ram 监控
5. 导出堆栈信息
2019-03-12 15:43:21 +08:00
6. [阿里云 CodePipeline + Oss在线管理](/doc/CodePipeline-Oss.md)
7. 多用户管理,用户项目权限独立(上传、删除权限可控制)
2018-12-29 15:54:44 +08:00
8. 此项目完全不依赖数据库,随装随用
2018-12-29 15:58:07 +08:00
9. 整个服务器top监听
2019-02-22 13:32:24 +08:00
10. 查看项目运行进程占用的端口
2019-03-12 15:43:21 +08:00
11. [安全模式](/doc/safeMode.md)运行,更好的保证服务器稳定、避免误操作
2019-03-01 16:22:41 +08:00
12. 项目路径白名单模式,杜绝用户误操作系统文件
2018-12-29 15:54:44 +08:00
#### 项目截图
2019-03-13 17:37:28 +08:00
1. 创建、修改、删除项目
2019-01-04 15:29:36 +08:00
![修改、删除项目](/doc/images/edit_del.png)
2018-12-29 15:54:44 +08:00
3. 文件管理
2019-01-04 15:29:36 +08:00
![文件管理](/doc/images/file.png)
2018-12-29 15:54:44 +08:00
4. 项目列表
2019-01-04 15:29:36 +08:00
![项目列表](/doc/images/list.png)
2018-12-29 15:54:44 +08:00
2019-03-27 16:28:20 +08:00
5. 监控cpu、内存、占用的端口情况
2019-01-04 15:29:36 +08:00
![ 监控cpu 内存](/doc/images/cup_ram.png)
2018-12-29 15:54:44 +08:00
6. 控制台日志实时查看
2019-01-04 15:29:36 +08:00
![控制台日志实时查看](/doc/images/console.png)
2018-12-29 15:54:44 +08:00
7. 用户管理
2019-01-04 15:29:36 +08:00
![用户管理](/doc/images/user_list.png)
2018-12-29 15:58:07 +08:00
8. top监听
2019-01-04 15:29:36 +08:00
![top监听](/doc/images/top.png)
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-03-21 15:53:11 +08:00
1. 下载安装包 [https://gitee.com/keepbx/Jpom/attach_files](https://gitee.com/keepbx/Jpom/attach_files)
2019-01-03 17:52:30 +08:00
2. 上传到服务解压到根目录
2019-03-21 15:27:15 +08:00
3. 执行目录下[Jpom.sh](/script/Jpom.sh)文件(记得给命令文件添加权限奥[*chmod 755 /jpom/Jpom.sh*]
2019-03-21 15:32:47 +08:00
```
/jpom/Jpom.sh start
```
2019-03-21 15:27:15 +08:00
4. 如有需要修改项目端口请查看 Jpom.sh
5. windows 下则执行Jpom.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-03-26 11:23:16 +08:00
1. 访问[Jpom](https://gitee.com/keepbx/Jpom)的码云主页,拉取最新完整代码:
2. 进入项目目录执行,然后在目录中查看 target/jpom-x.x-release
2019-03-21 15:53:11 +08:00
```
mvn clean package
```
3. 打包上传服务器运行
4. 命令运行
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-03-26 11:23:16 +08:00
1. 访问[Jpom](https://gitee.com/keepbx/Jpom)的码云主页,拉取最新完整代码:
2. 运行*cn.keepbx.jpom.JpomApplication*
3. 浏览器访问http://127.0.0.1:2122
2019-01-02 10:52:16 +08:00
2019-03-21 16:48:40 +08:00
### Jpom 的参数配置
在项目运行的根路径下创建[`extConfig.yml`](/src/main/resources/bin/extConfig.yml) 具体的配置说明和示例请查看:[`extConfig.yml`](/src/main/resources/bin/extConfig.yml)
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-02-28 20:07:21 +08:00
2019-03-17 20:42:27 +08:00
账号demo
密码demo123
2019-03-21 16:16:13 +08:00
> 演示系统有部分功能做了限制,完整功能请自行部署体验
2019-03-21 15:58:33 +08:00
> 如果出现登录不上,请联系我们重置密码,联系方式在最底部
2019-03-13 13:46:30 +08:00
1. [Jboot案例代码](https://gitee.com/keepbx/Jpom-demo-case/tree/master/jboot-test)
2. [SpringBoot案例代码](https://gitee.com/keepbx/Jpom-demo-case/tree/master/springboot-test)
2019-02-28 20:07:21 +08:00
2019-02-28 11:40:59 +08:00
### 常见问题
[常见问题>>](/FQA.md)
2019-03-26 11:18:02 +08:00
[启动失败问题>>](https://gitee.com/keepbx/Jpom/wikis/pages?sort_id=1395625&doc_id=264493)
2019-03-26 11:23:16 +08:00
[安装说明>>](https://gitee.com/keepbx/Jpom/wikis/pages?sort_id=1395348&doc_id=264493)
2019-02-28 11:40:59 +08:00
### 开发计划
[开发计划>>](/PLANS.md)
2019-03-12 15:38:00 +08:00
### 安全模式说明
2019-03-13 21:49:48 +08:00
[安全模式>>](/doc/safeMode.md)
[用户角色说明>>](/doc/safeMode.md#用户权限说明)
2019-03-12 15:38:00 +08:00
2019-03-13 13:46:30 +08:00
### 阿里云Oss配置
2019-01-16 10:23:35 +08:00
[查看文档](/doc/CodePipeline-Oss.md)
2019-01-02 10:26:08 +08:00
2019-01-02 10:52:16 +08:00
### 感谢
2019-01-04 14:48:48 +08:00
Jpom使用以下开源项目
2019-01-02 10:26:08 +08:00
- [Spring Boot](https://github.com/spring-projects/spring-boot):核心框架
2019-02-22 22:32:07 +08:00
- [Fast-Boot](https://gitee.com/keepbx/common-parent)针对SpringBoot 封装的一系列的快捷包 提供公共的Controller、自动化拦截器、启动加载资源接口、线程池管理
2019-01-04 15:41:00 +08:00
- [Fastjson](https://github.com/alibaba/fastjson)用于Java的快速JSON解析器/生成器
2019-01-04 18:20:33 +08:00
- [Hutool](https://gitee.com/loolly/hutool)一个Java工具包也只是一个工具包它帮助我们简化每一行代码减少每一个方法让Java语言也可以“甜甜的”
2019-01-02 10:52:16 +08:00
- [Layui](https://gitee.com/sentsin/layui)前端UI框架
### 提供bug反馈或建议
2019-03-21 15:53:11 +08:00
- [码云](https://gitee.com/keepbx/Jpom/issues)
2019-01-02 10:52:16 +08:00
### 贡献代码
2019-01-04 11:56:36 +08:00
欢迎任何人为Jpom添砖加瓦贡献代码
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-02-22 13:32:24 +08:00