diff --git a/README.md b/README.md new file mode 100644 index 0000000..e198e76 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# masterproef_v2 + +This POC aims to create an IPv6 overlay network compeletly writting in Rust. The overlay network uses some of the core principles of the Babel routing protocol (https://www.irif.fr/~jch/software/babel/). Each node that joins the overlay network will receive an overlay network IP in the 200::/7 range. + +## Installation + +```sh +git clone git@github.com:vanheesmaxime/masterproef_v2.git +# in case of an exisiting route to 200::/7, it should be deleted in order to run the application +ip r del 200::/7 +``` + +## Usage example +In this example setup we create a small overlay network on 5 different virtual machines that looks like this: + + +``` ++----------+ +----------+ +--------+ +| node 1 |--------| node 2 |--------| node 3 | ++----------+ +----------+ +--------+ + | | + | +--------+ +-------+ | + +---| node 4 |--------| node 5|-----+ + +--------+ +-------+ +``` +To create this setup, run the following commands: + +```sh +# node 1 +cargo run +# node 2 +cargo run -- -p +# node 3 +cargo run -- -p +# node 4 +cargo run -- -p +# node 5 +cargo run -- -p -p +``` + +