tor-webwml.git

Strukturansicht: e6b1101f9
e6b1101f911853bbcf5600de2ee5e6a257e7f9b0
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
1) Content-type: text/html
2) 
3) <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4) <HTML><HEAD><TITLE>Man page of TOR</TITLE>
5) </HEAD><BODY>
6) <H1>TOR</H1>
Thomas Sjögren Update tor-manual-cvs.html

Thomas Sjögren authored 19 years ago

 
7) Section: User Commands  (1)<BR>Updated: May 2005<BR><A HREF="#index">Index</A>
Thomas Sjögren Updated tor-manual-cvs.html...

Thomas Sjögren authored 19 years ago

 
8) <A HREF="../">Return to Main Contents</A><HR>
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
9) 
10) <A NAME="lbAB">&nbsp;</A>
11) <H2>NAME</H2>
12) 
13) tor - The second-generation onion router
14) <A NAME="lbAC">&nbsp;</A>
15) <H2>SYNOPSIS</H2>
16) 
17) <B>tor</B>
18) 
19) [<I>OPTION value</I>]...
20) <A NAME="lbAD">&nbsp;</A>
21) <H2>DESCRIPTION</H2>
22) 
23) <I>tor</I>
24) 
25) is a connection-oriented anonymizing communication
26) service. Users choose a source-routed path through a set of nodes, and
27) negotiate a &quot;virtual circuit&quot; through the network, in which each node
28) knows its predecessor and successor, but no others. Traffic flowing down
29) the circuit is unwrapped by a symmetric key at each node, which reveals
30) the downstream node.
31) <P>
32) 
33) Basically <I>tor</I> provides a distributed network of servers (&quot;onion
34) routers&quot;). Users bounce their TCP streams -- web traffic, ftp, ssh, etc --
35) around the routers, and recipients, observers, and even the routers
36) themselves have difficulty tracking the source of the stream.
37) <A NAME="lbAE">&nbsp;</A>
38) <H2>OPTIONS</H2>
39) 
40) <B>-h, -help</B>
41) Display a short help message and exit.
42) <DL COMPACT>
43) <DT><B>-f </B><I>FILE</I><DD>
44) FILE contains further &quot;option value&quot; pairs. (Default: @CONFDIR@/torrc)
45) <DT>Other options can be specified either on the command-line (<I>--option<DD>
46) value</I>), or in the configuration file (<I>option value</I>).
47) Options are case-insensitive.
48) <DT><B>BandwidthRate </B><I>N</I> <B>bytes</B>|<B>KB</B>|<B>MB</B>|<B>GB</B>|<B>TB</B><DD>
49) A token bucket limits the average incoming bandwidth on this node to
Thomas Sjögren update tor-manual-cvs.html

Thomas Sjögren authored 19 years ago

 
50) the specified number of bytes per second. (Default: 2 MB)
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
51) <DT><B>BandwidthBurst </B><I>N</I> <B>bytes</B>|<B>KB</B>|<B>MB</B>|<B>GB</B>|<B>TB</B><DD>
Thomas Sjögren update tor-manual-cvs.html

Thomas Sjögren authored 19 years ago

 
52) Limit the maximum token bucket size (also known as the burst) to the given number of bytes. (Default: 5 MB)
Thomas Sjögren Updated tor-manual-cvs.html...

Thomas Sjögren authored 19 years ago

 
53) <DT><B>MaxAdvertisedBandwidth </B><I>N</I> <B>bytes</B>|<B>KB</B>|<B>MB</B>|<B>GB</B>|<B>TB</B><DD>
54) If set, we will not advertise more than this amount of bandwidth for our
55) BandwidthRate. Server operators who want to reduce the number of clients
56) who ask to build circuits through them (since this is proportional to
57) advertised bandwidth rate) can thus reduce the CPU demands on their
58) server without impacting network performance.
Thomas Sjögren Update tor-manual-cvs.html

