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 not 0, 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 If not 0, 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 **ConnLimit** __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 **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **file** __FILENAME__ +
328 **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **stderr**|**stdout**|**syslog** ::
329 As above, but select messages by range of log severity __and__ by a
330 set of "logging domains". Each logging domain corresponds to an area of
331 functionality inside Tor. You can specify any number of severity ranges
332 for a single log statement, each of them prefixed by a comma-separated
333 list of logging domains. You can prefix a domain with ~ to indicate
334 negation, and use * to indicate "all domains". If you specify a severity
335 range without a list of domains, it matches all domains. +
337 This is an advanced feature which is most useful for debugging one or two
338 of Tor's subsystems at a time. +
340 The currently recognized domains are: general, crypto, net, config, fs,
341 protocol, mm, http, app, control, circ, rend, bug, dir, dirserv, or, edge,
342 acct, hist, and handshake. Domain names are case-insensitive. +
344 For example, "`Log [handshake]debug [*,~net,~mm]info notice stdout`" sends
345 to stdout: all handshake messages of any severity, all info-and-higher
346 messages from domains other than networking and memory management, and all
347 messages of severity notice or higher.
349 **OutboundBindAddress** __IP__::
350 Make all outbound connections originate from the IP address specified. This
351 is only useful when you have multiple network interfaces, and you want all
352 of Tor's outgoing connections to use a single one. This setting will be
353 ignored for connections to the loopback addresses (127.0.0.0/8 and ::1).
355 **PidFile** __FILE__::
356 On startup, write our PID to FILE. On clean shutdown, remove
359 **ProtocolWarnings** **0**|**1**::
360 If 1, Tor will log with severity \'warn' various cases of other parties not
361 following the Tor specification. Otherwise, they are logged with severity
362 \'info'. (Default: 0)
364 **RunAsDaemon** **0**|**1**::
365 If 1, Tor forks and daemonizes to the background. This option has no effect
366 on Windows; instead you should use the --service command-line option.
370 **SafeLogging** **0**|**1**|**relay**::
371 Tor can scrub potentially sensitive strings from log messages (e.g.
372 addresses) by replacing them with the string [scrubbed]. This way logs can
373 still be useful, but they don't leave behind personally identifying
374 information about what sites a user might have visited. +
376 If this option is set to 0, Tor will not perform any scrubbing, if it is
377 set to 1, all potentially sensitive strings are replaced. If it is set to
378 relay, all log messages generated when acting as a relay are sanitized, but
379 all messages generated when acting as a client are not. (Default: 1)
382 On startup, setuid to this user and setgid to their primary group.
384 **HardwareAccel** **0**|**1**::
385 If non-zero, try to use built-in (static) crypto hardware acceleration when
386 available. (Default: 0)
388 **AccelName** __NAME__::
389 When using OpenSSL hardware crypto acceleration attempt to load the dynamic
390 engine of this name. This must be used for any dynamic hardware engine.
391 Names can be verified with the openssl engine command.
393 **AccelDir** __DIR__::
394 Specify this option if using dynamic hardware acceleration and the engine
395 implementation library resides somewhere other than the OpenSSL default.
397 **AvoidDiskWrites** **0**|**1**::
398 If non-zero, try to write to disk less frequently than we would otherwise.
399 This is useful when running on flash memory or other media that support
400 only a limited number of writes. (Default: 0)
402 **TunnelDirConns** **0**|**1**::
403 If non-zero, when a directory server we contact supports it, we will build
404 a one-hop circuit and make an encrypted connection via its ORPort.
407 **PreferTunneledDirConns** **0**|**1**::
408 If non-zero, we will avoid directory servers that don't support tunneled
409 directory connections, when possible. (Default: 1)
411 **CircuitPriorityHalflife** __NUM1__::
412 If this value is set, we override the default algorithm for choosing which
413 circuit's cell to deliver or relay next. When the value is 0, we
414 round-robin between the active circuits on a connection, delivering one
415 cell from each in turn. When the value is positive, we prefer delivering
416 cells from whichever connection has the lowest weighted cell count, where
417 cells are weighted exponentially according to the supplied
418 CircuitPriorityHalflife value (in seconds). If this option is not set at
419 all, we use the behavior recommended in the current consensus
420 networkstatus. This is an advanced option; you generally shouldn't have
421 to mess with it. (Default: not set.)
426 The following options are useful only for clients (that is, if
427 **SocksPort** is non-zero):
429 **AllowInvalidNodes** **entry**|**exit**|**middle**|**introduction**|**rendezvous**|**...**::
430 If some Tor servers are obviously not working right, the directory
431 authorities can manually mark them as invalid, meaning that it's not
432 recommended you use them for entry or exit positions in your circuits. You
433 can opt to use them in some circuit positions, though. The default is
434 "middle,rendezvous", and other choices are not advised.
436 **ExcludeSingleHopRelays** **0**|**1**::
437 This option controls whether circuits built by Tor will include relays with
438 the AllowSingleHopExits flag set to true. If ExcludeSingleHopRelays is set
439 to 0, these relays will be included. Note that these relays might be at
440 higher risk of being seized or observed, so they are not normally
441 included. Also note that relatively few clients turn off this option,
442 so using these relays might make your client stand out.
445 **Bridge** __IP__:__ORPort__ [fingerprint]::
446 When set along with UseBridges, instructs Tor to use the relay at
447 "IP:ORPort" as a "bridge" relaying into the Tor network. If "fingerprint"
448 is provided (using the same format as for DirServer), we will verify that
449 the relay running at that location has the right fingerprint. We also use
450 fingerprint to look up the bridge descriptor at the bridge authority, if
451 it's provided and if UpdateBridgesFromAuthority is set too.
453 **LearnCircuitBuildTimeout** **0**|**1**::
454 If 0, CircuitBuildTimeout adaptive learning is disabled. (Default: 1)
456 **CircuitBuildTimeout** __NUM__::
458 Try for at most NUM seconds when building circuits. If the circuit isn't
459 open in that time, give up on it. If LearnCircuitBuildTimeout is 1, this
460 value serves as the initial value to use before a timeout is learned. If
461 LearnCircuitBuildTimeout is 0, this value is the only value used.
462 (Default: 60 seconds.)
464 **CircuitIdleTimeout** __NUM__::
465 If we have kept a clean (never used) circuit around for NUM seconds, then
466 close it. This way when the Tor client is entirely idle, it can expire all
467 of its circuits, and then expire its TLS connections. Also, if we end up
468 making a circuit that is not useful for exiting any of the requests we're
469 receiving, it won't forever take up a slot in the circuit list. (Default: 1
472 **CircuitStreamTimeout** __NUM__::
473 If non-zero, this option overrides our internal timeout schedule for how
474 many seconds until we detach a stream from a circuit and try a new circuit.
475 If your network is particularly slow, you might want to set this to a
476 number like 60. (Default: 0)
478 **ClientOnly** **0**|**1**::
479 If set to 1, Tor will under no circumstances run as a server or serve
480 directory requests. The default is to run as a client unless ORPort is
481 configured. (Usually, you don't need to set this; Tor is pretty smart at
482 figuring out whether you are reliable and high-bandwidth enough to be a
483 useful server.) (Default: 0)
485 **ExcludeNodes** __node__,__node__,__...__::
486 A list of identity fingerprints, nicknames, country codes and address
487 patterns of nodes to never use when building a circuit. (Example:
488 ExcludeNodes SlowServer, $ EFFFFFFFFFFFFFFF, \{cc}, 255.254.0.0/8)
490 **ExcludeExitNodes** __node__,__node__,__...__::
491 A list of identity fingerprints, nicknames, country codes and address
492 patterns of nodes to never use when picking an exit node. Note that any
493 node listed in ExcludeNodes is automatically considered to be part of this
496 **EntryNodes** __node__,__node__,__...__::
497 A list of identity fingerprints, nicknames, country codes and address
498 patterns of nodes to use for the first hop in normal circuits. These are
499 treated only as preferences unless StrictNodes (see below) is also set.
501 **ExitNodes** __node__,__node__,__...__::
502 A list of identity fingerprints, nicknames, country codes and address
503 patterns of nodes to use for the last hop in normal exit circuits. These
504 are treated only as preferences unless StrictNodes (see below) is also set.
506 **StrictNodes** **0**|**1**::
507 If 1 and EntryNodes config option is set, Tor will never use any nodes
508 besides those listed in EntryNodes for the first hop of a normal circuit.
509 If 1 and ExitNodes config option is set, Tor will never use any nodes
510 besides those listed in ExitNodes for the last hop of a normal exit
511 circuit. Note that Tor might still use these nodes for non-exit circuits
512 such as one-hop directory fetches or hidden service support circuits.
514 **FascistFirewall** **0**|**1**::
515 If 1, Tor will only create outgoing connections to ORs running on ports
516 that your firewall allows (defaults to 80 and 443; see **FirewallPorts**).
517 This will allow you to run Tor as a client behind a firewall with
518 restrictive policies, but will not allow you to run as a server behind such
519 a firewall. If you prefer more fine-grained control, use
520 ReachableAddresses instead.
522 **FirewallPorts** __PORTS__::
523 A list of ports that your firewall allows you to connect to. Only used when
524 **FascistFirewall** is set. This option is deprecated; use ReachableAddresses
525 instead. (Default: 80, 443)
527 **HidServAuth** __onion-address__ __auth-cookie__ [__service-name__]::
528 Client authorization for a hidden service. Valid onion addresses contain 16
529 characters in a-z2-7 plus ".onion", and valid auth cookies contain 22
530 characters in A-Za-z0-9+/. The service name is only used for internal
531 purposes, e.g., for Tor controllers. This option may be used multiple times
532 for different hidden services. If a hidden service uses authorization and
533 this option is not set, the hidden service is not accessible. Hidden
534 services can be configured to require authorization using the
535 **HiddenServiceAuthorizeClient** option.
537 **ReachableAddresses** __ADDR__[/__MASK__][:__PORT__]...::
538 A comma-separated list of IP addresses and ports that your firewall allows
539 you to connect to. The format is as for the addresses in ExitPolicy, except
540 that "accept" is understood unless "reject" is explicitly provided. For
541 example, \'ReachableAddresses 99.0.0.0/8, reject 18.0.0.0/8:80, accept
542 \*:80' means that your firewall allows connections to everything inside net
543 99, rejects port 80 connections to net 18, and accepts connections to port
544 80 otherwise. (Default: \'accept \*:*'.)
546 **ReachableDirAddresses** __ADDR__[/__MASK__][:__PORT__]...::
547 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
548 these restrictions when fetching directory information, using standard HTTP
549 GET requests. If not set explicitly then the value of
550 **ReachableAddresses** is used. If **HTTPProxy** is set then these
551 connections will go through that proxy.
553 **ReachableORAddresses** __ADDR__[/__MASK__][:__PORT__]...::
554 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
555 these restrictions when connecting to Onion Routers, using TLS/SSL. If not
556 set explicitly then the value of **ReachableAddresses** is used. If
557 **HTTPSProxy** is set then these connections will go through that proxy. +
559 The separation between **ReachableORAddresses** and
560 **ReachableDirAddresses** is only interesting when you are connecting
561 through proxies (see **HTTPProxy** and **HTTPSProxy**). Most proxies limit
562 TLS connections (which Tor uses to connect to Onion Routers) to port 443,
563 and some limit HTTP GET requests (which Tor uses for fetching directory
564 information) to port 80.
566 **LongLivedPorts** __PORTS__::
567 A list of ports for services that tend to have long-running connections
568 (e.g. chat and interactive shells). Circuits for streams that use these
569 ports will contain only high-uptime nodes, to reduce the chance that a node
570 will go down before the stream is finished. (Default: 21, 22, 706, 1863,
571 5050, 5190, 5222, 5223, 6667, 6697, 8300)
573 **MapAddress** __address__ __newaddress__::
574 When a request for address arrives to Tor, it will rewrite it to newaddress
575 before processing it. For example, if you always want connections to
576 www.indymedia.org to exit via __torserver__ (where __torserver__ is the
577 nickname of the server), use "MapAddress www.indymedia.org
578 www.indymedia.org.torserver.exit".
580 **NewCircuitPeriod** __NUM__::
581 Every NUM seconds consider whether to build a new circuit. (Default: 30
584 **MaxCircuitDirtiness** __NUM__::
585 Feel free to reuse a circuit that was first used at most NUM seconds ago,
586 but never attach a new stream to a circuit that is too old. (Default: 10
589 **NodeFamily** __node__,__node__,__...__::
590 The Tor servers, defined by their identity fingerprints or nicknames,
591 constitute a "family" of similar or co-administered servers, so never use
592 any two of them in the same circuit. Defining a NodeFamily is only needed
593 when a server doesn't list the family itself (with MyFamily). This option
594 can be used multiple times.
596 **EnforceDistinctSubnets** **0**|**1**::
597 If 1, Tor will not put two servers whose IP addresses are "too close" on
598 the same circuit. Currently, two addresses are "too close" if they lie in
599 the same /16 range. (Default: 1)
601 **SocksPort** __PORT__::
602 Advertise this port to listen for connections from Socks-speaking
603 applications. Set this to 0 if you don't want to allow application
604 connections. (Default: 9050)
606 **SocksListenAddress** __IP__[:__PORT__]::
607 Bind to this address to listen for connections from Socks-speaking
608 applications. (Default: 127.0.0.1) You can also specify a port (e.g.
609 192.168.0.1:9100). This directive can be specified multiple times to bind
610 to multiple addresses/ports.
612 **SocksPolicy** __policy__,__policy__,__...__::
613 Set an entrance policy for this server, to limit who can connect to the
614 SocksPort and DNSPort ports. The policies have the same form as exit
617 **SocksTimeout** __NUM__::
618 Let a socks connection wait NUM seconds handshaking, and NUM seconds
619 unattached waiting for an appropriate circuit, before we fail it. (Default:
622 **TrackHostExits** __host__,__.domain__,__...__::
623 For each value in the comma separated list, Tor will track recent
624 connections to hosts that match this value and attempt to reuse the same
625 exit node for each. If the value is prepended with a \'.\', it is treated as
626 matching an entire domain. If one of the values is just a \'.', it means
627 match everything. This option is useful if you frequently connect to sites
628 that will expire all your authentication cookies (i.e. log you out) if
629 your IP address changes. Note that this option does have the disadvantage
630 of making it more clear that a given history is associated with a single
631 user. However, most people who would wish to observe this will observe it
632 through cookies or other protocol-specific means anyhow.
634 **TrackHostExitsExpire** __NUM__::
635 Since exit servers go up and down, it is desirable to expire the
636 association between host and exit server after NUM seconds. The default is
637 1800 seconds (30 minutes).
639 **UpdateBridgesFromAuthority** **0**|**1**::
640 When set (along with UseBridges), Tor will try to fetch bridge descriptors
641 from the configured bridge authorities when feasible. It will fall back to
642 a direct request if the authority responds with a 404. (Default: 0)
644 **UseBridges** **0**|**1**::
645 When set, Tor will fetch descriptors for each bridge listed in the "Bridge"
646 config lines, and use these relays as both entry guards and directory
649 **UseEntryGuards** **0**|**1**::
650 If this option is set to 1, we pick a few long-term entry servers, and try
651 to stick with them. This is desirable because constantly changing servers
652 increases the odds that an adversary who owns some servers will observe a
653 fraction of your paths. (Defaults to 1.)
655 **NumEntryGuards** __NUM__::
656 If UseEntryGuards is set to 1, we will try to pick a total of NUM routers
657 as long-term entries for our circuits. (Defaults to 3.)
659 **SafeSocks** **0**|**1**::
660 When this option is enabled, Tor will reject application connections that
661 use unsafe variants of the socks protocol -- ones that only provide an IP
662 address, meaning the application is doing a DNS resolve first.
663 Specifically, these are socks4 and socks5 when not doing remote DNS.
666 **TestSocks** **0**|**1**::
667 When this option is enabled, Tor will make a notice-level log entry for
668 each connection to the Socks port indicating whether the request used a
669 safe socks protocol or an unsafe one (see above entry on SafeSocks). This
670 helps to determine whether an application using Tor is possibly leaking
671 DNS requests. (Default: 0)
673 **WarnUnsafeSocks** **0**|**1**::
674 When this option is enabled, Tor will warn whenever a request is
675 received that only contains an IP address instead of a hostname. Allowing
676 applications to do DNS resolves themselves is usually a bad idea and
677 can leak your location to attackers. (Default: 1)
679 **VirtualAddrNetwork** __Address__/__bits__::
680 When a controller asks for a virtual (unused) address with the MAPADDRESS
681 command, Tor picks an unassigned address from this range. (Default:
684 When providing proxy server service to a network of computers using a tool
685 like dns-proxy-tor, change this address to "10.192.0.0/10" or
686 "172.16.0.0/12". The default **VirtualAddrNetwork** address range on a
687 properly configured machine will route to the loopback interface. For
688 local use, no change to the default VirtualAddrNetwork setting is needed.
690 **AllowNonRFC953Hostnames** **0**|**1**::
691 When this option is disabled, Tor blocks hostnames containing illegal
692 characters (like @ and :) rather than sending them to an exit node to be
693 resolved. This helps trap accidental attempts to resolve URLs and so on.
696 **AllowDotExit** **0**|**1**::
697 If enabled, we convert "www.google.com.foo.exit" addresses on the
698 SocksPort/TransPort/NATDPort into "www.google.com" addresses that exit from
699 the node "foo". Disabled by default since attacking websites and exit
700 relays can use it to manipulate your path selection. (Default: 0)
702 **FastFirstHopPK** **0**|**1**::
703 When this option is disabled, Tor uses the public key step for the first
704 hop of creating circuits. Skipping it is generally safe since we have
705 already used TLS to authenticate the relay and to establish forward-secure
706 keys. Turning this option off makes circuit building slower. +
708 Note that Tor will always use the public key step for the first hop if it's
709 operating as a relay, and it will never use the public key step if it
710 doesn't yet know the onion key of the first hop. (Default: 1)
712 **TransPort** __PORT__::
713 If non-zero, enables transparent proxy support on __PORT__ (by convention,
714 9040). Requires OS support for transparent proxies, such as BSDs' pf or
715 Linux's IPTables. If you're planning to use Tor as a transparent proxy for
716 a network, you'll want to examine and change VirtualAddrNetwork from the
717 default setting. You'll also want to set the TransListenAddress option for
718 the network you'd like to proxy. (Default: 0).
720 **TransListenAddress** __IP__[:__PORT__]::
721 Bind to this address to listen for transparent proxy connections. (Default:
722 127.0.0.1). This is useful for exporting a transparent proxy server to an
725 **NATDPort** __PORT__::
726 Allow old versions of ipfw (as included in old versions of FreeBSD, etc.)
727 to send connections through Tor using the NATD protocol. This option is
728 only for people who cannot use TransPort.
730 **NATDListenAddress** __IP__[:__PORT__]::
731 Bind to this address to listen for NATD connections. (Default: 127.0.0.1).
733 **AutomapHostsOnResolve** **0**|**1**::
734 When this option is enabled, and we get a request to resolve an address
735 that ends with one of the suffixes in **AutomapHostsSuffixes**, we map an
736 unused virtual address to that address, and return the new virtual address.
737 This is handy for making ".onion" addresses work with applications that
738 resolve an address and then connect to it. (Default: 0).
740 **AutomapHostsSuffixes** __SUFFIX__,__SUFFIX__,__...__::
741 A comma-separated list of suffixes to use with **AutomapHostsOnResolve**.
742 The "." suffix is equivalent to "all addresses." (Default: .exit,.onion).
744 **DNSPort** __PORT__::
745 If non-zero, Tor listens for UDP DNS requests on this port and resolves
746 them anonymously. (Default: 0).
748 **DNSListenAddress** __IP__[:__PORT__]::
749 Bind to this address to listen for DNS connections. (Default: 127.0.0.1).
751 **ClientDNSRejectInternalAddresses** **0**|**1**::
752 If true, Tor does not believe any anonymously retrieved DNS answer that
753 tells it that an address resolves to an internal address (like 127.0.0.1 or
754 192.168.0.1). This option prevents certain browser-based attacks; don't
755 turn it off unless you know what you're doing. (Default: 1).
757 **DownloadExtraInfo** **0**|**1**::
758 If true, Tor downloads and caches "extra-info" documents. These documents
759 contain information about servers other than the information in their
760 regular router descriptors. Tor does not use this information for anything
761 itself; to save bandwidth, leave this option turned off. (Default: 0).
763 **FallbackNetworkstatusFile** __FILENAME__::
764 If Tor doesn't have a cached networkstatus file, it starts out using this
765 one instead. Even if this file is out of date, Tor can still use it to
766 learn about directory mirrors, so it doesn't need to put load on the
767 authorities. (Default: None).
769 **WarnPlaintextPorts** __port__,__port__,__...__::
770 Tells Tor to issue a warnings whenever the user tries to make an anonymous
771 connection to one of these ports. This option is designed to alert users
772 to services that risk sending passwords in the clear. (Default:
775 **RejectPlaintextPorts** __port__,__port__,__...__::
776 Like WarnPlaintextPorts, but instead of warning about risky port uses, Tor
777 will instead refuse to make the connection. (Default: None).
779 **AllowSingleHopCircuits** **0**|**1**::
780 When this option is set, the attached Tor controller can use relays
781 that have the **AllowSingleHopExits** option turned on to build
782 one-hop Tor connections. (Default: 0)
787 The following options are useful only for servers (that is, if ORPort
790 **Address** __address__::
791 The IP address or fully qualified domain name of this server (e.g.
792 moria.mit.edu). You can leave this unset, and Tor will guess your IP
793 address. This IP address is the one used to tell clients and other
794 servers where to find your Tor server; it doesn't affect the IP that your
795 Tor client binds to. To bind to a different address, use the
796 *ListenAddress and OutboundBindAddress options.
798 **AllowSingleHopExits** **0**|**1**::
799 This option controls whether clients can use this server as a single hop
800 proxy. If set to 1, clients can use this server as an exit even if it is
801 the only hop in the circuit. Note that most clients will refuse to use
802 servers that set this option, since most clients have
803 ExcludeSingleHopRelays set. (Default: 0)
805 **AssumeReachable** **0**|**1**::
806 This option is used when bootstrapping a new Tor network. If set to 1,
807 don't do self-reachability testing; just upload your server descriptor
808 immediately. If **AuthoritativeDirectory** is also set, this option
809 instructs the dirserver to bypass remote reachability testing too and list
810 all connected servers as running.
812 **BridgeRelay** **0**|**1**::
813 Sets the relay to act as a "bridge" with respect to relaying connections
814 from bridge users to the Tor network. It mainly causes Tor to publish a
815 server descriptor to the bridge database, rather than publishing a relay
816 descriptor to the public directory authorities.
818 **ContactInfo** __email_address__::
819 Administrative contact information for server. This line might get picked
820 up by spam harvesters, so you may want to obscure the fact that it's an
823 **ExitPolicy** __policy__,__policy__,__...__::
824 Set an exit policy for this server. Each policy is of the form
825 "**accept**|**reject** __ADDR__[/__MASK__][:__PORT__]". If /__MASK__ is
826 omitted then this policy just applies to the host given. Instead of giving
827 a host or network you can also use "\*" to denote the universe (0.0.0.0/0).
828 __PORT__ can be a single port number, an interval of ports
829 "__FROM_PORT__-__TO_PORT__", or "\*". If __PORT__ is omitted, that means
832 For example, "accept 18.7.22.69:\*,reject 18.0.0.0/8:\*,accept \*:\*" would
833 reject any traffic destined for MIT except for web.mit.edu, and accept
836 To specify all internal and link-local networks (including 0.0.0.0/8,
837 169.254.0.0/16, 127.0.0.0/8, 192.168.0.0/16, 10.0.0.0/8, and
838 172.16.0.0/12), you can use the "private" alias instead of an address.
839 These addresses are rejected by default (at the beginning of your exit
840 policy), along with your public IP address, unless you set the
841 ExitPolicyRejectPrivate config option to 0. For example, once you've done
842 that, you could allow HTTP to 127.0.0.1 and block all other connections to
843 internal networks with "accept 127.0.0.1:80,reject private:\*", though that
844 may also allow connections to your own computer that are addressed to its
845 public (external) IP address. See RFC 1918 and RFC 3330 for more details
846 about internal and reserved IP address space. +
848 This directive can be specified multiple times so you don't have to put it
851 Policies are considered first to last, and the first match wins. If you
852 want to \_replace_ the default exit policy, end your exit policy with
853 either a reject \*:* or an accept \*:*. Otherwise, you're \_augmenting_
854 (prepending to) the default exit policy. The default exit policy is: +
868 **ExitPolicyRejectPrivate** **0**|**1**::
869 Reject all private (local) networks, along with your own public IP address,
870 at the beginning of your exit policy. See above entry on ExitPolicy.
873 **MaxOnionsPending** __NUM__::
874 If you have more than this number of onionskins queued for decrypt, reject
875 new ones. (Default: 100)
877 **MyFamily** __node__,__node__,__...__::
878 Declare that this Tor server is controlled or administered by a group or
879 organization identical or similar to that of the other servers, defined by
880 their identity fingerprints or nicknames. When two servers both declare
881 that they are in the same \'family', Tor clients will not use them in the
882 same circuit. (Each server only needs to list the other servers in its
883 family; it doesn't need to list itself, but it won't hurt.)
885 **Nickname** __name__::
886 Set the server's nickname to \'name'. Nicknames must be between 1 and 19
887 characters inclusive, and must contain only the characters [a-zA-Z0-9].
889 **NumCPUs** __num__::
890 How many processes to use at once for decrypting onionskins. (Default: 1)
892 **ORPort** __PORT__::
893 Advertise this port to listen for connections from Tor clients and servers.
895 **ORListenAddress** __IP__[:__PORT__]::
896 Bind to this IP address to listen for connections from Tor clients and
897 servers. If you specify a port, bind to this port rather than the one
898 specified in ORPort. (Default: 0.0.0.0) This directive can be specified
899 multiple times to bind to multiple addresses/ports.
901 **PublishServerDescriptor** **0**|**1**|**v1**|**v2**|**v3**|**bridge**|**hidserv**,**...**::
902 This option specifies which descriptors Tor will publish when acting as
903 a relay or hidden service. You can
904 choose multiple arguments, separated by commas.
906 If this option is set to 0, Tor will not publish its
907 descriptors to any directories. (This is useful if you're testing
908 out your server, or if you're using a Tor controller that handles directory
909 publishing for you.) Otherwise, Tor will publish its descriptors of all
910 type(s) specified. The default is "1",
911 which means "if running as a server or a hidden service, publish the
912 appropriate descriptors to the authorities".
914 **ShutdownWaitLength** __NUM__::
915 When we get a SIGINT and we're a server, we begin shutting down:
916 we close listeners and start refusing new circuits. After **NUM**
917 seconds, we exit. If we get a second SIGINT, we exit immedi-
918 ately. (Default: 30 seconds)
921 **AccountingMax** __N__ **bytes**|**KB**|**MB**|**GB**|**TB**::
922 Never send more than the specified number of bytes in a given accounting
923 period, or receive more than that number in the period. For example, with
924 AccountingMax set to 1 GB, a server could send 900 MB and receive 800 MB
925 and continue running. It will only hibernate once one of the two reaches 1
926 GB. When the number of bytes is exhausted, Tor will hibernate until some
927 time in the next accounting period. To prevent all servers from waking at
928 the same time, Tor will also wait until a random point in each period
929 before waking up. If you have bandwidth cost issues, enabling hibernation
930 is preferable to setting a low bandwidth, since it provides users with a
931 collection of fast servers that are up some of the time, which is more
932 useful than a set of slow servers that are always "available".
934 **AccountingStart** **day**|**week**|**month** [__day__] __HH:MM__::
935 Specify how long accounting periods last. If **month** is given, each
936 accounting period runs from the time __HH:MM__ on the __dayth__ day of one
937 month to the same day and time of the next. (The day must be between 1 and
938 28.) If **week** is given, each accounting period runs from the time __HH:MM__
939 of the __dayth__ day of one week to the same day and time of the next week,
940 with Monday as day 1 and Sunday as day 7. If **day** is given, each
941 accounting period runs from the time __HH:MM__ each day to the same time on
942 the next day. All times are local, and given in 24-hour time. (Defaults to
945 **RefuseUnknownExits** **0**|**1**|**auto**::
946 Prevent nodes that don't appear in the consensus from exiting using this
947 relay. If the option is 1, we always block exit attempts from such
948 nodes; if it's 0, we never do, and if the option is "auto", then we do
949 whatever the authorities suggest in the consensus. (Defaults to auto.)
951 **ServerDNSResolvConfFile** __filename__::
952 Overrides the default DNS configuration with the configuration in
953 __filename__. The file format is the same as the standard Unix
954 "**resolv.conf**" file (7). This option, like all other ServerDNS options,
955 only affects name lookups that your server does on behalf of clients.
956 (Defaults to use the system DNS configuration.)
958 **ServerDNSAllowBrokenConfig** **0**|**1**::
959 If this option is false, Tor exits immediately if there are problems
960 parsing the system DNS configuration or connecting to nameservers.
961 Otherwise, Tor continues to periodically retry the system nameservers until
962 it eventually succeeds. (Defaults to "1".)
964 **ServerDNSSearchDomains** **0**|**1**::
965 If set to 1, then we will search for addresses in the local search domain.
966 For example, if this system is configured to believe it is in
967 "example.com", and a client tries to connect to "www", the client will be
968 connected to "www.example.com". This option only affects name lookups that
969 your server does on behalf of clients. (Defaults to "0".)
971 **ServerDNSDetectHijacking** **0**|**1**::
972 When this option is set to 1, we will test periodically to determine
973 whether our local nameservers have been configured to hijack failing DNS
974 requests (usually to an advertising site). If they are, we will attempt to
975 correct this. This option only affects name lookups that your server does
976 on behalf of clients. (Defaults to "1".)
978 **ServerDNSTestAddresses** __address__,__address__,__...__::
979 When we're detecting DNS hijacking, make sure that these __valid__ addresses
980 aren't getting redirected. If they are, then our DNS is completely useless,
981 and we'll reset our exit policy to "reject *:*". This option only affects
982 name lookups that your server does on behalf of clients. (Defaults to
983 "www.google.com, www.mit.edu, www.yahoo.com, www.slashdot.org".)
985 **ServerDNSAllowNonRFC953Hostnames** **0**|**1**::
986 When this option is disabled, Tor does not try to resolve hostnames
987 containing illegal characters (like @ and :) rather than sending them to an
988 exit node to be resolved. This helps trap accidental attempts to resolve
989 URLs and so on. This option only affects name lookups that your server does
990 on behalf of clients. (Default: 0)
992 **BridgeRecordUsageByCountry** **0**|**1**::
993 When this option is enabled and BridgeRelay is also enabled, and we have
994 GeoIP data, Tor keeps a keep a per-country count of how many client
995 addresses have contacted it so that it can help the bridge authority guess
996 which countries have blocked access to it. (Default: 1)
998 **ServerDNSRandomizeCase** **0**|**1**::
999 When this option is set, Tor sets the case of each character randomly in
1000 outgoing DNS requests, and makes sure that the case matches in DNS replies.
1001 This so-called "0x20 hack" helps resist some types of DNS poisoning attack.
1002 For more information, see "Increased DNS Forgery Resistance through
1003 0x20-Bit Encoding". This option only affects name lookups that your server
1004 does on behalf of clients. (Default: 1)
1006 **GeoIPFile** __filename__::
1007 A filename containing GeoIP data, for use with BridgeRecordUsageByCountry.
1009 **CellStatistics** **0**|**1**::
1010 When this option is enabled, Tor writes statistics on the mean time that
1011 cells spend in circuit queues to disk every 24 hours. (Default: 0)
1013 **DirReqStatistics** **0**|**1**::
1014 When this option is enabled, Tor writes statistics on the number and
1015 response time of network status requests to disk every 24 hours.
1018 **EntryStatistics** **0**|**1**::
1019 When this option is enabled, Tor writes statistics on the number of
1020 directly connecting clients to disk every 24 hours. (Default: 0)
1022 **ExitPortStatistics** **0**|**1**::
1023 When this option is enabled, Tor writes statistics on the number of relayed
1024 bytes and opened stream per exit port to disk every 24 hours. (Default: 0)
1026 **ExtraInfoStatistics** **0**|**1**::
1027 When this option is enabled, Tor includes previously gathered statistics in
1028 its extra-info documents that it uploads to the directory authorities.
1031 DIRECTORY SERVER OPTIONS
1032 ------------------------
1034 The following options are useful only for directory servers (that is,
1035 if DirPort is non-zero):
1037 **AuthoritativeDirectory** **0**|**1**::
1038 When this option is set to 1, Tor operates as an authoritative directory
1039 server. Instead of caching the directory, it generates its own list of
1040 good servers, signs it, and sends that to the clients. Unless the clients
1041 already have you listed as a trusted directory, you probably do not want
1042 to set this option. Please coordinate with the other admins at
1043 tor-ops@torproject.org if you think you should be a directory.
1045 **DirPortFrontPage** __FILENAME__::
1046 When this option is set, it takes an HTML file and publishes it as "/" on
1047 the DirPort. Now relay operators can provide a disclaimer without needing
1048 to set up a separate webserver. There's a sample disclaimer in
1049 contrib/tor-exit-notice.html.
1051 **V1AuthoritativeDirectory** **0**|**1**::
1052 When this option is set in addition to **AuthoritativeDirectory**, Tor
1053 generates version 1 directory and running-routers documents (for legacy
1054 Tor clients up to 0.1.0.x).
1056 **V2AuthoritativeDirectory** **0**|**1**::
1057 When this option is set in addition to **AuthoritativeDirectory**, Tor
1058 generates version 2 network statuses and serves descriptors, etc as
1059 described in doc/spec/dir-spec-v2.txt (for Tor clients and servers running
1060 0.1.1.x and 0.1.2.x).
1062 **V3AuthoritativeDirectory** **0**|**1**::
1063 When this option is set in addition to **AuthoritativeDirectory**, Tor
1064 generates version 3 network statuses and serves descriptors, etc as
1065 described in doc/spec/dir-spec.txt (for Tor clients and servers running at
1068 **VersioningAuthoritativeDirectory** **0**|**1**::
1069 When this option is set to 1, Tor adds information on which versions of
1070 Tor are still believed safe for use to the published directory. Each
1071 version 1 authority is automatically a versioning authority; version 2
1072 authorities provide this service optionally. See **RecommendedVersions**,
1073 **RecommendedClientVersions**, and **RecommendedServerVersions**.
1075 **NamingAuthoritativeDirectory** **0**|**1**::
1076 When this option is set to 1, then the server advertises that it has
1077 opinions about nickname-to-fingerprint bindings. It will include these
1078 opinions in its published network-status pages, by listing servers with
1079 the flag "Named" if a correct binding between that nickname and fingerprint
1080 has been registered with the dirserver. Naming dirservers will refuse to
1081 accept or publish descriptors that contradict a registered binding. See
1082 **approved-routers** in the **FILES** section below.
1084 **HSAuthoritativeDir** **0**|**1**::
1085 When this option is set in addition to **AuthoritativeDirectory**, Tor also
1086 accepts and serves hidden service descriptors. (Default: 0)
1088 **HidServDirectoryV2** **0**|**1**::
1089 When this option is set, Tor accepts and serves v2 hidden service
1090 descriptors. Setting DirPort is not required for this, because clients
1091 connect via the ORPort by default. (Default: 1)
1093 **BridgeAuthoritativeDir** **0**|**1**::
1094 When this option is set in addition to **AuthoritativeDirectory**, Tor
1095 accepts and serves router descriptors, but it caches and serves the main
1096 networkstatus documents rather than generating its own. (Default: 0)
1098 **MinUptimeHidServDirectoryV2** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
1099 Minimum uptime of a v2 hidden service directory to be accepted as such by
1100 authoritative directories. (Default: 24 hours)
1102 **DirPort** __PORT__::
1103 Advertise the directory service on this port.
1105 **DirListenAddress** __IP__[:__PORT__]::
1106 Bind the directory service to this address. If you specify a port, bind to
1107 this port rather than the one specified in DirPort. (Default: 0.0.0.0)
1108 This directive can be specified multiple times to bind to multiple
1111 **DirPolicy** __policy__,__policy__,__...__::
1112 Set an entrance policy for this server, to limit who can connect to the
1113 directory ports. The policies have the same form as exit policies above.
1115 DIRECTORY AUTHORITY SERVER OPTIONS
1116 ----------------------------------
1118 **RecommendedVersions** __STRING__::
1119 STRING is a comma-separated list of Tor versions currently believed to be
1120 safe. The list is included in each directory, and nodes which pull down the
1121 directory learn whether they need to upgrade. This option can appear
1122 multiple times: the values from multiple lines are spliced together. When
1123 this is set then **VersioningAuthoritativeDirectory** should be set too.
1125 **RecommendedClientVersions** __STRING__::
1126 STRING is a comma-separated list of Tor versions currently believed to be
1127 safe for clients to use. This information is included in version 2
1128 directories. If this is not set then the value of **RecommendedVersions**
1129 is used. When this is set then **VersioningAuthoritativeDirectory** should
1132 **RecommendedServerVersions** __STRING__::
1133 STRING is a comma-separated list of Tor versions currently believed to be
1134 safe for servers to use. This information is included in version 2
1135 directories. If this is not set then the value of **RecommendedVersions**
1136 is used. When this is set then **VersioningAuthoritativeDirectory** should
1139 **ConsensusParams** __STRING__::
1140 STRING is a space-separated list of key=value pairs that Tor will include
1141 in the "params" line of its networkstatus vote.
1143 **DirAllowPrivateAddresses** **0**|**1**::
1144 If set to 1, Tor will accept router descriptors with arbitrary "Address"
1145 elements. Otherwise, if the address is not an IP address or is a private IP
1146 address, it will reject the router descriptor. Defaults to 0.
1148 **AuthDirBadDir** __AddressPattern...__::
1149 Authoritative directories only. A set of address patterns for servers that
1150 will be listed as bad directories in any network status document this
1151 authority publishes, if **AuthDirListBadDirs** is set.
1153 **AuthDirBadExit** __AddressPattern...__::
1154 Authoritative directories only. A set of address patterns for servers that
1155 will be listed as bad exits in any network status document this authority
1156 publishes, if **AuthDirListBadExits** is set.
1158 **AuthDirInvalid** __AddressPattern...__::
1159 Authoritative directories only. A set of address patterns for servers that
1160 will never be listed as "valid" in any network status document that this
1161 authority publishes.
1163 **AuthDirReject** __AddressPattern__...::
1164 Authoritative directories only. A set of address patterns for servers that
1165 will never be listed at all in any network status document that this
1166 authority publishes, or accepted as an OR address in any descriptor
1167 submitted for publication by this authority.
1169 **AuthDirListBadDirs** **0**|**1**::
1170 Authoritative directories only. If set to 1, this directory has some
1171 opinion about which nodes are unsuitable as directory caches. (Do not set
1172 this to 1 unless you plan to list non-functioning directories as bad;
1173 otherwise, you are effectively voting in favor of every declared
1176 **AuthDirListBadExits** **0**|**1**::
1177 Authoritative directories only. If set to 1, this directory has some
1178 opinion about which nodes are unsuitable as exit nodes. (Do not set this to
1179 1 unless you plan to list non-functioning exits as bad; otherwise, you are
1180 effectively voting in favor of every declared exit as an exit.)
1182 **AuthDirRejectUnlisted** **0**|**1**::
1183 Authoritative directories only. If set to 1, the directory server rejects
1184 all uploaded server descriptors that aren't explicitly listed in the
1185 fingerprints file. This acts as a "panic button" if we get hit with a Sybil
1186 attack. (Default: 0)
1188 **AuthDirMaxServersPerAddr** __NUM__::
1189 Authoritative directories only. The maximum number of servers that we will
1190 list as acceptable on a single IP address. Set this to "0" for "no limit".
1193 **AuthDirMaxServersPerAuthAddr** __NUM__::
1194 Authoritative directories only. Like AuthDirMaxServersPerAddr, but applies
1195 to addresses shared with directory authorities. (Default: 5)
1197 **V3AuthVotingInterval** __N__ **minutes**|**hours**::
1198 V3 authoritative directories only. Configures the server's preferred voting
1199 interval. Note that voting will __actually__ happen at an interval chosen
1200 by consensus from all the authorities' preferred intervals. This time
1201 SHOULD divide evenly into a day. (Default: 1 hour)
1203 **V3AuthVoteDelay** __N__ **minutes**|**hours**::
1204 V3 authoritative directories only. Configures the server's preferred delay
1205 between publishing its vote and assuming it has all the votes from all the
1206 other authorities. Note that the actual time used is not the server's
1207 preferred time, but the consensus of all preferences. (Default: 5 minutes.)
1209 **V3AuthDistDelay** __N__ **minutes**|**hours**::
1210 V3 authoritative directories only. Configures the server's preferred delay
1211 between publishing its consensus and signature and assuming it has all the
1212 signatures from all the other authorities. Note that the actual time used
1213 is not the server's preferred time, but the consensus of all preferences.
1214 (Default: 5 minutes.)
1216 **V3AuthNIntervalsValid** __NUM__::
1217 V3 authoritative directories only. Configures the number of VotingIntervals
1218 for which each consensus should be valid for. Choosing high numbers
1219 increases network partitioning risks; choosing low numbers increases
1220 directory traffic. Note that the actual number of intervals used is not the
1221 server's preferred number, but the consensus of all preferences. Must be at
1222 least 2. (Default: 3.)
1224 **V3BandwidthsFile** __FILENAME__::
1225 V3 authoritative directories only. Configures the location of the
1226 bandiwdth-authority generated file storing information on relays' measured
1227 bandwidth capacities. (Default: unset.)
1229 HIDDEN SERVICE OPTIONS
1230 ----------------------
1232 The following options are used to configure a hidden service.
1234 **HiddenServiceDir** __DIRECTORY__::
1235 Store data files for a hidden service in DIRECTORY. Every hidden service
1236 must have a separate directory. You may use this option multiple times to
1237 specify multiple services.
1239 **HiddenServicePort** __VIRTPORT__ [__TARGET__]::
1240 Configure a virtual port VIRTPORT for a hidden service. You may use this
1241 option multiple times; each time applies to the service using the most
1242 recent hiddenservicedir. By default, this option maps the virtual port to
1243 the same port on 127.0.0.1. You may override the target port, address, or
1244 both by specifying a target of addr, port, or addr:port. You may also have
1245 multiple lines with the same VIRTPORT: when a user connects to that
1246 VIRTPORT, one of the TARGETs from those lines will be chosen at random.
1248 **PublishHidServDescriptors** **0**|**1**::
1249 If set to 0, Tor will run any hidden services you configure, but it won't
1250 advertise them to the rendezvous directory. This option is only useful if
1251 you're using a Tor controller that handles hidserv publishing for you.
1254 **HiddenServiceVersion** __version__,__version__,__...__::
1255 A list of rendezvous service descriptor versions to publish for the hidden
1256 service. Currently, only version 2 is supported. (Default: 2)
1258 **HiddenServiceAuthorizeClient** __auth-type__ __client-name__,__client-name__,__...__::
1259 If configured, the hidden service is accessible for authorized clients
1260 only. The auth-type can either be \'basic' for a general-purpose
1261 authorization protocol or \'stealth' for a less scalable protocol that also
1262 hides service activity from unauthorized clients. Only clients that are
1263 listed here are authorized to access the hidden service. Valid client names
1264 are 1 to 19 characters long and only use characters in A-Za-z0-9+-_ (no
1265 spaces). If this option is set, the hidden service is not accessible for
1266 clients without authorization any more. Generated authorization data can be
1267 found in the hostname file. Clients need to put this authorization data in
1268 their configuration file using **HidServAuth**.
1270 **RendPostPeriod** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
1271 Every time the specified period elapses, Tor uploads any rendezvous
1272 service descriptors to the directory servers. This information is also
1273 uploaded whenever it changes. (Default: 1 hour)
1275 TESTING NETWORK OPTIONS
1276 -----------------------
1278 The following options are used for running a testing Tor network.
1280 **TestingTorNetwork** **0**|**1**::
1281 If set to 1, Tor adjusts default values of the configuration options below,
1282 so that it is easier to set up a testing Tor network. May only be set if
1283 non-default set of DirServers is set. Cannot be unset while Tor is running.
1286 ServerDNSAllowBrokenConfig 1
1287 DirAllowPrivateAddresses 1
1288 EnforceDistinctSubnets 0
1290 AuthDirMaxServersPerAddr 0
1291 AuthDirMaxServersPerAuthAddr 0
1292 ClientDNSRejectInternalAddresses 0
1293 ExitPolicyRejectPrivate 0
1294 V3AuthVotingInterval 5 minutes
1295 V3AuthVoteDelay 20 seconds
1296 V3AuthDistDelay 20 seconds
1297 MinUptimeHidServDirectoryV2 0 seconds
1298 TestingV3AuthInitialVotingInterval 5 minutes
1299 TestingV3AuthInitialVoteDelay 20 seconds
1300 TestingV3AuthInitialDistDelay 20 seconds
1301 TestingAuthDirTimeToLearnReachability 0 minutes
1302 TestingEstimatedDescriptorPropagationTime 0 minutes
1304 **TestingV3AuthInitialVotingInterval** __N__ **minutes**|**hours**::
1305 Like V3AuthVotingInterval, but for initial voting interval before the first
1306 consensus has been created. Changing this requires that
1307 **TestingTorNetwork** is set. (Default: 30 minutes)
1309 **TestingV3AuthInitialVoteDelay** __N__ **minutes**|**hours**::
1310 Like TestingV3AuthInitialVoteDelay, but for initial voting interval before
1311 the first consensus has been created. Changing this requires that
1312 **TestingTorNetwork** is set. (Default: 5 minutes)
1314 **TestingV3AuthInitialDistDelay** __N__ **minutes**|**hours**::
1315 Like TestingV3AuthInitialDistDelay, but for initial voting interval before
1316 the first consensus has been created. Changing this requires that
1317 **TestingTorNetwork** is set. (Default: 5 minutes)
1319 **TestingAuthDirTimeToLearnReachability** __N__ **minutes**|**hours**::
1320 After starting as an authority, do not make claims about whether routers
1321 are Running until this much time has passed. Changing this requires
1322 that **TestingTorNetwork** is set. (Default: 30 minutes)
1324 **TestingEstimatedDescriptorPropagationTime** __N__ **minutes**|**hours**::
1325 Clients try downloading router descriptors from directory caches after this
1326 time. Changing this requires that **TestingTorNetwork** is set. (Default:
1332 Tor catches the following signals:
1335 Tor will catch this, clean up and sync to disk if necessary, and exit.
1338 Tor clients behave as with SIGTERM; but Tor servers will do a controlled
1339 slow shutdown, closing listeners and waiting 30 seconds before exiting.
1340 (The delay can be configured with the ShutdownWaitLength config option.)
1343 The signal instructs Tor to reload its configuration (including closing and
1344 reopening logs), and kill and restart its helper processes if applicable.
1347 Log statistics about current connections, past connections, and throughput.
1350 Switch all logs to loglevel debug. You can go back to the old loglevels by
1354 Tor receives this signal when one of its helper processes has exited, so it
1358 Tor catches this signal and ignores it.
1361 If this signal exists on your platform, Tor catches and ignores it.
1366 **@CONFDIR@/torrc**::
1367 The configuration file, which contains "option value" pairs.
1369 **@LOCALSTATEDIR@/lib/tor/**::
1370 The tor process stores keys and other data here.
1372 __DataDirectory__**/cached-status/**::
1373 The most recently downloaded network status document for each authority.
1374 Each file holds one such document; the filenames are the hexadecimal
1375 identity key fingerprints of the directory authorities.
1377 __DataDirectory__**/cached-descriptors** and **cached-descriptors.new**::
1378 These files hold downloaded router statuses. Some routers may appear more
1379 than once; if so, the most recently published descriptor is used. Lines
1380 beginning with @-signs are annotations that contain more information about
1381 a given router. The ".new" file is an append-only journal; when it gets
1382 too large, all entries are merged into a new cached-descriptors file.
1384 __DataDirectory__**/cached-routers** and **cached-routers.new**::
1385 Obsolete versions of cached-descriptors and cached-descriptors.new. When
1386 Tor can't find the newer files, it looks here instead.
1388 __DataDirectory__**/state**::
1389 A set of persistent key-value mappings. These are documented in
1390 the file. These include:
1391 - The current entry guards and their status.
1392 - The current bandwidth accounting values (unused so far; see
1394 - When the file was last written
1395 - What version of Tor generated the state file
1396 - A short history of bandwidth usage, as produced in the router
1399 __DataDirectory__**/bw_accounting**::
1400 Used to track bandwidth accounting values (when the current period starts
1401 and ends; how much has been read and written so far this period). This file
1402 is obsolete, and the data is now stored in the \'state' file as well. Only
1403 used when bandwidth accounting is enabled.
1405 __DataDirectory__**/control_auth_cookie**::
1406 Used for cookie authentication with the controller. Location can be
1407 overridden by the CookieAuthFile config option. Regenerated on startup. See
1408 control-spec.txt for details. Only used when cookie authentication is
1411 __DataDirectory__**/keys/***::
1412 Only used by servers. Holds identity keys and onion keys.
1414 __DataDirectory__**/fingerprint**::
1415 Only used by servers. Holds the fingerprint of the server's identity key.
1417 __DataDirectory__**/approved-routers**::
1418 Only for naming authoritative directory servers (see
1419 **NamingAuthoritativeDirectory**). This file lists nickname to identity
1420 bindings. Each line lists a nickname and a fingerprint separated by
1421 whitespace. See your **fingerprint** file in the __DataDirectory__ for an
1422 example line. If the nickname is **!reject** then descriptors from the
1423 given identity (fingerprint) are rejected by this server. If it is
1424 **!invalid** then descriptors are accepted but marked in the directory as
1425 not valid, that is, not recommended.
1427 __DataDirectory__**/router-stability**::
1428 Only used by authoritative directory servers. Tracks measurements for
1429 router mean-time-between-failures so that authorities have a good idea of
1430 how to set their Stable flags.
1432 __HiddenServiceDirectory__**/hostname**::
1433 The <base32-encoded-fingerprint>.onion domain name for this hidden service.
1434 If the hidden service is restricted to authorized clients only, this file
1435 also contains authorization data for all clients.
1437 __HiddenServiceDirectory__**/private_key**::
1438 The private key for this hidden service.
1440 __HiddenServiceDirectory__**/client_keys**::
1441 Authorization data for a hidden service that is only accessible by
1446 **privoxy**(1), **tsocks**(1), **torify**(1) +
1448 **https://www.torproject.org/**
1454 Plenty, probably. Tor is still in development. Please report them.
1458 Roger Dingledine [arma at mit.edu], Nick Mathewson [nickm at alum.mit.edu].