Configuration

Erupt is configured in two places: the backend in application.yml, and the frontend through static files under resources/public/ (app.js, app.css, home.html). Every entry is optional — configure only what you need.

Backend Configuration (application.yml)

erupt-app — frontend application settings

erupt-app.* controls frontend presentation (watermark, captcha policy, languages, login page). It is backed by xyz.erupt.upms.prop.EruptAppProp and ships with erupt-upms. The frontend pulls the whole set once at startup via GET /erupt-api/erupt-app.

erupt-app:
  # Enable the page watermark (v1.12.0+)
  water-mark: true
  # Include the date in the watermark (v1.14.3+)
  water-mark-date: false
  # Custom watermark content; shows the current user when empty (v1.14.3+)
  water-mark-content: ""
  # Show a captcha after this many failed logins; 0 means a captcha is always required
  verify-code-count: 2
  # Encrypt the password in transit during login; turn off for scenarios such as LDAP that need the cleartext password
  pwd-transfer-encrypt: true
  # Expose the password-reset feature; when disabled the frontend hides every entry point (v1.12.7+)
  reset-pwd: true
  # Prompt users who are still on the default password to change it after login
  reset-pwd-prompt: false
  # Path to a custom login page; HTTP URLs are supported (v1.10.6+)
  login-page-path: /customer-login.html
  # Languages selectable in the login page and the language switcher; the system default is controlled by erupt.default-locales
  # An empty list falls back to ["en-US"]
  locales:
    - "zh-CN"   # Simplified Chinese
    - "zh-TW"   # Traditional Chinese
    - "en-US"   # English
    - "fr-FR"   # Français
    - "ja-JP"   # 日本語
    - "ko-KR"   # 한국어
    - "ru-RU"   # русск
    - "es-ES"   # Español
    - "de-DE"   # Deutsch
    - "pt-PT"   # Português
    - "id-ID"   # Bahasa Indonesia
    - "ar-SA"   # العربية
  # Custom key-values delivered to the frontend alongside /erupt-api/erupt-app; readable from app.js or TPL pages
  properties:
    show-help-entry: true
    help-doc-url: https://docs.your-company.com

verify-code-count: 0 does not disable the captcha

0 means every login requires a captcha. To relax the policy, raise the number.

reset-pwd vs reset-pwd-prompt

reset-pwd decides whether the feature exists at all (disabled removes every entry point). reset-pwd-prompt decides whether to nag — when enabled, users still on the initial password are reminded on every login. reset-pwd-prompt: true is recommended in production.

properties can also be registered from code. This is exactly how erupt-websocket, erupt-ai, erupt-notice and erupt-print announce "I am installed" to the frontend, which then decides whether to render the matching entry points:

@Resource
private EruptAppProp eruptAppProp;

@PostConstruct
public void init() {
    eruptAppProp.registerProp("my-module", true);
}

The response also carries two read-only fields filled in by the server — hash (hashCode of the controller instance, used by the frontend to detect changes) and version (the current Erupt version). Setting them in yaml has no effect.

See also: Custom Login Page · Internationalization

erupt — framework core

erupt:
  # Enable CSRF protection
  csrf-inspect: true
  # Path where uploaded attachments are stored; defaults to /opt/erupt-attachment
  upload-path: D:/erupt/pictures
  # Keep the original file name when uploading
  keep-upload-file-name: false
  # Initialization mode: NONE - never run init code, EVERY - run on every startup, FILE - use a marker file
  init-method-enum: file
  # Default language used during initialization for text values (v1.12.3+)
  default-locales: zh-CN
  # Enable log collection — viewable under System Logs in real time (v1.12.14+)
  log-track: true
  # Maximum number of buffered log lines (v1.12.14+)
  log-track-cache-size: 1000
  security:
    # Record operation logs; viewable under System Management → Operation Logs
    record-operate-log: true
    # Max request body size (bytes) buffered for operation logging; larger or chunked bodies are not recorded. Default 1MB (v2.0.2+)
    record-operate-log-max-body-size: 1048576
  upms:
    # Login session length (minutes)
    expire-time-by-login: 60
    # Strict role-menu policy, true by default. It governs the candidate tree of Role Management -> Menu Permission:
    # when on, a non-admin can only grant menus it already holds (the union of its enabled roles' menus),
    # so a role can never receive a permission the operator lacks. Super admins are unrestricted; turning it off
    # lets anyone who can open Role Management hand out every menu, i.e. gives away privilege escalation.
    # Note: menus a role holds beyond the operator's reach are not rendered in the tree and are removed when that
    # user saves the role — keep such roles with a super admin
    strict-role-menu-legal: true
    # Default super-admin username used at system initialization (v1.12.18+)
    default-account: erupt
    # Default super-admin password used at system initialization (v1.12.18+)
    default-password: erupt

erupt.redis-session — distributed sessions

When enabled, sessions are stored in Redis. Add the standard Spring Boot Redis configuration alongside it:

erupt:
  # Store sessions in Redis, default false
  redis-session: true
  # Auto-refresh the Redis session (v1.10.8+)
  redis-session-refresh: false

