Merge pull request #388 from Logan007/faq

created faq

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 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:
 
 - Collection of pre-built binaries for Windows: [lucktu](https://github.com/lucktu/n2n)
 - n2n for Android: [hin2n](https://github.com/switch-iot/hin2n)

doc/Faq.md

@@ -0,0 +1,38 @@
+# 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 <community file>` parameter where the `<community file>` 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 <community name>` 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 and can be changed using supernode's `-t` command line option.
+
+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 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 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. pressing [ENTER] key, with current information. The edge even understands some simple commands, try `help`.