Thomas Sjögren authored 19 years ago

 
59) <DT><B>ControlPort </B><I>Port</I><DD>
60) If set, Tor will accept connections from the same machine (localhost only) on
61) this port, and allow those connections to control the Tor process using the
62) Tor Control Protocol (described in control-spec.txt).  Note: unless you also
63) specify one of <B>HashedControlPassword</B> or <B>CookieAuthentication</B>,
64) setting this option will cause Tor to allow any process on the local host to
65) control it.
66) <DT><B>HashedControlPassword </B><I>hashed_password</I><DD>
67) Don't allow any connections on the control port except when the other process
68) knows the password whose one-way hash is <I>hashed_password</I>.  You can
69) compute the hash of a password by running &quot;tor --hash-password
70) <I>password</I>&quot;.
71) <DT><B>CookieAuthentication </B><B>0</B>|<B>1</B><DD>
72) If this option is set to 1, don't allow any connections on the control port
73) except when the connecting process knows the contents of a file named
74) &quot;control_auth_cookie&quot;, which Tor will create in its data directory.  This
75) authentication methods should only be used on systems with good filesystem
76) security. (Default: 0)
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
77) <DT><B>DataDirectory </B><I>DIR</I><DD>
78) Store working data in DIR (Default: @LOCALSTATEDIR@/lib/tor)
Thomas Sjögren Update tor-manual-cvs.html

Thomas Sjögren authored 19 years ago

 
79) <DT><B>DirFetchPeriod </B><I>N</I> <B>seconds</B>|<B>minutes</B>|<B>hours</B>|<B>days</B>|<B>weeks</B><DD>
80) Every time the specified period elapses, Tor downloads a directory.
81) A directory contains a signed list of all known servers as well as
82) their current liveness status. A value of &quot;0 seconds&quot; tells Tor to choose an
Thomas Sjögren Update tor-manual-cvs.html...

Thomas Sjögren authored 19 years ago

 
83) appropriate default. (Default: 1 hour for clients, 20 minutes for servers)
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
84) <DT><B>DirServer </B><I>address:port fingerprint</I><DD>
85) Use a nonstandard authoritative directory server at the provided
86) address and port, with the specified key fingerprint.  This option can
87) be repeated many times, for multiple authoritative directory
88) servers. If no <B>dirserver</B> line is given, Tor will use the default
89) directory servers: moria1, moria2, and tor26.
90) <DT><B>Group </B><I>GID</I><DD>
91) On startup, setgid to this user.
92) <DT><B>HttpProxy</B> <I>host</I>[:<I>port</I>]<DD>
93) If set, Tor will make all its directory requests through this host:port,
94) rather than connecting directly to any directory servers.
95) <DT><B>HttpsProxy</B> <I>host</I>[:<I>port</I>]<DD>
96) If set, Tor will make all its OR (SSL) connections through this host:port,
97) via HTTP CONNECT, rather than connecting directly to servers.
Thomas Sjögren Update tor-manual-cvs.html...

Thomas Sjögren authored 19 years ago

 
98) You may want to set <B>FascistFirewall</B> to restrict the set of ports you
99) might try to connect to, if your Https proxy only allows connecting to certain
100) ports.
Thomas Sjögren Update tor-manual-cvs.html

Thomas Sjögren authored 19 years ago

 
101) <DT><B>HttpsProxyAuthenticator</B> <I>username:password</I><DD>
102) If defined, Tor will use this username:password for Basic Https proxy
103) authentication, as in RFC 2617. This is currently the only form of
104) Https proxy authentication that Tor supports; feel free to submit a
Thomas Sjögren Update tor-manual-cvs.html...

Thomas Sjögren authored 19 years ago

 
105) patch if you want it to support others.
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
106) <DT><B>KeepalivePeriod </B><I>NUM</I><DD>
107) To keep firewalls from expiring connections, send a padding keepalive
Thomas Sjögren Update tor-manual-cvs.html...

Thomas Sjögren authored 19 years ago

 
108) cell on open connections every NUM seconds. (Default: 5 minutes)
Thomas Sjögren Update tor-manual-cvs.html

Thomas Sjögren authored 19 years ago

 
109) <DT><B>Log </B><I>minSeverity</I>[-<I>maxSeverity</I>] <B>stderr</B>|<B>stdout</B>|<B>syslog</B><DD>
110) Send all messages between <I>minSeverity</I> and <I>maxSeverity</I> to
111) the standard output stream, the standard error stream, or to the system
112) log. (The &quot;syslog&quot; value is only supported on Unix.)  Recognized
113) severity levels are debug, info, notice, warn, and err.  If only one
114) severity level is given, all messages of that level or higher will be
115) sent to the listed destination.
116) <DT><B>Log </B><I>minSeverity</I>[-<I>maxSeverity</I>] <B>file</B> <I>FILENAME</I><DD>
117) As above, but send log messages to the listed filename.  The &quot;Log&quot;
118) option may appear more than once in a configuration file.  Messages
119) are sent to all the logs that match their severity level.
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
120) <DT><B>MaxConn </B><I>NUM</I><DD>
121) Maximum number of simultaneous sockets allowed.  You probably don't need
122) to adjust this. (Default: 1024)
123) <DT><B>OutboundBindAddress </B><I>IP</I><DD>
124) Make all outbound connections originate from the IP address specified.  This
125) is only useful when you have multiple network interfaces, and you want all
126) of Tor's outgoing connections to use a single one.
127) <DT><B>PIDFile </B><I>FILE</I><DD>
128) On startup, write our PID to FILE. On clean shutdown, remove FILE.
129) <DT><B>RunAsDaemon </B><B>0</B>|<B>1</B><DD>
130) If 1, Tor forks and daemonizes to the background. (Default: 0)
Thomas Sjögren Update tor-manual-cvs.html

