Setup Instructions for the Gong System

This is the setup instructions for the Gong latest version currently at 5.0.6C (client program) and 5.0.6S (server). It is primarily written for installing the system on the Windows operating system. Special notes are also given below for installation on any Unix/Linux-based system.

Before going through this page, make sure you have got the required components from the downloads page and the Gong package after submitting a request form.

The instructions are divided into two parts. The first part describes the steps on how to setup your own Gong server. After finishing this part you can use either the Gong applet or application to try your newly installed server.

Part I. Setting up your Gong Server

  1. Install the Apache Tomcat Web Server
  2. Install the Gong Server
  3. Configure the Apache Tomcat Web Server
  4. Configure the Gong Server

Part II. Accessing your Gong Server

  1. Try out your Gong system using the Applet
  2. Try out your Gong system using the Application

Setting Up the Gong Server

1. Install the Apache Tomcat Web Server

 
Step 1.1 INSTALL JAVA 2 SDK
Install Java 2 SDK
Installing Java 2 SDK Version 1.4.2
  • Download the Java 2 SDK from the downloads page
  • Install the software
  • Please remember the location of the installation as it is required in the next step, step 1.2
    Default location when installing on Windows is C:\j2sdk1.4.2_08
    For Linux, it depends where you wish to put it, our suggestion is /usr/java

For people who are installing on a Unix/Linux based system:

You should download and install an appropriate Java 2 SDK from the Java homepage.

 
Step 1.2 INSTALL THE WEB SERVER
  • Download the Apache Tomcat Web Server from the downloads page
  • Start the installation
  • When asked for Java Runtime Environment, provide the location of your Java 2 SDK installation in step 1.1, e.g. C:\j2sdk1.4.2_08
    • Tomcat would detect the available Java for you but usually it is not the one you have just installed
  • Use port 80 as the outgoing port number
  • Please remember to make a note of the username and password you have given during installation as they will be used for web server configuration later

For people who are installing on a Unix/Linux based system:

You should download and install an appropriate Tomcat from the Apache Tomcat website.

 
Step 1.3 START THE WEB SERVER
The Tomcat Configuration Window
The Tomcat Configuration Window
  • Run the server configuration by
    Start Menu > All Programs > Apache Tomcat 5.0 > Configure Tomcat
  • Start the web server by pressing the Start button

For people who are installing on a Unix/Linux based system:

You should start the Tomcat web server by following the instruction given in the installation package.

 
Step 1.4 TEST THE WEB SERVER
The Tomcat Root Page
The Tomcat Root Page
  • Open any web browser
  • Go to this location
    http://localhost
  • You should be able to see the root page of the Tomcat web server

For people who are installing on a Unix/Linux based system:

When installed on Linux, Tomcat is set up by default for access through port 8080 and not port 80. So you can briefly test the Tomcat server is installed by loading http://localhost:8080.

However, you will then need to change the configuration of Tomcat so that it uses port 80 (the usual port for web page activity) and not port 8000. To do this edit server.xml and search for '8080'. You will find it used by this directive:

<Connector port="8080" ...

Change the 8080 to 80, save the file, and restart Tomcat. You can then access http://localhost

 

2. Install the Gong Server

 
Step 2.1 INSTALL THE GONG SERVER
  • Go to the download form, fill in and submit the form
  • Download the Gong Server from the link given in the Gong email that was sent to you
  • Install the server and remember the location of the installation
    Default location when installing on Windows: C:\Gong
    For Linux, it depends where you wish to put it, our suggestion is: /usr/local/gong
 

3. Configure the Apache Tomcat Web Server

 
Step 3.0 ONLY IF USING LINUX/UNIX BASED SYSTEM
  • Do this step (step 3.0) only if you are installing on Linux/Unix based systems
  • Go to the directories where Tomcat is installed and edit the file tomcat-users.xml in the directory conf
  • Search for the text 'tomcat-users' inside the file
  • Add the following three lines inside <tomcat-users>...</tomcat-users>
    	<role rolename="admin" />	
    	<role rolename="manager" />	
    	<user username="administrator" password="administratorpassword" 
    		roles="admin,manager"/>
  • Restart the Tomcat server
 
Step 3.1 LOG ON TO THE TOMCAT ADMINISTRATION TOOL
The Tomcat Administration Tool
The Tomcat Administration Tool
  • Use a browser to open the root page of the Tomcat web server, i.e. http://localhost
  • Go to the administration tool on the left hand side of the page
    (in the Administration box, click on Tomcat Administration)
  • Log on to the Administration tool using the administrator username and password
    • For Windows, you entered the administration name+password during the Tomcat installation
    • For Linux, you set the administration name+password in step 3.0
 
Step 3.2 SELECT ADMINISTRATION TOOL
Create New Context
Create New Context in the Administration Tool
  • In the administration tool, go to the following page from the dropdown tree
    Tomcat Server > Service (Catalina) > Host (localhost)
  • On the right frame, select Create New Context under Host Actions
  • Create a new context in the next step
 
