Jpom 一款国人都说好的自动化部署系统

Jpom 是一款简而轻的低侵入式在线构建、自动部署、日常运维、项目监控软件。

日常开发中，您是否有以下痛点？

团队中没有专业的运维，开发还要做运维的活，需要自己手动构建、部署项目。

不同的项目有不同的构建、部署命令。

有开发、测试、生产等多环境打包的需求。

需要同时监控多个项目的运行状态。

需要下载 SSH 工具远程连接服务器。

需要下载 FTP 工具传输文件到服务器。

多台服务器时，在不同电脑之间账号密码同步不方便。

想使用一些自动化工具，但是对服务器性能太高，搭建太麻烦。

对自动化工具有个性化的需求，想自己修改项目，但是市面上的工具太复杂了。

使用 Jpom 后

方便的用户管理

用户操作监控，监控指定用户指定操作以邮件形式通知

多用户管理，用户项目权限独立（上传、删除权限可控制），完善的操作日志，使用工作空间隔离权限

账号可以开启 MFA 两步验证提高账号安全性

界面形式实时查看项目运行状态、控制台日志、管理项目文件

在线修改项目文本文件

Docker 容器管理、Docker Swarm 集群管理（Docker UI）

在线 SSH 终端，让您在没有 PuTTY、Xshell、FinalShell 等软件也能轻松管理服务器

登录 Jpom 系统后不需要知道服务器密码

能指定 SSH 禁止执行的命令，避免执行高风险命令，并且能自动执行命令日志

设置文件目录，在线查看管理对应项目文件及配置文件

SSH 命令模版在线执行脚本还能定时执行

在线修改文本文件

轻量的实现了简单的 "堡垒机" 功能

使用项目分发一键搞定集群项目多机部署

在线构建不用手动更新升级项目

支持拉取 GIT、SVN 仓库

支持容器构建（docker）

支持 SSH 方式发布

支持定时构建

支持 WebHook 形式触发构建

支持在线编辑 nginx 配置文件并自动 reload 等操作

管理 nginx 状态，管理 SSL 证书

项目状态监控异常自动报警、自动尝试重启

支持邮件 + 钉钉群 + 微信群通知，主动感知项目运行状况

节点脚本模版 + 定时执行或者触发器，拓展更多功能

重要路径授权配置，杜绝用户误操作系统文件

📥 安装 Jpom

Jpom 支持多种安装方式，满足不同用户的个性化需求，您只需要选择一种方式安装即可。

在开始安装之前我们需要一台服务器，服务器这里我推荐伍六七云：https://www.vps567.com 香港 2H2G5M 服务器 20 / 月，还有高防 CDN 加速只需 18 / 月起。

方式一：🚀（推荐） 一键安装（Linux）

一键安装服务端

注意：安装的目录位于执行命令的目录！

⚠️ 特别提醒：一键安装的时候注意执行命令不可在同一目录下，即 Server 端和 Agent 端不可安装在同一目录下！

如果需要修改服务端数据、日志存储的路径请修改
application.yml
文件中 jpom.path 配置属性。

Copy
# 一键默认安装
curl -fsSL https://jpom.top/docs/install.sh | bash -s Server jdk+default
# 一键默认安装 + 自动配置开机自启服务
curl -fsSL https://jpom.top/docs/install.sh | bash -s Server jdk+default+service

# 安装服务端和 jdk 环境
yum install -y wget && \
wget -O install.sh https://jpom.top/docs/install.sh && \
bash install.sh Server jdk

# 安装服务端和 jdk、maven 环境
yum install -y wget && \
wget -O install.sh https://jpom.top/docs/install.sh && \
bash install.sh Server jdk+mvn

# ubuntu
apt-get install -y wget && \
wget -O install.sh https://jpom.top/docs/install.sh && \
bash install.sh Server jdk

启动成功后，服务端的端口为 2122，可通过 http://127.0.0.1:2122/
访问管理页面（如果不是本机访问，需要把 127.0.0.1 换成您安装的服务器 IP 地址）。

如无法访问管理系统，执行命令 systemctl status firewalld 检查下是否开启了防火墙
，如状态栏看到绿色显示 Active: active (running) 需要放行 2122 端口。

Copy
# 放行管理系统的 2122 端口
firewall-cmd --add-port=2122/tcp --permanent
# 重启防火墙才会生效
firewall-cmd --reload

如果在操作系统上放行了端口仍无法访问，并且您使用的是云服务器，请到云服务器后台中检查安全组规则是否放行 2122 端口。

