commit c1c1c4d057376e98ea710e6628a0a27cbccc8c5b Author: Nick Mathewson nickm@torproject.org Date: Fri Oct 30 10:57:47 2015 -0400

Refer to the actual minima and the preferred minimum --- changes/bug16382 | 3 +++ doc/tor.1.txt | 10 ++++++---- 2 files changed, 9 insertions(+), 4 deletions(-)

diff --git a/changes/bug16382 b/changes/bug16382 new file mode 100644 index 0000000..8faee98 --- /dev/null +++ b/changes/bug16382 @@ -0,0 +1,3 @@ + o Documentation: + - Explain actual minima for BandwidthRate. Closes ticket 16382. + diff --git a/doc/tor.1.txt b/doc/tor.1.txt index 6ae85fe..916433b 100644 --- a/doc/tor.1.txt +++ b/doc/tor.1.txt @@ -140,11 +140,13 @@ GENERAL OPTIONS ---------------

[[BandwidthRate]] **BandwidthRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**:: - A token bucket limits the average incoming bandwidth usage on this node to - the specified number of bytes per second, and the average outgoing + A token bucket limits the average incoming bandwidth usage on this node + to the specified number of bytes per second, and the average outgoing bandwidth usage to that same value. If you want to run a relay in the - public network, this needs to be _at the very least_ 250 KBytes (that is, - 2 mbit). (Default: 1 GByte) + + public network, this needs to be _at the very least_ 75 KBytes for a + relay (that is, 600 kbits) or 50 KBytes for a bridge (400 kbits) -- but of + course, more is better; we recommend at least 250 KBytes (2 mbits) if + possible. (Default: 1 GByte) + + With this option, and in other options that take arguments in bytes, KBytes, and so on, other formats are also supported. Notably, "KBytes" can