Clarify the RelayBandwidth* options in man file

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>
This commit is contained in:
Fernando Fernandez Mancera 2017-11-20 17:13:16 +01:00 committed by Nick Mathewson
parent edc3fe0eb5
commit 5f4e9d5079

View File

@ -231,12 +231,15 @@ GENERAL OPTIONS
usage for \_relayed traffic_ on this node to the specified number of bytes 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. per second, and the average outgoing bandwidth usage to that same value.
Relayed traffic currently is calculated to include answers to directory 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**:: [[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 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. \_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**:: [[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. If set, do separate rate limiting for each connection from a non-relay.