⚠️ 注意： Linux 系统中有多种防火墙：Firewall、Iptables、SELinux 等，再检查防火墙配置时候需要都检查一下。

一键安装插件端

如果安装服务端的服务器也需要被管理，在服务端上也需要安装插件端（同一个服务器中可以同时安装服务端和插件端）

⚠️ 特别提醒：一键安装的时候注意执行命令不可在同一目录下，即 Server 端和 Agent 端不可安装在同一目录下！

如果需要修改插件端数据、日志存储的路径请修改
application.yml
文件中 jpom.path 配置属性。

Copy
# 一键默认安装
curl -fsSL https://jpom.top/docs/install.sh | bash -s Agent jdk+default
# 一键默认安装 + 自动配置开机自启服务
curl -fsSL https://jpom.top/docs/install.sh | bash -s Agent jdk+default+service

# 安装插件端和 jdk 环境
yum install -y wget && \
wget -O install.sh https://jpom.top/docs/install.sh && \
bash install.sh Agent jdk

# ubuntu
apt-get install -y wget && \
wget -O install.sh https://jpom.top/docs/install.sh && \
bash install.sh Agent jdk

启动成功后，插件端的端口为 2123，插件端提供给服务端使用。

方式二：📦 容器化安装

⚠️ 注意：容器化安装方式需要先安装 docker，点击跳转 docker 安装文档

一条命令安装

Copy
docker run -p 2122:2122 --name jpom-server jpomdocker/jpom

使用挂载方式存储相关数据（在部分环境可能出现兼容性问题）

Copy
docker pull jpomdocker/jpom
mkdir -p /home/jpom-server/logs
mkdir -p /home/jpom-server/data
mkdir -p /home/jpom-server/conf
docker run -d -p 2122:2122 \
--name jpom-server \
-v /home/jpom-server/logs:/usr/local/jpom-server/logs \
-v /home/jpom-server/data:/usr/local/jpom-server/data \
-v /home/jpom-server/conf:/usr/local/jpom-server/conf \
jpomdocker/jpom

使用容器卷方式存储相关数据

Copy
docker pull jpomdocker/jpom
docker volume create jpom-server-data
docker volume create jpom-server-logs
docker volume create jpom-server-conf
docker run -d -p 2122:2122 \
--name jpom-server \
-v jpom-server-data:/usr/local/jpom-server/data \
-v jpom-server-logs:/usr/local/jpom-server/logs \
-v jpom-server-conf:/usr/local/jpom-server/conf \
jpomdocker/jpom

容器化安装仅提供服务端版。由于容器和宿主机环境隔离，而导致插件端的很多功能无法正常使用，因此对插件端容器化意义不大。

安装 docker、配置镜像、自动启动、查找安装后所在目录等可参考文档
https://jpom.top/pages/b63dc5/

在低版本 docker 中运行可能出现 ls: cannot access'/usr/local/jpom-server/lib/': Operation not permitted
错误，此时需要添加 --privileged 参数
如：docker run -p 2122:2122 --name jpom-server jpomdocker/jpom --privileged

方式三：💾 下载安装

下载安装包 https://jpom.top/pages/all-downloads/

解压文件

安装插件端

agent-x.x.x-release 目录为插件端的全部安装文件

上传到对应服务器（整个目录）

启动插件端，Windows 环境用 bat 脚本，Linux 环境用 sh 脚本。（如果出现乱码或者无法正常执行，请检查编码格式、换行符是否匹配。）

插件端默认运行端口：2123

安装服务端

server-x.x.x-release 目录为服务端的全部安装文件

上传到对应服务器（整个目录）

启动服务端，Windows 环境用 bat 脚本，Linux 环境用 sh 脚本。（如果出现乱码或者无法正常执行，请检查编码格式、换行符是否匹配。）

服务端默认运行端口：2122，访问管理页面：http://127.0.0.1:2122/（非本机访问把 127.0.0.1 换成您的服务器 IP 地址）

方式四：⌨️ 编译安装

访问 Jpom 的码云主页，拉取最新完整代码（建议使用 master 分支）

切换到 web-vue 目录，执行 npm install（vue 环境需要提前搭建和安装依赖包详情可以查看 web-vue 目录下 README.md）

执行 npm run build 进行 vue 项目打包

切换到项目根目录执行：mvn clean package

安装插件端

查看插件端安装包 modules/agent/target/agent-x.x.x-release

打包上传服务器运行（整个目录）

