Introducing the --base switch to modify the base URL.
[darkstat.git] / darkstat.8.in
1 .\"
2 .\" darkstat 3
3 .\" Copyright 2001-2010, Emil Mikulic.
4 .\"
5 .\" You may use, modify and redistribute this file under the terms of the
6 .\" GNU General Public License version 2. (see COPYING.GPL)
7 .\"
8 .TH darkstat 8 "September 2010" "@PACKAGE_STRING@"
9 .SH NAME
10 darkstat \- network statistics gatherer
11 .\"
12 .SH SYNOPSIS
13 .B darkstat
14 [
15 .BI \-i " interface"
16 ] [
17 .BI \-r " file"
18 ] [
19 .BI \-\-snaplen " bytes"
20 ] [
21 .BI \-\-pppoe
22 ] [
23 .BI \-\-syslog
24 ] [
25 .BI \-\-verbose
26 ] [
27 .BI \-\-no\-daemon
28 ] [
29 .BI \-\-no\-promisc
30 ] [
31 .BI \-\-no\-dns
32 ] [
33 .BI \-\-no\-macs
34 ] [
35 .BI \-\-no\-lastseen
36 ] [
37 .BI \-p " port"
38 ] [
39 .BI \-b " bindaddr"
40 ] [
41 .BI \-\-base " path"
42 ] [
43 .BI \-f " filter"
44 ] [
45 .BI \-l " network/netmask"
46 ] [
47 .BI \-\-chroot " dir"
48 ] [
49 .BI \-\-user " username"
50 ] [
51 .BI \-\-daylog " filename"
52 ] [
53 .BI \-\-import " filename"
54 ] [
55 .BI \-\-export " filename"
56 ] [
57 .BI \-\-pidfile " filename"
58 ] [
59 .BI \-\-hosts\-max " count"
60 ] [
61 .BI \-\-hosts\-keep " count"
62 ] [
63 .BI \-\-ports\-max " count"
64 ] [
65 .BI \-\-ports\-keep " count"
66 ] [
67 .BI \-\-highest\-port " port"
68 ] [
69 .BI \-\-wait " secs"
70 ] [
71 .BI \-\-hexdump
72 ]
73 .\"
74 .SH DESCRIPTION
75 .I darkstat
76 is a packet sniffer that runs as a background process,
77 gathers all sorts of statistics about network usage,
78 and serves them over HTTP.
79
80 All settings are passed on the commandline.
81 .\"
82 .SH OPTIONS
83 .\"
84 .TP
85 .BI \-i " interface"
86 Capture traffic on the specified network interface.
87 This is the only mandatory commandline argument.
88 .\"
89 .TP
90 .BI \-r " file"
91 Instead of capturing live traffic, read it from a
92 .BR pcap (3)
93 capture file.
94 This is only useful for development and benchmarking.
95 The
96 .BI \-r
97 and
98 .BI \-i
99 arguments are mutually exclusive.
100 .\"
101 .TP
102 .BI \-\-snaplen " bytes"
103 How many bytes to capture from the start of each packet.
104 You should not need to specify this;
105 \fIdarkstat\fR will calculate it automatically.
106 .\"
107 .TP
108 .BI \-\-pppoe
109 Don't use this.
110
111 Instead, capture on the tunnel interface that your PPPoE software
112 provides, for example \fBtun0\fR on \fIFreeBSD\fR, \fBpppoe0\fR on
113 \fIOpenBSD\fR or \fINetBSD\fR.
114
115 If you really must, you can capture on an Ethernet interface and pass
116 this argument to have \fIdarkstat\fR decode PPPoE frames and ignore
117 everything else.
118 Make sure you also specify your local address with the \fB\-l\fR
119 argument!
120 .\"
121 .TP
122 .BI \-\-syslog
123 Errors, warnings, and verbose messages will go to \fBsyslog\fR (facility
124 daemon, priority debug) instead of \fBstderr\fR.
125
126 On some systems, these messages end up in \fB/var/log/debug\fR
127 by default.
128 .\"
129 .TP
130 .BI \-\-verbose
131 Produce more verbose debugging messages.
132 .\"
133 .TP
134 .BI \-\-no\-daemon
135 Do not detach from the controlling terminal;
136 stay in the foreground.
137 .\"
138 .TP
139 .BI \-\-no\-promisc
140 Do not use promiscuous mode to capture.
141 Note that an interface may already be in promiscuous mode, or may later
142 enter promiscuous mode, due to circumstances beyond \fIdarkstat\fR's control.
143 If this is a problem, use \fB\-f\fR to specify an appropriate
144 .BR bpf (4)
145 filter.
146 .\"
147 .TP
148 .BI \-\-no\-dns
149 Do not resolve IPs to host names.
150 This can significantly reduce memory footprint on small systems
151 as an extra process is created for DNS resolution.
152 .\"
153 .TP
154 .BI \-\-no\-macs
155 Do not display MAC addresses in the hosts table.
156 .\"
157 .TP
158 .BI \-\-no\-lastseen
159 Do not display the last seen time in the hosts table.
160 .\"
161 .TP
162 .BI \-p " port"
163 Bind the web interface to the specified port.
164 The default is 667.
165 .\"
166 .TP
167 .BI \-b " bindaddr"
168 Bind the web interface to the specified address.
169 The default is to listen on all interfaces.
170 .\"
171 .TP
172 .BI \-\-base " path"
173 .RS
174 Specify the path of the base URL.
175 This can be useful if \fIdarkstat\fR is accessed via a reverse proxy.
176
177 For example, if you use Apache's \fImod_proxy\fR and want to avoid a
178 complicated setup with \fImod_proxy_html\fR (and \fImod_header\fR to unset
179 the \fIAccept-Encoding\fR header), just set the base path to something like
180 \fIstats\fR and use a config similar to the following snippet:
181
182 .IP
183  ProxyPass /stats/ http://localhost:667/stats/
184  ProxyPassReverse /stats/ http://localhost:667/stats/
185 .PP
186
187 The default is \fI/\fR (ie. the root).
188 .RE
189 .\"
190 .TP
191 .BI \-f " filter"
192 Use the specified filter expression when capturing traffic.
193 The filter syntax is beyond the scope of this manual page;
194 please refer to the
195 .BR tcpdump (1)
196 documentation.
197 .\"
198 .TP
199 .BI \-l " network/netmask"
200 Define a "local network" according to the network and netmask addresses.
201 All traffic entering or leaving this network will be graphed, as opposed
202 to the default behaviour of only graphing traffic to and from the local
203 host.
204 .RS
205
206 The rule is that if \fBip_addr & netmask == network\fR,
207 then that address is considered local.
208 See the usage example below.
209 .RE
210 .\"
211 .TP
212 .BI \-\-chroot " dir"
213 Force \fIdarkstat\fR to \fBchroot()\fR into the specified directory.
214 Without this argument, a default directory will be used, which is
215 determined at build time.
216 Usually \fI/var/empty\fR or \fI/var/lib/empty\fR.
217 .RS
218
219 For security reasons, this directory should be empty, and the user that
220 \fIdarkstat\fR is running as should not have write access to it.
221
222 However, if you wish to use \fB\-\-daylog\fR or \fB\-\-export\fR,
223 \fIdarkstat\fR will need write access to the chroot.
224 If you are uncomfortable with the security implications, don't
225 use any functionality that requires write access.
226 .RE
227 .\"
228 .TP
229 .BI \-\-user " username"
230 Force \fIdarkstat\fR to drop privileges to the \fBuid\fR and \fBgid\fR of
231 the specified user.
232 Without this argument, a default value will be used, which is set at
233 build time.
234 Usually \fBnobody\fR.
235 .RS
236
237 For security reasons, this should not be \fBroot\fR.
238 .RE
239 .\"
240 .TP
241 .BI \-\-daylog " filename"
242 .RS
243 Log daily traffic statistics into the named file, relative to the
244 chroot directory.
245 If you wish to use \fB\-\-daylog\fR, you must first specify a
246 \fB\-\-chroot\fR directory, and it must be writeable by the
247 \fIdarkstat\fR user.
248 A writeable chroot has security implications; if you are uncomfortable
249 with this, do not use the \fB\-\-daylog\fR functionality.
250
251 If the daylog argument is not specified, no logging is performed.
252
253 The daylog format is:
254
255 localtime|time_t|bytes_in|bytes_out|pkts_in|pkts_outs
256
257 Lines starting with a # are comments stating when logging started and
258 stopped.
259 .RE
260 .\"
261 .TP
262 .BI \-\-import " filename"
263 Upon starting, import a \fIdarkstat\fR database from the named file,
264 relative to the chroot directory.
265 If you wish to use \fB\-\-import\fR, you must first specify a
266 \fB\-\-chroot\fR directory.
267 If the import is unsuccessful, \fIdarkstat\fR will start with an empty
268 database.
269 .\"
270 .TP
271 .BI \-\-export " filename"
272 On shutdown, or upon receiving SIGUSR1 or SIGUSR2,
273 export the in-memory database
274 to the named file, relative to the chroot directory.
275 If you wish to use \fB\-\-export\fR, you must first specify a
276 \fB\-\-chroot\fR directory, and it must be writeable by the
277 \fIdarkstat\fR user.
278 A writeable chroot has security implications - if you are uncomfortable
279 with this, do not use the \fB\-\-export\fR functionality.
280 .\"
281 .TP
282 .BI \-\-pidfile " filename"
283 .RS
284 Creates a file containing the process ID of \fIdarkstat\fR.
285 This file will be unlinked upon clean shutdown.
286 As with all pidfiles, if \fIdarkstat\fR dies uncleanly, a stale pidfile
287 can be left over.
288
289 For example, start \fIdarkstat\fR with:
290 .IP
291 darkstat \-i fxp0 \-\-chroot /var/run/darkstat \-\-pidfile darkstat.pid
292 .PP
293 And stop with:
294 .IP
295 kill `cat /var/run/darkstat/darkstat.pid`
296 .PP
297 By default,
298 .BR kill (1)
299 will send SIGTERM, which will cause \fIdarkstat\fR to shut down cleanly.
300 .RE
301 .\"
302 .TP
303 .BI \-\-hosts\-max " count"
304 The maximum number of hosts that will be kept in the hosts table.
305 This is used to limit how much accounting data will be kept in memory.
306 The number of
307 .BI \-\-hosts\-max
308 must be greater than
309 .BI \-\-hosts\-keep
310 .\"
311 .TP
312 .BI \-\-hosts\-keep " count"
313 When the hosts table hits
314 .BI \-\-hosts\-max
315 and traffic is seen from a new host, we clean out the hosts table,
316 keeping only the top
317 .BI \-\-hosts\-keep
318 number of hosts, sorted by total traffic.
319 .\"
320 .TP
321 .BI \-\-ports\-max " count"
322 The maximum number of ports that will be tracked for each host.
323 This is used to limit how much accounting data will be kept in memory.
324 The number of
325 .BI \-\-ports\-max
326 must be greater than
327 .BI \-\-ports\-keep
328 .\"
329 .TP
330 .BI \-\-ports\-keep " count"
331 When a ports table fills up, this many ports are kept and the rest are
332 discarded.
333 .\"
334 .TP
335 .BI \-\-highest\-port " port"
336 Ports that are numerically higher than this will not appear in the
337 per-host ports tables, although their traffic will still be accounted
338 for.
339 This can be used to hide ephemeral ports.
340 By default, all ports are tracked.
341 .\"
342 .TP
343 .BI \-\-wait " secs"
344 Don't use this.
345 It's a hack to help victims of \fINetworkManager\fR and similar systems.
346 .RS
347
348 You should start \fIdarkstat\fR after the capture interface has come up.
349 If you can't, specifying the \fB\-\-wait\fR option will make \fIdarkstat\fR
350 sleep up to the specified number of seconds for the interface to become ready.
351 Zero means wait indefinitely.
352 .RE
353 .\"
354 .TP
355 .BI \-\-hexdump
356 Show hex dumps of received traffic.
357 This is only for debugging, and implies \fB\-\-verbose\fR and
358 \fB\-\-no\-daemon\fR.
359 .\"
360 .\" --------------------------------------------------------------------
361 .SH USAGE EXAMPLES
362 To gather statistics on the
363 .I fxp0
364 interface:
365 .IP
366 darkstat \-i fxp0
367 .PP
368 .\"
369 We want to account for traffic on the Internet-facing interface,
370 but only serve web pages to our private local network where we have the
371 IP address 192.168.0.1:
372 .IP
373 darkstat \-i fxp0 \-b 192.168.0.1
374 .PP
375 .\"
376 We want to serve web pages on the standard HTTP port:
377 .IP
378 darkstat \-i fxp0 \-p 80
379 .PP
380 .\"
381 We are on Optus (cable) and don't want to account for the constant ARP
382 traffic we are receiving:
383 .IP
384 darkstat \-i fxp0 \-f "not arp"
385 .PP
386 .\"
387 We only want to account for SSH traffic:
388 .IP
389 darkstat \-i fxp0 \-f "port 22"
390 .PP
391 .\"
392 We don't want to account for traffic between internal IPs:
393 .IP
394 darkstat \-i fxp0 \-f "not (src net 192.168.0 and dst net 192.168.0)"
395 .PP
396 .\"
397 (For a full reference on filter syntax, refer to the
398 .BR tcpdump (1)
399 manpage)
400 .PP
401 .\"
402 We have a network consisting of a gateway server (192.168.1.1) and a few
403 workstations (192.168.1.2, 192.168.1.3, etc.) and we want to graph all
404 traffic entering and leaving the local network, not just the gateway
405 server (which is running \fIdarkstat\fR):
406 .IP
407 darkstat \-i fxp0 \-l 192.168.1.0/255.255.255.0
408 .PP
409 .\"
410 On some systems, we can't capture on a "decoded" interface but
411 only on \fInas0\fR which returns PPPoE encapsulated packets.
412 Do PPPoE decoding, and override the local IP manually since it
413 cannot be automatically detected.
414 Note the /32 netmask:
415 .IP
416 darkstat \-i nas0 \-\-pppoe \-l 192.168.1.1/255.255.255.255
417 .\"
418 .SH SIGNALS
419 To shut
420 .I darkstat
421 down cleanly, send a SIGTERM or SIGINT signal to the
422 .I darkstat
423 parent process.
424 .PP
425 Sending the SIGUSR1 signal will cause \fIdarkstat\fR to empty out its
426 in-memory database.
427 If an \fB\-\-export\fR file was set, it will first save the database to
428 file.
429 Sending SIGUSR2 will save the database without emptying it.
430 .PP
431 .\"
432 .SH FREQUENTLY ASKED QUESTIONS
433 .SS How many bytes does each bar on the graph represent?
434 Hover your mouse cursor over a bar and you should get a tooltip
435 saying exactly how many bytes in and out the bar represents.
436 .\"
437 .SS Why aren't there labels / tics / a scale on the graphs?
438 Because implementing them is hard.
439 And doing so \fIcorrectly\fR, and in a way that works across all
440 browsers, looks pretty much impossible.
441
442 I might attempt it some day.
443 In the meantime, patches would be gladly accepted.
444 .\"
445 .SS Why are the graphs blank?  All the bars are zero.
446 The graphs only show traffic in/out of the local host, which is
447 determined by getting the IP address of the interface you're sniffing
448 on.
449
450 You can use the \fB\-l\fR argument to override the local address for
451 accounting purposes.
452 You can also use it to do accounting for a whole subnet by specifying
453 an appropriate netmask.
454 .\"
455 .SH SEE ALSO
456 .BR tcpdump (1)
457 .\"
458 .SH HISTORY
459 .I darkstat
460 was written in 2001, largely as a result of a certain Australian
461 cable Internet provider introducing a 3GB monthly traffic limit.
462 .\"
463 .SH AUTHORS
464 Emil Mikulic and others. (see the AUTHORS file)
465 .\"
466 .SH WEBSITE
467 http://dmr.ath.cx/net/darkstat/