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
6 :man manual: Tor Manual
12 tor - The second-generation onion router
17 **tor** [__OPTION__ __value__]...
21 __tor__ is a connection-oriented anonymizing communication
22 service. Users choose a source-routed path through a set of nodes, and
23 negotiate a "virtual circuit" through the network, in which each node
24 knows its predecessor and successor, but no others. Traffic flowing down
25 the circuit is unwrapped by a symmetric key at each node, which reveals
26 the downstream node. +
28 Basically __tor__ provides a distributed network of servers ("onion routers").
29 Users bounce their TCP streams -- web traffic, ftp, ssh, etc -- around the
30 routers, and recipients, observers, and even the routers themselves have
31 difficulty tracking the source of the stream.
36 Display a short help message and exit.
39 Specify a new configuration file to contain further Tor configuration
40 options. (Default: $HOME/.torrc, or @CONFDIR@/torrc if that file is not
43 **--defaults-torrc** __FILE__::
44 Specify a file in which to find default values for Tor options. The
45 contents of this file are overridden by those in the regular
46 configuration file, and by those on the command line. (Default:
47 @CONFDIR@/torrc-defaults.)
50 Generates a hashed password for control port access.
52 **--list-fingerprint**::
53 Generate your keys and output your nickname and fingerprint.
56 Verify the configuration file is valid.
58 **--service install** [**--options** __command-line options__]::
59 Install an instance of Tor as a Windows service, with the provided
60 command-line options. Current instructions can be found at
61 https://trac.torproject.org/projects/tor/wiki/doc/TorFAQ#HowdoIrunmyTorrelayasanNTservice
63 **--service** **remove**|**start**|**stop**::
64 Remove, start, or stop a configured Tor Windows service.
67 Used internally to implement a Windows service.
69 **--list-torrc-options**::
70 List all valid options.
73 Display Tor version and exit.
75 **--quiet**|**--hush**::
76 Override the default console log. By default, Tor starts out logging
77 messages at level "notice" and higher to the console. It stops doing so
78 after it parses its configuration, if the configuration tells it to log
79 anywhere else. You can override this behavior with the **--hush** option,
80 which tells Tor to only send warnings and errors to the console, or with
81 the **--quiet** option, which tells Tor not to log to the console at all.
83 Other options can be specified on the command-line in the format "--option
84 value", in the format "option value", or in a configuration file. For
85 instance, you can tell Tor to start listening for SOCKS connections on port
86 9999 by passing --SOCKSPort 9999 or SOCKPort 9999 to it on the command line,
87 or by putting "SOCKSPort 9999" in the configuration file. You will need to
88 quote options with spaces in them: if you want Tor to log all debugging
89 messages to debug.log, you will probably need to say --Log 'debug file
92 Options on the command line override those in configuration files. See the
93 next section for more information.
95 THE CONFIGURATION FILE FORMAT
96 -----------------------------
98 All configuration options in a configuration are written on a single line by
99 default. They take the form of an option name and a value, or an option name
100 and a quoted value (option value or option "value"). Anything after a #
101 character is treated as a comment. Options are
102 case-insensitive. C-style escaped characters are allowed inside quoted
103 values. To split one configuration entry into multiple lines, use a single
104 backslash character (\) before the end of the line. Comments can be used in
105 such multiline entries, but they must start at the beginning of a line.
107 By default, an option on the command line overrides an option found in the
108 configuration file, and an option in a configuration file overrides one in
111 This rule is simple for options that take a single value, but it can become
112 complicated for options that are allowed to occur more than once: if you
113 specify four SOCKSPorts in your configuration file, and one more SOCKSPort on
114 the command line, the option on the command line will replace __all__ of the
115 SOCKSPorts in the configuration file. If this isn't what you want, prefix
116 the option name with a plus sign, and it will be appended to the previous set
119 Alternatively, you might want to remove every instance of an option in the
120 configuration file, and not replace it at all: you might want to say on the
121 command line that you want no SOCKSPorts at all. To do that, prefix the
122 option name with a forward slash.
127 **BandwidthRate** __N__ **bytes**|**KB**|**MB**|**GB**::
128 A token bucket limits the average incoming bandwidth usage on this node to
129 the specified number of bytes per second, and the average outgoing
130 bandwidth usage to that same value. If you want to run a relay in the
131 public network, this needs to be _at the very least_ 30 KB (that is,
132 30720 bytes). (Default: 5 MB)
134 **BandwidthBurst** __N__ **bytes**|**KB**|**MB**|**GB**::
135 Limit the maximum token bucket size (also known as the burst) to the given
136 number of bytes in each direction. (Default: 10 MB)
138 **MaxAdvertisedBandwidth** __N__ **bytes**|**KB**|**MB**|**GB**::
139 If set, we will not advertise more than this amount of bandwidth for our
140 BandwidthRate. Server operators who want to reduce the number of clients
141 who ask to build circuits through them (since this is proportional to
142 advertised bandwidth rate) can thus reduce the CPU demands on their server
143 without impacting network performance.
145 **RelayBandwidthRate** __N__ **bytes**|**KB**|**MB**|**GB**::
146 If not 0, a separate token bucket limits the average incoming bandwidth
147 usage for \_relayed traffic_ on this node to the specified number of bytes
148 per second, and the average outgoing bandwidth usage to that same value.
149 Relayed traffic currently is calculated to include answers to directory
150 requests, but that may change in future versions. (Default: 0)
152 **RelayBandwidthBurst** __N__ **bytes**|**KB**|**MB**|**GB**::
153 If not 0, limit the maximum token bucket size (also known as the burst) for
154 \_relayed traffic_ to the given number of bytes in each direction.
157 **PerConnBWRate** __N__ **bytes**|**KB**|**MB**|**GB**::
158 If set, do separate rate limiting for each connection from a non-relay.
159 You should never need to change this value, since a network-wide value is
160 published in the consensus and your relay will use that value. (Default: 0)
162 **PerConnBWBurst** __N__ **bytes**|**KB**|**MB**|**GB**::
163 If set, do separate rate limiting for each connection from a non-relay.
164 You should never need to change this value, since a network-wide value is
165 published in the consensus and your relay will use that value. (Default: 0)
167 **ClientTransportPlugin** __transport__ socks4|socks5 __IP__:__PORT__::
168 **ClientTransportPlugin** __transport__ exec __path-to-binary__ [options]::
169 In its first form, when set along with a corresponding Bridge line, the Tor
170 client forwards its traffic to a SOCKS-speaking proxy on "IP:PORT". It's the
171 duty of that proxy to properly forward the traffic to the bridge. +
173 In its second form, when set along with a corresponding Bridge line, the Tor
174 client launches the pluggable transport proxy executable in
175 __path-to-binary__ using __options__ as its command-line options, and
176 forwards its traffic to it. It's the duty of that proxy to properly forward
177 the traffic to the bridge.
179 **ServerTransportPlugin** __transport__ exec __path-to-binary__ [options]::
180 The Tor relay launches the pluggable transport proxy in __path-to-binary__
181 using __options__ as its command-line options, and expects to receive
182 proxied client traffic from it.
184 **ConnLimit** __NUM__::
185 The minimum number of file descriptors that must be available to the Tor
186 process before it will start. Tor will ask the OS for as many file
187 descriptors as the OS will allow (you can find this by "ulimit -H -n").
188 If this number is less than ConnLimit, then Tor will refuse to start. +
190 You probably don't need to adjust this. It has no effect on Windows
191 since that platform lacks getrlimit(). (Default: 1000)
193 **DisableNetwork** **0**|**1**::
194 When this option is set, we don't listen for or accept any connections
195 other than controller connections, and we don't make any outbound
196 connections. Controllers sometimes use this option to avoid using
197 the network until Tor is fully configured. (Default: 0)
199 **ConstrainedSockets** **0**|**1**::
200 If set, Tor will tell the kernel to attempt to shrink the buffers for all
201 sockets to the size specified in **ConstrainedSockSize**. This is useful for
202 virtual servers and other environments where system level TCP buffers may
203 be limited. If you're on a virtual server, and you encounter the "Error
204 creating network socket: No buffer space available" message, you are
205 likely experiencing this problem. +
207 The preferred solution is to have the admin increase the buffer pool for
208 the host itself via /proc/sys/net/ipv4/tcp_mem or equivalent facility;
209 this configuration option is a second-resort. +
211 The DirPort option should also not be used if TCP buffers are scarce. The
212 cached directory requests consume additional sockets which exacerbates
215 You should **not** enable this feature unless you encounter the "no buffer
216 space available" issue. Reducing the TCP buffers affects window size for
217 the TCP stream and will reduce throughput in proportion to round trip
218 time on long paths. (Default: 0)
220 **ConstrainedSockSize** __N__ **bytes**|**KB**::
221 When **ConstrainedSockets** is enabled the receive and transmit buffers for
222 all sockets will be set to this limit. Must be a value between 2048 and
223 262144, in 1024 byte increments. Default of 8192 is recommended.
225 **ControlPort** __PORT__|**auto**::
226 If set, Tor will accept connections on this port and allow those
227 connections to control the Tor process using the Tor Control Protocol
228 (described in control-spec.txt). Note: unless you also specify one or
229 more of **HashedControlPassword** or **CookieAuthentication**,
230 setting this option will cause Tor to allow any process on the local
231 host to control it. (Setting both authentication methods means either
232 method is sufficient to authenticate to Tor.) This
233 option is required for many Tor controllers; most use the value of 9051.
234 Set it to "auto" to have Tor pick a port for you. (Default: 0)
236 **ControlListenAddress** __IP__[:__PORT__]::
237 Bind the controller listener to this address. If you specify a port, bind
238 to this port rather than the one specified in ControlPort. We strongly
239 recommend that you leave this alone unless you know what you're doing,
240 since giving attackers access to your control listener is really
241 dangerous. This directive can be specified multiple
242 times to bind to multiple addresses/ports. (Default: 127.0.0.1)
244 **ControlSocket** __Path__::
245 Like ControlPort, but listens on a Unix domain socket, rather than a TCP
246 socket. (Unix and Unix-like systems only.)
248 **ControlSocketsGroupWritable** **0**|**1**::
249 If this option is set to 0, don't allow the filesystem group to read and
250 write unix sockets (e.g. ControlSocket). If the option is set to 1, make
251 the control socket readable and writable by the default GID. (Default: 0)
253 **HashedControlPassword** __hashed_password__::
254 Allow connections on the control port if they present
255 the password whose one-way hash is __hashed_password__. You
256 can compute the hash of a password by running "tor --hash-password
257 __password__". You can provide several acceptable passwords by using more
258 than one HashedControlPassword line.
260 **CookieAuthentication** **0**|**1**::
261 If this option is set to 1, allow connections on the control port
262 when the connecting process knows the contents of a file named
263 "control_auth_cookie", which Tor will create in its data directory. This
264 authentication method should only be used on systems with good filesystem
265 security. (Default: 0)
267 **CookieAuthFile** __Path__::
268 If set, this option overrides the default location and file name
269 for Tor's cookie file. (See CookieAuthentication above.)
271 **CookieAuthFileGroupReadable** **0**|**1**|__Groupname__::
272 If this option is set to 0, don't allow the filesystem group to read the
273 cookie file. If the option is set to 1, make the cookie file readable by
274 the default GID. [Making the file readable by other groups is not yet
275 implemented; let us know if you need this for some reason.] (Default: 0)
277 **ControlPortWriteToFile** __Path__::
278 If set, Tor writes the address and port of any control port it opens to
279 this address. Usable by controllers to learn the actual control port
280 when ControlPort is set to "auto".
282 **ControlPortFileGroupReadable** **0**|**1**::
283 If this option is set to 0, don't allow the filesystem group to read the
284 control port file. If the option is set to 1, make the control port
285 file readable by the default GID. (Default: 0)
287 **DataDirectory** __DIR__::
288 Store working data in DIR (Default: @LOCALSTATEDIR@/lib/tor)
290 **DirServer** [__nickname__] [**flags**] __address__:__port__ __fingerprint__::
291 Use a nonstandard authoritative directory server at the provided address
292 and port, with the specified key fingerprint. This option can be repeated
293 many times, for multiple authoritative directory servers. Flags are
294 separated by spaces, and determine what kind of an authority this directory
295 is. By default, every authority is authoritative for current ("v2")-style
296 directories, unless the "no-v2" flag is given. If the "v1" flags is
297 provided, Tor will use this server as an authority for old-style (v1)
298 directories as well. (Only directory mirrors care about this.) Tor will
299 use this server as an authority for hidden service information if the "hs"
300 flag is set, or if the "v1" flag is set and the "no-hs" flag is **not** set.
301 Tor will use this authority as a bridge authoritative directory if the
302 "bridge" flag is set. If a flag "orport=**port**" is given, Tor will use the
303 given port when opening encrypted tunnels to the dirserver. Lastly, if a
304 flag "v3ident=**fp**" is given, the dirserver is a v3 directory authority
305 whose v3 long-term signing key has the fingerprint **fp**. +
307 If no **dirserver** line is given, Tor will use the default directory
308 servers. NOTE: this option is intended for setting up a private Tor
309 network with its own directory authorities. If you use it, you will be
310 distinguishable from other users, because you won't believe the same
313 **DynamicDHGroups** **0**|**1**::
314 If this option is set to 1, when running as a server, generate our
315 own Diffie-Hellman group instead of using the one from Apache's mod_ssl.
316 This option may help circumvent censorship based on static
317 Diffie-Hellman parameters. (Default: 0)
319 **AlternateDirAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__ +
321 **AlternateHSAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__ +
323 **AlternateBridgeAuthority** [__nickname__] [**flags**] __address__:__port__ __ fingerprint__::
324 These options behave as DirServer, but they replace fewer of the
325 default directory authorities. Using
326 AlternateDirAuthority replaces the default Tor directory authorities, but
327 leaves the default hidden service authorities and bridge authorities in
328 place. Similarly, AlternateHSAuthority replaces the default hidden
329 service authorities, but not the directory or bridge authorities; and
330 AlternateBridgeAuthority replaces the default bridge authority,
331 but leaves the directory and hidden service authorities alone.
333 **DisableAllSwap** **0**|**1**::
334 If set to 1, Tor will attempt to lock all current and future memory pages,
335 so that memory cannot be paged out. Windows, OS X and Solaris are currently
336 not supported. We believe that this feature works on modern Gnu/Linux
337 distributions, and that it should work on *BSD systems (untested). This
338 option requires that you start your Tor as root, and you should use the
339 **User** option to properly reduce Tor's privileges. (Default: 0)
341 **DisableDebuggerAttachment** **0**|**1**::
342 If set to 1, Tor will attempt to prevent basic debugging attachment attempts
343 by other processes. It has no impact for users who wish to attach if they
344 have CAP_SYS_PTRACE or if they are root. We believe that this feature
345 works on modern Gnu/Linux distributions, and that it may also work on *BSD
346 systems (untested). Some modern Gnu/Linux systems such as Ubuntu have the
347 kernel.yama.ptrace_scope sysctl and by default enable it as an attempt to
348 limit the PTRACE scope for all user processes by default. This feature will
349 attempt to limit the PTRACE scope for Tor specifically - it will not attempt
350 to alter the system wide ptrace scope as it may not even exist. If you wish
351 to attach to Tor with a debugger such as gdb or strace you will want to set
352 this to 0 for the duration of your debugging. Normal users should leave it
353 on. Disabling this option while Tor is running is prohibited. (Default: 1)
355 **FetchDirInfoEarly** **0**|**1**::
356 If set to 1, Tor will always fetch directory information like other
357 directory caches, even if you don't meet the normal criteria for fetching
358 early. Normal users should leave it off. (Default: 0)
360 **FetchDirInfoExtraEarly** **0**|**1**::
361 If set to 1, Tor will fetch directory information before other directory
362 caches. It will attempt to download directory information closer to the
363 start of the consensus period. Normal users should leave it off.
366 **FetchHidServDescriptors** **0**|**1**::
367 If set to 0, Tor will never fetch any hidden service descriptors from the
368 rendezvous directories. This option is only useful if you're using a Tor
369 controller that handles hidden service fetches for you. (Default: 1)
371 **FetchServerDescriptors** **0**|**1**::
372 If set to 0, Tor will never fetch any network status summaries or server
373 descriptors from the directory servers. This option is only useful if
374 you're using a Tor controller that handles directory fetches for you.
377 **FetchUselessDescriptors** **0**|**1**::
378 If set to 1, Tor will fetch every non-obsolete descriptor from the
379 authorities that it hears about. Otherwise, it will avoid fetching useless
380 descriptors, for example for routers that are not running. This option is
381 useful if you're using the contributed "exitlist" script to enumerate Tor
382 nodes that exit to certain addresses. (Default: 0)
384 **HTTPProxy** __host__[:__port__]::
385 Tor will make all its directory requests through this host:port (or host:80
386 if port is not specified), rather than connecting directly to any directory
389 **HTTPProxyAuthenticator** __username:password__::
390 If defined, Tor will use this username:password for Basic HTTP proxy
391 authentication, as in RFC 2617. This is currently the only form of HTTP
392 proxy authentication that Tor supports; feel free to submit a patch if you
393 want it to support others.
395 **HTTPSProxy** __host__[:__port__]::
396 Tor will make all its OR (SSL) connections through this host:port (or
397 host:443 if port is not specified), via HTTP CONNECT rather than connecting
398 directly to servers. You may want to set **FascistFirewall** to restrict
399 the set of ports you might try to connect to, if your HTTPS proxy only
400 allows connecting to certain ports.
402 **HTTPSProxyAuthenticator** __username:password__::
403 If defined, Tor will use this username:password for Basic HTTPS proxy
404 authentication, as in RFC 2617. This is currently the only form of HTTPS
405 proxy authentication that Tor supports; feel free to submit a patch if you
406 want it to support others.
408 **Socks4Proxy** __host__[:__port__]::
409 Tor will make all OR connections through the SOCKS 4 proxy at host:port
410 (or host:1080 if port is not specified).
412 **Socks5Proxy** __host__[:__port__]::
413 Tor will make all OR connections through the SOCKS 5 proxy at host:port
414 (or host:1080 if port is not specified).
416 **Socks5ProxyUsername** __username__ +
418 **Socks5ProxyPassword** __password__::
419 If defined, authenticate to the SOCKS 5 server using username and password
420 in accordance to RFC 1929. Both username and password must be between 1 and
423 **KeepalivePeriod** __NUM__::
424 To keep firewalls from expiring connections, send a padding keepalive cell
425 every NUM seconds on open connections that are in use. If the connection
426 has no open circuits, it will instead be closed after NUM seconds of
427 idleness. (Default: 5 minutes)
429 **Log** __minSeverity__[-__maxSeverity__] **stderr**|**stdout**|**syslog**::
430 Send all messages between __minSeverity__ and __maxSeverity__ to the standard
431 output stream, the standard error stream, or to the system log. (The
432 "syslog" value is only supported on Unix.) Recognized severity levels are
433 debug, info, notice, warn, and err. We advise using "notice" in most cases,
434 since anything more verbose may provide sensitive information to an
435 attacker who obtains the logs. If only one severity level is given, all
436 messages of that level or higher will be sent to the listed destination.
438 **Log** __minSeverity__[-__maxSeverity__] **file** __FILENAME__::
439 As above, but send log messages to the listed filename. The
440 "Log" option may appear more than once in a configuration file.
441 Messages are sent to all the logs that match their severity
444 **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **file** __FILENAME__ +
446 **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **stderr**|**stdout**|**syslog**::
447 As above, but select messages by range of log severity __and__ by a
448 set of "logging domains". Each logging domain corresponds to an area of
449 functionality inside Tor. You can specify any number of severity ranges
450 for a single log statement, each of them prefixed by a comma-separated
451 list of logging domains. You can prefix a domain with $$~$$ to indicate
452 negation, and use * to indicate "all domains". If you specify a severity
453 range without a list of domains, it matches all domains. +
455 This is an advanced feature which is most useful for debugging one or two
456 of Tor's subsystems at a time. +
458 The currently recognized domains are: general, crypto, net, config, fs,
459 protocol, mm, http, app, control, circ, rend, bug, dir, dirserv, or, edge,
460 acct, hist, and handshake. Domain names are case-insensitive. +
462 For example, "`Log [handshake]debug [~net,~mm]info notice stdout`" sends
463 to stdout: all handshake messages of any severity, all info-and-higher
464 messages from domains other than networking and memory management, and all
465 messages of severity notice or higher.
467 **LogMessageDomains** **0**|**1**::
468 If 1, Tor includes message domains with each log message. Every log
469 message currently has at least one domain; most currently have exactly
470 one. This doesn't affect controller log messages. (Default: 0)
472 **OutboundBindAddress** __IP__::
473 Make all outbound connections originate from the IP address specified. This
474 is only useful when you have multiple network interfaces, and you want all
475 of Tor's outgoing connections to use a single one. This setting will be
476 ignored for connections to the loopback addresses (127.0.0.0/8 and ::1).
478 **PidFile** __FILE__::
479 On startup, write our PID to FILE. On clean shutdown, remove
482 **ProtocolWarnings** **0**|**1**::
483 If 1, Tor will log with severity \'warn' various cases of other parties not
484 following the Tor specification. Otherwise, they are logged with severity
485 \'info'. (Default: 0)
487 **RunAsDaemon** **0**|**1**::
488 If 1, Tor forks and daemonizes to the background. This option has no effect
489 on Windows; instead you should use the --service command-line option.
492 **LogTimeGranularity** __NUM__::
493 Set the resolution of timestamps in Tor's logs to NUM milliseconds.
494 NUM must be positive and either a divisor or a multiple of 1 second.
495 Note that this option only controls the granularity written by Tor to
496 a file or console log. Tor does not (for example) "batch up" log
497 messages to affect times logged by a controller, times attached to
498 syslog messages, or the mtime fields on log files. (Default: 1 second)
500 **SafeLogging** **0**|**1**|**relay**::
501 Tor can scrub potentially sensitive strings from log messages (e.g.
502 addresses) by replacing them with the string [scrubbed]. This way logs can
503 still be useful, but they don't leave behind personally identifying
504 information about what sites a user might have visited. +
506 If this option is set to 0, Tor will not perform any scrubbing, if it is
507 set to 1, all potentially sensitive strings are replaced. If it is set to
508 relay, all log messages generated when acting as a relay are sanitized, but
509 all messages generated when acting as a client are not. (Default: 1)
512 On startup, setuid to this user and setgid to their primary group.
514 **HardwareAccel** **0**|**1**::
515 If non-zero, try to use built-in (static) crypto hardware acceleration when
516 available. (Default: 0)
518 **AccelName** __NAME__::
519 When using OpenSSL hardware crypto acceleration attempt to load the dynamic
520 engine of this name. This must be used for any dynamic hardware engine.
521 Names can be verified with the openssl engine command.
523 **AccelDir** __DIR__::
524 Specify this option if using dynamic hardware acceleration and the engine
525 implementation library resides somewhere other than the OpenSSL default.
527 **AvoidDiskWrites** **0**|**1**::
528 If non-zero, try to write to disk less frequently than we would otherwise.
529 This is useful when running on flash memory or other media that support
530 only a limited number of writes. (Default: 0)
532 **TunnelDirConns** **0**|**1**::
533 If non-zero, when a directory server we contact supports it, we will build
534 a one-hop circuit and make an encrypted connection via its ORPort.
537 **PreferTunneledDirConns** **0**|**1**::
538 If non-zero, we will avoid directory servers that don't support tunneled
539 directory connections, when possible. (Default: 1)
541 **CircuitPriorityHalflife** __NUM1__::
542 If this value is set, we override the default algorithm for choosing which
543 circuit's cell to deliver or relay next. When the value is 0, we
544 round-robin between the active circuits on a connection, delivering one
545 cell from each in turn. When the value is positive, we prefer delivering
546 cells from whichever connection has the lowest weighted cell count, where
547 cells are weighted exponentially according to the supplied
548 CircuitPriorityHalflife value (in seconds). If this option is not set at
549 all, we use the behavior recommended in the current consensus
550 networkstatus. This is an advanced option; you generally shouldn't have
551 to mess with it. (Default: not set)
553 **DisableIOCP** **0**|**1**::
554 If Tor was built to use the Libevent's "bufferevents" networking code
555 and you're running on Windows, setting this option to 1 will tell Libevent
556 not to use the Windows IOCP networking API. (Default: 1)
558 **UserspaceIOCPBuffers** **0**|**1**::
559 If IOCP is enabled (see DisableIOCP above), setting this option to 1
560 will tell Tor to disable kernel-space TCP buffers, in order to avoid
561 needless copy operations and try not to run out of non-paged RAM.
562 This feature is experimental; don't use it yet unless you're eager to
563 help tracking down bugs. (Default: 0)
565 **_UseFilteringSSLBufferevents** **0**|**1**::
566 Tells Tor to do its SSL communication using a chain of
567 bufferevents: one for SSL and one for networking. This option has no
568 effect if bufferevents are disabled (in which case it can't turn on), or
569 if IOCP bufferevents are enabled (in which case it can't turn off). This
570 option is useful for debugging only; most users shouldn't touch it.
573 **CountPrivateBandwidth** **0**|**1**::
574 If this option is set, then Tor's rate-limiting applies not only to
575 remote connections, but also to connections to private addresses like
576 127.0.0.1 or 10.0.0.1. This is mostly useful for debugging
577 rate-limiting. (Default: 0)
582 The following options are useful only for clients (that is, if
583 **SocksPort**, **TransPort**, **DNSPort**, or **NATDPort** is non-zero):
585 **AllowInvalidNodes** **entry**|**exit**|**middle**|**introduction**|**rendezvous**|**...**::
586 If some Tor servers are obviously not working right, the directory
587 authorities can manually mark them as invalid, meaning that it's not
588 recommended you use them for entry or exit positions in your circuits. You
589 can opt to use them in some circuit positions, though. The default is
590 "middle,rendezvous", and other choices are not advised.
592 **ExcludeSingleHopRelays** **0**|**1**::
593 This option controls whether circuits built by Tor will include relays with
594 the AllowSingleHopExits flag set to true. If ExcludeSingleHopRelays is set
595 to 0, these relays will be included. Note that these relays might be at
596 higher risk of being seized or observed, so they are not normally
597 included. Also note that relatively few clients turn off this option,
598 so using these relays might make your client stand out.
601 **Bridge** [__transport__] __IP__:__ORPort__ [__fingerprint__]::
602 When set along with UseBridges, instructs Tor to use the relay at
603 "IP:ORPort" as a "bridge" relaying into the Tor network. If "fingerprint"
604 is provided (using the same format as for DirServer), we will verify that
605 the relay running at that location has the right fingerprint. We also use
606 fingerprint to look up the bridge descriptor at the bridge authority, if
607 it's provided and if UpdateBridgesFromAuthority is set too. +
609 If "transport" is provided, and matches to a ClientTransportPlugin
610 line, we use that pluggable transports proxy to transfer data to
613 **LearnCircuitBuildTimeout** **0**|**1**::
614 If 0, CircuitBuildTimeout adaptive learning is disabled. (Default: 1)
616 **CircuitBuildTimeout** __NUM__::
618 Try for at most NUM seconds when building circuits. If the circuit isn't
619 open in that time, give up on it. If LearnCircuitBuildTimeout is 1, this
620 value serves as the initial value to use before a timeout is learned. If
621 LearnCircuitBuildTimeout is 0, this value is the only value used.
622 (Default: 60 seconds)
624 **CircuitIdleTimeout** __NUM__::
625 If we have kept a clean (never used) circuit around for NUM seconds, then
626 close it. This way when the Tor client is entirely idle, it can expire all
627 of its circuits, and then expire its TLS connections. Also, if we end up
628 making a circuit that is not useful for exiting any of the requests we're
629 receiving, it won't forever take up a slot in the circuit list. (Default: 1
632 **CircuitStreamTimeout** __NUM__::
633 If non-zero, this option overrides our internal timeout schedule for how
634 many seconds until we detach a stream from a circuit and try a new circuit.
635 If your network is particularly slow, you might want to set this to a
636 number like 60. (Default: 0)
638 **ClientOnly** **0**|**1**::
639 If set to 1, Tor will under no circumstances run as a relay or serve
640 directory requests. This config option is mostly meaningless: we
641 added it back when we were considering having Tor clients auto-promote
642 themselves to being relays if they were stable and fast enough. The
643 current behavior is simply that Tor is a client unless ORPort or
644 DirPort are configured. (Default: 0)
646 **ExcludeNodes** __node__,__node__,__...__::
647 A list of identity fingerprints, nicknames, country codes and address
648 patterns of nodes to avoid when building a circuit.
650 ExcludeNodes SlowServer, ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
652 By default, this option is treated as a preference that Tor is allowed
653 to override in order to keep working.
654 For example, if you try to connect to a hidden service,
655 but you have excluded all of the hidden service's introduction points,
656 Tor will connect to one of them anyway. If you do not want this
657 behavior, set the StrictNodes option (documented below). +
659 Note also that if you are a relay, this (and the other node selection
660 options below) only affects your own circuits that Tor builds for you.
661 Clients can still build circuits through you to any node. Controllers
662 can tell Tor to build circuits through any node.
665 **ExcludeExitNodes** __node__,__node__,__...__::
666 A list of identity fingerprints, nicknames, country codes and address
667 patterns of nodes to never use when picking an exit node---that is, a
668 node that delivers traffic for you outside the Tor network. Note that any
669 node listed in ExcludeNodes is automatically considered to be part of this
670 list too. See also the caveats on the "ExitNodes" option below.
672 **ExitNodes** __node__,__node__,__...__::
673 A list of identity fingerprints, nicknames, country codes and address
674 patterns of nodes to use as exit node---that is, a
675 node that delivers traffic for you outside the Tor network. +
677 Note that if you list too few nodes here, or if you exclude too many exit
678 nodes with ExcludeExitNodes, you can degrade functionality. For example,
679 if none of the exits you list allows traffic on port 80 or 443, you won't
680 be able to browse the web. +
682 Note also that not every circuit is used to deliver traffic outside of
683 the Tor network. It is normal to see non-exit circuits (such as those
684 used to connect to hidden services, those that do directory fetches,
685 those used for relay reachability self-tests, and so on) that end
686 at a non-exit node. To
687 keep a node from being used entirely, see ExcludeNodes and StrictNodes. +
689 The ExcludeNodes option overrides this option: any node listed in both
690 ExitNodes and ExcludeNodes is treated as excluded. +
692 The .exit address notation, if enabled via AllowDotExit, overrides
695 **EntryNodes** __node__,__node__,__...__::
696 A list of identity fingerprints, nicknames, and country codes of nodes
697 to use for the first hop in your normal circuits.
698 Normal circuits include all
699 circuits except for direct connections to directory servers. The Bridge
700 option overrides this option; if you have configured bridges and
701 UseBridges is 1, the Bridges are used as your entry nodes. +
703 The ExcludeNodes option overrides this option: any node listed in both
704 EntryNodes and ExcludeNodes is treated as excluded.
706 **StrictNodes** **0**|**1**::
707 If StrictNodes is set to 1, Tor will treat the ExcludeNodes option as a
708 requirement to follow for all the circuits you generate, even if doing so
709 will break functionality for you. If StrictNodes is set to 0, Tor will
710 still try to avoid nodes in the ExcludeNodes list, but it will err on the
711 side of avoiding unexpected errors. Specifically, StrictNodes 0 tells
712 Tor that it is okay to use an excluded node when it is *necessary* to
713 perform relay reachability self-tests, connect to
714 a hidden service, provide a hidden service to a client, fulfill a .exit
715 request, upload directory information, or download directory information.
718 **FascistFirewall** **0**|**1**::
719 If 1, Tor will only create outgoing connections to ORs running on ports
720 that your firewall allows (defaults to 80 and 443; see **FirewallPorts**).
721 This will allow you to run Tor as a client behind a firewall with
722 restrictive policies, but will not allow you to run as a server behind such
723 a firewall. If you prefer more fine-grained control, use
724 ReachableAddresses instead.
726 **FirewallPorts** __PORTS__::
727 A list of ports that your firewall allows you to connect to. Only used when
728 **FascistFirewall** is set. This option is deprecated; use ReachableAddresses
729 instead. (Default: 80, 443)
731 **ReachableAddresses** __ADDR__[/__MASK__][:__PORT__]...::
732 A comma-separated list of IP addresses and ports that your firewall allows
733 you to connect to. The format is as for the addresses in ExitPolicy, except
734 that "accept" is understood unless "reject" is explicitly provided. For
735 example, \'ReachableAddresses 99.0.0.0/8, reject 18.0.0.0/8:80, accept
736 \*:80' means that your firewall allows connections to everything inside net
737 99, rejects port 80 connections to net 18, and accepts connections to port
738 80 otherwise. (Default: \'accept \*:*'.)
740 **ReachableDirAddresses** __ADDR__[/__MASK__][:__PORT__]...::
741 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
742 these restrictions when fetching directory information, using standard HTTP
743 GET requests. If not set explicitly then the value of
744 **ReachableAddresses** is used. If **HTTPProxy** is set then these
745 connections will go through that proxy.
747 **ReachableORAddresses** __ADDR__[/__MASK__][:__PORT__]...::
748 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
749 these restrictions when connecting to Onion Routers, using TLS/SSL. If not
750 set explicitly then the value of **ReachableAddresses** is used. If
751 **HTTPSProxy** is set then these connections will go through that proxy. +
753 The separation between **ReachableORAddresses** and
754 **ReachableDirAddresses** is only interesting when you are connecting
755 through proxies (see **HTTPProxy** and **HTTPSProxy**). Most proxies limit
756 TLS connections (which Tor uses to connect to Onion Routers) to port 443,
757 and some limit HTTP GET requests (which Tor uses for fetching directory
758 information) to port 80.
760 **HidServAuth** __onion-address__ __auth-cookie__ [__service-name__]::
761 Client authorization for a hidden service. Valid onion addresses contain 16
762 characters in a-z2-7 plus ".onion", and valid auth cookies contain 22
763 characters in A-Za-z0-9+/. The service name is only used for internal
764 purposes, e.g., for Tor controllers. This option may be used multiple times
765 for different hidden services. If a hidden service uses authorization and
766 this option is not set, the hidden service is not accessible. Hidden
767 services can be configured to require authorization using the
768 **HiddenServiceAuthorizeClient** option.
770 **CloseHSClientCircuitsImmediatelyOnTimeout** **0**|**1**::
771 If 1, Tor will close unfinished hidden service client circuits
772 which have not moved closer to connecting to their destination
773 hidden service when their internal state has not changed for the
774 duration of the current circuit-build timeout. Otherwise, such
775 circuits will be left open, in the hope that they will finish
776 connecting to their destination hidden services. In either case,
777 another set of introduction and rendezvous circuits for the same
778 destination hidden service will be launched. (Default: 0)
780 **CloseHSServiceRendCircuitsImmediatelyOnTimeout** **0**|**1**::
781 If 1, Tor will close unfinished hidden-service-side rendezvous
782 circuits after the current circuit-build timeout. Otherwise, such
783 circuits will be left open, in the hope that they will finish
784 connecting to their destinations. In either case, another
785 rendezvous circuit for the same destination client will be
786 launched. (Default: 0)
788 **LongLivedPorts** __PORTS__::
789 A list of ports for services that tend to have long-running connections
790 (e.g. chat and interactive shells). Circuits for streams that use these
791 ports will contain only high-uptime nodes, to reduce the chance that a node
792 will go down before the stream is finished. Note that the list is also
793 honored for circuits (both client and service side) involving hidden
794 services whose virtual port is in this list. (Default: 21, 22, 706,
795 1863, 5050, 5190, 5222, 5223, 6523, 6667, 6697, 8300)
797 **MapAddress** __address__ __newaddress__::
798 When a request for address arrives to Tor, it will transform to newaddress
799 before processing it. For example, if you always want connections to
800 www.example.com to exit via __torserver__ (where __torserver__ is the
801 nickname of the server), use "MapAddress www.example.com
802 www.example.com.torserver.exit". If the value is prefixed with a
803 "\*.", matches an entire domain. For example, if you
804 always want connections to example.com and any if its subdomains
806 __torserver__ (where __torserver__ is the nickname of the server), use
807 "MapAddress \*.example.com \*.example.com.torserver.exit". (Note the
808 leading "*." in each part of the directive.) You can also redirect all
809 subdomains of a domain to a single address. For example, "MapAddress
810 *.example.com www.example.com". +
814 1. When evaluating MapAddress expressions Tor stops when it hits the most
815 recently added expression that matches the requested address. So if you
816 have the following in your torrc, www.torproject.org will map to 1.1.1.1:
818 MapAddress www.torproject.org 2.2.2.2
819 MapAddress www.torproject.org 1.1.1.1
821 2. Tor evaluates the MapAddress configuration until it finds no matches. So
822 if you have the following in your torrc, www.torproject.org will map to
825 MapAddress 1.1.1.1 2.2.2.2
826 MapAddress www.torproject.org 1.1.1.1
828 3. The following MapAddress expression is invalid (and will be
829 ignored) because you cannot map from a specific address to a wildcard
832 MapAddress www.torproject.org *.torproject.org.torserver.exit
834 4. Using a wildcard to match only part of a string (as in *ample.com) is
837 **NewCircuitPeriod** __NUM__::
838 Every NUM seconds consider whether to build a new circuit. (Default: 30
841 **MaxCircuitDirtiness** __NUM__::
842 Feel free to reuse a circuit that was first used at most NUM seconds ago,
843 but never attach a new stream to a circuit that is too old. For hidden
844 services, this applies to the __last__ time a circuit was used, not the
845 first. (Default: 10 minutes)
847 **MaxClientCircuitsPending** __NUM__::
848 Do not allow more than NUM circuits to be pending at a time for handling
849 client streams. A circuit is pending if we have begun constructing it,
850 but it has not yet been completely constructed. (Default: 32)
852 **NodeFamily** __node__,__node__,__...__::
853 The Tor servers, defined by their identity fingerprints or nicknames,
854 constitute a "family" of similar or co-administered servers, so never use
855 any two of them in the same circuit. Defining a NodeFamily is only needed
856 when a server doesn't list the family itself (with MyFamily). This option
857 can be used multiple times. In addition to nodes, you can also list
858 IP address and ranges and country codes in {curly braces}.
860 **EnforceDistinctSubnets** **0**|**1**::
861 If 1, Tor will not put two servers whose IP addresses are "too close" on
862 the same circuit. Currently, two addresses are "too close" if they lie in
863 the same /16 range. (Default: 1)
865 **SOCKSPort** \['address':]__port__|**auto** [_isolation flags_]::
866 Open this port to listen for connections from SOCKS-speaking
867 applications. Set this to 0 if you don't want to allow application
868 connections via SOCKS. Set it to "auto" to have Tor pick a port for
869 you. This directive can be specified multiple times to bind
870 to multiple addresses/ports. (Default: 9050) +
872 The _isolation flags_ arguments give Tor rules for which streams
873 received on this SOCKSPort are allowed to share circuits with one
874 another. Recognized isolation flags are:
875 **IsolateClientAddr**;;
876 Don't share circuits with streams from a different
877 client address. (On by default and strongly recommended;
878 you can disable it with **NoIsolateClientAddr**.)
879 **IsolateSOCKSAuth**;;
880 Don't share circuits with streams for which different
881 SOCKS authentication was provided. (On by default;
882 you can disable it with **NoIsolateSOCKSAuth**.)
883 **IsolateClientProtocol**;;
884 Don't share circuits with streams using a different protocol.
885 (SOCKS 4, SOCKS 5, TransPort connections, NATDPort connections,
886 and DNSPort requests are all considered to be different protocols.)
887 **IsolateDestPort**;;
888 Don't share circuits with streams targetting a different
890 **IsolateDestAddr**;;
891 Don't share circuits with streams targetting a different
893 **SessionGroup=**__INT__;;
894 If no other isolation rules would prevent it, allow streams
895 on this port to share circuits with streams from every other
896 port with the same session group. (By default, streams received
897 on different SOCKSPorts, TransPorts, etc are always isolated from one
898 another. This option overrides that behavior.)
900 **SOCKSListenAddress** __IP__[:__PORT__]::
901 Bind to this address to listen for connections from Socks-speaking
902 applications. (Default: 127.0.0.1) You can also specify a port (e.g.
903 192.168.0.1:9100). This directive can be specified multiple times to bind
904 to multiple addresses/ports. (DEPRECATED: As of 0.2.3.x-alpha, you can
905 now use multiple SOCKSPort entries, and provide addresses for SOCKSPort
906 entries, so SOCKSListenAddress no longer has a purpose. For backward
907 compatibility, SOCKSListenAddress is only allowed when SOCKSPort is just
910 **SocksPolicy** __policy__,__policy__,__...__::
911 Set an entrance policy for this server, to limit who can connect to the
912 SocksPort and DNSPort ports. The policies have the same form as exit
915 **SocksTimeout** __NUM__::
916 Let a socks connection wait NUM seconds handshaking, and NUM seconds
917 unattached waiting for an appropriate circuit, before we fail it. (Default:
920 **TokenBucketRefillInterval** __NUM__ [**msec**|**second**]::
921 Set the refill interval of Tor's token bucket to NUM milliseconds.
922 NUM must be between 1 and 1000, inclusive. Note that the configured
923 bandwidth limits are still expressed in bytes per second: this
924 option only affects the frequency with which Tor checks to see whether
925 previously exhausted connections may read again. (Default: 100 msec)
927 **TrackHostExits** __host__,__.domain__,__...__::
928 For each value in the comma separated list, Tor will track recent
929 connections to hosts that match this value and attempt to reuse the same
930 exit node for each. If the value is prepended with a \'.\', it is treated as
931 matching an entire domain. If one of the values is just a \'.', it means
932 match everything. This option is useful if you frequently connect to sites
933 that will expire all your authentication cookies (i.e. log you out) if
934 your IP address changes. Note that this option does have the disadvantage
935 of making it more clear that a given history is associated with a single
936 user. However, most people who would wish to observe this will observe it
937 through cookies or other protocol-specific means anyhow.
939 **TrackHostExitsExpire** __NUM__::
940 Since exit servers go up and down, it is desirable to expire the
941 association between host and exit server after NUM seconds. The default is
942 1800 seconds (30 minutes).
944 **UpdateBridgesFromAuthority** **0**|**1**::
945 When set (along with UseBridges), Tor will try to fetch bridge descriptors
946 from the configured bridge authorities when feasible. It will fall back to
947 a direct request if the authority responds with a 404. (Default: 0)
949 **UseBridges** **0**|**1**::
950 When set, Tor will fetch descriptors for each bridge listed in the "Bridge"
951 config lines, and use these relays as both entry guards and directory
954 **UseEntryGuards** **0**|**1**::
955 If this option is set to 1, we pick a few long-term entry servers, and try
956 to stick with them. This is desirable because constantly changing servers
957 increases the odds that an adversary who owns some servers will observe a
958 fraction of your paths. (Default: 1)
960 **NumEntryGuards** __NUM__::
961 If UseEntryGuards is set to 1, we will try to pick a total of NUM routers
962 as long-term entries for our circuits. (Default: 3)
964 **SafeSocks** **0**|**1**::
965 When this option is enabled, Tor will reject application connections that
966 use unsafe variants of the socks protocol -- ones that only provide an IP
967 address, meaning the application is doing a DNS resolve first.
968 Specifically, these are socks4 and socks5 when not doing remote DNS.
971 **TestSocks** **0**|**1**::
972 When this option is enabled, Tor will make a notice-level log entry for
973 each connection to the Socks port indicating whether the request used a
974 safe socks protocol or an unsafe one (see above entry on SafeSocks). This
975 helps to determine whether an application using Tor is possibly leaking
976 DNS requests. (Default: 0)
978 **WarnUnsafeSocks** **0**|**1**::
979 When this option is enabled, Tor will warn whenever a request is
980 received that only contains an IP address instead of a hostname. Allowing
981 applications to do DNS resolves themselves is usually a bad idea and
982 can leak your location to attackers. (Default: 1)
984 **VirtualAddrNetwork** __Address__/__bits__::
985 When Tor needs to assign a virtual (unused) address because of a MAPADDRESS
986 command from the controller or the AutomapHostsOnResolve feature, Tor
987 picks an unassigned address from this range. (Default:
990 When providing proxy server service to a network of computers using a tool
991 like dns-proxy-tor, change this address to "10.192.0.0/10" or
992 "172.16.0.0/12". The default **VirtualAddrNetwork** address range on a
993 properly configured machine will route to the loopback interface. For
994 local use, no change to the default VirtualAddrNetwork setting is needed.
996 **AllowNonRFC953Hostnames** **0**|**1**::
997 When this option is disabled, Tor blocks hostnames containing illegal
998 characters (like @ and :) rather than sending them to an exit node to be
999 resolved. This helps trap accidental attempts to resolve URLs and so on.
1002 **AllowDotExit** **0**|**1**::
1003 If enabled, we convert "www.google.com.foo.exit" addresses on the
1004 SocksPort/TransPort/NATDPort into "www.google.com" addresses that exit from
1005 the node "foo". Disabled by default since attacking websites and exit
1006 relays can use it to manipulate your path selection. (Default: 0)
1008 **FastFirstHopPK** **0**|**1**::
1009 When this option is disabled, Tor uses the public key step for the first
1010 hop of creating circuits. Skipping it is generally safe since we have
1011 already used TLS to authenticate the relay and to establish forward-secure
1012 keys. Turning this option off makes circuit building slower. +
1014 Note that Tor will always use the public key step for the first hop if it's
1015 operating as a relay, and it will never use the public key step if it
1016 doesn't yet know the onion key of the first hop. (Default: 1)
1018 **TransPort** \['address':]__port__|**auto** [_isolation flags_]::
1019 Open this port to listen for transparent proxy connections. Set this to
1020 0 if you don't want to allow transparent proxy connections. Set the port
1021 to "auto" to have Tor pick a port for you. This directive can be
1022 specified multiple times to bind to multiple addresses/ports. See
1023 SOCKSPort for an explanation of isolation flags. +
1025 TransPort requires OS support for transparent proxies, such as BSDs' pf or
1026 Linux's IPTables. If you're planning to use Tor as a transparent proxy for
1027 a network, you'll want to examine and change VirtualAddrNetwork from the
1028 default setting. You'll also want to set the TransListenAddress option for
1029 the network you'd like to proxy. (Default: 0)
1031 **TransListenAddress** __IP__[:__PORT__]::
1032 Bind to this address to listen for transparent proxy connections. (Default:
1033 127.0.0.1). This is useful for exporting a transparent proxy server to an
1034 entire network. (DEPRECATED: As of 0.2.3.x-alpha, you can
1035 now use multiple TransPort entries, and provide addresses for TransPort
1036 entries, so TransListenAddress no longer has a purpose. For backward
1037 compatibility, TransListenAddress is only allowed when TransPort is just
1040 **NATDPort** \['address':]__port__|**auto** [_isolation flags_]::
1041 Open this port to listen for connections from old versions of ipfw (as
1042 included in old versions of FreeBSD, etc) using the NATD protocol.
1043 Use 0 if you don't want to allow NATD connections. Set the port
1044 to "auto" to have Tor pick a port for you. This directive can be
1045 specified multiple times to bind to multiple addresses/ports. See
1046 SOCKSPort for an explanation of isolation flags. +
1048 This option is only for people who cannot use TransPort. (Default: 0)
1050 **NATDListenAddress** __IP__[:__PORT__]::
1051 Bind to this address to listen for NATD connections. (DEPRECATED: As of
1052 0.2.3.x-alpha, you can now use multiple NATDPort entries, and provide
1053 addresses for NATDPort entries, so NATDListenAddress no longer has a
1054 purpose. For backward compatibility, NATDListenAddress is only allowed
1055 when NATDPort is just a port number.)
1057 **AutomapHostsOnResolve** **0**|**1**::
1058 When this option is enabled, and we get a request to resolve an address
1059 that ends with one of the suffixes in **AutomapHostsSuffixes**, we map an
1060 unused virtual address to that address, and return the new virtual address.
1061 This is handy for making ".onion" addresses work with applications that
1062 resolve an address and then connect to it. (Default: 0)
1064 **AutomapHostsSuffixes** __SUFFIX__,__SUFFIX__,__...__::
1065 A comma-separated list of suffixes to use with **AutomapHostsOnResolve**.
1066 The "." suffix is equivalent to "all addresses." (Default: .exit,.onion).
1068 **DNSPort** \['address':]__port__|**auto** [_isolation flags_]::
1069 If non-zero, open this port to listen for UDP DNS requests, and resolve
1070 them anonymously. Set the port to "auto" to have Tor pick a port for
1071 you. This directive can be specified multiple times to bind to multiple
1072 addresses/ports. See SOCKSPort for an explanation of isolation
1075 **DNSListenAddress** __IP__[:__PORT__]::
1076 Bind to this address to listen for DNS connections. (DEPRECATED: As of
1077 0.2.3.x-alpha, you can now use multiple DNSPort entries, and provide
1078 addresses for DNSPort entries, so DNSListenAddress no longer has a
1079 purpose. For backward compatibility, DNSListenAddress is only allowed
1080 when DNSPort is just a port number.)
1082 **ClientDNSRejectInternalAddresses** **0**|**1**::
1083 If true, Tor does not believe any anonymously retrieved DNS answer that
1084 tells it that an address resolves to an internal address (like 127.0.0.1 or
1085 192.168.0.1). This option prevents certain browser-based attacks; don't
1086 turn it off unless you know what you're doing. (Default: 1)
1088 **ClientRejectInternalAddresses** **0**|**1**::
1089 If true, Tor does not try to fulfill requests to connect to an internal
1090 address (like 127.0.0.1 or 192.168.0.1) __unless a exit node is
1091 specifically requested__ (for example, via a .exit hostname, or a
1092 controller request). (Default: 1)
1094 **DownloadExtraInfo** **0**|**1**::
1095 If true, Tor downloads and caches "extra-info" documents. These documents
1096 contain information about servers other than the information in their
1097 regular router descriptors. Tor does not use this information for anything
1098 itself; to save bandwidth, leave this option turned off. (Default: 0)
1100 **FallbackNetworkstatusFile** __FILENAME__::
1101 If Tor doesn't have a cached networkstatus file, it starts out using this
1102 one instead. Even if this file is out of date, Tor can still use it to
1103 learn about directory mirrors, so it doesn't need to put load on the
1104 authorities. (Default: None)
1106 **WarnPlaintextPorts** __port__,__port__,__...__::
1107 Tells Tor to issue a warnings whenever the user tries to make an anonymous
1108 connection to one of these ports. This option is designed to alert users
1109 to services that risk sending passwords in the clear. (Default:
1112 **RejectPlaintextPorts** __port__,__port__,__...__::
1113 Like WarnPlaintextPorts, but instead of warning about risky port uses, Tor
1114 will instead refuse to make the connection. (Default: None)
1116 **AllowSingleHopCircuits** **0**|**1**::
1117 When this option is set, the attached Tor controller can use relays
1118 that have the **AllowSingleHopExits** option turned on to build
1119 one-hop Tor connections. (Default: 0)
1121 **OptimisticData** **0**|**1**|**auto**::
1122 When this option is set, and Tor is using an exit node that supports
1123 the feature, it will try optimistically to send data to the exit node
1124 without waiting for the exit node to report whether the connection
1125 succeeded. This can save a round-trip time for protocols like HTTP
1126 where the client talks first. If OptimisticData is set to **auto**,
1127 Tor will look at the UseOptimisticData parameter in the networkstatus.
1130 **Tor2webMode** **0**|**1**::
1131 When this option is set, Tor connects to hidden services
1132 **non-anonymously**. This option also disables client connections to
1133 non-hidden-service hostnames through Tor. It **must only** be used when
1134 running a tor2web Hidden Service web proxy.
1135 To enable this option the compile time flag --enable-tor2webmode must be
1136 specified. (Default: 0)
1138 **UseMicrodescriptors** **0**|**1**|**auto**::
1139 Microdescriptors are a smaller version of the information that Tor needs
1140 in order to build its circuits. Using microdescriptors makes Tor clients
1141 download less directory information, thus saving bandwidth. Directory
1142 caches need to fetch regular descriptors and microdescriptors, so this
1143 option doesn't save any bandwidth for them. If this option is set to
1144 "auto" (recommended) then it is on for all clients that do not set
1145 FetchUselessDescriptors. (Default: auto)
1147 **PathBiasCircThreshold** __NUM__ +
1149 **PathBiasNoticeRate** __NUM__ +
1151 **PathBiasDisableRate** __NUM__ +
1153 **PathBiasScaleThreshold** __NUM__ +
1155 **PathBiasScaleFactor** __NUM__::
1156 These options override the default behavior of Tor's (**currently
1157 experimental**) path bias detection algorithm. To try to find broken or
1158 misbehaving guard nodes, Tor looks for nodes where more than a certain
1159 fraction of circuits through that node fail after the first hop. The
1160 PathBiasCircThreshold option controls how many circuits we need to build
1161 through a guard before we make these checks. The PathBiasNoticeRate and
1162 PathBiasDisableRate options control what fraction of circuits must
1163 succeed through a guard so we won't warn about it or disable it,
1164 respectively. When we have seen more than PathBiasScaleThreshold
1165 circuits through a guard, we divide our observations by
1166 PathBiasScaleFactor, so that new observations don't get swamped by old
1169 By default, or if a negative value is provided for one of these options,
1170 Tor uses reasonable defaults from the networkstatus consensus document.
1171 If no defaults are available there, these options default to 20, .70,
1172 0.0, 200, and 4 respectively.
1174 **ClientUseIPv6** **0**|**1**::
1175 If this option is set to 1, Tor might connect to entry nodes over
1176 IPv6. Note that clients configured with an IPv6 address in a
1177 **Bridge** line will try connecting over IPv6 even if
1178 **ClientUseIPv6** is set to 0. (Default: 0)
1180 **ClientPreferIPv6ORPort** **0**|**1**::
1181 If this option is set to 1, Tor prefers an OR port with an IPv6
1182 address over one with IPv4 if a given entry node has both. Other
1183 things may influence the choice. This option breaks a tie to the
1184 favor of IPv6. (Default: 0)
1190 The following options are useful only for servers (that is, if ORPort
1193 **Address** __address__::
1194 The IP address or fully qualified domain name of this server (e.g.
1195 moria.mit.edu). You can leave this unset, and Tor will guess your IP
1196 address. This IP address is the one used to tell clients and other
1197 servers where to find your Tor server; it doesn't affect the IP that your
1198 Tor client binds to. To bind to a different address, use the
1199 *ListenAddress and OutboundBindAddress options.
1201 **AllowSingleHopExits** **0**|**1**::
1202 This option controls whether clients can use this server as a single hop
1203 proxy. If set to 1, clients can use this server as an exit even if it is
1204 the only hop in the circuit. Note that most clients will refuse to use
1205 servers that set this option, since most clients have
1206 ExcludeSingleHopRelays set. (Default: 0)
1208 **AssumeReachable** **0**|**1**::
1209 This option is used when bootstrapping a new Tor network. If set to 1,
1210 don't do self-reachability testing; just upload your server descriptor
1211 immediately. If **AuthoritativeDirectory** is also set, this option
1212 instructs the dirserver to bypass remote reachability testing too and list
1213 all connected servers as running.
1215 **BridgeRelay** **0**|**1**::
1216 Sets the relay to act as a "bridge" with respect to relaying connections
1217 from bridge users to the Tor network. It mainly causes Tor to publish a
1218 server descriptor to the bridge database, rather than publishing a relay
1219 descriptor to the public directory authorities.
1221 **ContactInfo** __email_address__::
1222 Administrative contact information for server. This line might get picked
1223 up by spam harvesters, so you may want to obscure the fact that it's an
1226 **ExitPolicy** __policy__,__policy__,__...__::
1227 Set an exit policy for this server. Each policy is of the form
1228 "**accept**|**reject** __ADDR__[/__MASK__][:__PORT__]". If /__MASK__ is
1229 omitted then this policy just applies to the host given. Instead of giving
1230 a host or network you can also use "\*" to denote the universe (0.0.0.0/0).
1231 __PORT__ can be a single port number, an interval of ports
1232 "__FROM_PORT__-__TO_PORT__", or "\*". If __PORT__ is omitted, that means
1235 For example, "accept 18.7.22.69:\*,reject 18.0.0.0/8:\*,accept \*:\*" would
1236 reject any traffic destined for MIT except for web.mit.edu, and accept
1239 To specify all internal and link-local networks (including 0.0.0.0/8,
1240 169.254.0.0/16, 127.0.0.0/8, 192.168.0.0/16, 10.0.0.0/8, and
1241 172.16.0.0/12), you can use the "private" alias instead of an address.
1242 These addresses are rejected by default (at the beginning of your exit
1243 policy), along with your public IP address, unless you set the
1244 ExitPolicyRejectPrivate config option to 0. For example, once you've done
1245 that, you could allow HTTP to 127.0.0.1 and block all other connections to
1246 internal networks with "accept 127.0.0.1:80,reject private:\*", though that
1247 may also allow connections to your own computer that are addressed to its
1248 public (external) IP address. See RFC 1918 and RFC 3330 for more details
1249 about internal and reserved IP address space. +
1251 This directive can be specified multiple times so you don't have to put it
1254 Policies are considered first to last, and the first match wins. If you
1255 want to \_replace_ the default exit policy, end your exit policy with
1256 either a reject \*:* or an accept \*:*. Otherwise, you're \_augmenting_
1257 (prepending to) the default exit policy. The default exit policy is: +
1271 **ExitPolicyRejectPrivate** **0**|**1**::
1272 Reject all private (local) networks, along with your own public IP address,
1273 at the beginning of your exit policy. See above entry on ExitPolicy.
1276 **MaxOnionsPending** __NUM__::
1277 If you have more than this number of onionskins queued for decrypt, reject
1278 new ones. (Default: 100)
1280 **MyFamily** __node__,__node__,__...__::
1281 Declare that this Tor server is controlled or administered by a group or
1282 organization identical or similar to that of the other servers, defined by
1283 their identity fingerprints or nicknames. When two servers both declare
1284 that they are in the same \'family', Tor clients will not use them in the
1285 same circuit. (Each server only needs to list the other servers in its
1286 family; it doesn't need to list itself, but it won't hurt.) Do not list
1287 any bridge relay as it would compromise its concealment.
1289 **Nickname** __name__::
1290 Set the server's nickname to \'name'. Nicknames must be between 1 and 19
1291 characters inclusive, and must contain only the characters [a-zA-Z0-9].
1293 **NumCPUs** __num__::
1294 How many processes to use at once for decrypting onionskins and other
1295 parallelizable operations. If this is set to 0, Tor will try to detect
1296 how many CPUs you have, defaulting to 1 if it can't tell. (Default: 0)
1298 **ORPort** \['address':]__PORT__|**auto** [_flags_]::
1299 Advertise this port to listen for connections from Tor clients and
1300 servers. This option is required to be a Tor server.
1301 Set it to "auto" to have Tor pick a port for you. Set it to 0 to not
1302 run an ORPort at all. This option can occur more than once. (Default: 0)
1304 Tor recognizes these flags on each ORPort:
1306 By default, we bind to a port and tell our users about it. If
1307 NoAdvertise is specified, we don't advertise, but listen anyway. This
1308 can be useful if the port everybody will be connecting to (for
1309 example, one that's opened on our firewall) is somewhere else.
1311 By default, we bind to a port and tell our users about it. If
1312 NoListen is specified, we don't bind, but advertise anyway. This
1313 can be useful if something else (for example, a firewall's port
1314 forwarding configuration) is causing connections to reach us.
1316 If the address is absent, or resolves to both an IPv4 and an IPv6
1317 address, only listen to the IPv4 address.
1319 If the address is absent, or resolves to both an IPv4 and an IPv6
1320 address, only listen to the IPv6 address.
1322 For obvious reasons, NoAdvertise and NoListen are mutually exclusive, and
1323 IPv4Only and IPv6Only are mutually exclusive.
1325 **ORListenAddress** __IP__[:__PORT__]::
1326 Bind to this IP address to listen for connections from Tor clients and
1327 servers. If you specify a port, bind to this port rather than the one
1328 specified in ORPort. (Default: 0.0.0.0) This directive can be specified
1329 multiple times to bind to multiple addresses/ports.
1331 This option is deprecated; you can get the same behavior with ORPort now
1332 that it supports NoAdvertise and explicit addresses.
1334 **PortForwarding** **0**|**1**::
1335 Attempt to automatically forward the DirPort and ORPort on a NAT router
1336 connecting this Tor server to the Internet. If set, Tor will try both
1337 NAT-PMP (common on Apple routers) and UPnP (common on routers from other
1338 manufacturers). (Default: 0)
1340 **PortForwardingHelper** __filename__|__pathname__::
1341 If PortForwarding is set, use this executable to configure the forwarding.
1342 If set to a filename, the system path will be searched for the executable.
1343 If set to a path, only the specified path will be executed.
1344 (Default: tor-fw-helper)
1346 **PublishServerDescriptor** **0**|**1**|**v1**|**v2**|**v3**|**bridge**,**...**::
1347 This option specifies which descriptors Tor will publish when acting as
1349 choose multiple arguments, separated by commas.
1351 If this option is set to 0, Tor will not publish its
1352 descriptors to any directories. (This is useful if you're testing
1353 out your server, or if you're using a Tor controller that handles directory
1354 publishing for you.) Otherwise, Tor will publish its descriptors of all
1355 type(s) specified. The default is "1",
1356 which means "if running as a server, publish the
1357 appropriate descriptors to the authorities".
1359 **ShutdownWaitLength** __NUM__::
1360 When we get a SIGINT and we're a server, we begin shutting down:
1361 we close listeners and start refusing new circuits. After **NUM**
1362 seconds, we exit. If we get a second SIGINT, we exit immedi-
1363 ately. (Default: 30 seconds)
1365 **HeartbeatPeriod** __N__ **minutes**|**hours**|**days**|**weeks**::
1366 Log a heartbeat message every **HeartbeatPeriod** seconds. This is
1367 a log level __info__ message, designed to let you know your Tor
1368 server is still alive and doing useful things. Settings this
1369 to 0 will disable the heartbeat. (Default: 6 hours)
1371 **AccountingMax** __N__ **bytes**|**KB**|**MB**|**GB**|**TB**::
1372 Never send more than the specified number of bytes in a given accounting
1373 period, or receive more than that number in the period. For example, with
1374 AccountingMax set to 1 GB, a server could send 900 MB and receive 800 MB
1375 and continue running. It will only hibernate once one of the two reaches 1
1376 GB. When the number of bytes gets low, Tor will stop accepting new
1377 connections and circuits. When the number of bytes
1378 is exhausted, Tor will hibernate until some
1379 time in the next accounting period. To prevent all servers from waking at
1380 the same time, Tor will also wait until a random point in each period
1381 before waking up. If you have bandwidth cost issues, enabling hibernation
1382 is preferable to setting a low bandwidth, since it provides users with a
1383 collection of fast servers that are up some of the time, which is more
1384 useful than a set of slow servers that are always "available".
1386 **AccountingStart** **day**|**week**|**month** [__day__] __HH:MM__::
1387 Specify how long accounting periods last. If **month** is given, each
1388 accounting period runs from the time __HH:MM__ on the __dayth__ day of one
1389 month to the same day and time of the next. (The day must be between 1 and
1390 28.) If **week** is given, each accounting period runs from the time __HH:MM__
1391 of the __dayth__ day of one week to the same day and time of the next week,
1392 with Monday as day 1 and Sunday as day 7. If **day** is given, each
1393 accounting period runs from the time __HH:MM__ each day to the same time on
1394 the next day. All times are local, and given in 24-hour time. (Default:
1397 **RefuseUnknownExits** **0**|**1**|**auto**::
1398 Prevent nodes that don't appear in the consensus from exiting using this
1399 relay. If the option is 1, we always block exit attempts from such
1400 nodes; if it's 0, we never do, and if the option is "auto", then we do
1401 whatever the authorities suggest in the consensus. (Default: auto)
1403 **ServerDNSResolvConfFile** __filename__::
1404 Overrides the default DNS configuration with the configuration in
1405 __filename__. The file format is the same as the standard Unix
1406 "**resolv.conf**" file (7). This option, like all other ServerDNS options,
1407 only affects name lookups that your server does on behalf of clients.
1408 (Defaults to use the system DNS configuration.)
1410 **ServerDNSAllowBrokenConfig** **0**|**1**::
1411 If this option is false, Tor exits immediately if there are problems
1412 parsing the system DNS configuration or connecting to nameservers.
1413 Otherwise, Tor continues to periodically retry the system nameservers until
1414 it eventually succeeds. (Default: 1)
1416 **ServerDNSSearchDomains** **0**|**1**::
1417 If set to 1, then we will search for addresses in the local search domain.
1418 For example, if this system is configured to believe it is in
1419 "example.com", and a client tries to connect to "www", the client will be
1420 connected to "www.example.com". This option only affects name lookups that
1421 your server does on behalf of clients. (Default: 0)
1423 **ServerDNSDetectHijacking** **0**|**1**::
1424 When this option is set to 1, we will test periodically to determine
1425 whether our local nameservers have been configured to hijack failing DNS
1426 requests (usually to an advertising site). If they are, we will attempt to
1427 correct this. This option only affects name lookups that your server does
1428 on behalf of clients. (Default: 1)
1430 **ServerDNSTestAddresses** __address__,__address__,__...__::
1431 When we're detecting DNS hijacking, make sure that these __valid__ addresses
1432 aren't getting redirected. If they are, then our DNS is completely useless,
1433 and we'll reset our exit policy to "reject *:*". This option only affects
1434 name lookups that your server does on behalf of clients. (Default:
1435 "www.google.com, www.mit.edu, www.yahoo.com, www.slashdot.org")
1437 **ServerDNSAllowNonRFC953Hostnames** **0**|**1**::
1438 When this option is disabled, Tor does not try to resolve hostnames
1439 containing illegal characters (like @ and :) rather than sending them to an
1440 exit node to be resolved. This helps trap accidental attempts to resolve
1441 URLs and so on. This option only affects name lookups that your server does
1442 on behalf of clients. (Default: 0)
1444 **BridgeRecordUsageByCountry** **0**|**1**::
1445 When this option is enabled and BridgeRelay is also enabled, and we have
1446 GeoIP data, Tor keeps a keep a per-country count of how many client
1447 addresses have contacted it so that it can help the bridge authority guess
1448 which countries have blocked access to it. (Default: 1)
1450 **ServerDNSRandomizeCase** **0**|**1**::
1451 When this option is set, Tor sets the case of each character randomly in
1452 outgoing DNS requests, and makes sure that the case matches in DNS replies.
1453 This so-called "0x20 hack" helps resist some types of DNS poisoning attack.
1454 For more information, see "Increased DNS Forgery Resistance through
1455 0x20-Bit Encoding". This option only affects name lookups that your server
1456 does on behalf of clients. (Default: 1)
1458 **GeoIPFile** __filename__::
1459 A filename containing GeoIP data, for use with BridgeRecordUsageByCountry.
1461 **CellStatistics** **0**|**1**::
1462 When this option is enabled, Tor writes statistics on the mean time that
1463 cells spend in circuit queues to disk every 24 hours. (Default: 0)
1465 **DirReqStatistics** **0**|**1**::
1466 When this option is enabled, a Tor directory writes statistics on the
1467 number and response time of network status requests to disk every 24
1470 **EntryStatistics** **0**|**1**::
1471 When this option is enabled, Tor writes statistics on the number of
1472 directly connecting clients to disk every 24 hours. (Default: 0)
1474 **ExitPortStatistics** **0**|**1**::
1475 When this option is enabled, Tor writes statistics on the number of relayed
1476 bytes and opened stream per exit port to disk every 24 hours. (Default: 0)
1478 **ConnDirectionStatistics** **0**|**1**::
1479 When this option is enabled, Tor writes statistics on the bidirectional use
1480 of connections to disk every 24 hours. (Default: 0)
1482 **ExtraInfoStatistics** **0**|**1**::
1483 When this option is enabled, Tor includes previously gathered statistics in
1484 its extra-info documents that it uploads to the directory authorities.
1487 **ExtendAllowPrivateAddresses** **0**|**1**::
1488 When this option is enabled, Tor routers allow EXTEND request to
1489 localhost, RFC1918 addresses, and so on. This can create security issues;
1490 you should probably leave it off. (Default: 0)
1492 DIRECTORY SERVER OPTIONS
1493 ------------------------
1495 The following options are useful only for directory servers (that is,
1496 if DirPort is non-zero):
1498 **AuthoritativeDirectory** **0**|**1**::
1499 When this option is set to 1, Tor operates as an authoritative directory
1500 server. Instead of caching the directory, it generates its own list of
1501 good servers, signs it, and sends that to the clients. Unless the clients
1502 already have you listed as a trusted directory, you probably do not want
1503 to set this option. Please coordinate with the other admins at
1504 tor-ops@torproject.org if you think you should be a directory.
1506 **DirPortFrontPage** __FILENAME__::
1507 When this option is set, it takes an HTML file and publishes it as "/" on
1508 the DirPort. Now relay operators can provide a disclaimer without needing
1509 to set up a separate webserver. There's a sample disclaimer in
1510 contrib/tor-exit-notice.html.
1512 **V1AuthoritativeDirectory** **0**|**1**::
1513 When this option is set in addition to **AuthoritativeDirectory**, Tor
1514 generates version 1 directory and running-routers documents (for legacy
1515 Tor clients up to 0.1.0.x).
1517 **V2AuthoritativeDirectory** **0**|**1**::
1518 When this option is set in addition to **AuthoritativeDirectory**, Tor
1519 generates version 2 network statuses and serves descriptors, etc as
1520 described in doc/spec/dir-spec-v2.txt (for Tor clients and servers running
1521 0.1.1.x and 0.1.2.x).
1523 **V3AuthoritativeDirectory** **0**|**1**::
1524 When this option is set in addition to **AuthoritativeDirectory**, Tor
1525 generates version 3 network statuses and serves descriptors, etc as
1526 described in doc/spec/dir-spec.txt (for Tor clients and servers running at
1529 **VersioningAuthoritativeDirectory** **0**|**1**::
1530 When this option is set to 1, Tor adds information on which versions of
1531 Tor are still believed safe for use to the published directory. Each
1532 version 1 authority is automatically a versioning authority; version 2
1533 authorities provide this service optionally. See **RecommendedVersions**,
1534 **RecommendedClientVersions**, and **RecommendedServerVersions**.
1536 **NamingAuthoritativeDirectory** **0**|**1**::
1537 When this option is set to 1, then the server advertises that it has
1538 opinions about nickname-to-fingerprint bindings. It will include these
1539 opinions in its published network-status pages, by listing servers with
1540 the flag "Named" if a correct binding between that nickname and fingerprint
1541 has been registered with the dirserver. Naming dirservers will refuse to
1542 accept or publish descriptors that contradict a registered binding. See
1543 **approved-routers** in the **FILES** section below.
1545 **HSAuthoritativeDir** **0**|**1**::
1546 When this option is set in addition to **AuthoritativeDirectory**, Tor also
1547 accepts and serves v0 hidden service descriptors,
1548 which are produced and used by Tor 0.2.1.x and older. (Default: 0)
1550 **HidServDirectoryV2** **0**|**1**::
1551 When this option is set, Tor accepts and serves v2 hidden service
1552 descriptors. Setting DirPort is not required for this, because clients
1553 connect via the ORPort by default. (Default: 1)
1555 **BridgeAuthoritativeDir** **0**|**1**::
1556 When this option is set in addition to **AuthoritativeDirectory**, Tor
1557 accepts and serves router descriptors, but it caches and serves the main
1558 networkstatus documents rather than generating its own. (Default: 0)
1560 **MinUptimeHidServDirectoryV2** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
1561 Minimum uptime of a v2 hidden service directory to be accepted as such by
1562 authoritative directories. (Default: 25 hours)
1564 **DirPort** \['address':]__PORT__|**auto** [_flags_]::
1565 If this option is nonzero, advertise the directory service on this port.
1566 Set it to "auto" to have Tor pick a port for you. This option can occur
1567 more than once. (Default: 0)
1569 The same flags are supported here as are supported by ORPort.
1571 **DirListenAddress** __IP__[:__PORT__]::
1572 Bind the directory service to this address. If you specify a port, bind to
1573 this port rather than the one specified in DirPort. (Default: 0.0.0.0)
1574 This directive can be specified multiple times to bind to multiple
1577 This option is deprecated; you can get the same behavior with DirPort now
1578 that it supports NoAdvertise and explicit addresses.
1580 **DirPolicy** __policy__,__policy__,__...__::
1581 Set an entrance policy for this server, to limit who can connect to the
1582 directory ports. The policies have the same form as exit policies above.
1584 **FetchV2Networkstatus** **0**|**1**::
1585 If set, we try to fetch the (obsolete, unused) version 2 network status
1586 consensus documents from the directory authorities. No currently
1587 supported Tor version uses them. (Default: 0)
1590 DIRECTORY AUTHORITY SERVER OPTIONS
1591 ----------------------------------
1593 **RecommendedVersions** __STRING__::
1594 STRING is a comma-separated list of Tor versions currently believed to be
1595 safe. The list is included in each directory, and nodes which pull down the
1596 directory learn whether they need to upgrade. This option can appear
1597 multiple times: the values from multiple lines are spliced together. When
1598 this is set then **VersioningAuthoritativeDirectory** should be set too.
1600 **RecommendedClientVersions** __STRING__::
1601 STRING is a comma-separated list of Tor versions currently believed to be
1602 safe for clients to use. This information is included in version 2
1603 directories. If this is not set then the value of **RecommendedVersions**
1604 is used. When this is set then **VersioningAuthoritativeDirectory** should
1607 **RecommendedServerVersions** __STRING__::
1608 STRING is a comma-separated list of Tor versions currently believed to be
1609 safe for servers to use. This information is included in version 2
1610 directories. If this is not set then the value of **RecommendedVersions**
1611 is used. When this is set then **VersioningAuthoritativeDirectory** should
1614 **ConsensusParams** __STRING__::
1615 STRING is a space-separated list of key=value pairs that Tor will include
1616 in the "params" line of its networkstatus vote.
1618 **DirAllowPrivateAddresses** **0**|**1**::
1619 If set to 1, Tor will accept router descriptors with arbitrary "Address"
1620 elements. Otherwise, if the address is not an IP address or is a private IP
1621 address, it will reject the router descriptor. (Default: 0)
1623 **AuthDirBadDir** __AddressPattern...__::
1624 Authoritative directories only. A set of address patterns for servers that
1625 will be listed as bad directories in any network status document this
1626 authority publishes, if **AuthDirListBadDirs** is set.
1628 **AuthDirBadExit** __AddressPattern...__::
1629 Authoritative directories only. A set of address patterns for servers that
1630 will be listed as bad exits in any network status document this authority
1631 publishes, if **AuthDirListBadExits** is set.
1633 **AuthDirInvalid** __AddressPattern...__::
1634 Authoritative directories only. A set of address patterns for servers that
1635 will never be listed as "valid" in any network status document that this
1636 authority publishes.
1638 **AuthDirReject** __AddressPattern__...::
1639 Authoritative directories only. A set of address patterns for servers that
1640 will never be listed at all in any network status document that this
1641 authority publishes, or accepted as an OR address in any descriptor
1642 submitted for publication by this authority.
1644 **AuthDirBadDirCCs** __CC__,... +
1646 **AuthDirBadExitCCs** __CC__,... +
1648 **AuthDirInvalidCCs** __CC__,... +
1650 **AuthDirRejectCCs** __CC__,...::
1651 Authoritative directories only. These options contain a comma-separated
1652 list of country codes such that any server in one of those country codes
1653 will be marked as a bad directory/bad exit/invalid for use, or rejected
1656 **AuthDirListBadDirs** **0**|**1**::
1657 Authoritative directories only. If set to 1, this directory has some
1658 opinion about which nodes are unsuitable as directory caches. (Do not set
1659 this to 1 unless you plan to list non-functioning directories as bad;
1660 otherwise, you are effectively voting in favor of every declared
1663 **AuthDirListBadExits** **0**|**1**::
1664 Authoritative directories only. If set to 1, this directory has some
1665 opinion about which nodes are unsuitable as exit nodes. (Do not set this to
1666 1 unless you plan to list non-functioning exits as bad; otherwise, you are
1667 effectively voting in favor of every declared exit as an exit.)
1669 **AuthDirRejectUnlisted** **0**|**1**::
1670 Authoritative directories only. If set to 1, the directory server rejects
1671 all uploaded server descriptors that aren't explicitly listed in the
1672 fingerprints file. This acts as a "panic button" if we get hit with a Sybil
1673 attack. (Default: 0)
1675 **AuthDirMaxServersPerAddr** __NUM__::
1676 Authoritative directories only. The maximum number of servers that we will
1677 list as acceptable on a single IP address. Set this to "0" for "no limit".
1680 **AuthDirMaxServersPerAuthAddr** __NUM__::
1681 Authoritative directories only. Like AuthDirMaxServersPerAddr, but applies
1682 to addresses shared with directory authorities. (Default: 5)
1684 **AuthDirFastGuarantee** __N__ **bytes**|**KB**|**MB**|**GB**::
1685 Authoritative directories only. If non-zero, always vote the
1686 Fast flag for any relay advertising this amount of capacity or
1687 more. (Default: 100 KB)
1689 **AuthDirGuardBWGuarantee** __N__ **bytes**|**KB**|**MB**|**GB**::
1690 Authoritative directories only. If non-zero, this advertised capacity
1691 or more is always sufficient to satisfy the bandwidth requirement
1692 for the Guard flag. (Default: 250 KB)
1694 **BridgePassword** __Password__::
1695 If set, contains an HTTP authenticator that tells a bridge authority to
1696 serve all requested bridge information. Used by the (only partially
1697 implemented) "bridge community" design, where a community of bridge
1698 relay operators all use an alternate bridge directory authority,
1699 and their target user audience can periodically fetch the list of
1700 available community bridges to stay up-to-date. (Default: not set)
1702 **V3AuthVotingInterval** __N__ **minutes**|**hours**::
1703 V3 authoritative directories only. Configures the server's preferred voting
1704 interval. Note that voting will __actually__ happen at an interval chosen
1705 by consensus from all the authorities' preferred intervals. This time
1706 SHOULD divide evenly into a day. (Default: 1 hour)
1708 **V3AuthVoteDelay** __N__ **minutes**|**hours**::
1709 V3 authoritative directories only. Configures the server's preferred delay
1710 between publishing its vote and assuming it has all the votes from all the
1711 other authorities. Note that the actual time used is not the server's
1712 preferred time, but the consensus of all preferences. (Default: 5 minutes)
1714 **V3AuthDistDelay** __N__ **minutes**|**hours**::
1715 V3 authoritative directories only. Configures the server's preferred delay
1716 between publishing its consensus and signature and assuming it has all the
1717 signatures from all the other authorities. Note that the actual time used
1718 is not the server's preferred time, but the consensus of all preferences.
1719 (Default: 5 minutes)
1721 **V3AuthNIntervalsValid** __NUM__::
1722 V3 authoritative directories only. Configures the number of VotingIntervals
1723 for which each consensus should be valid for. Choosing high numbers
1724 increases network partitioning risks; choosing low numbers increases
1725 directory traffic. Note that the actual number of intervals used is not the
1726 server's preferred number, but the consensus of all preferences. Must be at
1727 least 2. (Default: 3)
1729 **V3BandwidthsFile** __FILENAME__::
1730 V3 authoritative directories only. Configures the location of the
1731 bandwidth-authority generated file storing information on relays' measured
1732 bandwidth capacities. (Default: unset)
1734 **V3AuthUseLegacyKey** **0**|**1**::
1735 If set, the directory authority will sign consensuses not only with its
1736 own signing key, but also with a "legacy" key and certificate with a
1737 different identity. This feature is used to migrate directory authority
1738 keys in the event of a compromise. (Default: 0)
1740 **RephistTrackTime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
1741 Tells an authority, or other node tracking node reliability and history,
1742 that fine-grained information about nodes can be discarded when it hasn't
1743 changed for a given amount of time. (Default: 24 hours)
1745 **VoteOnHidServDirectoriesV2** **0**|**1**::
1746 When this option is set in addition to **AuthoritativeDirectory**, Tor
1747 votes on whether to accept relays as hidden service directories.
1750 **AuthDirHasIPv6Connectivity** **0**|**1**::
1751 Authoritative directories only. When set to 0, OR ports with an
1752 IPv6 address are being accepted without reachability testing.
1753 When set to 1, IPv6 OR ports are being tested just like IPv4 OR
1756 HIDDEN SERVICE OPTIONS
1757 ----------------------
1759 The following options are used to configure a hidden service.
1761 **HiddenServiceDir** __DIRECTORY__::
1762 Store data files for a hidden service in DIRECTORY. Every hidden service
1763 must have a separate directory. You may use this option multiple times to
1764 specify multiple services. DIRECTORY must be an existing directory.
1766 **HiddenServicePort** __VIRTPORT__ [__TARGET__]::
1767 Configure a virtual port VIRTPORT for a hidden service. You may use this
1768 option multiple times; each time applies to the service using the most
1769 recent hiddenservicedir. By default, this option maps the virtual port to
1770 the same port on 127.0.0.1. You may override the target port, address, or
1771 both by specifying a target of addr, port, or addr:port. You may also have
1772 multiple lines with the same VIRTPORT: when a user connects to that
1773 VIRTPORT, one of the TARGETs from those lines will be chosen at random.
1775 **PublishHidServDescriptors** **0**|**1**::
1776 If set to 0, Tor will run any hidden services you configure, but it won't
1777 advertise them to the rendezvous directory. This option is only useful if
1778 you're using a Tor controller that handles hidserv publishing for you.
1781 **HiddenServiceVersion** __version__,__version__,__...__::
1782 A list of rendezvous service descriptor versions to publish for the hidden
1783 service. Currently, only version 2 is supported. (Default: 2)
1785 **HiddenServiceAuthorizeClient** __auth-type__ __client-name__,__client-name__,__...__::
1786 If configured, the hidden service is accessible for authorized clients
1787 only. The auth-type can either be \'basic' for a general-purpose
1788 authorization protocol or \'stealth' for a less scalable protocol that also
1789 hides service activity from unauthorized clients. Only clients that are
1790 listed here are authorized to access the hidden service. Valid client names
1791 are 1 to 19 characters long and only use characters in A-Za-z0-9+-_ (no
1792 spaces). If this option is set, the hidden service is not accessible for
1793 clients without authorization any more. Generated authorization data can be
1794 found in the hostname file. Clients need to put this authorization data in
1795 their configuration file using **HidServAuth**.
1797 **RendPostPeriod** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
1798 Every time the specified period elapses, Tor uploads any rendezvous
1799 service descriptors to the directory servers. This information is also
1800 uploaded whenever it changes. (Default: 1 hour)
1802 TESTING NETWORK OPTIONS
1803 -----------------------
1805 The following options are used for running a testing Tor network.
1807 **TestingTorNetwork** **0**|**1**::
1808 If set to 1, Tor adjusts default values of the configuration options below,
1809 so that it is easier to set up a testing Tor network. May only be set if
1810 non-default set of DirServers is set. Cannot be unset while Tor is running.
1813 ServerDNSAllowBrokenConfig 1
1814 DirAllowPrivateAddresses 1
1815 EnforceDistinctSubnets 0
1817 AuthDirMaxServersPerAddr 0
1818 AuthDirMaxServersPerAuthAddr 0
1819 ClientDNSRejectInternalAddresses 0
1820 ClientRejectInternalAddresses 0
1821 CountPrivateBandwidth 1
1822 ExitPolicyRejectPrivate 0
1823 ExtendAllowPrivateAddresses 1
1824 V3AuthVotingInterval 5 minutes
1825 V3AuthVoteDelay 20 seconds
1826 V3AuthDistDelay 20 seconds
1827 MinUptimeHidServDirectoryV2 0 seconds
1828 TestingV3AuthInitialVotingInterval 5 minutes
1829 TestingV3AuthInitialVoteDelay 20 seconds
1830 TestingV3AuthInitialDistDelay 20 seconds
1831 TestingAuthDirTimeToLearnReachability 0 minutes
1832 TestingEstimatedDescriptorPropagationTime 0 minutes
1834 **TestingV3AuthInitialVotingInterval** __N__ **minutes**|**hours**::
1835 Like V3AuthVotingInterval, but for initial voting interval before the first
1836 consensus has been created. Changing this requires that
1837 **TestingTorNetwork** is set. (Default: 30 minutes)
1839 **TestingV3AuthInitialVoteDelay** __N__ **minutes**|**hours**::
1840 Like TestingV3AuthInitialVoteDelay, but for initial voting interval before
1841 the first consensus has been created. Changing this requires that
1842 **TestingTorNetwork** is set. (Default: 5 minutes)
1844 **TestingV3AuthInitialDistDelay** __N__ **minutes**|**hours**::
1845 Like TestingV3AuthInitialDistDelay, but for initial voting interval before
1846 the first consensus has been created. Changing this requires that
1847 **TestingTorNetwork** is set. (Default: 5 minutes)
1849 **TestingAuthDirTimeToLearnReachability** __N__ **minutes**|**hours**::
1850 After starting as an authority, do not make claims about whether routers
1851 are Running until this much time has passed. Changing this requires
1852 that **TestingTorNetwork** is set. (Default: 30 minutes)
1854 **TestingEstimatedDescriptorPropagationTime** __N__ **minutes**|**hours**::
1855 Clients try downloading router descriptors from directory caches after this
1856 time. Changing this requires that **TestingTorNetwork** is set. (Default:
1862 Tor catches the following signals:
1865 Tor will catch this, clean up and sync to disk if necessary, and exit.
1868 Tor clients behave as with SIGTERM; but Tor servers will do a controlled
1869 slow shutdown, closing listeners and waiting 30 seconds before exiting.
1870 (The delay can be configured with the ShutdownWaitLength config option.)
1873 The signal instructs Tor to reload its configuration (including closing and
1874 reopening logs), and kill and restart its helper processes if applicable.
1877 Log statistics about current connections, past connections, and throughput.
1880 Switch all logs to loglevel debug. You can go back to the old loglevels by
1884 Tor receives this signal when one of its helper processes has exited, so it
1888 Tor catches this signal and ignores it.
1891 If this signal exists on your platform, Tor catches and ignores it.
1896 **@CONFDIR@/torrc**::
1897 The configuration file, which contains "option value" pairs.
1899 **@LOCALSTATEDIR@/lib/tor/**::
1900 The tor process stores keys and other data here.
1902 __DataDirectory__**/cached-status/**::
1903 The most recently downloaded network status document for each authority.
1904 Each file holds one such document; the filenames are the hexadecimal
1905 identity key fingerprints of the directory authorities. Mostly obsolete.
1907 __DataDirectory__**/cached-consensus** and/or **cached-microdesc-consensus**::
1908 The most recent consensus network status document we've downloaded.
1910 __DataDirectory__**/cached-descriptors** and **cached-descriptors.new**::
1911 These files hold downloaded router statuses. Some routers may appear more
1912 than once; if so, the most recently published descriptor is used. Lines
1913 beginning with @-signs are annotations that contain more information about
1914 a given router. The ".new" file is an append-only journal; when it gets
1915 too large, all entries are merged into a new cached-descriptors file.
1917 __DataDirectory__**/cached-microdescs** and **cached-microdescs.new**::
1918 These files hold downloaded microdescriptors. Lines beginning with
1919 @-signs are annotations that contain more information about a given
1920 router. The ".new" file is an append-only journal; when it gets too
1921 large, all entries are merged into a new cached-microdescs file.
1923 __DataDirectory__**/cached-routers** and **cached-routers.new**::
1924 Obsolete versions of cached-descriptors and cached-descriptors.new. When
1925 Tor can't find the newer files, it looks here instead.
1927 __DataDirectory__**/state**::
1928 A set of persistent key-value mappings. These are documented in
1929 the file. These include:
1930 - The current entry guards and their status.
1931 - The current bandwidth accounting values (unused so far; see
1933 - When the file was last written
1934 - What version of Tor generated the state file
1935 - A short history of bandwidth usage, as produced in the router
1938 __DataDirectory__**/bw_accounting**::
1939 Used to track bandwidth accounting values (when the current period starts
1940 and ends; how much has been read and written so far this period). This file
1941 is obsolete, and the data is now stored in the \'state' file as well. Only
1942 used when bandwidth accounting is enabled.
1944 __DataDirectory__**/control_auth_cookie**::
1945 Used for cookie authentication with the controller. Location can be
1946 overridden by the CookieAuthFile config option. Regenerated on startup. See
1947 control-spec.txt for details. Only used when cookie authentication is
1950 __DataDirectory__**/keys/***::
1951 Only used by servers. Holds identity keys and onion keys.
1953 __DataDirectory__**/fingerprint**::
1954 Only used by servers. Holds the fingerprint of the server's identity key.
1956 __DataDirectory__**/approved-routers**::
1957 Only for naming authoritative directory servers (see
1958 **NamingAuthoritativeDirectory**). This file lists nickname to identity
1959 bindings. Each line lists a nickname and a fingerprint separated by
1960 whitespace. See your **fingerprint** file in the __DataDirectory__ for an
1961 example line. If the nickname is **!reject** then descriptors from the
1962 given identity (fingerprint) are rejected by this server. If it is
1963 **!invalid** then descriptors are accepted but marked in the directory as
1964 not valid, that is, not recommended.
1966 __DataDirectory__**/router-stability**::
1967 Only used by authoritative directory servers. Tracks measurements for
1968 router mean-time-between-failures so that authorities have a good idea of
1969 how to set their Stable flags.
1971 __HiddenServiceDirectory__**/hostname**::
1972 The <base32-encoded-fingerprint>.onion domain name for this hidden service.
1973 If the hidden service is restricted to authorized clients only, this file
1974 also contains authorization data for all clients.
1976 __HiddenServiceDirectory__**/private_key**::
1977 The private key for this hidden service.
1979 __HiddenServiceDirectory__**/client_keys**::
1980 Authorization data for a hidden service that is only accessible by
1985 **privoxy**(1), **tsocks**(1), **torify**(1) +
1987 **https://www.torproject.org/**
1993 Plenty, probably. Tor is still in development. Please report them.
1997 Roger Dingledine [arma at mit.edu], Nick Mathewson [nickm at alum.mit.edu].