]> git.ipfire.org Git - thirdparty/tor.git/commitdiff
Clarify the RelayBandwidth* options in man file
authorFernando Fernandez Mancera <ffernandezmancera@gmail.com>
Mon, 20 Nov 2017 16:13:16 +0000 (17:13 +0100)
committerNick Mathewson <nickm@torproject.org>
Tue, 21 Nov 2017 18:54:16 +0000 (13:54 -0500)
Added clarifying information in man file about RelayBandwidthRate and
RelayBandwidthBurst options that exclude directory fetches by relays.

Fixes #24318

Signed-off-by: Fernando Fernandez Mancera <ffernandezmancera@gmail.com>
doc/tor.1.txt

index e1c3cdaf984f9a5c7d1c4323988974682068bc49..6d0b809186be27963ce781c371dc75e0a699b5ea 100644 (file)
@@ -231,12 +231,15 @@ GENERAL OPTIONS
     usage for \_relayed traffic_ on this node to the specified number of bytes
     per second, and the average outgoing bandwidth usage to that same value.
     Relayed traffic currently is calculated to include answers to directory
-    requests, but that may change in future versions. (Default: 0)
+    requests, but that may change in future versions. They do not include directory
+    fetches by the relay (from authority or other relays), because that is considered
+    "client" activity.  (Default: 0)
 
 [[RelayBandwidthBurst]] **RelayBandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
     If not 0, limit the maximum token bucket size (also known as the burst) for
     \_relayed traffic_ to the given number of bytes in each direction.
-    (Default: 0)
+    They do not include directory fetches by the relay (from authority 
+    or other relays), because that is considered "client" activity. (Default: 0)
 
 [[PerConnBWRate]] **PerConnBWRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
     If set, do separate rate limiting for each connection from a non-relay.