Thomas Sjögren authored 19 years ago

 
131) <DT><B>SafeLogging </B><B>0</B>|<B>1</B><DD>
132) If 1, Tor replaces potentially sensitive strings in the logs
133) (e.g. addresses) with the string [scrubbed]. This way logs can still be
134) useful, but they don't leave behind personally identifying information
135) about what sites a user might have visited. (Default: 1)
136) <DT><B>StatusFetchPeriod </B><I>N</I> <B>seconds</B>|<B>minutes</B>|<B>hours</B>|<B>days</B>|<B>weeks</B><DD>
137) Every time the specified period elapses, Tor downloads signed status
138) information about the current state of known servers.  A value of
139) &quot;0 seconds&quot; tells Tor to choose an appropriate default. (Default: 30
Thomas Sjögren Update tor-manual-cvs.html...

Thomas Sjögren authored 19 years ago

 
140) minutes for clients, 15 minutes for servers)
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
141) <DT><B>User </B><I>UID</I><DD>
142) On startup, setuid to this user.
143) <P>
144) </DL>
145) <A NAME="lbAF">&nbsp;</A>
146) <H2>CLIENT OPTIONS</H2>
147) 
148) <P>
149) 
150) The following options are useful only for clients (that is, if <B>SOCKSPort</B> is non-zero):
151) <DL COMPACT>
152) <DT><B>AllowUnverifiedNodes</B> <B>entry</B>|<B>exit</B>|<B>middle</B>|<B>introduction</B>|<B>rendezvous</B>|...<DD>
153) Where on our circuits should we allow Tor servers that the directory
Thomas Sjögren Update tor-manual-cvs.html...

Thomas Sjögren authored 19 years ago

 
154) servers haven't authenticated as &quot;verified&quot;?  (Default: middle,rendezvous)
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
155) <DT><B>ClientOnly </B><B>0</B>|<B>1</B><DD>
Thomas Sjögren Update tor-manual-cvs.html

Thomas Sjögren authored 19 years ago

 
156) If set to 1, Tor will under no circumstances run as a server. The default
157) is to run as a client unless ORPort is configured.  (Usually,
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
158) you don't need to set this; Tor is pretty smart at figuring out whether
Thomas Sjögren Update tor-manual-cvs.html

Thomas Sjögren authored 19 years ago

 
159) you are reliable and high-bandwidth enough to be a useful server.)
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
160) <DT><B>EntryNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD>
161) A list of preferred nodes to use for the first hop in the circuit, if possible.
162) <DT><B>ExitNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD>
163) A list of preferred nodes to use for the last hop in the circuit, if possible.
164) <DT><B>ExcludeNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD>
165) A list of nodes to never use when building a circuit.
166) <DT><B>StrictExitNodes </B><B>0</B>|<B>1</B><DD>
167) If 1, Tor will never use any nodes besides those listed in &quot;exitnodes&quot; for
168) the last hop of a circuit.
169) <DT><B>StrictEntryNodes </B><B>0</B>|<B>1</B><DD>
170) If 1, Tor will never use any nodes besides those listed in &quot;entrynodes&quot; for
171) the first hop of a circuit.
172) <DT><B>FascistFirewall </B><B>0</B>|<B>1</B><DD>
173) If 1, Tor will only create outgoing connections to ORs running on ports that
174) your firewall allows (defaults to 80 and 443; see <B>FirewallPorts</B>).  This will
175) allow you to run Tor as a client behind a firewall with restrictive policies,
176) but will not allow you to run as a server behind such a firewall.
177) <DT><B>FirewallPorts </B><I>PORTS</I><DD>
178) A list of ports that your firewall allows you to connect to.  Only used when
Thomas Sjögren Update tor-manual-cvs.html...

