summaryrefslogtreecommitdiffstats
path: root/retiolum/scripts/adv_graphgen/USAGE.md
diff options
context:
space:
mode:
authormakefu <github@syntax-fehler.de>2014-01-14 01:11:00 +0100
committermakefu <github@syntax-fehler.de>2014-01-14 01:11:00 +0100
commitf975f5290e9738229cd0d08d56263fb666e800dc (patch)
treeb3bb1d2cea3759d751af22c143db63132f2c2ee9 /retiolum/scripts/adv_graphgen/USAGE.md
parent849fc0a0542ca985acd3edf1071ff49fe77492b6 (diff)
adv_graphgen: add usage, this should clear some things up
Diffstat (limited to 'retiolum/scripts/adv_graphgen/USAGE.md')
-rw-r--r--retiolum/scripts/adv_graphgen/USAGE.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/retiolum/scripts/adv_graphgen/USAGE.md b/retiolum/scripts/adv_graphgen/USAGE.md
new file mode 100644
index 00000000..2c2c3833
--- /dev/null
+++ b/retiolum/scripts/adv_graphgen/USAGE.md
@@ -0,0 +1,27 @@
+# Example usage
+
+# High Level
+
+ # creates all graphs with predefined paths (see source code of this script)
+ ./all_the_graphs.sh
+
+ # create anonymized graphs to /tmp
+ ./anonytize.sh /tmp
+
+ # create full detail graphs to /var/www/graph.retiolum
+ ./sanitize.sh /var/ww/graph.retiolum
+
+ # return currently availabe supernodes
+ tinc_stats/Supernodes.py
+
+# Low Level
+
+ # returns the current tinc graph as json
+ tinc_stats/Log2JSON.py
+
+ # adds GEOIP information to the json file
+ tinc_stats/Log2JSON.py | tinc_stats/Geo.py
+
+ # creates a grapviz file from current graph, pipes into a timpfile
+ tinc_stats/Log2JSON.py | tinc_stats/Graph.py > /tmp/out.graphviz
+