examples/prometheus.conf

   1 #==========================================================================
   2 #Configuration for Arachne Labs gateway prometheus.brevnov.czf (10.11.10.1)
   3 #==========================================================================
   4 #Path to external utilities required to run iGW Prometheus:
   5 #--------------------------------------------------------------------------
   6 tc                      /sbin/tc
   7 iptables                /sbin/iptables
   8 iptables-restore        /sbin/iptables-restore
   9 #==========================================================================
  10 #Filename of iptables mangle table for iptables-restore
  11 #--------------------------------------------------------------------------
  12 iptables-file           /var/spool/prometheus.iptables
  13 #==========================================================================
  14 #Filename of /etc/hosts - style IP address configuration file
  15 #--------------------------------------------------------------------------
  16 hosts                   /etc/prometheus/hosts
  17 #==========================================================================
  18 #Keywords found in /etc/host comments - syntax KEYWORD-MIN-MAX
  19 #Eg.:   192.168.1.2     mypc    #via-prometheus-256-512
  20 #sets   HTB rate for 192.168.1.2 to 256 kbps and HTB ceil to 512 kbps
  21 #--------------------------------------------------------------------------
  22 keyword                 wifi-normal
  23 keyword                 wifi-plus
  24 keyword                 backbone-normal
  25 keyword                 backbone-plus
  26 keyword                 backbone-bezfup
  27 #==========================================================================
  28 #LAN (local, downstream) and WAN (isp, internet, upstream) interface names
  29 #didn't work well with only one interface - two interfaces are required now
  30 #--------------------------------------------------------------------------
  31 lan-interface           eth0    #Linux network interface name
  32 wan-interface           eth1    #Linux network interface name
  33 #==========================================================================
  34 #LAN and WAN medium definition (100Mbit, 10Mbit - use 2Mbit for Wi-Fi)
  35 #--------------------------------------------------------------------------
  36 lan-medium              100Mbit #Mbit|kbit
  37 wan-medium              100Mbit #Mbit|kbit
  38 #==========================================================================
  39 #guranted upload and download bandwidth FROM your ISP (in kbps, please!)
  40 #asymetry settings will be automaticaly calculated from these values
  41 #--------------------------------------------------------------------------
  42 wan-download            40960   #kbps
  43 wan-upload              40960
  44 #==========================================================================
  45 #special QoS free zone (eg. free CZFree tranzit, etc.)
  46 #Apply QoS on HTTP proxy IP addres/port
  47 #Set HTB rate and HTB ceil for address undefined in hosts file
  48 #--------------------------------------------------------------------------
  49 qos-free-zone           10.0.0.0/8      #0=disable|subnet eg. 192.168.0.0/16
  50 qos-free-delay          14400           #seconds to wait before applying QoS
  51 qos-proxy-enable        0               #1=yes|0=no
  52 qos-proxy-ip            10.11.10.1/32   #eg. IP of our LAN interface
  53 qos-proxy-port          3128            #squid port
  54 free-rate               64              #kbps - by Vitex kuli testovani dashboardu
  55 free-ceil               128             #kbps
  56 digital-divide-weirdness-ratio  1       #can be 1, 2, 3, maybe even more...
  57 #==========================================================================
  58 #Asymetric line settings - this allows setup of ADSL-style ISP service
  59 #asymetry-rate 2 means upload is limited to  50% of the rate of download
  60 #asymetry-treshold 64 means upload will be 64 kbps slower then download
  61 #--------------------------------------------------------------------------
  62 #These settings are keyword-derived ! (see "keyword" section)
  63 #--------------------------------------------------------------------------
  64 wifi-normal-asymetry-ratio      1       #2,4,etc. for relative upload shaping
  65 wifi-normal-asymetry-treshold   0       #kbps
  66 wifi-plus-asymetry-ratio        1
  67 wifi-plus-asymetry-treshold     0
  68 backbone-normal-asymetry-ratio          1
  69 backbone-normal-asymetry-treshold       0
  70 backbone-plus-asymetry-ratio            1
  71 backbone-plus-asymetry-treshold         0
  72 backbone-bezfup-asymetry-ratio          1
  73 backbone-bezfup-asymetry-treshold       0
  74 #==========================================================================
  75 #HTB fine tuning part I - common settings
  76 #type of traffic filtering  mark&filter or classify (without tc filter)
  77 #--------------------------------------------------------------------------
  78 htb-nesting-limit       3       #0..4: HTB seems to have built-in limit
  79 htb-burst               32      #kbit
  80 htb-burst-group         32      #kbit (group level classes)
  81 htb-burst-main          64      #kbit (medium&line level classes - 1:1, 1:2)
  82 htb-leaf-discipline     sfq perturb 5
  83 filter-type             classify #or mark
  84 #==========================================================================
  85 #magic-include-upload - is data counter sum of upload and download ?
  86 #magic-priorities - prioty levels are used by magic-relative-prio
  87 #magic-treshold - heaviest downloader: htb-rate, 2nd: htb-rate+magic-treshold
  88 #==========================================================================
  89 magic-include-upload    1       #1=yes|0=no
  90 magic-priorities        8       #number of priority levels - 2
  91 magic-treshold          2       #kbps
  92 #--------------------------------------------------------------------------
  93 #Magic data limit based od guaranted bandwidth in kbps fine tunes HTB ceil:
  94 #(magic-relative-limit)*(min bandwidth kbps) = limit for given time period
  95 #eg. value 8 gives 512 MB limit to 64 kbps HTB rates, 1024 MB to 128'ers...
  96 #magic-fixed-limit is fixed data limit in MB (megabytes), 0=no limit
  97 #HTB ceil will be reduced to (HTB rate) for the most unfair-users
  98 #other offenders get (HTB rate)+(magic-treshold)
  99 #magic-relative-prio and magic-fixed-prio work exactly the same way as
 100 #limit, except that they reduce HTB priority instead of HTB ceil
 101 #--------------------------------------------------------------------------
 102 #These settings are keyword-derived ! (see "keyword" section)
 103 #--------------------------------------------------------------------------
 104 wifi-normal-magic-relative-limit        8       #*kb/sec->MB/day
 105 wifi-normal-magic-relative-prio         4       #*kb/sec->MB/day
 106 wifi-normal-magic-fixed-limit           0       #MB, less then
 107 wifi-normal-magic-fixed-prio            0       #MB, less then
 108 wifi-plus-magic-relative-limit          16
 109 wifi-plus-magic-relative-prio           8
 110 wifi-plus-magic-fixed-limit             0
 111 wifi-plus-magic-fixed-prio              0
 112 backbone-normal-magic-relative-limit    16
 113 backbone-normal-magic-relative-prio     8
 114 backbone-normal-magic-fixed-limit       0
 115 backbone-normal-magic-fixed-prio        0
 116 backbone-plus-magic-relative-limit      32
 117 backbone-plus-magic-relative-prio       16
 118 backbone-plus-magic-fixed-limit         0
 119 backbone-plus-magic-fixed-prio          0
 120 backbone-bezfup-magic-relative-limit    0
 121 backbone-bezfup-magic-relative-prio     8
 122 backbone-bezfup-magic-fixed-limit       0
 123 backbone-bezfup-magic-fixed-prio        0
 124 #==========================================================================
 125 #HTB fine tuning part II - keyword dependent settings
 126 #--------------------------------------------------------------------------
 127 #These settings are keyword-derived ! (see "keyword" section)
 128 #--------------------------------------------------------------------------
 129 wifi-normal-htb-default-prio            1       #can be 1...magic-priorities-2
 130 wifi-normal-htb-rate-bonus              0       #kbps
 131 wifi-normal-htb-ceil-malus              0       #kbps
 132 wifi-plus-htb-default-prio              1
 133 wifi-plus-htb-rate-bonus                16
 134 wifi-plus-htb-ceil-malus                0
 135 backbone-normal-htb-default-prio        1
 136 backbone-normal-htb-rate-bonus          16
 137 backbone-normal-htb-ceil-malus          0
 138 backbone-plus-htb-default-prio          1
 139 backbone-plus-htb-rate-bonus            32
 140 backbone-plus-htb-ceil-malus            0
 141 backbone-bezfup-htb-default-prio        2
 142 backbone-bezfup-htb-rate-bonus          0
 143 backbone-bezfup-htb-ceil-malus          0
 144 #==========================================================================
 145 #Credit file settings - stores unused credit from previous runs
 146 #--------------------------------------------------------------------------
 147 credit-filename         /var/lib/misc/prometheus.credit
 148 credit-enable           1       #1=yes|0=no
 149 #==========================================================================
 150 #Log file names and directories
 151 #--------------------------------------------------------------------------
 152 log-filename            /var/log/prometheuslog
 153 log-traffic-directory   /var/www/logs/
 154 log-traffic-url-path    logs/
 155 #==========================================================================
 156 #Hall of Fame - Greatest Suckers settings
 157 #--------------------------------------------------------------------------
 158 hall-of-fame-enable     1       #1=yes|0=no
 159 hall-of-fame-filename   /var/www/traffic.html
 160 hall-of-fame-preview    /var/www/preview.html
 161 hall-of-fame-title      Hall of Fame - Greatest Suckers
 162 #==========================================================================
 163 #Hall of Fame - Color settings (for FUP data limit display)
 164 #--------------------------------------------------------------------------
 165 #These settings are keyword-derived ! (see "keyword" section)
 166 #--------------------------------------------------------------------------
 167 wifi-normal-html-color          609000  #RRGGBB html hexa
 168 wifi-plus-html-color            008000
 169 backbone-normal-html-color      600090
 170 backbone-plus-html-color        000080
 171 backbone-bezfup-html-color      A06000
 172 #==========================================================================
 173 #That's all, folks. Now just run /usr/local/sbin/prometheus every day...