Merge remote-tracking branch 'rl1987/doc26908'

changes/doc26908

@@ -0,0 +1,4 @@
+  o Documentation:
+    - Warn users that they should not include MyFamily
+      line(s) in their torrc when running Tor bridge.
+      Closes ticket 26908.

doc/tor.1.txt

@@ -1803,7 +1803,10 @@ is non-zero):
     Sets the relay to act as a "bridge" with respect to relaying connections
     from bridge users to the Tor network. It mainly causes Tor to publish a
     server descriptor to the bridge database, rather than
-    to the public directory authorities.
+    to the public directory authorities. +
+ +
+    Note: make sure that no MyFamily lines are present in your torrc when
+    relay is configured in bridge mode.
 
 [[BridgeDistribution]] **BridgeDistribution** __string__::
     If set along with BridgeRelay, Tor will include a new line in its
@@ -2060,7 +2063,10 @@ is non-zero):
     nickname: fingerprints are more reliable. +
  +
     If you run more than one relay, the MyFamily option on each relay
-    **must** list all other relays, as described above.
+    **must** list all other relays, as described above. +
+ +
+    Note: do not use MyFamily when configuring your Tor instance as a
+    brigde.
 
 [[Nickname]] **Nickname** __name__::
     Set the server's nickname to \'name'. Nicknames must be between 1 and 19

src/config/torrc.minimal.in-staging

@@ -167,6 +167,7 @@
 ##
 ## If you are running multiple relays, you MUST set this option.
 ##
+## Note: do not use MyFamily on bridge relays.
 #MyFamily $keyid,$keyid,...
 
 ## Uncomment this if you want your relay to allow IPv6 exit traffic.
@@ -212,6 +213,9 @@
 ## won't be able to block all the bridges. Also, websites won't treat you
 ## differently because they won't know you're running Tor. If you can
 ## be a real relay, please do; but if not, be a bridge!
+##
+## Warning: when running your Tor as a bridge, make sure than MyFamily is
+## NOT configured.
 #BridgeRelay 1
 ## By default, Tor will advertise your bridge to users through various
 ## mechanisms like https://bridges.torproject.org/. If you want to run

src/config/torrc.sample.in

@@ -169,6 +169,7 @@
 ##
 ## If you are running multiple relays, you MUST set this option.
 ##
+## Note: do not use MyFamily on bridge relays.
 #MyFamily $keyid,$keyid,...
 
 ## Uncomment this if you do *not* want your relay to allow any exit traffic.
@@ -218,6 +219,9 @@
 ## won't be able to block all the bridges. Also, websites won't treat you
 ## differently because they won't know you're running Tor. If you can
 ## be a real relay, please do; but if not, be a bridge!
+##
+## Warning: when running your Tor as a bridge, make sure than MyFamily is
+## NOT configured.
 #BridgeRelay 1
 ## By default, Tor will advertise your bridge to users through various
 ## mechanisms like https://bridges.torproject.org/. If you want to run