findinsite-js installation overview
findinsite-js is a Java servlet. It is a program that must be run in a server that supports Java servlets.
If necessary, install a servlet engine and connect it up to your
Please refer to our servers page for details of servers
and servlet engines. Then consult the servlet engine installation guide.
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.
If you have any questions on servlet installation or findinsite-js installation,
please contact sales/support.
There are typically two ways to install findinsite-js in your servlet engine
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.
- Install the findinsite-js Web Application archive (WAR) file - easier.
- Install findinsite-js by hand - harder
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
You can get the latest version online at www.phdcc.com/download/findinsitejs.war.
The findinsite-js WAR contains:
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.
- findinsite-js binaries
- findinsite-js servlet definition
- findinsite-js default initialisation parameters
- findinsite-js documentation
- findinsite-js search database for documentation
Web Application installation instructions differ for each servlet engine.
- In Apache Tomcat, simply put
findinsitejs.war in the Tomcat
sub-directory. When Tomcat restarts, the WAR file is installed with context path
/findinsite, which corresponds to sub-directory
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
- 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
- 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
- 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
If your servlet engine is at port 8111 and the context path is
/findinsite, then these URLs should be available:
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.
The findinsite-js Web Application WAR file contains a file called
web.xml in the
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.
PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.2//EN"
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
findinsitejs.war in a clean temporary directory.
- Make a new sub-directory for findinsite-js in the servlet engine directory.
- 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|
- Define findinsite-js as a servlet called
- Define initialisation parameters for the
findinsitejs.jar to the Java CLASSPATH.
- if required, copy in the findinsite-js search database and documentation.