diff --git a/README.md b/README.md index 7894244..de45402 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ [![Build Status](https://travis-ci.org/ntop/n2n.png?branch=dev)](https://travis-ci.org/ntop/n2n) + # n2n n2n is a light VPN software which makes it easy to create virtual networks bypassing intermediate firewalls. @@ -13,6 +14,7 @@ A virtual network shared between multiple edge nodes in n2n is called a _communi n2n tries to establish a direct peer-to-peer connection via udp between the edge nodes when possible. When this is not possible (usually due to special NAT devices), the supernode is also used to relay the packets. + ## Quick Setup Some Linux distributions already provide n2n as a package so a simple `sudo apt install n2n` will do the work. Alternatively, up-to-date packages for most distributions are available on [ntop repositories](http://packages.ntop.org/). @@ -33,6 +35,7 @@ Now the two hosts can ping each other. **IMPORTANT** It is strongly advised to choose a custom community name (`-c`) and a secret encryption key (`-k`) in order to prevent other users from connecting to your computer. For the privacy of your data sent and to reduce the server load of `supernode.ntop.org`, it is also suggested to set up a custom supernode as explained below. + ## Setting up a Custom Supernode You can create your own infrastructure by setting up a supernode on a public server (e.g. a VPS). You just need to open a single port (1234 in the example below) on your firewall (usually `iptables`). @@ -47,9 +50,10 @@ You can create your own infrastructure by setting up a supernode on a public ser Now the supernode service should be up and running on port 1234. On your edge nodes you can now specify `-l your_supernode_ip:1234` to use it. All the edge nodes must use the same supernode. + ## Manual Compilation -On linux, compilation from source is straight forward: +On Linux, compilation from source is straight forward: ```sh ./autogen.sh @@ -64,7 +68,7 @@ Some parts of the code significantly benefit from compiler optimizations and pla For Windows, MacOS and general building options, please check out [Building documentation](doc/Building.md) for compilation and running. -**IMPORTANT** It is generally recommended to use the [latest stable release](https://github.com/ntop/n2n/releases). Please note that the current _dev_ branch usually is not guaranteed to be backward compatible neither with the latest stable release nor with previous _dev_ states. On the other hand, if you dare to try the bleeding edge features, you are encouraged to compile from _dev_ – just keep track of sometimes rapidly occuring changes. Feedback in the _Issues_ section is appreciated. +**IMPORTANT** It is generally recommended to use the [latest stable release](https://github.com/ntop/n2n/releases). Please note that the current _dev_ branch usually is not guaranteed to be backward compatible neither with the latest stable release nor with previous _dev_ states. On the other hand, if you dare to try bleeding edge features, you are encouraged to compile from _dev_ – just keep track of sometimes rapidly occuring changes. Feedback in the _Issues_ section is appreciated. ## Security Considerations @@ -99,6 +103,7 @@ You can contribute to n2n in various ways: For details about the internals of n2n check out the [Hacking guide](https://github.com/ntop/n2n/blob/dev/doc/Hacking.md). + ## Further Readings and Related Projects Answers to frequently asked questions can be found in our [FAQ document](https://github.com/ntop/n2n/blob/dev/doc/Faq.md). @@ -112,4 +117,4 @@ Here is a list of third-party projects connected to this repository: --- -(C) 2007-2020 - ntop.org and contributors +(C) 2007-2021 - ntop.org and contributors