I. Overview ​

Oinone provides two deployment methods for the designer, allowing partners to choose the most suitable approach for their needs.

II. Docker Configuration Parameters ​

(Ⅰ) Environment Variables ​

  • ARG_ENV: Specifies spring.profiles.active (Default: dev)
  • ARG_LIFECYCLE: Specifies -Plifecycle (Default: INSTALL)
  • JVM_OPTIONS: JVM parameters
  • PROGRAM_ARGS: Program parameters

Description of JVM_OPTIONS and PROGRAM_ARGS parameters:

shell
java [JVM_OPTIONS?] -jar boot.jar [PROGRAM_ARGS?]

(Ⅱ) Port Description ​

Note:

The following are all ports of the current designer image. Different types of images use different numbers of ports due to built-in services, but the port numbers are completely consistent.

  • Port 80: Frontend service port, serving as the access entry for the designer, responsible for data transmission and access guidance for the frontend application and user interface.
  • Port 8091: Backend service port, handling backend business logic, responding to frontend requests, and performing data processing and business flow control.
  • Port 8093: Backend EIP service port, mainly serving backend enterprise integration platform functions to ensure integration and interaction between different systems.
  • Port 20880: Dubbo port. As a distributed service framework, Dubbo uses this port to implement core functions such as service registration, discovery, and invocation.
  • Port 3306: Built-in MySQL database port, used for communication between the MySQL database management system and external applications to perform data storage, retrieval, etc.
  • Port 2181: Built-in Zookeeper port. As a distributed coordination service, Zookeeper uses this port to complete configuration management, naming services, and cluster management in a distributed environment.
  • Port 6379: Built-in Redis port. As a high-performance key-value database, Redis uses this port for fast data reading/writing, caching, etc.
  • Ports 9876/10991: Built-in RocketMQ ports. As a distributed message queue, RocketMQ uses these two ports for message sending, receiving, and storage to ensure asynchronous communication and peak shaving between systems.
  • Port 9999: Built-in local OSS default port. The local object storage service (OSS) provides object storage functions through this port, supporting data storage and access.

(Ⅲ) Mount Directory Description (Mount Virtual Volume) ​

In the image environment, /opt/pamirs is specified as the working directory, and all mount directories are built based on this directory. The specific functions of each directory are as follows:

  • /opt/pamirs/ext: Directory for storing application configuration files, including key configuration files such as application.yml, logback.xml, and license.lic, which configure application runtime parameters, logging strategies, and authorization licenses.
  • /opt/pamirs/nginx/vhost: Dedicated directory for storing Nginx configuration files, centrally managing and maintaining Nginx configuration to enable efficient processing and forwarding of network requests.
  • /opt/pamirs/logs: Backend service log directory, collecting and storing various log information generated by backend services during operation, crucial for system fault troubleshooting, performance analysis, and operation monitoring.
  • /opt/mq/conf/broker.conf: Path to RocketMQ's broker configuration file, which plays a key role in setting parameters for RocketMQ's core functions like message processing, storage, and cluster deployment.
  • /opt/pamirs/outlib: Defined as the external loading directory (external library) for non-designer built-in packages, where users can add any required jar packages to extend the designer's functionality.
  • /opt/pamirs/dist: Frontend service directory, hosting frontend service-related files and resources to support frontend application operation.
  • /opt/pamirs/static: A multi-functional directory serving as both the frontend static file directory for storing frontend static resources and the upload/download directory for LOCAL-type OSS (Object Storage Service), managing data transmission for local object storage.

(Ⅳ) Common Parameters for docker run Startup ​

  • -e: Specify environment variables
  • -p: Specify port mapping
  • -v: Specify mount directory (mount virtual volume)
shell
docker run [OPTIONS] IMAGE [COMMAND] [ARG...]

(Ⅴ) Common Configurations for docker compose Startup ​

yaml
services:
  container:
    image: $IMAGE
    container_name: $CONTAINER_NAME
    restart: always
    # Equivalent to docker run -e
    environment:
      KEY1: VALUE1
      KEY2: VALUE2
      ...
    # Equivalent to docker run -p
    ports:
      - $machinePort1:$containerPort1
      - $machinePort2:$containerPort2
      ...
    # Equivalent to docker run -v
    volumes:
      - $machinePath1:$containerPath1
      - $machinePath2:$containerPath2
      ...

(Ⅵ) Common docker compose Commands ​

shell
# Start using docker-compose.yaml
docker compose up -d

# Stop and remove containers using docker-compose.yaml
docker compose down -v

# Start with a specified configuration file
docker compose -f config.yaml up -d

# Stop and remove containers with a specified configuration file
docker compose -f config.yaml down -v

III. JAR Package Startup Method ​

(Ⅰ) Download Oinone Exclusive Starter ​

oinone-boot-starter.zip

(Ⅱ) Startup Command Changes ​

shell
# Original command
java -jar boot.jar

# Changed command
boot-starter java -jar boot.jar