Difference between revisions of "Hyrax"

From OPeNDAP Documentation
(Installing the binary distribution)
m
 
(43 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This is the '''OPeNDAP 4 Data Server''', also known as '''Hyrax'''.
+
<font size="+1">This is the '''OPeNDAP 4 Data Server''', also known as '''Hyrax'''. See our new '''[https://opendap.github.io/hyrax_guide/Master_Hyrax_Guide.html Hyrax Installation and Configuration Guide]'''.</font>
 +
----
 +
<font color="red">
 +
Note: The documentation on this is somewhat out of date as of October 2017.
 +
</font>
  
=Overview=
+
This page leads you through implementing and configuring Hyrax. Work through this page from top to bottom.
 +
 
 +
== Hyrax Operational Overview ==
 
[[Image:HyraxArchitecture.jpg|right|thumb]]
 
[[Image:HyraxArchitecture.jpg|right|thumb]]
  
Line 7: Line 13:
  
 
The BES is the high-performance server software from HAO. It handles reading data from the data stores and returning DAP-compliant responses to the OLFS. In turn, the OLFS may pass these response back to the requestor with little or no modification or it may use them to build more complex responses. The nature of the Inter Process Communication (IPC) between the OLFS and BES is such that they should both be on the same machine or be able to communicate over a very high bandwidth channel.
 
The BES is the high-performance server software from HAO. It handles reading data from the data stores and returning DAP-compliant responses to the OLFS. In turn, the OLFS may pass these response back to the requestor with little or no modification or it may use them to build more complex responses. The nature of the Inter Process Communication (IPC) between the OLFS and BES is such that they should both be on the same machine or be able to communicate over a very high bandwidth channel.
 
  
 
Both the OLFS and the BES will run and serve test data immediately after a default installation. Additional configuration is required for them to serve site specific data.
 
Both the OLFS and the BES will run and serve test data immediately after a default installation. Additional configuration is required for them to serve site specific data.
  
 
+
{|  class="wikitable"
==Features==
+
|+ Hyrax Features
 
+
| '''THREDDS Catalog Support'''
;THREDDS Catalog Support  
+
| Hyrax supports the THREDDS catalogs. It can serve user supplied static catalogs and it will dynamically generate THREDDS catalogs of it's internal holdings.
: Hyrax supports the THREDDS catalogs. It can serve user supplied static catalogs and it will dynamically generate THREDDS catalogs of it's internal holdings.
+
|-
 
+
| '''Dataset Aggregation'''
;Dataset Aggregation
+
| Collections of related data resources can be collected into a single dataset using the aggregation features. Typically these are formed for geographic tiles, time series, etc.
: Collections of related data resources can be collected into a single dataset using the aggregation features. Typically these are formed for geographic tiles, time series, etc.
+
|-
 
+
|'''Adding/modifying dataset content'''
;Adding/modifying dataset content.
+
| Datasets can be modified by the server without having to actually change the underlying files. These views are independently accessible from the original data. Both dataset metadata and data values may be added or changed.  
: Datasets can be modified by the server without having to actually change the underlying files. These views are independently accessible from the original data. Both dataset metadata and data values may be added or changed.
+
|-
 
+
|'''Multiple source data formats'''
;Supports multiple source data formats
+
| Server can ingest source data stored as HDF4, HDF4-EOS, HDF5, HDF5-EOS, NetCDF-3, NetCDF-4, CEDAR, FITS, Comma Separated Values, and raw ASCII and Binary formats. Because of Hyrax's extensible design, it's easy to add new source data formats.
: Server can ingest source data stored as HDF4, HDF4-EOS, HDF5, HDF5-EOS, NetCDF-3, NetCDF-4, CEDAR, FITS, Comma Separated Values, and raw ASCII and Binary formats. Because of Hyrax's extensible design, it's easy to add new source data formats.
+
|-
 
+
|'''Multiple Return Formats For Data rRetrieval in multiple return formats'''
; Supports data retrieval in multiple return formats
+
| Hyrax is able to return data in DAP, DAP4, NetCDF-3, NetCDF-4, JSON, CSV, and ASCII formats, Or, you can add your own response types.
: Hyrax is able to return data in DAP, DAP4, NetCDF-3, NetCDF-4, JSON, CSV, and ASCII formats, Or, you can add your own response types.
+
|-
 
+
|'''Gateway Service'''
; Gateway  
+
| Hyrax supports a gateway service feature that allows it to provide DAP (and other Hyrax) services for remotely held datasets that are stored in any of Hyrax's source data formats.
: Hyrax supports a gateway feature that allows it to provide DAP (and other Hyrax) services for remotely held datasets that are stored in any of Hyrax's source data formats.
+
|-
 
+
|'''RDF'''
; RDF
+
| Hyrax provides RDF descriptions of it's data holdings. These can enable semantic web tools to operate upon the metadata content held in the server.
: Hyrax provides RDF descriptions of it's data holdings. These can enable semantic web tools to operate upon the metadata content held in the server.  
+
|-
 
+
|'''[[Server_Side_Processing_Functions | Server side functions]]'''
;[[Server_Side_Processing_Functions | Server side functions]]
+
|Hyrax supports a number of server side functions out of the box including (but not limited to):
: Hyrax supports a number of server side functions out of the box including (but not limited to):
+
* ''[[Server_Side_Processing_Functions#geogrid.28.29|geogrid]]'': Subset applicable DAP Grids using latitude and longitude values.
:* ''[[Server_Side_Processing_Functions#geogrid.28.29|geogrid]]'': Subset applicable DAP Grids using latitude and longitude values.
+
* ''[[Server_Side_Processing_Functions#grid.28.29|grid]]'': Subset any DAP Grid object using the values of it's map vectors.
:* ''[[Server_Side_Processing_Functions#grid.28.29|grid]]'': Subset any DAP Grid object using the values of it's map vectors.
+
* ''[[Server_Side_Processing_Functions#linear_scale|linear_scale]]'': Apply a linear equation to the data returned, including automatic use of CF attributes.
:* ''[[Server_Side_Processing_Functions#linear_scale|linear_scale]]'': Apply a linear equation to the data returned, including automatic use of CF attributes.
+
* ''[[Server_Side_Processing_Functions#version.28.29|version]]'': The version function provides a list of the server-side processing functions available.
:* ''[[Server_Side_Processing_Functions#version.28.29|version]]'': The version function provides a list of the server-side processing functions available.
+
* New ones are easy to add.
:* New ones are easy to add.
+
|-
 
+
|'''Extensible WebStart functionality for data clients'''
;Extensible WebStart functionality for data clients
+
| Hyrax provides WebStart functionality for a number of Java based DAP clients. It's simple to add new clients to the list that Hyrax supports.
: Hyrax provides WebStart functionality for a number of Java based DAP clients. It's simple to add new clients to the list that Hyrax supports.
+
|-
 
+
|'''Extensible WebStart functionality for data clients'''
;Extensible/Configurable web interface
+
|Hyrax provides WebStart functionality for a number of Java based DAP clients. It's simple to add new clients to the list that Hyrax supports.
:The web interface for both Hyrax and the administrator's interface can be customized using CSS and XSL. You can add your organizations logo and specialize the colors and fonts in the presentation of data sets.
+
|-
 
+
|'''Extensible/Configurable web interface'''
;Administrator's interface
+
|The web interface for both Hyrax and the administrator's interface can be customized using CSS and XSL. You can add your organizations logo and specialize the colors and fonts in the presentation of data sets.
: Control and dynamically update Hyrax from a convenient web interface. See [[Hyrax_-_Administrators_Interface| the Admin interface documentation]].
+
|-
 
+
|'''Administrator's interface'''
; WMS services
+
|Control and dynamically update Hyrax from a convenient web interface. See [[Hyrax_-_Administrators_Interface| the Admin interface documentation]].
: [[Hyrax WMS|Hyrax now supports WMS services via integration with ncWMS.]]
+
|-
 
+
|'''WMS services'''
; JSON responses
+
|[[Hyrax WMS|Hyrax now supports WMS services via integration with ncWMS.]]
: [[Hyrax JSON| Both metadata and data are now available in a JSON encoding.]]
+
|-
 
+
|'''JSON responses'''
; w10n
+
|[[Hyrax JSON| Both metadata and data are now available in a JSON encoding.]]
: Hyrax comes with a complete w10n service stack. W10n navigation is supported through the default catalog where all datasets and "structure" variables appear as graph nodes. Data can be acquired for atomic types or arrays of atomic types in a number of formats.
+
|-
 
+
|'''JSON responses'''
 +
|[[Hyrax JSON| Both metadata and data are now available in a JSON encoding.]]
 +
|-
 +
|'''w10n'''
 +
|Hyrax comes with a complete w10n service stack. W10n navigation is supported through the default catalog where all datasets and "structure" variables appear as graph nodes. Data can be acquired for atomic types or arrays of atomic types in a number of formats.
 +
|}
  
 
;Feature Request
 
;Feature Request
 
: Is there a feature you would like to see but don't? Let us know: [mailto:support@opendap.org support@opendap.org] or [mailto:opendap-tech@opendap.org opendap-tech@opendap.org] (You need to [http://mailman.opendap.org/mailman/listinfo/opendap-tech subscribe] first)
 
: Is there a feature you would like to see but don't? Let us know: [mailto:support@opendap.org support@opendap.org] or [mailto:opendap-tech@opendap.org opendap-tech@opendap.org] (You need to [http://mailman.opendap.org/mailman/listinfo/opendap-tech subscribe] first)
  
=Downloads=
+
== Downloading and Installing ==
 
 
To obtain Hyrax just go to the [http://www.opendap.org/download/hyrax  Hyrax download page] and get it.
 
 
 
= Install =  
 
'''''Updated for Hyrax-1.11''' ([[Hyrax - Installation Instructions|For older versions see here.]])''
 
  
== Installing the binary distribution ==
+
The download and installation instructions are kept together.  
# Download the RPM packages from the [http://www.opendap.org/download/hyrax  Hyrax download page]
+
For the latest release look at <font size="2">[https://www.opendap.org/index.php/software/hyrax-data-server the Hyrax downloads page]</font>.
# If your CentOS/Fedora/RHEL 6 machine does not have the EPEL repository configured (rpm -q epel-release will tell if that has been configured) then get the [https://fedoraproject.org/wiki/EPEL Extra Packages For Linux (EPEL) rpm] and install it using sudo rpm -ivh epel-*.rpm Be careful to use the -i option option. Also note that some CentOS 6 images (e.g., Amazon AMIs) ship with EPEL installed but disabled. If that's the case, run yum using --enablerepo=epel​ or ​Modify /etc/yum.repos.d/epel.repo. Under the section marked [epel], change enabled=0 to enabled=1. (see the [http://http//aws.amazon.com/amazon-linux-ami/faqs/ Amazon Linux AMI FAQ] for more information).
 
# Use yum to install the libdap and bes RPMs (sudo yum install libdap-3.14*.rpm bes-3.14*.rpm). Unless you're going to be developing software for Hyrax, skip the libdap-devel and bes-devel since those are for development only.
 
# At this point you can test the BES by typing the following into a terminal:
 
#* Start it:
 
#:: <tt>sudo besctl start</tt>
 
#* Connect using a simple client:
 
#:: <tt>bescmdln</tt>
 
#* Get version information:
 
#:: <tt>show version;</tt>
 
#* Exit from bescmdln:
 
#:: <tt>exit;</tt>
 
# Check the java version on your system:
 
#:: <tt>java -version</tt>
 
# If you have earlier than 1.8.x then you'll need to install java 8:
 
#: <tt>yum install java-1.8.0</tt>
 
#* If you are on a modernish Linux system you may need to use the alternatives tool to make java 8 the current JVM. Run the command:
 
#::<tt>alternatives --config java</tt>
 
#:You'll get an interactive terminal application that will allow you to select your newly installed java 8 as the preferred alternative.
 
#* '''NB:''' ''[http://docs.oracle.com/javase/8/docs/technotes/guides/install/mac_install_faq.html On OS-X you will have a different path for making Java 8 your current java.]''
 
# Get Apache Tomcat-7.0.50 or newer if you don't already have it. (Earilier version like 7.0.30 or so DO NOT support Java 8)
 
# Download the OLFS Web ARchive (war) file (see above, by the Java logo) and put opendap.war in the tomcat webapps directory (cp opendap.war apache-tomcat-7.0.59/webapps).
 
# At this point you should be able to start tomcat (./apache-tomcat-7.0.59/bin/startup.sh) and test the server:
 
#* In a web browser, use http://localhost:8080/opendap/
 
#* Look at sample data files shipped with the server
 
#* If you are installing the OLFS/ncWMS bundle, copy both the opendap.war and the ncWMS.war files in the Tomcat webapps directory. (Re)Start Tomcat. [http://docs.opendap.org/index.php/Hyrax_WMS Go read about, and then configure ncWMS and the OLFS to work together].
 
  
== Building And Installing From Source ==
+
=== Building And Installing From Source ===
  
 
[[Hyrax GitHub Source Build|Getting and Building The Code From GitHub]]
 
[[Hyrax GitHub Source Build|Getting and Building The Code From GitHub]]
  
=Documentation=
+
== Server Configuration ==
 
+
At this point, you should have a running Hyrax server, but it will not be configured for your needs. In this section you will configure your Hyrax server. To do this, you will need to  configure BES and OLFS; optionally, you can configure THREDDS catalogs to provide a custom virtual view of the servers holdings.
== Users ==
 
* [[Hyrax - Administrators Interface]]
 
 
* [[Hyrax - Configuration|Hyrax Configuration Instructions]]
 
* [[Hyrax - Configuration|Hyrax Configuration Instructions]]
 
** [[Hyrax - BES Configuration|BES Configuration]]
 
** [[Hyrax - BES Configuration|BES Configuration]]
 
** [[Hyrax - OLFS Configuration|OLFS Configuration]]
 
** [[Hyrax - OLFS Configuration|OLFS Configuration]]
** [[Hyrax - THREDDS Configuration|THREDDS Configuration]]
+
** [[Hyrax - THREDDS Configuration|THREDDS Catalog Configuration]]
** [[Hyrax - Logging Configuration|Logging Configuration]]
 
  
 +
=== Apache Integration ===
 +
This is an optional step after configuring BES and OLFS. Integrating Hyrax with Apache allows you to integrate your Hyrax server with existing web infrastructure and is the recommended path for enabling user authentication and authorization. 
 
* [[Hyrax - Apache Integration|Hyrax integration with the Apache Web Server]]
 
* [[Hyrax - Apache Integration|Hyrax integration with the Apache Web Server]]
* [[Hyrax_-_User_Identification_(Authentication) | Hyrax User Authentication and Identification]]
+
==== User Authentication ====
* [[Hyrax - Customizing Hyrax| Customizing Hyrax]]
+
*[[Hyrax_-_User_Identification_(Authentication) | Hyrax User Authentication and Identification]] Configure Hyrax to support user authentication. Explains how to integrate Hyrax with LDAP, Earthdata Login, Shibboleth, etc.
* [[Australian BOM System Administrator's Agenda and Presentations|System Administrators Workshop]]
+
** [[DAP Clients - Authentication]] Instruction to configure various DAP (and other generic HTTP clients) to work with the various authentication schemes
 +
 
 +
=== And then there's more...===
 +
* [[Hyrax - Customizing Hyrax| Customizing Hyrax]]. Here you will find instructions on how to change the colors, fonts, and logo images presented in the Hyrax web pages.
 +
* [[Australian BOM System Administrator's Agenda and Presentations|System Administrators Workshop]] Here are slides from a system administrators workshop we gave to the Australian BOM on how to manage a Hyrax instance.
 +
* [[Hyrax - Administrators Interface]] Here are the instruction for using the Hyrax Admin Interface, a web UI that allows one to view logs, restart, reconfigure, and otherwise fiddle with a Hyrax instance.
 
<!-- * [[Hyrax - Release Notes|Release Notes]] -->
 
<!-- * [[Hyrax - Release Notes|Release Notes]] -->
  
=== Modules ===
+
== Modules ==
 
Hyrax has a number of modules that provide the actual functionality of the server: Reading data files, building different kinds of responses and performing different kinds of server processing operations. Most of these modules work with the BES but some are part of the front (web facing) part of the server.
 
Hyrax has a number of modules that provide the actual functionality of the server: Reading data files, building different kinds of responses and performing different kinds of server processing operations. Most of these modules work with the BES but some are part of the front (web facing) part of the server.
  
===== BES modules =====
+
=== BES modules ===
 
* [[BES - Modules - The NetCDF Handler|NetCDF data handler]]
 
* [[BES - Modules - The NetCDF Handler|NetCDF data handler]]
 
* [[BES - Modules - The HDF4 Handler|HDF4 data handler]]
 
* [[BES - Modules - The HDF4 Handler|HDF4 data handler]]
Line 134: Line 118:
 
* [[BES - Modules - CSV Handler | CSV handler ]]
 
* [[BES - Modules - CSV Handler | CSV handler ]]
 
* [[BES - Modules - GeoTiff, GRIB2, JPEG2000 Handler| GeoTiff, GRiB2, JPEG2000 hander]]
 
* [[BES - Modules - GeoTiff, GRIB2, JPEG2000 Handler| GeoTiff, GRiB2, JPEG2000 hander]]
 
 
* [[BES - Modules - FileOut Netcdf|NetCDF File Response handler]]
 
* [[BES - Modules - FileOut Netcdf|NetCDF File Response handler]]
 
* [[BES_-_Modules_-_FileOut_GDAL | GDAL (GeoTIFF, JPEG2000) File Response handler]]
 
* [[BES_-_Modules_-_FileOut_GDAL | GDAL (GeoTIFF, JPEG2000) File Response handler]]
  
===== Additional Java Modules that use the BES =====
+
=== Additional Java Modules that use the BES ===
 
* [[Hyrax WMS | WMS]] - Web Mapping Service via integration with ncWMS.
 
* [[Hyrax WMS | WMS]] - Web Mapping Service via integration with ncWMS.
 
* [[Aggregation enhancements]]
 
* [[Aggregation enhancements]]
Line 145: Line 128:
 
* [[BES - Modules - SQL Hander | SQL handler]]
 
* [[BES - Modules - SQL Hander | SQL handler]]
  
== For Software Developers ==
+
== Technical Support ==
* [[Hyrax GitHub Source Build]] We have moved the Hyrax source code to GitHub; please don't use the old, read-only SVN repo to build.
 
* [[How to use Eclipse with Hyrax Source Code]] Note that this is a a work in progress, but it will help with some of the odd steps that Eclipse seems to require.
 
 
 
===== BES Development Information =====
 
* [[BES_-_How_to_Debug_the_BES| How to debug the BES]]
 
* [[BES - Debugging Using besstandalone]]
 
* [[Hyrax - Create BES Module | How to create your own BES Module]]
 
* [[Hyrax - Starting and stopping the BES| Starting and stopping the BES]]
 
* [[Hyrax - Running bescmdln | Running the BES command line client]]
 
* [[Hyrax - BES Client commands| BES Client commands]]
 
* [[BES_XML_Commands | BES XML Commands]]
 
* [[Hyrax - Extending BES Module | Extending your BES Module]]
 
* [[Hyrax - Example BES Modules | Example BES Modules]] - the Hello World example and the CSV data handler
 
* [[Hyrax - BES PPT | BES communication protocol using PPT (point to point transport)]]
 
* [[Hyrax:_BES_Administrative_Commands| BES Administrative Commands]]
 
 
 
<!-- There is a link to this on the main opendap.org page. I'll put a copy of that on the Developer Info page, where it's more appropriate. jhrg * [[Australian BOM Software Developer's Agenda and Presentations|Software Developers Workshop]] -->
 
 
 
==Reference documentation==
 
 
 
* [http://www.opendap.org/api/bes/html/index.html BES Reference]
 
* [http://www.opendap.org/api/libdap/html/index.html libdap Reference]
 
 
 
=Thanks!=
 
 
 
We hope we hope you find this software useful, and we welcome your questions and comments.
 
 
 
==Contact Us==
 
  
 
'''Technical Support:'''  
 
'''Technical Support:'''  
Line 186: Line 141:
 
* jgallagher <at> opendap <dot> org (''libdap'')
 
* jgallagher <at> opendap <dot> org (''libdap'')
  
==Sponsorship==
+
== Sponsorship ==
  
====OPeNDAP Hyrax development is sponsored by:====
+
OPeNDAP Hyrax development is sponsored by:
  
 +
[[Image:Nasa-logo.jpg|95px]] '''[http://www.nasa.gov  National Aeronautics and Space Administration]'''
  
 
[[Image:Nsf-logo.png|95px]]  '''[http://www.nsf.gov National Science Foundation]'''
 
[[Image:Nsf-logo.png|95px]]  '''[http://www.nsf.gov National Science Foundation]'''
  
This material is based upon work supported by the National Science Foundation under Grant No. 0430822. Any opinions, findings and conclusions or recomendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation (NSF).
+
This material is based on work supported by the National Science Foundation under Grant No. 0430822. Any opinions, findings and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation (NSF).
 
 
[[Image:Nasa-logo.jpg|95px]] '''[http://www.nasa.gov  National Aeronautics and Space Administration]'''
 
  
 
[[Image:Noaa-logo.jpg|90px]]  '''[http://www.noaa.gov National Oceanic and Atmospheric Administration]'''
 
[[Image:Noaa-logo.jpg|90px]]  '''[http://www.noaa.gov National Oceanic and Atmospheric Administration]'''

Latest revision as of 18:47, 26 October 2017

This is the OPeNDAP 4 Data Server, also known as Hyrax. See our new Hyrax Installation and Configuration Guide.


Note: The documentation on this is somewhat out of date as of October 2017.

This page leads you through implementing and configuring Hyrax. Work through this page from top to bottom.

1 Hyrax Operational Overview

HyraxArchitecture.jpg

Hyrax uses the Java servlet mechanism to hand off requests from a general web daemon to DAP format-specific software. This results in higher performance for small requests. The servlet front end, which we call the OPeNDAP Lightweight Front end Server (OLFS) looks at each request and formulates a query to a second server (which may or may not on the same machine as the OLFS) called the Back End Server (BES).

The BES is the high-performance server software from HAO. It handles reading data from the data stores and returning DAP-compliant responses to the OLFS. In turn, the OLFS may pass these response back to the requestor with little or no modification or it may use them to build more complex responses. The nature of the Inter Process Communication (IPC) between the OLFS and BES is such that they should both be on the same machine or be able to communicate over a very high bandwidth channel.

Both the OLFS and the BES will run and serve test data immediately after a default installation. Additional configuration is required for them to serve site specific data.

Hyrax Features
THREDDS Catalog Support Hyrax supports the THREDDS catalogs. It can serve user supplied static catalogs and it will dynamically generate THREDDS catalogs of it's internal holdings.
Dataset Aggregation Collections of related data resources can be collected into a single dataset using the aggregation features. Typically these are formed for geographic tiles, time series, etc.
Adding/modifying dataset content Datasets can be modified by the server without having to actually change the underlying files. These views are independently accessible from the original data. Both dataset metadata and data values may be added or changed.
Multiple source data formats Server can ingest source data stored as HDF4, HDF4-EOS, HDF5, HDF5-EOS, NetCDF-3, NetCDF-4, CEDAR, FITS, Comma Separated Values, and raw ASCII and Binary formats. Because of Hyrax's extensible design, it's easy to add new source data formats.
Multiple Return Formats For Data rRetrieval in multiple return formats Hyrax is able to return data in DAP, DAP4, NetCDF-3, NetCDF-4, JSON, CSV, and ASCII formats, Or, you can add your own response types.
Gateway Service Hyrax supports a gateway service feature that allows it to provide DAP (and other Hyrax) services for remotely held datasets that are stored in any of Hyrax's source data formats.
RDF Hyrax provides RDF descriptions of it's data holdings. These can enable semantic web tools to operate upon the metadata content held in the server.
Server side functions Hyrax supports a number of server side functions out of the box including (but not limited to):
  • geogrid: Subset applicable DAP Grids using latitude and longitude values.
  • grid: Subset any DAP Grid object using the values of it's map vectors.
  • linear_scale: Apply a linear equation to the data returned, including automatic use of CF attributes.
  • version: The version function provides a list of the server-side processing functions available.
  • New ones are easy to add.
Extensible WebStart functionality for data clients Hyrax provides WebStart functionality for a number of Java based DAP clients. It's simple to add new clients to the list that Hyrax supports.
Extensible WebStart functionality for data clients Hyrax provides WebStart functionality for a number of Java based DAP clients. It's simple to add new clients to the list that Hyrax supports.
Extensible/Configurable web interface The web interface for both Hyrax and the administrator's interface can be customized using CSS and XSL. You can add your organizations logo and specialize the colors and fonts in the presentation of data sets.
Administrator's interface Control and dynamically update Hyrax from a convenient web interface. See the Admin interface documentation.
WMS services Hyrax now supports WMS services via integration with ncWMS.
JSON responses Both metadata and data are now available in a JSON encoding.
JSON responses Both metadata and data are now available in a JSON encoding.
w10n Hyrax comes with a complete w10n service stack. W10n navigation is supported through the default catalog where all datasets and "structure" variables appear as graph nodes. Data can be acquired for atomic types or arrays of atomic types in a number of formats.
Feature Request
Is there a feature you would like to see but don't? Let us know: support@opendap.org or opendap-tech@opendap.org (You need to subscribe first)

2 Downloading and Installing

The download and installation instructions are kept together. For the latest release look at the Hyrax downloads page.

2.1 Building And Installing From Source

Getting and Building The Code From GitHub

3 Server Configuration

At this point, you should have a running Hyrax server, but it will not be configured for your needs. In this section you will configure your Hyrax server. To do this, you will need to configure BES and OLFS; optionally, you can configure THREDDS catalogs to provide a custom virtual view of the servers holdings.

3.1 Apache Integration

This is an optional step after configuring BES and OLFS. Integrating Hyrax with Apache allows you to integrate your Hyrax server with existing web infrastructure and is the recommended path for enabling user authentication and authorization.

3.1.1 User Authentication

3.2 And then there's more...

  • Customizing Hyrax. Here you will find instructions on how to change the colors, fonts, and logo images presented in the Hyrax web pages.
  • System Administrators Workshop Here are slides from a system administrators workshop we gave to the Australian BOM on how to manage a Hyrax instance.
  • Hyrax - Administrators Interface Here are the instruction for using the Hyrax Admin Interface, a web UI that allows one to view logs, restart, reconfigure, and otherwise fiddle with a Hyrax instance.

4 Modules

Hyrax has a number of modules that provide the actual functionality of the server: Reading data files, building different kinds of responses and performing different kinds of server processing operations. Most of these modules work with the BES but some are part of the front (web facing) part of the server.

4.1 BES modules

4.2 Additional Java Modules that use the BES

Unsupported:

5 Technical Support

Technical Support:

Hyrax Java Development:

  • ndp <at> opendap <dot> org

Hyrax C++ Development:

  • pwest <at> ucar <dot> edu (bes)
  • jgallagher <at> opendap <dot> org (libdap)

6 Sponsorship

OPeNDAP Hyrax development is sponsored by:

Nasa-logo.jpg National Aeronautics and Space Administration

Nsf-logo.png National Science Foundation

This material is based on work supported by the National Science Foundation under Grant No. 0430822. Any opinions, findings and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation (NSF).

Noaa-logo.jpg National Oceanic and Atmospheric Administration