list
logo

Startup options

Start scripts webswing.bat and webswing.sh are included in Webswing distribution. These scripts may need to be adapted to point to the right Java installation and to configure other custom options.

The launcher does not define a dedicated help flag; if argument parsing fails, it prints the supported option list together with the parsing error.

The launcher starts Webswing Server by default. Add one of these mode switches when another role is required:

Switch Mode
-admin Start only Admin Console.
-serveradmin Start Webswing Server together with Admin Console.
-clustersessionpool Start Cluster Server with an embedded Session Pool.
-testtool Start Webswing Test Tool.

You can define the following options in start scripts:

Startup properties

You can define the following properties in webswing.properties file:

Property Description Default value
webswing.connection.secret Secret string for securing user sessions and websocket connections used by Webswing server. Should be a 128 characters long string. If you are using admin console, use the same secret in webswing-admin.properties.
webswing.connection.secret.file Alternative way to specify secret string in a file.
webswing.connection.secret.random Generate a random connection secret when no direct, file, or script source is configured. Do not use this for separately running cluster modules, which must share the same secret. false
webswing.connection.secret.script Command whose standard output supplies the connection secret; arguments may follow the script path.
webswing.connection.secret.script.timeout.ms Maximum time in milliseconds to wait for the connection-secret script. 30000
webswing.logsDir Directory where Webswing server log files should be stored. This needs to be set as java property -Dwebswing.logsDir when starting the process. logs/
webswing.server.websocketUrl Provide this property only if you are going to deploy webswing-server.war on your own server, without using embedded Jetty. This property should contain the websocket URL of this Webswing server, e.g. ws://localhost:8080.
webswing.sessionPoolDumpDir Directory where thread dumps generated by Session Pool should be stored. The code fallback is the current directory (.), while the shipped server and Session Pool properties set datastore/dumps. datastore/dumps in the distribution