1 // Copyright (c) The Tor Project, Inc.
2 // See LICENSE for licensing information
3 // This is an asciidoc file used to generate the manpage/html reference.
4 // Learn asciidoc on http://www.methods.co.nz/asciidoc/userguide.html
10 tor - The second-generation onion router
15 **tor** [__OPTION__ __value__]...
19 __tor__ is a connection-oriented anonymizing communication
20 service. Users choose a source-routed path through a set of nodes, and
21 negotiate a "virtual circuit" through the network, in which each node
22 knows its predecessor and successor, but no others. Traffic flowing down
23 the circuit is unwrapped by a symmetric key at each node, which reveals
24 the downstream node. +
26 Basically __tor__ provides a distributed network of servers ("onion routers").
27 Users bounce their TCP streams -- web traffic, ftp, ssh, etc -- around the
28 routers, and recipients, observers, and even the routers themselves have
29 difficulty tracking the source of the stream.
34 Display a short help message and exit.
37 FILE contains further "option value" paris. (Default: @CONFDIR@/torrc)
40 Generates a hashed password for control port access.
42 **--list-fingerprint**::
43 Generate your keys and output your nickname and fingerprint.
46 Verify the configuration file is valid.
49 **--service [install|remove|start|stop]** Manage the Tor Windows
50 NT/2000/XP service. Current instructions can be found at
51 https://wiki.torproject.org/noreply/TheOnionRouter/TorFAQ#WinNTService
53 **--list-torrc-options**::
54 List all valid options.
57 Display Tor version and exit.
60 Do not start Tor with a console log unless explicitly requested to do so.
61 (By default, Tor starts out logging messages at level "notice" or higher to
62 the console, until it has parsed its configuration.)
64 Other options can be specified either on the command-line (--option
65 value), or in the configuration file (option value or option "value").
66 Options are case-insensitive. C-style escaped characters are allowed inside
67 quoted values. Options on the command line take precedence over
68 options found in the configuration file, except indicated otherwise. To
69 split one configuration entry into multiple lines, use a single \ before
70 the end of the line. Comments can be used in such multiline entries, but
71 they must start at the beginning of a line.
73 **BandwidthRate** __N__ **bytes**|**KB**|**MB**|**GB**::
74 A token bucket limits the average incoming bandwidth usage on this node to
75 the specified number of bytes per second, and the average outgoing
76 bandwidth usage to that same value. If you want to run a relay in the
77 public network, this needs to be _at the very least_ 20 KB (that is,
78 20480 bytes). (Default: 5 MB)
80 **BandwidthBurst** __N__ **bytes**|**KB**|**MB**|**GB**::
81 Limit the maximum token bucket size (also known as the burst) to the given
82 number of bytes in each direction. (Default: 10 MB)
84 **MaxAdvertisedBandwidth** __N__ **bytes**|**KB**|**MB**|**GB**::
85 If set, we will not advertise more than this amount of bandwidth for our
86 BandwidthRate. Server operators who want to reduce the number of clients
87 who ask to build circuits through them (since this is proportional to
88 advertised bandwidth rate) can thus reduce the CPU demands on their server
89 without impacting network performance.
91 **RelayBandwidthRate** __N__ **bytes**|**KB**|**MB**|**GB**::
92 If defined, a separate token bucket limits the average incoming bandwidth
93 usage for \_relayed traffic_ on this node to the specified number of bytes
94 per second, and the average outgoing bandwidth usage to that same value.
95 Relayed traffic currently is calculated to include answers to directory
96 requests, but that may change in future versions. (Default: 0)
98 **RelayBandwidthBurst** __N__ **bytes**|**KB**|**MB**|**GB**::
99 Limit the maximum token bucket size (also known as the burst) for
100 \_relayed traffic_ to the given number of bytes in each direction.
103 **PerConnBWRate** __N__ **bytes**|**KB**|**MB**|**GB**::
104 If set, do separate rate limiting for each connection from a non-relay.
105 You should never need to change this value, since a network-wide value is
106 published in the consensus and your relay will use that value. (Default: 0)
108 **PerConnBWBurst** __N__ **bytes**|**KB**|**MB**|**GB**::
109 If set, do separate rate limiting for each connection from a non-relay.
110 You should never need to change this value, since a network-wide value is
111 published in the consensus and your relay will use that value. (Default: 0)
113 **ConLimit** __NUM__::
114 The minimum number of file descriptors that must be available to the Tor
115 process before it will start. Tor will ask the OS for as many file
116 descriptors as the OS will allow (you can find this by "ulimit -H -n").
117 If this number is less than ConnLimit, then Tor will refuse to start. +
119 You probably don't need to adjust this. It has no effect on Windows
120 since that platform lacks getrlimit(). (Default: 1000)
122 **ConstrainedSockets** **0**|**1**::
123 If set, Tor will tell the kernel to attempt to shrink the buffers for all
124 sockets to the size specified in **ConstrainedSockSize**. This is useful for
125 virtual servers and other environments where system level TCP buffers may
126 be limited. If you're on a virtual server, and you encounter the "Error
127 creating network socket: No buffer space available" message, you are
128 likely experiencing this problem. +
130 The preferred solution is to have the admin increase the buffer pool for
131 the host itself via /proc/sys/net/ipv4/tcp_mem or equivalent facility;
132 this configuration option is a second-resort. +
134 The DirPort option should also not be used if TCP buffers are scarce. The
135 cached directory requests consume additional sockets which exacerbates
138 You should **not** enable this feature unless you encounter the "no buffer
139 space available" issue. Reducing the TCP buffers affects window size for
140 the TCP stream and will reduce throughput in proportion to round trip
141 time on long paths. (Default: 0.)
143 **ConstrainedSockSize** __N__ **bytes**|**KB**::
144 When **ConstrainedSockets** is enabled the receive and transmit buffers for
145 all sockets will be set to this limit. Must be a value between 2048 and
146 262144, in 1024 byte increments. Default of 8192 is recommended.
148 **ControlPort** __Port__::
149 If set, Tor will accept connections on this port and allow those
150 connections to control the Tor process using the Tor Control Protocol
151 (described in control-spec.txt). Note: unless you also specify one of
152 **HashedControlPassword** or **CookieAuthentication**, setting this option will
153 cause Tor to allow any process on the local host to control it. This
154 option is required for many Tor controllers; most use the value of 9051.
156 **ControlListenAddress** __IP__[:__PORT__]::
157 Bind the controller listener to this address. If you specify a port, bind
158 to this port rather than the one specified in ControlPort. We strongly
159 recommend that you leave this alone unless you know what you're doing,
160 since giving attackers access to your control listener is really
161 dangerous. (Default: 127.0.0.1) This directive can be specified multiple
162 times to bind to multiple addresses/ports.
164 **ControlSocket** __Path__::
165 Like ControlPort, but listens on a Unix domain socket, rather than a TCP
166 socket. (Unix and Unix-like systems only.)
168 **HashedControlPassword** __hashed_password__::
169 Don't allow any connections on the control port except when the other
170 process knows the password whose one-way hash is __hashed_password__. You
171 can compute the hash of a password by running "tor --hash-password
172 __password__". You can provide several acceptable passwords by using more
173 than one HashedControlPassword line.
175 **CookieAuthentication** **0**|**1**::
176 If this option is set to 1, don't allow any connections on the control port
177 except when the connecting process knows the contents of a file named
178 "control_auth_cookie", which Tor will create in its data directory. This
179 authentication method should only be used on systems with good filesystem
180 security. (Default: 0)
182 **CookieAuthFile** __Path__::
183 If set, this option overrides the default location and file name
184 for Tor's cookie file. (See CookieAuthentication above.)
186 **CookieAuthFileGroupReadable** **0**|**1**|__Groupname__::
187 If this option is set to 0, don't allow the filesystem group to read the
188 cookie file. If the option is set to 1, make the cookie file readable by
189 the default GID. [Making the file readable by other groups is not yet
190 implemented; let us know if you need this for some reason.] (Default: 0).
192 **DataDirectory** __DIR__::
193 Store working data in DIR (Default: @LOCALSTATEDIR@/lib/tor)
195 **DirServer** [__nickname__] [**flags**] __address__:__port__ __fingerprint__::
196 Use a nonstandard authoritative directory server at the provided address
197 and port, with the specified key fingerprint. This option can be repeated
198 many times, for multiple authoritative directory servers. Flags are
199 separated by spaces, and determine what kind of an authority this directory
200 is. By default, every authority is authoritative for current ("v2")-style
201 directories, unless the "no-v2" flag is given. If the "v1" flags is
202 provided, Tor will use this server as an authority for old-style (v1)
203 directories as well. (Only directory mirrors care about this.) Tor will
204 use this server as an authority for hidden service information if the "hs"
205 flag is set, or if the "v1" flag is set and the "no-hs" flag is **not** set.
206 Tor will use this authority as a bridge authoritative directory if the
207 "bridge" flag is set. If a flag "orport=**port**" is given, Tor will use the
208 given port when opening encrypted tunnels to the dirserver. Lastly, if a
209 flag "v3ident=**fp**" is given, the dirserver is a v3 directory authority
210 whose v3 long-term signing key has the fingerprint **fp**. +
212 If no **dirserver** line is given, Tor will use the default directory
213 servers. NOTE: this option is intended for setting up a private Tor
214 network with its own directory authorities. If you use it, you will be
215 distinguishable from other users, because you won't believe the same
218 **AlternateDirAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__ +
220 **AlternateHSAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__ +
222 **AlternateBridgeAuthority** [__nickname__] [**flags**] __address__:__port__ __ fingerprint__::
223 As DirServer, but replaces less of the default directory authorities. Using
224 AlternateDirAuthority replaces the default Tor directory authorities, but
225 leaves the hidden service authorities and bridge authorities in place.
226 Similarly, Using AlternateHSAuthority replaces the default hidden service
227 authorities, but not the directory or bridge authorities.
229 **DisableAllSwap** **0**|**1**::
230 If set to 1, Tor will attempt to lock all current and future memory pages,
231 so that memory cannot be paged out. Windows, OS X and Solaris are currently
232 not supported. We believe that this feature works on modern Gnu/Linux
233 distributions, and that it should work on *BSD systems (untested). This
234 option requires that you start your Tor as root, and you should use the
235 **User** option to properly reduce Tor's privileges. (Default: 0)
237 **FetchDirInfoEarly** **0**|**1**::
238 If set to 1, Tor will always fetch directory information like other
239 directory caches, even if you don't meet the normal criteria for fetching
240 early. Normal users should leave it off. (Default: 0)
242 **FetchDirInfoExtraEarly** **0**|**1**::
243 If set to 1, Tor will fetch directory information before other directory
244 caches. It will attempt to download directory information closer to the
245 start of the consensus period. Normal users should leave it off.
248 **FetchHidServDescriptors** **0**|**1**::
249 If set to 0, Tor will never fetch any hidden service descriptors from the
250 rendezvous directories. This option is only useful if you're using a Tor
251 controller that handles hidden service fetches for you. (Default: 1)
253 **FetchServerDescriptors** **0**|**1**::
254 If set to 0, Tor will never fetch any network status summaries or server
255 descriptors from the directory servers. This option is only useful if
256 you're using a Tor controller that handles directory fetches for you.
259 **FetchUselessDescriptors** **0**|**1**::
260 If set to 1, Tor will fetch every non-obsolete descriptor from the
261 authorities that it hears about. Otherwise, it will avoid fetching useless
262 descriptors, for example for routers that are not running. This option is
263 useful if you're using the contributed "exitlist" script to enumerate Tor
264 nodes that exit to certain addresses. (Default: 0)
266 **HTTPProxy** __host__[:__port__]::
267 Tor will make all its directory requests through this host:port (or host:80
268 if port is not specified), rather than connecting directly to any directory
271 **HTTPProxyAuthenticator** __username:password__::
272 If defined, Tor will use this username:password for Basic HTTP proxy
273 authentication, as in RFC 2617. This is currently the only form of HTTP
274 proxy authentication that Tor supports; feel free to submit a patch if you
275 want it to support others.
277 **HTTPSProxy** __host__[:__port__]::
278 Tor will make all its OR (SSL) connections through this host:port (or
279 host:443 if port is not specified), via HTTP CONNECT rather than connecting
280 directly to servers. You may want to set **FascistFirewall** to restrict
281 the set of ports you might try to connect to, if your HTTPS proxy only
282 allows connecting to certain ports.
284 **HTTPSProxyAuthenticator** __username:password__::
285 If defined, Tor will use this username:password for Basic HTTPS proxy
286 authentication, as in RFC 2617. This is currently the only form of HTTPS
287 proxy authentication that Tor supports; feel free to submit a patch if you
288 want it to support others.
290 **Socks4Proxy** __host__[:__port__]::
291 Tor will make all OR connections through the SOCKS 4 proxy at host:port
292 (or host:1080 if port is not specified).
294 **Socks5Proxy** __host__[:__port__]::
295 Tor will make all OR connections through the SOCKS 5 proxy at host:port
296 (or host:1080 if port is not specified).
298 **Socks5ProxyUsername** __username__ +
300 **Socks5ProxyPassword** __password__::
301 If defined, authenticate to the SOCKS 5 server using username and password
302 in accordance to RFC 1929. Both username and password must be between 1 and
305 **KeepalivePeriod** __NUM__::
306 To keep firewalls from expiring connections, send a padding keepalive cell
307 every NUM seconds on open connections that are in use. If the connection
308 has no open circuits, it will instead be closed after NUM seconds of
309 idleness. (Default: 5 minutes)
311 **Log** __minSeverity__[-__maxSeverity__] **stderr**|**stdout**|**syslog**::
312 Send all messages between __minSeverity__ and __maxSeverity__ to the standard
313 output stream, the standard error stream, or to the system log. (The
314 "syslog" value is only supported on Unix.) Recognized severity levels are
315 debug, info, notice, warn, and err. We advise using "notice" in most cases,
316 since anything more verbose may provide sensitive information to an
317 attacker who obtains the logs. If only one severity level is given, all
318 messages of that level or higher will be sent to the listed destination.
320 **Log** __minSeverity__[-__maxSeverity__] **file** __FILENAME__::
321 As above, but send log messages to the listed filename. The
322 "Log" option may appear more than once in a configuration file.
323 Messages are sent to all the logs that match their severity
326 **OutboundBindAddress** __IP__::
327 Make all outbound connections originate from the IP address specified. This
328 is only useful when you have multiple network interfaces, and you want all
329 of Tor's outgoing connections to use a single one. This setting will be
330 ignored for connections to the loopback addresses (127.0.0.0/8 and ::1).
332 **PidFile** __FILE__::
333 On startup, write our PID to FILE. On clean shutdown, remove
336 **ProtocolWarnings** **0**|**1**::
337 If 1, Tor will log with severity \'warn' various cases of other parties not
338 following the Tor specification. Otherwise, they are logged with severity
339 \'info'. (Default: 0)
341 **RunAsDaemon** **0**|**1**::
342 If 1, Tor forks and daemonizes to the background. This option has no effect
343 on Windows; instead you should use the --service command-line option.
347 **SafeLogging** **0**|**1**|**relay**::
348 Tor can scrub potentially sensitive strings from log messages (e.g.
349 addresses) by replacing them with the string [scrubbed]. This way logs can
350 still be useful, but they don't leave behind personally identifying
351 information about what sites a user might have visited. +
353 If this option is set to 0, Tor will not perform any scrubbing, if it is
354 set to 1, all potentially sensitive strings are replaced. If it is set to
355 relay, all log messages generated when acting as a relay are sanitized, but
356 all messages generated when acting as a client are not. (Default: 1)
359 On startup, setuid to this user and setgid to their primary group.
361 **HardwareAccel** **0**|**1**::
362 If non-zero, try to use built-in (static) crypto hardware acceleration when
363 available. (Default: 0)
365 **AccelName** __NAME__::
366 When using OpenSSL hardware crypto acceleration attempt to load the dynamic
367 engine of this name. This must be used for any dynamic hardware engine.
368 Names can be verified with the openssl engine command.
370 **AccelDir** __DIR__::
371 Specify this option if using dynamic hardware acceleration and the engine
372 implementation library resides somewhere other than the OpenSSL default.
374 **AvoidDiskWrites** **0**|**1**::
375 If non-zero, try to write to disk less frequently than we would otherwise.
376 This is useful when running on flash memory or other media that support
377 only a limited number of writes. (Default: 0)
379 **TunnelDirConns** **0**|**1**::
380 If non-zero, when a directory server we contact supports it, we will build
381 a one-hop circuit and make an encrypted connection via its ORPort.
384 **PreferTunneledDirConns** **0**|**1**::
385 If non-zero, we will avoid directory servers that don't support tunneled
386 directory connections, when possible. (Default: 1)
388 **CircuitPriorityHalflife** __NUM1__::
389 If this value is set, we override the default algorithm for choosing which
390 circuit's cell to deliver or relay next. When the value is 0, we
391 round-robin between the active circuits on a connection, delivering one
392 cell from each in turn. When the value is positive, we prefer delivering
393 cells from whichever connection has the lowest weighted cell count, where
394 cells are weighted exponentially according to the supplied
395 CircuitPriorityHalflife value (in seconds). If this option is not set at
396 all, we use the behavior recommended in the current consensus
397 networkstatus. This is an advanced option; you generally shouldn't have
398 to mess with it. (Default: not set.)
403 The following options are useful only for clients (that is, if
404 **SocksPort** is non-zero):
406 **AllowInvalidNodes** **entry**|**exit**|**middle**|**introduction**|**rendezvous**|**...**::
407 If some Tor servers are obviously not working right, the directory
408 authorities can manually mark them as invalid, meaning that it's not
409 recommended you use them for entry or exit positions in your circuits. You
410 can opt to use them in some circuit positions, though. The default is
411 "middle,rendezvous", and other choices are not advised.
413 **ExcludeSingleHopRelays** **0**|**1**::
414 This option controls whether circuits built by Tor will include relays with
415 the AllowSingleHopExits flag set to true. If ExcludeSingleHopRelays is set
416 to 0, these relays will be included. Note that these relays might be at
417 higher risk of being seized or observed, so they are not normally included.
420 **Bridge** __IP__:__ORPort__ [fingerprint]::
421 When set along with UseBridges, instructs Tor to use the relay at
422 "IP:ORPort" as a "bridge" relaying into the Tor network. If "fingerprint"
423 is provided (using the same format as for DirServer), we will verify that
424 the relay running at that location has the right fingerprint. We also use
425 fingerprint to look up the bridge descriptor at the bridge authority, if
426 it's provided and if UpdateBridgesFromAuthority is set too.
428 **LearnCircuitBuildTimeout** **0**|**1**::
429 If 0, CircuitBuildTimeout adaptive learning is disabled. (Default: 1)
431 **CircuitBuildTimeout** __NUM__::
433 Try for at most NUM seconds when building circuits. If the circuit isn't
434 open in that time, give up on it. If LearnCircuitBuildTimeout is 1, this
435 value serves as the initial value to use before a timeout is learned. If
436 LearnCircuitBuildTimeout is 0, this value is the only value used.
437 (Default: 60 seconds.)
439 **CircuitIdleTimeout** __NUM__::
440 If we have kept a clean (never used) circuit around for NUM seconds, then
441 close it. This way when the Tor client is entirely idle, it can expire all
442 of its circuits, and then expire its TLS connections. Also, if we end up
443 making a circuit that is not useful for exiting any of the requests we're
444 receiving, it won't forever take up a slot in the circuit list. (Default: 1
447 **CircuitStreamTimeout** __NUM__::
448 If non-zero, this option overrides our internal timeout schedule for how
449 many seconds until we detach a stream from a circuit and try a new circuit.
450 If your network is particularly slow, you might want to set this to a
451 number like 60. (Default: 0)
453 **ClientOnly** **0**|**1**::
454 If set to 1, Tor will under no circumstances run as a server or serve
455 directory requests. The default is to run as a client unless ORPort is
456 configured. (Usually, you don't need to set this; Tor is pretty smart at
457 figuring out whether you are reliable and high-bandwidth enough to be a
458 useful server.) (Default: 0)
460 **ExcludeNodes** __node__,__node__,__...__::
461 A list of identity fingerprints, nicknames, country codes and address
462 patterns of nodes to never use when building a circuit. (Example:
463 ExcludeNodes SlowServer, $ EFFFFFFFFFFFFFFF, \{cc}, 255.254.0.0/8)
465 **ExcludeExitNodes** __node__,__node__,__...__::
466 A list of identity fingerprints, nicknames, country codes and address
467 patterns of nodes to never use when picking an exit node. Note that any
468 node listed in ExcludeNodes is automatically considered to be part of this
471 **EntryNodes** __node__,__node__,__...__::
472 A list of identity fingerprints, nicknames, country codes and address
473 patterns of nodes to use for the first hop in normal circuits. These are
474 treated only as preferences unless StrictNodes (see below) is also set.
476 **ExitNodes** __node__,__node__,__...__::
477 A list of identity fingerprints, nicknames, country codes and address
478 patterns of nodes to use for the last hop in normal exit circuits. These
479 are treated only as preferences unless StrictNodes (see below) is also set.
481 **StrictNodes** **0**|**1**::
482 If 1 and EntryNodes config option is set, Tor will never use any nodes
483 besides those listed in EntryNodes for the first hop of a normal circuit.
484 If 1 and ExitNodes config option is set, Tor will never use any nodes
485 besides those listed in ExitNodes for the last hop of a normal exit
486 circuit. Note that Tor might still use these nodes for non-exit circuits
487 such as one-hop directory fetches or hidden service support circuits.
489 **FascistFirewall** **0**|**1**::
490 If 1, Tor will only create outgoing connections to ORs running on ports
491 that your firewall allows (defaults to 80 and 443; see **FirewallPorts**).
492 This will allow you to run Tor as a client behind a firewall with
493 restrictive policies, but will not allow you to run as a server behind such
494 a firewall. If you prefer more fine-grained control, use
495 ReachableAddresses instead.
497 **FirewallPorts** __PORTS__::
498 A list of ports that your firewall allows you to connect to. Only used when
499 **FascistFirewall** is set. This option is deprecated; use ReachableAddresses
500 instead. (Default: 80, 443)
502 **HidServAuth** __onion-address__ __auth-cookie__ [__service-name__]::
503 Client authorization for a hidden service. Valid onion addresses contain 16
504 characters in a-z2-7 plus ".onion", and valid auth cookies contain 22
505 characters in A-Za-z0-9+/. The service name is only used for internal
506 purposes, e.g., for Tor controllers. This option may be used multiple times
507 for different hidden services. If a hidden service uses authorization and
508 this option is not set, the hidden service is not accessible. Hidden
509 services can be configured to require authorization using the
510 **HiddenServiceAuthorizeClient** option.
512 **ReachableAddresses** __ADDR__[/__MASK__][:__PORT__]...::
513 A comma-separated list of IP addresses and ports that your firewall allows
514 you to connect to. The format is as for the addresses in ExitPolicy, except
515 that "accept" is understood unless "reject" is explicitly provided. For
516 example, \'ReachableAddresses 99.0.0.0/8, reject 18.0.0.0/8:80, accept
517 \*:80' means that your firewall allows connections to everything inside net
518 99, rejects port 80 connections to net 18, and accepts connections to port
519 80 otherwise. (Default: \'accept \*:*'.)
521 **ReachableDirAddresses** __ADDR__[/__MASK__][:__PORT__]...::
522 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
523 these restrictions when fetching directory information, using standard HTTP
524 GET requests. If not set explicitly then the value of
525 **ReachableAddresses** is used. If **HTTPProxy** is set then these
526 connections will go through that proxy.
528 **ReachableORAddresses** __ADDR__[/__MASK__][:__PORT__]...::
529 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
530 these restrictions when connecting to Onion Routers, using TLS/SSL. If not
531 set explicitly then the value of **ReachableAddresses** is used. If
532 **HTTPSProxy** is set then these connections will go through that proxy. +
534 The separation between **ReachableORAddresses** and
535 **ReachableDirAddresses** is only interesting when you are connecting
536 through proxies (see **HTTPProxy** and **HTTPSProxy**). Most proxies limit
537 TLS connections (which Tor uses to connect to Onion Routers) to port 443,
538 and some limit HTTP GET requests (which Tor uses for fetching directory
539 information) to port 80.
541 **LongLivedPorts** __PORTS__::
542 A list of ports for services that tend to have long-running connections
543 (e.g. chat and interactive shells). Circuits for streams that use these
544 ports will contain only high-uptime nodes, to reduce the chance that a node
545 will go down before the stream is finished. (Default: 21, 22, 706, 1863,
546 5050, 5190, 5222, 5223, 6667, 6697, 8300)
548 **MapAddress** __address__ __newaddress__::
549 When a request for address arrives to Tor, it will rewrite it to newaddress
550 before processing it. For example, if you always want connections to
551 www.indymedia.org to exit via __torserver__ (where __torserver__ is the
552 nickname of the server), use "MapAddress www.indymedia.org
553 www.indymedia.org.torserver.exit".
555 **NewCircuitPeriod** __NUM__::
556 Every NUM seconds consider whether to build a new circuit. (Default: 30
559 **MaxCircuitDirtiness** __NUM__::
560 Feel free to reuse a circuit that was first used at most NUM seconds ago,
561 but never attach a new stream to a circuit that is too old. (Default: 10
564 **NodeFamily** __node__,__node__,__...__::
565 The Tor servers, defined by their identity fingerprints or nicknames,
566 constitute a "family" of similar or co-administered servers, so never use
567 any two of them in the same circuit. Defining a NodeFamily is only needed
568 when a server doesn't list the family itself (with MyFamily). This option
569 can be used multiple times.
571 **EnforceDistinctSubnets** **0**|**1**::
572 If 1, Tor will not put two servers whose IP addresses are "too close" on
573 the same circuit. Currently, two addresses are "too close" if they lie in
574 the same /16 range. (Default: 1)
576 **SocksPort** __PORT__::
577 Advertise this port to listen for connections from Socks-speaking
578 applications. Set this to 0 if you don't want to allow application
579 connections. (Default: 9050)
581 **SocksListenAddress** __IP__[:__PORT__]::
582 Bind to this address to listen for connections from Socks-speaking
583 applications. (Default: 127.0.0.1) You can also specify a port (e.g.
584 192.168.0.1:9100). This directive can be specified multiple times to bind
585 to multiple addresses/ports.
587 **SocksPolicy** __policy__,__policy__,__...__::
588 Set an entrance policy for this server, to limit who can connect to the
589 SocksPort and DNSPort ports. The policies have the same form as exit
592 **SocksTimeout** __NUM__::
593 Let a socks connection wait NUM seconds handshaking, and NUM seconds
594 unattached waiting for an appropriate circuit, before we fail it. (Default:
597 **TrackHostExits** __host__,__.domain__,__...__::
598 For each value in the comma separated list, Tor will track recent
599 connections to hosts that match this value and attempt to reuse the same
600 exit node for each. If the value is prepended with a \'.\', it is treated as
601 matching an entire domain. If one of the values is just a \'.', it means
602 match everything. This option is useful if you frequently connect to sites
603 that will expire all your authentication cookies (i.e. log you out) if
604 your IP address changes. Note that this option does have the disadvantage
605 of making it more clear that a given history is associated with a single
606 user. However, most people who would wish to observe this will observe it
607 through cookies or other protocol-specific means anyhow.
609 **TrackHostExitsExpire** __NUM__::
610 Since exit servers go up and down, it is desirable to expire the
611 association between host and exit server after NUM seconds. The default is
612 1800 seconds (30 minutes).
614 **UpdateBridgesFromAuthority** **0**|**1**::
615 When set (along with UseBridges), Tor will try to fetch bridge descriptors
616 from the configured bridge authorities when feasible. It will fall back to
617 a direct request if the authority responds with a 404. (Default: 0)
619 **UseBridges** **0**|**1**::
620 When set, Tor will fetch descriptors for each bridge listed in the "Bridge"
621 config lines, and use these relays as both entry guards and directory
624 **UseEntryGuards** **0**|**1**::
625 If this option is set to 1, we pick a few long-term entry servers, and try
626 to stick with them. This is desirable because constantly changing servers
627 increases the odds that an adversary who owns some servers will observe a
628 fraction of your paths. (Defaults to 1.)
630 **NumEntryGuards** __NUM__::
631 If UseEntryGuards is set to 1, we will try to pick a total of NUM routers
632 as long-term entries for our circuits. (Defaults to 3.)
634 **SafeSocks** **0**|**1**::
635 When this option is enabled, Tor will reject application connections that
636 use unsafe variants of the socks protocol -- ones that only provide an IP
637 address, meaning the application is doing a DNS resolve first.
638 Specifically, these are socks4 and socks5 when not doing remote DNS.
641 **TestSocks** **0**|**1**::
642 When this option is enabled, Tor will make a notice-level log entry for
643 each connection to the Socks port indicating whether the request used a
644 safe socks protocol or an unsafe one (see above entry on SafeSocks). This
645 helps to determine whether an application using Tor is possibly leaking
646 DNS requests. (Default: 0)
648 **WarnUnsafeSocks** **0**|**1**::
649 When this option is enabled, Tor will warn whenever a request is
650 received that only contains an IP address instead of a hostname. Allowing
651 applications to do DNS resolves themselves is usually a bad idea and
652 can leak your location to attackers. (Default: 1)
654 **VirtualAddrNetwork** __Address__/__bits__::
655 When a controller asks for a virtual (unused) address with the MAPADDRESS
656 command, Tor picks an unassigned address from this range. (Default:
659 When providing proxy server service to a network of computers using a tool
660 like dns-proxy-tor, change this address to "10.192.0.0/10" or
661 "172.16.0.0/12". The default **VirtualAddrNetwork** address range on a
662 properly configured machine will route to the loopback interface. For
663 local use, no change to the default VirtualAddrNetwork setting is needed.
665 **AllowNonRFC953Hostnames** **0**|**1**::
666 When this option is disabled, Tor blocks hostnames containing illegal
667 characters (like @ and :) rather than sending them to an exit node to be
668 resolved. This helps trap accidental attempts to resolve URLs and so on.
671 **AllowDotExit** **0**|**1**::
672 If enabled, we convert "www.google.com.foo.exit" addresses on the
673 SocksPort/TransPort/NatdPort into "www.google.com" addresses that exit from
674 the node "foo". Disabled by default since attacking websites and exit
675 relays can use it to manipulate your path selection. (Default: 0)
677 **FastFirstHopPK** **0**|**1**::
678 When this option is disabled, Tor uses the public key step for the first
679 hop of creating circuits. Skipping it is generally safe since we have
680 already used TLS to authenticate the relay and to establish forward-secure
681 keys. Turning this option off makes circuit building slower. +
683 Note that Tor will always use the public key step for the first hop if it's
684 operating as a relay, and it will never use the public key step if it
685 doesn't yet know the onion key of the first hop. (Default: 1)
687 **TransPort** __PORT__::
688 If non-zero, enables transparent proxy support on __PORT__ (by convention,
689 9040). Requires OS support for transparent proxies, such as BSDs' pf or
690 Linux's IPTables. If you're planning to use Tor as a transparent proxy for
691 a network, you'll want to examine and change VirtualAddrNetwork from the
692 default setting. You'll also want to set the TransListenAddress option for
693 the network you'd like to proxy. (Default: 0).
695 **TransListenAddress** __IP__[:__PORT__]::
696 Bind to this address to listen for transparent proxy connections. (Default:
697 127.0.0.1). This is useful for exporting a transparent proxy server to an
700 **NATDPort** __PORT__::
701 Allow old versions of ipfw (as included in old versions of FreeBSD, etc.)
702 to send connections through Tor using the NATD protocol. This option is
703 only for people who cannot use TransPort.
705 **NATDListenAddress** __IP__[:__PORT__]::
706 Bind to this address to listen for NATD connections. (Default: 127.0.0.1).
708 **AutomapHostsOnResolve** **0**|**1**::
709 When this option is enabled, and we get a request to resolve an address
710 that ends with one of the suffixes in **AutomapHostsSuffixes**, we map an
711 unused virtual address to that address, and return the new virtual address.
712 This is handy for making ".onion" addresses work with applications that
713 resolve an address and then connect to it. (Default: 0).
715 **AutomapHostsSuffixes** __SUFFIX__,__SUFFIX__,__...__::
716 A comma-separated list of suffixes to use with **AutomapHostsOnResolve**.
717 The "." suffix is equivalent to "all addresses." (Default: .exit,.onion).
719 **DNSPort** __PORT__::
720 If non-zero, Tor listens for UDP DNS requests on this port and resolves
721 them anonymously. (Default: 0).
723 **DNSListenAddress** __IP__[:__PORT__]::
724 Bind to this address to listen for DNS connections. (Default: 127.0.0.1).
726 **ClientDNSRejectInternalAddresses** **0**|**1**::
727 If true, Tor does not believe any anonymously retrieved DNS answer that
728 tells it that an address resolves to an internal address (like 127.0.0.1 or
729 192.168.0.1). This option prevents certain browser-based attacks; don't
730 turn it off unless you know what you're doing. (Default: 1).
732 **DownloadExtraInfo** **0**|**1**::
733 If true, Tor downloads and caches "extra-info" documents. These documents
734 contain information about servers other than the information in their
735 regular router descriptors. Tor does not use this information for anything
736 itself; to save bandwidth, leave this option turned off. (Default: 0).
738 **FallbackNetworkstatusFile** __FILENAME__::
739 If Tor doesn't have a cached networkstatus file, it starts out using this
740 one instead. Even if this file is out of date, Tor can still use it to
741 learn about directory mirrors, so it doesn't need to put load on the
742 authorities. (Default: None).
744 **WarnPlaintextPorts** __port__,__port__,__...__::
745 Tells Tor to issue a warnings whenever the user tries to make an anonymous
746 connection to one of these ports. This option is designed to alert users
747 to services that risk sending passwords in the clear. (Default:
750 **RejectPlaintextPorts** __port__,__port__,__...__::
751 Like WarnPlaintextPorts, but instead of warning about risky port uses, Tor
752 will instead refuse to make the connection. (Default: None).
757 The following options are useful only for servers (that is, if ORPort
760 **Address** __address__::
761 The IP address or fully qualified domain name of this server (e.g.
762 moria.mit.edu). You can leave this unset, and Tor will guess your IP
763 address. This IP address is the one used to tell clients and other
764 servers where to find your Tor server; it doesn't affect the IP that your
765 Tor client binds to. To bind to a different address, use the
766 *ListenAddress and OutboundBindAddress options.
768 **AllowSingleHopExits** **0**|**1**::
769 This option controls whether clients can use this server as a single hop
770 proxy. If set to 1, clients can use this server as an exit even if it is
771 the only hop in the circuit. (Default: 0)
773 **AssumeReachable** **0**|**1**::
774 This option is used when bootstrapping a new Tor network. If set to 1,
775 don't do self-reachability testing; just upload your server descriptor
776 immediately. If **AuthoritativeDirectory** is also set, this option
777 instructs the dirserver to bypass remote reachability testing too and list
778 all connected servers as running.
780 **BridgeRelay** **0**|**1**::
781 Sets the relay to act as a "bridge" with respect to relaying connections
782 from bridge users to the Tor network. It mainly causes Tor to publish a
783 server descriptor to the bridge database, rather than publishing a relay
784 descriptor to the public directory authorities.
786 **ContactInfo** __email_address__::
787 Administrative contact information for server. This line might get picked
788 up by spam harvesters, so you may want to obscure the fact that it's an
791 **ExitPolicy** __policy__,__policy__,__...__::
792 Set an exit policy for this server. Each policy is of the form
793 "**accept**|**reject** __ADDR__[/__MASK__][:__PORT__]". If /__MASK__ is
794 omitted then this policy just applies to the host given. Instead of giving
795 a host or network you can also use "\*" to denote the universe (0.0.0.0/0).
796 __PORT__ can be a single port number, an interval of ports
797 "__FROM_PORT__-__TO_PORT__", or "\*". If __PORT__ is omitted, that means
800 For example, "accept 18.7.22.69:\*,reject 18.0.0.0/8:\*,accept \*:\*" would
801 reject any traffic destined for MIT except for web.mit.edu, and accept
804 To specify all internal and link-local networks (including 0.0.0.0/8,
805 169.254.0.0/16, 127.0.0.0/8, 192.168.0.0/16, 10.0.0.0/8, and
806 172.16.0.0/12), you can use the "private" alias instead of an address.
807 These addresses are rejected by default (at the beginning of your exit
808 policy), along with your public IP address, unless you set the
809 ExitPolicyRejectPrivate config option to 0. For example, once you've done
810 that, you could allow HTTP to 127.0.0.1 and block all other connections to
811 internal networks with "accept 127.0.0.1:80,reject private:\*", though that
812 may also allow connections to your own computer that are addressed to its
813 public (external) IP address. See RFC 1918 and RFC 3330 for more details
814 about internal and reserved IP address space. +
816 This directive can be specified multiple times so you don't have to put it
819 Policies are considered first to last, and the first match wins. If you
820 want to \_replace_ the default exit policy, end your exit policy with
821 either a reject \*:* or an accept \*:*. Otherwise, you're \_augmenting_
822 (prepending to) the default exit policy. The default exit policy is: +
836 **ExitPolicyRejectPrivate** **0**|**1**::
837 Reject all private (local) networks, along with your own public IP address,
838 at the beginning of your exit policy. See above entry on ExitPolicy.
841 **MaxOnionsPending** __NUM__::
842 If you have more than this number of onionskins queued for decrypt, reject
843 new ones. (Default: 100)
845 **MyFamily** __node__,__node__,__...__::
846 Declare that this Tor server is controlled or administered by a group or
847 organization identical or similar to that of the other servers, defined by
848 their identity fingerprints or nicknames. When two servers both declare
849 that they are in the same \'family', Tor clients will not use them in the
850 same circuit. (Each server only needs to list the other servers in its
851 family; it doesn't need to list itself, but it won't hurt.)
853 **Nickname** __name__::
854 Set the server's nickname to \'name'. Nicknames must be between 1 and 19
855 characters inclusive, and must contain only the characters [a-zA-Z0-9].
857 **NumCPUs** __num__::
858 How many processes to use at once for decrypting onionskins. (Default: 1)
860 **ORPort** __PORT__::
861 Advertise this port to listen for connections from Tor clients and servers.
863 **ORListenAddress** __IP__[:__PORT__]::
864 Bind to this IP address to listen for connections from Tor clients and
865 servers. If you specify a port, bind to this port rather than the one
866 specified in ORPort. (Default: 0.0.0.0) This directive can be specified
867 multiple times to bind to multiple addresses/ports.
869 **PublishServerDescriptor** **0**|**1**|**v1**|**v2**|**v3**|**bridge**|**hidserv**,**...**::
870 This option specifies which descriptors Tor will publish when acting as
871 a relay or hidden service. You can
872 choose multiple arguments, separated by commas.
874 If this option is set to 0, Tor will not publish its
875 descriptors to any directories. (This is useful if you're testing
876 out your server, or if you're using a Tor controller that handles directory
877 publishing for you.) Otherwise, Tor will publish its descriptors of all
878 type(s) specified. The default is "1",
879 which means "if running as a server or a hidden service, publish the
880 appropriate descriptors to the authorities".
882 **ShutdownWaitLength** __NUM__::
883 When we get a SIGINT and we're a server, we begin shutting down:
884 we close listeners and start refusing new circuits. After **NUM**
885 seconds, we exit. If we get a second SIGINT, we exit immedi-
886 ately. (Default: 30 seconds)
889 **AccountingMax** __N__ **bytes**|**KB**|**MB**|**GB**|**TB**::
890 Never send more than the specified number of bytes in a given accounting
891 period, or receive more than that number in the period. For example, with
892 AccountingMax set to 1 GB, a server could send 900 MB and receive 800 MB
893 and continue running. It will only hibernate once one of the two reaches 1
894 GB. When the number of bytes is exhausted, Tor will hibernate until some
895 time in the next accounting period. To prevent all servers from waking at
896 the same time, Tor will also wait until a random point in each period
897 before waking up. If you have bandwidth cost issues, enabling hibernation
898 is preferable to setting a low bandwidth, since it provides users with a
899 collection of fast servers that are up some of the time, which is more
900 useful than a set of slow servers that are always "available".
902 **AccountingStart** **day**|**week**|**month** [__day__] __HH:MM__::
903 Specify how long accounting periods last. If **month** is given, each
904 accounting period runs from the time __HH:MM__ on the __dayth__ day of one
905 month to the same day and time of the next. (The day must be between 1 and
906 28.) If **week** is given, each accounting period runs from the time __HH:MM__
907 of the __dayth__ day of one week to the same day and time of the next week,
908 with Monday as day 1 and Sunday as day 7. If **day** is given, each
909 accounting period runs from the time __HH:MM__ each day to the same time on
910 the next day. All times are local, and given in 24-hour time. (Defaults to
913 **RefuseUnknownExits** **0**|**1**|**auto**::
914 Prevent nodes that don't appear in the consensus from exiting using this
915 relay. If the option is 1, we always block exit attempts from such
916 nodes; if it's 0, we never do, and if the option is "auto", then we do
917 whatever the authorities suggest in the consensus. (Defaults to auto.)
919 **ServerDNSResolvConfFile** __filename__::
920 Overrides the default DNS configuration with the configuration in
921 __filename__. The file format is the same as the standard Unix
922 "**resolv.conf**" file (7). This option, like all other ServerDNS options,
923 only affects name lookups that your server does on behalf of clients.
924 (Defaults to use the system DNS configuration.)
926 **ServerDNSAllowBrokenConfig** **0**|**1**::
927 If this option is false, Tor exits immediately if there are problems
928 parsing the system DNS configuration or connecting to nameservers.
929 Otherwise, Tor continues to periodically retry the system nameservers until
930 it eventually succeeds. (Defaults to "1".)
932 **ServerDNSSearchDomains** **0**|**1**::
933 If set to 1, then we will search for addresses in the local search domain.
934 For example, if this system is configured to believe it is in
935 "example.com", and a client tries to connect to "www", the client will be
936 connected to "www.example.com". This option only affects name lookups that
937 your server does on behalf of clients. (Defaults to "0".)
939 **ServerDNSDetectHijacking** **0**|**1**::
940 When this option is set to 1, we will test periodically to determine
941 whether our local nameservers have been configured to hijack failing DNS
942 requests (usually to an advertising site). If they are, we will attempt to
943 correct this. This option only affects name lookups that your server does
944 on behalf of clients. (Defaults to "1".)
946 **ServerDNSTestAddresses** __address__,__address__,__...__::
947 When we're detecting DNS hijacking, make sure that these __valid__ addresses
948 aren't getting redirected. If they are, then our DNS is completely useless,
949 and we'll reset our exit policy to "reject *:*". This option only affects
950 name lookups that your server does on behalf of clients. (Defaults to
951 "www.google.com, www.mit.edu, www.yahoo.com, www.slashdot.org".)
953 **ServerDNSAllowNonRFC953Hostnames** **0**|**1**::
954 When this option is disabled, Tor does not try to resolve hostnames
955 containing illegal characters (like @ and :) rather than sending them to an
956 exit node to be resolved. This helps trap accidental attempts to resolve
957 URLs and so on. This option only affects name lookups that your server does
958 on behalf of clients. (Default: 0)
960 **BridgeRecordUsageByCountry** **0**|**1**::
961 When this option is enabled and BridgeRelay is also enabled, and we have
962 GeoIP data, Tor keeps a keep a per-country count of how many client
963 addresses have contacted it so that it can help the bridge authority guess
964 which countries have blocked access to it. (Default: 1)
966 **ServerDNSRandomizeCase** **0**|**1**::
967 When this option is set, Tor sets the case of each character randomly in
968 outgoing DNS requests, and makes sure that the case matches in DNS replies.
969 This so-called "0x20 hack" helps resist some types of DNS poisoning attack.
970 For more information, see "Increased DNS Forgery Resistance through
971 0x20-Bit Encoding". This option only affects name lookups that your server
972 does on behalf of clients. (Default: 1)
974 **GeoIPFile** __filename__::
975 A filename containing GeoIP data, for use with BridgeRecordUsageByCountry.
977 **CellStatistics** **0**|**1**::
978 When this option is enabled, Tor writes statistics on the mean time that
979 cells spend in circuit queues to disk every 24 hours. (Default: 0)
981 **DirReqStatistics** **0**|**1**::
982 When this option is enabled, Tor writes statistics on the number and
983 response time of network status requests to disk every 24 hours.
986 **EntryStatistics** **0**|**1**::
987 When this option is enabled, Tor writes statistics on the number of
988 directly connecting clients to disk every 24 hours. (Default: 0)
990 **ExitPortStatistics** **0**|**1**::
991 When this option is enabled, Tor writes statistics on the number of relayed
992 bytes and opened stream per exit port to disk every 24 hours. (Default: 0)
994 **ExtraInfoStatistics** **0**|**1**::
995 When this option is enabled, Tor includes previously gathered statistics in
996 its extra-info documents that it uploads to the directory authorities.
999 DIRECTORY SERVER OPTIONS
1000 ------------------------
1002 The following options are useful only for directory servers (that is,
1003 if DirPort is non-zero):
1005 **AuthoritativeDirectory** **0**|**1**::
1006 When this option is set to 1, Tor operates as an authoritative directory
1007 server. Instead of caching the directory, it generates its own list of
1008 good servers, signs it, and sends that to the clients. Unless the clients
1009 already have you listed as a trusted directory, you probably do not want
1010 to set this option. Please coordinate with the other admins at
1011 tor-ops@torproject.org if you think you should be a directory.
1013 **DirPortFrontPage** __FILENAME__::
1014 When this option is set, it takes an HTML file and publishes it as "/" on
1015 the DirPort. Now relay operators can provide a disclaimer without needing
1016 to set up a separate webserver. There's a sample disclaimer in
1017 contrib/tor-exit-notice.html.
1019 **V1AuthoritativeDirectory** **0**|**1**::
1020 When this option is set in addition to **AuthoritativeDirectory**, Tor
1021 generates version 1 directory and running-routers documents (for legacy
1022 Tor clients up to 0.1.0.x).
1024 **V2AuthoritativeDirectory** **0**|**1**::
1025 When this option is set in addition to **AuthoritativeDirectory**, Tor
1026 generates version 2 network statuses and serves descriptors, etc as
1027 described in doc/spec/dir-spec-v2.txt (for Tor clients and servers running
1028 0.1.1.x and 0.1.2.x).
1030 **V3AuthoritativeDirectory** **0**|**1**::
1031 When this option is set in addition to **AuthoritativeDirectory**, Tor
1032 generates version 3 network statuses and serves descriptors, etc as
1033 described in doc/spec/dir-spec.txt (for Tor clients and servers running at
1036 **VersioningAuthoritativeDirectory** **0**|**1**::
1037 When this option is set to 1, Tor adds information on which versions of
1038 Tor are still believed safe for use to the published directory. Each
1039 version 1 authority is automatically a versioning authority; version 2
1040 authorities provide this service optionally. See **RecommendedVersions**,
1041 **RecommendedClientVersions**, and **RecommendedServerVersions**.
1043 **NamingAuthoritativeDirectory** **0**|**1**::
1044 When this option is set to 1, then the server advertises that it has
1045 opinions about nickname-to-fingerprint bindings. It will include these
1046 opinions in its published network-status pages, by listing servers with
1047 the flag "Named" if a correct binding between that nickname and fingerprint
1048 has been registered with the dirserver. Naming dirservers will refuse to
1049 accept or publish descriptors that contradict a registered binding. See
1050 **approved-routers** in the **FILES** section below.
1052 **HSAuthoritativeDir** **0**|**1**::
1053 When this option is set in addition to **AuthoritativeDirectory**, Tor also
1054 accepts and serves hidden service descriptors. (Default: 0)
1056 **HidServDirectoryV2** **0**|**1**::
1057 When this option is set, Tor accepts and serves v2 hidden service
1058 descriptors. Setting DirPort is not required for this, because clients
1059 connect via the ORPort by default. (Default: 1)
1061 **BridgeAuthoritativeDir** **0**|**1**::
1062 When this option is set in addition to **AuthoritativeDirectory**, Tor
1063 accepts and serves router descriptors, but it caches and serves the main
1064 networkstatus documents rather than generating its own. (Default: 0)
1066 **MinUptimeHidServDirectoryV2** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
1067 Minimum uptime of a v2 hidden service directory to be accepted as such by
1068 authoritative directories. (Default: 24 hours)
1070 **DirPort** __PORT__::
1071 Advertise the directory service on this port.
1073 **DirListenAddress** __IP__[:__PORT__]::
1074 Bind the directory service to this address. If you specify a port, bind to
1075 this port rather than the one specified in DirPort. (Default: 0.0.0.0)
1076 This directive can be specified multiple times to bind to multiple
1079 **DirPolicy** __policy__,__policy__,__...__::
1080 Set an entrance policy for this server, to limit who can connect to the
1081 directory ports. The policies have the same form as exit policies above.
1083 DIRECTORY AUTHORITY SERVER OPTIONS
1084 ----------------------------------
1086 **RecommendedVersions** __STRING__::
1087 STRING is a comma-separated list of Tor versions currently believed to be
1088 safe. The list is included in each directory, and nodes which pull down the
1089 directory learn whether they need to upgrade. This option can appear
1090 multiple times: the values from multiple lines are spliced together. When
1091 this is set then **VersioningAuthoritativeDirectory** should be set too.
1093 **RecommendedClientVersions** __STRING__::
1094 STRING is a comma-separated list of Tor versions currently believed to be
1095 safe for clients to use. This information is included in version 2
1096 directories. If this is not set then the value of **RecommendedVersions**
1097 is used. When this is set then **VersioningAuthoritativeDirectory** should
1100 **RecommendedServerVersions** __STRING__::
1101 STRING is a comma-separated list of Tor versions currently believed to be
1102 safe for servers to use. This information is included in version 2
1103 directories. If this is not set then the value of **RecommendedVersions**
1104 is used. When this is set then **VersioningAuthoritativeDirectory** should
1107 **ConsensusParams** __STRING__::
1108 STRING is a space-separated list of key=value pairs that Tor will include
1109 in the "params" line of its networkstatus vote.
1111 **DirAllowPrivateAddresses** **0**|**1**::
1112 If set to 1, Tor will accept router descriptors with arbitrary "Address"
1113 elements. Otherwise, if the address is not an IP address or is a private IP
1114 address, it will reject the router descriptor. Defaults to 0.
1116 **AuthDirBadDir** __AddressPattern...__::
1117 Authoritative directories only. A set of address patterns for servers that
1118 will be listed as bad directories in any network status document this
1119 authority publishes, if **AuthDirListBadDirs** is set.
1121 **AuthDirBadExit** __AddressPattern...__::
1122 Authoritative directories only. A set of address patterns for servers that
1123 will be listed as bad exits in any network status document this authority
1124 publishes, if **AuthDirListBadExits** is set.
1126 **AuthDirInvalid** __AddressPattern...__::
1127 Authoritative directories only. A set of address patterns for servers that
1128 will never be listed as "valid" in any network status document that this
1129 authority publishes.
1131 **AuthDirReject** __AddressPattern__...::
1132 Authoritative directories only. A set of address patterns for servers that
1133 will never be listed at all in any network status document that this
1134 authority publishes, or accepted as an OR address in any descriptor
1135 submitted for publication by this authority.
1137 **AuthDirListBadDirs** **0**|**1**::
1138 Authoritative directories only. If set to 1, this directory has some
1139 opinion about which nodes are unsuitable as directory caches. (Do not set
1140 this to 1 unless you plan to list non-functioning directories as bad;
1141 otherwise, you are effectively voting in favor of every declared
1144 **AuthDirListBadExits** **0**|**1**::
1145 Authoritative directories only. If set to 1, this directory has some
1146 opinion about which nodes are unsuitable as exit nodes. (Do not set this to
1147 1 unless you plan to list non-functioning exits as bad; otherwise, you are
1148 effectively voting in favor of every declared exit as an exit.)
1150 **AuthDirRejectUnlisted** **0**|**1**::
1151 Authoritative directories only. If set to 1, the directory server rejects
1152 all uploaded server descriptors that aren't explicitly listed in the
1153 fingerprints file. This acts as a "panic button" if we get hit with a Sybil
1154 attack. (Default: 0)
1156 **AuthDirMaxServersPerAddr** __NUM__::
1157 Authoritative directories only. The maximum number of servers that we will
1158 list as acceptable on a single IP address. Set this to "0" for "no limit".
1161 **AuthDirMaxServersPerAuthAddr** __NUM__::
1162 Authoritative directories only. Like AuthDirMaxServersPerAddr, but applies
1163 to addresses shared with directory authorities. (Default: 5)
1165 **V3AuthVotingInterval** __N__ **minutes**|**hours**::
1166 V3 authoritative directories only. Configures the server's preferred voting
1167 interval. Note that voting will __actually__ happen at an interval chosen
1168 by consensus from all the authorities' preferred intervals. This time
1169 SHOULD divide evenly into a day. (Default: 1 hour)
1171 **V3AuthVoteDelay** __N__ **minutes**|**hours**::
1172 V3 authoritative directories only. Configures the server's preferred delay
1173 between publishing its vote and assuming it has all the votes from all the
1174 other authorities. Note that the actual time used is not the server's
1175 preferred time, but the consensus of all preferences. (Default: 5 minutes.)
1177 **V3AuthDistDelay** __N__ **minutes**|**hours**::
1178 V3 authoritative directories only. Configures the server's preferred delay
1179 between publishing its consensus and signature and assuming it has all the
1180 signatures from all the other authorities. Note that the actual time used
1181 is not the server's preferred time, but the consensus of all preferences.
1182 (Default: 5 minutes.)
1184 **V3AuthNIntervalsValid** __NUM__::
1185 V3 authoritative directories only. Configures the number of VotingIntervals
1186 for which each consensus should be valid for. Choosing high numbers
1187 increases network partitioning risks; choosing low numbers increases
1188 directory traffic. Note that the actual number of intervals used is not the
1189 server's preferred number, but the consensus of all preferences. Must be at
1190 least 2. (Default: 3.)
1192 HIDDEN SERVICE OPTIONS
1193 ----------------------
1195 The following options are used to configure a hidden service.
1197 **HiddenServiceDir** __DIRECTORY__::
1198 Store data files for a hidden service in DIRECTORY. Every hidden service
1199 must have a separate directory. You may use this option multiple times to
1200 specify multiple services.
1202 **HiddenServicePort** __VIRTPORT__ [__TARGET__]::
1203 Configure a virtual port VIRTPORT for a hidden service. You may use this
1204 option multiple times; each time applies to the service using the most
1205 recent hiddenservicedir. By default, this option maps the virtual port to
1206 the same port on 127.0.0.1. You may override the target port, address, or
1207 both by specifying a target of addr, port, or addr:port. You may also have
1208 multiple lines with the same VIRTPORT: when a user connects to that
1209 VIRTPORT, one of the TARGETs from those lines will be chosen at random.
1211 **PublishHidServDescriptors** **0**|**1**::
1212 If set to 0, Tor will run any hidden services you configure, but it won't
1213 advertise them to the rendezvous directory. This option is only useful if
1214 you're using a Tor controller that handles hidserv publishing for you.
1217 **HiddenServiceVersion** __version__,__version__,__...__::
1218 A list of rendezvous service descriptor versions to publish for the hidden
1219 service. Currently, only version 2 is supported. (Default: 2)
1221 **HiddenServiceAuthorizeClient** __auth-type__ __client-name__,__client-name__,__...__::
1222 If configured, the hidden service is accessible for authorized clients
1223 only. The auth-type can either be \'basic' for a general-purpose
1224 authorization protocol or \'stealth' for a less scalable protocol that also
1225 hides service activity from unauthorized clients. Only clients that are
1226 listed here are authorized to access the hidden service. Valid client names
1227 are 1 to 19 characters long and only use characters in A-Za-z0-9+-_ (no
1228 spaces). If this option is set, the hidden service is not accessible for
1229 clients without authorization any more. Generated authorization data can be
1230 found in the hostname file. Clients need to put this authorization data in
1231 their configuration file using **HidServAuth**.
1233 **RendPostPeriod** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
1234 Every time the specified period elapses, Tor uploads any rendezvous
1235 service descriptors to the directory servers. This information is also
1236 uploaded whenever it changes. (Default: 1 hour)
1238 TESTING NETWORK OPTIONS
1239 -----------------------
1241 The following options are used for running a testing Tor network.
1243 **TestingTorNetwork** **0**|**1**::
1244 If set to 1, Tor adjusts default values of the configuration options below,
1245 so that it is easier to set up a testing Tor network. May only be set if
1246 non-default set of DirServers is set. Cannot be unset while Tor is running.
1249 ServerDNSAllowBrokenConfig 1
1250 DirAllowPrivateAddresses 1
1251 EnforceDistinctSubnets 0
1253 AuthDirMaxServersPerAddr 0
1254 AuthDirMaxServersPerAuthAddr 0
1255 ClientDNSRejectInternalAddresses 0
1256 ExitPolicyRejectPrivate 0
1257 V3AuthVotingInterval 5 minutes
1258 V3AuthVoteDelay 20 seconds
1259 V3AuthDistDelay 20 seconds
1260 TestingV3AuthInitialVotingInterval 5 minutes
1261 TestingV3AuthInitialVoteDelay 20 seconds
1262 TestingV3AuthInitialDistDelay 20 seconds
1263 TestingAuthDirTimeToLearnReachability 0 minutes
1264 TestingEstimatedDescriptorPropagationTime 0 minutes
1266 **TestingV3AuthInitialVotingInterval** __N__ **minutes**|**hours**::
1267 Like V3AuthVotingInterval, but for initial voting interval before the first
1268 consensus has been created. Changing this requires that
1269 **TestingTorNetwork** is set. (Default: 30 minutes)
1271 **TestingV3AuthInitialVoteDelay** __N__ **minutes**|**hours**::
1272 Like TestingV3AuthInitialVoteDelay, but for initial voting interval before
1273 the first consensus has been created. Changing this requires that
1274 **TestingTorNetwork** is set. (Default: 5 minutes)
1276 **TestingV3AuthInitialDistDelay** __N__ **minutes**|**hours**::
1277 Like TestingV3AuthInitialDistDelay, but for initial voting interval before
1278 the first consensus has been created. Changing this requires that
1279 **TestingTorNetwork** is set. (Default: 5 minutes)
1281 **TestingAuthDirTimeToLearnReachability** __N__ **minutes**|**hours**::
1282 After starting as an authority, do not make claims about whether routers
1283 are Running until this much time has passed. Changing this requires
1284 that **TestingTorNetwork** is set. (Default: 30 minutes)
1286 **TestingEstimatedDescriptorPropagationTime** __N__ **minutes**|**hours**::
1287 Clients try downloading router descriptors from directory caches after this
1288 time. Changing this requires that **TestingTorNetwork** is set. (Default:
1294 Tor catches the following signals:
1297 Tor will catch this, clean up and sync to disk if necessary, and exit.
1300 Tor clients behave as with SIGTERM; but Tor servers will do a controlled
1301 slow shutdown, closing listeners and waiting 30 seconds before exiting.
1302 (The delay can be configured with the ShutdownWaitLength config option.)
1305 The signal instructs Tor to reload its configuration (including closing and
1306 reopening logs), and kill and restart its helper processes if applicable.
1309 Log statistics about current connections, past connections, and throughput.
1312 Switch all logs to loglevel debug. You can go back to the old loglevels by
1316 Tor receives this signal when one of its helper processes has exited, so it
1320 Tor catches this signal and ignores it.
1323 If this signal exists on your platform, Tor catches and ignores it.
1328 **@CONFDIR@/torrc**::
1329 The configuration file, which contains "option value" pairs.
1331 **@LOCALSTATEDIR@/lib/tor/**::
1332 The tor process stores keys and other data here.
1334 __DataDirectory__**/cached-status/**::
1335 The most recently downloaded network status document for each authority.
1336 Each file holds one such document; the filenames are the hexadecimal
1337 identity key fingerprints of the directory authorities.
1339 __DataDirectory__**/cached-descriptors** and **cached-descriptors.new**::
1340 These files hold downloaded router statuses. Some routers may appear more
1341 than once; if so, the most recently published descriptor is used. Lines
1342 beginning with @-signs are annotations that contain more information about
1343 a given router. The ".new" file is an append-only journal; when it gets
1344 too large, all entries are merged into a new cached-descriptors file.
1346 __DataDirectory__**/cached-routers** and **cached-routers.new**::
1347 Obsolete versions of cached-descriptors and cached-descriptors.new. When
1348 Tor can't find the newer files, it looks here instead.
1350 __DataDirectory__**/state**::
1351 A set of persistent key-value mappings. These are documented in
1352 the file. These include:
1353 - The current entry guards and their status.
1354 - The current bandwidth accounting values (unused so far; see
1356 - When the file was last written
1357 - What version of Tor generated the state file
1358 - A short history of bandwidth usage, as produced in the router
1361 __DataDirectory__**/bw_accounting**::
1362 Used to track bandwidth accounting values (when the current period starts
1363 and ends; how much has been read and written so far this period). This file
1364 is obsolete, and the data is now stored in the \'state' file as well. Only
1365 used when bandwidth accounting is enabled.
1367 __DataDirectory__**/control_auth_cookie**::
1368 Used for cookie authentication with the controller. Location can be
1369 overridden by the CookieAuthFile config option. Regenerated on startup. See
1370 control-spec.txt for details. Only used when cookie authentication is
1373 __DataDirectory__**/keys/***::
1374 Only used by servers. Holds identity keys and onion keys.
1376 __DataDirectory__**/fingerprint**::
1377 Only used by servers. Holds the fingerprint of the server's identity key.
1379 __DataDirectory__**/approved-routers**::
1380 Only for naming authoritative directory servers (see
1381 **NamingAuthoritativeDirectory**). This file lists nickname to identity
1382 bindings. Each line lists a nickname and a fingerprint separated by
1383 whitespace. See your **fingerprint** file in the __DataDirectory__ for an
1384 example line. If the nickname is **!reject** then descriptors from the
1385 given identity (fingerprint) are rejected by this server. If it is
1386 **!invalid** then descriptors are accepted but marked in the directory as
1387 not valid, that is, not recommended.
1389 __DataDirectory__**/router-stability**::
1390 Only used by authoritative directory servers. Tracks measurements for
1391 router mean-time-between-failures so that authorities have a good idea of
1392 how to set their Stable flags.
1394 __HiddenServiceDirectory__**/hostname**::
1395 The <base32-encoded-fingerprint>.onion domain name for this hidden service.
1396 If the hidden service is restricted to authorized clients only, this file
1397 also contains authorization data for all clients.
1399 __HiddenServiceDirectory__**/private_key**::
1400 The private key for this hidden service.
1402 __HiddenServiceDirectory__**/client_keys**::
1403 Authorization data for a hidden service that is only accessible by
1408 **privoxy**(1), **tsocks**(1), **torify**(1) +
1410 **https://www.torproject.org/**
1416 Plenty, probably. Tor is still in development. Please report them.
1420 Roger Dingledine [arma at mit.edu], Nick Mathewson [nickm at alum.mit.edu].