Spy-Server Installation Guide for Sun ONE Web Server 6 (iPlanet)

Last modified: 21 March 2003.
  • 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.

  • Page contents
  • iPlanet introduction
  • Setting up...
    Install Spy-Server
    Spy-Server URLs
    Work directory
    Run test searches
    Index your own site
    Word highlighting
  • Configuration Init parameters

  • Sun ONE Web Server 6 (iPlanet)

    The Sun ONE Web Server 6 (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.2.

    You might also wish to consider the Sun ONE Application Server 7, Platform Edition.

    The Sun ONE Web Server has an "Administer Web Server" browser interface which makes it easy to deploy Spy-Server.


    Spy-Server Deployment, Configuration and Usage Instructions

    These instructions are for Sun ONE Web Server 6.0 SP5.


    Installing Spy-Server

    Installing the Spy-Server web application SpySrv50.war is usually called deployment.
    1. Start the iWS Administration Server

    2. Select "Administer Web Server" and login to the iPlanet Web Server Administration Server user interface.

    3. Select a server and click on "Manage"

    4. Click on the "Class Manager" link in the top right of the screen

    5. Select a virtual server and click on "Manage"

    6. Click on the "Web Applications" tab

    7. Click on the "Deploy Web Application" link on the left

    8. Fill in the form as follows:
      WAR file on:Select "Local Machine"
      WAR File Path:Browse to select SpySrv50.war
      Application URI:Eg /spy
      Installation Directory:Enter a suitable absolute local path
      Click OK

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

    Spy-Server URLs

    The following URLs should now be available (assuming that you set the Application URI to /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

    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.
    Spy-Server makes a directory called SpyData when it starts. If this is not suitable then you need to change the work init parameter.

    For Sun ONE Web Server 6, the SpyData 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 Spy-Server 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 iPlanet Web Server Administration Server user interface, click on "Server Off" then "Server On".


    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

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

    Spy-Server online
    Find in Site search engines for MS-servers, Java-servers and CDs/DVDsSpy-Server is part of the FindinSite software range - search engines for MS-servers, Java-servers and CDs/DVDs