启动插件端，Windows 环境用 bat 脚本，Linux 环境用 sh 脚本。（如果出现乱码或者无法正常执行，请检查编码格式、换行符是否匹配。）

默认运行端口：2123

安装服务端

查看插件端安装包 modules/server/target/server-x.x.x-release

打包上传服务器运行（整个目录）

启动服务端，Windows 环境用 bat 脚本，Linux 环境用 sh 脚本。（如果出现乱码或者无法正常执行，请检查编码格式、换行符是否匹配。）

服务端默认运行端口：2122，访问管理页面：http://127.0.0.1:2122/（非本机访问把 127.0.0.1 换成您的服务器 IP 地址）

也可以使用 script/release.bat 或 script/release.sh 快速打包。

方式五：📦 一键启动 docker-compose

无需安装任何环境，自动编译构建

需要注意修改 .env 文件中的 token 值

Copy
yum install -y git
git clone https://gitee.com/dromara/Jpom.git
cd Jpom
docker-compose -f docker-compose.yml up
# docker-compose -f docker-compose.yml up --build
# docker-compose -f docker-compose.yml build --no-cache
# docker-compose -f docker-compose-local.yml up
# docker-compose -f docker-compose-local.yml build --build-arg TEMP_VERSION=.0
# docker-compose -f docker-compose-cluster.yml up --build

方式六：💻 编译运行

访问 Jpom 的码云主页 拉取最新完整代码 （建议使用 master 分支，如果想体验新功能可以使用
dev 分支）

运行插件端

运行 org.dromara.jpom.JpomAgentApplication

留意控制台打印的默认账号密码信息

插件端默认运行端口：2123

运行服务端

运行 org.dromara.jpom.JpomServerApplication

服务端默认运行端口：2122

构建 vue 页面，切换到 web-vue 目录（前提需要本地开发环境有 node、npm 环境）

安装项目 vue 依赖，控制台执行 npm install

启动开发模式，控制台执行 npm run dev

根据控制台输出的地址访问前端页面：http://127.0.0.1:3000/（非本机访问把 127.0.0.1 换成您的服务器 IP 地址）

管理 Jpom 命令

Windows 系统使用 bat 脚本文件。

Copy
# 服务端管理脚本 （命令行）
./bin/Server.bat start # 启动Jpom服务端
./bin/Server.bat stop # 停止Jpom服务端
./bin/Server.bat restart # 重启Jpom服务端
./bin/Server.bat status # 查看Jpom服务端运行状态
# 服务端管理脚本 （控制面板），按照面板提示输入操作
./bin/Server.bat

# 插件端管理脚本
./bin/Agent.bat start # 启动Jpom插件端
./bin/Agent.bat stop # 停止Jpom插件端
./bin/Agent.bat restart # 重启Jpom插件端
./bin/Agent.bat status # 查看Jpom插件端运行状态
# 插件端管理脚本（控制面板），按照面板提示输入操作
./bin/Agent.bat

Windows 系统中执行启动后需要根据日志去跟进启动的状态，如果出现乱码请检查或者修改编码格式，Windows 系统中 bat
编码格式推荐为 GB2312

Linux 系统中使用 sh 脚本文件。

Copy
# 服务端
./bin/Server.sh start # 启动Jpom服务端
./bin/Server.sh stop # 停止Jpom服务端
./bin/Server.sh restart # 重启Jpom服务端
./bin/Server.sh status # 查看Jpom服务端运行状态
./bin/Service.sh install # 创建Jpom服务端的应用服务（jpom-server）

# 插件端
./bin/Agent.sh start # 启动Jpom插件端
./bin/Agent.sh stop # 停止Jpom插件端
./bin/Agent.sh restart # 重启Jpom插件端
./bin/Agent.sh status # 查看Jpom插件端运行状态
./bin/Service.sh install # 创建Jpom插件端的应用服务（jpom-agent）

Linux 服务方式管理

这里安装服务仅供参考，实际中可以根据需求自定义配置

在使用 ./bin/Service.sh install 成功后

systemctl {status | start | stop | restart} jpom-server

systemctl {status | start | stop | restart} jpom-agent

⚙️ Jpom 的参数配置

在项目运行的根路径下的 ：

程序配置 ./conf/application.yml

插件端示例：
application.yml

服务端示例：
application.yml

项目日志 ./conf/logback.xml

插件端示例：
logback.xml

服务端示例：
logback.xml

📝 常见问题、操作说明

文档主页

FQA

名词解释