DOGAI

DOGAI

分享高质量GitHub开源项目，低价高质量服务器请看：https://www.vps567.com 香港CN2服务器 高防美国和大陆服务器 还有全球CDN加速。
Home文章归档便宜香港VPS高防美国VPS大陆高防VPS全球CDN加速

Jpom is an automation deployment system that everyone in the country says is good.

114
AI Translation
This post is translated from Chinese into English through AI.View Original
AI-generated summary
Jpom is a lightweight, low-intrusion online software for building, deploying, maintaining, and monitoring projects. It addresses common pain points in development, such as the lack of dedicated operations staff, the need for different commands for various projects, and the complexity of managing multiple environments and servers. Key features of Jpom include: - User management with monitoring and multi-user support. - Real-time project status and console logs. - Docker container and Swarm management. - Online SSH terminal for server management without additional tools. - One-click deployment for multi-machine projects. - Support for GIT, SVN, and Docker builds. - Automated project monitoring and alerts. - Easy editing of configuration files. Installation options include: 1. **One-click installation** for Linux, with various configurations. 2. **Containerized installation** using Docker, with options for data storage. 3. **Manual download and installation** from the official site. Jpom aims to simplify project management and enhance operational efficiency for development teams.

Jpom is a simple and lightweight low-intrusion online construction, automatic deployment, daily operation and maintenance, and project monitoring software.

logo

In daily development, do you have the following pain points?

  • There are no professional operations and maintenance personnel in the team, and developers have to do operational tasks, needing to manually build and deploy projects.
  • Different projects have different build and deployment commands.
  • There is a need for packaging in multiple environments such as development, testing, and production.
  • There is a need to monitor the running status of multiple projects simultaneously.
  • There is a need to download SSH tools to remotely connect to servers.
  • There is a need to download FTP tools to transfer files to servers.
  • When using multiple servers, synchronizing account passwords between different computers is inconvenient.
  • Want to use some automation tools, but they are too resource-intensive and complicated to set up.
  • Have personalized needs for automation tools and want to modify projects themselves, but the tools available on the market are too complex.

After using Jpom

  • Convenient user management
    1. User operation monitoring, notifying specified user operations via email
    2. Multi-user management, independent project permissions for users (upload and delete permissions can be controlled), complete operation logs, using workspace isolation for permissions
    3. Accounts can enable MFA two-step verification to enhance account security
  • Interface for real-time viewing of project running status, console logs, and managing project files
    1. Online modification of project text files
  • Docker container management, Docker Swarm cluster management (Docker UI)
  • Online SSH terminal, allowing you to easily manage servers without software like PuTTY, Xshell, FinalShell
    1. No need to know the server password after logging into the Jpom system
    2. Can specify commands to be prohibited from execution via SSH to avoid executing high-risk commands, and can automatically log executed commands
    3. Set file directories, view and manage corresponding project files and configuration files online
    4. SSH command templates can execute scripts online and can also be scheduled
    5. Online modification of text files
    6. Lightweight implementation of simple "bastion host" functionality
  • Use project distribution to easily deploy cluster projects on multiple machines with one click
  • Online builds without manually updating or upgrading projects
    1. Supports pulling from GIT, SVN repositories
    2. Supports container builds (docker)
    3. Supports SSH method for publishing
    4. Supports scheduled builds
    5. Supports triggering builds in WebHook form
  • Supports online editing of nginx configuration files and automatic reload operations
    1. Manage nginx status, manage SSL certificates
  • Project status monitoring with automatic alarms for exceptions and automatic restart attempts
    1. Supports email + DingTalk group + WeChat group notifications, actively sensing project operating conditions
  • Node script templates + scheduled execution or triggers to expand more functions
  • Important path authorization configuration to prevent users from mistakenly operating system files

📥 Install Jpom#

Jpom supports various installation methods to meet different users' personalized needs; you only need to choose one installation method.

Before starting the installation, we need a server, I recommend Wu Liu Qi Cloud for the server: https://www.vps567.com Hong Kong 2H2G5M server for $20/month, with high-defense CDN acceleration starting at just $18/month.

Method 1: 🚀 (Recommended) One-click installation (Linux)#

One-click install server#

Note: The installation directory is located in the directory where the command is executed!

