Thomas Sjögren commited on 2005-06-27 00:39:08
Zeige 1 geänderte Dateien mit 327 Einfügungen und 6 Löschungen.
... | ... |
@@ -39,23 +39,45 @@ themselves have difficulty tracking the source of the stream. |
39 | 39 |
|
40 | 40 |
<B>-h, -help</B> |
41 | 41 |
Display a short help message and exit. |
42 |
+<P> |
|
43 |
+ |
|
42 | 44 |
<DL COMPACT> |
43 | 45 |
<DT><B>-f </B><I>FILE</I><DD> |
44 | 46 |
FILE contains further "option value" pairs. (Default: @CONFDIR@/torrc) |
47 |
+</DL> |
|
48 |
+<P> |
|
49 |
+ |
|
50 |
+<DL COMPACT> |
|
45 | 51 |
<DT>Other options can be specified either on the command-line (<I>--option<DD> |
46 | 52 |
value</I>), or in the configuration file (<I>option value</I>). |
47 | 53 |
Options are case-insensitive. |
54 |
+</DL> |
|
55 |
+<P> |
|
56 |
+ |
|
57 |
+<DL COMPACT> |
|
48 | 58 |
<DT><B>BandwidthRate </B><I>N</I> <B>bytes</B>|<B>KB</B>|<B>MB</B>|<B>GB</B>|<B>TB</B><DD> |
49 | 59 |
A token bucket limits the average incoming bandwidth on this node to |
50 | 60 |
the specified number of bytes per second. (Default: 2 MB) |
61 |
+</DL> |
|
62 |
+<P> |
|
63 |
+ |
|
64 |
+<DL COMPACT> |
|
51 | 65 |
<DT><B>BandwidthBurst </B><I>N</I> <B>bytes</B>|<B>KB</B>|<B>MB</B>|<B>GB</B>|<B>TB</B><DD> |
52 | 66 |
Limit the maximum token bucket size (also known as the burst) to the given number of bytes. (Default: 5 MB) |
67 |
+</DL> |
|
68 |
+<P> |
|
69 |
+ |
|
70 |
+<DL COMPACT> |
|
53 | 71 |
<DT><B>MaxAdvertisedBandwidth </B><I>N</I> <B>bytes</B>|<B>KB</B>|<B>MB</B>|<B>GB</B>|<B>TB</B><DD> |
54 | 72 |
If set, we will not advertise more than this amount of bandwidth for our |
55 | 73 |
BandwidthRate. Server operators who want to reduce the number of clients |
56 | 74 |
who ask to build circuits through them (since this is proportional to |
57 | 75 |
advertised bandwidth rate) can thus reduce the CPU demands on their |
58 | 76 |
server without impacting network performance. |
77 |
+</DL> |
|
78 |
+<P> |
|
79 |
+ |
|
80 |
+<DL COMPACT> |
|
59 | 81 |
<DT><B>ControlPort </B><I>Port</I><DD> |
60 | 82 |
If set, Tor will accept connections from the same machine (localhost only) on |
61 | 83 |
this port, and allow those connections to control the Tor process using the |
... | ... |
@@ -63,57 +85,105 @@ Tor Control Protocol (described in control-spec.txt). Note: unless you also |
63 | 85 |
specify one of <B>HashedControlPassword</B> or <B>CookieAuthentication</B>, |
64 | 86 |
setting this option will cause Tor to allow any process on the local host to |
65 | 87 |
control it. |
88 |
+</DL> |
|
89 |
+<P> |
|
90 |
+ |
|
91 |
+<DL COMPACT> |
|
66 | 92 |
<DT><B>HashedControlPassword </B><I>hashed_password</I><DD> |
67 | 93 |
Don't allow any connections on the control port except when the other process |
68 | 94 |
knows the password whose one-way hash is <I>hashed_password</I>. You can |
69 | 95 |
compute the hash of a password by running "tor --hash-password |
70 | 96 |
<I>password</I>". |
97 |
+</DL> |
|
98 |
+<P> |
|
99 |
+ |
|
100 |
+<DL COMPACT> |
|
71 | 101 |
<DT><B>CookieAuthentication </B><B>0</B>|<B>1</B><DD> |
72 | 102 |
If this option is set to 1, don't allow any connections on the control port |
73 | 103 |
except when the connecting process knows the contents of a file named |
74 | 104 |
"control_auth_cookie", which Tor will create in its data directory. This |
75 | 105 |
authentication methods should only be used on systems with good filesystem |
76 | 106 |
security. (Default: 0) |
107 |
+</DL> |
|
108 |
+<P> |
|
109 |
+ |
|
110 |
+<DL COMPACT> |
|
77 | 111 |
<DT><B>DataDirectory </B><I>DIR</I><DD> |
78 | 112 |
Store working data in DIR (Default: @LOCALSTATEDIR@/lib/tor) |
113 |
+</DL> |
|
114 |
+<P> |
|
115 |
+ |
|
116 |
+<DL COMPACT> |
|
79 | 117 |
<DT><B>DirFetchPeriod </B><I>N</I> <B>seconds</B>|<B>minutes</B>|<B>hours</B>|<B>days</B>|<B>weeks</B><DD> |
80 | 118 |
Every time the specified period elapses, Tor downloads a directory. |
81 | 119 |
A directory contains a signed list of all known servers as well as |
82 | 120 |
their current liveness status. A value of "0 seconds" tells Tor to choose an |
83 | 121 |
appropriate default. (Default: 1 hour for clients, 20 minutes for servers) |
122 |
+</DL> |
|
123 |
+<P> |
|
124 |
+ |
|
125 |
+<DL COMPACT> |
|
84 | 126 |
<DT><B>DirServer </B><I>address:port fingerprint</I><DD> |
85 | 127 |
Use a nonstandard authoritative directory server at the provided |
86 | 128 |
address and port, with the specified key fingerprint. This option can |
87 | 129 |
be repeated many times, for multiple authoritative directory |
88 | 130 |
servers. If no <B>dirserver</B> line is given, Tor will use the default |
89 | 131 |
directory servers: moria1, moria2, and tor26. |
132 |
+</DL> |
|
133 |
+<P> |
|
134 |
+ |
|
135 |
+<DL COMPACT> |
|
90 | 136 |
<DT><B>Group </B><I>GID</I><DD> |
91 | 137 |
On startup, setgid to this user. |
138 |
+</DL> |
|
139 |
+<P> |
|
140 |
+ |
|
141 |
+<DL COMPACT> |
|
92 | 142 |
<DT><B>HttpProxy</B> <I>host</I>[:<I>port</I>]<DD> |
93 | 143 |
Tor will make all its directory requests through this host:port |
94 | 144 |
(or host:80 if port is not specified), |
95 | 145 |
rather than connecting directly to any directory servers. |
146 |
+</DL> |
|
147 |
+<P> |
|
148 |
+ |
|
149 |
+<DL COMPACT> |
|
96 | 150 |
<DT><B>HttpProxyAuthenticator</B> <I>username:password</I><DD> |
97 | 151 |
If defined, Tor will use this username:password for Basic Http proxy |
98 | 152 |
authentication, as in RFC 2617. This is currently the only form of |
99 | 153 |
Http proxy authentication that Tor supports; feel free to submit a |
100 | 154 |
patch if you want it to support others. |
155 |
+</DL> |
|
156 |
+<P> |
|
157 |
+ |
|
158 |
+<DL COMPACT> |
|
101 | 159 |
<DT><B>HttpsProxy</B> <I>host</I>[:<I>port</I>]<DD> |
102 | 160 |
Tor will make all its OR (SSL) connections through this host:port |
103 | 161 |
(or host:443 if port is not specified), via HTTP CONNECT rather than |
104 | 162 |
connecting directly to servers. You may want to set <B>FascistFirewall</B> |
105 | 163 |
to restrict the set of ports you might try to connect to, if your Https |
106 | 164 |
proxy only allows connecting to certain ports. |
165 |
+</DL> |
|
166 |
+<P> |
|
167 |
+ |
|
168 |
+<DL COMPACT> |
|
107 | 169 |
<DT><B>HttpsProxyAuthenticator</B> <I>username:password</I><DD> |
108 | 170 |
If defined, Tor will use this username:password for Basic Https proxy |
109 | 171 |
authentication, as in RFC 2617. This is currently the only form of |
110 | 172 |
Https proxy authentication that Tor supports; feel free to submit a |
111 | 173 |
patch if you want it to support others. |
174 |
+</DL> |
|
175 |
+<P> |
|
176 |
+ |
|
177 |
+<DL COMPACT> |
|
112 | 178 |
<DT><B>KeepalivePeriod </B><I>NUM</I><DD> |
113 | 179 |
To keep firewalls from expiring connections, send a padding keepalive |
114 | 180 |
cell every NUM seconds on open connections that are in use. If the |
115 | 181 |
connection has no open circuits, it will instead be closed after NUM |
116 | 182 |
seconds of idleness. (Default: 5 minutes) |
183 |
+</DL> |
|
184 |
+<P> |
|
185 |
+ |
|
186 |
+<DL COMPACT> |
|
117 | 187 |
<DT><B>Log </B><I>minSeverity</I>[-<I>maxSeverity</I>] <B>stderr</B>|<B>stdout</B>|<B>syslog</B><DD> |
118 | 188 |
Send all messages between <I>minSeverity</I> and <I>maxSeverity</I> to |
119 | 189 |
the standard output stream, the standard error stream, or to the system |
... | ... |
@@ -121,33 +191,69 @@ log. (The "syslog" value is only supported on Unix.) Recognized |
121 | 191 |
severity levels are debug, info, notice, warn, and err. If only one |
122 | 192 |
severity level is given, all messages of that level or higher will be |
123 | 193 |
sent to the listed destination. |
194 |
+</DL> |
|
195 |
+<P> |
|
196 |
+ |
|
197 |
+<DL COMPACT> |
|
124 | 198 |
<DT><B>Log </B><I>minSeverity</I>[-<I>maxSeverity</I>] <B>file</B> <I>FILENAME</I><DD> |
125 | 199 |
As above, but send log messages to the listed filename. The "Log" |
126 | 200 |
option may appear more than once in a configuration file. Messages |
127 | 201 |
are sent to all the logs that match their severity level. |
202 |
+</DL> |
|
203 |
+<P> |
|
204 |
+ |
|
205 |
+<DL COMPACT> |
|
128 | 206 |
<DT><B>MaxConn </B><I>NUM</I><DD> |
129 | 207 |
Maximum number of simultaneous sockets allowed. You probably don't need |
130 | 208 |
to adjust this. (Default: 1024) |
209 |
+</DL> |
|
210 |
+<P> |
|
211 |
+ |
|
212 |
+<DL COMPACT> |
|
131 | 213 |
<DT><B>OutboundBindAddress </B><I>IP</I><DD> |
132 | 214 |
Make all outbound connections originate from the IP address specified. This |
133 | 215 |
is only useful when you have multiple network interfaces, and you want all |
134 | 216 |
of Tor's outgoing connections to use a single one. |
217 |
+</DL> |
|
218 |
+<P> |
|
219 |
+ |
|
220 |
+<DL COMPACT> |
|
135 | 221 |
<DT><B>PIDFile </B><I>FILE</I><DD> |
136 | 222 |
On startup, write our PID to FILE. On clean shutdown, remove FILE. |
223 |
+</DL> |
|
224 |
+<P> |
|
225 |
+ |
|
226 |
+<DL COMPACT> |
|
137 | 227 |
<DT><B>RunAsDaemon </B><B>0</B>|<B>1</B><DD> |
138 | 228 |
If 1, Tor forks and daemonizes to the background. (Default: 0) |
229 |
+</DL> |
|
230 |
+<P> |
|
231 |
+ |
|
232 |
+<DL COMPACT> |
|
139 | 233 |
<DT><B>SafeLogging </B><B>0</B>|<B>1</B><DD> |
140 | 234 |
If 1, Tor replaces potentially sensitive strings in the logs |
141 | 235 |
(e.g. addresses) with the string [scrubbed]. This way logs can still be |
142 | 236 |
useful, but they don't leave behind personally identifying information |
143 | 237 |
about what sites a user might have visited. (Default: 1) |
238 |
+</DL> |
|
239 |
+<P> |
|
240 |
+ |
|
241 |
+<DL COMPACT> |
|
144 | 242 |
<DT><B>StatusFetchPeriod </B><I>N</I> <B>seconds</B>|<B>minutes</B>|<B>hours</B>|<B>days</B>|<B>weeks</B><DD> |
145 | 243 |
Every time the specified period elapses, Tor downloads signed status |
146 | 244 |
information about the current state of known servers. A value of |
147 | 245 |
"0 seconds" tells Tor to choose an appropriate default. (Default: 30 |
148 | 246 |
minutes for clients, 15 minutes for servers) |
247 |
+</DL> |
|
248 |
+<P> |
|
249 |
+ |
|
250 |
+<DL COMPACT> |
|
149 | 251 |
<DT><B>User </B><I>UID</I><DD> |
150 | 252 |
On startup, setuid to this user. |
253 |
+</DL> |
|
254 |
+<P> |
|
255 |
+ |
|
256 |
+<DL COMPACT> |
|
151 | 257 |
<DT><B>HardwareAccel </B><I>0|1</I><DD> |
152 | 258 |
If non-zero, try to use crypto hardware acceleration when |
153 | 259 |
available. (Default: 1. ) |
... | ... |
@@ -159,10 +265,16 @@ available. (Default: 1. ) |
159 | 265 |
<P> |
160 | 266 |
|
161 | 267 |
The following options are useful only for clients (that is, if <B>SOCKSPort</B> is non-zero): |
268 |
+<P> |
|
269 |
+ |
|
162 | 270 |
<DL COMPACT> |
163 | 271 |
<DT><B>AllowUnverifiedNodes</B> <B>entry</B>|<B>exit</B>|<B>middle</B>|<B>introduction</B>|<B>rendezvous</B>|...<DD> |
164 | 272 |
Where on our circuits should we allow Tor servers that the directory |
165 | 273 |
servers haven't authenticated as "verified"? (Default: middle,rendezvous) |
274 |
+</DL> |
|
275 |
+<P> |
|
276 |
+ |
|
277 |
+<DL COMPACT> |
|
166 | 278 |
<DT><B>ClientOnly </B><B>0</B>|<B>1</B><DD> |
167 | 279 |
If set to 1, Tor will under no circumstances run as a server. The default |
168 | 280 |
is to run as a client unless ORPort is configured. (Usually, |
... | ... |
@@ -171,68 +283,135 @@ you are reliable and high-bandwidth enough to be a useful server.) |
171 | 283 |
<P> |
172 | 284 |
This option will likely be deprecated in the future; see the NoPublish |
173 | 285 |
option below. (Default: 0) |
286 |
+</DL> |
|
287 |
+<P> |
|
288 |
+ |
|
289 |
+<DL COMPACT> |
|
174 | 290 |
<DT><B>EntryNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD> |
175 | 291 |
A list of preferred nodes to use for the first hop in the circuit, if possible. |
292 |
+</DL> |
|
293 |
+<P> |
|
294 |
+ |
|
295 |
+<DL COMPACT> |
|
176 | 296 |
<DT><B>ExitNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD> |
177 | 297 |
A list of preferred nodes to use for the last hop in the circuit, if possible. |
298 |
+</DL> |
|
299 |
+<P> |
|
300 |
+ |
|
301 |
+<DL COMPACT> |
|
178 | 302 |
<DT><B>ExcludeNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD> |
179 | 303 |
A list of nodes to never use when building a circuit. |
304 |
+</DL> |
|
305 |
+<P> |
|
306 |
+ |
|
307 |
+<DL COMPACT> |
|
180 | 308 |
<DT><B>StrictExitNodes </B><B>0</B>|<B>1</B><DD> |
181 | 309 |
If 1, Tor will never use any nodes besides those listed in "exitnodes" for |
182 | 310 |
the last hop of a circuit. |
311 |
+</DL> |
|
312 |
+<P> |
|
313 |
+ |
|
314 |
+<DL COMPACT> |
|
183 | 315 |
<DT><B>StrictEntryNodes </B><B>0</B>|<B>1</B><DD> |
184 | 316 |
If 1, Tor will never use any nodes besides those listed in "entrynodes" for |
185 | 317 |
the first hop of a circuit. |
318 |
+</DL> |
|
319 |
+<P> |
|
320 |
+ |
|
321 |
+<DL COMPACT> |
|
186 | 322 |
<DT><B>FascistFirewall </B><B>0</B>|<B>1</B><DD> |
187 | 323 |
If 1, Tor will only create outgoing connections to ORs running on ports that |
188 | 324 |
your firewall allows (defaults to 80 and 443; see <B>FirewallPorts</B>). This will |
189 | 325 |
allow you to run Tor as a client behind a firewall with restrictive policies, |
190 | 326 |
but will not allow you to run as a server behind such a firewall. |
327 |
+</DL> |
|
328 |
+<P> |
|
329 |
+ |
|
330 |
+<DL COMPACT> |
|
191 | 331 |
<DT><B>FirewallPorts </B><I>PORTS</I><DD> |
192 | 332 |
A list of ports that your firewall allows you to connect to. Only used when |
193 | 333 |
<B>FascistFirewall</B> is set. (Default: 80, 443) |
334 |
+</DL> |
|
335 |
+<P> |
|
336 |
+ |
|
337 |
+<DL COMPACT> |
|
194 | 338 |
<DT><B>LongLivedPorts </B><I>PORTS</I><DD> |
195 | 339 |
A list of ports for services that tend to have long-running connections |
196 | 340 |
(e.g. chat and interactive shells). Circuits for streams that use these |
197 | 341 |
ports will contain only high-uptime nodes, to reduce the chance that a |
198 | 342 |
node will go down before the stream is finished. (Default: 21, 22, 706, 1863, 5050, |
199 | 343 |
5190, 5222, 5223, 6667, 8300, 8888) |
344 |
+</DL> |
|
345 |
+<P> |
|
346 |
+ |
|
347 |
+<DL COMPACT> |
|
200 | 348 |
<DT><B>MapAddress</B> <I>address</I> <I>newaddress</I><DD> |
201 | 349 |
When a request for address arrives to Tor, it will rewrite it to newaddress before |
202 | 350 |
processing it. For example, if you always want connections to <A HREF="http://www.indymedia.org">www.indymedia.org</A> to |
203 | 351 |
exit via <I>torserver</I> (where <I>torserver</I> is the nickname of the server), |
204 | 352 |
use "MapAddress <A HREF="http://www.indymedia.org">www.indymedia.org</A> <A HREF="http://www.indymedia.org.torserver.exit">www.indymedia.org.torserver.exit</A>". |
353 |
+</DL> |
|
354 |
+<P> |
|
355 |
+ |
|
356 |
+<DL COMPACT> |
|
205 | 357 |
<DT><B>NewCircuitPeriod </B><I>NUM</I><DD> |
206 | 358 |
Every NUM seconds consider whether to build a new circuit. (Default: 30 seconds) |
359 |
+</DL> |
|
360 |
+<P> |
|
361 |
+ |
|
362 |
+<DL COMPACT> |
|
207 | 363 |
<DT><B>MaxCircuitDirtiness </B><I>NUM</I><DD> |
208 | 364 |
Feel free to reuse a circuit that was first used at most NUM seconds |
209 | 365 |
ago, but never attach a new stream to a circuit that is too old. (Default: 10 minutes) |
366 |
+</DL> |
|
367 |
+<P> |
|
368 |
+ |
|
369 |
+<DL COMPACT> |
|
210 | 370 |
<DT><B>NodeFamily </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD> |
211 | 371 |
The named Tor servers constitute a "family" of similar or co-administered |
212 | 372 |
servers, so never use any two of them in the same circuit. Defining a |
213 | 373 |
NodeFamily is only needed when a server doesn't list the family itself |
214 | 374 |
(with MyFamily). This option can be used multiple times. |
215 |
-<DT> |
|
216 |
-<DD> |
|
217 |
- |
|
218 |
- |
|
375 |
+</DL> |
|
376 |
+<P> |
|
219 | 377 |
|
220 |
-<B>RendNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I> |
|
378 |
+<DL COMPACT> |
|
379 |
+<DT><B>RendNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD> |
|
221 | 380 |
A list of preferred nodes to use for the rendezvous point, if possible. |
381 |
+</DL> |
|
382 |
+<P> |
|
383 |
+ |
|
384 |
+<DL COMPACT> |
|
222 | 385 |
<DT><B>RendExcludeNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD> |
223 | 386 |
A list of nodes to never use when choosing a rendezvous point. |
387 |
+</DL> |
|
388 |
+<P> |
|
389 |
+ |
|
390 |
+<DL COMPACT> |
|
224 | 391 |
<DT><B>SOCKSPort </B><I>PORT</I><DD> |
225 | 392 |
Advertise this port to listen for connections from SOCKS-speaking |
226 | 393 |
applications. Set this to 0 if you don't want to allow application |
227 | 394 |
connections. (Default: 9050) |
395 |
+</DL> |
|
396 |
+<P> |
|
397 |
+ |
|
398 |
+<DL COMPACT> |
|
228 | 399 |
<DT><B>SOCKSBindAddress </B><I>IP</I>[:<I>PORT</I>]<DD> |
229 | 400 |
Bind to this address to listen for connections from SOCKS-speaking |
230 | 401 |
applications. (Default: 127.0.0.1) You can also specify a port |
231 | 402 |
(e.g. 192.168.0.1:9100). This directive can be specified multiple times |
232 | 403 |
to bind to multiple addresses/ports. |
404 |
+</DL> |
|
405 |
+<P> |
|
406 |
+ |
|
407 |
+<DL COMPACT> |
|
233 | 408 |
<DT><B>SOCKSPolicy </B><I>policy</I>,<I>policy</I>,<I>...</I><DD> |
234 | 409 |
Set an entrance policy for this server, to limit who can connect to the SOCKS ports. |
235 | 410 |
The policies have the same form as exit policies below. |
411 |
+</DL> |
|
412 |
+<P> |
|
413 |
+ |
|
414 |
+<DL COMPACT> |
|
236 | 415 |
<DT><B>TrackHostExits </B><I>host</I>,<I>.domain</I>,<I>...</I><DD> |
237 | 416 |
For each value in the comma separated list, Tor will track recent connections |
238 | 417 |
to hosts that match this value and attempt to |
... | ... |
@@ -244,6 +423,10 @@ your IP address changes. Note that this option does have the disadvantage of |
244 | 423 |
making it more clear that a given history is |
245 | 424 |
associated with a single user. However, most people who would wish to observe |
246 | 425 |
this will observe it through cookies or other protocol-specific means anyhow. |
426 |
+</DL> |
|
427 |
+<P> |
|
428 |
+ |
|
429 |
+<DL COMPACT> |
|
247 | 430 |
<DT><B>TrackHostExitsExpire </B><I>NUM</I><DD> |
248 | 431 |
Since exit servers go up and down, it is desirable to expire the association |
249 | 432 |
between host and exit server after NUM seconds of inactivity. The default |
... | ... |
@@ -256,12 +439,22 @@ is 1800 seconds (30 minutes). |
256 | 439 |
<P> |
257 | 440 |
|
258 | 441 |
The following options are useful only for servers (that is, if <B>ORPort</B> is non-zero): |
442 |
+<P> |
|
443 |
+ |
|
259 | 444 |
<DL COMPACT> |
260 | 445 |
<DT><B>Address </B><I>address</I><DD> |
261 | 446 |
The IP or fqdn of this server (e.g. moria.mit.edu). You can leave this |
262 | 447 |
unset, and Tor will guess your IP. |
448 |
+</DL> |
|
449 |
+<P> |
|
450 |
+ |
|
451 |
+<DL COMPACT> |
|
263 | 452 |
<DT><B>ContactInfo </B><I>email_address</I><DD> |
264 | 453 |
Administrative contact information for server. |
454 |
+</DL> |
|
455 |
+<P> |
|
456 |
+ |
|
457 |
+<DL COMPACT> |
|
265 | 458 |
<DT><B>ExitPolicy </B><I>policy</I>,<I>policy</I>,<I>...</I><DD> |
266 | 459 |
Set an exit policy for this server. Each policy is of the form |
267 | 460 |
"<B>accept</B>|<B>reject</B> <I>ADDR</I>[<B>/</B><I>MASK</I>]<B>[:</B><I>PORT</I>]". |
... | ... |
@@ -306,30 +499,62 @@ either a reject *:* or an accept *:*. Otherwise, you're _augmenting_ |
306 | 499 |
</DL> |
307 | 500 |
|
308 | 501 |
|
502 |
+</DL> |
|
503 |
+<P> |
|
504 |
+ |
|
505 |
+<DL COMPACT> |
|
309 | 506 |
<DT><B>MaxOnionsPending </B><I>NUM</I><DD> |
310 | 507 |
If you have more than this number of onionskins queued for decrypt, reject new ones. (Default: 100) |
508 |
+</DL> |
|
509 |
+<P> |
|
510 |
+ |
|
511 |
+<DL COMPACT> |
|
311 | 512 |
<DT><B>MyFamily </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD> |
312 | 513 |
Declare that this Tor server is controlled or administered by a group |
313 | 514 |
or organization identical or similar to that of the other named servers. |
314 | 515 |
When two servers both declare that they are in the same 'family', Tor clients |
315 | 516 |
will not use them in the same circuit. (Each server only needs to list the |
316 | 517 |
other servers in its family; it doesn't need to list itself, but it won't hurt.) |
518 |
+</DL> |
|
519 |
+<P> |
|
520 |
+ |
|
521 |
+<DL COMPACT> |
|
317 | 522 |
<DT><B>Nickname </B><I>name</I><DD> |
318 | 523 |
Set the server's nickname to 'name'. |
524 |
+</DL> |
|
525 |
+<P> |
|
526 |
+ |
|
527 |
+<DL COMPACT> |
|
319 | 528 |
<DT><B>NoPublish </B><B>0</B>|<B>1</B><DD> |
320 | 529 |
If you set NoPublish 1, Tor will act as a server if you have an ORPort |
321 | 530 |
defined, but it will not publish its descriptor to the dirservers. This |
322 | 531 |
option is useful if you're testing out your server, or if you're using |
323 | 532 |
alternate dirservers (e.g. for other Tor networks such as Blossom). |
324 | 533 |
(Default: 0) |
534 |
+</DL> |
|
535 |
+<P> |
|
536 |
+ |
|
537 |
+<DL COMPACT> |
|
325 | 538 |
<DT><B>NumCPUs </B><I>num</I><DD> |
326 | 539 |
How many processes to use at once for decrypting onionskins. (Default: 1) |
540 |
+</DL> |
|
541 |
+<P> |
|
542 |
+ |
|
543 |
+<DL COMPACT> |
|
327 | 544 |
<DT><B>ORPort </B><I>PORT</I><DD> |
328 | 545 |
Advertise this port to listen for connections from Tor clients and servers. |
546 |
+</DL> |
|
547 |
+<P> |
|
548 |
+ |
|
549 |
+<DL COMPACT> |
|
329 | 550 |
<DT><B>ORBindAddress </B><I>IP</I>[:<I>PORT</I>]<DD> |
330 | 551 |
Bind to this IP address to listen for connections from Tor clients and |
331 | 552 |
servers. If you specify a port, bind to this port rather than the one |
332 | 553 |
specified in ORPort. (Default: 0.0.0.0) |
554 |
+</DL> |
|
555 |
+<P> |
|
556 |
+ |
|
557 |
+<DL COMPACT> |
|
333 | 558 |
<DT><B>RedirectExit </B><I>pattern target</I><DD> |
334 | 559 |
Whenever an outgoing connection tries to connect to one of a given set |
335 | 560 |
of addresses, connect to <I>target</I> (an <I>address:port</I> pair) instead. |
... | ... |
@@ -341,15 +566,27 @@ successfully, no subsequent rules are considered. You can specify that no |
341 | 566 |
redirection is to be performed on a given set of addresses by using the |
342 | 567 |
special target string "pass", which prevents subsequent rules from being |
343 | 568 |
considered. |
569 |
+</DL> |
|
570 |
+<P> |
|
571 |
+ |
|
572 |
+<DL COMPACT> |
|
344 | 573 |
<DT><B>ShutdownWaitLength</B><I>NUM</I><DD> |
345 | 574 |
When we get a SIGINT and we're a server, we begin shutting down: we close |
346 | 575 |
listeners and start refusing new circuits. After <B>NUM</B> seconds, |
347 | 576 |
we exit. If we get a second SIGINT, we exit immediately. (Default: |
348 | 577 |
30 seconds) |
578 |
+</DL> |
|
579 |
+<P> |
|
580 |
+ |
|
581 |
+<DL COMPACT> |
|
349 | 582 |
<DT><B>DirPostPeriod </B><I>N</I> <B>seconds</B>|<B>minutes</B>|<B>hours</B>|<B>days</B>|<B>weeks</B><DD> |
350 | 583 |
Every time the specified period elapses, Tor uploads its server |
351 | 584 |
descriptors to the directory servers. This information is also |
352 | 585 |
uploaded whenever it changes. (Default: 20 minutes) |
586 |
+</DL> |
|
587 |
+<P> |
|
588 |
+ |
|
589 |
+<DL COMPACT> |
|
353 | 590 |
<DT><B>AccountingMax </B><I>N</I> <B>bytes</B>|<B>KB</B>|<B>MB</B>|<B>GB</B>|<B>TB</B><DD> |
354 | 591 |
Never send more than the specified number of bytes in a given |
355 | 592 |
accounting period, or receive more than that number in the period. |
... | ... |
@@ -364,6 +601,10 @@ enabling hibernation is preferable to setting a low bandwidth, since it |
364 | 601 |
provides users with a collection of fast servers that are up some of |
365 | 602 |
the time, which is more useful than a set of slow servers that are |
366 | 603 |
always "available". |
604 |
+</DL> |
|
605 |
+<P> |
|
606 |
+ |
|
607 |
+<DL COMPACT> |
|
367 | 608 |
<DT><B>AccountingStart </B><B>day</B>|<B>week</B>|<B>month</B> [<I>day</I>] <I>HH:MM</I><DD> |
368 | 609 |
Specify how long accounting periods last. If <B>month</B> is given, |
369 | 610 |
each accounting period runs from the time <I>HH:MM</I> on the |
... | ... |
@@ -383,6 +624,8 @@ next day. All times are local, and given in 24-hour time. (Defaults to |
383 | 624 |
<P> |
384 | 625 |
|
385 | 626 |
The following options are useful only for directory servers (that is, if <B>DirPort</B> is non-zero): |
627 |
+<P> |
|
628 |
+ |
|
386 | 629 |
<DL COMPACT> |
387 | 630 |
<DT><B>AuthoritativeDirectory </B><B>0</B>|<B>1</B><DD> |
388 | 631 |
When this option is set to 1, Tor operates as an authoritative |
... | ... |
@@ -391,24 +634,48 @@ own list of good servers, signs it, and sends that to the clients. |
391 | 634 |
Unless the clients already have you listed as a trusted directory, you |
392 | 635 |
probably do not want to set this option. Please coordinate with the other |
393 | 636 |
admins at <A HREF="mailto:tor-ops@freehaven.net">tor-ops@freehaven.net</A> if you think you should be a directory. |
637 |
+</DL> |
|
638 |
+<P> |
|
639 |
+ |
|
640 |
+<DL COMPACT> |
|
394 | 641 |
<DT><B>DirPort </B><I>PORT</I><DD> |
395 | 642 |
Advertise the directory service on this port. |
643 |
+</DL> |
|
644 |
+<P> |
|
645 |
+ |
|
646 |
+<DL COMPACT> |
|
396 | 647 |
<DT><B>DirBindAddress </B><I>IP</I>[:<I>PORT</I>]<DD> |
397 | 648 |
Bind the directory service to this address. If you specify a port, bind |
398 | 649 |
to this port rather than the one specified in DirPort. (Default: 0.0.0.0) |
650 |
+</DL> |
|
651 |
+<P> |
|
652 |
+ |
|
653 |
+<DL COMPACT> |
|
399 | 654 |
<DT><B>DirPolicy </B><I>policy</I>,<I>policy</I>,<I>...</I><DD> |
400 | 655 |
Set an entrance policy for this server, to limit who can connect to the directory ports. |
401 | 656 |
The policies have the same form as exit policies above. |
657 |
+</DL> |
|
658 |
+<P> |
|
659 |
+ |
|
660 |
+<DL COMPACT> |
|
402 | 661 |
<DT><B>RecommendedVersions </B><I>STRING</I><DD> |
403 | 662 |
STRING is a command-separated list of Tor versions currently believed |
404 | 663 |
to be safe. The list is included in each directory, and nodes which |
405 | 664 |
pull down the directory learn whether they need to upgrade. This |
406 | 665 |
option can appear multiple times: the values from multiple lines are |
407 | 666 |
spliced together. |
667 |
+</DL> |
|
668 |
+<P> |
|
669 |
+ |
|
670 |
+<DL COMPACT> |
|
408 | 671 |
<DT><B>DirAllowPrivateAddresses </B><B>0</B>|<B>1</B><DD> |
409 | 672 |
If set to 1, Tor will accept router descriptors with arbitrary "Address" |
410 | 673 |
elements. Otherwise, if the address is not an IP or is a private IP, |
411 | 674 |
it will reject the router descriptor. Defaults to 0. |
675 |
+</DL> |
|
676 |
+<P> |
|
677 |
+ |
|
678 |
+<DL COMPACT> |
|
412 | 679 |
<DT><B>RunTesting </B><B>0</B>|<B>1</B><DD> |
413 | 680 |
If set to 1, Tor tries to build circuits through all of the servers it |
414 | 681 |
knows about, so it can tell which are up and which are down. This |
... | ... |
@@ -422,24 +689,42 @@ don't want to use it. |
422 | 689 |
<P> |
423 | 690 |
|
424 | 691 |
The following options are used to configure a hidden service. |
692 |
+<P> |
|
693 |
+ |
|
425 | 694 |
<DL COMPACT> |
426 | 695 |
<DT><B>HiddenServiceDir </B><I>DIRECTORY</I><DD> |
427 | 696 |
Store data files for a hidden service in DIRECTORY. Every hidden |
428 | 697 |
service must have a separate directory. You may use this option multiple |
429 | 698 |
times to specify multiple services. |
699 |
+</DL> |
|
700 |
+<P> |
|
701 |
+ |
|
702 |
+<DL COMPACT> |
|
430 | 703 |
<DT><B>HiddenServicePort </B><I>VIRTPORT </I>[<I>TARGET</I>]<DD> |
431 | 704 |
Configure a virtual port VIRTPORT for a hidden service. You may use this |
432 | 705 |
option multiple times; each time applies to the service using the most recent |
433 | 706 |
hiddenservicedir. By default, this option maps the virtual port to the |
434 | 707 |
same port on 127.0.0.1. You may override the target port, address, or both |
435 | 708 |
by specifying a target of addr, port, or addr:port. |
709 |
+</DL> |
|
710 |
+<P> |
|
711 |
+ |
|
712 |
+<DL COMPACT> |
|
436 | 713 |
<DT><B>HiddenServiceNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD> |
437 | 714 |
If possible, use the specified nodes as introduction points for the hidden |
438 | 715 |
service. If this is left unset, Tor will be smart and pick some reasonable |
439 | 716 |
ones; most people can leave this unset. |
717 |
+</DL> |
|
718 |
+<P> |
|
719 |
+ |
|
720 |
+<DL COMPACT> |
|
440 | 721 |
<DT><B>HiddenServiceExcludeNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD> |
441 | 722 |
Do not use the specified nodes as introduction points for the hidden |
442 | 723 |
service. In normal use there is no reason to set this. |
724 |
+</DL> |
|
725 |
+<P> |
|
726 |
+ |
|
727 |
+<DL COMPACT> |
|
443 | 728 |
<DT><B>RendPostPeriod </B><I>N</I> <B>seconds</B>|<B>minutes</B>|<B>hours</B>|<B>days</B>|<B>weeks</B><DD> |
444 | 729 |
Every time the specified period elapses, Tor uploads any rendezvous |
445 | 730 |
service descriptors to the directory servers. This information is also |
... | ... |
@@ -453,28 +738,58 @@ uploaded whenever it changes. (Default: 20 minutes) |
453 | 738 |
<H2>SIGNALS</H2> |
454 | 739 |
|
455 | 740 |
Tor catches the following signals: |
741 |
+<P> |
|
742 |
+ |
|
456 | 743 |
<DL COMPACT> |
457 | 744 |
<DT><B>SIGTERM</B><DD> |
458 | 745 |
Tor will catch this, clean up and sync to disk if necessary, and exit. |
746 |
+</DL> |
|
747 |
+<P> |
|
748 |
+ |
|
749 |
+<DL COMPACT> |
|
459 | 750 |
<DT><B>SIGINT</B><DD> |
460 | 751 |
Tor clients behave as with SIGTERM; but Tor servers will do a controlled |
461 | 752 |
slow shutdown, closing listeners and waiting 30 seconds before exiting. |
462 | 753 |
(The delay can be configured with the ShutdownWaitLength config option.) |
754 |
+</DL> |
|
755 |
+<P> |
|
756 |
+ |
|
757 |
+<DL COMPACT> |
|
463 | 758 |
<DT><B>SIGHUP</B><DD> |
464 | 759 |
The signal instructs Tor to reload its configuration (including closing |
465 | 760 |
and reopening logs), fetch a new directory, and kill and restart its |
466 | 761 |
helper processes if applicable. |
762 |
+</DL> |
|
763 |
+<P> |
|
764 |
+ |
|
765 |
+<DL COMPACT> |
|
467 | 766 |
<DT><B>SIGUSR1</B><DD> |
468 | 767 |
Log statistics about current connections, past connections, and |
469 | 768 |
throughput. |
769 |
+</DL> |
|
770 |
+<P> |
|
771 |
+ |
|
772 |
+<DL COMPACT> |
|
470 | 773 |
<DT><B>SIGUSR2</B><DD> |
471 | 774 |
Switch all logs to loglevel debug. You can go back to the old loglevels |
472 | 775 |
by sending a SIGHUP. |
776 |
+</DL> |
|
777 |
+<P> |
|
778 |
+ |
|
779 |
+<DL COMPACT> |
|
473 | 780 |
<DT><B>SIGCHLD</B><DD> |
474 | 781 |
Tor receives this signal when one of its helper processes has exited, |
475 | 782 |
so it can clean up. |
783 |
+</DL> |
|
784 |
+<P> |
|
785 |
+ |
|
786 |
+<DL COMPACT> |
|
476 | 787 |
<DT><B>SIGPIPE</B><DD> |
477 | 788 |
Tor catches this signal and ignores it. |
789 |
+</DL> |
|
790 |
+<P> |
|
791 |
+ |
|
792 |
+<DL COMPACT> |
|
478 | 793 |
<DT><B>SIGXFSZ</B><DD> |
479 | 794 |
If this signal exists on your platform, Tor catches and ignores it. |
480 | 795 |
<P> |
... | ... |
@@ -482,11 +797,17 @@ If this signal exists on your platform, Tor catches and ignores it. |
482 | 797 |
<A NAME="lbAK"> </A> |
483 | 798 |
<H2>FILES</H2> |
484 | 799 |
|
800 |
+<P> |
|
801 |
+ |
|
485 | 802 |
<DL COMPACT> |
486 | 803 |
<DT><I>@CONFDIR@/torrc</I> |
487 | 804 |
|
488 | 805 |
<DD> |
489 | 806 |
The configuration file, which contains "option value" pairs. |
807 |
+</DL> |
|
808 |
+<P> |
|
809 |
+ |
|
810 |
+<DL COMPACT> |
|
490 | 811 |
<DT><I>@LOCALSTATEDIR@/lib/tor/</I> |
491 | 812 |
|
492 | 813 |
<DD> |
... | ... |
@@ -537,6 +858,6 @@ Roger Dingledine <<A HREF="mailto:arma@mit.edu">arma@mit.edu</A>>, Nick Ma |
537 | 858 |
This document was created by |
538 | 859 |
<A HREF="../">man2html</A>, |
539 | 860 |
using the manual pages.<BR> |
540 |
-Time: 00:17:30 GMT, June 23, 2005 |
|
861 |
+Time: 22:36:14 GMT, June 26, 2005 |
|
541 | 862 |
</BODY> |
542 | 863 |
</HTML> |
543 | 864 |