findinsite-js installation guide for Sun Java System Application 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.

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 Application 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 Application Server

You might also wish to consider the Sun Java System Web Server (iPlanet).

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

Indexing emails

The default security settings prevent findinsite-js from setting various properties that are required for sending emails.

The server administrator can alter a server's JVM config/server.policy file to enable read and write access to system properties, thereby enabling findinsite-js indexing emails. In the section of this file described as "Basic set of required permissions granted to all remaining code" change the line containing java.util.PropertyPermission to include write permission, ie:

	permission java.util.PropertyPermission "*", "read,write";

findinsite-js Deployment, Configuration and Usage Instructions

Installing findinsite-js

1. Start the Application Server

2. Start the "Admin Console" and login.

3. Open up the server tree using the handle icons and click on Web Apps in the Applications menu.

4. Click on the "Deploy..." button

5. Browse to select findinsitejs.war and click OK

6. Check the form settings; leave the "Web Application Name" and "Context Root" at findinsitejs for now.
   Click OK

findinsite-js URLs

Check the work directory 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.

For Sun Java System Application 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

1. In the findinsite-js installation directory, open the file WEB-INF/web.xml for editing.
2. 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.
3. Restart the main server as follows:
   In the Sun Java System Application Server Admin Console, click on "Stop" and then "Start".

Test Search

1. Browse to the findinsite-js localised search page, eg http://localhost/findinsitejs/search.

2. Enter some search text, eg engine and click on "Search".

3. 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

Test Word highlighting