首頁>編程相關>JAVA源碼
下載

【dromara】簡而輕的低侵入式線上建置、自動部署、日常運維、專案監控軟體

【更是一款原生ops 軟體/ English】

國際站：https://jpom.dromara.org ?

大陸站：https://jpom.top ?

? 在日常開發中，您是否有以下痛點？

  • 團隊中沒有專業的維運，開發還要做維運的活，需要自己手動建置、部署專案。
  • 不同的專案有不同的建置、部署指令。
  • 有開發、測試、生產等多環境打包的需求。
  • 需要同時監控多個項目的運作狀態。
  • 需要下載SSH 工具遠端連接伺服器。
  • 需要下載FTP 工具傳輸檔案到伺服器。
  • 多台伺服器時，在不同電腦之間帳號密碼同步不方便。
  • 想使用一些自動化工具，但是對伺服器效能太高，搭建太麻煩。
  • 對自動化工具有個人化的需求，想自己修改項目，但市面上的工具太複雜了。

如果是分散式的項目，以上步驟則更加繁瑣。

讓Jpom 來幫您解決這些痛點吧！然而，這些只是Jpom 解決的最基礎的功能。

?使用 Jpom 後

  • 方便的用戶管理
    1. 使用者操作監控，監控指定使用者指定操作以郵件形式通知
    2. 多用戶管理，使用者專案權限獨立（上傳、刪除權限可控制），完善的操作日誌，使用工作空間隔離權限
    3. 帳號可以開啟MFA 兩步驟驗證提高帳號安全性
  • 介面形式即時查看專案運行狀態、控制台日誌、管理專案文件
    1. 線上修改專案文本文件
  • Docker 容器管理、Docker Swarm 叢集管理（ Docker UI ）
  • 線上SSH 終端，讓您在沒有PuTTY、Xshell、FinalShell 等軟體也能輕鬆管理伺服器
    1. 登入Jpom 系統後不需要知道伺服器密碼
    2. 能指定SSH 禁止執行的命令，避免執行高風險命令，並且能自動執行命令日誌
    3. 設定文件目錄，線上查看管理對應專案文件及設定文件
    4. SSH 指令模版線上執行腳本還能定時執行
    5. 線上修改文字文件
    6. 輕量的實作了簡單的"堡壘機"功能
  • 使用專案分發一鍵處理叢集專案多機部署
  • 線上建置不用手動更新升級項目
    1. 支援拉取GIT、SVN 倉庫
    2. 支援容器建置（docker）
    3. 支援SSH 方式發布
    4. 支援定時構建
    5. 支援WebHook 形式觸發構建
  • 支援線上編輯nginx 設定檔並自動reload 等操作
    1. 管理nginx 狀態，管理SSL 憑證
  • 項目狀態監控異常自動警報、自動嘗試重啟
    1. 支援郵件+ 釘釘群+ 微信群通知，主動感知專案運作狀況
  • 節點腳本模版+定時執行或觸發器，拓展更多功能
  • 重要路徑授權配置，杜絕用戶誤作業系統文件

?️ 特別提醒

  1. 在Windows 伺服器中可能有部分功能因為系統特性造成相容性問題，建議在實際使用上充分測試。 Linux 目前相容性良好
  2. 服務端和插件端請安裝到不同目錄中，切勿安裝到同一目錄中
  3. 卸載Jpom 插件端或服務端，先停止對應服務，然後刪除對應的程式檔案、日誌資料夾、資料目錄資料夾即可
  4. 本機建置依賴的是系統環境，如果建置指令需要使用maven 或node 需要在建置專案的伺服器安裝好對應的環境。如果已經啟動服務端再安裝的對應環境需要透過命令列重新啟動服務端後環境才會生效。
  5. 在Ubuntu/Debian 伺服器作為插件端可能會新增失敗，請在目前使用者的根目錄建立.bash_profile 文件
  6. 升級2.7.x 後不建議降級操作，會涉及到資料不相容的情況
  7. 由於目前2.xx 版本插件端和服務端主要採用http 協定通訊，插件端和服務端網路要求互通，在使用的時候請注意。
  8. Jpom 3.0 版本已經開始規劃更新了，盡請期待新版本的誕生吧

?️ 版本更新日誌

升級前必看：CHANGELOG.md

? 安裝 Jpom

Jpom 支援多種安裝方式，滿足不同使用者的個人化需求，您只需要選擇一種方式安裝即可。

方式一：（建議） 一鍵安裝（Linux）

一鍵安裝服務端

注意：安裝的目錄位於執行指令的目錄！

️特別提醒：一鍵安裝的時候注意執行指令不可在同一目錄下，即Server 端和Agent 端不可安裝在同一目錄下！

如果需要修改服務端資料、日誌儲存的路徑請修改application.yml檔案中jpom.path配置屬性。 

 # 一键默认安装
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埠。 

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

如果在作業系統上放行了連接埠仍無法訪問，且您使用的是雲端伺服器，請到雲端伺服器後台檢查安全性群組規則是否放行2122 連接埠。

