renamed sample-configuration/ -> examples/
[svn/Prometheus-QoS/.git] / examples / prometheus.conf
diff --git a/examples/prometheus.conf b/examples/prometheus.conf
new file mode 100644 (file)
index 0000000..fff604b
--- /dev/null
@@ -0,0 +1,173 @@
+#==========================================================================
+#Configuration for Arachne Labs gateway prometheus.brevnov.czf (10.11.10.1)
+#==========================================================================
+#Path to external utilities required to run iGW Prometheus:
+#--------------------------------------------------------------------------
+tc                     /sbin/tc
+iptables               /sbin/iptables
+iptables-restore        /sbin/iptables-restore
+#========================================================================== 
+#Filename of iptables mangle table for iptables-restore 
+#--------------------------------------------------------------------------  
+iptables-file           /var/spool/prometheus.iptables 
+#==========================================================================
+#Filename of /etc/hosts - style IP address configuration file
+#--------------------------------------------------------------------------
+hosts                  /etc/prometheus/hosts
+#==========================================================================
+#Keywords found in /etc/host comments - syntax KEYWORD-MIN-MAX
+#Eg.:  192.168.1.2     mypc    #via-prometheus-256-512
+#sets  HTB rate for 192.168.1.2 to 256 kbps and HTB ceil to 512 kbps
+#--------------------------------------------------------------------------
+keyword                        wifi-normal
+keyword                        wifi-plus
+keyword                        backbone-normal
+keyword                        backbone-plus
+keyword                        backbone-bezfup
+#==========================================================================
+#LAN (local, downstream) and WAN (isp, internet, upstream) interface names
+#didn't work well with only one interface - two interfaces are required now
+#--------------------------------------------------------------------------
+lan-interface          eth0    #Linux network interface name
+wan-interface          eth1    #Linux network interface name
+#==========================================================================
+#LAN and WAN medium definition (100Mbit, 10Mbit - use 2Mbit for Wi-Fi)
+#--------------------------------------------------------------------------
+lan-medium             100Mbit #Mbit|kbit
+wan-medium             100Mbit #Mbit|kbit
+#==========================================================================
+#guranted upload and download bandwidth FROM your ISP (in kbps, please!)
+#asymetry settings will be automaticaly calculated from these values
+#--------------------------------------------------------------------------
+wan-download           40960   #kbps
+wan-upload             40960
+#==========================================================================
+#special QoS free zone (eg. free CZFree tranzit, etc.)
+#Apply QoS on HTTP proxy IP addres/port   
+#Set HTB rate and HTB ceil for address undefined in hosts file
+#--------------------------------------------------------------------------
+qos-free-zone          10.0.0.0/8      #0=disable|subnet eg. 192.168.0.0/16
+qos-free-delay         14400           #seconds to wait before applying QoS
+qos-proxy-enable       0               #1=yes|0=no
+qos-proxy-ip           10.11.10.1/32   #eg. IP of our LAN interface
+qos-proxy-port         3128            #squid port
+free-rate              64              #kbps - by Vitex kuli testovani dashboardu
+free-ceil              128             #kbps
+digital-divide-weirdness-ratio 1       #can be 1, 2, 3, maybe even more...
+#==========================================================================
+#Asymetric line settings - this allows setup of ADSL-style ISP service
+#asymetry-rate 2 means upload is limited to  50% of the rate of download
+#asymetry-treshold 64 means upload will be 64 kbps slower then download
+#--------------------------------------------------------------------------
+#These settings are keyword-derived ! (see "keyword" section)
+#--------------------------------------------------------------------------
+wifi-normal-asymetry-ratio     1       #2,4,etc. for relative upload shaping
+wifi-normal-asymetry-treshold  0       #kbps
+wifi-plus-asymetry-ratio       1
+wifi-plus-asymetry-treshold    0
+backbone-normal-asymetry-ratio         1
+backbone-normal-asymetry-treshold      0
+backbone-plus-asymetry-ratio           1
+backbone-plus-asymetry-treshold                0
+backbone-bezfup-asymetry-ratio         1
+backbone-bezfup-asymetry-treshold      0
+#==========================================================================
+#HTB fine tuning part I - common settings
+#type of traffic filtering  mark&filter or classify (without tc filter) 
+#--------------------------------------------------------------------------
+htb-nesting-limit      3       #0..4: HTB seems to have built-in limit
+htb-burst              32      #kbit
+htb-burst-group                32      #kbit (group level classes) 
+htb-burst-main                 64      #kbit (medium&line level classes - 1:1, 1:2) 
+htb-leaf-discipline    sfq perturb 5
+filter-type             classify #or mark 
+#==========================================================================
+#magic-include-upload - is data counter sum of upload and download ?
+#magic-priorities - prioty levels are used by magic-relative-prio
+#magic-treshold - heaviest downloader: htb-rate, 2nd: htb-rate+magic-treshold
+#==========================================================================
+magic-include-upload   1       #1=yes|0=no
+magic-priorities       8       #number of priority levels - 2
+magic-treshold         2       #kbps
+#--------------------------------------------------------------------------
+#Magic data limit based od guaranted bandwidth in kbps fine tunes HTB ceil:
+#(magic-relative-limit)*(min bandwidth kbps) = limit for given time period
+#eg. value 8 gives 512 MB limit to 64 kbps HTB rates, 1024 MB to 128'ers...
+#magic-fixed-limit is fixed data limit in MB (megabytes), 0=no limit
+#HTB ceil will be reduced to (HTB rate) for the most unfair-users
+#other offenders get (HTB rate)+(magic-treshold)
+#magic-relative-prio and magic-fixed-prio work exactly the same way as
+#limit, except that they reduce HTB priority instead of HTB ceil
+#--------------------------------------------------------------------------
+#These settings are keyword-derived ! (see "keyword" section)
+#--------------------------------------------------------------------------
+wifi-normal-magic-relative-limit       8       #*kb/sec->MB/day
+wifi-normal-magic-relative-prio                4       #*kb/sec->MB/day
+wifi-normal-magic-fixed-limit          0       #MB, less then
+wifi-normal-magic-fixed-prio           0       #MB, less then
+wifi-plus-magic-relative-limit         16
+wifi-plus-magic-relative-prio          8
+wifi-plus-magic-fixed-limit            0
+wifi-plus-magic-fixed-prio             0
+backbone-normal-magic-relative-limit   16
+backbone-normal-magic-relative-prio    8
+backbone-normal-magic-fixed-limit      0
+backbone-normal-magic-fixed-prio       0
+backbone-plus-magic-relative-limit     32
+backbone-plus-magic-relative-prio      16
+backbone-plus-magic-fixed-limit                0
+backbone-plus-magic-fixed-prio         0
+backbone-bezfup-magic-relative-limit   0
+backbone-bezfup-magic-relative-prio    8
+backbone-bezfup-magic-fixed-limit      0
+backbone-bezfup-magic-fixed-prio       0
+#==========================================================================
+#HTB fine tuning part II - keyword dependent settings
+#--------------------------------------------------------------------------
+#These settings are keyword-derived ! (see "keyword" section)
+#--------------------------------------------------------------------------
+wifi-normal-htb-default-prio           1       #can be 1...magic-priorities-2
+wifi-normal-htb-rate-bonus             0       #kbps
+wifi-normal-htb-ceil-malus             0       #kbps
+wifi-plus-htb-default-prio             1       
+wifi-plus-htb-rate-bonus               16
+wifi-plus-htb-ceil-malus               0       
+backbone-normal-htb-default-prio       1       
+backbone-normal-htb-rate-bonus         16
+backbone-normal-htb-ceil-malus         0       
+backbone-plus-htb-default-prio         1       
+backbone-plus-htb-rate-bonus           32
+backbone-plus-htb-ceil-malus           0       
+backbone-bezfup-htb-default-prio       2       
+backbone-bezfup-htb-rate-bonus         0
+backbone-bezfup-htb-ceil-malus         0       
+#==========================================================================
+#Credit file settings - stores unused credit from previous runs
+#--------------------------------------------------------------------------
+credit-filename                /var/lib/misc/prometheus.credit
+credit-enable          1       #1=yes|0=no
+#==========================================================================
+#Log file names and directories
+#--------------------------------------------------------------------------
+log-filename           /var/log/prometheuslog
+log-traffic-directory  /var/www/logs/
+log-traffic-url-path    logs/
+#==========================================================================
+#Hall of Fame - Greatest Suckers settings
+#--------------------------------------------------------------------------
+hall-of-fame-enable    1       #1=yes|0=no
+hall-of-fame-filename  /var/www/traffic.html
+hall-of-fame-preview   /var/www/preview.html
+hall-of-fame-title     Hall of Fame - Greatest Suckers
+#==========================================================================
+#Hall of Fame - Color settings (for FUP data limit display)
+#--------------------------------------------------------------------------
+#These settings are keyword-derived ! (see "keyword" section)
+#--------------------------------------------------------------------------
+wifi-normal-html-color         609000  #RRGGBB html hexa
+wifi-plus-html-color           008000
+backbone-normal-html-color     600090
+backbone-plus-html-color       000080
+backbone-bezfup-html-color     A06000
+#==========================================================================
+#That's all, folks. Now just run /usr/local/sbin/prometheus every day...
This page took 0.143665 seconds and 4 git commands to generate.