Opened 4 years ago

Closed 4 years ago

#16382 closed defect (fixed)

man page has misleading info about the min bw rate

Reported by: mrphs Owned by:
Priority: Medium Milestone: Tor: 0.2.8.x-final
Component: Core Tor/Tor Version:
Severity: Normal Keywords: man, page, documentation, 028-triaged, pre028-patch
Cc: Actual Points:
Parent ID: Points: small
Reviewer: Sponsor:

Description (last modified by mrphs)

GENERAL OPTIONS
       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 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 30 KBytes (that is, 30720 bytes). (Default: 1 GByte)

The number has been lifted to 250KBytes in our online documentation and this one should probably get fixed too. Anything below 250KBytes (each direction) is probably hurting the network.

Child Tickets

Change History (12)

comment:1 Changed 4 years ago by mrphs

Description: modified (diff)

comment:2 Changed 4 years ago by mrphs

Status: newneeds_review

I just tried to fix it. Hopefully I didn't do it wrong :)

comment:3 Changed 4 years ago by mrphs

Sure enough, I *did* something wrong. There was a typo in the first patch. please see the second one.

comment:4 Changed 4 years ago by rl1987

Hey, we took a look at this patch during our weekly workshop. Actually, the absolutely lowest value that tor allows for BandwidthRate is 75 kbytes today (see #13822). However, there is not much use in having OR with that much of bandwidth, so the manpage should recommend 250 kbytes as minimum. Furthermore, minimum allowed BandwidthRate is lower for bridges (50 kbytes), but 250 kbyte recommendation should work for bridges as well.

comment:5 Changed 4 years ago by rl1987

Keywords: documentation added
Status: needs_reviewneeds_revision

comment:6 Changed 4 years ago by nickm

Milestone: Tor: 0.2.8.x-final

comment:7 Changed 4 years ago by nickm

Keywords: 028-triaged added

comment:8 Changed 4 years ago by nickm

Points: small

comment:9 Changed 4 years ago by nickm

Keywords: pre028-patch added

comment:10 Changed 4 years ago by nickm

Resolution: fixed
Severity: Normal
Status: needs_revisionclosed

tweaked the numbers and merged.

Note: See TracTickets for help on using tickets.