Opened 6 years ago

Closed 3 years ago

#9222 closed defect (worksforme)

Torrc's bandwidth entries are more flexible than documented

Reported by: atagar Owned by:
Priority: Very Low Milestone:
Component: Core Tor/Nyx Version:
Severity: Normal Keywords: tor-relay easy doc
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

According to the tor man page the permitted format for bandwidth entries is pretty simple...

RelayBandwidthRate N bytes|KB|MB|GB

Arm parses these to check if the torrc is out of sync with tor's actual state (ie, that the user edited their configuration without restarting or issuing a sighup). However, a user inadvertently found that tor is actually more flexible on these lines that what the man page documents...

12:54 < atagar> What is the exact torrc lines that you have?
12:55 < Urban_core> RelayBandwidthRate 250Kbytes # Throttle traffic to 100KB/s (800Kbps)
12:55 < Urban_core> RelayBandwidthBurst 350Kbytes  # But allow bursts up to 200KB/s (1600Kbps)

Once this is fixed in the tor man page please assign this to the arm component and I'll fix it on my end.

Child Tickets

Change History (10)

comment:1 Changed 6 years ago by nickm

Hm. I think that we deliberately simplified the manual so that people wouldn't get confused or think there was a difference between B and Bytes here, or "K" and "Kilo". I guess we could list all 22 synonyms? Or maybe we could come up with a nice compact way to say "It's a unit of memory, see X for a list of all recognized units." But that would probably make the manpage less usable, since you'd need to chase the cross-reference to know how to configure one of these options.

comment:2 Changed 6 years ago by nickm

Keywords: tor-relay added
Milestone: Tor: 0.2.5.x-final

comment:3 Changed 6 years ago by atagar

Maybe leave its present simple version with a note in the description "Other formats are also accepted on this line. For the other varieties see X."?

comment:4 Changed 6 years ago by nickm

Sounds good to me.

comment:5 Changed 6 years ago by nickm

Keywords: easy doc added

comment:6 Changed 5 years ago by nickm

In 27d231ca130b48e0963aaab7307109f7eafcc5c9 I've added a short section to the first option that takes a bandwidth/memory unit.

comment:7 Changed 5 years ago by nickm

Resolution: fixed
Status: newclosed

I think this is okay now.

comment:8 Changed 5 years ago by atagar

Component: Torarm
Resolution: fixed
Status: closedreopened

Reassigning to the arm component for the corresponding fix there (man page change).

comment:9 Changed 5 years ago by nickm

Milestone: Tor: 0.2.5.x-final

comment:10 Changed 3 years ago by atagar

Resolution: worksforme
Severity: Normal
Status: reopenedclosed
Note: See TracTickets for help on using tickets.