Thomas Sjögren authored 19 years ago

 
179) <B>FascistFirewall</B> is set. (Default: 80, 443)
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
180) <DT><B>LongLivedPorts </B><I>PORTS</I><DD>
181) A list of ports for services that tend to have long-running connections
182) (e.g. chat and interactive shells). Circuits for streams that use these
183) ports will contain only high-uptime nodes, to reduce the chance that a
Thomas Sjögren Update tor-manual-cvs.html...

Thomas Sjögren authored 19 years ago

 
184) node will go down before the stream is finished. (Default: 21, 22, 706, 1863, 5050, 
185) 5190, 5222, 5223, 6667, 8300, 8888)
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
186) <DT><B>MapAddress</B> <I>address</I> <I>newaddress</I><DD>
Thomas Sjögren Update tor-manual-cvs.html...

Thomas Sjögren authored 19 years ago

 
187) When a request for address arrives to Tor, it will rewrite it to newaddress before 
188) processing it. For example, if you always want connections to <A HREF="http://www.indymedia.org">www.indymedia.org</A> to 
189) exit via <I>torserver</I> (where <I>torserver</I> is the nickname of the server), 
190) use &quot;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>&quot;.
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
191) <DT><B>NewCircuitPeriod </B><I>NUM</I><DD>
Thomas Sjögren Update tor-manual-cvs.html

Thomas Sjögren authored 19 years ago

 
192) Every NUM seconds consider whether to build a new circuit. (Default: 30 seconds)
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
193) <DT><B>MaxCircuitDirtiness </B><I>NUM</I><DD>
194) Feel free to reuse a circuit that was first used at most NUM seconds
Thomas Sjögren Update tor-manual-cvs.html

Thomas Sjögren authored 19 years ago

 
195) ago, but never attach a new stream to a circuit that is too old. (Default: 10 minutes)
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
196) <DT><B>NodeFamily </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD>
197) The named Tor servers constitute a &quot;family&quot; of similar or co-administered
198) servers, so never use any two of them in the same circuit. Defining a
199) NodeFamily is only needed when a server doesn't list the family itself
200) (with MyFamily). This option can be used multiple times.
201) <DT>
202) <DD>
203) 
204)
Thomas Sjögren Update tor-manual-cvs.html...

Thomas Sjögren authored 19 years ago

 
205)
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
206) <B>RendNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I>
207) A list of preferred nodes to use for the rendezvous point, if possible.
208) <DT><B>RendExcludeNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD>
209) A list of nodes to never use when choosing a rendezvous point.
210) <DT><B>SOCKSPort </B><I>PORT</I><DD>
Thomas Sjögren Update tor-manual-cvs.html

Thomas Sjögren authored 19 years ago

 
211) Advertise this port to listen for connections from SOCKS-speaking
212) applications.  Set this to 0 if you don't want to allow application
213) connections. (Default: 9050)
214) <DT><B>SOCKSBindAddress </B><I>IP</I>[:<I>PORT</I>]<DD>
215) Bind to this address to listen for connections from SOCKS-speaking
216) applications. (Default: 127.0.0.1) You can also specify a port
217) (e.g. 192.168.0.1:9100). This directive can be specified multiple times
218) to bind to multiple addresses/ports.
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
219) <DT><B>SOCKSPolicy </B><I>policy</I>,<I>policy</I>,<I>...</I><DD>
Thomas Sjögren Update tor-manual-cvs.html...

Thomas Sjögren authored 19 years ago

 
220) Set an entrance policy for this server, to limit who can connect to the SOCKS ports. 
221) The policies have the same form as exit policies below.
Thomas Sjögren update tor-manual-cvs.html

