[tor-commits] [tor/master] Note contactinfo and myfamily as required in more places

[nickm at torproject.org]

commit 4c651b8c0414f1de5db87e9255b80f401a63263e
Author: Nick Mathewson <nickm at torproject.org>
Date:   Wed Dec 20 11:10:14 2017 -0500

    Note contactinfo and myfamily as required in more places
    
    Includes a sentence from cypherpunks; for ticket 24526.
---
 changes/bug24526                    |  4 ++++
 doc/tor.1.txt                       | 13 +++++++++++--
 src/config/torrc.minimal.in-staging |  6 ++++++
 src/config/torrc.sample.in          |  6 ++++++
 4 files changed, 27 insertions(+), 2 deletions(-)

diff --git a/changes/bug24526 b/changes/bug24526
new file mode 100644
index 000000000..4d69defa9
--- /dev/null
+++ b/changes/bug24526
@@ -0,0 +1,4 @@
+  o Documentation:
+    - Document that operators who run more than one relay or bridge are
+      expected to set MyFamily and ContactInfo correctly. Closes ticket
+      24526.
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index a319aa938..aedc1ad20 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -1703,7 +1703,12 @@ is non-zero):
     descriptors containing these lines and that Google indexes them, so
     spammers might also collect them. You may want to obscure the fact
     that it's an email address and/or generate a new address for this
-    purpose.
+    purpose. +
+ +
+    ContactInfo **must** be set to a working address if you run more than one
+    relay or bridge.  (Really, everybody running a relay or bridge should set
+    it.)
+
 
 [[ExitRelay]] **ExitRelay** **0**|**1**|**auto**::
     Tells Tor whether to run as an exit relay.  If Tor is running as a
@@ -1831,7 +1836,11 @@ is non-zero):
     compromise its concealment. +
  +
     When listing a node, it's better to list it by fingerprint than by
-    nickname: fingerprints are more reliable.
+    nickname: fingerprints are more reliable. +
+ +
+    MyFamily **must** be set correctly if you run more than one relay or
+    bridge. (That is, every relay should list all the others as described
+    above.)
 
 [[Nickname]] **Nickname** __name__::
     Set the server's nickname to \'name'. Nicknames must be between 1 and 19
diff --git a/src/config/torrc.minimal.in-staging b/src/config/torrc.minimal.in-staging
index 4fede6dcf..90f91e5cb 100644
--- a/src/config/torrc.minimal.in-staging
+++ b/src/config/torrc.minimal.in-staging
@@ -132,6 +132,9 @@
 ## spammers might also collect them. You may want to obscure the fact that
 ## it's an email address and/or generate a new address for this purpose.
 ## Notice that "<" and ">" are recommended.
+##
+## If you are running multiple relays, you MUST set this option.
+##
 #ContactInfo Random Person <nobody AT example dot com>
 ## You might also include your PGP or GPG fingerprint if you have one.
 ## Use the full fingerprint, not just a (short) KeyID: KeyIDs are easy
@@ -161,6 +164,9 @@
 ## See https://www.torproject.org/docs/faq#MultipleRelays
 ## However, you should never include a bridge's fingerprint here, as it would
 ## break its concealability and potentially reveal its IP/TCP address.
+##
+## If you are running multiple relays, you MUST set this option.
+##
 #MyFamily $keyid,$keyid,...
 
 ## Uncomment this if you want your relay to allow IPv6 exit traffic.
diff --git a/src/config/torrc.sample.in b/src/config/torrc.sample.in
index 865e9f660..4e183478e 100644
--- a/src/config/torrc.sample.in
+++ b/src/config/torrc.sample.in
@@ -136,6 +136,9 @@
 ## descriptors containing these lines and that Google indexes them, so
 ## spammers might also collect them. You may want to obscure the fact that
 ## it's an email address and/or generate a new address for this purpose.
+##
+## If you are running multiple relays, you MUST set this option.
+##
 #ContactInfo Random Person <nobody AT example dot com>
 ## You might also include your PGP or GPG fingerprint if you have one:
 #ContactInfo 0xFFFFFFFF Random Person <nobody AT example dot com>
@@ -162,6 +165,9 @@
 ## https://www.torproject.org/docs/faq#MultipleRelays
 ## However, you should never include a bridge's fingerprint here, as it would
 ## break its concealability and potentially reveal its IP/TCP address.
+##
+## If you are running multiple relays, you MUST set this option.
+##
 #MyFamily $keyid,$keyid,...
 
 ## Uncomment this if you do *not* want your relay to allow any exit traffic.