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.
Since this page was written, this server software has been renamed Sun GlassFish Enterprise Server.
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
Sun Java System Application Server
The Sun Java System Application Server has a built-in Java servlet engine.
It is available for several platforms from
It supports the servlet specification JSDK 2.4.
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.
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
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";
If you cannot or do not wish to alter this file then findinsite-js cannot send emails.
findinsite-js Deployment, Configuration and Usage Instructions
These instructions are for Sun ONE Application Server 7.0.
Installing the findinsite-js web application
findinsitejs.war is usually called
- Start the Application Server
- Start the "Admin Console" and login.
- Open up the server tree using the handle icons and click on Web Apps in the Applications menu.
- Click on the "Deploy..." button
- Browse to select findinsitejs.war and click OK
- Check the form settings; leave the "Web Application Name" and "Context Root" at
findinsitejs for now.
The following URLs should now be available
(assuming that you set the Application Name to
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
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
- 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 Sun Java System Application Server Admin Console,
click on "Stop" and then "Start".
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+.