MainConfigurationFile – StormSiren

Context Navigation

StormSiren'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 device sections.

[main]
- states = [comma separated list]
  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
  The total number of devices contained in the configuration file
```
Example:
	devices = 5
```
- history = integer
  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)
```
Example:
	history = 100
```
- proxy = string
  The URL of the proxy server to use when fetching xml files. If this parameter does not exist, no proxy will be used. (Default: None)
```
Example:
	proxy = http://proxy.example.com:3128
		-- or --
	proxy = http://USERNAME:PASSWORD@proxy.example.com:3128
```
[smtp]
- host = string
  The hostname of your mail server. (Default: localhost)
```
Example:
	host = localhost
```
- port = integer
  The port number that your mail server is listening on. (Default: 25)
```
Example:
	port = 25
```
- from = string
  The Email address that Email based alerts will appear to be from. (Default: noreply@…)
```
Example:
	from = noreply@storms.example.com
```
- user = string
  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.
```
Example:
	user = chris.freeze
```
- password = string
  The password to use when trying to send email if your SMTP gateway requires authentication.
```
Example:
	password = secret
```
[jabber]
- host = string
  The hostname of your jabber server. (Default: localhost)
```
Example:
	host = jabber.example.com
```
- port = integer
  The port number that your jabber server is listening on. (Default: 5223)
```
Example:
	port = 5222
```
- user = string
  The username for StormSiren to use when authenticating to your jabber server.
```
Example:
	user = weatherbot
```
- password = string
  The password for StormSiren to use when authenticating to your jabber server.
```
Example:
	password = secret
```
[media]
- player = string
  The media player to use to play the files below.
```
Example:
	player = /usr/bin/mplayer
```
- forecast = string
  The media file to play when a new forecast is to be alerted on.
```
Example:
	forecast = "C:\Sounds\forecast.wav"
```
- statement = string
  The media file to play when a new statement is to be alerted on.
```
Example:
	statement = "C:\Sounds\statement.avi"
```
- advisory = string
  The media file to play when a new advisory is to be alerted on.
```
Example:
	advisory = "C:\Sounds\advisory.mid"
```
- watch = string
  The media file to play when a new watch is to be alerted on.
```
Example:
	watch = "C:\Sounds\watch.wav"
```
- warning = string
  The media file to play when a new warning is to be alerted on.
```
Example:
	warning = "C:\Sounds\warning.wav" 
```
[execution]
- forecast = string
  The program to execute when a new forecast is to be alerted on.
```
Example:
	forecast = "C:\Scripts\forecast.bat"
```
- statement = string
  The program to execute when a new statement is to be alerted on.
```
Example:
	statement = "C:\Scripts\statement.bat"
```
- advisory = string
  The program to execute when a new advisory is to be alerted on.
```
Example:
	advisory = "/home/cfreeze/bin/weather/advisory.sh"
```
- watch = string
  The program to execute when a new watch is to be alerted on.

Example:
	watch = "/home/cfreeze/bin/weather/watch.sh"

warning = string
The program to execute when a new warning is to be alerted on.
```
Example:
	warning = "C:\Scripts\warning.cmd"
```

Download in other formats:

Plain Text