Opened 10 years ago

Closed 10 years ago

Last modified 8 years ago

#1993 closed defect (implemented)

Documentation of BridgeRelay and PublishServerDescriptor is incorrect

Reported by: rransom Owned by:
Priority: Medium Milestone: Tor: 0.2.2.x-final
Component: Core Tor/Tor Version:
Severity: Keywords: tor-relay
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:


The descriptions of the BridgeRelay and PublishServerDescriptor options in the tor(1) man page are no longer correct.

  • BridgeRelay is not ‘Usually used in combination with PublishServerDescriptor’ anymore, because the PublishServerDescriptor option is not in the sample torrc in the Tor distribution.
  • The main effect of the BridgeRelay option is now to cause a relay to publish a bridge descriptor to the bridge authority (rather than a relay descriptor to the public directory authorities), not to influence ‘how the relay will cache and serve directory information’.
  • Based on the syntax specified for PublishServerDescriptor, it appears to control publication of all things called descriptors -- not just relay descriptors, as the documentation suggests, but also bridge descriptors and hidden service descriptors.
  • In particular, the ‘hidserv’ flag to PublishServerDescriptor appears to be considered even for Tor instances that do not define ORPort.

Child Tickets

Change History (4)

comment:2 Changed 10 years ago by nickm

Resolution: implemented
Status: newclosed

Applied with additional re-clarification on PublishServerDescriptor. We want to be clear that if you're running as a pure client, you don't publish anything at all, so you have no reason to set PublishServerDescriptor.

comment:3 Changed 8 years ago by nickm

Keywords: tor-relay added

comment:4 Changed 8 years ago by nickm

Component: Tor RelayTor
Note: See TracTickets for help on using tickets.