⚠️ Special reminder: When performing one-click installation, be careful not to execute the command in the same directory, i.e., the Server side and Agent side cannot be installed in the same directory!

If you need to modify the path for server data and log storage, please modify the jpom.path configuration property in the application.yml file.

# One-click default installation
curl -fsSL https://jpom.top/docs/install.sh | bash -s Server jdk+default
# One-click default installation + automatic configuration for startup service
curl -fsSL https://jpom.top/docs/install.sh | bash -s Server jdk+default+service

# Install server and jdk environment
yum install -y wget && \
wget -O install.sh https://jpom.top/docs/install.sh && \
bash install.sh Server jdk

# Install server and jdk, maven environment
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

After successful startup, the server port is 2122, and you can access the management page at http://127.0.0.1:2122/ (if accessing from a non-local machine, replace 127.0.0.1 with the IP address of your installed server).

If you cannot access the management system, execute the command systemctl status firewalld to check if the firewall is enabled. If the status bar shows green Active: active (running), you need to allow port 2122.

# Allow the management system's port 2122
firewall-cmd --add-port=2122/tcp --permanent
# Restart the firewall for changes to take effect
firewall-cmd --reload

If you have allowed the port on the operating system but still cannot access it, and you are using a cloud server, please check the security group rules in the cloud server backend to see if port 2122 is allowed.

⚠️ Note: There are various firewalls in Linux systems: Firewall, Iptables, SELinux, etc. When checking firewall configurations, make sure to check all of them.

One-click install plugin side#

If the server that installs the server side also needs to be managed, the plugin side also needs to be installed on the server side (the server side and plugin side can be installed simultaneously on the same server)

⚠️ Special reminder: When performing one-click installation, be careful not to execute the command in the same directory, i.e., the Server side and Agent side cannot be installed in the same directory!

If you need to modify the plugin side data and log storage path, please modify the jpom.path configuration property in the application.yml file.

# One-click default installation
curl -fsSL https://jpom.top/docs/install.sh | bash -s Agent jdk+default
# One-click default installation + automatic configuration for startup service
curl -fsSL https://jpom.top/docs/install.sh | bash -s Agent jdk+default+service

# Install plugin side and jdk environment
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

After successful startup, the plugin side port is 2123, which is provided for use by the server side.

Method 2: 📦 Containerized installation#

⚠️ Note: The containerized installation method requires Docker to be installed first, click here for Docker installation documentation

Install with one command#

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

Use mounted storage for relevant data (may have compatibility issues in some environments)#

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

Use container volume for relevant data storage#

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

The containerized installation only provides the server version. Due to the isolation of the container and the host environment, many functions of the plugin side cannot be used normally, so containerizing the plugin side is not very meaningful.

For installing Docker, configuring images, automatic startup, finding the installation directory, etc., you can refer to the documentation
https://jpom.top/pages/b63dc5/

Running in lower versions of Docker may result in the error ls: cannot access '/usr/local/jpom-server/lib/': Operation not permitted, in which case you need to add the --privileged parameter
For example: docker run -p 2122:2122 --name jpom-server jpomdocker/jpom --privileged

Method 3: 💾 Download and install#

  1. Download the installation package https://jpom.top/pages/all-downloads/
  2. Unzip the file
  3. Install the plugin side
    1. The agent-x.x.x-release directory contains all installation files for the plugin side
    2. Upload to the corresponding server (the entire directory)
    3. Start the plugin side, using bat script for Windows environment, sh script for Linux environment. (If there are garbled characters or it cannot be executed normally, please check the encoding format and line endings.)
    4. Default running port for the plugin side: 2123
  4. Install the server side
    1. The server-x.x.x-release directory contains all installation files for the server side
    2. Upload to the corresponding server (the entire directory)
    3. Start the server side, using bat script for Windows environment, sh script for Linux environment. (If there are garbled characters or it cannot be executed normally, please check the encoding format and line endings.)
    4. Default running port for the server side: 2122, access management page: http://127.0.0.1:2122/ (for non-local access, replace 127.0.0.1 with your server IP address)

