more IPs allowed in identical IPv6 uplink network
[svn/Prometheus-QoS/.git] / prometheus.conf.5
1 .TH prometheus.conf 5 "January 4, 2008"
2 .LO 5
3 .SH NAME
4 prometheus.conf \- configuration file for prometheus
5 .SH SYNOPSIS
6 .ll +8
7 .B prometheus.conf
8 .SH DESCRIPTION
9 There are daily traffic quotas defined using "magic-relative-limit" value
10 se to 8. This translates into 48h quota 1 GB for 64 kbps lines,
11 2 GB for 128 kbps lines, etc., with unused credit from day before yesterday
12 stored in /var/run/prometheus.credit. Soft quotas (fair use policy) are
13 applied (resulting in lower HTB priority) even before hard quotas are reached
14 (magic-relative-prio set to 6, which is less then magic-relative-limit set
15 to 8).
16
17 Daily limits are applied by running prometheus every day at 3:00 AM. Between
18 3:00 AM and 6:00 AM, there is QoS free period, enabled by "qos-free-delay"
19 value set to 10800. However, yesterday's data transfer statistics are kept
20 in memory while prometheus QoS is iddle in this sleep mode.
21
22 Undefined IP addresses share 32 kbps guaranted and 64 kbps maximum speed,
23 set using "free-rate" and "free-ceil" keyword.
24
25 There is QoS-free zone defined using "qos-free-zone" too be 10.0.0.0/8.
26 This allows for example easy management of gateway from inside this range,
27 or remote management of entire network after ssh to gatway and then another
28 ssh to this zone.
29
30 We run HTTP proxy at port 3128 of LAN interface of internet gateway. This
31 proxy is inside "qos-free-zone". Because of "qos-proxy-enable",
32 "qos-proxy-ip" (which is actually IP/number of bits of netmask) and
33 "qos-proxy-port" settings, this port is excluded from QoS-free zone.
34 .SH OPTIONS
35 .B tc
36 .TP
37 .B iptables
38 .TP
39 .B iptables-restore
40 .TP
41 .B iptables-file
42 .TP
43 .B hosts
44 .TP
45 .B keyword
46 .TP
47 .B lan-interface
48 .TP
49 .B wan-interface
50 .TP
51 .B lan-medium
52 .TP
53 .B wan-medium
54 .TP
55 .B wan-download
56 .TP
57 .B wan-upload
58 .TP
59 .B qos-free-zone
60 .TP
61 .B qos-free-delay
62 .TP
63 .B qos-proxy-enable
64 .TP
65 .B qos-proxy-ip
66 .TP
67 .B qos-proxy-port
68 .TP
69 .B free-rate
70 .TP
71 .B free-ceil
72 .TP
73 .B digital-divide-weirdness-ratio
74 .TP
75 .B via-prometheus-asymetry-ratio
76 .TP
77 .B via-prometheus-asymetry-treshold
78 .TP
79 .B adsl-prometheus-asymetry-ratio
80 .TP
81 .B adsl-prometheus-asymetry-treshold
82 .TP
83 .B htb-nesting-limit
84 .TP
85 .B htb-burst
86 .TP
87 .B htb-burst-group
88 .TP
89 .B htb-burst-main
90 .TP
91 .B htb-leaf-discipline
92 .TP
93 .B htb-r2q
94 .TP
95 .B filter-type
96 .TP
97 .B magic-include-upload
98 .TP
99 .B magic-priorities
100 .TP
101 .B magic-treshold
102 .TP
103 .B via-prometheus-magic-relative-limit
104 .TP
105 .B via-prometheus-magic-relative-prio
106 .TP
107 .B via-prometheus-magic-fixed-limit
108 .TP
109 .B via-prometheus-magic-fixed-prio
110 .TP
111 .B adsl-prometheus-magic-relative-limit
112 .TP
113 .B adsl-prometheus-magic-relative-prio
114 .TP
115 .B adsl-prometheus-magic-fixed-limit
116 .TP
117 .B adsl-prometheus-magic-fixed-prio
118 .TP
119 .B via-prometheus-htb-default-prio
120 .TP
121 .B via-prometheus-htb-rate-bonus
122 .TP
123 .B via-prometheus-htb-ceil-malus
124 .TP
125 .B adsl-prometheus-htb-default-prio
126 .TP
127 .B adsl-prometheus-htb-rate-bonus
128 .TP
129 .B adsl-prometheus-htb-ceil-malus
130 .TP
131 .B credit-filename
132 .TP
133 .B credit-enable
134 .TP
135 .B log-filename
136 .TP
137 .B log-traffic-directory
138 .TP
139 .B log-traffic-url-path
140 .TP
141 .B hall-of-fame-enable
142 .TP
143 .B hall-of-fame-filename
144 .TP
145 .B hall-of-fame-preview
146 .TP
147 .B hall-of-fame-title
148 .TP
149 .B via-prometheus-html-color
150 .TP
151 .B adsl-prometheus-html-color
152 .SH SEE ALSO
153 iptables(8), tc(8), prometheus(1)
154 .SH AVAILABILITY
155 Prometheus is available at https://dev.arachne.cz/svn/prometheus/downloads
This page took 0.300366 seconds and 4 git commands to generate.