RuoYi-Vue-Plus Documentation

RuoYi-Vue-Plus extends the standard RuoYi functionality with several advanced business features. Key differences include:

• Client Management: Supports managing all integrated clients (e.g., PC, Mini-programs) with dynamic login methods (SMS, password) and dynamic token expiration control.
• File Management: Includes built-in file display, upload, download, and deletion, along with dynamic configuration management for file storage.
• Advanced Scheduled Tasks: Supports full task management (add, modify, delete), log management, and executor management (standard RuoYi only supports task and log management).
• Multi-DataSource Code Generation: Supports generating frontend and backend code (Java, HTML, XML, SQL) for multiple data sources with CRUD download capabilities.
• Enhanced Service Monitoring: Provides cluster-level monitoring for CPU, memory, disk, stack, online logs, and Spring configurations (standard RuoYi is limited to single-machine monitoring).
• Use Case Demonstrations: Includes built-in functional case studies.

RuoYi-Vue-Plus is an enhanced version of the RuoYi framework designed for higher performance, better extensibility, and modern development standards. Key improvements include:

• Frontend: Rewritten with Vue3 + TS + ElementPlus (vs Vue2/3 + JS).
• Backend Architecture: Uses a plugin-based and extension-pack structure for decoupling, making it easier to extend compared to the tightly coupled modules in standard RuoYi.
• Web Container: Uses Jetty (based on Netty) for high performance instead of Tomcat.
• Security & Auth: Uses Sa-Token and Jwt for low-coupling and high extensibility, supporting complex permission expressions (e.g., AND, OR, Permission OR Role). It also includes JustAuth for third-party logins (WeChat, DingTalk, etc.).
• Database & ORM: Uses Mybatis-Plus for near-zero SQL writing and provides advanced features like automatic SQL monitoring, seamless data permission filtering via annotations, and support for multiple heterogeneous data sources via dynamic-datasource.
• Distributed Capabilities: Built-in support for Distributed Locks (Lock4j), Distributed Task Scheduling (SnailJob), Distributed File Storage (Minio/RustFS), and Distributed Sessions/WebSocket/SSE.
• Data Security: Features built-in support for Data Masking, Data Encryption/Decryption (AES, RSA, SM2, etc.), and Interface Transmission Encryption (Dynamic AES + RSA).
• Observability: Integrated with SpringBoot-Admin for service monitoring and Apache SkyWalking for distributed tracing.
• Developer Experience: Includes a code generator that supports Mybatis-Plus and SpringDoc, supports Docker orchestration for one-click environment setup, and provides comprehensive demo cases.

The mysql service uses mysql:8.4.9. Key configuration options include:

• MYSQL_ROOT_PASSWORD: Sets the root password (default: root).
• MYSQL_DATABASE: The initial database name to create (default: ry-vue).
• TZ: Sets the timezone (e.g., Asia/Shanghai).

Volumes:

• Data: /docker/mysql/data/ maps to /var/lib/mysql/.
• Config: /docker/mysql/conf/ maps to /etc/mysql/conf.d/.

Default Command Arguments:

• --character-set-server=utf8mb4
• --collation-server=utf8mb4_general_ci
• --explicit_defaults_for_timestamp=true
• --lower_case_table_names=1

mysql:
    image: mysql:8.4.9
    container_name: mysql
    environment:
      TZ: Asia/Shanghai
      MYSQL_ROOT_PASSWORD: root
      MYSQL_DATABASE: ry-vue
    ports:
      - "3306:3306"
    volumes:
      - /docker/mysql/data/:/var/lib/mysql/
      - /docker/mysql/conf/:/etc/mysql/conf.d/
    command:
      --character-set-server=utf8mb4
      --collation-server=utf8mb4_general_ci
      --explicit_defaults_for_timestamp=true
      --lower_case_table_names=1
    privileged: true
    network_mode: "host"

The ruoyi-snailai-server provides AI capabilities. When using network_mode: "host", it accesses external services via the host's ports.

Environment Variables:

• SNAIL_AI_RAG_DOCLING_ENABLED: Enables/disables Docling (default: true).
• SNAIL_AI_RAG_DOCLING_URL: URL for Docling service (default: http://127.0.0.1:5100).
• SNAIL_AI_RAG_DOCLING_PADDLE_OCR_ENABLED: Enables/disables PaddleOCR (default: true).
• SNAIL_AI_RAG_DOCLING_PADDLE_OCR_URL: URL for PaddleOCR service (default: http://127.0.0.1:8866/ocr).

Ports:

• 8900 and 18888.

Volumes:

• Logs: /docker/snailai/logs/ maps to /ruoyi/snailai/logs.

ruoyi-snailai-server:
    image: ruoyi/ruoyi-snailai-server:6.0.0
    container_name: ruoyi-snailai-server
    environment:
      TZ: Asia/Shanghai
      SNAIL_AI_RAG_DOCLING_ENABLED: ${SNAIL_AI_RAG_DOCLING_ENABLED:-true}
      SNAIL_AI_RAG_DOCLING_URL: ${SNAIL_AI_RAG_DOCLING_URL:-http://127.0.0.1:5100}
      SNAIL_AI_RAG_DOCLING_PADDLE_OCR_ENABLED: ${SNAIL_AI_RAG_DOCLING_PADDLE_OCR_ENABLED:-true}
      SNAIL_AI_RAG_DOCLING_PADDLE_OCR_URL: ${SNAIL_AI_RAG_DOCLING_PADDLE_OCR_URL:-http://127.0.0.1:8866/ocr}
    ports:
      - "8900:8900"
      - "18888:18888"
    volumes:
      - /docker/snailai/logs/:/ruoyi/snailai/logs
    privileged: true
    network_mode: "host"

The minio service uses a community-maintained image pgsty/minio:RELEASE.2026-04-17T00-00-00Z.

Environment Variables:

• MINIO_ROOT_USER: Admin username (default: ruoyi).
• MINIO_ROOT_PASSWORD: Admin password (minimum 8 characters, default: ruoyi123).
• MINIO_COMPRESS: Enables/disables compression (on or off).
• MINIO_COMPRESS_EXTENSIONS: List of extensions to compress (e.g., .pdf,.doc). Leave empty to compress all types.
• MINIO_COMPRESS_MIME_TYPES: List of MIME types to compress (e.g., application/pdf). Leave empty to compress all types.
• MINIO_SERVER_URL: (Optional) Set the HTTPS domain for the API.
• MINIO_BROWSER_REDIRECT_URL: (Optional) Set the HTTPS domain for the Console.

Ports:

• API: 9000
• Console: 9001

Volumes:

• Data: /docker/minio/data maps to /data.
• Config: /docker/minio/config maps to /root/.minio/.

minio:
    image: pgsty/minio:RELEASE.2026-04-17T00-00-00Z
    container_name: minio
    ports:
      - "9000:9000"
      - "9001:9001"
    environment:
      TZ: Asia/Shanghai
      MINIO_ROOT_USER: ruoyi
      MINIO_ROOT_PASSWORD: ruoyi123
      MINIO_COMPRESS: "off"
      MINIO_COMPRESS_EXTENSIONS: ""
      MINIO_COMPRESS_MIME_TYPES: ""
    volumes:
      - /docker/minio/data:/data
      - /docker/minio/config:/root/.minio/
    command: server --address ':9000' --console-address ':9001' /data
    privileged: true
    network_mode: "host"