Ozibug Install Guide

Ozibug is a 2.2 servlet compliant web application which is packaged as a web archive (war) file and distributed with its documentation. For ease of download the distribution is named ozibug-x.x.x.zip where x.x.x reflects the current version number. The following sections outline the installation procedure in a few selected, tested, servlet containers.

Ozibug requires a SAX XML parser which is supplied by most servlet containers. If your servlet container doesn't contain or export one for use by its clients, then you'll need to download one and install it in the OZIBUG_HOME/WEB-INF/lib directory. The most commonly used xml processing library is xerces.jar and is available from the Apache XML Project.

Container specific installation instructions are available for the following servlet containers that Ozibug has been installed and tested in.

Tomcat 3
Tomcat 4
Orion 1.5.2 & 2.0.2
BEA WebLogic 6.0 & 8.1
JBoss 2.4.3 & 3.x
Oracle 9ias OC4J
Jetty 4.2.14
WebSphere 4.0
Sun ONE iPlanet 6

Back to index

All Tomcat 3.x releases trace their heritage back to the original Servlet and JSP implementations that Sun donated to the Apache Software Foundation. This version supports the 2.2 servlet specification. Its website can be found at http://jakarta.apache.org/tomcat/tomcat-3.2-doc/index.html while the binary can be downloaded from the directory http://jakarta.apache.org/site/binindex.cgi (the distribution files are jakarta-tomcat-3.2.4.tar.gz or jakarta-tomcat-3.2.4.zip)

Install tomcat according to the standard instructions. The home directory where the distribution is unpacked is known as TOMCAT_HOME.
Make a directory called ozibug underneath the TOMCAT_HOME/webapps directory. We will refer to this directory as OZIBUG_HOME from now on.
Use an unzip program to unpack the ozibug.war file into the OZIBUG_HOME directory.
Copy the license file License.ser (which you need to request to be mailed to you after registering) into the OZIBUG_HOME/WEB-INF directory.
Examine the properties defined in the OZIBUG_HOME/WEB-INF/ozibug.properties file and make any necessary changes. These are documented in the file itself - please refer to this.
You are now ready to run. Start the tomcat servlet container and point your browser at the Ozibug. The following lines show how to do this on a Win32 platform.
```
C:\> set JAVA_HOME=C:\jdk-1.3.1
C:\> set TOMCAT_HOME=C:\jakarta-tomcat-3.2.4
C:\> cd %TOMCAT_HOME%\bin
C:\> tomcat start
                            
```
The URL will be similar to the following http://host:port/ozibug/index.html where host is the hostname that you are running on and port is the port number (this is 8080 by default.)

This version of the popular open source servlet container supports the 2.3 servlet specification. Its website can be found at http://jakarta.apache.org/tomcat/tomcat-4.0-doc/index.html while the binary can be downloaded from the directory http://jakarta.apache.org/site/binindex.cgi (the distribution files are jakarta-tomcat-4.x.x.tar.gz or jakarta-tomcat-4.x.x.zip)

Install tomcat according to the standard instructions. The home directory where the distribution is unpacked is known as CATALINA_HOME.
Make a directory called ozibug underneath the CATALINA_HOME/webapps directory. We will refer to this directory as OZIBUG_HOME from now on.
Use an unzip program to unpack the ozibug.war file into the OZIBUG_HOME directory.
Copy the license file License.ser (which you need to request to be mailed to you after registering) into the OZIBUG_HOME/WEB-INF directory.
Examine the properties defined in the OZIBUG_HOME/WEB-INF/ozibug.properties file and make any necessary changes. These are documented in the file itself - please refer to this.
You are now ready to run. Start the tomcat servlet container and point your browser at the Ozibug. The following lines show how to do this on a Unix platform (using a Bourne shell.)
```
$ CATALINA_HOME="/opt/pkg/jakarta-tomcat-4.0.3"
$ JAVA_HOME="/opt/pkg/jdk-1.3.1"
$ PATH="${CATALINA_HOME}/bin:${JAVA_HOME}/bin:${PATH}";
$ export CATALINA_HOME JAVA_HOME PATH
$ catalina.sh start
                            
```
The URL will be similar to the following http://host:port/ozibug/index.html where host is the hostname that you are running on and port is the port number (this is 8080 by default.)

