findinsite-js installation guide for Apache JServ

This page is for information purposes only. It is not a recommendation to use this Java servlet engine or application server. Please consult the supplier's documentation for full installation information and details of how to deploy and configure servlets such as findinsite-js.

Introduction

findinsite-js is a Java servlet. It is a program that must be run by a Java servlet engine on a web server, with its output viewed in a browser.

Java application servers usually have built-in support for Java servlets.
Alternatively, a Java servlet engine can be installed and connected up to an existing server.

Please refer to these pages for more information:

Servers page for details of application servers and servlet engines.
Installation guide for application servers and servlet engines.
Deployment overview for findinsite-js.

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

Page contents
JServ introduction
Setting up...

Install findinsite-js

findinsite-js URLs

Work directory

Run test searches

Index your own site

Word highlighting

Apache JServ

Apache JServ is an ancient, free servlet engine for use only with the Apache server on many platforms - available from archive.apache.org. It only supports the older servlet specification JSDK 2.0. All new Apache effort is in the Tomcat software.

JServ is fairly hard to install, and the installation and the deployment of servlets is similarly hard because configuration text files must be edited by hand.

findinsite-js Deployment, Configuration and Usage Instructions

JServ must be correctly connected to the main Apache server for the following steps to work.

Deployment

To add findinsite-js to the "root" zone:

Copy the findinsite-js binary files (see list here) to the JServ servlets sub-directory.

Edit file zone.properties in the JServ servlets sub-directory.
Add these four lines at the appropriate points in this file:

repositories=<JSERV_PATH> repositories=<JSERV_PATH>/servlets/findinsitejs.jar servlet.findinsitejs.code=com.phdcc.servlet.fisServer

servlet.findinsitejs.initArgs= work=D:/FindData, index=/fisjsdb, baseurl=/fisjs/doc/, target=_self, password=null, rules=/rulesen.txt, logging=true, heading=/findhead.htt, top=/findtop.htt, line=/findline.htt, bot=/findbot.htt, footer=/findfoot.htt

In the first two lines, <JSERV_PATH> must be replaced with the JServ installation directory, eg for Windows these lines might be
repositories=D:\JServ\servlets
repositories=D:\JServ\servlets\findinsitejs.jar
In Windows do not replace / characters with \ in the other lines.

The work init parameter must be set to a valid directory, initially empty of files.

Unzip the findinsite-js Web application findinsitejs.war in a temporary directory.
Copy fisjsdb.* from the temporary directory to the JServ servlets sub-directory.
Make a sub-directory for the findinsite-js (eg fisjs) in the Apache htdocs directory. Make a further doc sub-directory, eg htdocs/fisjs/doc/. If you use different directory names, change the third line in the zone.properties file so that the baseurl initArg uses your directory.
Copy index.html and logoFindJS.jpg from the temporary directory to your Apache sub-directory, eg htdocs/fisjs/.
Copy doc/*.* from the temporary directory to your Apache doc sub-directory, eg htdocs/fisjs/doc/.
Delete the temporary directory and all its files.
Restart the Apache server

findinsite-js URLs

The following URLs should now be available (assuming that Apache is running on the default web server port of 80, and the Apache sub-directory used for findinsite-js is /fisjs):

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

Check the work directory location

Before you start testing findinsite-js, it is important to check that the findinsite-js work directory is in a suitable location.

findinsite-js uses a work directory to store all its configuration information and search database files. It is important that this directory is secure from unwanted direct access, while still being available to findinsite-js. It is also a good idea to make sure that this directory is not wiped accidentally, eg if you update the findinsite-js runtime to a newer version. Finally, it is also a good idea to backup the contents of the findinsite-js work directory regularly.

If you need to change the work directory, set the work init parameter as described above.

Test Search Preamble

You will need to make the following changes to make findinsite-js display its results correctly for the findinsite-js documentation.

Go to the findinsite-js configuration screen Searching section, eg http://localhost/servlets/findinsitejs?config=now. Change the Additional Base URL to /fisjs/doc/ Then press the "Make Changes" button.

Test Search

Check that you can search the findinsite-js documentation correctly, as follows:

Browse to the findinsite-js localised search page, eg http://localhost/servlets/findinsitejs.
Enter some search text, eg engine and click on "Search".
The first 10 hits are displayed. Click on a hit and check that the result page is displayed correctly in the browser.
If the hit page is not shown correctly, then you probably need to alter the Additional Base URL setting in the configuration screen Searching section.

Index your own site

Follow the general Getting Started instructions to index your own site to build a search database and start searching.

Test Word highlighting

See the Word highlighting instructions for details of how to set this up for HTML pages shown in Internet Explorer 4+.