Thomas Sjögren authored 19 years ago

 
222) <DT><B>TrackHostExits </B><I>host</I>,<I>.domain</I>,<I>...</I><DD>
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
223) For each value in the comma separated list, Tor will track recent connections
224) to hosts that match this value and attempt to
225) reuse the same exit node for each. If the value is prepended with a '.', it is
226) treated as matching an entire domain. If one of the values is just a '.', it
227) means match everything. This option is useful if you frequently connect to
228) sites that will expire all your authentication cookies (ie log you out) if
229) your IP address changes. Note that this option does have the disadvantage of
230) making it more clear that a given history is
231) associated with a single user. However, most people who would wish to observe
232) this will observe it through cookies or other protocol-specific means anyhow.
233) <DT><B>TrackHostExitsExpire </B><I>NUM</I><DD>
234) Since exit servers go up and down, it is desirable to expire the association
235) between host and exit server after NUM seconds of inactivity. The default
236) is 1800 seconds (30 minutes).
237) <P>
238) </DL>
239) <A NAME="lbAG">&nbsp;</A>
240) <H2>SERVER OPTIONS</H2>
241) 
242) <P>
243) 
244) The following options are useful only for servers (that is, if <B>ORPort</B> is non-zero):
245) <DL COMPACT>
246) <DT><B>Address </B><I>address</I><DD>
247) The IP or fqdn of this server (e.g. moria.mit.edu). You can leave this
248) unset, and Tor will guess your IP.
249) <DT><B>ContactInfo </B><I>email_address</I><DD>
250) Administrative contact information for server.
251) <DT><B>ExitPolicy </B><I>policy</I>,<I>policy</I>,<I>...</I><DD>
252) Set an exit policy for this server. Each policy is of the form
253) &quot;<B>accept</B>|<B>reject</B> <I>ADDR</I>[<B>/</B><I>MASK</I>]<B>:</B><I>PORT</I>&quot;.
254) If <B>/</B><I>MASK</I> is omitted then this policy just applies to the host
255) given.  Instead of giving a host or network you can also use &quot;<B>*</B>&quot; to
256) denote the universe (0.0.0.0/0).  <I>PORT</I> can be a single port number,
257) an interval of ports &quot;<I>FROM_PORT</I><B>-</B><I>TO_PORT</I>&quot;, or &quot;<B>*</B>&quot;.
258) <P>
259) For example, &quot;reject 127.0.0.1:*,reject 192.168.1.0/24:*,accept *:*&quot; would
260) reject any traffic destined for localhost and any 192.168.1.* address, but
261) accept anything else.
262) <P>
263) This directive can be specified multiple times so you don't have to put
264) it all on one line.
265) <P>
266) See RFC 3330 for more details about internal and reserved IP address
267) space. Policies are considered first to last, and the first match wins. If
268) you want to _replace_ the default exit policy, end your exit policy with
269) either a reject *:* or an accept *:*. Otherwise, you're _augmenting_
270) (prepending to) the default exit policy. The default exit policy is:
271) 
272) <DL COMPACT><DT><DD>
273) <DL COMPACT>
274) <DT>reject 0.0.0.0/8<DD>
275) <DT>reject 169.254.0.0/16<DD>
276) <DT>reject 127.0.0.0/8<DD>
277) <DT>reject 192.168.0.0/16<DD>
278) <DT>reject 10.0.0.0/8<DD>
279) <DT>reject 172.16.0.0/12<DD>
280) <DT>reject *:25<DD>
281) <DT>reject *:119<DD>
282) <DT>reject *:135-139<DD>
283) <DT>reject *:445<DD>
284) <DT>reject *:1214<DD>
285) <DT>reject *:4661-4666<DD>
286) <DT>reject *:6346-6429<DD>
287) <DT>reject *:6699<DD>
288) <DT>reject *:6881-6999<DD>
289) <DT>accept *:*<DD>
290) </DL>
291) </DL>
292) 
293) 
294) <DT><B>MaxOnionsPending </B><I>NUM</I><DD>
295) If you have more than this number of onionskins queued for decrypt, reject new ones. (Default: 100)
296) <DT><B>MyFamily </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD>
297) Declare that this Tor server is controlled or administered by a group
298) or organization identical or similar to that of the other named servers.
299) When two servers both declare that they are in the same 'family', Tor clients
300) will not use them in the same circuit.  (Each server only needs to list the
301) other servers in its family; it doesn't need to list itself, but it won't hurt.)
302) <DT><B>Nickname </B><I>name</I><DD>
303) Set the server's nickname to 'name'.
304) <DT><B>NumCPUs </B><I>num</I><DD>
305) How many processes to use at once for decrypting onionskins. (Default: 1)
306) <DT><B>ORPort </B><I>PORT</I><DD>
Thomas Sjögren Update tor-manual-cvs.html

