Spy-Server Installation Guide for Macromedia JRun

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.

Page contents JRun introduction Setting up... Install Spy-Server Spy-Server URLs Work directory Run test searches Index your own site Word highlighting Configuration Init parameters Log files Updating Spy-Server Uninstalling Spy-Server

Macromedia JRun

Macromedia (formerly Allaire) JRun is a Java servlet engine, available for several platforms from www.macromedia.com. It supports the servlet specification JSDK 2.2.

JRun can be connected to several types of main server. JRun includes a servlet web server so it does not need to be connected to a web server when testing.

JRun has a "JRun Management Console" browser interface which makes it fairly easy to deploy Spy-Server.

JRun installation

By default, Macromedia JRun installs two servlet web servers, a JRun Admin Server and a JRun Default Server.  Each of these servers needs a separate port.

The Admin server should be only used by the "JRun Management Console" and should not be connected to your main web server.

Connect the Default server to your main web server using the Connector Wizard in the "JRun Management Console".  This automates most of the connection tasks; however for at least one server type, the Microsoft IIS server, we found that we needed to consult the documentation for the final connection steps.

You should deploy the Spy-Server Web Application in the Default server.

Spy-Server Deployment, Configuration and Usage Instructions

Note that JRun 3.1 must be connected to the public internet when you deploy Spy-Server so that the Sun web application definition web site can be accessed. Thereafter, this public internet web site also needs to be accessible when JRun restarts with Spy-Server deployed.

Installing Spy-Server

1. Start the JRun Admin and Default servers.

2. Start the "JRun Management Console" and login.

3. In the navigation panel, expand the relevant server, eg "JRun Default Server" and click on "Web Applications"

4. Click on "Deploy an Application" in the main screen.

5. Fill in the form as follows:

   Servlet War File or Directory:	Browse to select SpySrv50.war
   JRun Server Name:	Select one, eg JRun Default Server
   Application Name:	Eg Spy-Server
   Application Host:
   Application URL:	Eg /spy
   Application Deploy Directory:
   Click Deploy

6. In the navigation panel, click on the relevant server, eg "JRun Default Server".
   Click on "Restart Server".

Spy-Server URLs

The following URLs should now be available (assuming that the Apache server is running on the default web server port of 80, and the JRun Application Root is /spy):

Spy-Server welcome page	http://localhost/spy/
Spy-Server documentation	http://localhost/spy/doc/
Spy-Server search page	http://localhost/spy/search
Spy-Server configuration screen	http://localhost/spy/search?config=now

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

Changing init parameters

1. Start the "JRun Management Console" and login.
2. In the navigation panel, expand the relevant server, eg "JRun Default Server" and click on "Web Applications"
3. Select "Spy-Server" then "Application Variables"
4. Add a suitably named init parameter, eg work, and give the required value.
5. Click on "Update"
6. Restart the Default Server

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/spy/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

Test Word highlighting

Additional JRun Instructions

Updating Spy-Server

Note that you will probably need to reset the Spy-Server work init parameter to your chosen directory, as described above.

Uninstalling Spy-Server

1. Start the "JRun Management Console" and login.
2. In the navigation panel, expand the relevant server, eg "JRun Default Server" and click on "Web Applications"
3. Click on "Remove an Application" in the main window
4. Select "Spy-Server" and click on "remove"
5. Restart the JRun Default Server