Hyrax - Installation Instructions: Difference between revisions

From OPeNDAP Documentation
⧼opendap2-jumptonavigation⧽
mNo edit summary
Line 9: Line 9:


==System Requirements==
==System Requirements==
Hyrax is supported on Linux and OS/X, although we only build binary versions for Linux. We do not support Hyrax on Windows or Vista, although see the [[Using Virtual Machines to Serve Data]] project for a solution applicable to Win32 platforms.


Hyrax is supported on Linux and OS/X. It's certainly likely that you can get it to run on virtually any Unix-like operating system. We do not support Hyrax on Windows or Vista, although see the [[Using Virtual Machines to Serve Data]] project for a solution for Win32 platforms. Also a group at Microsoft Research has ported Hyrax 1.5.x to their Azure cloud platform.
You can use either ''yum'', ''rpm'' or ''apt-get'' to get binary packages for the required software listed below. If you're building using our source distributions or a GitHub clone, be sure to get the ''-devel'' (rpm) or ''-dev'' (deb) packages; if you're using our binary builds then the plain packages will be fine.
 
You can use either ''yum'', ''rpm'' or ''apt-get'' to get binary packages for all of the required software listed below. On many operating systems the only packages you'll need to get are those specific to data you intend to serve (e.g., hdf5). If you're building our source distributions, be sure to get the ''-devel' packages; if you're using our binary builds then the plain packages will be fine.
 
In general, in addition to the software needed to build/run the basic framework, to serve data stored in a particular format, you need a handler that can read that format and often you need a that format's software library.


=== ''For the impatient'' ===
=== ''For the impatient'' ===
 
# On Linux system that uses RPM packages (Red Hat, CentOS, Fedora Core, ...), use ''yum'' to install epel-release. Then install our packages for libdap and BES.  
On Linux system that uses RPM packages (Red Hat, CentOS, Fedora Core, ...), use ''yum'' to install libicu, netcdf, hdf4 and hdf5. Then install our packages.  
# Get/install Tomcat
 
# Download the OLFS package, unpack the tar.gz file and copy ''opendap.war'' into Tomca's webapps directory.
To build from source, install libxml2-devel, libcurl-devel, uuid-devel, readline-devel, libicu-devel, netcdf-devel, hdf4-devel and hdf5-devel. Build. Your machine might have some of those packages, but RPM/yum will sort that out.
# Start the BES
 
# Start Tomcat
On systems that use the Debian package system, use ''apt-get'' to install the same packages, except that the development packages (the ones you need to compile code) are called ''-dev'' instead of ''-devel''.
# look at http://localhost:8080/opendap in a web browser


=== Short list ===
=== Short list ===

Revision as of 17:09, 10 April 2015

Hyrax is fairly easy to configure, but because there are several different components involved, it can seem complicated. Essentially you need to install two pieces of software: the BES and the OLFS. The BES reads data files and builds various kinds of responses and the OLFS is an interface to the BES that provides a web presence for the data and services. Because Hyrax uses a web server to work with web browsers and other kinds of programs, you will need to install the Apache Tomcat software too.

What you will need:

  • 5 minutes
  • Java 1.8 Runtime
  • Tomcat 7 or newer
  • The two pieces of software the make up Hyrax

System Requirements

Hyrax is supported on Linux and OS/X, although we only build binary versions for Linux. We do not support Hyrax on Windows or Vista, although see the Using Virtual Machines to Serve Data project for a solution applicable to Win32 platforms.

You can use either yum, rpm or apt-get to get binary packages for the required software listed below. If you're building using our source distributions or a GitHub clone, be sure to get the -devel (rpm) or -dev (deb) packages; if you're using our binary builds then the plain packages will be fine.

For the impatient

  1. On Linux system that uses RPM packages (Red Hat, CentOS, Fedora Core, ...), use yum to install epel-release. Then install our packages for libdap and BES.
  2. Get/install Tomcat
  3. Download the OLFS package, unpack the tar.gz file and copy opendap.war into Tomca's webapps directory.
  4. Start the BES
  5. Start Tomcat
  6. look at http://localhost:8080/opendap in a web browser

Short list

  1. libdap
    1. libxml2 2.6.16*
    2. libcurl 7.10.6*
    3. pthreads (part of glibc on linux)*
    4. uuid
  2. bes
    1. to build ssl authenticated connections, install openssl
    2. to use the bes command line utility, install readline-dev(el)
  3. dap-server (referred to as General purpose handlers on download page)
  4. OLFS
    1. Tomcat 6.0.x
    2. Java 1.5* run-time (or newer, depending on the requirements of the Tomcat software).

Additional stuff

When building from source, to run tests:

  1. dejagnu
  2. cppunit

To serve NetCDF files:

  1. The netCDF handler
    1. libnetcdf 3.x

To serve HDF4 files:

  1. The HDF4 handler
    1. The HDF4 library (4.x) and it's required software (often libjpeg, zlib* and szip)

To serve formatted ASCII using FreeForm:

  1. The FreeForm handler

To serve HDF5 files:

  1. The HDF5 handler
    1. The HDF5 library (1.6.0 or 1.8.x) (and often zlib*)

To provide data responses as NetCDF files:

  1. The Fileout NetCDF handler
    1. libnetcdf 3.x

To use NCML:

  1. The NCML Handler
    1. libicu 3.6
    2. At least one data handler

*Stock on any recent linux or OS/X distribution

Secure Installation Guidelines

Making Hyrax Secure

Install the BES

Install and configure the BES.

Install the OLFS

Next You need to install and configure the OLFS inside of a Tomcat server

Starting and Stopping Hyrax

To correctly start and stop Hyrax, follow these simple recipes.

Starting

  1. Start the BES first using the besctl program with the start argument. See Starting and stopping the BES for more information.
  2. Start the OLFS using the Tomcat startup script. See Starting Tomcat for more information.

Stopping

  1. Stop the OLFS first using the tomcat shutdown script.
  2. Stop the BES using the besctl program with the stop argument.

See above for stopping information.

Test the server

To test/use the server, open a web browser and open the URL: http://localhost:8080/ and you should see the Tomcat default page.

Open the URL: http://localhost:8080/opendap/ to see an HTML directory of the top of your data archive.

You can get the HTML view THREDDS catalog by appending "catalog.html" to the end of any URL that returns an HTML directory, like so: http://localhost:8080/opendap/catalog.html But you may need to do some additional configuration that to work.

Configure Your Hyrax Installation

At this point, Hyrax should be working. When you install Hyrax for the first time it is pre-configured to serve test data sets that come with each of the installed data handlers. This will allow you to test the server and make sure it is functioning correctly. After that you will want to configure so that it works with your data.

Miscellaneous

Once opendap.war is expanded, manually copy the file favicon.ico file:

$CATALINA_HOME/webapps/opendap/docs/images/favicon.ico

to

$CATALINA_HOME/webapps/ROOT/

The favicon.ico file is mostly a convenience to keep browsers from constantly asking for it (substitute your own icon if you like!).