README

01/2013: This project is now hosted at BitBucket because Github decided to disable downloads. https://bitbucket.org/ra_/tor-gateway



######################
#   Tor gateway VM   #
######################

Table of contents:
 (a) How to use
 (b) build.sh
 (c) patches
 (d) overlay
 (e) TODO
 (f) LICENSE


(a) How to use:
Run the build.sh script explained below without any arguments. Take the resulting OVA file, import it in VirtualBox and you are ready to run the Tor gateway VM.

 
(b) build.sh:
This script creates the disk image for VirtualBox based on the OpenWRT source code and OpenWRT ImageBuilder.
It takes the following arguments:
  -) clean	cleans all temporary and downloaded files
  -) debug	build with lots of debugging output
  -) help	shows the help
If run without arguments it will create the disk image first and will then create the VirtualBox image.


(c) patches:
This directory contains two subdirectories "imagebuilder" and "source". All patches in the imagebuilder-directory will be applied before running the OpenWRT image creation process while the patches in the source-directory will be applied before compiling packages from source. 


(d) overlay:
At the end of the OpenWRT image creation process the content of this directory will be copied to the image directory structure and therefor add or overwrite files.


(e) TODO:
List of tasks that are known to be not implemented yet.


(f) LICENSE:
All code by this project is licensed under the GPLv2, if not stated otherwise.