Browse Source

Document helper node options

svn:r4715
Nick Mathewson 20 years ago
parent
commit
35b04df4fd
2 changed files with 16 additions and 2 deletions
  1. 2 2
      doc/TODO
  2. 14 0
      doc/tor.1.in

+ 2 - 2
doc/TODO

@@ -103,8 +103,8 @@ N . helper nodes (Choose N nodes randomly; if a node dies (goes down for a
     long time), replace it.  Store nodes on disk.
     long time), replace it.  Store nodes on disk.
     o Implement (basic case)
     o Implement (basic case)
     o Implement (persistence)
     o Implement (persistence)
-    - Document
-    - Test, debug
+    o Document
+    . Test, debug
     - On sighup, if usehelpernodes changed to 1, use new circs.
     - On sighup, if usehelpernodes changed to 1, use new circs.
 N - Make a FirewallIPs to correspond to firewallPorts so I can use Tor at
 N - Make a FirewallIPs to correspond to firewallPorts so I can use Tor at
     MIT when my directory is out of date.
     MIT when my directory is out of date.

+ 14 - 0
doc/tor.1.in

@@ -318,6 +318,20 @@ this will observe it through cookies or other protocol-specific means anyhow.
 Since exit servers go up and down, it is desirable to expire the association
 Since exit servers go up and down, it is desirable to expire the association
 between host and exit server after NUM seconds. The default
 between host and exit server after NUM seconds. The default
 is 1800 seconds (30 minutes).
 is 1800 seconds (30 minutes).
+.LP
+.TP
+\fBUseHelperNodes \fR\fI0|1\fP
+If this option is set to 1, we pick a few entry servers as our "helpers", and
+try to use only those fixed entry servers.  This is desirable, because
+constantly changing servers increases the odds that an adversary who owns
+some servers will observe a fraction of your paths.
+(Defaults to 0; will eventually default to 1.)
+.LP
+.TP
+\fBNumHelperNodesUseHelperNodes \fR\fINUM\fP
+If UseHelperNodes is set to 1, we will try to pick a total of NUM helper
+nodes as entries for our circuits.
+(Defaults to 3.)
 
 
 .SH SERVER OPTIONS
 .SH SERVER OPTIONS
 .PP
 .PP