Updated config file options & descriptions

opentrafficshaper.conf

 [system]
-# Log level:
+# Log level
 # 0 - Errors only
 # 1 - Warnings and errors
 # 2 - Notices, warnings, errors
 # 3 - Info, notices, warnings, errors
-# 4 - Debugging 
-#log_level=2
+# 4 - Debugging
+#
+# default:
+# log_level=2
 
 
-# Log file:
-# Filename to write log messages to
-# Defaults to /var/log/opentrafficshaper/opentrafficshaper.log
-#log_file=/var/log/opentrafficshaper/opentrafficshaper.log
+# Log file to write log messages to
+#
+# default:
+# log_file=/var/log/opentrafficshaper/opentrafficshaper.log
 
 
-# PID file:
-# Filename to write our PID to
-# Defaults to /var/run/opentrafficshaper/opentrafficshaper.pid
-#pid_file=/var/run/opentrafficshaper/opentrafficshaper.pid
+# PID file to write our PID to
+#
+# default:
+# pid_file=/var/run/opentrafficshaper/opentrafficshaper.pid
+
+
+# State file, this file is used to store persistent information
+#
+# default:
+# statefile=/var/lib/opentrafficshaper/configmanager.state
 
 
-# STATE file:
-# This is the file used to store persistent information
-#statefile=/var/lib/opentrafficshaper/configmanager.state
 
 #
 # Plugins
@@ -57,16 +62,26 @@ load=tcstats
 # General shaping settings
 #
 [shaping]
-# Group 1 is by default the "Default" group
+# User group, this is the list of groups users can belong to
+#
+# The format of this option is:
+# <ID>:<DESCRIPTION>
+#
+# * NOT IMPLEMENTED YET *
+#
+# default:
+# none
 group=1:Default
 
 
-# Traffic classes
-# ID's and short description of traffic classes to Setup. Traffic is 
-# priortized as the lowest number getting the highest priority
+# Traffic classes ID's and short description of traffic classes to Setup. Traffic is priortized as the lowest number getting the
+# highest priority
 #
-# The second parameter is the name of the class
+# The format of this option is:
+# <ID>:<DESCRIPTION>
 #
+# default:
+# none
 class=1:High Priority
 class=2:Platinum
 class=3:Gold
@@ -75,24 +90,31 @@ class=5:Bronze
 class=6:Best Effort
 
 
-# Default pool
-# For traffic not classified, we can send it to a specific traffic class
+# Default pool for traffic not classified, we can send it to a specific traffic class. This is a pool ID.
 #
-# Defaults to "no"
-#default_pool=no
+# default:
+# default_pool=no
 
 
-# Interface group
-# This is a friendly name for a group of interfaces used for TX & RX
-# Its in the format of     txiface,rxiface:Friendly name
+# Interface groups that a pool is associated with
+#
+# The format of this option is:
+# <TXIFACE>,<RXIFACE>:<DESCRIPTION>
+#
 # The txiface is always the interface the client traffic is transmitted on (downloaded)
 # The rxiface is always the interface the client traffic is received on (uploaded)
+#
+# default:
+# interface_group=eth1,eth0:Default
 interface_group=eth1,eth0:LAN-side
 
 
 #
 # Interface setup
 #
+# Each interface comprises of a name, rate and a list of class rates for each class defined above. Each interface used in the
+# interface_groups above must be defined below.
+#
 
 [shaping.interface eth0]
 # This is the friendly name used when displaying this interface
@@ -100,10 +122,17 @@ name=WAN interface
 # The rate is specified in Kbps
 rate=100000
 
-# Class format is:  ClassID:CIR/Limit
-# If Limit is not specified it defaults to CIR
-# if the class definition is omitted, defaults to rate of interface
+# Class rate specification
+#
+# format:
+# <CLASSID>:<CIR>[/<LIMIT>]
+#
 # The CIR and Limit are specified in Kbps or percentage
+# If Limit is not specified it defaults to CIR
+# if the entire class definition is omitted, defaults to rate of interface
+#
+# default:
+# --interface limit for each class--
 class_rate=1:10000
 class_rate=2:5%/5%
 class_rate=3:5%
@@ -111,6 +140,7 @@ class_rate=4:5000/10000
 class_rate=5:5%
 class_rate=6:5%
 
+
 [shaping.interface eth1]
 name=LAN Interface
 rate=100000
@@ -126,36 +156,92 @@ class_rate=5:5%
 # Radius plugin
 #
 [plugin.radius]
+
+# Path of the radius dictionary files
+#
+# default:
+# none
 dictionary_path=/etc/opentrafficshaper
-# Dictionaries we need to load for radius functionality
+
+
+# Dictionaries we need to load for radius attributes we use, these are paths relative to dicitonary_path=
+#
+# default:
+# none
 dictionary=dicts/dictionary
 dictionary=dicts/dictionary.allworldit
 
-# Expire traffic control entries from radius in this period of time if not updated
-# Default: 86400     (1 day)
-#expiry_period=86400
+
+# Expire traffic control entries from radius in this period of time if not updated, this is in seconds
+#
+# default:
+# expiry_period=86400
+
+
+# Pool name transform to apply to the username. We apply a regex to the username and grab the first returned group, this group is
+# then used as the pool name instead of the full username.
+#
+#
+# Example: To use user@POOL, try something like this...
+# username_to_pool_transform=^[^@]+@(.*)
+#
+# Example: To use user.POOL@realm, try something like this...
+# username_to_pool_transform=^[^\.]+\.([^@]+)
+#
+# default:
+# none
+
+
+# Interface group to use for users which don't have the attribute set
+#
+# default:
+# default_interface_group=1
+
+
+# Match priority to use for users which don't have the attribute set
+#
+# default:
+# default_match_priority=2
+
+
+# Traffic class to use for users which don't have the attribute set
+#
+# default:
+# default_traffic_class=2
+
+
+# NOT IMPLEMENTED: Default group to use for users which don't have the attribute set
+#
+# default:
+# default_group=1
 
 
 #
 # TC Plugin
 #
 [plugin.tc]
-# Protocol to filter on, 99% of the time it will be "ip"
-# If however you're filtering VLAN Q-in-Q traffic, set this to 0x88a8
-#protocol=ip
+# Protocol to filter on, 99% of the time it will be "ip". If however you're filtering VLAN Q-in-Q traffic, set this to 0x88a8
+#
+# default:
+# protocol=ip
+
 
-# IP Header offset
-# If the kernel offsets your IP packet with octets you need to specify the value here
-# this most commonly happens when you shaping vlan traffic (as per above one would maybe
-# set this value to 4)
-#iphdr_offset=0
+# IP Header offset, if the kernel offsets your IP packet with octets you need to specify the value here this most commonly happens
+# when you shaping vlan traffic (as per above one would maybe set this value to 4)
+#
+# default:
+# iphdr_offset=0
 
 
 #
 # Statistics Plugin
 #
 [plugin.statistics]
-#db_dsn=dbi:SQLite:dbname=stats.sqlite3
-#db_username=
-#db_password=
+
+# Database credentials used for stats recording
+#
+# example:
+# db_dsn=DBI:mysql:dbname=ots
+# db_username=
+# db_password=