Installation

This document describes how to install the Search Service software contained in the search-service package. The following topics can be found in this section:

• System Requirements
• Unpacking the Package
• Basic Application Deployment
• Advanced Application Deployment

System Requirements

This section details the system requirements for installing and operating the Search Service.

% which java
/usr/bin/java

% java -version
java version "1.6.0_26"
Java(TM) SE Runtime Environment (build 1.6.0_26-b03-384-10M3425)
Java HotSpot(TM) 64-Bit Server VM (build 20.1-b02-384, mixed mode)
        

Unpacking the Package

Download the search-service package from the PDS FTP site. The binary distribution is available in identical zip or tar/gzip packages. The installation directory may vary from environment to environment but in UNIX-based environments it is typical to install software packages in the /usr/local directory and in Windows-based environments it is typical to install software packages in the C:\Program Files directory. Unpack the selected binary distribution file with one of the following commands:

% unzip search-service-0.3.0-bin.zip
or
% tar -xzvf search-service-0.3.0-bin.tar.gz
      

Note: Depending on the platform, the native version of tar may produce an error when attempting to unpack the distribution file because many of the file paths are greater than 100 characters. If available, the GNU version of tar will resolve this problem. If that is not available or cannot be installed, the zipped package will work just fine in a UNIX environment.

The commands above result in the creation of the search-service-0.3.0 directory with the following directory structure:

• README.txt
  

  A README file directing the user to the available documentation for the project.

• LICENSE.txt
  

  The copyright notice from the California Institute of Technology detailing the restrictions regarding the use and distribution of this software. Although the license is strictly worded, the software has been classified as Technology and Software Publicly Available (TSPA) and is available for anyone to download and use.

• doc/
  

  This directory contains a local web site with the Search Service documentation, javadoc, unit test results and other configuration management related information. Just point the desired web browser to the index.html file in this directory.

Basic Application Deployment

The Search Service is the Solr configuration along with the Java extensions written to support PDS Search Protocol. In order to deploy Solr with the Search Service configuration, please complete the following procedure:

Note: This deployment procedure is the basic version, where all steps need to be repeated whenever and upgrade is required. For a more consistent approach for long-term deployment and maintenance, please see Advanced Application Deployment.

1. Download the Apache Solr software from the Solr website (the WAR file can be found in the dist directory of the tar package).
2. Place the WAR file in the $SEARCH_SERVICE_HOME directory (i.e. /usr/local/search-service-0.3.0).
3. Note the name of the WAR file (i.e. apache-solr-3.5.0.war)
4. Create a Tomcat context file search-service.xml to refer to this Solr war, and place it in the $TOMCAT_HOME/conf/Catalina/localhost directory. The search-service.xml file should look something like this:

   <?xml version="1.0" encoding="utf-8" ?>
   <Context docBase="/usr/local/search-service-0.3.0/apache-solr-3.5.0.war" debug="0" crossContext="true">
     <Environment name="solr/home" type="java.lang.String" value="/usr/local/search-service-0.3.0" override="true" />
     <Environment name="javax/xml/transform/TransformerFactory" type="java.lang.String" value="net/sf/saxon/TransformerFactoryImpl" override="true"/>
   </Context>
   	  

5. Modify $TOMCAT_HOME/bin/catalina.sh (or /etc/init.d/tomcat) to append something similar to the following to the CATALINA_OPTS and CLASSPATH environment variables:

   CATALINA_OPTS="${CATALINA_OPTS} -Dsolr.pds.home=/usr/local/search-service-0.3.0"
   CATALINA_OPTS="${CATALINA_OPTS} -Djavax.xml.transform.TransformerFactory=net.sf.saxon.TransformerFactoryImpl"
   
   CLASSPATH="${CLASSPATH}:/usr/local/search-service-0.3.0/lib/saxon-9.jar"
   	  

6. Restart Tomcat server
7. Test installation by going to http://localhost:8080/search-service/

Advanced Application Deployment

The Search Service is the Solr configuration along with the Java extensions written to support PDS Search Protocol. In order to deploy Solr with the Search Service configuration, please complete the following procedure:

Note: This deployment procedure is the advanced version, expected for long-term deployment and maintenance installation, please see Basic Application Deployment for a more simplistic approach.