Skip to content

Ribbon2 UIX

Stanislav Nepochatov edited this page Oct 21, 2024 · 1 revision

General

UIX module provides basic UI for Ribbon2 system. Written on HTMX. Doesn't store any data, just pass through requests to REST API of the gateway module.

Configuration

Example:

{
    "gatewayUrl": "http://127.0.0.1:9000",
    "gatewayDummy": false,
    "http": {
        "port": 9999,
        "authCookieName": "R2_AUTH",
        "authTokenValidDays": 30
    }
}

List of params:

  • gatewayUrl - URL for gateway module. All REST API calls will use this param value;
  • gatewayDummy - enable dummy gateway. Instead of sending requests to system UIX will mock data. For debug purposes;
  • http.port - port of UIX module;
  • http.authCookieName - name of the auth cookie to save auth data from system;
  • http.authTokenValidDays - period of validity of the auth cookie in days;

Startup

UIX module can be started like normal Java application or in Docker image. Project contains ready-to-use Dockerfile.

During startup UIX don't call gateway. All calls to the system triggered only by user interaction with ui.

Clone this wiki locally