Cybotics Search Engine Installation

Requirements

  1. Administration interface requires JavaScript/JScript capable browsers,
     which means either Netscape browser 3.0 or higher, or Microsoft
     Internet Explorer 3.0 or higher.
  2. A web server or servlet engine capable of running Java servlets. Two
     choices are the Java Web Server and the Servlet Development Kit (which
     enables servlet support on Netscape web servers and Microsoft Internet
     Information Server). More information about Java servlets can be found
     at http://jserv.javasoft.com.

Installing on Windows 95 and Windows NT

If you are installing on a servlet engine other than the Java Web Server,
please see notes below.

  1. Download the Cybotics Search Engine 1.0b2 zip file from Cybotics
     Technologies Limited Web Site at http://www.cybotics.com.
  2. Unzip the zip file using utilities like WinZip (see
     http://www.winzip.com) This creates a directory called "cse1.0b2",
     which contains the product license "LICENSE", this "readme.html" file
     and another zip file "install.zip"
  3. Read the license ("LICENSE") carefully before using the product.
  4. Unzip "install.zip" in the directory where your servlet classes are
     stored. For example, if you have Java Web Server 1.0.1 installed under
     C:\Javaserver1.0.1, you should unzip the file to
     C:\Javaserver1.0.1\classes (you may need to create this directory if
     it does not exist). You can then delete the zip file.

  5. This extracts two servlets "CyboticsAdmin.class",
     "CyboticsSearch.class" and extra files under the "Cybotics" directory
     tree.
  6. That's it, start your web server. Using your web browser, connect to
     the login page of the Cybotics Search Engine Administration interface
     at the URL http://hostname:port/servlet/CyboticsAdmin, where
     "hostname" is your web host name, and "port" is the port number (e.g.
     http://localhost:8080/servlet/CyboticsAdmin)
  7. Login for the first time with password "admin". Click on "Help"->"Help
     Content" and follow the "Quick start" instructions to create a
     collection and start searching!

Installing on Unix

  1. Download the Cybotics Search Engine 1.0b2 tar file from Cybotics
     Technologies Limited Web Site at http://www.cybotics.com.
  2. Untar the tar file:

     % tar xvf cse1.0b2.tar

     This creates a directory called "cse1.0b2", which contains the product
     license "LICENSE", this "readme.html" file and another tar file
     "install.tar"
  3. Read the license ("LICENSE") carefully before using the product.
  4. Move the tar file "install.tar" to the directory where your servlet
     classes are stored. For example, if you have Java Web Server 1.0.1
     installed under /usr/local/Javaserver1.0.1, you should move the tar
     file to /usr/local/Javaserver1.0.1/classes (you may need to create
     this directory if it does not exist).
  5. Untar the tar file in the servlet directory and then delete it:

     % tar xvpf install.tar
     % rm install.tar

  6. This extracts two servlets "CyboticsAdmin.class",
     "CyboticsSearch.class" and extra files under the "Cybotics" directory
     tree. Make sure the user your web server is running as has read
     permission on all files under the "Cybotics" directory. Also make sure
     write permissions are granted for the following directories and any
     files under them (the untarred default is all writable):
        o Cybotics/System/collections
        o Cybotics/System/config
        o Cybotics/System/logs
        o Cybotics/System/templates
        o Cybotics/System/tmp
  7. That's it, start your web server. Using your web browser, connect to
     the login page of the Cybotics Search Engine Administration interface
     at the URL http://hostname:port/servlet/CyboticsAdmin, where
     "hostname" is your web host name, and "port" is the port number (e.g.
     http://localhost:8080/servlet/CyboticsAdmin)
  8. Login for the first time with password "admin". Click on "Help"->"Help
     Content" and follow the "Quick start" instructions to create a
     collection and start searching!

Installing on Servlet Engines other than the Java Web Server

A list of servlet engines could be found at
http://jserv.javasoft.com/products/java-server/servlets/environments.html.
To install the search engine on servlet engines other than the Java Web
Server, please note the following:

   * Search engine servlets and files ("install.zip" or "install.tar") must
     be extracted in a directory listed in the system property
     "java.class.path". At start, the search engine servlets
     "CyboticsAdmin.class" and "CyboticsSearch.class" will scan directories
     listed in this system property to search for search engine files. For
     some servlet engines (e.g. srun.exe in the Servlet Development Kit),
     this is done by adding the directory to the environment variable
     "CLASSPATH". For others, specific instructions must be followed for
     the particular servlet engine (e.g. IBM's Servlet Express requires
     setting the classpath in the file cfg/servlet.cnf).
   * Make sure the administration servlet can be accessed at URL
     http://hostname:port/servlet/CyboticsAdmin and the search servlet at
     URL http://hostname:port/servlet/CyboticsSearch. This is the default
     for the Servlet Development Kit, while in IBM's Servlet Express, this
     requires the following steps:

       1. In file "home/servlets.prp", add the lines:

          servlets.CyboticsAdmin.code=CyboticsAdmin
          servlets.CyboticsSearch.code=CyboticsSearch

       2. In file "home/rules.prp", add the lines:

          /servlet/CyboticsAdmin=CyboticsAdmin
          /servlet/CyboticsSearch=CyboticsSearch

   * The servlets also recognizes the following init parameters. If these
     parameters are supplied, they must be supplied to both the
     administration servlet and the search servlet:

       1. servletDir - the directory where you extracted search engine
          files ("install.zip" or "install.tar"). This overrides the
          setting in the classpath
       2. adminURL - the URL where the administration servlet
          "CyboticsAdmin.class" is to be accessed. This overrides the
          default URL http://hostname:port/servlet/CyboticsAdmin.
       3. searchURL - the URL where the search servlet
          "CyboticsAdmin.class" is to be accessed. This overrides the
          default URL http://hostname:port/servlet/CyboticsSearch.
