From cbb49604c5e8c960c857699e870adefad7e7035f Mon Sep 17 00:00:00 2001 From: Felix Richter Date: Fri, 27 May 2011 23:40:58 +0200 Subject: added introduction to retiolum please add more documentation --- modules/retiolum/README | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 modules/retiolum/README (limited to 'modules') diff --git a/modules/retiolum/README b/modules/retiolum/README new file mode 100644 index 00000000..9b9725f2 --- /dev/null +++ b/modules/retiolum/README @@ -0,0 +1,29 @@ +Retiolum Darknet Module for Krebs +======================== + +Enter the darknet with the help of tinc retiolum + +Getting Started +------------- +to get you started, check out scripts/tinc_setup/README + +1. the first step you will need to do is grab a binary copy of tinc via your +packet manager, build it yourself or place all your hope into the build +script of your distribution. +2. after doing that you might want to run the scripts/tinc_setup/install.sh +script to write all the configuration files and private/public keys. +This installation is somewhat interactive so be sure not to fuck shit up. + +Other cool stuff +--------------- +in bin/ there are some cool scripts which are partly needed and partly +totally unnecessary to work with retiolum. + +As all the scripts are not too horribly long, be sure to use +`cat bin/SCRIPTNAME` to get an understanding of what they do + +besides that in scripts/ there are 3 more scripts which perform pretty +sophisticated tasks like finding instances via multicast or writing graphs +of the current retiolum network. Try them if you dare :) + + -- cgit v1.2.3