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.
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.
Please refer to these pages for more information:
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.
- Java application servers usually have built-in support for Java servlets.
- Alternatively, a Java servlet engine can be installed and connected up to an
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.
To add findinsite-js to the "root" zone:
- Copy the findinsite-js binary files (see list here) to the JServ
- Edit file
zone.properties in the JServ
Add these four lines at the appropriate points in this file:
baseurl=/fisjs/doc/, target=_self, password=null,
In the first two lines, <JSERV_PATH> must be replaced with the JServ installation directory,
eg for Windows these lines might be
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.
fisjsdb.* from the temporary directory to the JServ
- Make a sub-directory for the findinsite-js (eg
fisjs) in the Apache
Make a further
doc sub-directory, eg
If you use different directory names, change the third line in the
file so that the
baseurl initArg uses your directory.
logoFindJS.jpg from the temporary directory
to your Apache sub-directory, eg
doc/*.* from the temporary directory
to your Apache doc sub-directory, eg
- Delete the temporary directory and all its files.
- Restart the Apache server
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
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
Change the Additional Base URL to /fisjs/doc/
Then press the "Make Changes" button.
Check that you can search the findinsite-js documentation correctly, as follows:
- Browse to the findinsite-js localised search page, eg
- 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+.