findinsite-js installation overview

Please consult our Getting Started Guide for an overview of how to get findinsite-js, set up your server, install and configure findinsite-js.  Get the findinsite-js software from the Download page.

This Installation Guide describes how to install and start findinsite-js in typical servlet engines. See these pages for detailed deployment instructions for these types of servlet engine.

• Apache JServ
• Apache Tomcat
• BEA WebLogic Server
• Borland Enterprise Server Web, VisiBroker and AppServer editions
• IBM WebSphere
• Macromedia JRun
• Sun Java System Web Server
• Sun Java System Application Server

If you have any questions on servlet installation or findinsite-js installation, please contact sales/support.

findinsite-js Installation

There are typically two ways to install findinsite-js in your servlet engine

• Install the findinsite-js Web Application archive (WAR) file - easier.
• Install findinsite-js by hand - harder

If you run more than one instance of findinsite-js on the same server, then you will probably need to turn off results caching by disabling CacheResults in the online configuration screen or as an init parameter.

Web Application Installation

A Web Application is a WAR file that contains the servlet binaries and all the required initialisation information.  A WAR file is a ZIP archive with particular files enclosed.

The findinsite-js WAR file is called findinsitejs.war.  You can get the latest version online at www.phdcc.com/download/findinsitejs.war.

The findinsite-js WAR contains:

• findinsite-js binaries
• findinsite-js servlet definition
• findinsite-js default initialisation parameters
• findinsite-js documentation
• findinsite-js search database for documentation

Once the findinsite-js WAR is installed correctly, the findinsite-js servlet will search the supplied documentation using the search database.  Later on, you can reconfigure findinsite-js so that it searches your web site.

Web Application installation instructions differ for each servlet engine.

• In Apache Tomcat, simply put findinsitejs.war in the Tomcat webapps sub-directory.  When Tomcat restarts, the WAR file is installed with context path /findinsite, which corresponds to sub-directory webapps/findinsitejs.  You can change the context path by renaming the directory and restarting.
• In IBM WebSphere, you install a WAR file by clicking on "Install" in the "Enterprise Applications" section of the "Administrative Console". You can choose the context path - try /findinsite
• In BEA WebLogic Server, you install a WAR file by clicking on "Web Applications" and then "Configure a new Web Application...".
• In Borland Enterprise Server, you install a WAR file by starting the "Borland Management Console" and selecting menu "Wizards+Deployment wizard".
• In Macromedia JRun, you install a WAR file by clicking on "Deploy an Application" in the "JRun Management Console" in the "Web Applications" section of a server.  You can choose the context path - try /findinsite
• In Sun Java System Web Server, you install a WAR file by clicking on "Deploy Web Application" in the Web Server Administration Server user interface.
• In Sun Java System Application Server, you install a WAR file by clicking on "Deploy..." in the Admin Console tree "Web Apps" folder.

Once the findinsite-js WAR is installed on your local computer, you should be able to see findinsite-js running.  If your servlet engine is at port 8111 and the context path is /findinsite, then these URLs should be available:

findinsite-js welcome page	http://localhost:8111/findinsite/
findinsite-js documentation	http://localhost:8111/findinsite/doc/
findinsite-js search page	http://localhost:8111/findinsite/search
findinsite-js configuration screen	http://localhost:8111/findinsite/search?config=now

Please see the Servlet Engine Installation Guide for possible alternatives to the above URLs.

Some configuration changes might be required for some servlet engines after installation. In particular, it is possible that the Base URL will need changing in the findinsite-js Configuration screen General section.

web.xml header

The findinsite-js Web Application WAR file contains a file called web.xml in the WEB-INF subdirectory that defines various aspects of the findinsite-js running environment (including the init parameters).

In some cases, you may want to remove the following header from the start of web.xml because the servlet engine is not permanently connected online.

<!DOCTYPE web-app
    PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.2//EN"
    "http://java.sun.com/j2ee/dtds/web-app_2_2.dtd">

Some servers such as Tomcat 4 need this header to be present. Tomcat 4 does not seem to complain if the referenced DTD is not available.

Installing findinsite-js by hand

On older servlet engines such as Apache JServ you have to install findinsite-js by hand.  Obviously instructions will vary for each servlet engine, but the following steps are usually required:

1. Unzip findinsitejs.war in a clean temporary directory.
2. Make a new sub-directory for findinsite-js in the servlet engine directory.
3. Copy these runtime files to the findinsite-js servlet directory:

   WEB-INF/lib/findinsitejs.jar	findinsite-js executable binary classes
   findhead.htt	Results heading definition
   findtop.htt	Results top definition
   findline.htt	Results line definition
   findbot.htt	Results bottom definition
   findfoot.htt	Results footer definition
   rulesen.txt	English word stemming and synonym rules
   rulesde.txt	German word stemming and synonym rules
   rulesfr.txt	French word stemming and synonym rules

4. Define findinsite-js as a servlet called findinsite.
5. Define initialisation parameters for the findinsite servlet.
6. Add findinsitejs.jar to the Java CLASSPATH.
7. if required, copy in the findinsite-js search database and documentation.