Documentation

The openAlerts documentation is divided into sections. The menu bar on the left lists the main topics. Links to sub-topics are highlighted in the text body. The following is a brief synopsis of each section:

  • Introduction
    General overview of openAlerts. This section covers the components of openAlerts and how they work together. Start here to get the big picture of openAlerts.

  • Requirements
    Lists the hardware and software requirements. This section details the components required before installing openAlerts.

  • Installation
    A guide on how to install openAlerts. This section covers downloading, extraction, configuration, compile, installation, and login to openAlerts.

  • Configuration
    General setup procedures. This section outlines the configuration of accounts, hosts, nodes, sensors, controls, people, contacts, and options.

  • Events
    Sensor status and activity. This section discusses the activity of sensors which includes outstanding alerts, current status, history, and graphical activity charts.

  • Utilities
    Command line utilities. This section explains how to manually start and stop openAlerts, set the locale, and test email.

Last edited 2012-03-02 21:57 UTC