Hyrax - Administrators Interface

From OPeNDAP Documentation
Revision as of 21:03, 9 August 2011 by Ndp (talk | contribs) (OLFS Log Viewer)

1 Overview

2 Installation & Configuration

2.1 BES

The HAI is a regular part of the BES it is not a module that needs to be added. It just needs to be enabled by editing the BES configuration file and restarting the BES.

2.1.1 how-to

Edit the file $HYRAX_HOME/etc/bes.conf and uncomment this line:


Restart the BES and you're ready.

2.2 OLFS

The HAI is a regular part of the OLFS distribution and simply needs to be enabled by configuring the OLFS to communicate with the BES admin port, and by configuring Tomcat to allow you to access the UI.

2.2.1 olfs.xml

In the $CATALINA_HOME/content/opendap/olfs.xml file you will need to add (or uncomment) the following for each BES:


You will need to manually verify that the value of the adminPort element is the same as the BES.DaemonPort parameter specified in the bes.conf file for that BES instance.

2.2.2 Tomcat Users

You will need to configure Tomcat to support container-managed security, by connecting to an existing "database" (aka Realm) of usernames, passwords, and user roles. Tomcat supports several authentication Realms including LDAP. What follows are simple instructions for getting a Memory-Realm working. The Memory-Realm is not for production use, and the example is provided only as a means by which to easily demonstrate and allow one to test the HAI features.

Look here from more information on Tomcat and other authentication Realms how-to
  1. Edit the file $CATALINA_HOME/conf/tomcat-users.xml
  2. Add a user whose role is "manager":
    <user username="admin" password="foo" roles="manager" />
    And be sure to make the password something better than "foo".

Note that because the HAI is a web-based interface, with secure logins using SSL, you can use the interface with your server from anywhere in the world. It might be a godd idea, however, to limit the IP addresses that can access the HAI.

2.2.3 Tomcat SSL

In order to use the HAI you will need to configure your tomcat instance to enable SSL. How to accomplish this is covered in detail here at the Tomcat site. how-to

From their Quick Start section:

To install and configure SSL support on Tomcat 6, you need to follow these simple steps. For more information, read the rest of this HOW-TO.
1. Create a certificate keystore by executing the following command:
%JAVA_HOME%\bin\keytool -genkey -alias tomcat -keyalg RSA
$JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA
and specify a password value of "changeit".
2. Uncomment the "SSL HTTP/1.1 Connector" entry in $CATALINA_BASE/conf/server.xml and modify as described in the Configuration section.

2.2.4 Olfs Details

The HAI servlet (as part of the Hyrax web application) utilizes a <security-constraint> element, and a <login-config> element that define how administrators are required to authenticate themselves.

In the case of the HAI we use BASIC authentication over an SSL channel. The <transport-guarantee> ensures that the url's defined <web-resource-collection> can only be accessed via a secure channel:

           <web-resource-name>Hyrax Admin Interface</web-resource-name>


3 Using the Hyrax Admin Interface

Note: We often refer to the interface as either the HAI or just the interface.

To access the the interface, use the following URLs:

  • https://test.opendap.org:8443/opendap/docs/admin/index.jsp or https://test.opendap.org:8443/opendap/docs/admin/
  • http://test.opendap.org:8080/opendap/docs/admin

You will need to login using a user who is assigned the manager role as described above.

Once logged in, you will see a page with several links. Each one takes you to a different part of the interface so you can easily open them as tabs or separate windows in you browser.

Note that because the HAI is a web-based interface, with secure logins using SSL, you can use the interface with your server from anywhere in the world. It might be a godd idea, however, to limit the IP addresses that can access the HAI.

In order to understand this tool it may be helpful to review how Hyrax is structured: Hyrax is composed of one OLFS and one or more BES process. These are not required to be running on the same system.

4 OLFS Log Viewer

OLFS Log Viewer Default Page

4.1 Log Viewer Controls

Log Viewer Controls 1

Log Viewer Controls 2

4.2 Setting logging levels

Setting log levels 1

Setting log levels 2

Setting log levels 3

Setting log levels 4

5 BES Controls

The BES controller is located at: https://test.opendap.org:8453/opendap/docs/admin/besctl.jsp

The default page looks like this:

Default Admin Page

Beneath the "BES Management " banner you will see one or more tabs. You will always see a tab with the title of "/". This is the default BES for this Hyrax. If the particular installation of Hyrax has multiple BES configured in its OLFS they will appear here as tabs where the "prefix" for the BES from the olfs.xml file will be used as the tab title.

Admin Page Tour 1

Admin Page Tour  2

5.1 BES Configuration

BES Configuration 1

BES Configuration 2

5.2 Bes Logging

BES Logging 1

BES Logging 2

BES Logging Configuration 1

BES Logging 3

5.3 OLFS Connections

OLFS Connections 1

OLFS Connections 2