|
Home
Installation
Indexing
Configuration
Purchasing
|
|
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 Spy-Server.
Introduction
Spy-Server 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 Spy-Server.
Please consult our Getting Started Guide for an overview
of how to obtain Spy-Server, set up your server, install and configure Spy-Server.
Get the Spy-Server software from the Download page.
|
|
Apache JServ
Apache JServ is a free servlet engine for use only with the Apache server
on many platforms -
available from java.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 need edited by hand.
Spy-Server Deployment and Configuration Instructions
JServ must be correctly connected to the main Apache server for the following steps to work.
Deployment
To add Spy-Server to the "root" zone:
- Copy the Spy-Server 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/SpySrv50.jar
servlet.SpyServer.code=com.phdcc.servlet.SpyServer
servlet.SpyServer.initArgs=
|
work=D:/SpyData, index=/SpySrvDb,
baseurl=/spy/doc/, target=_self, password=null,
rules=/rulesen.txt, logging=true,
heading=/spyhead.htt, top=/spytop.htt,
line=/spyline.htt, bot=/spybot.htt,
footer=/spyfoot.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\SpySrv50.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 Spy-Server Web application
SpySrv50.war in a temporary directory.
- Copy
SpySrvDb.* from the temporary directory to the JServ servlets sub-directory.
- Make a sub-directory for the Spy-Server (eg
spy) in the Apache htdocs directory.
Make a further doc sub-directory, eg htdocs/spy/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 spyserve.gif from the temporary directory
to your Apache sub-directory, eg htdocs/spy.
- Copy
doc/*.* from the temporary directory
to your Apache doc sub-directory, eg htdocs/spy/doc.
- Delete the temporary directory and all its files.
- Restart the Apache server
Spy-Server 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 Spy-Server is /spy):
Check the work directory location
Before you start testing Spy-Server, it is important to check that the
Spy-Server work directory is in a suitable location.
Spy-Server 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 Spy-Server.
It is also a good idea to make sure that this directory is not wiped accidentally,
eg if you update the Spy-Server runtime to a newer version.
Finally, it is also a good idea to backup the contents of the Spy-Server 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 Spy-Server display its results correctly
for the Spy-Server documentation.
Go to the Spy-Server configuration screen Searching section, eg
http://localhost/servlets/SpyServer?config=now.
Change the Additional Base URL to /spy/doc/
Then press the "Make Changes" button.
Test Search
Check that you can search the Spy-Server documentation correctly, as follows:
Browse to the Spy-Server localised search page, eg
http://localhost/servlets/SpyServer.
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+.
|