️注意： Linux 系統中有多種防火牆：Firewall、Iptables、SELinux 等，再檢查防火牆配置時候需要都檢查一下。

一鍵安裝插件端

如果安裝服務端的伺服器也需要管理，在服務端上也需要安裝插件端（同一個伺服器中可以同時安裝服務端和插件端）

️特別提醒：一鍵安裝的時候注意執行指令不可在同一目錄下，即Server 端和Agent 端不可安裝在同一目錄下！

如果需要修改插件端資料、日誌儲存的路徑請修改application.yml檔案中jpom.path配置屬性。 

 # 一键默认安装
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安裝文檔

一條命令安裝

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

使用掛載方式儲存相關資料（在部分環境可能出現相容性問題）

  1. 阿里倉庫
docker pull registry.cn-chengdu.aliyuncs.com/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
  1. dockerhub 倉庫
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

使用容器卷方式儲存相關數據

  1. 阿里倉庫
docker pull registry.cn-chengdu.aliyuncs.com/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
  1. dockerhub 倉庫
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

方式三：? 下載安裝

  1. 下載安裝包https://jpom.top/pages/all-downloads/
  2. 解壓縮文件
  3. 安裝插件端
    1. agent-xxx-release目錄為插件端的全部安裝文件
    2. 上傳到對應伺服器（整個目錄）
    3. 啟動插件端，Windows 環境用bat 腳本，Linux 環境用sh 腳本。 （如果出現亂碼或無法正常執行，請檢查編碼格式、換行符號是否符合。）
    4. 插件端預設運行連接埠： 2123
  4. 安裝服務端
    1. server-xxx-release目錄為服務端的全部安裝文件
    2. 上傳到對應伺服器（整個目錄）
    3. 啟動服務端，Windows 環境用bat 腳本，Linux 環境用sh 腳本。 （如果出現亂碼或無法正常執行，請檢查編碼格式、換行符號是否符合。）
    4. 服務端預設執行連接埠： 2122 ，存取管理頁面： http://127.0.0.1:2122/ （非本機存取將127.0.0.1換成您的伺服器IP 位址）

方式四：⌨️ 編譯安裝

  1. 造訪Jpom 的碼雲首頁，拉取最新完整程式碼（建議使用master 分支）
  2. 切換到web-vue目錄，執行npm install （vue 環境需要提前建置和安裝依賴套件詳情可以查看web-vue 目錄下README.md）
  3. 執行npm run build進行vue 專案打包
  4. 切換到專案根目錄執行： mvn clean package
  5. 安裝插件端
    1. 查看插件端安裝包modules/agent/target/agent-xxx-release
    2. 打包上傳伺服器運行（整個目錄）
    3. 啟動插件端，Windows 環境用bat 腳本，Linux 環境用sh 腳本。 （如果出現亂碼或無法正常執行，請檢查編碼格式、換行符號是否符合。）
    4. 預設運作連接埠： 2123
  6. 安裝服務端
    1. 查看插件端安裝包modules/server/target/server-xxx-release
    2. 打包上傳伺服器運行（整個目錄）
    3. 啟動服務端，Windows 環境用bat 腳本，Linux 環境用sh 腳本。 （如果出現亂碼或無法正常執行，請檢查編碼格式、換行符號是否符合。）
    4. 服務端預設執行連接埠： 2122 ，存取管理頁面： http://127.0.0.1:2122/ （非本機存取將127.0.0.1換成您的伺服器IP 位址）

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

方式五：? 一鍵啟動docker-compose

  • 無需安裝任何環境,自動編譯構建

需要注意修改.env檔案中的token 值

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

方式六： 編譯運行

  1. 造訪Jpom 的碼雲首頁拉取最新完整程式碼（建議使用master 分支，如果想體驗新功能可以使用dev 分支）
  2. 運行插件端
    1. 運行org.dromara.jpom.JpomAgentApplication
    2. 留意控制台列印的預設帳號密碼訊息
    3. 插件端預設運行連接埠： 2123
  3. 運行服務端
    1. 運行org.dromara.jpom.JpomServerApplication
    2. 服務端預設運作連接埠： 2122
  4. 建立vue 頁面，切換到web-vue目錄（前提需要本機開發環境有node、npm 環境）
  5. 安裝專案vue 依賴，控制台執行npm install
  6. 啟動開發模式，控制台執行npm run dev
  7. 根據控制台輸出的位址存取前端頁面： http://127.0.0.1:3000/ （非本機存取將127.0.0.1換成您的伺服器IP 位址）

管理Jpom 指令

  1. Windows 系統使用bat 腳本檔。 
 # 服务端管理脚本 （命令行）
./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

  1. Linux 系統中使用sh 腳本檔。 
 # 服务端
./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

  1. 插件端範例： application.yml
  2. 服務端範例： application.yml

專案日誌./conf/logback.xml

  1. 外掛端範例： logback.xml
  2. 服務端範例： logback.xml

常見問題、操作說明

  • 文件主頁
  • FQA
  • 名詞解釋

