jWebSocket Quickguide

Although we encourage you to delve into the jWebSocket fundamentals here you find a quick-guide how to immediately use the jWebSocket technology. jWebSocket

Stand-Alone Server

Prerequisities on the server

The jWebSocket server is based on pure Java technology. For your server please ensure that you have at least the Java Runtime Environment (JRE) 1.5 installed. If not you can get it here . We recommend to put the path to java.exe into your PATH enviroment variable. If not, you may need to adjust the provided start batch.

Prerequisities on the Client

The jWebSocket client is based on pure JavaScript and does not require any browser plug-ins. It also runs from a local file system, i.e. you do not need to install any web server. However, be sure that you allow JavaScript on your Browser. Up to now (2010-02-24) only Google's Chrome from Version 4.0.249 fully supports WebSockets according to the HTML 5 standards. You can get the latest Google Chrome 4 Browser here or the Chrome Frame for IE 6/7/8 here.

Setup the jWebSocket Server

To set up the jWebSocket server on your MS Windows system please....

1. Create a folder of your choice (e.g. c:\jWebSocket\server).
2. Download the jWebSocketSAServer.zip which includes the jWebSocketSAServer.jar, all required libs and jWebSocketSAServer.bat from the download section to this folder.
3. Start the batch either from the command shell or the Windows Explorer.

If the path to the java.exe is not part of your PATH environment variable, please adjust the jWebSocketSAServer.bat.

Setup the jWebSocket Client

To run the jWebSocket client on your MS Windows system please....

1. Create a folder of your choice (e.g. c:\jWebSocket\client).
2. Download the jWebSocketClient.zip from the download section and unzip it into this folder.
3. Start your browser (currently only Google's Chrome Browser and Chrome Frame for IE 6/7/8 from Version 4.0.249 fully support WebSockets).
4. Type file:///[path/to/client/]index.htm (e.g. file:///c:/jWebSocket/client/index.html) into the URL input field of the browser.
5. The browser opens the Welcome page of the jWebSocket client. You now can test the chat, fundamentals, streaming and RPC demos.

Done!

jWebSocket Web Application (Tomcat)

Prerequisities on the server

You only need to have Tomcat 6.x running on your system and we recommend to have Java 1.6 installed. It is possible but not needed to use the Apache http server as frontend together with mod_proxy or mod_jk.

Prerequisities on the Client

The jWebSocket client is embedded into the web application, so that there is no need for certain preparations.

Setup the jWebSocket Web Application

1. Create a folder of your choice (e.g. c:\jWebSocket\webapp).
2. Download the jWebSocketAppServer.zip from the download section and unzip it into this folder.
3. Start Tomcat 6 either as service or via the Tomcat startup batch.
4. Open your HTML 5 compliant browser and open the Tomcat Manager usually at http://localhost:8080, click Manager link and authenticate as configured in the tomcat-users.xml.
5. Select the jWebSocket.war from the above folder and deploy it in Tomcat.
6. Clicking the jWebSocket item in the Tomcat manager or typing http://localhost:8080/jWebSocket in the URL input line of your browser starts the demo website. You now can test the chat, fundamentals, streaming and RPC demos.

Done!