RRFW Web Interface Reference

Directory structure

The directory $RRFW_HOME/web/ is reserved for CGI executables. However, there are no CGI executables in RRFW distribution.

The directory $RRFW_HOME/web/plain/ is the place for static HTML and images. The default CSS stylesheet files are installed in this directory. This directory must be configured with SetHandler default-handler directive.

CSS Stylesheets

The stylesheet files may be placed in $RRFW_HOME/web/plain/. The default HTML templates that come with the RRFW distribution use the global configuration variable $RRFW::Renderer::stylesheet, which is set in rrfw-config.pl and may be overwritten in rrfw-siteconfig.pl.

Cache files

All generated HTML and graphical images are cached twice: first on the server, and then in your browser. Thus, if you change somehow the HTML appearance of your RRFW installation, you need to clean both caches:

   /usr/local/rrfw-0.1/bin/clearcache

This will clear the cache on the server. Then you may use your browser's ``reload'' button, or clear the whole browser cache.

Site configuration options

The following variables may need to be set in your $RRFW_HOME/share/rrfw/rrfw-siteconfig.pl file:

$RRFW::Renderer::companyName

$RRFW::Renderer::companyURL

$RRFW::Renderer::rendererURL

'/rrfw'

$RRFW::Renderer::plainURL

'/rrfw/plain'

$RRFW::ApacheHandler::authorizeUsers

1

mod_perl 1.0 handler: RRFW::ApacheHandler

For more documentation, see <http://perl.apache.org/>.

The whole output generation is performed by the RRFW::ApacheHandler class. However, you still need access to the plain directory where your CSS resides. Typical Apache configuration would look like follows. Make sure your configuration does not contain tab characters:

  Alias /rrfw/plain "/usr/local/rrfw-0.1/web/plain"
  PerlRequire "/usr/local/rrfw-0.1/share/rrfw/webmux.pl"
  <Location /rrfw>
    SetHandler perl-script
    PerlHandler RRFW::ApacheHandler
  </Location>
  <Location /rrfw/plain/>
    SetHandler default-handler
    Options None
  </Location>

The base URL would be in this case:

  http://yourhost/rrfw/

mod_perl 2.0 handler: RRFW::Apache2Handler

Note: Apache 2.0 support in RRFW is currently in its early development stage.

Note: As of now, libapreq2 library is not released yet, and only the development version is available. You have to download and install it manually.

Earlier RRFW releases required Apache::ParseFormData module instead of libapreq2, and were compatible with mod_perl versions prior to 1.99_15. Starting with RRFW 0.1.8, Apache::ParseFormData is no longer required.

mod_perl version 1.99_15 or later is supported. To the moment, libapreq2 version 2.04_03-dev is tested.

Make sure you use webmux2.pl and RRFW::Apache2Handler in your configuration.

SetHandler modperl directive should give better performance than SetHandler perl-script. Both Perl handlers work the same way with RRFW.

Typical Apache 2.0 configuration follows:

  Alias /rrfw/plain "/usr/local/rrfw-0.1/web/plain"
  PerlRequire "/usr/local/rrfw-0.1/share/rrfw/webmux2.pl"
  <Location /rrfw>
    SetHandler modperl
    PerlResponseHandler RRFW::Apache2Handler
  </Location>
  <Location /rrfw/plain/>
    SetHandler default-handler
    Options None
  </Location>

The base URL would be in this case:

  http://yourhost/rrfw/

Known CGI parameters

The following CGI parameters are recognized by mod_perl handler:

token: Optional. Each configuration tree element is referenced by a token, a short unique identifier. If not given, the root of the tree (/) is displayed.
path: Optional. Alternatively to token reference, the full path of the tree element may be referenced.
view: Optional. Specifies the view name for displaying the tree element. If not specified, the defaul view is used.
TZ: Optional. If given, specifies the timezone that you want the graphs to be displayed for. This must be the URL-encoded zone name which is understood by your server system. You may use zdump(8) for testing.
NOW: Optional. If given, presents the output for the given moment, instead of the current time. Must be of the form understood by rrdtool (see RRDTool manuals).
DEBUG: Optional. If true, turns on the debug level of logging. The debug messages are sent to HTTP server's error log.
SHOWHIDDEN: Optional. If true, makes the grapher display those subtree and leaves which have hidden parameter set to yes.
NOHW: Optional. If true, disables the displaying of Holt-Winters boundaries and failures.
LOGOUT: Optional. When user authorization is enabled, causes the current user session to log out.

All other parameters whose name starts with capital letter, are passed to the HTML template as-is, and may be used for your custom purposes.