#Webswing Installation Guide

Webswing is packaged and distributed as a fully working platform with some examples for your convenience, so no complicated installation is needed. Just unpack the distribution zip file and you are good to go. The only prerequisite is to have a supported version of Java installed.

Supported Java versions for starting server are

• All recent major distributions compliant with the LTS Java SE 17, 11 or 8 standards (1.8.0_202-b08 or newer)
• Adoptium, Amazon Corretto, Red Hat JDK, IBM SDK, Oracle JDK

#Downloading Webswing

First download Webswing or you can download other versions in Client Portal

#Starting on Windows

If you are using the Windows operating system, you can use the webswing.bat script, which executes the following command:

java -jar server/webswing-jetty-launcher.jar -j jetty.properties -serveradmin -pfa admin/webswing-admin.properties -adminctx /admin -aw admin/webswing-admin-server.war

Note: Make sure java is pointing to a supported java version by running java -version from your command line.

#Windows Service

#Starting on Linux

#Docker

#Startup options

#Commandline

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.

Starting Webswing with option -h will print out help with list of all possible option.

c:\webswing>java -jar webswing-server.war -h

You can define the following options in start scripts:

#Startup properties

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

#SSL configuration

You can configure the SSL with embedded Jetty (described below) or with Reverse Proxy.

There is a special configuration file for the built-in jetty called jetty.properties. It is used to configure connection options of the server like ports, protocols and SSL context. Command-line options have higher priority than this file. Location of this file can be specified by option -j. You can configure following options in this file:

org.webswing.server.host=localhost

org.webswing.server.http=true
org.webswing.server.http.port=8080

org.webswing.server.https=true
org.webswing.server.https.port=8443
org.webswing.server.https.truststore=ssl/truststore.jks
org.webswing.server.https.truststore.password=OBF:18xp18xr18xt18xp18xr18xt
org.webswing.server.https.keystore=ssl/keystore.jks
org.webswing.server.https.keystore.password=OBF:18xp18xr18xt18xp18xr18xt

In case you are not using embedded Jetty, please follow the documentation for setting up SSL for your Servlet container. Additionaly you will need to setup SSL truststore for websocket connection from app sessions (in webswing.properties file), session pool (in webswing-sessionpool.properties file) and admin console (in webswing-admin.properties file).

1. Set the webswing.server.websocketUrl to use wss Url schema.
2. Add truststore containing the CA that signed the SSL certificate. This truststore will only be used for context of websocket connection to Webswing server.:

#Custom ssl context configuration for websocket connection to Webswing server
webswing.server.websocket.truststore.type = PKCS12
webswing.server.websocket.truststore = ssl/truststore.p12
webswing.server.websocket.truststore.password = OBF:18xp18xr18xt18xp18xr18xt

3. If the websocketUrl is not the same as public domain name the SSL certificate is issued for, add the following line: webswing.server.websocket.hostnameVerifier.disabled = true
4. If the websocket connection should connect through a forward proxy, add the following line: webswing.server.websocket.proxyUri = http://myproxy:8080

#Tomcat Deployment

Even though Webswing comes with an embedded Jetty server, it is still possible to deploy it to an external servlet container like Tomcat. Other J2EE servers should work as well, as far as they support Servlet 3.0 spec and JSR-356 Websocket spec (but only Tomcat 8 is tested). Previous experience with Tomcat configuration is expected.

To deploy Webswing to Tomcat, follow the following steps:

#IBM WAS 9.0 Deployment

To deploy Webswing to WAS 9.0, follow these steps:

1. Unzip Webswing distribution to a temporary folder
2. In webswing.properties set property webswing.server.websocketUrl to ws://localhost:<port>, port should be the same as application server port
3. Go to IBM WAS Console http://localhost:9060/ibm/console
4. Navigate in the menu to Applications>New Application>New Enterprise Application
5. Click Choose File (select webswing-server.war from the temporary folder created before)
6. Next>Next>Next>Next>Next
7. Configure Webswing JVM Properties in location: Servers>Server Types>WebSphere application servers>server1>Server Infrastructure, Java and Process Management, Process Definition>Java Virtual Machine>Custom Properties similarly to following:

webswing.warLocation=webapps/webswing-server.war
webswing.configFile=webswing/webswing.config
webswing.tempDirBase=webswing/tmp
webswing.rootDir=webswing

Please note that the locations in demo webswing.config are pointing to relative paths, so in order to make the demo applications run in WAS you will need to change the paths accordingly.

In case of issues analyze the logfiles.