findinsite-js installation guide for Sun Java System Web Server

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.

Since this page was written, this server software is now available here, supporting JSDK 2.5.

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
Web Server introduction
Setting up...

Install findinsite-js

findinsite-js URLs

Work directory

Run test searches

Index your own site

Word highlighting
Configuration

Init parameters

Sun Java System Web Server

The Sun Java System Web Server (formerly iPlanet) has a built-in Java servlet engine. It is available for several platforms from www.sun.com/software/products. It supports the servlet specification JSDK 2.3.

You might also wish to consider the Sun Java System Application Server.

The Sun Java System Web Server has an "Administer Web Server" browser interface which makes it easy to deploy findinsite-js.

findinsite-js Deployment, Configuration and Usage Instructions

These instructions are for Sun ONE Web Server 6.0 SP5.

Installing findinsite-js

Installing the findinsite-js web application findinsitejs.war is usually called deployment.

Start the iWS Administration Server
Select "Administer Web Server" and login to the Web Server Administration Server user interface.
Select a server and click on "Manage"
Click on the "Class Manager" link in the top right of the screen
Select a virtual server and click on "Manage"
Click on the "Web Applications" tab
Click on the "Deploy Web Application" link on the left

Fill in the form as follows:

WAR file on:	Select "Local Machine"
WAR File Path:	Browse to select findinsitejs.war
Application URI:	Eg /fisjs
Installation Directory:	Enter a suitable absolute local path
Click OK

The main server must be restarted to activate findinsite-js:
Click on the "https-server" button at the top left of the screen. Click on "Server Off" then "Server On".

findinsite-js URLs

The following URLs should now be available (assuming that you set the Application URI to /fisjs):

findinsite-js welcome page	http://localhost/fisjs/
findinsite-js documentation	http://localhost/fisjs/doc/
findinsite-js search page	http://localhost/fisjs/search
findinsite-js configuration screen	http://localhost/fisjs/search?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.

findinsite-js makes a directory called FindData when it starts. If this is not suitable then you need to change the work init parameter.

For Sun Java System Web Server, the FindData directory will usually be visible to browsers if you leave it in its default location. So it is recommended that you change the work directory as follows:

Changing init parameters

In the findinsite-js installation directory, open the file WEB-INF/web.xml for editing.
Find the init parameter name (eg "work") in param-name tags and enter your chosen value in between the following <param-value> and </param-value> tags. Save the file.
Restart the main server as follows:
In the Web Server Administration Server user interface, click on "Server Off" then "Server On".

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/fisjs/search.
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+.