diff options
Diffstat (limited to 'spec/param-spec.md')
| -rw-r--r-- | spec/param-spec.md | 37 |
1 files changed, 11 insertions, 26 deletions
diff --git a/spec/param-spec.md b/spec/param-spec.md index bd18c0c..025110c 100644 --- a/spec/param-spec.md +++ b/spec/param-spec.md @@ -3,24 +3,9 @@ Tor network parameters This file lists the recognized parameters that can appear on the "params" line of a directory consensus. -Table of Contents - -1. Network protocol parameters -1. Performance-tuning parameters -1. Voting-related parameters -1. Circuit-build-timeout parameters -1. Directory-related parameters -1. Pathbias parameters -1. Relay behavior -1. V3 onion service parameters -1. Denial-of-service parameters -1. Padding-related parameters -1. Guard-related parameters - X. Obsolete parameters - <a id="param-spec.txt-1"></a> -# Network protocol parameters +# Network protocol parameters {#network-protocol} "circwindow" -- the default package window that circuits should be established with. It started out at 1000 cells, but some research @@ -73,7 +58,7 @@ First appeared: 0.4.5.1-alpha. <a id="param-spec.txt-2"></a> -# Performance-tuning parameters +# Performance-tuning parameters {#performance-tuning} "CircuitPriorityHalflifeMsec" -- the halflife parameter used when weighting which circuit will send the next cell. Obeyed by Tor @@ -123,7 +108,7 @@ First appeared: 0.4.8.2 <a id="param-spec.txt-3"></a> -# Voting-related parameters +# Voting-related parameters {#voting} "bwweightscale" -- Value that bandwidth-weights are divided by. If not present then this defaults to 10000. @@ -161,7 +146,7 @@ dirauth. <a id="param-spec.txt-4"></a> -# Circuit-build-timeout parameters +# Circuit-build-timeout parameters {#cbt} "cbtdisabled", "cbtnummodes", "cbtrecentcount", "cbtmaxtimeouts", "cbtmincircs", "cbtquantile", "cbtclosequantile", "cbttestfreq", @@ -172,7 +157,7 @@ consensus parameters. <a id="param-spec.txt-5"></a> -# Directory-related parameters +# Directory-related parameters {#directory} "max-consensus-age-to-cache-for-diff" -- Determines how much consensus history (in hours) relays should try to cache in order to @@ -184,7 +169,7 @@ try to find a diff for it. (min 0, max 8192, default 72) <a id="param-spec.txt-6"></a> -# Pathbias parameters +# Pathbias parameters {#pathbias} "pb_mincircs", "pb_noticepct", "pb_warnpct", "pb_extremepct", "pb_dropguards", "pb_scalecircs", "pb_scalefactor", @@ -193,7 +178,7 @@ try to find a diff for it. (min 0, max 8192, default 72) <a id="param-spec.txt-7"></a> -# Relay behavior +# Relay behavior parameters {#relay-behavior} "refuseunknownexits" -- if set to one, exit relays look at the previous hop of circuits that ask to open an exit stream, and refuse to exit if @@ -277,7 +262,7 @@ First appeared: 0.4.7.5-alpha. <a id="param-spec.txt-8"></a> -# V3 onion service parameters +# V3 onion service parameters {#onion-service} "hs_intro_min_introduce2", "hs_intro_max_introduce2" -- Minimum/maximum amount of INTRODUCE2 cells allowed per circuits @@ -336,7 +321,7 @@ First appeared: 0.4.2.1-alpha. <a id="param-spec.txt-9"></a> -# Denial-of-service parameters +# Denial-of-service parameters {#dos} Denial of Service mitigation parameters. Introduced in 0.3.3.2-alpha: @@ -383,7 +368,7 @@ rendezvous points for single hop clients. <a id="param-spec.txt-10"></a> -# Padding-related parameters +# Padding-related parameters {#padding} "circpad_max_circ_queued_cells" -- The circuitpadding module will stop sending more padding cells if more than this many cells are in @@ -514,7 +499,7 @@ First appeared: 0.3.0 <a id="param-spec.txt-X"></a> -# Obsolete parameters +# Obsolete parameters {#obsolete} "NumDirectoryGuards", "NumEntryGuards" -- Number of guard nodes clients should use by default. If NumDirectoryGuards is 0, we |