This is a full featured java based application server, further information (including all the documentation) on this product can be found at the following URL http://www.orionserver.com/.

Install orion according to the standard instructions. This should install into a directory similar to C:\orion (Win32 platform) and we will refer to this as ORION_HOME.
Make a directory called ozibug underneath the ORION_HOME directory. This will have the following path ORION_HOME\ozibug and we will refer to this directory as OZIBUG_HOME from now on.
Use an unzip program to unpack the ozibug.war file into the OZIBUG_HOME directory.
Ensure that orion is not running, edit the file ORION_HOME\config\application.xml and add the following descriptor within the <orion-application> element.
```
<web-module id="ozibug" path="../ozibug" />
                            
```
Edit the file ORION_HOME\config\default-web-site.xml (or ORION_HOME\config\http-web-site.xml for OC4J) and add the following descriptor within the <web-site> element.
```
<web-app load-on-startup="true"
         application="default" name="ozibug" root="/ozibug" />
                            
```
Copy the license file License.ser (which you need to request to be mailed to you after registering) into the OZIBUG_HOME/WEB-INF directory.
Examine the properties defined in the OZIBUG_HOME/WEB-INF/ozibug.properties file and make any necessary changes. These are documented in the file itself - please refer to this.
You are now ready to run. Start the application server according to the orion instructions and point your browser at the Ozibug. The URL will be similar to the following http://host/ozibug/index.html where host is the hostname that you are running on. The port number is 80 by default on Orion but you can change this to whatever you require.

WebLogic is a full blown application server (which includes a servlet container) and is marketed and sold by BEA. More information on this application server can be found at BEA's website located at the following URL http://www.bea.com/index.shtml. Use the following instructions to install Ozibug.

Install WebLogic according to the standard instructions. You should now have a directory structure that looks something similar to the following (Win32 platform) C:\bea\wlserver6.0\config\domain (6.0) or C:\bea\user_projects\domain (8.1) where domain is the name of the domain you entered when asked by the installation program. We will refer to this directory as WL_HOME from now on.
Make a directory called static underneath the domain directory and also a directory called ozibug underneath that. This will have the following path WL_HOME\static\ozibug and we will refer to this directory as OZIBUG_HOME from now on.
Use an unzip program to unpack the ozibug.war file into the OZIBUG_HOME directory.
Ensure that WebLogic is not running, edit the file WL_HOME\config.xml and add the following descriptor within the <Domain> element.
```
WebLogic 6.0
<Application Deployed="true"
             Name="ozibug"
             Path=".\config\domain\static">
 <WebAppComponent Name="ozibug"
                  Targets="server_name"
                  URI="ozibug"/>
</Application>
                            
```
```
WebLogic 8.1
<Application Name="ozibug"
             Path="static" 
             StagingMode="nostage" 
             TwoPhase="true">
 <WebAppComponent Name="ozibug"
                  Targets="server_name"
                  URI="ozibug"/>
</Application>
                            
```
Note that domain is the name of the domain you entered when asked by the installation program and server_name is the name of the server you entered.

By default WebLogic does not expand war files which is a requirement of Ozibug. Due to (buggy) behaviour of WebLogic (6.0 anyway), even dynamically deployed expanded applications are war'd up behind the scenes on startup. The only way to avoid this is to do a static deployment as described above.
Copy the license file License.ser (which you need to request to be mailed to you after registering) into the OZIBUG_HOME/WEB-INF directory.
Examine the properties defined in the OZIBUG_HOME/WEB-INF/ozibug.properties file and make any necessary changes. These are documented in the file itself - please refer to this.
You are now ready to run. Start the application server according to the BEA instructions and point your browser at the Ozibug. The URL will be similar to the following http://host:port/ozibug/index.html where host is the hostname that you are running on and port is the port number (this is 7001 by default on WebLogic.)