Thomas Sjögren authored 19 years ago

 
307) Advertise this port to listen for connections from Tor clients and servers.
308) <DT><B>ORBindAddress </B><I>IP</I>[:<I>PORT</I>]<DD>
309) Bind to this IP address to listen for connections from Tor clients and
310) servers. If you specify a port, bind to this port rather than the one
311) specified in ORPort. (Default: 0.0.0.0)
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
312) <DT><B>RedirectExit </B><I>pattern target</I><DD>
313) Whenever an outgoing connection tries to connect to one of a given set
314) of addresses, connect to <I>target</I> (an <I>address:port</I> pair) instead.
315) The address
316) pattern is given in the same format as for an exit policy.  The
317) address translation applies after exit policies are applied.  Multiple
318) <B>RedirectExit</B> options can be used: once any one has matched
319) successfully, no subsequent rules are considered.  You can specify that no
320) redirection is to be performed on a given set of addresses by using the
321) special target string &quot;pass&quot;, which prevents subsequent rules from being
322) considered.
323) <DT><B>ShutdownWaitLength</B><I>NUM</I><DD>
324) When we get a SIGINT and we're a server, we begin shutting down: we close
325) listeners and start refusing new circuits. After <B>NUM</B> seconds,
326) we exit. If we get a second SIGINT, we exit immediately.  (Default:
327) 30 seconds)
328) <DT><B>DirPostPeriod </B><I>N</I> <B>seconds</B>|<B>minutes</B>|<B>hours</B>|<B>days</B>|<B>weeks</B><DD>
329) Every time the specified period elapses, Tor uploads its server
330) descriptors to the directory servers.  This information is also
Thomas Sjögren Update tor-manual-cvs.html...

Thomas Sjögren authored 19 years ago

 
331) uploaded whenever it changes.  (Default: 20 minutes)
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
332) <DT><B>AccountingMax </B><I>N</I> <B>bytes</B>|<B>KB</B>|<B>MB</B>|<B>GB</B>|<B>TB</B><DD>
333) Never send more than the specified number of bytes in a given
334) accounting period, or receive more than that number in the period.
Thomas Sjögren Update tor-manual-cvs.html

Thomas Sjögren authored 19 years ago

 
335) For example, with AccountingMax set to 1 GB, a server could send 900 MB
336) and receive 800 MB and continue running. It will only hibernate once one
337) of the two reaches 1 GB.
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
338) When the number of bytes is exhausted, Tor will hibernate until some
339) time in the next accounting period.  To prevent all servers from
340) waking at the same time, Tor will also wait until a random point in
341) each period before waking up.  If you have bandwidth cost issues,
Thomas Sjögren Updated tor-manual-cvs.html...

Thomas Sjögren authored 19 years ago

 
342) enabling hibernation is preferable to setting a low bandwidth, since it
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
343) provides users with a collection of fast servers that are up some of
344) the time, which is more useful than a set of slow servers that are
345) always &quot;available&quot;.
346) <DT><B>AccountingStart </B><B>day</B>|<B>week</B>|<B>month</B> [<I>day</I>] <I>HH:MM</I><DD>
347) Specify how long accounting periods last.  If <B>month</B> is given,
348) each accounting period runs from the time <I>HH:MM</I> on the
349) <I>day</I>th day of one month to the same day and time of the next.
350) (The day must be between 1 and 28.)  If <B>week</B> is given, each
351) accounting period runs from the time <I>HH:MM</I> of the <I>day</I>th
352) day of one week to the same day and time of the next week, with Monday
353) as day 1 and Sunday as day 7.  If <B>day</B> is given, each accounting
354) period runs from the time <I>HH:MM</I> each day to the same time on the
355) next day.  All times are local, and given in 24-hour time.  (Defaults to
356) &quot;month 1 0:00&quot;.)
357) <P>
358) </DL>
359) <A NAME="lbAH">&nbsp;</A>
360) <H2>DIRECTORY SERVER OPTIONS</H2>
361) 
362) <P>
363) 
364) The following options are useful only for directory servers (that is, if <B>DirPort</B> is non-zero):
365) <DL COMPACT>
366) <DT><B>AuthoritativeDirectory </B><B>0</B>|<B>1</B><DD>
367) When this option is set to 1, Tor operates as an authoritative
368) directory server.  Instead of caching the directory, it generates its
369) own list of good servers, signs it, and sends that to the clients.
370) Unless the clients already have you listed as a trusted directory, you
371) probably do not want to set this option.  Please coordinate with the other
372) admins at <A HREF="mailto:tor-ops@freehaven.net">tor-ops@freehaven.net</A> if you think you should be a directory.
373) <DT><B>DirPort </B><I>PORT</I><DD>
Thomas Sjögren Update tor-manual-cvs.html

