diff options
Diffstat (limited to 'param-spec.txt')
| -rw-r--r-- | param-spec.txt | 81 |
1 files changed, 62 insertions, 19 deletions
diff --git a/param-spec.txt b/param-spec.txt index b2882a6..67c809d 100644 --- a/param-spec.txt +++ b/param-spec.txt @@ -17,7 +17,6 @@ Table of Contents 9. Denial-of-service parameters 10. Padding-related parameters 11. Guard-related parameters - 12. Relay behavior X. Obsolete parameters 1. Network protocol parameters @@ -83,7 +82,7 @@ Table of Contents "perconnbwrate" and "perconnbwburst" -- if set, each relay sets up a separate token bucket for every client OR connection, and rate limits - that connection indepedently. Typically left unset, except when used for + that connection independently. Typically left unset, except when used for performance experiments around trac entry 1750. Only honored by relays running Tor 0.2.2.16-alpha and later. (Note that relays running 0.2.2.7-alpha through 0.2.2.14-alpha looked for bwconnrate and @@ -191,6 +190,62 @@ Table of Contents Min: 0. Max: 1. Default: 0. First-appeared: 0.2.3.11-alpha + "overload_dns_timeout_scale_percent" -- This value is a percentage of how + many DNS timeout over N seconds we accept before reporting the overload + general state. It is scaled by a factor of 1000 in order to be able to + represent decimal point. As an example, a value of 1000 means 1%. + Min: 0. Max: 100000. Default: 1000. + First-appeared: 0.4.6.8 + Deprecated: 0.4.7.3-alpha-dev + + "overload_dns_timeout_period_secs" -- This value is the period in seconds + of the DNS timeout measurements (the N in the + "overload_dns_timeout_scale_percent" parameter). For this amount of + seconds, we will gather DNS statistics and at the end, we'll do an + assessment on the overload general signal with regards to DNS timeouts. + Min: 0. Max: 2147483647. Default: 600 + First-appeared: 0.4.6.8 + Deprecated: 0.4.7.3-alpha-dev + + "overload_onionskin_ntor_scale_percent" -- This value is a percentage of + how many onionskin ntor drop over N seconds we accept before reporting the + overload general state. It is scaled by a factor of 1000 in order to be + able to represent decimal point. As an example, a value of 1000 means 1%. + Min: 0. Max: 100000. Default: 1000. + First-appeared: 0.4.7.5-alpha + + "overload_onionskin_ntor_period_secs" -- This value is the period in + seconds of the onionskin ntor overload measurements (the N in the + "overload_onionskin_ntor_scale_percent" parameter). For this amount of + seconds, we will gather onionskin ntor statistics and at the end, we'll do + an assessment on the overload general signal. + Min: 0. Max: 2147483647. Default: 21600 (6 hours) + First-appeared: 0.4.7.5-alpha + + "assume-reachable" -- If true, relays should publish descriptors + even when they cannot make a connection to their IPv4 ORPort. + Min: 0. Max: 1. Default: 0. + First appeared: 0.4.5.1-alpha. + + "assume-reachable-ipv6" -- If true, relays should publish + descriptors even when they cannot make a connection to their IPv6 + ORPort. + Min: 0. Max: 1. Default: 0. + First appeared: 0.4.5.1-alpha. + + "exit_dns_timeout" -- The time in milliseconds an Exit sets libevent to + wait before it considers the DNS timed out. The corresponding libevent + option is "timeout:". + Min: 1. Max: 120000. Default: 1000 (1sec) + First appeared: 0.4.7.5-alpha. + + "exit_dns_num_attempts" -- How many attempts _after the first_ should an + Exit should try a timing-out DNS query before calling it hopeless? (Each of + these attempts will wait for "exit_dns_timeout" independently). The + corresponding libevent option is "attempts:". + Min: 0. Max: 255. Default: 2 + First appeared: 0.4.7.5-alpha. + 8. V3 onion service parameters "hs_intro_min_introduce2", "hs_intro_max_introduce2" -- @@ -324,7 +379,7 @@ Table of Contents Min: 0. Max: 1. Default: 0. First appeared: 0.2.6 - "guard-lifetime-days" -- Controls guard lifetime. If a unconfirmed + "guard-lifetime-days" -- Controls guard lifetime. If an unconfirmed guard has been sampled more than this many days ago, it should be removed from the guard sample. Min: 1. Max: 3650. Default: 120. @@ -363,8 +418,9 @@ Table of Contents "guard-extreme-restriction-percent" -- Warn the user if they have configured tor to exclude so many guards that the available guard bandwidth is less than this percentage of the total. - Min: 1. Max: INT32_MAX. Default: 1. - First appeared: 0.3.0 + Min: 1. Max: 100. Default: 1. + First appeared: 0.3.0. MAX was INT32_MAX, which would have no meaningful + effect. MAX lowered to 100 in 0.4.7. "guard-min-filtered-sample-size" -- If fewer than this number of guards is available in the sample after filtering out unusable @@ -394,7 +450,7 @@ Table of Contents Min: 1. Max: INT32_MAX. Default: 15 First appeared: 0.3.0 - "guard-nonprimary-guard-idle-timeout" -- When trying to confirm + "guard-nonprimary-guard-idle-timeout" -- When trying to confirm nonprimary guards, if a guard doesn't answer for more than this long in seconds, treat it as down. Min: 1. Max: INT32_MAX. Default: 600 @@ -406,19 +462,6 @@ Table of Contents Min: 1. Max: 3650. Default: 20. First appeared: 0.3.0 -12. Relay behavior - - "assume-reachable" -- If true, relays should publish descriptors - even when they cannot make a connection to their IPv4 ORPort. - Min: 0. Max: 1. Default: 0. - First appeared: 0.4.5.1-alpha. - - "assume-reachable-ipv6" -- If true, relays should publish - descriptors even when they cannot make a connection to their IPv6 - ORPort. - Min: 0. Max: 1. Default: 0. - First appeared: 0.4.5.1-alpha. - X. Obsolete parameters "NumDirectoryGuards", "NumEntryGuards" -- Number of guard nodes |