實踐案例

裡面有部分圖片載入可能比較慢

  1. 本地建置+ SSH 發布java 項目
  2. 本地建置+ 專案發布node 項目
  3. 本地建置+ SSH 發布node 項目
  4. 本機建置+ 自訂管理python 項目
  5. 自訂管理java 項目
  6. 管理編譯安裝的nginx
  7. 管理docker
  8. 容器建置+ 項目發布java 項目
  9. 更新實踐案例>>

建置案例倉庫程式碼

  1. Jboot 案例代碼
  2. SpringBoot 案例代碼(ClassPath)
  3. SpringBoot 案例代碼(Jar)
  4. node vue 案例代碼(antdv)
  5. python 案例程式碼

Node.js 編譯指定目錄： 

yarn --cwd xxxx/ install
yarn --cwd xxxx/ build

Maven 編譯指定目錄： 

mvn -f xxxx/pom.xml clean package

整體架構

?交流討論、回饋BUG、提出建議等

  1. 快掃描下方左側微信群二維碼和我們一起交流討論吧！ （新增小助手：備註Jpom 進群）
  2. 開源專案離不開社群的支持，如果專案幫助到了您，並且想為我們加餐。 歡迎掃描下方微信、支付寶收款碼讚賞或透過碼雲讚賞（在專案首頁下方點擊捐贈，支持微信和支付寶）。讚賞記錄
  3. 購買開源週邊商品：週邊介紹
  4. 企業技術服務請與我們單獨聯絡溝通服務方案
  5. 回饋BUG、提出建議，歡迎新建：issues，開發人員會不定時查看回覆。
  6. 參與貢獻，請查看貢獻指南。

感謝所有讚賞以及參與貢獻的小夥伴，您的支持是我們不斷更新前進的動力！

? 週邊商品

為了更好地維持開源項目，我們決定推出週邊商品。

購買支持我們這樣您既獲得了一份小商品我們也獲得了您購買商品的利潤（週邊商品的價格會比市場價稍高，介意請勿下單）

?貢獻指南

提交貢獻即認為簽署了CLA 協議

貢獻須知

Jpom 作為開源項目，離不開社群的支持，歡迎任何人修改和提出建議。貢獻無論大小，您的貢獻將幫助背後成千上萬的用戶以及開發者，您所做的貢獻也將永遠的保留在專案的貢獻者名單中，這也是開源專案的意義所在！

為了保證專案程式碼的品質與規範，以及幫助您更快的了解專案的結構，請在貢獻之前閱讀：

  • Jpom 貢獻說明
  • 中英文排版規範

貢獻步驟

  1. Fork 本倉庫。

  2. Fork 之後會在您的帳號下方多了一個和本倉庫一模一樣的倉庫，把您帳號的倉庫clone 到本地。

    注意替換掉連結中的分支名和用户名。

    如果是貢獻程式碼，分支名填dev ；如果是貢獻文檔，分支名填docs 

    git clone -b 分支名 https://gitee.com/用户名/Jpom.git

  3. 修改程式碼/文檔，修改後提交上來。 

     # 把修改的文件添加到暂存区
git add .
# 提交到本地仓库，说明您具体做了什么修改
git commit -m '填写您做了什么修改'
# 推送到远程仓库，分支名替换成 dev 或者 docs
git push origin 分支名

  4. 登入您的倉庫，然後會看到一條PR 請求，點擊請求合併，等待管理員把您的程式碼合併進來。

專案分支說明

分支說明
master主分支，受保護分支，此分支不接受PR。在beta 分支後經過測試沒問題後會合併到此分支。
beta beta 版本分支，受保護分支，此分支不接受PR。在dev 分支後經過測試沒問題後會合併到此分支。
dev開發分支，接受PR，PR 請提交至dev 分支。
docs專案文件分支，接受PR，介紹專案功能、總結常見問題等。

目前用到的主要是dev 和docs 分支，接受PR 修改，其他的分支為歸檔分支，貢獻者可以不用管。

貢獻者

Made with contrib.rocks.

? 知識星球

? 精品專案推薦

項目名稱項目地址項目介紹
SpringBoot_v2 https://gitee.com/bdj/SpringBoot_v2基於springboot的一款純淨鷹架
TLog GVP 項目https://gitee.com/dromara/TLog一個輕量級的分散式日誌標記追蹤神器，10分鐘即可接入，自動對日誌打標籤完成微服務的鏈路追蹤
Sa-Token https://gitee.com/dromara/sa-token這可能是史上功能最全的Java 權限認證架構！
Erupt https://gitee.com/erupt/erupt零前端程式碼，純註解開發admin 管理後台
hippo4j https://gitee.com/magegoofy/hippo4j強大的動態線程池框架，附帶監控警報功能。
HertzBeat https://gitee.com/dromara/hertzbeat易用友善的雲端監控系統, 無需Agent, 強大自訂監控能力。

?鳴謝

  • 感謝JetBrains 提供的免費開源License：

展開
附加信息
相關應用
爲您推薦
相關資訊 全部