From 622dd4927e1d3044fe34a1ec6c9785e044923953 Mon Sep 17 00:00:00 2001 From: Roger Dingledine Date: Tue, 12 Jun 2007 08:19:02 +0000 Subject: change the BandwidthRate/BandwidthBurst in the torrc to RelayBandwidthRate/RelayBandwidthBurst, since that's what most users will actually want. also flesh out the torrc.complete entries and fix a few typos. based on patch from "Armedblowfish". svn:r10570 --- src/config/torrc.complete.in | 21 ++++++++++++++++----- src/config/torrc.sample.in | 11 ++++++----- 2 files changed, 22 insertions(+), 10 deletions(-) diff --git a/src/config/torrc.complete.in b/src/config/torrc.complete.in index 62e8de50f..7057eaa6a 100644 --- a/src/config/torrc.complete.in +++ b/src/config/torrc.complete.in @@ -373,14 +373,14 @@ ## If you set NoPublish 1, Tor will act as a server if you have an ## ORPort defined, but it will not publish its descriptor to the -## dirservers. This option is useful if you’re testing out your -## server, or if you’re using alternate dirservers (e.g. for other +## dirservers. This option is useful if you're testing out your +## server, or if you're using alternate dirservers (e.g. for other ## Tor networks such as Blossom). (Default: 0) #NoPublish 0|1 ## How many processes to use at once for decrypting onionskins. ## (Default: 1) -NumCPUs num +#NumCPUs num ## Advertise this port to listen for connections from Tor clients ## and servers. @@ -403,7 +403,7 @@ NumCPUs num ## being considered. #RedirectExit pattern target -## When we get a SIGINT and we’re a server, we begin shutting +## When we get a SIGINT and we're a server, we begin shutting ## down: we close listeners and start refusing new circuits. After ## NUM seconds, we exit. If we get a second SIGINT, we exit imme- ## diately. (Default: 30 seconds) @@ -414,6 +414,16 @@ NumCPUs num ## uploaded whenever it changes. (Default: 20 minutes) #DirPostPeriod N seconds|minutes|hours|days|weeks +## A token bucket limits the average relayed bandwidth (server +## traffic only, not client traffic) on this node to the specified +## number of bytes per second. +#RelayBandwidthRate N bytes|KB|MB|GB|TB + +## Limit the maximum token bucket size (also known as the burst) for +## relayed traffic (server traffic only, not client traffic) to the +## given number of bytes. +#RelayBandwidthBurst N bytes|KB|MB|GB|TB + ## Never send more than the specified number of bytes in a given ## accounting period, or receive more than that number in the ## period. For example, with AccountingMax set to 1 GB, a server @@ -484,7 +494,7 @@ NumCPUs num ## If set to 1, Tor tries to build circuits through all of the ## servers it knows about, so it can tell which are up and which ## are down. This option is only useful for authoritative direc- -## tories, so you probably don’t want to use it. +## tories, so you probably don't want to use it. #RunTesting 0|1 ## Section 5: Hidden Service Options (clients and servers) @@ -516,3 +526,4 @@ NumCPUs num ## information is also uploaded whenever it changes. ## (Default: 20 minutes) #RendPostPeriod N seconds|minutes|hours|days|weeks +# diff --git a/src/config/torrc.sample.in b/src/config/torrc.sample.in index 7792ffee2..73bc05089 100644 --- a/src/config/torrc.sample.in +++ b/src/config/torrc.sample.in @@ -1,5 +1,5 @@ ## Configuration file for a typical Tor user -## Last updated 8 October 2006 for Tor 0.1.2.3-alpha. +## Last updated 12 June 2007 for Tor 0.2.0.3-alpha. ## (May or may not work for older or newer versions of Tor.) ## ## Lines that begin with "## " try to explain what's going on. Lines @@ -89,10 +89,11 @@ SocksListenAddress 127.0.0.1 # accept connections only from localhost ## The IP or FQDN for your server. Leave commented out and Tor will guess. #Address noname.example.com -## Define these to limit your bandwidth usage. Note that BandwidthRate -## must be at least 20 KB. -#BandwidthRate 100 KB # Throttle traffic to 100KB/s (800Kbps) -#BandwidthBurst 200 KB # But allow bursts up to 200KB/s (1600Kbps) +## Define these to limit the bandwidth usage of relayed (server) +## traffic. Your own traffic is still unthrottled. +## Note that RelayBandwidthRate must be at least 20 KB. +#RelayBandwidthRate 100 KB # Throttle traffic to 100KB/s (800Kbps) +#RelayBandwidthBurst 200 KB # But allow bursts up to 200KB/s (1600Kbps) ## Contact info to be published in the directory, so we can contact you ## if your server is misconfigured or something else goes wrong. -- cgit v1.2.3