Step 3.3 CREATE THE GONG CONTEXT
  • Fill the following values in the form
    • Document Base:
      This is the location where you installed the Gong server previously in step 2.1
      For example, if you are installing on Windows: Document Base: C:\Gong
      For example, if you are installing on Linux: Document Base: /usr/local/gong
    • Path: /gong
      (the path of the URL in the web server for the Gong system)
  • Press the Save button to create the context
  • Click on the Commit Changes button at the top and then log out
  • Restart the server
 
Step 3.4 TEST THE NEW CONTEXT
Gong Administration Page
The Gong Administration Page
  • Open any web browser
  • Go to this location
    http://localhost/gong/admin
  • You should be able to see the Administration page of the Gong administration module
 

4. Configure the Gong Server

 
Step 4.1 LOG ON THE GONG ADMINISTRATION MODULE
General Settings in the Gong Administration Page
General Settings in the Gong Admin Page
  • In the log on page use the following information to log on the system
    • Username: admin
    • Password: admin
  • This is the default account, you can change it later if you want
  • After logging on, you should be in the General Settings Page
 
Step 4.2 SET THE WEB LOCATION OF THE GONG SERVER
Advanced Settings in the Gong Administration Page
Advanced Settings in the Gong Admin Page
  • Put in the URL of the Gong system in the Base URL box
  • The value is typically
    http://<ip address of the server>/gong/
    (certainly the ip address varies for different machines)

    Be sure to have the http:// at the beginning and / at the end

  • Click on Save settings to save the value
 
Step 4.3 CONFIGURE THE SERVER INI FILE
  • For people who want more control over the configuration of the server you can go to our Gong server INI file generation page. This page helps you in the configuration of the gongServer.ini file which is located in the Gong server installation directory.
 
Step 4.4 START THE GONG SERVER
The Gong Server
The Gong Server
  • Start the Gong server by
    Start Menu > All Programs > Gong > Gong Server

For people who are installing on a Unix/Linux based system:

A shell script called "startup.sh" is given in the zip file of the Gong server. To start the Gong server you should:

  1. Change the permission of the file so that it can be executed, for example:
    chmod u+rwx startup.sh
  2. Set the JAVA_HOME variable inside the script to the directory where the Java 2 SDK is installed on your machine, for example:
    setenv JAVA_HOME /usr/java
  3. Run the shell script, for example:
    ./startup.sh
 

Congratulations! You have now installed your own copy of the Gong server. From now on you can try to use the applet or application to try it out!

Accessing the Gong Server

A. Try out your Gong system Using the Applet

 
Step A.1 COPY THE GONG JAR FILE
  • Look for the gong.jar file and the recogniser.jar file in the Gong server directory
  • Copy these files to the web location where you want to put the Gong Java applet
 
Step A.2 MAKE AN HTML PAGE FOR THE APPLET
  • Make a web page for the applet, such as
    <html>
    <head> <title>Test page for the Gong applet</title>
    </head>
    <body>
    <applet archive="gong.jar" code="gong.GongApplet" width="800" height="600">
        <param name="Server.Hostname" value="<your host name>" />
    </applet>
    </body>
    </html>
    
  • Put this test page in the same location as the gong.jar and recogniser.jar files
  • You should insert the host name of your Gong server in this line:
    <param name="Server.Hostname" value="<your host name>" />
    For example, if the Gong server is located in www.cse.ust.hk, then the line becomes:
    <param name="Server.Hostname" value="www.cse.ust.hk" />
    However you should not put the path onto this parameter. For example it is not correct to use the following value:
    <param name="Server.Hostname" value="www.cse.ust.hk/gong" />
  • You can put the HTML file, gong.jar and recogniser.jar anywhere you want, all in the same directory. They don't have to go anywhere special. They don't even have to go on the same server/ machine as Gong.
    • For example, if you have a web site http://www.mywebsite.com then you could make a directory with any name (let's say it is called 'gong'), and put the files in there. Then anyone can go to http://www.mywebsite.com/gong/index.html (assume the HTML file is index.html) and see the Gong applet.
 
Step A.3 VERIFY THE GONG APPLET
  • Use any web browser to load the test page, and try out your Gong Java applet
  • (After you have used the web page to test the Gong applet and you are sure everything is OK you can copy the <applet>...</applet> part into any web page, if you want to)
 

B. Try out your Gong system using the Application

 
Step B.1 CREATE GONG INSTALLER
  • You can quickly create a customized version of the Gong installer from this page
  • Simply enter your name, email and your Gong server address and we will create the installer for you
  • Install the application using the installer
  • If the above does not work click here and some alternative steps will be shown
 
Step B.2 EXECUTE THE GONG APPLICATION
The Gong Application
The Gong Application
  • Run the application from:
    Start Menu > All Programs > Gong 5 > Gong 5