###########################################################################
#
# NLANR/DAST Multicast Beacon v1.3-0
# http://dast.nlanr.net/projects/beacon
# beacon@dast.nlanr.net
# August 26, 2005
#
## Copyright (c)  1999-2005
## The Board of Trustees of the University of Illinois
## All rights reserved
##
##
## NLANR Multicast Beacon
## http://dast.nlanr.net/projects/beacon
##
###########################################################################
##
## Developed by:                        Mitch Kutzko
##                                     Tony Rimovsky
##                                     John Estabrook
##                                       Jon Dugan
##
##                     National Laboratory for Applied Network Research
##                        University of Illinois at Urbana-Champaign
##                                 http://dast.nlanr.net
##
##                     National Center for Supercomputing Applications
##                        University of Illinois at Urbana-Champaign
##                               http://www.ncsa.uiuc.edu
##
## Permission is hereby granted, free of charge, to any person obtaining a 
## copy of this software and associated documentation files (the "Software"), 
## to deal in the Software without restriction, including without limitation 
## the rights to use, copy, modify, merge, publish, distribute, sublicense, 
## and/or sell copies of the Software, and to permit persons to whom the
## Software is furnished to do so, subject to the following conditions:
##      
##
##   - Redistributions of source code must retain the above copyright 
##     notice, this list of conditions and the following disclaimers.
##
##   - Redistributions in binary form must reproduce the above copyright 
##     notice, this list of conditions and the following disclaimers in the 
##     documentation and/or other materials provided with the distribution.
##
##   - Neither the names of the University of Illinois, NCSA, NLANR, DAST, 
##     nor the names of its contributors may be used to endorse or promote 
##     products derived from this Software without specific prior written 
##     permission.
##
## THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
## EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
## OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
## NONINFRINGEMENT. IN NO EVENT SHALL THE CONTIBUTORS OR
## COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
## LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
## ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
## USE OR OTHER DEALINGS IN THE SOFTWARE.
##
##
###########################################################################
#
# REQUIREMENTS
#
# Requires Perl 5.6 or better, and Perl module Net::Multicast::Beacon, which
# is included in this tarball. Also require Perl module Time::HiRes, which
# appears to be standard in most OSs except darwin.
#  See the README for more details.
#
#
###########################################################################
#
# This file contains the various startup options for the Beacon - If 
# you aren't sure what these mean, contact your Network 
# Administrator before trying to start the Beacon.  
#
# Note: Do *not* just make numbers up and hope they'll 
# work -- They won't.             -Mitch
#
#
#
# PLEASE edit and uncomment the CONTACTNAME/INFO/LOCATION information
# below to show your own information so you can be contacted if 
# something goes wrong with your Beacon or if we need to ask you to
# load a patch or update to a newer version.  Thanks!
#
#

# Multicast group to join - Get this from your NetAdmin
GROUP			= 233.4.200.18 # NLANR/DAST default Beacon group

# Port for RTP data -- Get this from your NetAdmin, too.
#
# Per RTP RFC3550, the initial Port value must be an EVEN number.
# By protocol, the RTCP port will be PORT+1, and the 
# TCP Unicast port will PORT+2 for the Central Server option.
PORT			= 10002				# NLANR/DAST default Beacon port

# Multicast scope -- How "far" are we sending?  Don't change this
# unless you know why you're changing it.
TTL			= 127

# PLEASE set these values to your own contact information!
# CONTACTNAME is you, CONTACTINFO is your email and/or phone, and
# CONTACTLOCATION is your geographic location.  It's plain text, open format.
# This information will be displayed on the Beacon Info page, and used if
# there is some reason to contact you about your Beacon.  (Reset, update, etc.)
#
# Please DO NOT just uncomment these values -- Please add your OWN infomation!!
CONTACTNAME			= None Given
CONTACTINFO			= None Given
CONTACTLOCATION		= None Given

# Email address to use for future Alarm/Notification features.
# Currently unused, but please take a moment to fill this out.
# Note: This email address will NOT be published anywhere public.
#NOTIFYEMAIL		= my-email@xyz.edu

# Don't write  a shutdown message to the HTML files when the Beacon is shut down
#NOSHUTDOWNMSG		= 1

# Show the Message of the Day
#SHOWMOTD		= 1

# Will be shown in <b></b> mode.....
#MOTD			= Test.

# Display the IP address gotten by reverse lookup
SHOWIP			= 1

# Display the RTP SSRC values
#SHOWSSRC		= 1

# Display number of Receiver Reports (RRS) received during each interval
SHOWREPORTS		= 1

# Output directory for the files generated by the Beacon. All Beacons
# generate the output files.  
# PLEASE DON'T ADD A TRAILING SLASH
OUTPUTDIR		= /home/beacon/outputfiles

# Move the Beacon process to background processing automatically at startup?
#BACKGROUND		= 1

# If you have a machine with more than one network interface card (NIC), you
# can specify which interface to use for the Beacon by setting this option
# here, or using the command line options provided for the same function.
# This must be in the form of a dotted quad address.  Ie, 141.142.98.209.
#INTERFACE		= 141.142.2.55

# To have your Beacon report its data back TO a Central Beacon Server via 
# TCP Unicast, set this value to the name of the Central Server.  The TCP 
# port defaults to two greater than the RTP PORT number above.  
CENTRALSERVERNAME	= jhereg.ncsa.uiuc.edu

# UNRELATED to the CENTRALSERVERNAME option above, use this option
# to also have this particular instance of the Beacon act AS a 
# Central Beacon Server.  Do NOT turn this option on if your Beacon will
# just be reporting to an existing Central Server.  MOST INSTALLATIONS
# will leave this option OFF.
#BECENTRALSERVER		= 1

# If this Beacon is a Central Server, should it write flat-text 
# CSV (comma separated values) history data out to a file?  Default filename
# is "history.txt".
WRITEHISTORY		= 1

# Erase the existing file (if there is one) first?
#ERASEHISTORY		= 1

# Do we perform 100 packet burst tests at random intervals every
# 120 +  (0 - 240) minutes?	 (Two hours plus zero to four hours)
#BURSTTEST			= 0

# Do we perform three minute silence tests at random intervals every
# 120 +  (0 - 240) minutes?	 (Two hours plus zero to four hours)
#SILENCETEST		= 0

# For running the Beacon as a non-privileged user.  Must start Beacon
# as root to be able to change the UID of the process.  To use the example
# here, you'd need to create a user "beacon" first, and give it whatever
# privileges and permissions you deem appropriate.  Check with your SysAdmin
# if you aren't sure.
#RUNASUSER	= beacon
#RUNASGROUP	= beacon

# If this flag is set, anything normally written to STDOUT is written
# to SysLog instead.  (Ie, for Linux, look in /var/log/messages)  Log
# messages appear with an ident of 'beacon', include the pid, and at
# facility daemon.
#SYSLOG         = 1

# In the event that you need to specify a TCP Unicast port number (ONLY 
# USED for sending Beacon reports back to a Central Beacon Server) of 
# other than the default "PORT+2", you can edit this value and comment 
# this line in, but I recommend you NOT do so unless there's a good reason 
# for you not to use the default port.
#SERVERTCPPORT		= 10004

STOPME		= 1
