Installation
This document describes how to install the Registry Application software contained in the pds-registry-app package.
The following topics can be found in this section:
Download and unpack the package
Download the pds-registry-app package from Github (TAR.GZ ZIP). 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 /home/pds 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 pds-registry-app-0.2.3-bin.zip or % tar -xzvf pds-registry-app-0.2.3-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 pds-registry-app-0.2.3 directory with the following directory structure:
- registry-4.0.2/
This directory contains tools which initiate the registry index in Elasticsearch
- harvest-3.3.2/
This directory contains harvest tool package.
- test/
This directory contains reference test datasets useful to validate the deployment.
- LICENSE
The Apache License, Version 2.0
- README.txt
A README file with some high level information on the project and how to view more detailed documentation.
- VERSION.txt
A VERSION file contains the version of the project.
Configure your environment
The registry resources are located in sub-directory registry-4.0.2.
The harvest tools are located in subdirectory harvest-3.3.2
To enable these tools, add the following to your PATH:
For a UNIX environment, add the following to your .bash_profile (NOTE: May differ for other Unix shells). Replace $(pwd) as needed for the location of your software.
export PATH=${PATH}:/path/to/pds-registry-app-0.2.3/harvest-3.3.2/bin:/path/to/pds-registry-app-0.2.3/registry-manager-4.0.2/bin
For a Windows environment:
set PATH=%PATH%;C:\path\to${project.artifactId}-0.2.3\harvest-3.3.2\bin;C:\path\to${project.artifactId}-0.2.3\registry-manager-4.0.2\bin;%PATH%
Next Steps
The registry tools are deployed. You can now initialize your registry.