Thomas Sjögren authored 19 years ago

 
374) Advertise the directory service on this port.
375) <DT><B>DirBindAddress </B><I>IP</I>[:<I>PORT</I>]<DD>
376) Bind the directory service to this address. If you specify a port, bind
377) to this port rather than the one specified in DirPort. (Default: 0.0.0.0)
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
378) <DT><B>DirPolicy </B><I>policy</I>,<I>policy</I>,<I>...</I><DD>
Thomas Sjögren Update tor-manual-cvs.html...

Thomas Sjögren authored 19 years ago

 
379) Set an entrance policy for this server, to limit who can connect to the directory ports. 
380) The policies have the same form as exit policies above.
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
381) <DT><B>RecommendedVersions </B><I>STRING</I><DD>
382) STRING is a command-separated list of Tor versions currently believed
383) to be safe. The list is included in each directory, and nodes which
384) pull down the directory learn whether they need to upgrade.  This
385) option can appear multiple times: the values from multiple lines are
386) spliced together.
387) <DT><B>DirAllowPrivateAddresses </B><B>0</B>|<B>1</B><DD>
388) If set to 1, Tor will accept router descriptors with arbitrary &quot;Address&quot;
389) elements. Otherwise, if the address is not an IP or is a private IP,
390) it will reject the router descriptor. Defaults to 0.
391) <DT><B>RunTesting </B><B>0</B>|<B>1</B><DD>
392) If set to 1, Tor tries to build circuits through all of the servers it
393) knows about, so it can tell which are up and which are down.  This
394) option is only useful for authoritative directories, so you probably
395) don't want to use it.
396) <P>
397) </DL>
398) <A NAME="lbAI">&nbsp;</A>
399) <H2>HIDDEN SERVICE OPTIONS</H2>
400) 
401) <P>
402) 
403) The following options are used to configure a hidden service.
404) <DL COMPACT>
405) <DT><B>HiddenServiceDir </B><I>DIRECTORY</I><DD>
406) Store data files for a hidden service in DIRECTORY.  Every hidden
407) service must have a separate directory.  You may use this option multiple
408) times to specify multiple services.
409) <DT><B>HiddenServicePort </B><I>VIRTPORT </I>[<I>TARGET</I>]<DD>
410) Configure a virtual port VIRTPORT for a hidden service.  You may use this
411) option multiple times; each time applies to the service using the most recent
412) hiddenservicedir.  By default, this option maps the virtual port to the
413) same port on 127.0.0.1.  You may override the target port, address, or both
414) by specifying a target of addr, port, or addr:port.
415) <DT><B>HiddenServiceNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD>
416) If possible, use the specified nodes as introduction points for the hidden
417) service. If this is left unset, Tor will be smart and pick some reasonable
418) ones; most people can leave this unset.
419) <DT><B>HiddenServiceExcludeNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD>
420) Do not use the specified nodes as introduction points for the hidden
421) service. In normal use there is no reason to set this.
Thomas Sjögren Update tor-manual-cvs.html

Thomas Sjögren authored 19 years ago

 
422) <DT><B>RendPostPeriod </B><I>N</I> <B>seconds</B>|<B>minutes</B>|<B>hours</B>|<B>days</B>|<B>weeks</B><DD>
423) Every time the specified period elapses, Tor uploads any rendezvous
424) service descriptors to the directory servers.  This information is also
Thomas Sjögren Update tor-manual-cvs.html...

Thomas Sjögren authored 19 years ago

 
425) uploaded whenever it changes.  (Default: 20 minutes)
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
426) <P>
427) 
428) 
429) <P>
430) </DL>
431) <A NAME="lbAJ">&nbsp;</A>
432) <H2>SIGNALS</H2>
433) 
434) Tor catches the following signals:
435) <DL COMPACT>
436) <DT><B>SIGTERM</B><DD>
437) Tor will catch this, clean up and sync to disk if necessary, and exit.
438) <DT><B>SIGINT</B><DD>
439) Tor clients behave as with SIGTERM; but Tor servers will do a controlled
440) slow shutdown, closing listeners and waiting 30 seconds before exiting.
Thomas Sjögren Update tor-manual-cvs.html

