Software Documentation
Download
Project Documentation
This document describes the environment configuration for the Search Core command-line tool contained in the search-core package, specific to the Engineering Node environment. For more generic installation instructions, see the Install Guide. The following topics can be found in this section:
The following table lists the machines that require the installation of the Search Core software. The Configuring the Environment section of this document should only be performed on the machines in this table:
| Machine Name | Type |
|---|---|
| pdsbeta | Development |
| pdssrv1 | Operations |
| pdssrv2 | Operations |
In order to execute the Search Core, the local environment must first be configured appropriately. This section describes how to setup the user environment on the Engineering Node Unix-based machines.
This section details the environment setup for UNIX-based machines. First, a symbolic link should be made to the Search Core installation directory. This will provide a means to easily run the software, as well as upgrade software in the future.
The following command demonstrates how to create a symbolic link (requires root access):
% ln -s /usr/local/search-core-1.6.0 /usr/local/search-core
If a symbolic link already exists at /usr/local/search-core, simply remove it and recreate it with the new version of the software using the line above.
The pds4 user will be the owner of the the software so that it can be run without root access. The following command needs to be run to change the owner of the software (requires root access):
% chown -R pds4 /usr/local/search-core
The remaining environment configurations should be performed as the pds4 user:
% sudo su pds4
The binary distribution includes shell scripts that must be executed from the command-line. Setting the PATH environment variable to the location of the scripts, enables the shell scripts to be executed from any location on the local machine.
The following command demonstrates how to set the PATH environment variable (in Bourne shell), by appending to its current setting:
% export PATH=${PATH}:/usr/local/search-core/bin
In addition, the shell scripts require that the JAVA_HOME environment variable be set to the appropriate location of the Java installation on the local machine. The following command demonstrates how to set the JAVA_HOME environment variable:
% export JAVA_HOME=/path/to/java/home
The system administrator for the local machine may need to be consulted for this location. The path specified should have a bin sub-directory that contains the java executable. This variable may also be defined within the scripts. Edit the scripts (files without the .bat extension) and change the line in the example above to represent the local Java installation.