Jpom Documentation

Jpom is a lightweight, low-intrusion online build, automatic deployment, daily operations, and project monitoring software. It acts as a native Ops tool designed to solve common development pain points such as manual builds, complex multi-environment deployments, and the need for specialized SSH/FTP tools.

Key capabilities include:

• User Management: Multi-user management with workspace isolation, operation monitoring (email notifications), and MFA (Multi-Factor Authentication).
• Project Monitoring: Real-time status viewing, console log monitoring, and automatic alerts (Email, DingTalk, WeChat) with auto-restart capabilities.
• Online SSH Terminal: A built-in terminal that eliminates the need for external tools like PuTTY or Xshell. It includes 'bastion host' features like command restriction, command logging, and scheduled script execution.
• Online Build & Deployment: Supports GIT/SVN repository pulling, Docker container builds, SSH-based publishing, scheduled builds, and WebHook triggers.
• Infrastructure Management: Docker UI (container and Swarm management) and Nginx management (config editing, auto-reload, and SSL certificate management).
• File Management: Online text file editing and directory management.

Jpom is a simple, lightweight, and low-invasive software designed for online builds, automated deployment, daily operations, and project monitoring. It acts as a native ops tool to solve common developer pain points such as manual deployment, environment-specific packaging, and the need for multiple external tools (SSH, FTP, etc.).

Key Capabilities:

• User Management: Multi-user management with independent project permissions, workspace isolation, operation logs, and MFA (Multi-Factor Authentication).
• Project Monitoring: Real-time interface for viewing project status, console logs, and managing project files (including online text editing).
• Docker Management: Docker UI for managing containers and Docker Swarm clusters.
• Online SSH Terminal: Lightweight 'bastion host' functionality. Allows server management without external tools, command execution logging, forbidden command restriction, and SSH command templates.
• Automated Builds: Supports pulling from GIT/SVN, container builds (Docker), SSH-based deployment, scheduled builds, and WebHook-triggered builds.
• Nginx Management: Online editing of nginx configuration files with automatic reload, status management, and SSL certificate management.
• Alerting: Automatic alerts and restart attempts for abnormal project status via email, DingTalk, or WeChat.

Before using Jpom, please note the following technical constraints and best practices:

• OS Compatibility: Linux is highly compatible. Windows servers may experience compatibility issues with certain features; thorough testing is recommended.
• Installation Path: Always install the Server side and the Plugin side in different directories. Do not install them in the same directory.
• Uninstallation: To uninstall either the plugin or server side, stop the service first, then delete the program files, log folders, and data directory folders.
• Build Environment: Local builds depend on the system environment. If your build commands require maven or node, these must be installed on the server. If you install these environments after the Jpom server has already started, you must restart the server for the changes to take effect.
• Ubuntu/Debian Plugin Installation: If plugin installation fails on Ubuntu/Debian, create a .bash_profile file in the current user's home directory.
• Version Upgrades: Do not attempt to downgrade from version 2.7.x, as it will cause data incompatibility.
• Network Requirements: Since version 2.x.x uses HTTP for communication between the plugin side and the server side, ensure that the plugin and server can communicate over the network.

Before deploying or upgrading Jpom, keep the following technical constraints and best practices in mind:

• OS Compatibility: Linux is highly recommended. Some features may have compatibility issues on Windows servers.
• Installation Directory: Install the Jpom server and plugin components in different directories. Do not install them in the same directory.
• Uninstallation: To uninstall, stop the corresponding service first, then delete the program files, log folders, and data directories.
• Build Environments: Local builds depend on the system environment. If your build requires Maven or Node.js, ensure they are installed on the build server. If installed after the server starts, you must restart the server via the command line for the changes to take effect.
• Ubuntu/Debian Setup: If the plugin component fails to add, create a .bash_profile file in the root directory of the current user.
• Version Compatibility:
  • Do not downgrade to versions prior to 2.7.x due to potential data incompatibility.
  • Version 2.x.x uses HTTP for communication between plugin and server components; ensure network connectivity is available.
• Future Roadmap: Jpom version 3.0 is currently in planning.

To manage a server that is also running the Jpom Server, you must install the Agent on that same machine.

Important Notes:

• Crucial: The Agent must be installed in a different directory than the Server.
• To change the data and log storage paths, modify the jpom.path property in the application.yml file.
• The Agent runs on port 2123 to provide data to the Server.

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

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

# Install Agent and JDK environment (CentOS/Yum)
yum install -y wget && \
wget -O install.sh https://jpom.top/docs/install.sh && \
bash install.sh Agent jdk

# Install Agent and JDK (Ubuntu/Apt)
apt-get install -y wget && \
wget -O install.sh https://jpom.top/docs/install.sh && \
bash install.sh Agent jdk