[tahoe-lafs-trac-stream] [tahoe-lafs] #1718: document client.port and introducer.port files

[tahoe-lafs]

#1718: document client.port and introducer.port files
-------------------------------+-----------------------
     Reporter:  davidsarah     |      Owner:  marlowe
         Type:  defect         |     Status:  new
     Priority:  normal         |  Milestone:  undecided
    Component:  documentation  |    Version:  1.9.1
   Resolution:                 |   Keywords:  docs
Launchpad Bug:                 |
-------------------------------+-----------------------

Comment (by marlowe):

 Actually they are documented in docs/configuration.rst:

 "``tub.port = (integer, optional)``

     This controls which port the node uses to accept Foolscap connections
     from other nodes. If not provided, the node will ask the kernel for
 any
     available port. The port will be written to a separate file (named
     ``client.port`` or ``introducer.port``), so that subsequent runs will
     re-use the same port.

 ``tub.location = (string, optional)``

     In addition to running as a client, each Tahoe-LAFS node also runs as
 a
     server, listening for connections from other Tahoe-LAFS clients. The
 node
     announces its location by publishing a "FURL" (a string with some
     connection hints) to the Introducer. The string it publishes can be
 found
     in ``BASEDIR/private/storage.furl`` . The ``tub.location``
 configuration
     controls what location is published in this announcement.

     If you don't provide ``tub.location``, the node will try to figure out
 a
     useful one by itself, by using tools like "``ifconfig``" to determine
 the
     set of IP addresses on which it can be reached from nodes both near
 and
     far.  It will also include the TCP port number on which it is
 listening
     (either the one specified by ``tub.port``, or whichever port was
 assigned
     by the kernel when ``tub.port`` is left unspecified).

     You might want to override this value if your node lives behind a
     firewall that is doing inbound port forwarding, or if you are using
 other
     proxies such that the local IP address or port number is not the same
 one
     that remote clients should use to connect. You might also want to
 control
     this when using a Tor proxy to avoid revealing your actual IP address
     through the Introducer announcement."

 Anything else needed to be added or can I close the ticket?

-- 
Ticket URL: <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1718#comment:2>
tahoe-lafs <https://tahoe-lafs.org>
secure decentralized storage