[tor-bugs] #19209 [Core Tor/Tor]: torrc: Comments Need Clarifying

[Tor Bug Tracker & Wiki]

#19209: torrc: Comments Need Clarifying
------------------------------+--------------------------
     Reporter:  huertanix     |      Owner:
         Type:  defect        |     Status:  new
     Priority:  Low           |  Milestone:
    Component:  Core Tor/Tor  |    Version:  Tor: 0.2.7.6
     Severity:  Trivial       |   Keywords:  torrc
Actual Points:                |  Parent ID:
       Points:                |   Reviewer:
      Sponsor:                |
------------------------------+--------------------------
 I've written a guide on how to set up a Tor relay, but I ran into some
 confusion from readers on some initial drafts on a few areas which I
 clarified on the final guide (see: https://motherboard.vice.com/read/how-
 you-can-help-make-tor-faster-for-10-a-month). However, it'd be great to
 see some clarifications in the comments in /etc/tor/torrc.

 Specifically...

 Update:
 ## Uncomment this if you run more than one Tor relay, and add the identity
 ## key fingerprint of each Tor relay you control, even if they're on
 ## different networks. Include the "$" with each key ID.

 Update:
 ## Don't forget the < and >.
 #ContactInfo Random Person <nobody AT example dot com>

 Update:
 ## A handle for your relay, so people don't have to refer to it by key.
 ## Only alphanumeric characters, A-Z, a-z, 0-1 allowed. No unicode, no
 emoji.

 I assume this might be easy, but that it might trigger some package
 management systems to bug the user into asking which config they want if
 they already have the tor package installed.

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/19209>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online