Method 4: ⌨️ Compile and install#

  1. Visit the Jpom Gitee homepage to pull the latest complete code (it is recommended to use the master branch)
  2. Switch to the web-vue directory and execute npm install (the Vue environment needs to be set up in advance, and details about installing dependencies can be found in the README.md in the web-vue directory)
  3. Execute npm run build to package the Vue project
  4. Switch to the project root directory and execute: mvn clean package
  5. Install the plugin side
    1. Check the plugin side installation package modules/agent/target/agent-x.x.x-release
    2. Package and upload to the server for execution (the entire directory)
    3. Start the plugin side, using bat script for Windows environment, sh script for Linux environment. (If there are garbled characters or it cannot be executed normally, please check the encoding format and line endings.)
    4. Default running port: 2123
  6. Install the server side
    1. Check the server side installation package modules/server/target/server-x.x.x-release
    2. Package and upload to the server for execution (the entire directory)
    3. Start the server side, using bat script for Windows environment, sh script for Linux environment. (If there are garbled characters or it cannot be executed normally, please check the encoding format and line endings.)
    4. Default running port for the server side: 2122, access management page: http://127.0.0.1:2122/ (for non-local access, replace 127.0.0.1 with your server IP address)

You can also use script/release.bat or script/release.sh for quick packaging.

Method 5: 📦 One-click start with docker-compose#

  • No need to install any environment, automatically compile and build

Note: Be sure to modify the token value in the .env file

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

Method 6: 💻 Compile and run#

  1. Visit the Jpom Gitee homepage to pull the latest complete code (it is recommended to use the master branch; if you want to experience new features, you can use the dev branch)
  2. Run the plugin side
    1. Run org.dromara.jpom.JpomAgentApplication
    2. Pay attention to the default account password information printed in the console
    3. Default running port for the plugin side: 2123
  3. Run the server side
    1. Run org.dromara.jpom.JpomServerApplication
    2. Default running port for the server side: 2122
  4. Build the Vue page, switch to the web-vue directory (the local development environment needs to have node and npm)
  5. Install project Vue dependencies, execute npm install in the console
  6. Start development mode, execute npm run dev in the console
  7. Access the front-end page based on the address output in the console: http://127.0.0.1:3000/ (for non-local access, replace 127.0.0.1 with your server IP address)

Manage Jpom Commands#

  1. Use bat script files in Windows systems.
# Server management script (command line)
./bin/Server.bat start   # Start Jpom server
./bin/Server.bat stop    # Stop Jpom server
./bin/Server.bat restart # Restart Jpom server
./bin/Server.bat status  # View Jpom server running status
# Server management script (control panel), follow the prompts in the panel to enter operations
./bin/Server.bat

# Plugin management script
./bin/Agent.bat start   # Start Jpom plugin
./bin/Agent.bat stop    # Stop Jpom plugin
./bin/Agent.bat restart # Restart Jpom plugin
./bin/Agent.bat status  # View Jpom plugin running status
# Plugin management script (control panel), follow the prompts in the panel to enter operations
./bin/Agent.bat

In Windows systems, after executing the startup, you need to follow the logs to track the startup status. If there are garbled characters, please check or modify the encoding format. The recommended encoding format for bat files in Windows systems is GB2312.

  1. Use sh script files in Linux systems.
# Server
./bin/Server.sh start     # Start Jpom server
./bin/Server.sh stop      # Stop Jpom server
./bin/Server.sh restart   # Restart Jpom server
./bin/Server.sh status    # View Jpom server running status
./bin/Service.sh install  # Create application service for Jpom server (jpom-server)

# Plugin
./bin/Agent.sh start     # Start Jpom plugin
./bin/Agent.sh stop      # Stop Jpom plugin
./bin/Agent.sh restart   # Restart Jpom plugin
./bin/Agent.sh status    # View Jpom plugin running status
./bin/Service.sh install # Create application service for Jpom plugin (jpom-agent)

Linux Service Management#

The installation service here is for reference only; you can customize the configuration according to your needs.

After successfully using ./bin/Service.sh install

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

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

⚙️ Jpom Parameter Configuration#

In the root path of the project:

Program Configuration ./conf/application.yml#

  1. Plugin side example:
    application.yml
  2. Server side example:
    application.yml

Project Logs ./conf/logback.xml#

  1. Plugin side example:
    logback.xml
  2. Server side example:
    logback.xml

📝 Frequently Asked Questions, Operation Instructions#

Loading...
Ownership of this post data is guaranteed by blockchain and smart contracts to the creator alone.