fixes; first version
[rrq/hourglass.git] / sitetool / tooltips.txt
1 listener.net is the first three quads of the IP address to use for the
2 "listener network", with a final component being +1+ for the host and
3 +2+ for the listener daemon. The listener daemon acts as a virtual
4 host and is set up vie +setup.sh+ to receive copies of some network
5 packets for the purpose of measuring activity.
6 ---
7 listener.ports are the port numbers of concern, separated by
8 whitespace or comma, towards activity detection. Only packets to these
9 ports will be considered.
10 ---
11 listener.activity.dir is the directory in which the activity files are
12 stored. The Hourglass listener daemon operates continuously and
13 populates one measure per day with a full sequence of (roughly)
14 per-minute packet count measures.
15 ---
16 listener.tap is the name to use for the network tap that is set up to
17 be the interface for the virtual listener host.
18 ---
19 control.action is the name of the control action script to use.
20 Currently only +ipset-control.lsp+ is available.
21 ---
22 control.dat is the pathname for the policy file. The content is a
23 newlisp format expression; a list with sublists to represent the
24 desired control policy. It is typically generated by the Hourglass web
25 service and then used by the Hourglass control bot.
26 ---
27 control.net is the IP/bits code of the network to be controlled.
28 ---
29 control.extra.dat is the pathname for the ad-hoc time override. This
30 is a pair of numbers that define an overriding "network open" time
31 period of that many hours and minutes starting at the modification
32 time of the file itself
33 ---
34 control.usage.dat the filename to use for the usage state. This is a
35 newlisp expression of the current hours and minutes of usage. The file
36 is generated by the Hourglass policy bot to be used and displayed via
37 the Hourglass web service.
38 ---
39 control.usage.tmp is the temporary filename to use for the usage state
40 update. The state update is written to this file which then is renamed
41 as per +control.usage.dat+; this process avoids the risk of the
42 Hourglass web service accessing an incompletely written file.
43 ---
44 control.activity.gap is how many minutes of low activity is needed for
45 identifying an idle period.
46 ---
47 control.activity.clip is the count measure limit for low activity.
48 ---
49 ipset.bin is the pathname for the +ipset+ binary.
50 ---
51 ipset.table is the name of the ipset set.
52 ---
53 wui.port is the port for the HTTP service.
54 ---
55 wui.passwd is the pathname for the file of authorizable users. Each
56 line consists of the base64 encoding of a "user:password" pair as is
57 used in the HTTP Basic Authorization scheme.
58 ---
59 libc is the pathname for the libc6 dynamic library.
60 ---
61 tundev is the pathname for the tuntap device generator.