polished build procedure
[rrq/hourglass.git] / howto.adoc
1 Hourglass Howto
2 ===============
3
4 This is a collection of programs (scripts) that implement an automated
5 network access control policy. The general idea is to declare the open
6 and close times for each weekday as well as a time limit of
7 accumulated usage during the open time.
8
9 For example, that the network should be open between 3pm and 8pm and
10 allow for 2 hours of usage within those times.
11
12 The Hourglass system includes four components:
13
14  1. User interface for policy setting
15  2. Continuous determination of network traffic (usage or not)
16  3. Continuous determination of control action 
17  4. Control actuator
18
19 .Dependencies
20
21 newlisp::
22 ipset::
23 iptables::
24
25 Hourglass User Interface
26 ------------------------
27
28 This software is an HTTP service aimed at editing the Hourglass
29 control policy, held in the +control.dat+ file, as well as the control
30 override setting, in file +control-extra.dat+, whilst also showing
31 current usage measure from file +usage.dat+.
32
33 The server +hourglass-web+ is first installed with
34 ----
35 $ ./hourglass-web install
36 ----
37 That installation sets up a small +www+ sub directory with "CGI"
38 scripting to provide the Hourglass User Interface on port 1070.
39
40 Hourglass Network Traffic Capture
41 ---------------------------------
42
43 Hourglass Policy Bot
44 --------------------
45
46 Hourglass Control Actuator
47 --------------------------