spring:
  data:
    redis:
      database: 0
      timeout: 10000
      host: 127.0.0.1

erupt.telemetry — anonymous telemetry

erupt:
  telemetry:
    # Report anonymous usage statistics, default true (v2.2.0+)
    # Can also be disabled with ERUPT_TELEMETRY_DISABLED=1; CI environments are skipped automatically
    enabled: true
    # Reporting endpoint, may point at a self-hosted collector
    endpoint: https://telemetry.erupt.xyz/v1/ping

For the full list of collected fields see Anonymous Telemetry.

Module-specific settings

Settings that belong to an extension module (erupt.ai.*, erupt.designer.*, erupt.remote.*, erupt.job.*, …) only take effect once that module is on the classpath, and are documented on the module's own page rather than repeated here: Erupt AI · Erupt AI Claw · Erupt Designer · Erupt Remote · Erupt Job.

Frontend Configuration (app.js)

Create the file manually at /resources/public/app.js.

It covers: basic parameters, route callbacks, global lifecycle hooks, and more.

window.eruptSiteConfig = {
    // Erupt API endpoint — required for frontend/backend separation
    domain: "",
    // Attachment URL — usually not required, but needed when using a custom object-storage provider
    fileDomain: "",
    // Title
    title: "Erupt",
    // Description
    desc: "Universal data management framework",
    // Whether to display copyright info
    copyright: true,
    // Enable multi-tab route reuse by default (v2.2.0+); the user's choice in the settings drawer wins
    tabReuse: false,
    // Custom copyright content (v1.12.8+)
    copyrightTxt: function() {
      return "Copyright xxxx"
    },
    // AMap (高德) API key — required when using the map component
    amapKey: "xxxx",
    // AMap SecurityJsCode
    amapSecurityJsCode: "xxxxx",
    // Logo path
    logoPath: "erupt.svg",
    // Logo shown when the sidebar is collapsed (v1.12.21+)
    logoFoldPath: null,
    // Logo text
    logoText: "erupt",
    // Registration page URL
    registerPage: "",
    // Appearance defaults. Each one applies only until the user picks something in the
    // "Page config" drawer; that choice is remembered in the browser and wins from then on
    theme: {
        // Primary color; the default is rgb(22, 119, 255) as of 2.2.0
        primaryColor: "rgb(22, 119, 255)",
        // Header bar color: "primary" (follow the primary color) or any CSS color
        headerColor: "primary",
        // Color scheme: false | true | "auto" (follow the OS)
        dark: false,
        // Compact mode
        compact: false,
        // Skin: "default" | "brutalist" | "liquid-glass"
        skin: "default",
        // Menu mode: "normal" sidebar | "split" categories in the header | "dual" two-column sidebar | "top" whole menu in the header, no sidebar
        menuMode: "normal"
    },
    // Custom items shown in the user-avatar menu (v1.12.21+)
    userTools: [{
        text: "Custom user tool",
        icon: "fa fa-snowflake-o",
        click: function (event) {
            alert("On Click")
        }
    }],
    // Custom buttons in the top-right navigation bar
    r_tools: [{
        icon: "fa-eercast",
        render: () => {
          return `<h2>Custom render</h2>`
        },
        mobileHidden: false,
        click: function (event) {
            alert("Function button");
        }
    }],
};

// Route callbacks
window.eruptRouterEvent = {
    demo: {
        load: function (e) { },
        unload: function (e) { }
    },
    $: {
        load: function (e) { },
        unload: function (e) { }
    }
};

// Erupt lifecycle hooks
window.eruptEvent = {
    startup: function () { },
    login: function(user){
      window.notify.success("Tip", "login success")
    },
    logout: function(user){ }
}

Minimal recommended configuration:

window.eruptSiteConfig = {
  title: "Your App Title",
  desc: "description",
  copyright: false,
  logoPath: "erupt.svg",
  logoText: "APP",
};

Frontend Styles (app.css)

Create the file manually at /resources/public/app.css. It is loaded after the framework stylesheets and is where you override defaults or add styles of your own.

The primary and header colors are already covered by the theme block in app.js, so they need no CSS. Here is the login card as an example:

/* Example: wider login card, bigger radius, primary-colored top edge */
:root layout-passport .lp-card {
    max-width: 420px;
    border-radius: 16px;
    border-top: 4px solid var(--ant-primary-color);
    box-shadow: 0 24px 64px rgba(0, 0, 0, 0.18);
}

The :root prefix out-ranks the component's own styles. In dark mode <html> carries .dark, so write :root.dark layout-passport .lp-card when the two modes need different values.

Custom Home Page (home.html)

Erupt ships a default home page that works out of the box. To replace it with your own, create /resources/public/home.html — the framework loads it in place of the default:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta content="width=device-width, initial-scale=1" name="viewport">
</head>
<body>
    <h1>Hello World</h1>
</body>
</html>

Contributors

YuePeng

Claude Opus 5 (1M context)

Changelog

Last edited 2 minutes ago

View full history

f3752b9-filter: add a role-based row-level data filtering example