This is the popular open source J2EE application server. Detailed information on this product can be found at the following URL http://www.jboss.org/. JBoss 3.x now includes Tomcat as the default servlet container whereas earlier versions provided integration with either the Tomcat or Jetty servlet containers. Downloads are available from http://www.jboss.org/downloads/.

Install JBoss according to the standard instructions. The home directory where the distribution is unpacked is known as JBOSS_DIST.
Make a directory called ozibug.war underneath the JBOSS_DIST/jboss/deploy (2.4.3) or JBOSS_DIST/server/default/deploy (3.x) directory. We will refer to this directory as OZIBUG_HOME from now on.
Use an unzip program to unpack the ozibug.war file into the OZIBUG_HOME directory.
Copy the license file License.ser (which you need to request to be mailed to you after registering) into the OZIBUG_HOME/WEB-INF directory.
Examine the properties defined in the OZIBUG_HOME/WEB-INF/ozibug.properties file and make any necessary changes. These are documented in the file itself - please refer to this.

You are now ready to run. Start the JBoss server and point your browser at the Ozibug. The following lines show how to do this on a Unix platform (using a Bourne shell.)

JBoss 2.4.3
$ JBOSS_HOME="/opt/pkg/JBoss-2.4.3_Tomcat-3.2.3/jboss"
$ JAVA_HOME="/opt/pkg/jdk-1.3.1"
$ PATH="${JBOSS_HOME}/bin:${JAVA_HOME}/bin:${PATH}";
$ export JBOSS_HOME JAVA_HOME PATH
$ run_with_tomcat.sh

JBoss 3.x
$ JBOSS_HOME="/opt/pkg/jboss-3.0.0"
$ JAVA_HOME="/opt/pkg/jdk-1.3.1"
$ PATH="${JBOSS_HOME}/bin:${JAVA_HOME}/bin:${PATH}";
$ export JBOSS_HOME JAVA_HOME PATH
$ run.sh

The URL will be similar to the following http://host:port/ozibug/index.html where host is the hostname that you are running on and port is the port number (this is 8080 by default.)

This is the application server offering from Oracle, which is based on a rebadged Orion server. Further information on this product can be found at the following URL
http://www.oracle.com/appserver/index.html?content.html.

Install oc4j according to the standard instructions. This should install into a directory similar to C:\oc4j-9.0.2 (Win32 platform) with the application server component installing into C:\oc4j-9.0.2\j2ee\home, we will refer to this as ORION_HOME.
Complete the remainder of the installation as per the Orion installation.

Jetty is a 100% Java HTTP Server and Servlet Container. Detailed information on this product can be found at the following URL http://jetty.mortbay.org. Downloads are available from http://jetty.mortbay.org/jetty/download.html.

Install Jetty according to the standard instructions. The home directory where the distribution is unpacked is known as JETTY_HOME.
Make a directory called ozibug.war underneath the JETTY_HOME/webapps directory. We will refer to this directory as OZIBUG_HOME from now on.
Use an unzip program to unpack the ozibug.war file into the OZIBUG_HOME directory.
Copy the license file License.ser (which you need to request to be mailed to you after registering) into the OZIBUG_HOME/WEB-INF directory.
Examine the properties defined in the OZIBUG_HOME/WEB-INF/ozibug.properties file and make any necessary changes. These are documented in the file itself - please refer to this.
You are now ready to run. Start the Jetty server and point your browser at the Ozibug. The following lines show how to do this on a Unix platform (using a Bourne shell.)
```
$ JETTY_HOME="/opt/pkg/jetty"
$ JAVA_HOME="/opt/pkg/jdk-1.3.1"
$ PATH="${JETTY_HOME}/bin:${JAVA_HOME}/bin:${PATH}";
$ export JETTY_HOME JAVA_HOME PATH
$ jetty.sh start
                            
```
The URL will be similar to the following http://host:port/ozibug/index.html where host is the hostname that you are running on and port is the port number (this is 8080 by default.)

