logo
25.1
search
No matching documents found.
list
search
No matching documents found.
logo

Config Files

Standalone Webswing config

This is a configurations file for Webswing standalone. By default webswing.config is located in Webswing root folder.

{
  "/": {
    ServerConfig
  },
  "/example-app": {
    SecuredPathConfig
    "swingConfig": {
      SwingConfig
    }
  }
}

ServerConfig
SecuredPathConfig
SwingConfig

Example of webswing.config with default values:

{
  "/": {
    "webHomeDir": "${user.dir}",
    "webFolder": "",
    "langFolder": ""
  },
  "/example-app": {
    "enabled": true,
    "name": "My Application",
    "webHomeDir": "${user.dir}",
    "webFolder": "",
    "langFolder": "",
    "sessionMode": "CONTINUE_FOR_BROWSER",
    "maxClients": "1",
    "maxClientsPerUser": "-1",
    "allowStealSession": true,
    "autoLogout": true,
    "goodbyeUrl": "",
    "monitorEdtEnabled": true,
    "loadingAnimationDelay": 2,
    "recordingAllowed": true,
    "recordingConsentRequired": false,
    "mirroringAllowed": true,
    "mirroringConsentRequired": false,
    "uploadMaxSize": 5
    "swingConfig": {
      "enabled": true,
      "homeDir": "${user.dir}",
      "theme": "",
      "directdraw": true,
      "debug": false,
      "testMode": false,
      "userDir": "",
      "jreExecutable": "${java.home}/bin/java",
      "javaVersion": "${java.version}",
      "javaFx": false,
      "javaFxVersion": "11",
      "javaFxEmbeddedInJdk": false,
      "launcherType": "Desktop",
      "prelaunchType": "NONE",
      "swingSessionTimeout": 300,
      "timeoutIfInactive": false,
      "inactivityAction": "SHUTDOWN",
      "idleInstancesCount": 0,
      "sessionLogging": false,
      "sessionLogMaxFileSize": "${webswing.sessionLog.maxSize:-1000MB}",
      "sessionLogFileSize": "${webswing.sessionLog.size:-10MB}",
      "allowStatisticsLogging": true,
      "isolatedFs": true,
      "allowUpload": true,
      "allowDelete": true,
      "allowDownload": true,
      "allowAutoDownload": false,
      "transparentFileOpen": true,
      "transparentFileSave": true,
      "transferDir": "${user}/upload",
      "clearTransferDir": true,
      "threadDumpsFolder": "${" + Constants.ROOT_DIR_PATH + "}/datastore/dumps",
      "recordingsFolder": "${" + Constants.ROOT_DIR_PATH + "}/datastore/recordings",
      "allowJsLink": false,
      "allowLocalClipboard": true,
      "allowServerPrinting": false,
      "fontEmbeddingEnabled": false,
      "dockMode": "NONE",
      "dockType": "POPUP",
      "multiScreenSupportEnabled": false
    }
  }
}

Cluster Server config

This is a configurations file for Webswing cluster server and applications. Available only in cluster version. Configuration is managed by Webswing admin server. By default webswing-server.config is located in Server root folder.

{
  "/": {
    ServerConfig
  },
  "/example-app": {
    SecuredPathConfig
  }
}

ServerConfig
SecuredPathConfig

Example of webswing-server.config with default values:

{
  "/": {
    "webHomeDir": "${user.dir}",
    "webFolder": "",
    "langFolder": ""
  },
  "/example-app": {
    "enabled": true,
    "name": "My Application",
    "webHomeDir": "${user.dir}",
    "webFolder": "",
    "langFolder": "",
    "sessionMode": "CONTINUE_FOR_BROWSER",
    "maxClients": "1",
    "maxClientsPerUser": "-1",
    "allowStealSession": true,
    "autoLogout": true,
    "goodbyeUrl": "",
    "monitorEdtEnabled": true,
    "loadingAnimationDelay": 2,
    "recordingAllowed": true,
    "recordingConsentRequired": false,
    "mirroringAllowed": true,
    "mirroringConsentRequired": false,
    "uploadMaxSize": 5
  }
}

Cluster Session-pool config

This is a configurations file for Webswing cluster applications. Available only in cluster version. Configuration is managed by Webswing admin server. By default webswing-app.config is located in Session-pool root folder.

{
  "/example-app": {
    SwingConfig
  }
}

SwingConfig

Example of webswing-app.config with default values:

{
  "/example-app": {
    "enabled": true,
    "homeDir": "${user.dir}",
    "theme": "",
    "directdraw": true,
    "debug": false,
    "testMode": false,
    "userDir": "",
    "jreExecutable": "${java.home}/bin/java",
    "javaVersion": "${java.version}",
    "javaFx": false,
    "javaFxVersion": "11",
    "javaFxEmbeddedInJdk": false,
    "launcherType": "Desktop",
    "prelaunchType": "NONE",
    "swingSessionTimeout": 300,
    "timeoutIfInactive": false,
    "inactivityAction": "SHUTDOWN",
    "idleInstancesCount": 0,
    "sessionLogging": false,
    "sessionLogMaxFileSize": "${webswing.sessionLog.maxSize:-1000MB}",
    "sessionLogFileSize": "${webswing.sessionLog.size:-10MB}",
    "allowStatisticsLogging": true,
    "isolatedFs": true,
    "allowUpload": true,
    "allowDelete": true,
    "allowDownload": true,
    "allowAutoDownload": false,
    "transparentFileOpen": true,
    "transparentFileSave": true,
    "transferDir": "${user}/upload",
    "clearTransferDir": true,
    "threadDumpsFolder": "${" + Constants.ROOT_DIR_PATH + "}/datastore/dumps",
    "recordingsFolder": "${" + Constants.ROOT_DIR_PATH + "}/datastore/recordings",
    "allowJsLink": false,
    "allowLocalClipboard": true,
    "allowServerPrinting": false,
    "fontEmbeddingEnabled": false,
    "dockMode": "NONE",
    "dockType": "POPUP",
    "multiScreenSupportEnabled": false
  }
}

Cluster Autoscaling config

This is a configurations file for Webswing cluster autoscaling. Available only in cluster version. Autoscaling is managed by Webswing admin server. By default webswing-autoscaling.config is located in Admin server root folder.

{
  "/": {
    AutoScalingConfig
  }
}

AutoScalingConfig

Example of webswing-autoscaling.config with default values:

{
  "/": {
    "enabled": false,
    "homeDir": "${user.dir}",
    "minSessionPools": 1,
    "startSessionPoolScriptTimeout": 300,
    "stopSessionPoolScriptTimeout": 300,
    "autoScalingSessionPoolAlgorithmModule": "DEFAULT"
  }
}