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 or relays ("onion routers").
29 Users bounce their TCP streams -- web traffic, ftp, ssh, etc. -- around the
30 network, and recipients, observers, and even the relays themselves have
31 difficulty tracking the source of the stream.
33 By default, **tor** will only act as a client only. To help the network
34 by providing bandwidth as a relay, change the **ORPort** configuration
35 option -- see below. Please also consult the documentation on the Tor
40 [[opt-h]] **-h**, **-help**::
41 Display a short help message and exit.
43 [[opt-f]] **-f** __FILE__::
44 Specify a new configuration file to contain further Tor configuration
45 options. (Default: @CONFDIR@/torrc, or $HOME/.torrc if that file is not
48 [[opt-allow-missing-torrc]] **--allow-missing-torrc**::
49 Do not require that configuration file specified by **-f** exist if
50 default torrc can be accessed.
52 [[opt-defaults-torrc]] **--defaults-torrc** __FILE__::
53 Specify a file in which to find default values for Tor options. The
54 contents of this file are overridden by those in the regular
55 configuration file, and by those on the command line. (Default:
56 @CONFDIR@/torrc-defaults.)
58 [[opt-ignore-missing-torrc]] **--ignore-missing-torrc**::
59 Specifies that Tor should treat a missing torrc file as though it
60 were empty. Ordinarily, Tor does this for missing default torrc files,
61 but not for those specified on the command line.
63 [[opt-hash-password]] **--hash-password** __PASSWORD__::
64 Generates a hashed password for control port access.
66 [[opt-list-fingerprint]] **--list-fingerprint**::
67 Generate your keys and output your nickname and fingerprint.
69 [[opt-verify-config]] **--verify-config**::
70 Verify the configuration file is valid.
72 [[opt-serviceinstall]] **--service install** [**--options** __command-line options__]::
73 Install an instance of Tor as a Windows service, with the provided
74 command-line options. Current instructions can be found at
75 https://trac.torproject.org/projects/tor/wiki/doc/TorFAQ#HowdoIrunmyTorrelayasanNTservice
77 [[opt-service]] **--service** **remove**|**start**|**stop**::
78 Remove, start, or stop a configured Tor Windows service.
80 [[opt-nt-service]] **--nt-service**::
81 Used internally to implement a Windows service.
83 [[opt-list-torrc-options]] **--list-torrc-options**::
84 List all valid options.
86 [[opt-version]] **--version**::
87 Display Tor version and exit.
89 [[opt-quiet]] **--quiet**|**--hush**::
90 Override the default console log. By default, Tor starts out logging
91 messages at level "notice" and higher to the console. It stops doing so
92 after it parses its configuration, if the configuration tells it to log
93 anywhere else. You can override this behavior with the **--hush** option,
94 which tells Tor to only send warnings and errors to the console, or with
95 the **--quiet** option, which tells Tor not to log to the console at all.
97 Other options can be specified on the command-line in the format "--option
98 value", in the format "option value", or in a configuration file. For
99 instance, you can tell Tor to start listening for SOCKS connections on port
100 9999 by passing --SOCKSPort 9999 or SOCKSPort 9999 to it on the command line,
101 or by putting "SOCKSPort 9999" in the configuration file. You will need to
102 quote options with spaces in them: if you want Tor to log all debugging
103 messages to debug.log, you will probably need to say --Log 'debug file
106 Options on the command line override those in configuration files. See the
107 next section for more information.
109 THE CONFIGURATION FILE FORMAT
110 -----------------------------
112 All configuration options in a configuration are written on a single line by
113 default. They take the form of an option name and a value, or an option name
114 and a quoted value (option value or option "value"). Anything after a #
115 character is treated as a comment. Options are
116 case-insensitive. C-style escaped characters are allowed inside quoted
117 values. To split one configuration entry into multiple lines, use a single
118 backslash character (\) before the end of the line. Comments can be used in
119 such multiline entries, but they must start at the beginning of a line.
121 By default, an option on the command line overrides an option found in the
122 configuration file, and an option in a configuration file overrides one in
125 This rule is simple for options that take a single value, but it can become
126 complicated for options that are allowed to occur more than once: if you
127 specify four SOCKSPorts in your configuration file, and one more SOCKSPort on
128 the command line, the option on the command line will replace __all__ of the
129 SOCKSPorts in the configuration file. If this isn't what you want, prefix
130 the option name with a plus sign, and it will be appended to the previous set
133 Alternatively, you might want to remove every instance of an option in the
134 configuration file, and not replace it at all: you might want to say on the
135 command line that you want no SOCKSPorts at all. To do that, prefix the
136 option name with a forward slash.
141 [[BandwidthRate]] **BandwidthRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
142 A token bucket limits the average incoming bandwidth usage on this node to
143 the specified number of bytes per second, and the average outgoing
144 bandwidth usage to that same value. If you want to run a relay in the
145 public network, this needs to be _at the very least_ 30 KBytes (that is,
146 30720 bytes). (Default: 1 GByte) +
148 With this option, and in other options that take arguments in bytes,
149 KBytes, and so on, other formats are also supported. Notably, "KBytes" can
150 also be written as "kilobytes" or "kb"; "MBytes" can be written as
151 "megabytes" or "MB"; "kbits" can be written as "kilobits"; and so forth.
152 Tor also accepts "byte" and "bit" in the singular.
153 The prefixes "tera" and "T" are also recognized.
154 If no units are given, we default to bytes.
155 To avoid confusion, we recommend writing "bytes" or "bits" explicitly,
156 since it's easy to forget that "B" means bytes, not bits.
158 [[BandwidthBurst]] **BandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
159 Limit the maximum token bucket size (also known as the burst) to the given
160 number of bytes in each direction. (Default: 1 GByte)
162 [[MaxAdvertisedBandwidth]] **MaxAdvertisedBandwidth** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
163 If set, we will not advertise more than this amount of bandwidth for our
164 BandwidthRate. Server operators who want to reduce the number of clients
165 who ask to build circuits through them (since this is proportional to
166 advertised bandwidth rate) can thus reduce the CPU demands on their server
167 without impacting network performance.
169 [[RelayBandwidthRate]] **RelayBandwidthRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
170 If not 0, a separate token bucket limits the average incoming bandwidth
171 usage for \_relayed traffic_ on this node to the specified number of bytes
172 per second, and the average outgoing bandwidth usage to that same value.
173 Relayed traffic currently is calculated to include answers to directory
174 requests, but that may change in future versions. (Default: 0)
176 [[RelayBandwidthBurst]] **RelayBandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
177 If not 0, limit the maximum token bucket size (also known as the burst) for
178 \_relayed traffic_ to the given number of bytes in each direction.
181 [[PerConnBWRate]] **PerConnBWRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
182 If set, do separate rate limiting for each connection from a non-relay.
183 You should never need to change this value, since a network-wide value is
184 published in the consensus and your relay will use that value. (Default: 0)
186 [[PerConnBWBurst]] **PerConnBWBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
187 If set, do separate rate limiting for each connection from a non-relay.
188 You should never need to change this value, since a network-wide value is
189 published in the consensus and your relay will use that value. (Default: 0)
191 [[ClientTransportPlugin]] **ClientTransportPlugin** __transport__ socks4|socks5 __IP__:__PORT__::
192 **ClientTransportPlugin** __transport__ exec __path-to-binary__ [options]::
193 In its first form, when set along with a corresponding Bridge line, the Tor
194 client forwards its traffic to a SOCKS-speaking proxy on "IP:PORT". It's the
195 duty of that proxy to properly forward the traffic to the bridge. +
197 In its second form, when set along with a corresponding Bridge line, the Tor
198 client launches the pluggable transport proxy executable in
199 __path-to-binary__ using __options__ as its command-line options, and
200 forwards its traffic to it. It's the duty of that proxy to properly forward
201 the traffic to the bridge.
203 [[ServerTransportPlugin]] **ServerTransportPlugin** __transport__ exec __path-to-binary__ [options]::
204 The Tor relay launches the pluggable transport proxy in __path-to-binary__
205 using __options__ as its command-line options, and expects to receive
206 proxied client traffic from it.
208 [[ServerTransportListenAddr]] **ServerTransportListenAddr** __transport__ __IP__:__PORT__::
209 When this option is set, Tor will suggest __IP__:__PORT__ as the
210 listening address of any pluggable transport proxy that tries to
211 launch __transport__.
213 [[ServerTransportOptions]] **ServerTransportOptions** __transport__ __k=v__ __k=v__ ...::
214 When this option is set, Tor will pass the __k=v__ parameters to
215 any pluggable transport proxy that tries to launch __transport__. +
216 (Example: ServerTransportOptions obfs45 shared-secret=bridgepasswd cache=/var/lib/tor/cache)
218 [[ExtORPort]] **ExtORPort** \['address':]__port__|**auto**
219 Open this port to listen for Extended ORPort connections from your
220 pluggable transports.
222 [[ExtORPortCookieAuthFile]] **ExtORPortCookieAuthFile** __Path__::
223 If set, this option overrides the default location and file name
224 for the Extended ORPort's cookie file -- the cookie file is needed
225 for pluggable transports to communicate through the Extended ORPort.
227 [[ExtORPortCookieAuthFileGroupReadable]] **ExtORPortCookieAuthFileGroupReadable** **0**|**1**::
228 If this option is set to 0, don't allow the filesystem group to read the
229 Extended OR Port cookie file. If the option is set to 1, make the cookie
230 file readable by the default GID. [Making the file readable by other
231 groups is not yet implemented; let us know if you need this for some
232 reason.] (Default: 0)
234 [[ConnLimit]] **ConnLimit** __NUM__::
235 The minimum number of file descriptors that must be available to the Tor
236 process before it will start. Tor will ask the OS for as many file
237 descriptors as the OS will allow (you can find this by "ulimit -H -n").
238 If this number is less than ConnLimit, then Tor will refuse to start. +
240 You probably don't need to adjust this. It has no effect on Windows
241 since that platform lacks getrlimit(). (Default: 1000)
243 [[DisableNetwork]] **DisableNetwork** **0**|**1**::
244 When this option is set, we don't listen for or accept any connections
245 other than controller connections, and we close (and don't reattempt)
247 connections. Controllers sometimes use this option to avoid using
248 the network until Tor is fully configured. (Default: 0)
250 [[ConstrainedSockets]] **ConstrainedSockets** **0**|**1**::
251 If set, Tor will tell the kernel to attempt to shrink the buffers for all
252 sockets to the size specified in **ConstrainedSockSize**. This is useful for
253 virtual servers and other environments where system level TCP buffers may
254 be limited. If you're on a virtual server, and you encounter the "Error
255 creating network socket: No buffer space available" message, you are
256 likely experiencing this problem. +
258 The preferred solution is to have the admin increase the buffer pool for
259 the host itself via /proc/sys/net/ipv4/tcp_mem or equivalent facility;
260 this configuration option is a second-resort. +
262 The DirPort option should also not be used if TCP buffers are scarce. The
263 cached directory requests consume additional sockets which exacerbates
266 You should **not** enable this feature unless you encounter the "no buffer
267 space available" issue. Reducing the TCP buffers affects window size for
268 the TCP stream and will reduce throughput in proportion to round trip
269 time on long paths. (Default: 0)
271 [[ConstrainedSockSize]] **ConstrainedSockSize** __N__ **bytes**|**KBytes**::
272 When **ConstrainedSockets** is enabled the receive and transmit buffers for
273 all sockets will be set to this limit. Must be a value between 2048 and
274 262144, in 1024 byte increments. Default of 8192 is recommended.
276 [[ControlPort]] **ControlPort** __PORT__|**auto**::
277 If set, Tor will accept connections on this port and allow those
278 connections to control the Tor process using the Tor Control Protocol
279 (described in control-spec.txt). Note: unless you also specify one or
280 more of **HashedControlPassword** or **CookieAuthentication**,
281 setting this option will cause Tor to allow any process on the local
282 host to control it. (Setting both authentication methods means either
283 method is sufficient to authenticate to Tor.) This
284 option is required for many Tor controllers; most use the value of 9051.
285 Set it to "auto" to have Tor pick a port for you. (Default: 0)
287 [[ControlListenAddress]] **ControlListenAddress** __IP__[:__PORT__]::
288 Bind the controller listener to this address. If you specify a port, bind
289 to this port rather than the one specified in ControlPort. We strongly
290 recommend that you leave this alone unless you know what you're doing,
291 since giving attackers access to your control listener is really
292 dangerous. This directive can be specified multiple
293 times to bind to multiple addresses/ports. (Default: 127.0.0.1)
295 [[ControlSocket]] **ControlSocket** __Path__::
296 Like ControlPort, but listens on a Unix domain socket, rather than a TCP
297 socket. (Unix and Unix-like systems only.)
299 [[ControlSocketsGroupWritable]] **ControlSocketsGroupWritable** **0**|**1**::
300 If this option is set to 0, don't allow the filesystem group to read and
301 write unix sockets (e.g. ControlSocket). If the option is set to 1, make
302 the control socket readable and writable by the default GID. (Default: 0)
304 [[HashedControlPassword]] **HashedControlPassword** __hashed_password__::
305 Allow connections on the control port if they present
306 the password whose one-way hash is __hashed_password__. You
307 can compute the hash of a password by running "tor --hash-password
308 __password__". You can provide several acceptable passwords by using more
309 than one HashedControlPassword line.
311 [[CookieAuthentication]] **CookieAuthentication** **0**|**1**::
312 If this option is set to 1, allow connections on the control port
313 when the connecting process knows the contents of a file named
314 "control_auth_cookie", which Tor will create in its data directory. This
315 authentication method should only be used on systems with good filesystem
316 security. (Default: 0)
318 [[CookieAuthFile]] **CookieAuthFile** __Path__::
319 If set, this option overrides the default location and file name
320 for Tor's cookie file. (See CookieAuthentication above.)
322 [[CookieAuthFileGroupReadable]] **CookieAuthFileGroupReadable** **0**|**1**::
323 If this option is set to 0, don't allow the filesystem group to read the
324 cookie file. If the option is set to 1, make the cookie file readable by
325 the default GID. [Making the file readable by other groups is not yet
326 implemented; let us know if you need this for some reason.] (Default: 0)
328 [[ControlPortWriteToFile]] **ControlPortWriteToFile** __Path__::
329 If set, Tor writes the address and port of any control port it opens to
330 this address. Usable by controllers to learn the actual control port
331 when ControlPort is set to "auto".
333 [[ControlPortFileGroupReadable]] **ControlPortFileGroupReadable** **0**|**1**::
334 If this option is set to 0, don't allow the filesystem group to read the
335 control port file. If the option is set to 1, make the control port
336 file readable by the default GID. (Default: 0)
338 [[DataDirectory]] **DataDirectory** __DIR__::
339 Store working data in DIR (Default: @LOCALSTATEDIR@/lib/tor)
341 [[FallbackDir]] **FallbackDir** __address__:__port__ orport=__port__ id=__fingerprint__ [weight=__num__]::
342 When we're unable to connect to any directory cache for directory info
343 (usually because we don't know about any yet) we try a FallbackDir.
344 By default, the directory authorities are also FallbackDirs.
346 [[DirAuthority]] **DirAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__::
347 Use a nonstandard authoritative directory server at the provided address
348 and port, with the specified key fingerprint. This option can be repeated
349 many times, for multiple authoritative directory servers. Flags are
350 separated by spaces, and determine what kind of an authority this directory
351 is. By default, an authority is not authoritative for any directory style
352 or version unless an appropriate flag is given.
353 Tor will use this authority as a bridge authoritative directory if the
354 "bridge" flag is set. If a flag "orport=**port**" is given, Tor will use the
355 given port when opening encrypted tunnels to the dirserver. If a flag
356 "weight=**num**" is given, then the directory server is chosen randomly
357 with probability proportional to that weight (default 1.0). Lastly, if a
358 flag "v3ident=**fp**" is given, the dirserver is a v3 directory authority
359 whose v3 long-term signing key has the fingerprint **fp**. +
361 If no **DirAuthority** line is given, Tor will use the default directory
362 authorities. NOTE: this option is intended for setting up a private Tor
363 network with its own directory authorities. If you use it, you will be
364 distinguishable from other users, because you won't believe the same
367 [[DirAuthorityFallbackRate]] **DirAuthorityFallbackRate** __NUM__::
368 When configured to use both directory authorities and fallback
369 directories, the directory authorities also work as fallbacks. They are
370 chosen with their regular weights, multiplied by this number, which
371 should be 1.0 or less. (Default: 1.0)
373 [[DynamicDHGroups]] **DynamicDHGroups** **0**|**1**::
374 If this option is set to 1, when running as a server, generate our
375 own Diffie-Hellman group instead of using the one from Apache's mod_ssl.
376 This option may help circumvent censorship based on static
377 Diffie-Hellman parameters. (Default: 0)
379 [[AlternateDirAuthority]] **AlternateDirAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__ +
381 [[AlternateBridgeAuthority]] **AlternateBridgeAuthority** [__nickname__] [**flags**] __address__:__port__ __ fingerprint__::
382 These options behave as DirAuthority, but they replace fewer of the
383 default directory authorities. Using
384 AlternateDirAuthority replaces the default Tor directory authorities, but
385 leaves the default bridge authorities in
387 AlternateBridgeAuthority replaces the default bridge authority,
388 but leaves the directory authorities alone.
390 [[DisableAllSwap]] **DisableAllSwap** **0**|**1**::
391 If set to 1, Tor will attempt to lock all current and future memory pages,
392 so that memory cannot be paged out. Windows, OS X and Solaris are currently
393 not supported. We believe that this feature works on modern Gnu/Linux
394 distributions, and that it should work on *BSD systems (untested). This
395 option requires that you start your Tor as root, and you should use the
396 **User** option to properly reduce Tor's privileges. (Default: 0)
398 [[DisableDebuggerAttachment]] **DisableDebuggerAttachment** **0**|**1**::
399 If set to 1, Tor will attempt to prevent basic debugging attachment attempts
400 by other processes. This may also keep Tor from generating core files if
401 it crashes. It has no impact for users who wish to attach if they
402 have CAP_SYS_PTRACE or if they are root. We believe that this feature
403 works on modern Gnu/Linux distributions, and that it may also work on *BSD
404 systems (untested). Some modern Gnu/Linux systems such as Ubuntu have the
405 kernel.yama.ptrace_scope sysctl and by default enable it as an attempt to
406 limit the PTRACE scope for all user processes by default. This feature will
407 attempt to limit the PTRACE scope for Tor specifically - it will not attempt
408 to alter the system wide ptrace scope as it may not even exist. If you wish
409 to attach to Tor with a debugger such as gdb or strace you will want to set
410 this to 0 for the duration of your debugging. Normal users should leave it
411 on. Disabling this option while Tor is running is prohibited. (Default: 1)
413 [[FetchDirInfoEarly]] **FetchDirInfoEarly** **0**|**1**::
414 If set to 1, Tor will always fetch directory information like other
415 directory caches, even if you don't meet the normal criteria for fetching
416 early. Normal users should leave it off. (Default: 0)
418 [[FetchDirInfoExtraEarly]] **FetchDirInfoExtraEarly** **0**|**1**::
419 If set to 1, Tor will fetch directory information before other directory
420 caches. It will attempt to download directory information closer to the
421 start of the consensus period. Normal users should leave it off.
424 [[FetchHidServDescriptors]] **FetchHidServDescriptors** **0**|**1**::
425 If set to 0, Tor will never fetch any hidden service descriptors from the
426 rendezvous directories. This option is only useful if you're using a Tor
427 controller that handles hidden service fetches for you. (Default: 1)
429 [[FetchServerDescriptors]] **FetchServerDescriptors** **0**|**1**::
430 If set to 0, Tor will never fetch any network status summaries or server
431 descriptors from the directory servers. This option is only useful if
432 you're using a Tor controller that handles directory fetches for you.
435 [[FetchUselessDescriptors]] **FetchUselessDescriptors** **0**|**1**::
436 If set to 1, Tor will fetch every non-obsolete descriptor from the
437 authorities that it hears about. Otherwise, it will avoid fetching useless
438 descriptors, for example for routers that are not running. This option is
439 useful if you're using the contributed "exitlist" script to enumerate Tor
440 nodes that exit to certain addresses. (Default: 0)
442 [[HTTPProxy]] **HTTPProxy** __host__[:__port__]::
443 Tor will make all its directory requests through this host:port (or host:80
444 if port is not specified), rather than connecting directly to any directory
447 [[HTTPProxyAuthenticator]] **HTTPProxyAuthenticator** __username:password__::
448 If defined, Tor will use this username:password for Basic HTTP proxy
449 authentication, as in RFC 2617. This is currently the only form of HTTP
450 proxy authentication that Tor supports; feel free to submit a patch if you
451 want it to support others.
453 [[HTTPSProxy]] **HTTPSProxy** __host__[:__port__]::
454 Tor will make all its OR (SSL) connections through this host:port (or
455 host:443 if port is not specified), via HTTP CONNECT rather than connecting
456 directly to servers. You may want to set **FascistFirewall** to restrict
457 the set of ports you might try to connect to, if your HTTPS proxy only
458 allows connecting to certain ports.
460 [[HTTPSProxyAuthenticator]] **HTTPSProxyAuthenticator** __username:password__::
461 If defined, Tor will use this username:password for Basic HTTPS proxy
462 authentication, as in RFC 2617. This is currently the only form of HTTPS
463 proxy authentication that Tor supports; feel free to submit a patch if you
464 want it to support others.
466 [[Sandbox]] **Sandbox** **0**|**1**::
467 If set to 1, Tor will run securely through the use of a syscall sandbox.
468 Otherwise the sandbox will be disabled. The option is currently an
469 experimental feature. (Default: 0)
471 [[Socks4Proxy]] **Socks4Proxy** __host__[:__port__]::
472 Tor will make all OR connections through the SOCKS 4 proxy at host:port
473 (or host:1080 if port is not specified).
475 [[Socks5Proxy]] **Socks5Proxy** __host__[:__port__]::
476 Tor will make all OR connections through the SOCKS 5 proxy at host:port
477 (or host:1080 if port is not specified).
479 [[Socks5ProxyUsername]] **Socks5ProxyUsername** __username__ +
481 [[Socks5ProxyPassword]] **Socks5ProxyPassword** __password__::
482 If defined, authenticate to the SOCKS 5 server using username and password
483 in accordance to RFC 1929. Both username and password must be between 1 and
486 [[KeepalivePeriod]] **KeepalivePeriod** __NUM__::
487 To keep firewalls from expiring connections, send a padding keepalive cell
488 every NUM seconds on open connections that are in use. If the connection
489 has no open circuits, it will instead be closed after NUM seconds of
490 idleness. (Default: 5 minutes)
492 [[Log]] **Log** __minSeverity__[-__maxSeverity__] **stderr**|**stdout**|**syslog**::
493 Send all messages between __minSeverity__ and __maxSeverity__ to the standard
494 output stream, the standard error stream, or to the system log. (The
495 "syslog" value is only supported on Unix.) Recognized severity levels are
496 debug, info, notice, warn, and err. We advise using "notice" in most cases,
497 since anything more verbose may provide sensitive information to an
498 attacker who obtains the logs. If only one severity level is given, all
499 messages of that level or higher will be sent to the listed destination.
501 [[Log2]] **Log** __minSeverity__[-__maxSeverity__] **file** __FILENAME__::
502 As above, but send log messages to the listed filename. The
503 "Log" option may appear more than once in a configuration file.
504 Messages are sent to all the logs that match their severity
507 [[Log3]] **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **file** __FILENAME__ +
509 [[Log4]] **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **stderr**|**stdout**|**syslog**::
510 As above, but select messages by range of log severity __and__ by a
511 set of "logging domains". Each logging domain corresponds to an area of
512 functionality inside Tor. You can specify any number of severity ranges
513 for a single log statement, each of them prefixed by a comma-separated
514 list of logging domains. You can prefix a domain with $$~$$ to indicate
515 negation, and use * to indicate "all domains". If you specify a severity
516 range without a list of domains, it matches all domains. +
518 This is an advanced feature which is most useful for debugging one or two
519 of Tor's subsystems at a time. +
521 The currently recognized domains are: general, crypto, net, config, fs,
522 protocol, mm, http, app, control, circ, rend, bug, dir, dirserv, or, edge,
523 acct, hist, and handshake. Domain names are case-insensitive. +
525 For example, "`Log [handshake]debug [~net,~mm]info notice stdout`" sends
526 to stdout: all handshake messages of any severity, all info-and-higher
527 messages from domains other than networking and memory management, and all
528 messages of severity notice or higher.
530 [[LogMessageDomains]] **LogMessageDomains** **0**|**1**::
531 If 1, Tor includes message domains with each log message. Every log
532 message currently has at least one domain; most currently have exactly
533 one. This doesn't affect controller log messages. (Default: 0)
535 [[OutboundBindAddress]] **OutboundBindAddress** __IP__::
536 Make all outbound connections originate from the IP address specified. This
537 is only useful when you have multiple network interfaces, and you want all
538 of Tor's outgoing connections to use a single one. This option may
539 be used twice, once with an IPv4 address and once with an IPv6 address.
540 This setting will be ignored for connections to the loopback addresses
541 (127.0.0.0/8 and ::1).
543 [[PidFile]] **PidFile** __FILE__::
544 On startup, write our PID to FILE. On clean shutdown, remove
547 [[ProtocolWarnings]] **ProtocolWarnings** **0**|**1**::
548 If 1, Tor will log with severity \'warn' various cases of other parties not
549 following the Tor specification. Otherwise, they are logged with severity
550 \'info'. (Default: 0)
552 [[PredictedPortsRelevanceTime]] **PredictedPortsRelevanceTime** __NUM__::
553 Set how long, after the client has mad an anonymized connection to a
554 given port, we will try to make sure that we build circuits to
555 exits that support that port. The maximum value for this option is 1
556 hour. (Default: 1 hour)
558 [[RunAsDaemon]] **RunAsDaemon** **0**|**1**::
559 If 1, Tor forks and daemonizes to the background. This option has no effect
560 on Windows; instead you should use the --service command-line option.
563 [[LogTimeGranularity]] **LogTimeGranularity** __NUM__::
564 Set the resolution of timestamps in Tor's logs to NUM milliseconds.
565 NUM must be positive and either a divisor or a multiple of 1 second.
566 Note that this option only controls the granularity written by Tor to
567 a file or console log. Tor does not (for example) "batch up" log
568 messages to affect times logged by a controller, times attached to
569 syslog messages, or the mtime fields on log files. (Default: 1 second)
571 [[TruncateLogFile]] **TruncateLogFile** **0**|**1**::
572 If 1, Tor will overwrite logs at startup and in response to a HUP signal,
573 instead of appending to them. (Default: 0)
575 [[SafeLogging]] **SafeLogging** **0**|**1**|**relay**::
576 Tor can scrub potentially sensitive strings from log messages (e.g.
577 addresses) by replacing them with the string [scrubbed]. This way logs can
578 still be useful, but they don't leave behind personally identifying
579 information about what sites a user might have visited. +
581 If this option is set to 0, Tor will not perform any scrubbing, if it is
582 set to 1, all potentially sensitive strings are replaced. If it is set to
583 relay, all log messages generated when acting as a relay are sanitized, but
584 all messages generated when acting as a client are not. (Default: 1)
586 [[User]] **User** __UID__::
587 On startup, setuid to this user and setgid to their primary group.
589 [[HardwareAccel]] **HardwareAccel** **0**|**1**::
590 If non-zero, try to use built-in (static) crypto hardware acceleration when
591 available. (Default: 0)
593 [[AccelName]] **AccelName** __NAME__::
594 When using OpenSSL hardware crypto acceleration attempt to load the dynamic
595 engine of this name. This must be used for any dynamic hardware engine.
596 Names can be verified with the openssl engine command.
598 [[AccelDir]] **AccelDir** __DIR__::
599 Specify this option if using dynamic hardware acceleration and the engine
600 implementation library resides somewhere other than the OpenSSL default.
602 [[AvoidDiskWrites]] **AvoidDiskWrites** **0**|**1**::
603 If non-zero, try to write to disk less frequently than we would otherwise.
604 This is useful when running on flash memory or other media that support
605 only a limited number of writes. (Default: 0)
607 [[CircuitPriorityHalflife]] **CircuitPriorityHalflife** __NUM1__::
608 If this value is set, we override the default algorithm for choosing which
609 circuit's cell to deliver or relay next. When the value is 0, we
610 round-robin between the active circuits on a connection, delivering one
611 cell from each in turn. When the value is positive, we prefer delivering
612 cells from whichever connection has the lowest weighted cell count, where
613 cells are weighted exponentially according to the supplied
614 CircuitPriorityHalflife value (in seconds). If this option is not set at
615 all, we use the behavior recommended in the current consensus
616 networkstatus. This is an advanced option; you generally shouldn't have
617 to mess with it. (Default: not set)
619 [[DisableIOCP]] **DisableIOCP** **0**|**1**::
620 If Tor was built to use the Libevent's "bufferevents" networking code
621 and you're running on Windows, setting this option to 1 will tell Libevent
622 not to use the Windows IOCP networking API. (Default: 1)
624 [[UserspaceIOCPBuffers]] **UserspaceIOCPBuffers** **0**|**1**::
625 If IOCP is enabled (see DisableIOCP above), setting this option to 1
626 will tell Tor to disable kernel-space TCP buffers, in order to avoid
627 needless copy operations and try not to run out of non-paged RAM.
628 This feature is experimental; don't use it yet unless you're eager to
629 help tracking down bugs. (Default: 0)
631 [[UseFilteringSSLBufferevents]] **UseFilteringSSLBufferevents** **0**|**1**::
632 Tells Tor to do its SSL communication using a chain of
633 bufferevents: one for SSL and one for networking. This option has no
634 effect if bufferevents are disabled (in which case it can't turn on), or
635 if IOCP bufferevents are enabled (in which case it can't turn off). This
636 option is useful for debugging only; most users shouldn't touch it.
639 [[CountPrivateBandwidth]] **CountPrivateBandwidth** **0**|**1**::
640 If this option is set, then Tor's rate-limiting applies not only to
641 remote connections, but also to connections to private addresses like
642 127.0.0.1 or 10.0.0.1. This is mostly useful for debugging
643 rate-limiting. (Default: 0)
648 The following options are useful only for clients (that is, if
649 **SocksPort**, **TransPort**, **DNSPort**, or **NATDPort** is non-zero):
651 [[AllowInvalidNodes]] **AllowInvalidNodes** **entry**|**exit**|**middle**|**introduction**|**rendezvous**|**...**::
652 If some Tor servers are obviously not working right, the directory
653 authorities can manually mark them as invalid, meaning that it's not
654 recommended you use them for entry or exit positions in your circuits. You
655 can opt to use them in some circuit positions, though. The default is
656 "middle,rendezvous", and other choices are not advised.
658 [[ExcludeSingleHopRelays]] **ExcludeSingleHopRelays** **0**|**1**::
659 This option controls whether circuits built by Tor will include relays with
660 the AllowSingleHopExits flag set to true. If ExcludeSingleHopRelays is set
661 to 0, these relays will be included. Note that these relays might be at
662 higher risk of being seized or observed, so they are not normally
663 included. Also note that relatively few clients turn off this option,
664 so using these relays might make your client stand out.
667 [[Bridge]] **Bridge** [__transport__] __IP__:__ORPort__ [__fingerprint__]::
668 When set along with UseBridges, instructs Tor to use the relay at
669 "IP:ORPort" as a "bridge" relaying into the Tor network. If "fingerprint"
670 is provided (using the same format as for DirAuthority), we will verify that
671 the relay running at that location has the right fingerprint. We also use
672 fingerprint to look up the bridge descriptor at the bridge authority, if
673 it's provided and if UpdateBridgesFromAuthority is set too. +
675 If "transport" is provided, and matches to a ClientTransportPlugin
676 line, we use that pluggable transports proxy to transfer data to
679 [[LearnCircuitBuildTimeout]] **LearnCircuitBuildTimeout** **0**|**1**::
680 If 0, CircuitBuildTimeout adaptive learning is disabled. (Default: 1)
682 [[CircuitBuildTimeout]] **CircuitBuildTimeout** __NUM__::
684 Try for at most NUM seconds when building circuits. If the circuit isn't
685 open in that time, give up on it. If LearnCircuitBuildTimeout is 1, this
686 value serves as the initial value to use before a timeout is learned. If
687 LearnCircuitBuildTimeout is 0, this value is the only value used.
688 (Default: 60 seconds)
690 [[CircuitIdleTimeout]] **CircuitIdleTimeout** __NUM__::
691 If we have kept a clean (never used) circuit around for NUM seconds, then
692 close it. This way when the Tor client is entirely idle, it can expire all
693 of its circuits, and then expire its TLS connections. Also, if we end up
694 making a circuit that is not useful for exiting any of the requests we're
695 receiving, it won't forever take up a slot in the circuit list. (Default: 1
698 [[CircuitStreamTimeout]] **CircuitStreamTimeout** __NUM__::
699 If non-zero, this option overrides our internal timeout schedule for how
700 many seconds until we detach a stream from a circuit and try a new circuit.
701 If your network is particularly slow, you might want to set this to a
702 number like 60. (Default: 0)
704 [[ClientOnly]] **ClientOnly** **0**|**1**::
705 If set to 1, Tor will not run as a relay or serve
706 directory requests, even if the ORPort, ExtORPort, or DirPort options are
707 set. (This config option is
708 mostly unnecessary: we added it back when we were considering having
709 Tor clients auto-promote themselves to being relays if they were stable
710 and fast enough. The current behavior is simply that Tor is a client
711 unless ORPort, ExtORPort, or DirPort are configured.) (Default: 0)
713 [[ExcludeNodes]] **ExcludeNodes** __node__,__node__,__...__::
714 A list of identity fingerprints, nicknames, country codes and address
715 patterns of nodes to avoid when building a circuit.
717 ExcludeNodes SlowServer, ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
719 By default, this option is treated as a preference that Tor is allowed
720 to override in order to keep working.
721 For example, if you try to connect to a hidden service,
722 but you have excluded all of the hidden service's introduction points,
723 Tor will connect to one of them anyway. If you do not want this
724 behavior, set the StrictNodes option (documented below). +
726 Note also that if you are a relay, this (and the other node selection
727 options below) only affects your own circuits that Tor builds for you.
728 Clients can still build circuits through you to any node. Controllers
729 can tell Tor to build circuits through any node. +
731 Country codes are case-insensitive. The code "\{??}" refers to nodes whose
732 country can't be identified. No country code, including \{??}, works if
733 no GeoIPFile can be loaded. See also the GeoIPExcludeUnknown option below.
736 [[ExcludeExitNodes]] **ExcludeExitNodes** __node__,__node__,__...__::
737 A list of identity fingerprints, nicknames, country codes and address
738 patterns of nodes to never use when picking an exit node---that is, a
739 node that delivers traffic for you outside the Tor network. Note that any
740 node listed in ExcludeNodes is automatically considered to be part of this
741 list too. See also the caveats on the "ExitNodes" option below.
743 [[GeoIPExcludeUnknown]] **GeoIPExcludeUnknown** **0**|**1**|**auto**::
744 If this option is set to 'auto', then whenever any country code is set in
745 ExcludeNodes or ExcludeExitNodes, all nodes with unknown country (\{??} and
746 possibly \{A1}) are treated as excluded as well. If this option is set to
747 '1', then all unknown countries are treated as excluded in ExcludeNodes
748 and ExcludeExitNodes. This option has no effect when a GeoIP file isn't
749 configured or can't be found. (Default: auto)
751 [[ExitNodes]] **ExitNodes** __node__,__node__,__...__::
752 A list of identity fingerprints, nicknames, country codes and address
753 patterns of nodes to use as exit node---that is, a
754 node that delivers traffic for you outside the Tor network. +
756 Note that if you list too few nodes here, or if you exclude too many exit
757 nodes with ExcludeExitNodes, you can degrade functionality. For example,
758 if none of the exits you list allows traffic on port 80 or 443, you won't
759 be able to browse the web. +
761 Note also that not every circuit is used to deliver traffic outside of
762 the Tor network. It is normal to see non-exit circuits (such as those
763 used to connect to hidden services, those that do directory fetches,
764 those used for relay reachability self-tests, and so on) that end
765 at a non-exit node. To
766 keep a node from being used entirely, see ExcludeNodes and StrictNodes. +
768 The ExcludeNodes option overrides this option: any node listed in both
769 ExitNodes and ExcludeNodes is treated as excluded. +
771 The .exit address notation, if enabled via AllowDotExit, overrides
774 [[EntryNodes]] **EntryNodes** __node__,__node__,__...__::
775 A list of identity fingerprints, nicknames, and country codes of nodes
776 to use for the first hop in your normal circuits.
777 Normal circuits include all
778 circuits except for direct connections to directory servers. The Bridge
779 option overrides this option; if you have configured bridges and
780 UseBridges is 1, the Bridges are used as your entry nodes. +
782 The ExcludeNodes option overrides this option: any node listed in both
783 EntryNodes and ExcludeNodes is treated as excluded.
785 [[StrictNodes]] **StrictNodes** **0**|**1**::
786 If StrictNodes is set to 1, Tor will treat the ExcludeNodes option as a
787 requirement to follow for all the circuits you generate, even if doing so
788 will break functionality for you. If StrictNodes is set to 0, Tor will
789 still try to avoid nodes in the ExcludeNodes list, but it will err on the
790 side of avoiding unexpected errors. Specifically, StrictNodes 0 tells
791 Tor that it is okay to use an excluded node when it is *necessary* to
792 perform relay reachability self-tests, connect to
793 a hidden service, provide a hidden service to a client, fulfill a .exit
794 request, upload directory information, or download directory information.
797 [[FascistFirewall]] **FascistFirewall** **0**|**1**::
798 If 1, Tor will only create outgoing connections to ORs running on ports
799 that your firewall allows (defaults to 80 and 443; see **FirewallPorts**).
800 This will allow you to run Tor as a client behind a firewall with
801 restrictive policies, but will not allow you to run as a server behind such
802 a firewall. If you prefer more fine-grained control, use
803 ReachableAddresses instead.
805 [[FirewallPorts]] **FirewallPorts** __PORTS__::
806 A list of ports that your firewall allows you to connect to. Only used when
807 **FascistFirewall** is set. This option is deprecated; use ReachableAddresses
808 instead. (Default: 80, 443)
810 [[ReachableAddresses]] **ReachableAddresses** __ADDR__[/__MASK__][:__PORT__]...::
811 A comma-separated list of IP addresses and ports that your firewall allows
812 you to connect to. The format is as for the addresses in ExitPolicy, except
813 that "accept" is understood unless "reject" is explicitly provided. For
814 example, \'ReachableAddresses 99.0.0.0/8, reject 18.0.0.0/8:80, accept
815 \*:80' means that your firewall allows connections to everything inside net
816 99, rejects port 80 connections to net 18, and accepts connections to port
817 80 otherwise. (Default: \'accept \*:*'.)
819 [[ReachableDirAddresses]] **ReachableDirAddresses** __ADDR__[/__MASK__][:__PORT__]...::
820 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
821 these restrictions when fetching directory information, using standard HTTP
822 GET requests. If not set explicitly then the value of
823 **ReachableAddresses** is used. If **HTTPProxy** is set then these
824 connections will go through that proxy.
826 [[ReachableORAddresses]] **ReachableORAddresses** __ADDR__[/__MASK__][:__PORT__]...::
827 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
828 these restrictions when connecting to Onion Routers, using TLS/SSL. If not
829 set explicitly then the value of **ReachableAddresses** is used. If
830 **HTTPSProxy** is set then these connections will go through that proxy. +
832 The separation between **ReachableORAddresses** and
833 **ReachableDirAddresses** is only interesting when you are connecting
834 through proxies (see **HTTPProxy** and **HTTPSProxy**). Most proxies limit
835 TLS connections (which Tor uses to connect to Onion Routers) to port 443,
836 and some limit HTTP GET requests (which Tor uses for fetching directory
837 information) to port 80.
839 [[HidServAuth]] **HidServAuth** __onion-address__ __auth-cookie__ [__service-name__]::
840 Client authorization for a hidden service. Valid onion addresses contain 16
841 characters in a-z2-7 plus ".onion", and valid auth cookies contain 22
842 characters in A-Za-z0-9+/. The service name is only used for internal
843 purposes, e.g., for Tor controllers. This option may be used multiple times
844 for different hidden services. If a hidden service uses authorization and
845 this option is not set, the hidden service is not accessible. Hidden
846 services can be configured to require authorization using the
847 **HiddenServiceAuthorizeClient** option.
849 [[CloseHSClientCircuitsImmediatelyOnTimeout]] **CloseHSClientCircuitsImmediatelyOnTimeout** **0**|**1**::
850 If 1, Tor will close unfinished hidden service client circuits
851 which have not moved closer to connecting to their destination
852 hidden service when their internal state has not changed for the
853 duration of the current circuit-build timeout. Otherwise, such
854 circuits will be left open, in the hope that they will finish
855 connecting to their destination hidden services. In either case,
856 another set of introduction and rendezvous circuits for the same
857 destination hidden service will be launched. (Default: 0)
859 [[CloseHSServiceRendCircuitsImmediatelyOnTimeout]] **CloseHSServiceRendCircuitsImmediatelyOnTimeout** **0**|**1**::
860 If 1, Tor will close unfinished hidden-service-side rendezvous
861 circuits after the current circuit-build timeout. Otherwise, such
862 circuits will be left open, in the hope that they will finish
863 connecting to their destinations. In either case, another
864 rendezvous circuit for the same destination client will be
865 launched. (Default: 0)
867 [[LongLivedPorts]] **LongLivedPorts** __PORTS__::
868 A list of ports for services that tend to have long-running connections
869 (e.g. chat and interactive shells). Circuits for streams that use these
870 ports will contain only high-uptime nodes, to reduce the chance that a node
871 will go down before the stream is finished. Note that the list is also
872 honored for circuits (both client and service side) involving hidden
873 services whose virtual port is in this list. (Default: 21, 22, 706,
874 1863, 5050, 5190, 5222, 5223, 6523, 6667, 6697, 8300)
876 [[MapAddress]] **MapAddress** __address__ __newaddress__::
877 When a request for address arrives to Tor, it will transform to newaddress
878 before processing it. For example, if you always want connections to
879 www.example.com to exit via __torserver__ (where __torserver__ is the
880 nickname of the server), use "MapAddress www.example.com
881 www.example.com.torserver.exit". If the value is prefixed with a
882 "\*.", matches an entire domain. For example, if you
883 always want connections to example.com and any if its subdomains
885 __torserver__ (where __torserver__ is the nickname of the server), use
886 "MapAddress \*.example.com \*.example.com.torserver.exit". (Note the
887 leading "*." in each part of the directive.) You can also redirect all
888 subdomains of a domain to a single address. For example, "MapAddress
889 *.example.com www.example.com". +
893 1. When evaluating MapAddress expressions Tor stops when it hits the most
894 recently added expression that matches the requested address. So if you
895 have the following in your torrc, www.torproject.org will map to 1.1.1.1:
897 MapAddress www.torproject.org 2.2.2.2
898 MapAddress www.torproject.org 1.1.1.1
900 2. Tor evaluates the MapAddress configuration until it finds no matches. So
901 if you have the following in your torrc, www.torproject.org will map to
904 MapAddress 1.1.1.1 2.2.2.2
905 MapAddress www.torproject.org 1.1.1.1
907 3. The following MapAddress expression is invalid (and will be
908 ignored) because you cannot map from a specific address to a wildcard
911 MapAddress www.torproject.org *.torproject.org.torserver.exit
913 4. Using a wildcard to match only part of a string (as in *ample.com) is
916 [[NewCircuitPeriod]] **NewCircuitPeriod** __NUM__::
917 Every NUM seconds consider whether to build a new circuit. (Default: 30
920 [[MaxCircuitDirtiness]] **MaxCircuitDirtiness** __NUM__::
921 Feel free to reuse a circuit that was first used at most NUM seconds ago,
922 but never attach a new stream to a circuit that is too old. For hidden
923 services, this applies to the __last__ time a circuit was used, not the
924 first. (Default: 10 minutes)
926 [[MaxClientCircuitsPending]] **MaxClientCircuitsPending** __NUM__::
927 Do not allow more than NUM circuits to be pending at a time for handling
928 client streams. A circuit is pending if we have begun constructing it,
929 but it has not yet been completely constructed. (Default: 32)
931 [[NodeFamily]] **NodeFamily** __node__,__node__,__...__::
932 The Tor servers, defined by their identity fingerprints or nicknames,
933 constitute a "family" of similar or co-administered servers, so never use
934 any two of them in the same circuit. Defining a NodeFamily is only needed
935 when a server doesn't list the family itself (with MyFamily). This option
936 can be used multiple times. In addition to nodes, you can also list
937 IP address and ranges and country codes in {curly braces}.
939 [[EnforceDistinctSubnets]] **EnforceDistinctSubnets** **0**|**1**::
940 If 1, Tor will not put two servers whose IP addresses are "too close" on
941 the same circuit. Currently, two addresses are "too close" if they lie in
942 the same /16 range. (Default: 1)
944 [[SOCKSPort]] **SOCKSPort** \['address':]__port__|**auto** [_flags_] [_isolation flags_]::
945 Open this port to listen for connections from SOCKS-speaking
946 applications. Set this to 0 if you don't want to allow application
947 connections via SOCKS. Set it to "auto" to have Tor pick a port for
948 you. This directive can be specified multiple times to bind
949 to multiple addresses/ports. (Default: 9050) +
951 The _isolation flags_ arguments give Tor rules for which streams
952 received on this SOCKSPort are allowed to share circuits with one
953 another. Recognized isolation flags are:
954 **IsolateClientAddr**;;
955 Don't share circuits with streams from a different
956 client address. (On by default and strongly recommended;
957 you can disable it with **NoIsolateClientAddr**.)
958 **IsolateSOCKSAuth**;;
959 Don't share circuits with streams for which different
960 SOCKS authentication was provided. (On by default;
961 you can disable it with **NoIsolateSOCKSAuth**.)
962 **IsolateClientProtocol**;;
963 Don't share circuits with streams using a different protocol.
964 (SOCKS 4, SOCKS 5, TransPort connections, NATDPort connections,
965 and DNSPort requests are all considered to be different protocols.)
966 **IsolateDestPort**;;
967 Don't share circuits with streams targeting a different
969 **IsolateDestAddr**;;
970 Don't share circuits with streams targeting a different
972 **SessionGroup=**__INT__;;
973 If no other isolation rules would prevent it, allow streams
974 on this port to share circuits with streams from every other
975 port with the same session group. (By default, streams received
976 on different SOCKSPorts, TransPorts, etc are always isolated from one
977 another. This option overrides that behavior.)
979 [[OtherSOCKSPortFlags]]::
980 Other recognized __flags__ for a SOCKSPort are:
982 Tell exits to not connect to IPv4 addresses in response to SOCKS
983 requests on this connection.
985 Tell exits to allow IPv6 addresses in response to SOCKS requests on
986 this connection, so long as SOCKS5 is in use. (SOCKS4 can't handle
989 Tells exits that, if a host has both an IPv4 and an IPv6 address,
990 we would prefer to connect to it via IPv6. (IPv4 is the default.) +
992 NOTE: Although this option allows you to specify an IP address
993 other than localhost, you should do so only with extreme caution.
994 The SOCKS protocol is unencrypted and (as we use it)
995 unauthenticated, so exposing it in this way could leak your
996 information to anybody watching your network, and allow anybody
997 to use your computer as an open proxy. +
1000 Tells the client to remember IPv4 DNS answers we receive from exit
1001 nodes via this connection. (On by default.)
1003 Tells the client to remember IPv6 DNS answers we receive from exit
1004 nodes via this connection.
1006 Tells the client to remember all DNS answers we receive from exit
1007 nodes via this connection.
1009 Tells the client to use any cached IPv4 DNS answers we have when making
1010 requests via this connection. (NOTE: This option, along UseIPv6Cache
1011 and UseDNSCache, can harm your anonymity, and probably
1012 won't help performance as much as you might expect. Use with care!)
1014 Tells the client to use any cached IPv6 DNS answers we have when making
1015 requests via this connection.
1017 Tells the client to use any cached DNS answers we have when making
1018 requests via this connection.
1019 **PreferIPv6Automap**;;
1020 When serving a hostname lookup request on this port that
1021 should get automapped (according to AutomapHostsOnResolve),
1022 if we could return either an IPv4 or an IPv6 answer, prefer
1023 an IPv6 answer. (On by default.)
1024 **PreferSOCKSNoAuth**;;
1025 Ordinarily, when an application offers both "username/password
1026 authentication" and "no authentication" to Tor via SOCKS5, Tor
1027 selects username/password authentication so that IsolateSOCKSAuth can
1028 work. This can confuse some applications, if they offer a
1029 username/password combination then get confused when asked for
1030 one. You can disable this behavior, so that Tor will select "No
1031 authentication" when IsolateSOCKSAuth is disabled, or when this
1034 [[SOCKSListenAddress]] **SOCKSListenAddress** __IP__[:__PORT__]::
1035 Bind to this address to listen for connections from Socks-speaking
1036 applications. (Default: 127.0.0.1) You can also specify a port (e.g.
1037 192.168.0.1:9100). This directive can be specified multiple times to bind
1038 to multiple addresses/ports. (DEPRECATED: As of 0.2.3.x-alpha, you can
1039 now use multiple SOCKSPort entries, and provide addresses for SOCKSPort
1040 entries, so SOCKSListenAddress no longer has a purpose. For backward
1041 compatibility, SOCKSListenAddress is only allowed when SOCKSPort is just
1044 [[SocksPolicy]] **SocksPolicy** __policy__,__policy__,__...__::
1045 Set an entrance policy for this server, to limit who can connect to the
1046 SocksPort and DNSPort ports. The policies have the same form as exit
1047 policies below, except that port specifiers are ignored. Any address
1048 not matched by some entry in the policy is accepted.
1050 [[SocksTimeout]] **SocksTimeout** __NUM__::
1051 Let a socks connection wait NUM seconds handshaking, and NUM seconds
1052 unattached waiting for an appropriate circuit, before we fail it. (Default:
1055 [[TokenBucketRefillInterval]] **TokenBucketRefillInterval** __NUM__ [**msec**|**second**]::
1056 Set the refill interval of Tor's token bucket to NUM milliseconds.
1057 NUM must be between 1 and 1000, inclusive. Note that the configured
1058 bandwidth limits are still expressed in bytes per second: this
1059 option only affects the frequency with which Tor checks to see whether
1060 previously exhausted connections may read again. (Default: 100 msec)
1062 [[TrackHostExits]] **TrackHostExits** __host__,__.domain__,__...__::
1063 For each value in the comma separated list, Tor will track recent
1064 connections to hosts that match this value and attempt to reuse the same
1065 exit node for each. If the value is prepended with a \'.\', it is treated as
1066 matching an entire domain. If one of the values is just a \'.', it means
1067 match everything. This option is useful if you frequently connect to sites
1068 that will expire all your authentication cookies (i.e. log you out) if
1069 your IP address changes. Note that this option does have the disadvantage
1070 of making it more clear that a given history is associated with a single
1071 user. However, most people who would wish to observe this will observe it
1072 through cookies or other protocol-specific means anyhow.
1074 [[TrackHostExitsExpire]] **TrackHostExitsExpire** __NUM__::
1075 Since exit servers go up and down, it is desirable to expire the
1076 association between host and exit server after NUM seconds. The default is
1077 1800 seconds (30 minutes).
1079 [[UpdateBridgesFromAuthority]] **UpdateBridgesFromAuthority** **0**|**1**::
1080 When set (along with UseBridges), Tor will try to fetch bridge descriptors
1081 from the configured bridge authorities when feasible. It will fall back to
1082 a direct request if the authority responds with a 404. (Default: 0)
1084 [[UseBridges]] **UseBridges** **0**|**1**::
1085 When set, Tor will fetch descriptors for each bridge listed in the "Bridge"
1086 config lines, and use these relays as both entry guards and directory
1087 guards. (Default: 0)
1089 [[UseEntryGuards]] **UseEntryGuards** **0**|**1**::
1090 If this option is set to 1, we pick a few long-term entry servers, and try
1091 to stick with them. This is desirable because constantly changing servers
1092 increases the odds that an adversary who owns some servers will observe a
1093 fraction of your paths. (Default: 1)
1095 [[UseEntryGuardsAsDirGuards]] **UseEntryGuardsAsDirGuards** **0**|**1**::
1096 If this option is set to 1, and UseEntryGuards is also set to 1,
1097 we try to use our entry guards as directory
1098 guards, and failing that, pick more nodes to act as our directory guards.
1099 This helps prevent an adversary from enumerating clients. It's only
1100 available for clients (non-relay, non-bridge) that aren't configured to
1101 download any non-default directory material. It doesn't currently
1102 do anything when we lack a live consensus. (Default: 1)
1104 [[NumEntryGuards]] **NumEntryGuards** __NUM__::
1105 If UseEntryGuards is set to 1, we will try to pick a total of NUM routers
1106 as long-term entries for our circuits. If NUM is 0, we try to learn
1107 the number from the NumEntryGuards consensus parameter, and default
1108 to 3 if the consensus parameter isn't set. (Default: 0)
1110 [[NumDirectoryGuards]] **NumDirectoryGuards** __NUM__::
1111 If UseEntryGuardsAsDirectoryGuards is enabled, we try to make sure we
1112 have at least NUM routers to use as directory guards. If this option
1113 is set to 0, use the value from the NumDirectoryGuards consensus
1114 parameter, falling back to the value from NumEntryGuards if the
1115 consensus parameter is 0 or isn't set. (Default: 0)
1117 [[GuardLifetime]] **GuardLifetime** __N__ **days**|**weeks**|**months**::
1118 If nonzero, and UseEntryGuards is set, minimum time to keep a guard before
1119 picking a new one. If zero, we use the GuardLifetime parameter from the
1120 consensus directory. No value here may be less than 1 month or greater
1121 than 5 years; out-of-range values are clamped. (Default: 0)
1123 [[SafeSocks]] **SafeSocks** **0**|**1**::
1124 When this option is enabled, Tor will reject application connections that
1125 use unsafe variants of the socks protocol -- ones that only provide an IP
1126 address, meaning the application is doing a DNS resolve first.
1127 Specifically, these are socks4 and socks5 when not doing remote DNS.
1130 [[TestSocks]] **TestSocks** **0**|**1**::
1131 When this option is enabled, Tor will make a notice-level log entry for
1132 each connection to the Socks port indicating whether the request used a
1133 safe socks protocol or an unsafe one (see above entry on SafeSocks). This
1134 helps to determine whether an application using Tor is possibly leaking
1135 DNS requests. (Default: 0)
1137 [[WarnUnsafeSocks]] **WarnUnsafeSocks** **0**|**1**::
1138 When this option is enabled, Tor will warn whenever a request is
1139 received that only contains an IP address instead of a hostname. Allowing
1140 applications to do DNS resolves themselves is usually a bad idea and
1141 can leak your location to attackers. (Default: 1)
1143 [[VirtualAddrNetworkIPv4]] **VirtualAddrNetworkIPv4** __Address__/__bits__ +
1145 [[VirtualAddrNetworkIPv6]] **VirtualAddrNetworkIPv6** [__Address__]/__bits__::
1146 When Tor needs to assign a virtual (unused) address because of a MAPADDRESS
1147 command from the controller or the AutomapHostsOnResolve feature, Tor
1148 picks an unassigned address from this range. (Defaults:
1149 127.192.0.0/10 and [FE80::]/10 respectively.) +
1151 When providing proxy server service to a network of computers using a tool
1152 like dns-proxy-tor, change the IPv4 network to "10.192.0.0/10" or
1153 "172.16.0.0/12" and change the IPv6 network to "[FC00]/7".
1154 The default **VirtualAddrNetwork** address ranges on a
1155 properly configured machine will route to the loopback or link-local
1157 local use, no change to the default VirtualAddrNetwork setting is needed.
1159 [[AllowNonRFC953Hostnames]] **AllowNonRFC953Hostnames** **0**|**1**::
1160 When this option is disabled, Tor blocks hostnames containing illegal
1161 characters (like @ and :) rather than sending them to an exit node to be
1162 resolved. This helps trap accidental attempts to resolve URLs and so on.
1165 [[AllowDotExit]] **AllowDotExit** **0**|**1**::
1166 If enabled, we convert "www.google.com.foo.exit" addresses on the
1167 SocksPort/TransPort/NATDPort into "www.google.com" addresses that exit from
1168 the node "foo". Disabled by default since attacking websites and exit
1169 relays can use it to manipulate your path selection. (Default: 0)
1171 [[FastFirstHopPK]] **FastFirstHopPK** **0**|**1**|**auto**::
1172 When this option is disabled, Tor uses the public key step for the first
1173 hop of creating circuits. Skipping it is generally safe since we have
1174 already used TLS to authenticate the relay and to establish forward-secure
1175 keys. Turning this option off makes circuit building a little
1176 slower. Setting this option to "auto" takes advice from the authorities
1177 in the latest consensus about whether to use this feature. +
1179 Note that Tor will always use the public key step for the first hop if it's
1180 operating as a relay, and it will never use the public key step if it
1181 doesn't yet know the onion key of the first hop. (Default: auto)
1183 [[TransPort]] **TransPort** \['address':]__port__|**auto** [_isolation flags_]::
1184 Open this port to listen for transparent proxy connections. Set this to
1185 0 if you don't want to allow transparent proxy connections. Set the port
1186 to "auto" to have Tor pick a port for you. This directive can be
1187 specified multiple times to bind to multiple addresses/ports. See
1188 SOCKSPort for an explanation of isolation flags. +
1190 TransPort requires OS support for transparent proxies, such as BSDs' pf or
1191 Linux's IPTables. If you're planning to use Tor as a transparent proxy for
1192 a network, you'll want to examine and change VirtualAddrNetwork from the
1193 default setting. You'll also want to set the TransListenAddress option for
1194 the network you'd like to proxy. (Default: 0)
1196 [[TransListenAddress]] **TransListenAddress** __IP__[:__PORT__]::
1197 Bind to this address to listen for transparent proxy connections. (Default:
1198 127.0.0.1). This is useful for exporting a transparent proxy server to an
1199 entire network. (DEPRECATED: As of 0.2.3.x-alpha, you can
1200 now use multiple TransPort entries, and provide addresses for TransPort
1201 entries, so TransListenAddress no longer has a purpose. For backward
1202 compatibility, TransListenAddress is only allowed when TransPort is just
1205 [[TransProxyType]] **TransProxyType** **default**|**TPROXY**|**ipfw**|**pf-divert**::
1206 TransProxyType may only be enabled when there is transparent proxy listener
1209 Set this to "TPROXY" if you wish to be able to use the TPROXY Linux module
1210 to transparently proxy connections that are configured using the TransPort
1211 option. This setting lets the listener on the TransPort accept connections
1212 for all addresses, even when the TransListenAddress is configured for an
1213 internal address. Detailed information on how to configure the TPROXY
1214 feature can be found in the Linux kernel source tree in the file
1215 Documentation/networking/tproxy.txt.
1217 Set this option to "ipfw" to use the FreeBSD ipfw interface.
1219 On *BSD operating systems when using pf, set this to "pf-divert" to take
1220 advantage of +divert-to+ rules, which do not modify the packets like
1221 +rdr-to+ rules do. Detailed information on how to configure pf to use
1222 +divert-to+ rules can be found in the pf.conf(5) manual page. On OpenBSD,
1223 +divert-to+ is available to use on versions greater than or equal to
1226 Set this to "default", or leave it unconfigured, to use regular IPTables
1227 on Linux, or to use pf +rdr-to+ rules on *BSD systems.
1229 (Default: "default".)
1231 [[NATDPort]] **NATDPort** \['address':]__port__|**auto** [_isolation flags_]::
1232 Open this port to listen for connections from old versions of ipfw (as
1233 included in old versions of FreeBSD, etc) using the NATD protocol.
1234 Use 0 if you don't want to allow NATD connections. Set the port
1235 to "auto" to have Tor pick a port for you. This directive can be
1236 specified multiple times to bind to multiple addresses/ports. See
1237 SOCKSPort for an explanation of isolation flags. +
1239 This option is only for people who cannot use TransPort. (Default: 0)
1241 [[NATDListenAddress]] **NATDListenAddress** __IP__[:__PORT__]::
1242 Bind to this address to listen for NATD connections. (DEPRECATED: As of
1243 0.2.3.x-alpha, you can now use multiple NATDPort entries, and provide
1244 addresses for NATDPort entries, so NATDListenAddress no longer has a
1245 purpose. For backward compatibility, NATDListenAddress is only allowed
1246 when NATDPort is just a port number.)
1248 [[AutomapHostsOnResolve]] **AutomapHostsOnResolve** **0**|**1**::
1249 When this option is enabled, and we get a request to resolve an address
1250 that ends with one of the suffixes in **AutomapHostsSuffixes**, we map an
1251 unused virtual address to that address, and return the new virtual address.
1252 This is handy for making ".onion" addresses work with applications that
1253 resolve an address and then connect to it. (Default: 0)
1255 [[AutomapHostsSuffixes]] **AutomapHostsSuffixes** __SUFFIX__,__SUFFIX__,__...__::
1256 A comma-separated list of suffixes to use with **AutomapHostsOnResolve**.
1257 The "." suffix is equivalent to "all addresses." (Default: .exit,.onion).
1259 [[DNSPort]] **DNSPort** \['address':]__port__|**auto** [_isolation flags_]::
1260 If non-zero, open this port to listen for UDP DNS requests, and resolve
1261 them anonymously. This port only handles A, AAAA, and PTR requests---it
1262 doesn't handle arbitrary DNS request types. Set the port to "auto" to
1263 have Tor pick a port for
1264 you. This directive can be specified multiple times to bind to multiple
1265 addresses/ports. See SOCKSPort for an explanation of isolation
1268 [[DNSListenAddress]] **DNSListenAddress** __IP__[:__PORT__]::
1269 Bind to this address to listen for DNS connections. (DEPRECATED: As of
1270 0.2.3.x-alpha, you can now use multiple DNSPort entries, and provide
1271 addresses for DNSPort entries, so DNSListenAddress no longer has a
1272 purpose. For backward compatibility, DNSListenAddress is only allowed
1273 when DNSPort is just a port number.)
1275 [[ClientDNSRejectInternalAddresses]] **ClientDNSRejectInternalAddresses** **0**|**1**::
1276 If true, Tor does not believe any anonymously retrieved DNS answer that
1277 tells it that an address resolves to an internal address (like 127.0.0.1 or
1278 192.168.0.1). This option prevents certain browser-based attacks; don't
1279 turn it off unless you know what you're doing. (Default: 1)
1281 [[ClientRejectInternalAddresses]] **ClientRejectInternalAddresses** **0**|**1**::
1282 If true, Tor does not try to fulfill requests to connect to an internal
1283 address (like 127.0.0.1 or 192.168.0.1) __unless a exit node is
1284 specifically requested__ (for example, via a .exit hostname, or a
1285 controller request). (Default: 1)
1287 [[DownloadExtraInfo]] **DownloadExtraInfo** **0**|**1**::
1288 If true, Tor downloads and caches "extra-info" documents. These documents
1289 contain information about servers other than the information in their
1290 regular router descriptors. Tor does not use this information for anything
1291 itself; to save bandwidth, leave this option turned off. (Default: 0)
1293 [[WarnPlaintextPorts]] **WarnPlaintextPorts** __port__,__port__,__...__::
1294 Tells Tor to issue a warnings whenever the user tries to make an anonymous
1295 connection to one of these ports. This option is designed to alert users
1296 to services that risk sending passwords in the clear. (Default:
1299 [[RejectPlaintextPorts]] **RejectPlaintextPorts** __port__,__port__,__...__::
1300 Like WarnPlaintextPorts, but instead of warning about risky port uses, Tor
1301 will instead refuse to make the connection. (Default: None)
1303 [[AllowSingleHopCircuits]] **AllowSingleHopCircuits** **0**|**1**::
1304 When this option is set, the attached Tor controller can use relays
1305 that have the **AllowSingleHopExits** option turned on to build
1306 one-hop Tor connections. (Default: 0)
1308 [[OptimisticData]] **OptimisticData** **0**|**1**|**auto**::
1309 When this option is set, and Tor is using an exit node that supports
1310 the feature, it will try optimistically to send data to the exit node
1311 without waiting for the exit node to report whether the connection
1312 succeeded. This can save a round-trip time for protocols like HTTP
1313 where the client talks first. If OptimisticData is set to **auto**,
1314 Tor will look at the UseOptimisticData parameter in the networkstatus.
1317 [[Tor2webMode]] **Tor2webMode** **0**|**1**::
1318 When this option is set, Tor connects to hidden services
1319 **non-anonymously**. This option also disables client connections to
1320 non-hidden-service hostnames through Tor. It **must only** be used when
1321 running a tor2web Hidden Service web proxy.
1322 To enable this option the compile time flag --enable-tor2webmode must be
1323 specified. (Default: 0)
1325 [[UseMicrodescriptors]] **UseMicrodescriptors** **0**|**1**|**auto**::
1326 Microdescriptors are a smaller version of the information that Tor needs
1327 in order to build its circuits. Using microdescriptors makes Tor clients
1328 download less directory information, thus saving bandwidth. Directory
1329 caches need to fetch regular descriptors and microdescriptors, so this
1330 option doesn't save any bandwidth for them. If this option is set to
1331 "auto" (recommended) then it is on for all clients that do not set
1332 FetchUselessDescriptors. (Default: auto)
1334 [[UseNTorHandshake]] **UseNTorHandshake** **0**|**1**|**auto**::
1335 The "ntor" circuit-creation handshake is faster and (we think) more
1336 secure than the original ("TAP") circuit handshake, but starting to use
1337 it too early might make your client stand out. If this option is 0, your
1338 Tor client won't use the ntor handshake. If it's 1, your Tor client
1339 will use the ntor handshake to extend circuits through servers that
1340 support it. If this option is "auto", then your client
1341 will use the ntor handshake once enough directory authorities recommend
1344 [[PathBiasCircThreshold]] **PathBiasCircThreshold** __NUM__ +
1346 [[PathBiasNoticeRate]] **PathBiasNoticeRate** __NUM__ +
1348 [[PathBiasWarnRate]] **PathBiasWarnRate** __NUM__ +
1350 [[PathBiasExtremeRate]] **PathBiasExtremeRate** __NUM__ +
1352 [[PathBiasDropGuards]] **PathBiasDropGuards** __NUM__ +
1354 [[PathBiasScaleThreshold]] **PathBiasScaleThreshold** __NUM__::
1355 These options override the default behavior of Tor's (**currently
1356 experimental**) path bias detection algorithm. To try to find broken or
1357 misbehaving guard nodes, Tor looks for nodes where more than a certain
1358 fraction of circuits through that guard fail to get built.
1360 The PathBiasCircThreshold option controls how many circuits we need to build
1361 through a guard before we make these checks. The PathBiasNoticeRate,
1362 PathBiasWarnRate and PathBiasExtremeRate options control what fraction of
1363 circuits must succeed through a guard so we won't write log messages.
1364 If less than PathBiasExtremeRate circuits succeed *and* PathBiasDropGuards
1365 is set to 1, we disable use of that guard. +
1367 When we have seen more than PathBiasScaleThreshold
1368 circuits through a guard, we scale our observations by 0.5 (governed by
1369 the consensus) so that new observations don't get swamped by old ones. +
1371 By default, or if a negative value is provided for one of these options,
1372 Tor uses reasonable defaults from the networkstatus consensus document.
1373 If no defaults are available there, these options default to 150, .70,
1374 .50, .30, 0, and 300 respectively.
1376 [[PathBiasUseThreshold]] **PathBiasUseThreshold** __NUM__ +
1378 [[PathBiasNoticeUseRate]] **PathBiasNoticeUseRate** __NUM__ +
1380 [[PathBiasExtremeUseRate]] **PathBiasExtremeUseRate** __NUM__ +
1382 [[PathBiasScaleUseThreshold]] **PathBiasScaleUseThreshold** __NUM__::
1383 Similar to the above options, these options override the default behavior
1384 of Tor's (**currently experimental**) path use bias detection algorithm.
1386 Where as the path bias parameters govern thresholds for successfully
1387 building circuits, these four path use bias parameters govern thresholds
1388 only for circuit usage. Circuits which receive no stream usage
1389 are not counted by this detection algorithm. A used circuit is considered
1390 successful if it is capable of carrying streams or otherwise receiving
1391 well-formed responses to RELAY cells.
1393 By default, or if a negative value is provided for one of these options,
1394 Tor uses reasonable defaults from the networkstatus consensus document.
1395 If no defaults are available there, these options default to 20, .80,
1396 .60, and 100, respectively.
1398 [[ClientUseIPv6]] **ClientUseIPv6** **0**|**1**::
1399 If this option is set to 1, Tor might connect to entry nodes over
1400 IPv6. Note that clients configured with an IPv6 address in a
1401 **Bridge** line will try connecting over IPv6 even if
1402 **ClientUseIPv6** is set to 0. (Default: 0)
1404 [[ClientPreferIPv6ORPort]] **ClientPreferIPv6ORPort** **0**|**1**::
1405 If this option is set to 1, Tor prefers an OR port with an IPv6
1406 address over one with IPv4 if a given entry node has both. Other
1407 things may influence the choice. This option breaks a tie to the
1408 favor of IPv6. (Default: 0)
1410 [[PathsNeededToBuildCircuits]] **PathsNeededToBuildCircuits** __NUM__::
1411 Tor clients don't build circuits for user traffic until they know
1412 about enough of the network so that they could potentially construct
1413 enough of the possible paths through the network. If this option
1414 is set to a fraction between 0.25 and 0.95, Tor won't build circuits
1415 until it has enough descriptors or microdescriptors to construct
1416 that fraction of possible paths. Note that setting this option too low
1417 can make your Tor client less anonymous, and setting it too high can
1418 prevent your Tor client from bootstrapping. If this option is negative,
1419 Tor will use a default value chosen by the directory
1420 authorities. (Default: -1.)
1422 [[Support022HiddenServices]] **Support022HiddenServices** **0**|**1**|**auto**::
1423 Tor hidden services running versions before 0.2.3.x required clients to
1424 send timestamps, which can potentially be used to distinguish clients
1425 whose view of the current time is skewed. If this option is set to 0, we
1426 do not send this timestamp, and hidden services on obsolete Tor versions
1427 will not work. If this option is set to 1, we send the timestamp. If
1428 this option is "auto", we take a recommendation from the latest consensus
1429 document. (Default: auto)
1435 The following options are useful only for servers (that is, if ORPort
1438 [[Address]] **Address** __address__::
1439 The IP address or fully qualified domain name of this server (e.g.
1440 moria.mit.edu). You can leave this unset, and Tor will guess your IP
1441 address. This IP address is the one used to tell clients and other
1442 servers where to find your Tor server; it doesn't affect the IP that your
1443 Tor client binds to. To bind to a different address, use the
1444 *ListenAddress and OutboundBindAddress options.
1446 [[AllowSingleHopExits]] **AllowSingleHopExits** **0**|**1**::
1447 This option controls whether clients can use this server as a single hop
1448 proxy. If set to 1, clients can use this server as an exit even if it is
1449 the only hop in the circuit. Note that most clients will refuse to use
1450 servers that set this option, since most clients have
1451 ExcludeSingleHopRelays set. (Default: 0)
1453 [[AssumeReachable]] **AssumeReachable** **0**|**1**::
1454 This option is used when bootstrapping a new Tor network. If set to 1,
1455 don't do self-reachability testing; just upload your server descriptor
1456 immediately. If **AuthoritativeDirectory** is also set, this option
1457 instructs the dirserver to bypass remote reachability testing too and list
1458 all connected servers as running.
1460 [[BridgeRelay]] **BridgeRelay** **0**|**1**::
1461 Sets the relay to act as a "bridge" with respect to relaying connections
1462 from bridge users to the Tor network. It mainly causes Tor to publish a
1463 server descriptor to the bridge database, rather than publishing a relay
1464 descriptor to the public directory authorities.
1466 [[ContactInfo]] **ContactInfo** __email_address__::
1467 Administrative contact information for this relay or bridge. This line
1468 can be used to contact you if your relay or bridge is misconfigured or
1469 something else goes wrong. Note that we archive and publish all
1470 descriptors containing these lines and that Google indexes them, so
1471 spammers might also collect them. You may want to obscure the fact
1472 that it's an email address and/or generate a new address for this
1475 [[ExitPolicy]] **ExitPolicy** __policy__,__policy__,__...__::
1476 Set an exit policy for this server. Each policy is of the form
1477 "**accept**|**reject** __ADDR__[/__MASK__][:__PORT__]". If /__MASK__ is
1478 omitted then this policy just applies to the host given. Instead of giving
1479 a host or network you can also use "\*" to denote the universe (0.0.0.0/0).
1480 __PORT__ can be a single port number, an interval of ports
1481 "__FROM_PORT__-__TO_PORT__", or "\*". If __PORT__ is omitted, that means
1484 For example, "accept 18.7.22.69:\*,reject 18.0.0.0/8:\*,accept \*:\*" would
1485 reject any traffic destined for MIT except for web.mit.edu, and accept
1488 To specify all internal and link-local networks (including 0.0.0.0/8,
1489 169.254.0.0/16, 127.0.0.0/8, 192.168.0.0/16, 10.0.0.0/8, and
1490 172.16.0.0/12), you can use the "private" alias instead of an address.
1491 These addresses are rejected by default (at the beginning of your exit
1492 policy), along with your public IP address, unless you set the
1493 ExitPolicyRejectPrivate config option to 0. For example, once you've done
1494 that, you could allow HTTP to 127.0.0.1 and block all other connections to
1495 internal networks with "accept 127.0.0.1:80,reject private:\*", though that
1496 may also allow connections to your own computer that are addressed to its
1497 public (external) IP address. See RFC 1918 and RFC 3330 for more details
1498 about internal and reserved IP address space. +
1500 Tor also allow IPv6 exit policy entries. For instance, "reject6 [FC00::]/7:*"
1501 rejects all destinations that share 7 most significant bit prefix with
1502 address FC00::. Respectively, "accept6 [C000::]/3:*" accepts all destinations
1503 that share 3 most significant bit prefix with address C000::. +
1505 This directive can be specified multiple times so you don't have to put it
1508 Policies are considered first to last, and the first match wins. If you
1509 want to \_replace_ the default exit policy, end your exit policy with
1510 either a reject \*:* or an accept \*:*. Otherwise, you're \_augmenting_
1511 (prepending to) the default exit policy. The default exit policy is: +
1525 [[ExitPolicyRejectPrivate]] **ExitPolicyRejectPrivate** **0**|**1**::
1526 Reject all private (local) networks, along with your own public IP address,
1527 at the beginning of your exit policy. See above entry on ExitPolicy.
1530 [[IPv6Exit]] **IPv6Exit** **0**|**1**::
1531 If set, and we are an exit node, allow clients to use us for IPv6
1532 traffic. (Default: 0)
1534 [[MaxOnionQueueDelay]] **MaxOnionQueueDelay** __NUM__ [**msec**|**second**]::
1535 If we have more onionskins queued for processing than we can process in
1536 this amount of time, reject new ones. (Default: 1750 msec)
1538 [[MyFamily]] **MyFamily** __node__,__node__,__...__::
1539 Declare that this Tor server is controlled or administered by a group or
1540 organization identical or similar to that of the other servers, defined by
1541 their identity fingerprints or nicknames. When two servers both declare
1542 that they are in the same \'family', Tor clients will not use them in the
1543 same circuit. (Each server only needs to list the other servers in its
1544 family; it doesn't need to list itself, but it won't hurt.) Do not list
1545 any bridge relay as it would compromise its concealment.
1547 When listing a node, it's better to list it by fingerprint than by
1548 nickname: fingerprints are more reliable.
1550 [[Nickname]] **Nickname** __name__::
1551 Set the server's nickname to \'name'. Nicknames must be between 1 and 19
1552 characters inclusive, and must contain only the characters [a-zA-Z0-9].
1554 [[NumCPUs]] **NumCPUs** __num__::
1555 How many processes to use at once for decrypting onionskins and other
1556 parallelizable operations. If this is set to 0, Tor will try to detect
1557 how many CPUs you have, defaulting to 1 if it can't tell. (Default: 0)
1559 [[ORPort]] **ORPort** \['address':]__PORT__|**auto** [_flags_]::
1560 Advertise this port to listen for connections from Tor clients and
1561 servers. This option is required to be a Tor server.
1562 Set it to "auto" to have Tor pick a port for you. Set it to 0 to not
1563 run an ORPort at all. This option can occur more than once. (Default: 0)
1565 Tor recognizes these flags on each ORPort:
1567 By default, we bind to a port and tell our users about it. If
1568 NoAdvertise is specified, we don't advertise, but listen anyway. This
1569 can be useful if the port everybody will be connecting to (for
1570 example, one that's opened on our firewall) is somewhere else.
1572 By default, we bind to a port and tell our users about it. If
1573 NoListen is specified, we don't bind, but advertise anyway. This
1574 can be useful if something else (for example, a firewall's port
1575 forwarding configuration) is causing connections to reach us.
1577 If the address is absent, or resolves to both an IPv4 and an IPv6
1578 address, only listen to the IPv4 address.
1580 If the address is absent, or resolves to both an IPv4 and an IPv6
1581 address, only listen to the IPv6 address.
1583 For obvious reasons, NoAdvertise and NoListen are mutually exclusive, and
1584 IPv4Only and IPv6Only are mutually exclusive.
1586 [[ORListenAddress]] **ORListenAddress** __IP__[:__PORT__]::
1587 Bind to this IP address to listen for connections from Tor clients and
1588 servers. If you specify a port, bind to this port rather than the one
1589 specified in ORPort. (Default: 0.0.0.0) This directive can be specified
1590 multiple times to bind to multiple addresses/ports.
1592 This option is deprecated; you can get the same behavior with ORPort now
1593 that it supports NoAdvertise and explicit addresses.
1595 [[PortForwarding]] **PortForwarding** **0**|**1**::
1596 Attempt to automatically forward the DirPort and ORPort on a NAT router
1597 connecting this Tor server to the Internet. If set, Tor will try both
1598 NAT-PMP (common on Apple routers) and UPnP (common on routers from other
1599 manufacturers). (Default: 0)
1601 [[PortForwardingHelper]] **PortForwardingHelper** __filename__|__pathname__::
1602 If PortForwarding is set, use this executable to configure the forwarding.
1603 If set to a filename, the system path will be searched for the executable.
1604 If set to a path, only the specified path will be executed.
1605 (Default: tor-fw-helper)
1607 [[PublishServerDescriptor]] **PublishServerDescriptor** **0**|**1**|**v3**|**bridge**,**...**::
1608 This option specifies which descriptors Tor will publish when acting as
1610 choose multiple arguments, separated by commas.
1612 If this option is set to 0, Tor will not publish its
1613 descriptors to any directories. (This is useful if you're testing
1614 out your server, or if you're using a Tor controller that handles directory
1615 publishing for you.) Otherwise, Tor will publish its descriptors of all
1616 type(s) specified. The default is "1",
1617 which means "if running as a server, publish the
1618 appropriate descriptors to the authorities".
1620 [[ShutdownWaitLength]] **ShutdownWaitLength** __NUM__::
1621 When we get a SIGINT and we're a server, we begin shutting down:
1622 we close listeners and start refusing new circuits. After **NUM**
1623 seconds, we exit. If we get a second SIGINT, we exit immediately.
1624 (Default: 30 seconds)
1626 [[SSLKeyLifetime]] **SSLKeyLifetime** __N__ **minutes**|**hours**|**days**|**weeks**::
1627 When creating a link certificate for our outermost SSL handshake,
1628 set its lifetime to this amount of time. If set to 0, Tor will choose
1629 some reasonable random defaults. (Default: 0)
1631 [[HeartbeatPeriod]] **HeartbeatPeriod** __N__ **minutes**|**hours**|**days**|**weeks**::
1632 Log a heartbeat message every **HeartbeatPeriod** seconds. This is
1633 a log level __notice__ message, designed to let you know your Tor
1634 server is still alive and doing useful things. Settings this
1635 to 0 will disable the heartbeat. (Default: 6 hours)
1637 [[AccountingMax]] **AccountingMax** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**|**TBytes**::
1638 Limits the max number of bytes sent and received within a set time period
1639 using a given calculation rule (see: AccountingStart, AccountingRule).
1640 Useful if you need to stay under a specific bandwidth. By default, the
1641 number used for calculation is the max of either the bytes sent or
1642 received. For example, with AccountingMax set to 1 GByte, a server
1643 could send 900 MBytes and receive 800 MBytes and continue running.
1644 It will only hibernate once one of the two reaches 1 GByte. This can
1645 be changed to use the sum of the both bytes received and sent by setting
1646 the AccountingRule option to "sum" (total bandwidth in/out). When the
1647 number of bytes remaining gets low, Tor will stop accepting new connections
1648 and circuits. When the number of bytes is exhausted, Tor will hibernate
1649 until some time in the next accounting period. To prevent all servers
1650 from waking at the same time, Tor will also wait until a random point
1651 in each period before waking up. If you have bandwidth cost issues,
1652 enabling hibernation is preferable to setting a low bandwidth, since
1653 it provides users with a collection of fast servers that are up some
1654 of the time, which is more useful than a set of slow servers that are
1657 [[AccountingRule]] **AccountingRule** **sum**|**max**::
1658 How we determine when our AccountingMax has been reached (when we
1659 should hibernate) during a time interval. Set to "max" to calculate
1660 using the higher of either the sent or received bytes (this is the
1661 default functionality). Set to "sum" to calculate using the sent
1662 plus received bytes. (Default: max)
1664 [[AccountingStart]] **AccountingStart** **day**|**week**|**month** [__day__] __HH:MM__::
1665 Specify how long accounting periods last. If **month** is given, each
1666 accounting period runs from the time __HH:MM__ on the __dayth__ day of one
1667 month to the same day and time of the next. (The day must be between 1 and
1668 28.) If **week** is given, each accounting period runs from the time __HH:MM__
1669 of the __dayth__ day of one week to the same day and time of the next week,
1670 with Monday as day 1 and Sunday as day 7. If **day** is given, each
1671 accounting period runs from the time __HH:MM__ each day to the same time on
1672 the next day. All times are local, and given in 24-hour time. (Default:
1675 [[RefuseUnknownExits]] **RefuseUnknownExits** **0**|**1**|**auto**::
1676 Prevent nodes that don't appear in the consensus from exiting using this
1677 relay. If the option is 1, we always block exit attempts from such
1678 nodes; if it's 0, we never do, and if the option is "auto", then we do
1679 whatever the authorities suggest in the consensus (and block if the consensus
1680 is quiet on the issue). (Default: auto)
1682 [[ServerDNSResolvConfFile]] **ServerDNSResolvConfFile** __filename__::
1683 Overrides the default DNS configuration with the configuration in
1684 __filename__. The file format is the same as the standard Unix
1685 "**resolv.conf**" file (7). This option, like all other ServerDNS options,
1686 only affects name lookups that your server does on behalf of clients.
1687 (Defaults to use the system DNS configuration.)
1689 [[ServerDNSAllowBrokenConfig]] **ServerDNSAllowBrokenConfig** **0**|**1**::
1690 If this option is false, Tor exits immediately if there are problems
1691 parsing the system DNS configuration or connecting to nameservers.
1692 Otherwise, Tor continues to periodically retry the system nameservers until
1693 it eventually succeeds. (Default: 1)
1695 [[ServerDNSSearchDomains]] **ServerDNSSearchDomains** **0**|**1**::
1696 If set to 1, then we will search for addresses in the local search domain.
1697 For example, if this system is configured to believe it is in
1698 "example.com", and a client tries to connect to "www", the client will be
1699 connected to "www.example.com". This option only affects name lookups that
1700 your server does on behalf of clients. (Default: 0)
1702 [[ServerDNSDetectHijacking]] **ServerDNSDetectHijacking** **0**|**1**::
1703 When this option is set to 1, we will test periodically to determine
1704 whether our local nameservers have been configured to hijack failing DNS
1705 requests (usually to an advertising site). If they are, we will attempt to
1706 correct this. This option only affects name lookups that your server does
1707 on behalf of clients. (Default: 1)
1709 [[ServerDNSTestAddresses]] **ServerDNSTestAddresses** __address__,__address__,__...__::
1710 When we're detecting DNS hijacking, make sure that these __valid__ addresses
1711 aren't getting redirected. If they are, then our DNS is completely useless,
1712 and we'll reset our exit policy to "reject *:*". This option only affects
1713 name lookups that your server does on behalf of clients. (Default:
1714 "www.google.com, www.mit.edu, www.yahoo.com, www.slashdot.org")
1716 [[ServerDNSAllowNonRFC953Hostnames]] **ServerDNSAllowNonRFC953Hostnames** **0**|**1**::
1717 When this option is disabled, Tor does not try to resolve hostnames
1718 containing illegal characters (like @ and :) rather than sending them to an
1719 exit node to be resolved. This helps trap accidental attempts to resolve
1720 URLs and so on. This option only affects name lookups that your server does
1721 on behalf of clients. (Default: 0)
1723 [[BridgeRecordUsageByCountry]] **BridgeRecordUsageByCountry** **0**|**1**::
1724 When this option is enabled and BridgeRelay is also enabled, and we have
1725 GeoIP data, Tor keeps a per-country count of how many client
1726 addresses have contacted it so that it can help the bridge authority guess
1727 which countries have blocked access to it. (Default: 1)
1729 [[ServerDNSRandomizeCase]] **ServerDNSRandomizeCase** **0**|**1**::
1730 When this option is set, Tor sets the case of each character randomly in
1731 outgoing DNS requests, and makes sure that the case matches in DNS replies.
1732 This so-called "0x20 hack" helps resist some types of DNS poisoning attack.
1733 For more information, see "Increased DNS Forgery Resistance through
1734 0x20-Bit Encoding". This option only affects name lookups that your server
1735 does on behalf of clients. (Default: 1)
1737 [[GeoIPFile]] **GeoIPFile** __filename__::
1738 A filename containing IPv4 GeoIP data, for use with by-country statistics.
1740 [[GeoIPv6File]] **GeoIPv6File** __filename__::
1741 A filename containing IPv6 GeoIP data, for use with by-country statistics.
1743 [[TLSECGroup]] **TLSECGroup** **P224**|**P256**::
1744 What EC group should we try to use for incoming TLS connections?
1745 P224 is faster, but makes us stand out more. Has no effect if
1746 we're a client, or if our OpenSSL version lacks support for ECDHE.
1749 [[CellStatistics]] **CellStatistics** **0**|**1**::
1750 When this option is enabled, Tor writes statistics on the mean time that
1751 cells spend in circuit queues to disk every 24 hours. (Default: 0)
1753 [[DirReqStatistics]] **DirReqStatistics** **0**|**1**::
1754 When this option is enabled, a Tor directory writes statistics on the
1755 number and response time of network status requests to disk every 24
1758 [[EntryStatistics]] **EntryStatistics** **0**|**1**::
1759 When this option is enabled, Tor writes statistics on the number of
1760 directly connecting clients to disk every 24 hours. (Default: 0)
1762 [[ExitPortStatistics]] **ExitPortStatistics** **0**|**1**::
1763 When this option is enabled, Tor writes statistics on the number of relayed
1764 bytes and opened stream per exit port to disk every 24 hours. (Default: 0)
1766 [[ConnDirectionStatistics]] **ConnDirectionStatistics** **0**|**1**::
1767 When this option is enabled, Tor writes statistics on the bidirectional use
1768 of connections to disk every 24 hours. (Default: 0)
1770 [[ExtraInfoStatistics]] **ExtraInfoStatistics** **0**|**1**::
1771 When this option is enabled, Tor includes previously gathered statistics in
1772 its extra-info documents that it uploads to the directory authorities.
1775 [[ExtendAllowPrivateAddresses]] **ExtendAllowPrivateAddresses** **0**|**1**::
1776 When this option is enabled, Tor routers allow EXTEND request to
1777 localhost, RFC1918 addresses, and so on. This can create security issues;
1778 you should probably leave it off. (Default: 0)
1780 [[MaxMemInQueues]] **MaxMemInQueues** __N__ **bytes**|**KB**|**MB**|**GB**::
1781 This option configures a threshold above which Tor will assume that it
1782 needs to stop queueing or buffering data because it's about to run out of
1783 memory. If it hits this threshold, it will begin killing circuits until
1784 it has recovered at least 10% of this memory. Do not set this option too
1785 low, or your relay may be unreliable under load. This option only
1786 affects some queues, so the actual process size will be larger than
1787 this. If this option is set to 0, Tor will try to pick a reasonable
1788 default based on your system's physical memory. (Default: 0)
1790 DIRECTORY SERVER OPTIONS
1791 ------------------------
1793 The following options are useful only for directory servers (that is,
1794 if DirPort is non-zero):
1796 [[DirPortFrontPage]] **DirPortFrontPage** __FILENAME__::
1797 When this option is set, it takes an HTML file and publishes it as "/" on
1798 the DirPort. Now relay operators can provide a disclaimer without needing
1799 to set up a separate webserver. There's a sample disclaimer in
1800 contrib/operator-tools/tor-exit-notice.html.
1802 [[HidServDirectoryV2]] **HidServDirectoryV2** **0**|**1**::
1803 When this option is set, Tor accepts and serves v2 hidden service
1804 descriptors. Setting DirPort is not required for this, because clients
1805 connect via the ORPort by default. (Default: 1)
1807 [[DirPort]] **DirPort** \['address':]__PORT__|**auto** [_flags_]::
1808 If this option is nonzero, advertise the directory service on this port.
1809 Set it to "auto" to have Tor pick a port for you. This option can occur
1810 more than once, but only one advertised DirPort is supported: all
1811 but one DirPort must have the **NoAdvertise** flag set. (Default: 0)
1813 The same flags are supported here as are supported by ORPort.
1815 [[DirListenAddress]] **DirListenAddress** __IP__[:__PORT__]::
1816 Bind the directory service to this address. If you specify a port, bind to
1817 this port rather than the one specified in DirPort. (Default: 0.0.0.0)
1818 This directive can be specified multiple times to bind to multiple
1821 This option is deprecated; you can get the same behavior with DirPort now
1822 that it supports NoAdvertise and explicit addresses.
1824 [[DirPolicy]] **DirPolicy** __policy__,__policy__,__...__::
1825 Set an entrance policy for this server, to limit who can connect to the
1826 directory ports. The policies have the same form as exit policies above,
1827 except that port specifiers are ignored. Any address not matched by
1828 some entry in the policy is accepted.
1831 DIRECTORY AUTHORITY SERVER OPTIONS
1832 ----------------------------------
1834 The following options enable operation as a directory authority, and
1835 control how Tor behaves as a directory authority. You should not need
1836 to adjust any of them if you're running a regular relay or exit server
1837 on the public Tor network.
1839 [[AuthoritativeDirectory]] **AuthoritativeDirectory** **0**|**1**::
1840 When this option is set to 1, Tor operates as an authoritative directory
1841 server. Instead of caching the directory, it generates its own list of
1842 good servers, signs it, and sends that to the clients. Unless the clients
1843 already have you listed as a trusted directory, you probably do not want
1844 to set this option. Please coordinate with the other admins at
1845 tor-ops@torproject.org if you think you should be a directory.
1847 [[V3AuthoritativeDirectory]] **V3AuthoritativeDirectory** **0**|**1**::
1848 When this option is set in addition to **AuthoritativeDirectory**, Tor
1849 generates version 3 network statuses and serves descriptors, etc as
1850 described in doc/spec/dir-spec.txt (for Tor clients and servers running at
1853 [[VersioningAuthoritativeDirectory]] **VersioningAuthoritativeDirectory** **0**|**1**::
1854 When this option is set to 1, Tor adds information on which versions of
1855 Tor are still believed safe for use to the published directory. Each
1856 version 1 authority is automatically a versioning authority; version 2
1857 authorities provide this service optionally. See **RecommendedVersions**,
1858 **RecommendedClientVersions**, and **RecommendedServerVersions**.
1860 [[RecommendedVersions]] **RecommendedVersions** __STRING__::
1861 STRING is a comma-separated list of Tor versions currently believed to be
1862 safe. The list is included in each directory, and nodes which pull down the
1863 directory learn whether they need to upgrade. This option can appear
1864 multiple times: the values from multiple lines are spliced together. When
1865 this is set then **VersioningAuthoritativeDirectory** should be set too.
1867 [[RecommendedClientVersions]] **RecommendedClientVersions** __STRING__::
1868 STRING is a comma-separated list of Tor versions currently believed to be
1869 safe for clients to use. This information is included in version 2
1870 directories. If this is not set then the value of **RecommendedVersions**
1871 is used. When this is set then **VersioningAuthoritativeDirectory** should
1874 [[BridgeAuthoritativeDir]] **BridgeAuthoritativeDir** **0**|**1**::
1875 When this option is set in addition to **AuthoritativeDirectory**, Tor
1876 accepts and serves router descriptors, but it caches and serves the main
1877 networkstatus documents rather than generating its own. (Default: 0)
1879 [[MinUptimeHidServDirectoryV2]] **MinUptimeHidServDirectoryV2** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
1880 Minimum uptime of a v2 hidden service directory to be accepted as such by
1881 authoritative directories. (Default: 25 hours)
1883 [[RecommendedServerVersions]] **RecommendedServerVersions** __STRING__::
1884 STRING is a comma-separated list of Tor versions currently believed to be
1885 safe for servers to use. This information is included in version 2
1886 directories. If this is not set then the value of **RecommendedVersions**
1887 is used. When this is set then **VersioningAuthoritativeDirectory** should
1890 [[ConsensusParams]] **ConsensusParams** __STRING__::
1891 STRING is a space-separated list of key=value pairs that Tor will include
1892 in the "params" line of its networkstatus vote.
1894 [[DirAllowPrivateAddresses]] **DirAllowPrivateAddresses** **0**|**1**::
1895 If set to 1, Tor will accept router descriptors with arbitrary "Address"
1896 elements. Otherwise, if the address is not an IP address or is a private IP
1897 address, it will reject the router descriptor. (Default: 0)
1899 [[AuthDirBadExit]] **AuthDirBadExit** __AddressPattern...__::
1900 Authoritative directories only. A set of address patterns for servers that
1901 will be listed as bad exits in any network status document this authority
1902 publishes, if **AuthDirListBadExits** is set.
1904 (The address pattern syntax here and in the options below
1905 is the same as for exit policies, except that you don't need to say
1906 "accept" or "reject", and ports are not needed.)
1908 [[AuthDirInvalid]] **AuthDirInvalid** __AddressPattern...__::
1909 Authoritative directories only. A set of address patterns for servers that
1910 will never be listed as "valid" in any network status document that this
1911 authority publishes.
1913 [[AuthDirReject]] **AuthDirReject** __AddressPattern__...::
1914 Authoritative directories only. A set of address patterns for servers that
1915 will never be listed at all in any network status document that this
1916 authority publishes, or accepted as an OR address in any descriptor
1917 submitted for publication by this authority.
1919 [[AuthDirBadExitCCs]] **AuthDirBadExitCCs** __CC__,... +
1921 [[AuthDirInvalidCCs]] **AuthDirInvalidCCs** __CC__,... +
1923 [[AuthDirRejectCCs]] **AuthDirRejectCCs** __CC__,...::
1924 Authoritative directories only. These options contain a comma-separated
1925 list of country codes such that any server in one of those country codes
1926 will be marked as a bad exit/invalid for use, or rejected
1929 [[AuthDirListBadExits]] **AuthDirListBadExits** **0**|**1**::
1930 Authoritative directories only. If set to 1, this directory has some
1931 opinion about which nodes are unsuitable as exit nodes. (Do not set this to
1932 1 unless you plan to list non-functioning exits as bad; otherwise, you are
1933 effectively voting in favor of every declared exit as an exit.)
1935 [[AuthDirMaxServersPerAddr]] **AuthDirMaxServersPerAddr** __NUM__::
1936 Authoritative directories only. The maximum number of servers that we will
1937 list as acceptable on a single IP address. Set this to "0" for "no limit".
1940 [[AuthDirMaxServersPerAuthAddr]] **AuthDirMaxServersPerAuthAddr** __NUM__::
1941 Authoritative directories only. Like AuthDirMaxServersPerAddr, but applies
1942 to addresses shared with directory authorities. (Default: 5)
1944 [[AuthDirFastGuarantee]] **AuthDirFastGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
1945 Authoritative directories only. If non-zero, always vote the
1946 Fast flag for any relay advertising this amount of capacity or
1947 more. (Default: 100 KBytes)
1949 [[AuthDirGuardBWGuarantee]] **AuthDirGuardBWGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
1950 Authoritative directories only. If non-zero, this advertised capacity
1951 or more is always sufficient to satisfy the bandwidth requirement
1952 for the Guard flag. (Default: 250 KBytes)
1954 [[BridgePassword]] **BridgePassword** __Password__::
1955 If set, contains an HTTP authenticator that tells a bridge authority to
1956 serve all requested bridge information. Used by the (only partially
1957 implemented) "bridge community" design, where a community of bridge
1958 relay operators all use an alternate bridge directory authority,
1959 and their target user audience can periodically fetch the list of
1960 available community bridges to stay up-to-date. (Default: not set)
1962 [[V3AuthVotingInterval]] **V3AuthVotingInterval** __N__ **minutes**|**hours**::
1963 V3 authoritative directories only. Configures the server's preferred voting
1964 interval. Note that voting will __actually__ happen at an interval chosen
1965 by consensus from all the authorities' preferred intervals. This time
1966 SHOULD divide evenly into a day. (Default: 1 hour)
1968 [[V3AuthVoteDelay]] **V3AuthVoteDelay** __N__ **minutes**|**hours**::
1969 V3 authoritative directories only. Configures the server's preferred delay
1970 between publishing its vote and assuming it has all the votes from all the
1971 other authorities. Note that the actual time used is not the server's
1972 preferred time, but the consensus of all preferences. (Default: 5 minutes)
1974 [[V3AuthDistDelay]] **V3AuthDistDelay** __N__ **minutes**|**hours**::
1975 V3 authoritative directories only. Configures the server's preferred delay
1976 between publishing its consensus and signature and assuming it has all the
1977 signatures from all the other authorities. Note that the actual time used
1978 is not the server's preferred time, but the consensus of all preferences.
1979 (Default: 5 minutes)
1981 [[V3AuthNIntervalsValid]] **V3AuthNIntervalsValid** __NUM__::
1982 V3 authoritative directories only. Configures the number of VotingIntervals
1983 for which each consensus should be valid for. Choosing high numbers
1984 increases network partitioning risks; choosing low numbers increases
1985 directory traffic. Note that the actual number of intervals used is not the
1986 server's preferred number, but the consensus of all preferences. Must be at
1987 least 2. (Default: 3)
1989 [[V3BandwidthsFile]] **V3BandwidthsFile** __FILENAME__::
1990 V3 authoritative directories only. Configures the location of the
1991 bandwidth-authority generated file storing information on relays' measured
1992 bandwidth capacities. (Default: unset)
1994 [[V3AuthUseLegacyKey]] **V3AuthUseLegacyKey** **0**|**1**::
1995 If set, the directory authority will sign consensuses not only with its
1996 own signing key, but also with a "legacy" key and certificate with a
1997 different identity. This feature is used to migrate directory authority
1998 keys in the event of a compromise. (Default: 0)
2000 [[RephistTrackTime]] **RephistTrackTime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2001 Tells an authority, or other node tracking node reliability and history,
2002 that fine-grained information about nodes can be discarded when it hasn't
2003 changed for a given amount of time. (Default: 24 hours)
2005 [[VoteOnHidServDirectoriesV2]] **VoteOnHidServDirectoriesV2** **0**|**1**::
2006 When this option is set in addition to **AuthoritativeDirectory**, Tor
2007 votes on whether to accept relays as hidden service directories.
2010 [[AuthDirHasIPv6Connectivity]] **AuthDirHasIPv6Connectivity** **0**|**1**::
2011 Authoritative directories only. When set to 0, OR ports with an
2012 IPv6 address are being accepted without reachability testing.
2013 When set to 1, IPv6 OR ports are being tested just like IPv4 OR
2016 [[MinMeasuredBWsForAuthToIgnoreAdvertised]] **MinMeasuredBWsForAuthToIgnoreAdvertised** __N__::
2017 A total value, in abstract bandwidth units, describing how much
2018 measured total bandwidth an authority should have observed on the network
2019 before it will treat advertised bandwidths as wholly
2020 unreliable. (Default: 500)
2022 HIDDEN SERVICE OPTIONS
2023 ----------------------
2025 The following options are used to configure a hidden service.
2027 [[HiddenServiceDir]] **HiddenServiceDir** __DIRECTORY__::
2028 Store data files for a hidden service in DIRECTORY. Every hidden service
2029 must have a separate directory. You may use this option multiple times to
2030 specify multiple services. DIRECTORY must be an existing directory.
2032 [[HiddenServicePort]] **HiddenServicePort** __VIRTPORT__ [__TARGET__]::
2033 Configure a virtual port VIRTPORT for a hidden service. You may use this
2034 option multiple times; each time applies to the service using the most
2035 recent HiddenServiceDir. By default, this option maps the virtual port to
2036 the same port on 127.0.0.1 over TCP. You may override the target port,
2037 address, or both by specifying a target of addr, port, or addr:port.
2038 You may also have multiple lines with the same VIRTPORT: when a user
2039 connects to that VIRTPORT, one of the TARGETs from those lines will be
2042 [[PublishHidServDescriptors]] **PublishHidServDescriptors** **0**|**1**::
2043 If set to 0, Tor will run any hidden services you configure, but it won't
2044 advertise them to the rendezvous directory. This option is only useful if
2045 you're using a Tor controller that handles hidserv publishing for you.
2048 [[HiddenServiceVersion]] **HiddenServiceVersion** __version__,__version__,__...__::
2049 A list of rendezvous service descriptor versions to publish for the hidden
2050 service. Currently, only version 2 is supported. (Default: 2)
2052 [[HiddenServiceAuthorizeClient]] **HiddenServiceAuthorizeClient** __auth-type__ __client-name__,__client-name__,__...__::
2053 If configured, the hidden service is accessible for authorized clients
2054 only. The auth-type can either be \'basic' for a general-purpose
2055 authorization protocol or \'stealth' for a less scalable protocol that also
2056 hides service activity from unauthorized clients. Only clients that are
2057 listed here are authorized to access the hidden service. Valid client names
2058 are 1 to 16 characters long and only use characters in A-Za-z0-9+-_ (no
2059 spaces). If this option is set, the hidden service is not accessible for
2060 clients without authorization any more. Generated authorization data can be
2061 found in the hostname file. Clients need to put this authorization data in
2062 their configuration file using **HidServAuth**.
2064 [[RendPostPeriod]] **RendPostPeriod** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2065 Every time the specified period elapses, Tor uploads any rendezvous
2066 service descriptors to the directory servers. This information is also
2067 uploaded whenever it changes. (Default: 1 hour)
2069 TESTING NETWORK OPTIONS
2070 -----------------------
2072 The following options are used for running a testing Tor network.
2074 [[TestingTorNetwork]] **TestingTorNetwork** **0**|**1**::
2075 If set to 1, Tor adjusts default values of the configuration options below,
2076 so that it is easier to set up a testing Tor network. May only be set if
2077 non-default set of DirAuthorities is set. Cannot be unset while Tor is
2081 ServerDNSAllowBrokenConfig 1
2082 DirAllowPrivateAddresses 1
2083 EnforceDistinctSubnets 0
2085 AuthDirMaxServersPerAddr 0
2086 AuthDirMaxServersPerAuthAddr 0
2087 ClientDNSRejectInternalAddresses 0
2088 ClientRejectInternalAddresses 0
2089 CountPrivateBandwidth 1
2090 ExitPolicyRejectPrivate 0
2091 ExtendAllowPrivateAddresses 1
2092 V3AuthVotingInterval 5 minutes
2093 V3AuthVoteDelay 20 seconds
2094 V3AuthDistDelay 20 seconds
2095 MinUptimeHidServDirectoryV2 0 seconds
2096 TestingV3AuthInitialVotingInterval 5 minutes
2097 TestingV3AuthInitialVoteDelay 20 seconds
2098 TestingV3AuthInitialDistDelay 20 seconds
2099 TestingAuthDirTimeToLearnReachability 0 minutes
2100 TestingEstimatedDescriptorPropagationTime 0 minutes
2101 TestingServerDownloadSchedule 0, 0, 0, 5, 10, 15, 20, 30, 60
2102 TestingClientDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2103 TestingServerConsensusDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2104 TestingClientConsensusDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2105 TestingBridgeDownloadSchedule 60, 30, 30, 60
2106 TestingClientMaxIntervalWithoutRequest 5 seconds
2107 TestingDirConnectionMaxStall 30 seconds
2108 TestingConsensusMaxDownloadTries 80
2109 TestingDescriptorMaxDownloadTries 80
2110 TestingMicrodescMaxDownloadTries 80
2111 TestingCertMaxDownloadTries 80
2112 TestingEnableConnBwEvent 1
2113 TestingEnableCellStatsEvent 1
2114 TestingEnableTbEmptyEvent 1
2116 [[TestingV3AuthInitialVotingInterval]] **TestingV3AuthInitialVotingInterval** __N__ **minutes**|**hours**::
2117 Like V3AuthVotingInterval, but for initial voting interval before the first
2118 consensus has been created. Changing this requires that
2119 **TestingTorNetwork** is set. (Default: 30 minutes)
2121 [[TestingV3AuthInitialVoteDelay]] **TestingV3AuthInitialVoteDelay** __N__ **minutes**|**hours**::
2122 Like V3AuthVoteDelay, but for initial voting interval before
2123 the first consensus has been created. Changing this requires that
2124 **TestingTorNetwork** is set. (Default: 5 minutes)
2126 [[TestingV3AuthInitialDistDelay]] **TestingV3AuthInitialDistDelay** __N__ **minutes**|**hours**::
2127 Like V3AuthDistDelay, but for initial voting interval before
2128 the first consensus has been created. Changing this requires that
2129 **TestingTorNetwork** is set. (Default: 5 minutes)
2131 [[TestingV3AuthVotingStartOffset]] **TestingV3AuthVotingStartOffset** __N__ **seconds**|**minutes**|**hours**::
2132 Directory authorities offset voting start time by this much.
2133 Changing this requires that **TestingTorNetwork** is set. (Default: 0)
2135 [[TestingAuthDirTimeToLearnReachability]] **TestingAuthDirTimeToLearnReachability** __N__ **minutes**|**hours**::
2136 After starting as an authority, do not make claims about whether routers
2137 are Running until this much time has passed. Changing this requires
2138 that **TestingTorNetwork** is set. (Default: 30 minutes)
2140 [[TestingEstimatedDescriptorPropagationTime]] **TestingEstimatedDescriptorPropagationTime** __N__ **minutes**|**hours**::
2141 Clients try downloading router descriptors from directory caches after this
2142 time. Changing this requires that **TestingTorNetwork** is set. (Default:
2145 [[TestingMinFastFlagThreshold]] **TestingMinFastFlagThreshold** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
2146 Minimum value for the Fast flag. Overrides the ordinary minimum taken
2147 from the consensus when TestingTorNetwork is set. (Default: 0.)
2149 [[TestingServerDownloadSchedule]] **TestingServerDownloadSchedule** __N__,__N__,__...__::
2150 Schedule for when servers should download things in general. Changing this
2151 requires that **TestingTorNetwork** is set. (Default: 0, 0, 0, 60, 60, 120,
2152 300, 900, 2147483647)
2154 [[TestingClientDownloadSchedule]] **TestingClientDownloadSchedule** __N__,__N__,__...__::
2155 Schedule for when clients should download things in general. Changing this
2156 requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2159 [[TestingServerConsensusDownloadSchedule]] **TestingServerConsensusDownloadSchedule** __N__,__N__,__...__::
2160 Schedule for when servers should download consensuses. Changing this
2161 requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2162 1800, 1800, 1800, 1800, 1800, 3600, 7200)
2164 [[TestingClientConsensusDownloadSchedule]] **TestingClientConsensusDownloadSchedule** __N__,__N__,__...__::
2165 Schedule for when clients should download consensuses. Changing this
2166 requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2167 1800, 3600, 3600, 3600, 10800, 21600, 43200)
2169 [[TestingBridgeDownloadSchedule]] **TestingBridgeDownloadSchedule** __N__,__N__,__...__::
2170 Schedule for when clients should download bridge descriptors. Changing this
2171 requires that **TestingTorNetwork** is set. (Default: 3600, 900, 900, 3600)
2173 [[TestingClientMaxIntervalWithoutRequest]] **TestingClientMaxIntervalWithoutRequest** __N__ **seconds**|**minutes**::
2174 When directory clients have only a few descriptors to request, they batch
2175 them until they have more, or until this amount of time has passed.
2176 Changing this requires that **TestingTorNetwork** is set. (Default: 10
2179 [[TestingDirConnectionMaxStall]] **TestingDirConnectionMaxStall** __N__ **seconds**|**minutes**::
2180 Let a directory connection stall this long before expiring it.
2181 Changing this requires that **TestingTorNetwork** is set. (Default:
2184 [[TestingConsensusMaxDownloadTries]] **TestingConsensusMaxDownloadTries** __NUM__::
2185 Try this often to download a consensus before giving up. Changing
2186 this requires that **TestingTorNetwork** is set. (Default: 8)
2188 [[TestingDescriptorMaxDownloadTries]] **TestingDescriptorMaxDownloadTries** __NUM__::
2189 Try this often to download a router descriptor before giving up.
2190 Changing this requires that **TestingTorNetwork** is set. (Default: 8)
2192 [[TestingMicrodescMaxDownloadTries]] **TestingMicrodescMaxDownloadTries** __NUM__::
2193 Try this often to download a microdesc descriptor before giving up.
2194 Changing this requires that **TestingTorNetwork** is set. (Default: 8)
2196 [[TestingCertMaxDownloadTries]] **TestingCertMaxDownloadTries** __NUM__::
2197 Try this often to download a v3 authority certificate before giving up.
2198 Changing this requires that **TestingTorNetwork** is set. (Default: 8)
2200 [[TestingDirAuthVoteGuard]] **TestingDirAuthVoteGuard** __node__,__node__,__...__::
2201 A list of identity fingerprints, nicknames, country codes and
2202 address patterns of nodes to vote Guard for regardless of their
2203 uptime and bandwidth. See the **ExcludeNodes** option for more
2204 information on how to specify nodes.
2206 In order for this option to have any effect, **TestingTorNetwork**
2209 [[TestingEnableConnBwEvent]] **TestingEnableConnBwEvent** **0**|**1**::
2210 If this option is set, then Tor controllers may register for CONN_BW
2211 events. Changing this requires that **TestingTorNetwork** is set.
2214 [[TestingEnableCellStatsEvent]] **TestingEnableCellStatsEvent** **0**|**1**::
2215 If this option is set, then Tor controllers may register for CELL_STATS
2216 events. Changing this requires that **TestingTorNetwork** is set.
2219 [[TestingEnableTbEmptyEvent]] **TestingEnableTbEmptyEvent** **0**|**1**::
2220 If this option is set, then Tor controllers may register for TB_EMPTY
2221 events. Changing this requires that **TestingTorNetwork** is set.
2224 [[TestingMinExitFlagThreshold]] **TestingMinExitFlagThreshold** __N__ **KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
2225 Sets a lower-bound for assigning an exit flag when running as an
2226 authority on a testing network. Overrides the usual default lower bound
2227 of 4 KB. (Default: 0)
2232 Tor catches the following signals:
2234 [[SIGTERM]] **SIGTERM**::
2235 Tor will catch this, clean up and sync to disk if necessary, and exit.
2237 [[SIGINT]] **SIGINT**::
2238 Tor clients behave as with SIGTERM; but Tor servers will do a controlled
2239 slow shutdown, closing listeners and waiting 30 seconds before exiting.
2240 (The delay can be configured with the ShutdownWaitLength config option.)
2242 [[SIGHUP]] **SIGHUP**::
2243 The signal instructs Tor to reload its configuration (including closing and
2244 reopening logs), and kill and restart its helper processes if applicable.
2246 [[SIGUSR1]] **SIGUSR1**::
2247 Log statistics about current connections, past connections, and throughput.
2249 [[SIGUSR2]] **SIGUSR2**::
2250 Switch all logs to loglevel debug. You can go back to the old loglevels by
2253 [[SIGCHLD]] **SIGCHLD**::
2254 Tor receives this signal when one of its helper processes has exited, so it
2257 [[SIGPIPE]] **SIGPIPE**::
2258 Tor catches this signal and ignores it.
2260 [[SIGXFSZ]] **SIGXFSZ**::
2261 If this signal exists on your platform, Tor catches and ignores it.
2266 **@CONFDIR@/torrc**::
2267 The configuration file, which contains "option value" pairs.
2270 Fallback location for torrc, if @CONFDIR@/torrc is not found.
2272 **@LOCALSTATEDIR@/lib/tor/**::
2273 The tor process stores keys and other data here.
2275 __DataDirectory__**/cached-status/**::
2276 The most recently downloaded network status document for each authority.
2277 Each file holds one such document; the filenames are the hexadecimal
2278 identity key fingerprints of the directory authorities. Mostly obsolete.
2280 __DataDirectory__**/cached-certs**::
2281 This file holds downloaded directory key certificates that are used to
2282 verify authenticity of documents generated by Tor directory authorities.
2284 __DataDirectory__**/cached-consensus** and/or **cached-microdesc-consensus**::
2285 The most recent consensus network status document we've downloaded.
2287 __DataDirectory__**/cached-descriptors** and **cached-descriptors.new**::
2288 These files hold downloaded router statuses. Some routers may appear more
2289 than once; if so, the most recently published descriptor is used. Lines
2290 beginning with @-signs are annotations that contain more information about
2291 a given router. The ".new" file is an append-only journal; when it gets
2292 too large, all entries are merged into a new cached-descriptors file.
2294 __DataDirectory__**/cached-microdescs** and **cached-microdescs.new**::
2295 These files hold downloaded microdescriptors. Lines beginning with
2296 @-signs are annotations that contain more information about a given
2297 router. The ".new" file is an append-only journal; when it gets too
2298 large, all entries are merged into a new cached-microdescs file.
2300 __DataDirectory__**/cached-routers** and **cached-routers.new**::
2301 Obsolete versions of cached-descriptors and cached-descriptors.new. When
2302 Tor can't find the newer files, it looks here instead.
2304 __DataDirectory__**/state**::
2305 A set of persistent key-value mappings. These are documented in
2306 the file. These include:
2307 - The current entry guards and their status.
2308 - The current bandwidth accounting values (unused so far; see
2310 - When the file was last written
2311 - What version of Tor generated the state file
2312 - A short history of bandwidth usage, as produced in the router
2315 __DataDirectory__**/bw_accounting**::
2316 Used to track bandwidth accounting values (when the current period starts
2317 and ends; how much has been read and written so far this period). This file
2318 is obsolete, and the data is now stored in the \'state' file as well. Only
2319 used when bandwidth accounting is enabled.
2321 __DataDirectory__**/control_auth_cookie**::
2322 Used for cookie authentication with the controller. Location can be
2323 overridden by the CookieAuthFile config option. Regenerated on startup. See
2324 control-spec.txt for details. Only used when cookie authentication is
2327 __DataDirectory__**/lock**::
2328 This file is used to prevent two Tor instances from using same data
2329 directory. If access to this file is locked, data directory is already
2332 __DataDirectory__**/keys/***::
2333 Only used by servers. Holds identity keys and onion keys.
2335 __DataDirectory__**/fingerprint**::
2336 Only used by servers. Holds the fingerprint of the server's identity key.
2338 __DataDirectory__**/hashed-fingerprint**::
2339 Only used by bridges. Holds the hashed fingerprint of the bridge's
2340 identity key. (That is, the hash of the hash of the identity key.)
2342 __DataDirectory__**/v3-status-votes**::
2343 Only for authoritative directory servers. This file contains status votes
2344 from all the authoritative directory servers and is used to generate the
2345 network consensus document.
2347 __DataDirectory__**/unverified-consensus**::
2348 This file contains a network consensus document that has been downloaded,
2349 but which we didn't have the right certificates to check yet.
2351 __DataDirectory__**/unverified-microdesc-consensus**::
2352 This file contains a microdescriptor-flavored network consensus document
2353 that has been downloaded, but which we didn't have the right certificates
2356 __DataDirectory__**/unparseable-desc**::
2357 Onion router descriptors that Tor was unable to parse are dumped to this
2358 file. Only used for debugging.
2360 __DataDirectory__**/router-stability**::
2361 Only used by authoritative directory servers. Tracks measurements for
2362 router mean-time-between-failures so that authorities have a good idea of
2363 how to set their Stable flags.
2365 __DataDirectory__**/stats/dirreq-stats**::
2366 Only used by directory caches and authorities. This file is used to
2367 collect directory request statistics.
2369 __DataDirectory__**/stats/entry-stats**::
2370 Only used by servers. This file is used to collect incoming connection
2371 statistics by Tor entry nodes.
2373 __DataDirectory__**/stats/bridge-stats**::
2374 Only used by servers. This file is used to collect incoming connection
2375 statistics by Tor bridges.
2377 __DataDirectory__**/stats/exit-stats**::
2378 Only used by servers. This file is used to collect outgoing connection
2379 statistics by Tor exit routers.
2381 __DataDirectory__**/stats/buffer-stats**::
2382 Only used by servers. This file is used to collect buffer usage
2385 __DataDirectory__**/stats/conn-stats**::
2386 Only used by servers. This file is used to collect approximate connection
2387 history (number of active connections over time).
2389 __HiddenServiceDirectory__**/hostname**::
2390 The <base32-encoded-fingerprint>.onion domain name for this hidden service.
2391 If the hidden service is restricted to authorized clients only, this file
2392 also contains authorization data for all clients.
2394 __HiddenServiceDirectory__**/private_key**::
2395 The private key for this hidden service.
2397 __HiddenServiceDirectory__**/client_keys**::
2398 Authorization data for a hidden service that is only accessible by
2403 **torsocks**(1), **torify**(1) +
2405 **https://www.torproject.org/**
2411 Plenty, probably. Tor is still in development. Please report them.
2415 Roger Dingledine [arma at mit.edu], Nick Mathewson [nickm at alum.mit.edu].