sample-configuration/prometheus.conf

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