From: Ralph Ronnquist <ralph.ronnquist@gmail.com>
Date: Sat, 1 Jan 2022 11:05:34 +0000 (+1100)
Subject: started instructions
X-Git-Tag: 0.1~31
X-Git-Url: https://git.rrq.au/?a=commitdiff_plain;h=dcb7a638fe8fd468981fdb9cada763f542f4cde8;p=rrq%2Fhourglass.git

started instructions
---

diff --git a/howto.adoc b/howto.adoc
new file mode 100644
index 0000000..e0c25cf
--- /dev/null
+++ b/howto.adoc
@@ -0,0 +1,40 @@
+Hourglass Howto
+===============
+
+This is a collection of programs (scripts) that implement an automated
+network access control policy. The general idea is to declare the open
+and close times for each weekday as well as a time limit of
+accumulated usage during the open time.
+
+For example, that the network should be open between 3pm and 8pm and
+allow for 2 hours of usage within those times.
+
+The Hourglass system includes four components:
+
+ 1. User interface for policy setting
+ 2. Continuous determination of network traffic (usage or not)
+ 3. Continuous determination of control action 
+ 4. Control actuator
+
+.Dependencies
+
+newlisp::
+ipset::
+iptables::
+
+Hourglass User Interface
+------------------------
+
+This software is an HTTP service aimed at editing the Hourglass
+control policy, held in the +control.dat+ file, as well as the control
+override setting, in file +control-extra.dat+, whilst also showing
+current usage measure from file +usage.dat+.
+
+Hourglass Network Traffic Capture
+---------------------------------
+
+Hourglass Policy Bot
+--------------------
+
+Hourglass Control Actuator
+--------------------------