This is the application server from IBM, this seems to come in many different flavours, the one being described here is the advanced single server edition. Further information (including all the documentation) on this product can be found at the following URL
http://www-4.ibm.com/software/webservers/appserv/infocenter.html.

Install WebSphere according to the standard instructions. This should install into a directory similar to C:\WebSphere\AppServer (Win32 platform) and we will refer to this as WEBSPHERE_HOME.
You must update the character set encoding properties file to contain the correct character set for the locale you intend to use. Edit the file WEBSPHERE_HOME/properties/encoding.properties and change the character set for your locale to UTF-8. The following section shows the corrected character encodings for the three supported Ozibug locales.
```
#en=ISO-8859-1
#es=ISO-8859-1
#ja=Shift_JIS
en=UTF-8
es=UTF-8
ja=UTF-8
                            
```
Copy the ozibug.war file to the directory WEBSPHERE_HOME/installableApps directory.
Using the Administrator's Console login and select the Nodes -> SERVER_NAME -> Enterprise Applications option from the menu on the left of the form. Where SERVER_NAME is the node name of your computer. Then select the install button from the right hand side row of buttons.

Two forms are displayed - in the top form the first field is Path - use the browse button select the ozibug.war file that was copied to the WEBSPHERE_HOME/installableApps directory in a previous step. The second field is the application name, this can be Ozibug. The third field is the servlet context, this should be /ozibug.

Select the next button and a new form is displayed, simply select next to go to the next screen. This displays the options that you have just entered, select finish to install Ozibug !

The Ozibug application gets installed in the directory WEBSPHERE_HOME\installedApps\Ozibug.ear\ozibug.war which we will refer to as OZIBUG_HOME from now on.
Copy the license file License.ser (which you need to request to be mailed to you after registering) into the OZIBUG_HOME\WEB-INF directory.
Examine the properties defined in the OZIBUG_HOME/WEB-INF/ozibug.properties file and make any necessary changes. These are documented in the file itself - please refer to this.
You are now ready to run. Stop and restart the application server, when it restarts the Ozibug application will be started. You must stop and restart to start Ozibug !

You can now point your browser at the Ozibug. The URL will be similar to the following http://host[:port]/ozibug/index.html where host is the hostname that you are running on. It seems several ports (80 and 9080) are active by default on WebSphere - this is configurable and you can change this through the Administrator's Console.

This is the application server offering from the Netscape/Sun spinoff company iPlanet. Detailed information (including all the documentation) on this product can be found at the following URL http://www.iPlanet.com/.

Install iPlanet according to the standard instructions. This should install into a directory similar to C:\iPlanet\Servers (Win32 platform) and we will refer to this as IWS_SERVER_HOME.
Make a directory called static underneath the IWS_SERVER_HOME directory and also a directory called ozibug underneath that. This will have the following path \iPlanet\Servers\static\ozibug and we will refer to this directory as OZIBUG_HOME from now on.
Use an unzip program to unpack the ozibug.war file into the OZIBUG_HOME directory.
Ensure that iPlanet is not running, edit the file C:\iPlanet\Servers\https-server_name\config\web-apps.xml and add the following descriptor within the <vs> element.
```
<web-app uri="/ozibug"
        dir="/iPlanet/Servers/static/ozibug"
        enable="true" />
                            
```
Copy the license file License.ser (which you need to request to be mailed to you after registering) into the OZIBUG_HOME/WEB-INF directory.
Examine the properties defined in the OZIBUG_HOME/WEB-INF/ozibug.properties file and make any necessary changes. These are documented in the file itself - please refer to this.

NOTE: you will need to set the log file properties when running under this application server as the console trace seems to get lost !
You are now ready to run. Start the application server according to the iPlanet instructions and point your browser at the Ozibug. The URL will be similar to the following http://host/ozibug/index.html where host is the hostname that you are running on. The port number is 80 by default on iPlanet but you can change this to whatever you require.

Back to index

Back to Ozibug home