root/trac/MainConfigurationFile

StormXmlSiren's main configuration file is based on the standard INI file format.  The file consists of the following main sections, followed by an unlimited number of [wiki:DeviceConfiguration device sections].

 * ['''main''']
   * '''states''' = ''[comma separated list]'' [[BR]]This is a list of states that will referenced in subsequent device sections.  This list should include all states that will be covered.
{{{
Example:
        states = TX,TN,AL,CA
}}}
   * '''watchers''' = ''integer''[[BR]]The total number of devices contained in the configuration file[[BR]]
{{{
Example:
        devices = 5
}}}
   * '''history''' = ''integer''[[BR]]The total number of previous alerts to keep on file.  Older alerts will be trimmed to keep the memory footprint smaller and execution time quicker.  (Default: 200)[[BR]]
{{{
Example:
        history = 100
}}}
 * ['''smtp''']
   * '''host''' = ''string''[[BR]]The hostname of your mail server. (Default: localhost)[[BR]]
{{{
Example:
        host = localhost
}}}
   * '''port''' = ''integer''[[BR]]The port number that your mail server is listening on. (Default: 25)[[BR]]
{{{
Example:
        port = 25
}}}
   * '''from''' = ''string''[[BR]]The Email address that Email based alerts will appear to be from. (Default: noreply@example.com)[[BR]]
{{{
Example:
        from = noreply@storms.example.com
}}}
   * '''user''' = ''string''[[BR]]The username to use when trying to send email if your SMTP gateway requires authentication.  If this is not set, SMTP authentication will not be used.[[BR]]
{{{
Example:
        user = chris.freeze
}}}
   * '''password''' = ''string''[[BR]]The password to use when trying to send email if your SMTP gateway requires authentication.[[BR]]
{{{
Example:
        password = secret
}}}
 * ['''jabber''']
   * '''host''' = ''string''[[BR]]The hostname of your jabber server. (Default: localhost)[[BR]]
{{{
Example:
        host = jabber.example.com
}}}
   * '''port''' = ''integer''[[BR]]The port number that your jabber server is listening on. (Default: 5223)[[BR]]
{{{
Example:
        port = 5222
}}}
   * '''user''' = ''string''[[BR]]The username for StormXmlSiren to use when authenticating to your jabber server.[[BR]]
{{{
Example:
        user = weatherbot
}}}
   * '''password''' = ''string''[[BR]]The password for StormXmlSiren to use when authenticating to your jabber server.[[BR]]
{{{
Example:
        password = secret
}}}
 * ['''media''']
   * '''player''' = string[[BR]]The media player to use to play the files below.[[BR]]
{{{
Example:
        player = /usr/bin/mplayer
}}}
   * '''forecast''' = string [[BR]]The media file to play when a new forecast is to be alerted on.[[BR]]
{{{
Example:
        forecast = "C:\Sounds\forecast.wav"
}}}
   * '''statement''' = string[[BR]]The media file to play when a new statement is to be alerted on.[[BR]]
{{{
Example:
        statement = "C:\Sounds\statement.avi"
}}}
   * '''advisory''' = string[[BR]]The media file to play when a new advisory is to be alerted on.[[BR]]
{{{
Example:
        advisory = "C:\Sounds\advisory.mid"
}}}
   * '''watch''' = string[[BR]]The media file to play when a new watch is to be alerted on.[[BR]]
{{{
Example:
        watch = "C:\Sounds\watch.wav"
}}}
   * '''warning''' = string[[BR]]The media file to play when a new warning is to be alerted on.[[BR]]
{{{
Example:
        warning = "C:\Sounds\warning.wav" 
}}}
 * ['''execution''']
   * '''forecast''' = string [[BR]]The program to execute when a new forecast is to be alerted on.[[BR]]
{{{
Example:
        forecast = "C:\Scripts\forecast.bat"
}}}
   * '''statement''' = string[[BR]]The program to execute when a new statement is to be alerted on.[[BR]]
{{{
Example:
        statement = "C:\Scripts\statement.bat"
}}}
   * '''advisory''' = string[[BR]]The program to execute when a new advisory is to be alerted on.[[BR]]
{{{
Example:
        advisory = "/home/cfreeze/bin/weather/advisory.sh"
}}}
   * '''watch''' = string[[BR]]The program to execute when a new watch is to be alerted on.[[BR]]
{{{
Example:
        watch = "/home/cfreeze/bin/weather/watch.sh"
}}}
   * '''warning''' = string[[BR]]The program to execute when a new warning is to be alerted on.[[BR]]
{{{
Example:
        warning = "C:\Scripts\warning.cmd"
}}}