SnailJob Documentation

SnailJob is a flexible, reliable, and high-performance distributed task retry and task scheduling platform. It is designed to improve the consistency of distributed business systems through replayable and controllable task retries.

Key features include:

• Distributed Task Retry: Replayable and controllable mechanism to ensure business consistency.
• High-Performance Scheduling: Supports second-level precision, interruptible tasks, and task orchestration.
• Scalability: Uses a partition-based mode to achieve high scalability and fault tolerance.
• Management Features: Includes comprehensive permission management, powerful alarm monitoring, and a user-friendly interface.

After making modifications to the code within the frontend directory, you must ensure that the Maven build process includes these changes.

1. Locate the skipFrontend option in your Maven configuration.
2. Ensure skipFrontend is not checked (it must be set to false or disabled).
3. Run the standard Maven packaging command to build the project with the integrated frontend.

To integrate a custom frontend interface into the snail-job-server-ui project, you must follow a specific directory structure where the frontend source code resides within the Maven project structure. The process involves creating a dedicated frontend directory, cloning the base administration UI, making your customizations, and ensuring Maven is configured to include the frontend during the build process.

snail-job-server-ui/
└─ src/
   └─ main/
      └─ frontend/  # New frontend directory
         └─ snail-job-admin/  # Cloned frontend code

To integrate a custom frontend interface into the Snail-Job project, you must place your frontend source code within the snail-job-server-ui module's directory structure. This allows the Maven build process to include your custom UI in the final application package.

Follow these steps:

1. Prepare the directory: Create a frontend directory inside snail-job-server-ui/src/main/.
2. Clone the base UI: Pull the official snail-job-admin source code into that directory to use as a starting point.
3. Customize: Modify the files within the cloned directory to meet your requirements.
4. Build: Ensure the Maven configuration is set to include the frontend before running the build command.

snail-job-server-ui/
└─ src/
   └─ main/
      └─ frontend/  # New frontend directory
         └─ snail-job-admin/  # Cloned frontend code

Navigate to the src/main/frontend directory and clone the official snail-job-admin repository. Ensure you are inside the frontend directory when running the command so that the code is cloned directly into the expected location.

cd src/main/frontend
git clone https://gitee.com/opensnail/snail-job-admin.git

To get started with SnailJob, refer to the following documentation categories:

• Deployment: Instructions for Service Deployment.
• Getting Started: Follow the QuickStart guide.
• Migration: Use the xxljob migration script if moving from XXL-JOB.
• API Integration:
  • OpenApi Overview
  • Python Client Guide
  • Go Client Guide
• Support: Check the Q/A section for common questions.

To set up the base frontend code, navigate to the src/main/frontend directory within the snail-job-server-ui module and clone the official repository.

Note: Ensure you are executing the command inside the frontend directory so the code is cloned directly into the expected path.

cd src/main/frontend
git clone https://gitee.com/opensnail/snail-job-admin.git

To integrate a custom frontend into the snail-job-server-ui project, you must place your frontend source code within a specific directory structure so that the Maven build process can include it. The process involves creating a frontend directory, cloning the base administration UI, making your modifications, and ensuring the Maven build is configured to include the frontend assets.

# 1. Create the directory structure
# snail-job-server-ui/src/main/frontend/

# 2. Clone the base admin UI into that directory
cd src/main/frontend
git clone https://gitee.com/opensnail/snail-job-admin.git

SnailJob provides a docker-compose.yaml configuration to quickly spin up various database engines for testing or development. The configuration includes support for MySQL, PostgreSQL, Oracle XE, SQL Server, MariaDB, DM8 (Dameng), and Kingbase. Each service is pre-configured with the necessary initialization scripts to set up the snail_job schema.

To use this, ensure you have Docker and Docker Compose installed, then run:

docker compose up -d

SnailJob provides official client implementations for various programming languages to integrate task scheduling and retries into your applications:

• Java: snail-job-demo (Example program)
• Python: snail-job-python (Python client)
• Go: snail-job-go (Go client)

- [snail-job-demo (Java客户端示例程序)](https://gitee.com/opensnail/snail-job-demo.git)
- [snail-job-python (Python客户端)](https://gitee.com/opensnail/snail-job-python.git)
- [snail-job-go (Go客户端)](https://gitee.com/opensnail/snail-job-go.git)