doc/man/gnunet-nat-server.1

   1 .TH GNUNET-NAT-SERVER 1 "February 25, 2012" "GNUnet"
   2 .SH NAME
   3 gnunet\-nat\-server \- help GNUnet setup test network setup with NAT
   4 .SH SYNOPSIS
   5 .B gnunet\-nat\-server
   6 .RI [ options ]
   7 .RI PORT
   8 .SH DESCRIPTION
   9 Normal GNUnet end-users should not concern themselves with
  10 gnunet\-nat\-server.  In fact, distributions are encouraged to
  11 consider not shipping it at all.  Running gnunet\-nat\-server's is
  12 similar to running hostlist servers: it is a special service to the
  13 community with special requirements and no benefit to those running
  14 the service.
  15 .PP
  16 This program will listen on the specified PORT for incoming requests
  17 to test a peer's network connectivity.  Incoming requests can ask it
  18 to connect to a given IPv4 address (and port) using TCP or UDP and to
  19 send a 2-byte test message using the specified address.  The program
  20 can also be asked to send a "fake" ICMP response message to a given
  21 IPv4 address (for autonomous NAT traversal \-\-\- see the description
  22 in the respective research paper).
  23 .PP
  24 The idea is that gnunet\-nat\-server will be run on some trusted hosts
  25 with unrestricted connectivity to allow GNUnet users to test their
  26 network configuration.  As written, the code allows any user on the
  27 Internet to cause the gnunet\-nat\-server to send 2-bytes of arbitrary
  28 data to any TCP or UDP port at any address.  We believe that this is
  29 generally harmless.
  30 .PP
  31 When running gnunet\-nat\-server, make sure to use a configuration
  32 that disables most NAT options but enables 'enable_nat_client' and
  33 sets 'internal_address' to the global IP address of your local host.
  34 Also, the gnunet\-helper\-nat\-client should be installed locally and
  35 run with root privileges (SUID), otherwise the gnunet\-nat\-server
  36 will not work properly.
  37 .PP
  38 Note that gnunet\-nat\-server could be run via gnunet\-arm but
  39 typically is not.  Also, the name of the host and port that
  40 gnunet\-nat\-server is run on should be specified in the NATSERVER
  41 option in the [setup] section of the configuration file of hosts that
  42 are supposed to autoconfigure with this server.
  43 .SH OPTIONS
  44 .IP "\-c FILENAME,  \-\-config=FILENAME"
  45 Use the configuration file FILENAME.
  46 .SH BUGS
  47 Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending
  48 electronic mail to <gnunet\-developers@gnu.org>
  49 .SH SEE ALSO
  50 gnunet\-transport(1)
  51 .PP
  52 The full documentation for
  53 .B gnunet
  54 is maintained as a Texinfo manual.
  55 If the
  56 .B info
  57 and
  58 .B gnunet
  59 programs are properly installed at your site, the command
  60 .IP
  61 .B info gnunet
  62 .PP
  63 should give you access to the complete handbook,
  64 .IP
  65 .B info gnunet-c-tutorial
  66 .PP
  67 will give you access to a tutorial for developers.
  68 .PP
  69 Depending on your installation, this information is also
  70 available in
  71 \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).