Thomas Sjögren authored 19 years ago

 
441) (The delay can be configured with the ShutdownWaitLength config option.)
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
442) <DT><B>SIGHUP</B><DD>
443) The signal instructs Tor to reload its configuration (including closing
444) and reopening logs), fetch a new directory, and kill and restart its
445) helper processes if applicable.
446) <DT><B>SIGUSR1</B><DD>
447) Log statistics about current connections, past connections, and
448) throughput.
449) <DT><B>SIGUSR2</B><DD>
450) Switch all logs to loglevel debug. You can go back to the old loglevels
451) by sending a SIGHUP.
452) <DT><B>SIGCHLD</B><DD>
453) Tor receives this signal when one of its helper processes has exited,
454) so it can clean up.
455) <DT><B>SIGPIPE</B><DD>
456) Tor catches this signal and ignores it.
457) <DT><B>SIGXFSZ</B><DD>
458) If this signal exists on your platform, Tor catches and ignores it.
459) <P>
460) </DL>
461) <A NAME="lbAK">&nbsp;</A>
462) <H2>FILES</H2>
463) 
464) <DL COMPACT>
465) <DT><I>@CONFDIR@/torrc</I>
466) 
467) <DD>
468) The configuration file, which contains &quot;option value&quot; pairs.
469) <DT><I>@LOCALSTATEDIR@/lib/tor/</I>
470) 
471) <DD>
472) The tor process stores keys and other data here.
473) <P>
474) </DL>
475) <A NAME="lbAL">&nbsp;</A>
476) <H2>SEE ALSO</H2>
477)
Thomas Sjögren Updated tor-manual-cvs.html...

Thomas Sjögren authored 19 years ago

 
478) <B><A HREF="../?1+privoxy">privoxy</A></B>(1),
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
479)
Thomas Sjögren Updated tor-manual-cvs.html...

Thomas Sjögren authored 19 years ago

 
480) <B><A HREF="../?1+tsocks">tsocks</A></B>(1),
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
481)
Thomas Sjögren Updated tor-manual-cvs.html...

Thomas Sjögren authored 19 years ago

 
482) <B><A HREF="../?1+torify">torify</A></B>(1)
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
483) 
484) <P>
485) <B><A HREF="http://tor.eff.org/">http://tor.eff.org/</A></B>
486) 
487) <P>
488) <A NAME="lbAM">&nbsp;</A>
489) <H2>BUGS</H2>
490)
Thomas Sjögren Update tor-manual-cvs.html

Thomas Sjögren authored 19 years ago

 
491) Plenty, probably. Tor is still in development. Please report them.
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
492) <A NAME="lbAN">&nbsp;</A>
493) <H2>AUTHORS</H2>
494) 
495) Roger Dingledine &lt;<A HREF="mailto:arma@mit.edu">arma@mit.edu</A>&gt;, Nick Mathewson &lt;<A HREF="mailto:nickm@alum.mit.edu">nickm@alum.mit.edu</A>&gt;.
496) <P>
497) 
498) <HR>
499) <A NAME="index">&nbsp;</A><H2>Index</H2>
500) <DL>
501) <DT><A HREF="#lbAB">NAME</A><DD>
502) <DT><A HREF="#lbAC">SYNOPSIS</A><DD>
503) <DT><A HREF="#lbAD">DESCRIPTION</A><DD>
504) <DT><A HREF="#lbAE">OPTIONS</A><DD>
505) <DT><A HREF="#lbAF">CLIENT OPTIONS</A><DD>
506) <DT><A HREF="#lbAG">SERVER OPTIONS</A><DD>
507) <DT><A HREF="#lbAH">DIRECTORY SERVER OPTIONS</A><DD>
508) <DT><A HREF="#lbAI">HIDDEN SERVICE OPTIONS</A><DD>
509) <DT><A HREF="#lbAJ">SIGNALS</A><DD>
510) <DT><A HREF="#lbAK">FILES</A><DD>
511) <DT><A HREF="#lbAL">SEE ALSO</A><DD>
512) <DT><A HREF="#lbAM">BUGS</A><DD>
513) <DT><A HREF="#lbAN">AUTHORS</A><DD>
514) </DL>
515) <HR>
516) This document was created by
Thomas Sjögren Updated tor-manual-cvs.html...

Thomas Sjögren authored 19 years ago

 
517) <A HREF="../">man2html</A>,
Thomas Sjögren tor-manual is now for the l...

Thomas Sjögren authored 19 years ago

 
518) using the manual pages.<BR>
Thomas Sjögren Update tor-manual-cvs.html...

Thomas Sjögren authored 19 years ago

 
519) Time: 14:06:07 GMT, May 23, 2005