From 594b3eeb62b8e7b29e35400f7e089ca763a0c59d Mon Sep 17 00:00:00 2001 From: Logan007 Date: Wed, 26 Aug 2020 13:49:15 +0545 Subject: [PATCH 1/5] premiered faq document --- doc/Faq.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 doc/Faq.md diff --git a/doc/Faq.md b/doc/Faq.md new file mode 100644 index 0000000..2c3872f --- /dev/null +++ b/doc/Faq.md @@ -0,0 +1,34 @@ +# n2n Frequently Asked Questions + +## Supernode + +### I want to setup a supernode that only I can use. Perhaps even password protected? + +Please think of the community-name as password and start the supernode with the `-c ` parameter where the `` is the path to a simple text file containing a single line with the name of your secret community. It will be the only community allowed. Only edge nodes from that community can join (`-c ` at the edge). + +If you additionally want to prevent open transmission of your secret community name via the network, **all** edge nodes should use `-H` command line option for header encryption. + +Also, please see the community.list file for advanced use of that file. + +Beyond this access barrier you may want to use payload encryption `-A_` at the edges. Only the edges – not the supernode – are able to decipher the payload data. So, even if anyone would be able to break the access barrier to the supernode, the payload remains protected by the payload crypto, see [this document](https://github.com/ntop/n2n/blob/dev/doc/Crypto.md) for details. + +### Can I get a list of connected edge node and their community and source IP from the supernode? + +The supernode provides basic information via its localhost udp management port. It defaults to 5645. + +You can request that information by just sending a new line, i.e. pressing [ENTER] key, running the following command (localhost only): + +`netcat -u localhost 5645` + + +## Edge + +### How can I know if p2p is successfully established? + +The edge also offer a management port at which it provides some information about connected _peers_, i.e. allowing a peer-to-peer connection, and _pending peers_ whose connections are forwarded through the supernode. + +The edge's management port defaults 5644. Connecting using the following command + +`netcat -u localhost 5644` + +answers every new line, i.e. press [ENTER] key, with the current information. The edge even understands some simple commands, try `help`. From 4c7966b969517d63d28fe5635cf1736f4223a306 Mon Sep 17 00:00:00 2001 From: Logan oos Even <46396513+Logan007@users.noreply.github.com> Date: Wed, 26 Aug 2020 13:51:54 +0545 Subject: [PATCH 2/5] updated faq doc grammar --- doc/Faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/Faq.md b/doc/Faq.md index 2c3872f..4140c69 100644 --- a/doc/Faq.md +++ b/doc/Faq.md @@ -23,7 +23,7 @@ You can request that information by just sending a new line, i.e. pressing [ENTE ## Edge -### How can I know if p2p is successfully established? +### How can I know if peer-to-peer connection has successfully been established? The edge also offer a management port at which it provides some information about connected _peers_, i.e. allowing a peer-to-peer connection, and _pending peers_ whose connections are forwarded through the supernode. From 396a590299a4d72bfe3dcf0df4dd1f5a43c836ae Mon Sep 17 00:00:00 2001 From: Logan007 Date: Thu, 27 Aug 2020 15:33:02 +0545 Subject: [PATCH 3/5] updatetd faq --- doc/Faq.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/doc/Faq.md b/doc/Faq.md index 4140c69..60c3e1a 100644 --- a/doc/Faq.md +++ b/doc/Faq.md @@ -1,7 +1,9 @@ # n2n Frequently Asked Questions + ## Supernode + ### I want to setup a supernode that only I can use. Perhaps even password protected? Please think of the community-name as password and start the supernode with the `-c ` parameter where the `` is the path to a simple text file containing a single line with the name of your secret community. It will be the only community allowed. Only edge nodes from that community can join (`-c ` at the edge). @@ -12,23 +14,25 @@ Also, please see the community.list file for advanced use of that file. Beyond this access barrier you may want to use payload encryption `-A_` at the edges. Only the edges – not the supernode – are able to decipher the payload data. So, even if anyone would be able to break the access barrier to the supernode, the payload remains protected by the payload crypto, see [this document](https://github.com/ntop/n2n/blob/dev/doc/Crypto.md) for details. + ### Can I get a list of connected edge node and their community and source IP from the supernode? -The supernode provides basic information via its localhost udp management port. It defaults to 5645. +The supernode provides basic information via its localhost udp management port. It defaults to 5645 and can be changed using supernode's `-t` command line option. -You can request that information by just sending a new line, i.e. pressing [ENTER] key, running the following command (localhost only): +You can request the current status by just sending a new line, i.e. pressing [ENTER] key, running the following command (localhost only) `netcat -u localhost 5645` + ## Edge ### How can I know if peer-to-peer connection has successfully been established? -The edge also offer a management port at which it provides some information about connected _peers_, i.e. allowing a peer-to-peer connection, and _pending peers_ whose connections are forwarded through the supernode. +The edge also offers a local udp management port at which it provides some information about connected _peers_ allowing a peer-to-peer connection, and _pending peers_ whose connections are forwarded through the supernode. -The edge's management port defaults 5644. Connecting using the following command +The edge's management port defaults to 5644 and can be changed using edge's `-t` command line option. Connecting using the following command (localhost only) `netcat -u localhost 5644` -answers every new line, i.e. press [ENTER] key, with the current information. The edge even understands some simple commands, try `help`. +answers every new line, i.e. pressing [ENTER] key, with current information. The edge even understands some simple commands, try `help`. From 3d47c9bff83a9b9b40b4d766b774f7f53de8f006 Mon Sep 17 00:00:00 2001 From: Logan007 Date: Thu, 27 Aug 2020 18:25:49 +0545 Subject: [PATCH 4/5] linked to faq --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fe53a86..d575447 100644 --- a/README.md +++ b/README.md @@ -112,9 +112,11 @@ You can contribute to n2n in various ways: For details about the internals of n2n check out [Hacking guide](https://github.com/ntop/n2n/blob/dev/doc/Hacking.md). -## Related Projects +## Further Readings and Related Projects -Here is a list of third-party projects connected to this repository. +Answers to frequenty asked questions can be found in our [FAQ document](https://github.com/ntop/n2n/blob/dev/doc/Faq.md). + +Here is a list of third-party projects connected to this repository: - Collection of pre-built binaries for Windows: [lucktu](https://github.com/lucktu/n2n) - n2n for Android: [hin2n](https://github.com/switch-iot/hin2n) From 6930ef010b6f27ee97af57089d00546b12c0bce6 Mon Sep 17 00:00:00 2001 From: Logan007 Date: Thu, 27 Aug 2020 18:27:21 +0545 Subject: [PATCH 5/5] linked to faq --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d575447..250ddaa 100644 --- a/README.md +++ b/README.md @@ -114,7 +114,7 @@ For details about the internals of n2n check out [Hacking guide](https://github. ## Further Readings and Related Projects -Answers to frequenty asked questions can be found in our [FAQ document](https://github.com/ntop/n2n/blob/dev/doc/Faq.md). +Answers to frequently asked questions can be found in our [FAQ document](https://github.com/ntop/n2n/blob/dev/doc/Faq.md). Here is a list of third-party projects connected to this repository: