document client.port and introducer.port files

[davidsarah]

On 13/04/12 01:23, sickness wrote on tahoe-dev:

On Fri, Apr 13, 2012 at 04:07:12AM +0400, Vladimir Arseniev wrote:

On 12-04-12 04:53 PM, Marko Niinimaki wrote:

what tcp ports do I need to open in order to run Tahoe nodes and the introducer on different networks?

They're in ~/.tahoe/client.port and ~/.tahoe/introducer.port.

iirc those files are now deprecated, the tahoe.cfg config file has to hold the port numbers instead [...]

They're not deprecated; they will be used to determine the port if tub.port and tub.location are not set. However, they aren't documented.

[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?

[zooko]

Looks closable to me, but let's see what the opener of the ticket, davidsarah, thinks.

[davidsarah]

OK, looks like I just missed that doc.