summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2011-07-01 10:26:10 +0000
committerChristian Grothoff <christian@grothoff.org>2011-07-01 10:26:10 +0000
commitf7ba974a5ec5e63c34834f07b5352b14f5cc68ac (patch)
tree1b49c1f6fadbb91f7bec9bd5432f5902801bfec3 /doc
parent46ac0cea02fe1949d76b86c7a0750f9e7854fef6 (diff)
finishing gnunet-nat-server
Diffstat (limited to 'doc')
-rw-r--r--doc/man/gnunet-nat-server.135
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/man/gnunet-nat-server.1 b/doc/man/gnunet-nat-server.1
new file mode 100644
index 000000000..e8f47b75c
--- /dev/null
+++ b/doc/man/gnunet-nat-server.1
@@ -0,0 +1,35 @@
+.TH GNUNET\-NAT\-SERVER 1 "Jul 1, 2011" "GNUnet"
+
+.SH NAME
+gnunet\-nat\-server \- help GNUnet setup test network setup with NAT
+
+.SH SYNOPSIS
+.B gnunet\-nat\-server
+.RI [ options ] PORT
+.br
+
+.SH DESCRIPTION
+
+Normal GNUnet end-users should not concern themselves with gnunet\-nat\-server. In fact, distributions are encouraged to consider not shipping it at all. Running gnunet\-nat\-server's is similar to running hostlist servers: it is a special service to the community with special requirements and no benefit to those running the service.
+
+This program will listen on the specified PORT for incoming requests to test a peer's network connectivity. Incoming requests can ask it to connect to a given IPv4 address (and port) using TCP or UDP and to send a 2-byte test message using the specified address. The program can also be asked to send a "fake" ICMP response message to a given IPv4 address (for autonomous NAT traversal \-\-\- see the description in the respective research paper).
+
+The idea is that gnunet\-nat\-server will be run on some trusted hosts with unrestricted connectivity to allow GNUnet users to test their network configuration. As written, the code allows any user on the Internet to cause the gnunet\-nat\-server to send 2-bytes of arbitrary data to any TCP or UDP port at any address. We believe that this is generally harmless.
+
+When runnung gnunet\-nat\-server, make sure to use a configuration that disables most NAT options but enables 'enable_nat_client' and sets 'internal_address' to the global IP address of your local host. Also, the gnunet\-helper\-nat\-client should be installed locally and run with root priviledges (SUID), otherwise the gnunet\-nat\-server will not work properly.
+
+Note that gnunet\-nat\-server could be run via gnunet\-arm but typically is not. Also, the name of the host and port that gnunet\-nat\-server is run on should be specified in the NATSERVER option in the [setup] section of the configuration file of hosts that are supposed to autoconfigure with this server.
+
+
+.SH OPTIONS
+
+.TP
+.IP "\-c FILENAME, \-\-config=FILENAME"
+Use the configuration file FILENAME.
+
+.SH BUGS
+Report bugs by using Mantis <https://gnunet.org/mantis/> or by sending electronic mail to <gnunet\-developers@gnu.org>
+
+.SH SEE ALSO
+gnunet\-service\-transport(1)
+