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 OR pass *-* to make Tor read its configuration from standard
46 input. (Default: @CONFDIR@/torrc, or $HOME/.torrc if that file is not
49 [[opt-allow-missing-torrc]] **--allow-missing-torrc**::
50 Do not require that configuration file specified by **-f** exist if
51 default torrc can be accessed.
53 [[opt-defaults-torrc]] **--defaults-torrc** __FILE__::
54 Specify a file in which to find default values for Tor options. The
55 contents of this file are overridden by those in the regular
56 configuration file, and by those on the command line. (Default:
57 @CONFDIR@/torrc-defaults.)
59 [[opt-ignore-missing-torrc]] **--ignore-missing-torrc**::
60 Specifies that Tor should treat a missing torrc file as though it
61 were empty. Ordinarily, Tor does this for missing default torrc files,
62 but not for those specified on the command line.
64 [[opt-hash-password]] **--hash-password** __PASSWORD__::
65 Generates a hashed password for control port access.
67 [[opt-list-fingerprint]] **--list-fingerprint**::
68 Generate your keys and output your nickname and fingerprint.
70 [[opt-verify-config]] **--verify-config**::
71 Verify the configuration file is valid.
73 [[opt-serviceinstall]] **--service install** [**--options** __command-line options__]::
74 Install an instance of Tor as a Windows service, with the provided
75 command-line options. Current instructions can be found at
76 https://www.torproject.org/docs/faq#NTService
78 [[opt-service]] **--service** **remove**|**start**|**stop**::
79 Remove, start, or stop a configured Tor Windows service.
81 [[opt-nt-service]] **--nt-service**::
82 Used internally to implement a Windows service.
84 [[opt-list-torrc-options]] **--list-torrc-options**::
85 List all valid options.
87 [[opt-version]] **--version**::
88 Display Tor version and exit.
90 [[opt-quiet]] **--quiet**|**--hush**::
91 Override the default console log. By default, Tor starts out logging
92 messages at level "notice" and higher to the console. It stops doing so
93 after it parses its configuration, if the configuration tells it to log
94 anywhere else. You can override this behavior with the **--hush** option,
95 which tells Tor to only send warnings and errors to the console, or with
96 the **--quiet** option, which tells Tor not to log to the console at all.
98 Other options can be specified on the command-line in the format "--option
99 value", in the format "option value", or in a configuration file. For
100 instance, you can tell Tor to start listening for SOCKS connections on port
101 9999 by passing --SOCKSPort 9999 or SOCKSPort 9999 to it on the command line,
102 or by putting "SOCKSPort 9999" in the configuration file. You will need to
103 quote options with spaces in them: if you want Tor to log all debugging
104 messages to debug.log, you will probably need to say --Log 'debug file
107 Options on the command line override those in configuration files. See the
108 next section for more information.
110 THE CONFIGURATION FILE FORMAT
111 -----------------------------
113 All configuration options in a configuration are written on a single line by
114 default. They take the form of an option name and a value, or an option name
115 and a quoted value (option value or option "value"). Anything after a #
116 character is treated as a comment. Options are
117 case-insensitive. C-style escaped characters are allowed inside quoted
118 values. To split one configuration entry into multiple lines, use a single
119 backslash character (\) before the end of the line. Comments can be used in
120 such multiline entries, but they must start at the beginning of a line.
122 By default, an option on the command line overrides an option found in the
123 configuration file, and an option in a configuration file overrides one in
126 This rule is simple for options that take a single value, but it can become
127 complicated for options that are allowed to occur more than once: if you
128 specify four SOCKSPorts in your configuration file, and one more SOCKSPort on
129 the command line, the option on the command line will replace __all__ of the
130 SOCKSPorts in the configuration file. If this isn't what you want, prefix
131 the option name with a plus sign, and it will be appended to the previous set
134 Alternatively, you might want to remove every instance of an option in the
135 configuration file, and not replace it at all: you might want to say on the
136 command line that you want no SOCKSPorts at all. To do that, prefix the
137 option name with a forward slash.
142 [[BandwidthRate]] **BandwidthRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
143 A token bucket limits the average incoming bandwidth usage on this node to
144 the specified number of bytes per second, and the average outgoing
145 bandwidth usage to that same value. If you want to run a relay in the
146 public network, this needs to be _at the very least_ 30 KBytes (that is,
147 30720 bytes). (Default: 1 GByte) +
149 With this option, and in other options that take arguments in bytes,
150 KBytes, and so on, other formats are also supported. Notably, "KBytes" can
151 also be written as "kilobytes" or "kb"; "MBytes" can be written as
152 "megabytes" or "MB"; "kbits" can be written as "kilobits"; and so forth.
153 Tor also accepts "byte" and "bit" in the singular.
154 The prefixes "tera" and "T" are also recognized.
155 If no units are given, we default to bytes.
156 To avoid confusion, we recommend writing "bytes" or "bits" explicitly,
157 since it's easy to forget that "B" means bytes, not bits.
159 [[BandwidthBurst]] **BandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
160 Limit the maximum token bucket size (also known as the burst) to the given
161 number of bytes in each direction. (Default: 1 GByte)
163 [[MaxAdvertisedBandwidth]] **MaxAdvertisedBandwidth** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
164 If set, we will not advertise more than this amount of bandwidth for our
165 BandwidthRate. Server operators who want to reduce the number of clients
166 who ask to build circuits through them (since this is proportional to
167 advertised bandwidth rate) can thus reduce the CPU demands on their server
168 without impacting network performance.
170 [[RelayBandwidthRate]] **RelayBandwidthRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
171 If not 0, a separate token bucket limits the average incoming bandwidth
172 usage for \_relayed traffic_ on this node to the specified number of bytes
173 per second, and the average outgoing bandwidth usage to that same value.
174 Relayed traffic currently is calculated to include answers to directory
175 requests, but that may change in future versions. (Default: 0)
177 [[RelayBandwidthBurst]] **RelayBandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
178 If not 0, limit the maximum token bucket size (also known as the burst) for
179 \_relayed traffic_ to the given number of bytes in each direction.
182 [[PerConnBWRate]] **PerConnBWRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
183 If set, do separate rate limiting for each connection from a non-relay.
184 You should never need to change this value, since a network-wide value is
185 published in the consensus and your relay will use that value. (Default: 0)
187 [[PerConnBWBurst]] **PerConnBWBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
188 If set, do separate rate limiting for each connection from a non-relay.
189 You should never need to change this value, since a network-wide value is
190 published in the consensus and your relay will use that value. (Default: 0)
192 [[ClientTransportPlugin]] **ClientTransportPlugin** __transport__ socks4|socks5 __IP__:__PORT__::
193 **ClientTransportPlugin** __transport__ exec __path-to-binary__ [options]::
194 In its first form, when set along with a corresponding Bridge line, the Tor
195 client forwards its traffic to a SOCKS-speaking proxy on "IP:PORT". It's the
196 duty of that proxy to properly forward the traffic to the bridge. +
198 In its second form, when set along with a corresponding Bridge line, the Tor
199 client launches the pluggable transport proxy executable in
200 __path-to-binary__ using __options__ as its command-line options, and
201 forwards its traffic to it. It's the duty of that proxy to properly forward
202 the traffic to the bridge.
204 [[ServerTransportPlugin]] **ServerTransportPlugin** __transport__ exec __path-to-binary__ [options]::
205 The Tor relay launches the pluggable transport proxy in __path-to-binary__
206 using __options__ as its command-line options, and expects to receive
207 proxied client traffic from it.
209 [[ServerTransportListenAddr]] **ServerTransportListenAddr** __transport__ __IP__:__PORT__::
210 When this option is set, Tor will suggest __IP__:__PORT__ as the
211 listening address of any pluggable transport proxy that tries to
212 launch __transport__.
214 [[ServerTransportOptions]] **ServerTransportOptions** __transport__ __k=v__ __k=v__ ...::
215 When this option is set, Tor will pass the __k=v__ parameters to
216 any pluggable transport proxy that tries to launch __transport__. +
217 (Example: ServerTransportOptions obfs45 shared-secret=bridgepasswd cache=/var/lib/tor/cache)
219 [[ExtORPort]] **ExtORPort** \['address':]__port__|**auto**
220 Open this port to listen for Extended ORPort connections from your
221 pluggable transports.
223 [[ExtORPortCookieAuthFile]] **ExtORPortCookieAuthFile** __Path__::
224 If set, this option overrides the default location and file name
225 for the Extended ORPort's cookie file -- the cookie file is needed
226 for pluggable transports to communicate through the Extended ORPort.
228 [[ExtORPortCookieAuthFileGroupReadable]] **ExtORPortCookieAuthFileGroupReadable** **0**|**1**::
229 If this option is set to 0, don't allow the filesystem group to read the
230 Extended OR Port cookie file. If the option is set to 1, make the cookie
231 file readable by the default GID. [Making the file readable by other
232 groups is not yet implemented; let us know if you need this for some
233 reason.] (Default: 0)
235 [[ConnLimit]] **ConnLimit** __NUM__::
236 The minimum number of file descriptors that must be available to the Tor
237 process before it will start. Tor will ask the OS for as many file
238 descriptors as the OS will allow (you can find this by "ulimit -H -n").
239 If this number is less than ConnLimit, then Tor will refuse to start. +
241 You probably don't need to adjust this. It has no effect on Windows
242 since that platform lacks getrlimit(). (Default: 1000)
244 [[DisableNetwork]] **DisableNetwork** **0**|**1**::
245 When this option is set, we don't listen for or accept any connections
246 other than controller connections, and we close (and don't reattempt)
248 connections. Controllers sometimes use this option to avoid using
249 the network until Tor is fully configured. (Default: 0)
251 [[ConstrainedSockets]] **ConstrainedSockets** **0**|**1**::
252 If set, Tor will tell the kernel to attempt to shrink the buffers for all
253 sockets to the size specified in **ConstrainedSockSize**. This is useful for
254 virtual servers and other environments where system level TCP buffers may
255 be limited. If you're on a virtual server, and you encounter the "Error
256 creating network socket: No buffer space available" message, you are
257 likely experiencing this problem. +
259 The preferred solution is to have the admin increase the buffer pool for
260 the host itself via /proc/sys/net/ipv4/tcp_mem or equivalent facility;
261 this configuration option is a second-resort. +
263 The DirPort option should also not be used if TCP buffers are scarce. The
264 cached directory requests consume additional sockets which exacerbates
267 You should **not** enable this feature unless you encounter the "no buffer
268 space available" issue. Reducing the TCP buffers affects window size for
269 the TCP stream and will reduce throughput in proportion to round trip
270 time on long paths. (Default: 0)
272 [[ConstrainedSockSize]] **ConstrainedSockSize** __N__ **bytes**|**KBytes**::
273 When **ConstrainedSockets** is enabled the receive and transmit buffers for
274 all sockets will be set to this limit. Must be a value between 2048 and
275 262144, in 1024 byte increments. Default of 8192 is recommended.
277 [[ControlPort]] **ControlPort** __PORT__|**unix:**__path__|**auto** [__flags__]::
278 If set, Tor will accept connections on this port and allow those
279 connections to control the Tor process using the Tor Control Protocol
280 (described in control-spec.txt). Note: unless you also specify one or
281 more of **HashedControlPassword** or **CookieAuthentication**,
282 setting this option will cause Tor to allow any process on the local
283 host to control it. (Setting both authentication methods means either
284 method is sufficient to authenticate to Tor.) This
285 option is required for many Tor controllers; most use the value of 9051.
286 Set it to "auto" to have Tor pick a port for you. (Default: 0)
288 Recognized flags are::
290 Unix domain sockets only: makes the socket get created as
293 Unix domain sockets only: makes the socket get created as
296 [[ControlListenAddress]] **ControlListenAddress** __IP__[:__PORT__]::
297 Bind the controller listener to this address. If you specify a port, bind
298 to this port rather than the one specified in ControlPort. We strongly
299 recommend that you leave this alone unless you know what you're doing,
300 since giving attackers access to your control listener is really
301 dangerous. This directive can be specified multiple
302 times to bind to multiple addresses/ports. (Default: 127.0.0.1)
304 [[ControlSocket]] **ControlSocket** __Path__::
305 Like ControlPort, but listens on a Unix domain socket, rather than a TCP
306 socket. '0' disables ControlSocket (Unix and Unix-like systems only.)
308 [[ControlSocketsGroupWritable]] **ControlSocketsGroupWritable** **0**|**1**::
309 If this option is set to 0, don't allow the filesystem group to read and
310 write unix sockets (e.g. ControlSocket). If the option is set to 1, make
311 the control socket readable and writable by the default GID. (Default: 0)
313 [[HashedControlPassword]] **HashedControlPassword** __hashed_password__::
314 Allow connections on the control port if they present
315 the password whose one-way hash is __hashed_password__. You
316 can compute the hash of a password by running "tor --hash-password
317 __password__". You can provide several acceptable passwords by using more
318 than one HashedControlPassword line.
320 [[CookieAuthentication]] **CookieAuthentication** **0**|**1**::
321 If this option is set to 1, allow connections on the control port
322 when the connecting process knows the contents of a file named
323 "control_auth_cookie", which Tor will create in its data directory. This
324 authentication method should only be used on systems with good filesystem
325 security. (Default: 0)
327 [[CookieAuthFile]] **CookieAuthFile** __Path__::
328 If set, this option overrides the default location and file name
329 for Tor's cookie file. (See CookieAuthentication above.)
331 [[CookieAuthFileGroupReadable]] **CookieAuthFileGroupReadable** **0**|**1**::
332 If this option is set to 0, don't allow the filesystem group to read the
333 cookie file. If the option is set to 1, make the cookie file readable by
334 the default GID. [Making the file readable by other groups is not yet
335 implemented; let us know if you need this for some reason.] (Default: 0)
337 [[ControlPortWriteToFile]] **ControlPortWriteToFile** __Path__::
338 If set, Tor writes the address and port of any control port it opens to
339 this address. Usable by controllers to learn the actual control port
340 when ControlPort is set to "auto".
342 [[ControlPortFileGroupReadable]] **ControlPortFileGroupReadable** **0**|**1**::
343 If this option is set to 0, don't allow the filesystem group to read the
344 control port file. If the option is set to 1, make the control port
345 file readable by the default GID. (Default: 0)
347 [[DataDirectory]] **DataDirectory** __DIR__::
348 Store working data in DIR (Default: @LOCALSTATEDIR@/lib/tor)
350 [[FallbackDir]] **FallbackDir** __address__:__port__ orport=__port__ id=__fingerprint__ [weight=__num__]::
351 When we're unable to connect to any directory cache for directory info
352 (usually because we don't know about any yet) we try a FallbackDir.
353 By default, the directory authorities are also FallbackDirs.
355 [[DirAuthority]] **DirAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__::
356 Use a nonstandard authoritative directory server at the provided address
357 and port, with the specified key fingerprint. This option can be repeated
358 many times, for multiple authoritative directory servers. Flags are
359 separated by spaces, and determine what kind of an authority this directory
360 is. By default, an authority is not authoritative for any directory style
361 or version unless an appropriate flag is given.
362 Tor will use this authority as a bridge authoritative directory if the
363 "bridge" flag is set. If a flag "orport=**port**" is given, Tor will use the
364 given port when opening encrypted tunnels to the dirserver. If a flag
365 "weight=**num**" is given, then the directory server is chosen randomly
366 with probability proportional to that weight (default 1.0). Lastly, if a
367 flag "v3ident=**fp**" is given, the dirserver is a v3 directory authority
368 whose v3 long-term signing key has the fingerprint **fp**. +
370 If no **DirAuthority** line is given, Tor will use the default directory
371 authorities. NOTE: this option is intended for setting up a private Tor
372 network with its own directory authorities. If you use it, you will be
373 distinguishable from other users, because you won't believe the same
376 [[DirAuthorityFallbackRate]] **DirAuthorityFallbackRate** __NUM__::
377 When configured to use both directory authorities and fallback
378 directories, the directory authorities also work as fallbacks. They are
379 chosen with their regular weights, multiplied by this number, which
380 should be 1.0 or less. (Default: 1.0)
382 [[AlternateDirAuthority]] **AlternateDirAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__ +
384 [[AlternateBridgeAuthority]] **AlternateBridgeAuthority** [__nickname__] [**flags**] __address__:__port__ __ fingerprint__::
385 These options behave as DirAuthority, but they replace fewer of the
386 default directory authorities. Using
387 AlternateDirAuthority replaces the default Tor directory authorities, but
388 leaves the default bridge authorities in
390 AlternateBridgeAuthority replaces the default bridge authority,
391 but leaves the directory authorities alone.
393 [[DisableAllSwap]] **DisableAllSwap** **0**|**1**::
394 If set to 1, Tor will attempt to lock all current and future memory pages,
395 so that memory cannot be paged out. Windows, OS X and Solaris are currently
396 not supported. We believe that this feature works on modern Gnu/Linux
397 distributions, and that it should work on *BSD systems (untested). This
398 option requires that you start your Tor as root, and you should use the
399 **User** option to properly reduce Tor's privileges. (Default: 0)
401 [[DisableDebuggerAttachment]] **DisableDebuggerAttachment** **0**|**1**::
402 If set to 1, Tor will attempt to prevent basic debugging attachment attempts
403 by other processes. This may also keep Tor from generating core files if
404 it crashes. It has no impact for users who wish to attach if they
405 have CAP_SYS_PTRACE or if they are root. We believe that this feature
406 works on modern Gnu/Linux distributions, and that it may also work on *BSD
407 systems (untested). Some modern Gnu/Linux systems such as Ubuntu have the
408 kernel.yama.ptrace_scope sysctl and by default enable it as an attempt to
409 limit the PTRACE scope for all user processes by default. This feature will
410 attempt to limit the PTRACE scope for Tor specifically - it will not attempt
411 to alter the system wide ptrace scope as it may not even exist. If you wish
412 to attach to Tor with a debugger such as gdb or strace you will want to set
413 this to 0 for the duration of your debugging. Normal users should leave it
414 on. Disabling this option while Tor is running is prohibited. (Default: 1)
416 [[FetchDirInfoEarly]] **FetchDirInfoEarly** **0**|**1**::
417 If set to 1, Tor will always fetch directory information like other
418 directory caches, even if you don't meet the normal criteria for fetching
419 early. Normal users should leave it off. (Default: 0)
421 [[FetchDirInfoExtraEarly]] **FetchDirInfoExtraEarly** **0**|**1**::
422 If set to 1, Tor will fetch directory information before other directory
423 caches. It will attempt to download directory information closer to the
424 start of the consensus period. Normal users should leave it off.
427 [[FetchHidServDescriptors]] **FetchHidServDescriptors** **0**|**1**::
428 If set to 0, Tor will never fetch any hidden service descriptors from the
429 rendezvous directories. This option is only useful if you're using a Tor
430 controller that handles hidden service fetches for you. (Default: 1)
432 [[FetchServerDescriptors]] **FetchServerDescriptors** **0**|**1**::
433 If set to 0, Tor will never fetch any network status summaries or server
434 descriptors from the directory servers. This option is only useful if
435 you're using a Tor controller that handles directory fetches for you.
438 [[FetchUselessDescriptors]] **FetchUselessDescriptors** **0**|**1**::
439 If set to 1, Tor will fetch every non-obsolete descriptor from the
440 authorities that it hears about. Otherwise, it will avoid fetching useless
441 descriptors, for example for routers that are not running. This option is
442 useful if you're using the contributed "exitlist" script to enumerate Tor
443 nodes that exit to certain addresses. (Default: 0)
445 [[HTTPProxy]] **HTTPProxy** __host__[:__port__]::
446 Tor will make all its directory requests through this host:port (or host:80
447 if port is not specified), rather than connecting directly to any directory
450 [[HTTPProxyAuthenticator]] **HTTPProxyAuthenticator** __username:password__::
451 If defined, Tor will use this username:password for Basic HTTP proxy
452 authentication, as in RFC 2617. This is currently the only form of HTTP
453 proxy authentication that Tor supports; feel free to submit a patch if you
454 want it to support others.
456 [[HTTPSProxy]] **HTTPSProxy** __host__[:__port__]::
457 Tor will make all its OR (SSL) connections through this host:port (or
458 host:443 if port is not specified), via HTTP CONNECT rather than connecting
459 directly to servers. You may want to set **FascistFirewall** to restrict
460 the set of ports you might try to connect to, if your HTTPS proxy only
461 allows connecting to certain ports.
463 [[HTTPSProxyAuthenticator]] **HTTPSProxyAuthenticator** __username:password__::
464 If defined, Tor will use this username:password for Basic HTTPS proxy
465 authentication, as in RFC 2617. This is currently the only form of HTTPS
466 proxy authentication that Tor supports; feel free to submit a patch if you
467 want it to support others.
469 [[Sandbox]] **Sandbox** **0**|**1**::
470 If set to 1, Tor will run securely through the use of a syscall sandbox.
471 Otherwise the sandbox will be disabled. The option is currently an
472 experimental feature. (Default: 0)
474 [[Socks4Proxy]] **Socks4Proxy** __host__[:__port__]::
475 Tor will make all OR connections through the SOCKS 4 proxy at host:port
476 (or host:1080 if port is not specified).
478 [[Socks5Proxy]] **Socks5Proxy** __host__[:__port__]::
479 Tor will make all OR connections through the SOCKS 5 proxy at host:port
480 (or host:1080 if port is not specified).
482 [[Socks5ProxyUsername]] **Socks5ProxyUsername** __username__ +
484 [[Socks5ProxyPassword]] **Socks5ProxyPassword** __password__::
485 If defined, authenticate to the SOCKS 5 server using username and password
486 in accordance to RFC 1929. Both username and password must be between 1 and
489 [[SocksSocketsGroupWritable]] **SocksSocketsGroupWritable** **0**|**1**::
490 If this option is set to 0, don't allow the filesystem group to read and
491 write unix sockets (e.g. SocksSocket). If the option is set to 1, make
492 the SocksSocket socket readable and writable by the default GID. (Default: 0)
494 [[KeepalivePeriod]] **KeepalivePeriod** __NUM__::
495 To keep firewalls from expiring connections, send a padding keepalive cell
496 every NUM seconds on open connections that are in use. If the connection
497 has no open circuits, it will instead be closed after NUM seconds of
498 idleness. (Default: 5 minutes)
500 [[Log]] **Log** __minSeverity__[-__maxSeverity__] **stderr**|**stdout**|**syslog**::
501 Send all messages between __minSeverity__ and __maxSeverity__ to the standard
502 output stream, the standard error stream, or to the system log. (The
503 "syslog" value is only supported on Unix.) Recognized severity levels are
504 debug, info, notice, warn, and err. We advise using "notice" in most cases,
505 since anything more verbose may provide sensitive information to an
506 attacker who obtains the logs. If only one severity level is given, all
507 messages of that level or higher will be sent to the listed destination.
509 [[Log2]] **Log** __minSeverity__[-__maxSeverity__] **file** __FILENAME__::
510 As above, but send log messages to the listed filename. The
511 "Log" option may appear more than once in a configuration file.
512 Messages are sent to all the logs that match their severity
515 [[Log3]] **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **file** __FILENAME__ +
517 [[Log4]] **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **stderr**|**stdout**|**syslog**::
518 As above, but select messages by range of log severity __and__ by a
519 set of "logging domains". Each logging domain corresponds to an area of
520 functionality inside Tor. You can specify any number of severity ranges
521 for a single log statement, each of them prefixed by a comma-separated
522 list of logging domains. You can prefix a domain with $$~$$ to indicate
523 negation, and use * to indicate "all domains". If you specify a severity
524 range without a list of domains, it matches all domains. +
526 This is an advanced feature which is most useful for debugging one or two
527 of Tor's subsystems at a time. +
529 The currently recognized domains are: general, crypto, net, config, fs,
530 protocol, mm, http, app, control, circ, rend, bug, dir, dirserv, or, edge,
531 acct, hist, and handshake. Domain names are case-insensitive. +
533 For example, "`Log [handshake]debug [~net,~mm]info notice stdout`" sends
534 to stdout: all handshake messages of any severity, all info-and-higher
535 messages from domains other than networking and memory management, and all
536 messages of severity notice or higher.
538 [[LogMessageDomains]] **LogMessageDomains** **0**|**1**::
539 If 1, Tor includes message domains with each log message. Every log
540 message currently has at least one domain; most currently have exactly
541 one. This doesn't affect controller log messages. (Default: 0)
543 [[OutboundBindAddress]] **OutboundBindAddress** __IP__::
544 Make all outbound connections originate from the IP address specified. This
545 is only useful when you have multiple network interfaces, and you want all
546 of Tor's outgoing connections to use a single one. This option may
547 be used twice, once with an IPv4 address and once with an IPv6 address.
548 This setting will be ignored for connections to the loopback addresses
549 (127.0.0.0/8 and ::1).
551 [[PidFile]] **PidFile** __FILE__::
552 On startup, write our PID to FILE. On clean shutdown, remove
555 [[ProtocolWarnings]] **ProtocolWarnings** **0**|**1**::
556 If 1, Tor will log with severity \'warn' various cases of other parties not
557 following the Tor specification. Otherwise, they are logged with severity
558 \'info'. (Default: 0)
560 [[PredictedPortsRelevanceTime]] **PredictedPortsRelevanceTime** __NUM__::
561 Set how long, after the client has made an anonymized connection to a
562 given port, we will try to make sure that we build circuits to
563 exits that support that port. The maximum value for this option is 1
564 hour. (Default: 1 hour)
566 [[RunAsDaemon]] **RunAsDaemon** **0**|**1**::
567 If 1, Tor forks and daemonizes to the background. This option has no effect
568 on Windows; instead you should use the --service command-line option.
571 [[LogTimeGranularity]] **LogTimeGranularity** __NUM__::
572 Set the resolution of timestamps in Tor's logs to NUM milliseconds.
573 NUM must be positive and either a divisor or a multiple of 1 second.
574 Note that this option only controls the granularity written by Tor to
575 a file or console log. Tor does not (for example) "batch up" log
576 messages to affect times logged by a controller, times attached to
577 syslog messages, or the mtime fields on log files. (Default: 1 second)
579 [[TruncateLogFile]] **TruncateLogFile** **0**|**1**::
580 If 1, Tor will overwrite logs at startup and in response to a HUP signal,
581 instead of appending to them. (Default: 0)
583 [[SafeLogging]] **SafeLogging** **0**|**1**|**relay**::
584 Tor can scrub potentially sensitive strings from log messages (e.g.
585 addresses) by replacing them with the string [scrubbed]. This way logs can
586 still be useful, but they don't leave behind personally identifying
587 information about what sites a user might have visited. +
589 If this option is set to 0, Tor will not perform any scrubbing, if it is
590 set to 1, all potentially sensitive strings are replaced. If it is set to
591 relay, all log messages generated when acting as a relay are sanitized, but
592 all messages generated when acting as a client are not. (Default: 1)
594 [[User]] **User** __UID__::
595 On startup, setuid to this user and setgid to their primary group.
597 [[HardwareAccel]] **HardwareAccel** **0**|**1**::
598 If non-zero, try to use built-in (static) crypto hardware acceleration when
599 available. (Default: 0)
601 [[AccelName]] **AccelName** __NAME__::
602 When using OpenSSL hardware crypto acceleration attempt to load the dynamic
603 engine of this name. This must be used for any dynamic hardware engine.
604 Names can be verified with the openssl engine command.
606 [[AccelDir]] **AccelDir** __DIR__::
607 Specify this option if using dynamic hardware acceleration and the engine
608 implementation library resides somewhere other than the OpenSSL default.
610 [[AvoidDiskWrites]] **AvoidDiskWrites** **0**|**1**::
611 If non-zero, try to write to disk less frequently than we would otherwise.
612 This is useful when running on flash memory or other media that support
613 only a limited number of writes. (Default: 0)
615 [[CircuitPriorityHalflife]] **CircuitPriorityHalflife** __NUM1__::
616 If this value is set, we override the default algorithm for choosing which
617 circuit's cell to deliver or relay next. When the value is 0, we
618 round-robin between the active circuits on a connection, delivering one
619 cell from each in turn. When the value is positive, we prefer delivering
620 cells from whichever connection has the lowest weighted cell count, where
621 cells are weighted exponentially according to the supplied
622 CircuitPriorityHalflife value (in seconds). If this option is not set at
623 all, we use the behavior recommended in the current consensus
624 networkstatus. This is an advanced option; you generally shouldn't have
625 to mess with it. (Default: not set)
627 [[DisableIOCP]] **DisableIOCP** **0**|**1**::
628 If Tor was built to use the Libevent's "bufferevents" networking code
629 and you're running on Windows, setting this option to 1 will tell Libevent
630 not to use the Windows IOCP networking API. (Default: 1)
632 [[UserspaceIOCPBuffers]] **UserspaceIOCPBuffers** **0**|**1**::
633 If IOCP is enabled (see DisableIOCP above), setting this option to 1
634 will tell Tor to disable kernel-space TCP buffers, in order to avoid
635 needless copy operations and try not to run out of non-paged RAM.
636 This feature is experimental; don't use it yet unless you're eager to
637 help tracking down bugs. (Default: 0)
639 [[UseFilteringSSLBufferevents]] **UseFilteringSSLBufferevents** **0**|**1**::
640 Tells Tor to do its SSL communication using a chain of
641 bufferevents: one for SSL and one for networking. This option has no
642 effect if bufferevents are disabled (in which case it can't turn on), or
643 if IOCP bufferevents are enabled (in which case it can't turn off). This
644 option is useful for debugging only; most users shouldn't touch it.
647 [[CountPrivateBandwidth]] **CountPrivateBandwidth** **0**|**1**::
648 If this option is set, then Tor's rate-limiting applies not only to
649 remote connections, but also to connections to private addresses like
650 127.0.0.1 or 10.0.0.1. This is mostly useful for debugging
651 rate-limiting. (Default: 0)
656 The following options are useful only for clients (that is, if
657 **SocksPort**, **TransPort**, **DNSPort**, or **NATDPort** is non-zero):
659 [[AllowInvalidNodes]] **AllowInvalidNodes** **entry**|**exit**|**middle**|**introduction**|**rendezvous**|**...**::
660 If some Tor servers are obviously not working right, the directory
661 authorities can manually mark them as invalid, meaning that it's not
662 recommended you use them for entry or exit positions in your circuits. You
663 can opt to use them in some circuit positions, though. The default is
664 "middle,rendezvous", and other choices are not advised.
666 [[ExcludeSingleHopRelays]] **ExcludeSingleHopRelays** **0**|**1**::
667 This option controls whether circuits built by Tor will include relays with
668 the AllowSingleHopExits flag set to true. If ExcludeSingleHopRelays is set
669 to 0, these relays will be included. Note that these relays might be at
670 higher risk of being seized or observed, so they are not normally
671 included. Also note that relatively few clients turn off this option,
672 so using these relays might make your client stand out.
675 [[Bridge]] **Bridge** [__transport__] __IP__:__ORPort__ [__fingerprint__]::
676 When set along with UseBridges, instructs Tor to use the relay at
677 "IP:ORPort" as a "bridge" relaying into the Tor network. If "fingerprint"
678 is provided (using the same format as for DirAuthority), we will verify that
679 the relay running at that location has the right fingerprint. We also use
680 fingerprint to look up the bridge descriptor at the bridge authority, if
681 it's provided and if UpdateBridgesFromAuthority is set too. +
683 If "transport" is provided, and matches to a ClientTransportPlugin
684 line, we use that pluggable transports proxy to transfer data to
687 [[LearnCircuitBuildTimeout]] **LearnCircuitBuildTimeout** **0**|**1**::
688 If 0, CircuitBuildTimeout adaptive learning is disabled. (Default: 1)
690 [[CircuitBuildTimeout]] **CircuitBuildTimeout** __NUM__::
692 Try for at most NUM seconds when building circuits. If the circuit isn't
693 open in that time, give up on it. If LearnCircuitBuildTimeout is 1, this
694 value serves as the initial value to use before a timeout is learned. If
695 LearnCircuitBuildTimeout is 0, this value is the only value used.
696 (Default: 60 seconds)
698 [[CircuitIdleTimeout]] **CircuitIdleTimeout** __NUM__::
699 If we have kept a clean (never used) circuit around for NUM seconds, then
700 close it. This way when the Tor client is entirely idle, it can expire all
701 of its circuits, and then expire its TLS connections. Also, if we end up
702 making a circuit that is not useful for exiting any of the requests we're
703 receiving, it won't forever take up a slot in the circuit list. (Default: 1
706 [[CircuitStreamTimeout]] **CircuitStreamTimeout** __NUM__::
707 If non-zero, this option overrides our internal timeout schedule for how
708 many seconds until we detach a stream from a circuit and try a new circuit.
709 If your network is particularly slow, you might want to set this to a
710 number like 60. (Default: 0)
712 [[ClientOnly]] **ClientOnly** **0**|**1**::
713 If set to 1, Tor will not run as a relay or serve
714 directory requests, even if the ORPort, ExtORPort, or DirPort options are
715 set. (This config option is
716 mostly unnecessary: we added it back when we were considering having
717 Tor clients auto-promote themselves to being relays if they were stable
718 and fast enough. The current behavior is simply that Tor is a client
719 unless ORPort, ExtORPort, or DirPort are configured.) (Default: 0)
721 [[ExcludeNodes]] **ExcludeNodes** __node__,__node__,__...__::
722 A list of identity fingerprints, country codes, and address
723 patterns of nodes to avoid when building a circuit. Country codes must
724 be wrapped in braces; fingerprints may be preceded by a dollar sign.
726 ExcludeNodes ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
728 By default, this option is treated as a preference that Tor is allowed
729 to override in order to keep working.
730 For example, if you try to connect to a hidden service,
731 but you have excluded all of the hidden service's introduction points,
732 Tor will connect to one of them anyway. If you do not want this
733 behavior, set the StrictNodes option (documented below). +
735 Note also that if you are a relay, this (and the other node selection
736 options below) only affects your own circuits that Tor builds for you.
737 Clients can still build circuits through you to any node. Controllers
738 can tell Tor to build circuits through any node. +
740 Country codes are case-insensitive. The code "\{??}" refers to nodes whose
741 country can't be identified. No country code, including \{??}, works if
742 no GeoIPFile can be loaded. See also the GeoIPExcludeUnknown option below.
745 [[ExcludeExitNodes]] **ExcludeExitNodes** __node__,__node__,__...__::
746 A list of identity fingerprints, country codes, and address
747 patterns of nodes to never use when picking an exit node---that is, a
748 node that delivers traffic for you outside the Tor network. Note that any
749 node listed in ExcludeNodes is automatically considered to be part of this
751 the **ExcludeNodes** option for more information on how to specify
752 nodes. See also the caveats on the "ExitNodes" option below.
754 [[GeoIPExcludeUnknown]] **GeoIPExcludeUnknown** **0**|**1**|**auto**::
755 If this option is set to 'auto', then whenever any country code is set in
756 ExcludeNodes or ExcludeExitNodes, all nodes with unknown country (\{??} and
757 possibly \{A1}) are treated as excluded as well. If this option is set to
758 '1', then all unknown countries are treated as excluded in ExcludeNodes
759 and ExcludeExitNodes. This option has no effect when a GeoIP file isn't
760 configured or can't be found. (Default: auto)
762 [[ExitNodes]] **ExitNodes** __node__,__node__,__...__::
763 A list of identity fingerprints, country codes, and address
764 patterns of nodes to use as exit node---that is, a
765 node that delivers traffic for you outside the Tor network. See
766 the **ExcludeNodes** option for more information on how to specify nodes. +
768 Note that if you list too few nodes here, or if you exclude too many exit
769 nodes with ExcludeExitNodes, you can degrade functionality. For example,
770 if none of the exits you list allows traffic on port 80 or 443, you won't
771 be able to browse the web. +
773 Note also that not every circuit is used to deliver traffic outside of
774 the Tor network. It is normal to see non-exit circuits (such as those
775 used to connect to hidden services, those that do directory fetches,
776 those used for relay reachability self-tests, and so on) that end
777 at a non-exit node. To
778 keep a node from being used entirely, see ExcludeNodes and StrictNodes. +
780 The ExcludeNodes option overrides this option: any node listed in both
781 ExitNodes and ExcludeNodes is treated as excluded. +
783 The .exit address notation, if enabled via AllowDotExit, overrides
786 [[EntryNodes]] **EntryNodes** __node__,__node__,__...__::
787 A list of identity fingerprints and country codes of nodes
788 to use for the first hop in your normal circuits.
789 Normal circuits include all
790 circuits except for direct connections to directory servers. The Bridge
791 option overrides this option; if you have configured bridges and
792 UseBridges is 1, the Bridges are used as your entry nodes. +
794 The ExcludeNodes option overrides this option: any node listed in both
795 EntryNodes and ExcludeNodes is treated as excluded. See
796 the **ExcludeNodes** option for more information on how to specify nodes.
798 [[StrictNodes]] **StrictNodes** **0**|**1**::
799 If StrictNodes is set to 1, Tor will treat the ExcludeNodes option as a
800 requirement to follow for all the circuits you generate, even if doing so
801 will break functionality for you. If StrictNodes is set to 0, Tor will
802 still try to avoid nodes in the ExcludeNodes list, but it will err on the
803 side of avoiding unexpected errors. Specifically, StrictNodes 0 tells
804 Tor that it is okay to use an excluded node when it is *necessary* to
805 perform relay reachability self-tests, connect to
806 a hidden service, provide a hidden service to a client, fulfill a .exit
807 request, upload directory information, or download directory information.
810 [[FascistFirewall]] **FascistFirewall** **0**|**1**::
811 If 1, Tor will only create outgoing connections to ORs running on ports
812 that your firewall allows (defaults to 80 and 443; see **FirewallPorts**).
813 This will allow you to run Tor as a client behind a firewall with
814 restrictive policies, but will not allow you to run as a server behind such
815 a firewall. If you prefer more fine-grained control, use
816 ReachableAddresses instead.
818 [[FirewallPorts]] **FirewallPorts** __PORTS__::
819 A list of ports that your firewall allows you to connect to. Only used when
820 **FascistFirewall** is set. This option is deprecated; use ReachableAddresses
821 instead. (Default: 80, 443)
823 [[ReachableAddresses]] **ReachableAddresses** __ADDR__[/__MASK__][:__PORT__]...::
824 A comma-separated list of IP addresses and ports that your firewall allows
825 you to connect to. The format is as for the addresses in ExitPolicy, except
826 that "accept" is understood unless "reject" is explicitly provided. For
827 example, \'ReachableAddresses 99.0.0.0/8, reject 18.0.0.0/8:80, accept
828 \*:80' means that your firewall allows connections to everything inside net
829 99, rejects port 80 connections to net 18, and accepts connections to port
830 80 otherwise. (Default: \'accept \*:*'.)
832 [[ReachableDirAddresses]] **ReachableDirAddresses** __ADDR__[/__MASK__][:__PORT__]...::
833 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
834 these restrictions when fetching directory information, using standard HTTP
835 GET requests. If not set explicitly then the value of
836 **ReachableAddresses** is used. If **HTTPProxy** is set then these
837 connections will go through that proxy.
839 [[ReachableORAddresses]] **ReachableORAddresses** __ADDR__[/__MASK__][:__PORT__]...::
840 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
841 these restrictions when connecting to Onion Routers, using TLS/SSL. If not
842 set explicitly then the value of **ReachableAddresses** is used. If
843 **HTTPSProxy** is set then these connections will go through that proxy. +
845 The separation between **ReachableORAddresses** and
846 **ReachableDirAddresses** is only interesting when you are connecting
847 through proxies (see **HTTPProxy** and **HTTPSProxy**). Most proxies limit
848 TLS connections (which Tor uses to connect to Onion Routers) to port 443,
849 and some limit HTTP GET requests (which Tor uses for fetching directory
850 information) to port 80.
852 [[HidServAuth]] **HidServAuth** __onion-address__ __auth-cookie__ [__service-name__]::
853 Client authorization for a hidden service. Valid onion addresses contain 16
854 characters in a-z2-7 plus ".onion", and valid auth cookies contain 22
855 characters in A-Za-z0-9+/. The service name is only used for internal
856 purposes, e.g., for Tor controllers. This option may be used multiple times
857 for different hidden services. If a hidden service uses authorization and
858 this option is not set, the hidden service is not accessible. Hidden
859 services can be configured to require authorization using the
860 **HiddenServiceAuthorizeClient** option.
862 [[CloseHSClientCircuitsImmediatelyOnTimeout]] **CloseHSClientCircuitsImmediatelyOnTimeout** **0**|**1**::
863 If 1, Tor will close unfinished hidden service client circuits
864 which have not moved closer to connecting to their destination
865 hidden service when their internal state has not changed for the
866 duration of the current circuit-build timeout. Otherwise, such
867 circuits will be left open, in the hope that they will finish
868 connecting to their destination hidden services. In either case,
869 another set of introduction and rendezvous circuits for the same
870 destination hidden service will be launched. (Default: 0)
872 [[CloseHSServiceRendCircuitsImmediatelyOnTimeout]] **CloseHSServiceRendCircuitsImmediatelyOnTimeout** **0**|**1**::
873 If 1, Tor will close unfinished hidden-service-side rendezvous
874 circuits after the current circuit-build timeout. Otherwise, such
875 circuits will be left open, in the hope that they will finish
876 connecting to their destinations. In either case, another
877 rendezvous circuit for the same destination client will be
878 launched. (Default: 0)
880 [[LongLivedPorts]] **LongLivedPorts** __PORTS__::
881 A list of ports for services that tend to have long-running connections
882 (e.g. chat and interactive shells). Circuits for streams that use these
883 ports will contain only high-uptime nodes, to reduce the chance that a node
884 will go down before the stream is finished. Note that the list is also
885 honored for circuits (both client and service side) involving hidden
886 services whose virtual port is in this list. (Default: 21, 22, 706,
887 1863, 5050, 5190, 5222, 5223, 6523, 6667, 6697, 8300)
889 [[MapAddress]] **MapAddress** __address__ __newaddress__::
890 When a request for address arrives to Tor, it will transform to newaddress
891 before processing it. For example, if you always want connections to
892 www.example.com to exit via __torserver__ (where __torserver__ is the
893 nickname of the server), use "MapAddress www.example.com
894 www.example.com.torserver.exit". If the value is prefixed with a
895 "\*.", matches an entire domain. For example, if you
896 always want connections to example.com and any if its subdomains
898 __torserver__ (where __torserver__ is the nickname of the server), use
899 "MapAddress \*.example.com \*.example.com.torserver.exit". (Note the
900 leading "*." in each part of the directive.) You can also redirect all
901 subdomains of a domain to a single address. For example, "MapAddress
902 *.example.com www.example.com". +
906 1. When evaluating MapAddress expressions Tor stops when it hits the most
907 recently added expression that matches the requested address. So if you
908 have the following in your torrc, www.torproject.org will map to 1.1.1.1:
910 MapAddress www.torproject.org 2.2.2.2
911 MapAddress www.torproject.org 1.1.1.1
913 2. Tor evaluates the MapAddress configuration until it finds no matches. So
914 if you have the following in your torrc, www.torproject.org will map to
917 MapAddress 1.1.1.1 2.2.2.2
918 MapAddress www.torproject.org 1.1.1.1
920 3. The following MapAddress expression is invalid (and will be
921 ignored) because you cannot map from a specific address to a wildcard
924 MapAddress www.torproject.org *.torproject.org.torserver.exit
926 4. Using a wildcard to match only part of a string (as in *ample.com) is
929 [[NewCircuitPeriod]] **NewCircuitPeriod** __NUM__::
930 Every NUM seconds consider whether to build a new circuit. (Default: 30
933 [[MaxCircuitDirtiness]] **MaxCircuitDirtiness** __NUM__::
934 Feel free to reuse a circuit that was first used at most NUM seconds ago,
935 but never attach a new stream to a circuit that is too old. For hidden
936 services, this applies to the __last__ time a circuit was used, not the
937 first. Circuits with streams constructed with SOCKS authentication via
938 SocksPorts that have **KeepAliveIsolateSOCKSAuth** ignore this value.
939 (Default: 10 minutes)
941 [[MaxClientCircuitsPending]] **MaxClientCircuitsPending** __NUM__::
942 Do not allow more than NUM circuits to be pending at a time for handling
943 client streams. A circuit is pending if we have begun constructing it,
944 but it has not yet been completely constructed. (Default: 32)
946 [[NodeFamily]] **NodeFamily** __node__,__node__,__...__::
947 The Tor servers, defined by their identity fingerprints,
948 constitute a "family" of similar or co-administered servers, so never use
949 any two of them in the same circuit. Defining a NodeFamily is only needed
950 when a server doesn't list the family itself (with MyFamily). This option
951 can be used multiple times; each instance defines a separate family. In
952 addition to nodes, you can also list IP address and ranges and country
953 codes in {curly braces}. See the **ExcludeNodes** option for more
954 information on how to specify nodes.
956 [[EnforceDistinctSubnets]] **EnforceDistinctSubnets** **0**|**1**::
957 If 1, Tor will not put two servers whose IP addresses are "too close" on
958 the same circuit. Currently, two addresses are "too close" if they lie in
959 the same /16 range. (Default: 1)
961 [[SOCKSPort]] **SOCKSPort** \['address':]__port__|**unix:**__path__|**auto** [_flags_] [_isolation flags_]::
962 Open this port to listen for connections from SOCKS-speaking
963 applications. Set this to 0 if you don't want to allow application
964 connections via SOCKS. Set it to "auto" to have Tor pick a port for
965 you. This directive can be specified multiple times to bind
966 to multiple addresses/ports. (Default: 9050) +
968 NOTE: Although this option allows you to specify an IP address
969 other than localhost, you should do so only with extreme caution.
970 The SOCKS protocol is unencrypted and (as we use it)
971 unauthenticated, so exposing it in this way could leak your
972 information to anybody watching your network, and allow anybody
973 to use your computer as an open proxy. +
975 The _isolation flags_ arguments give Tor rules for which streams
976 received on this SOCKSPort are allowed to share circuits with one
977 another. Recognized isolation flags are:
978 **IsolateClientAddr**;;
979 Don't share circuits with streams from a different
980 client address. (On by default and strongly recommended;
981 you can disable it with **NoIsolateClientAddr**.)
982 **IsolateSOCKSAuth**;;
983 Don't share circuits with streams for which different
984 SOCKS authentication was provided. (On by default;
985 you can disable it with **NoIsolateSOCKSAuth**.)
986 **IsolateClientProtocol**;;
987 Don't share circuits with streams using a different protocol.
988 (SOCKS 4, SOCKS 5, TransPort connections, NATDPort connections,
989 and DNSPort requests are all considered to be different protocols.)
990 **IsolateDestPort**;;
991 Don't share circuits with streams targeting a different
993 **IsolateDestAddr**;;
994 Don't share circuits with streams targeting a different
996 **KeepAliveIsolateSOCKSAuth**;;
997 If **IsolateSOCKSAuth** is enabled, keep alive circuits that have
998 streams with SOCKS authentication set indefinitely.
999 **SessionGroup=**__INT__;;
1000 If no other isolation rules would prevent it, allow streams
1001 on this port to share circuits with streams from every other
1002 port with the same session group. (By default, streams received
1003 on different SOCKSPorts, TransPorts, etc are always isolated from one
1004 another. This option overrides that behavior.)
1006 [[OtherSOCKSPortFlags]]::
1007 Other recognized __flags__ for a SOCKSPort are:
1009 Tell exits to not connect to IPv4 addresses in response to SOCKS
1010 requests on this connection.
1012 Tell exits to allow IPv6 addresses in response to SOCKS requests on
1013 this connection, so long as SOCKS5 is in use. (SOCKS4 can't handle
1016 Tells exits that, if a host has both an IPv4 and an IPv6 address,
1017 we would prefer to connect to it via IPv6. (IPv4 is the default.) +
1019 Tells the client to remember IPv4 DNS answers we receive from exit
1020 nodes via this connection. (On by default.)
1022 Tells the client to remember IPv6 DNS answers we receive from exit
1023 nodes via this connection.
1025 Unix domain sockets only: makes the socket get created as
1028 Unix domain sockets only: makes the socket get created as
1031 Tells the client to remember all DNS answers we receive from exit
1032 nodes via this connection.
1034 Tells the client to use any cached IPv4 DNS answers we have when making
1035 requests via this connection. (NOTE: This option, along UseIPv6Cache
1036 and UseDNSCache, can harm your anonymity, and probably
1037 won't help performance as much as you might expect. Use with care!)
1039 Tells the client to use any cached IPv6 DNS answers we have when making
1040 requests via this connection.
1042 Tells the client to use any cached DNS answers we have when making
1043 requests via this connection.
1044 **PreferIPv6Automap**;;
1045 When serving a hostname lookup request on this port that
1046 should get automapped (according to AutomapHostsOnResolve),
1047 if we could return either an IPv4 or an IPv6 answer, prefer
1048 an IPv6 answer. (On by default.)
1049 **PreferSOCKSNoAuth**;;
1050 Ordinarily, when an application offers both "username/password
1051 authentication" and "no authentication" to Tor via SOCKS5, Tor
1052 selects username/password authentication so that IsolateSOCKSAuth can
1053 work. This can confuse some applications, if they offer a
1054 username/password combination then get confused when asked for
1055 one. You can disable this behavior, so that Tor will select "No
1056 authentication" when IsolateSOCKSAuth is disabled, or when this
1059 [[SOCKSListenAddress]] **SOCKSListenAddress** __IP__[:__PORT__]::
1060 Bind to this address to listen for connections from Socks-speaking
1061 applications. (Default: 127.0.0.1) You can also specify a port (e.g.
1062 192.168.0.1:9100). This directive can be specified multiple times to bind
1063 to multiple addresses/ports. (DEPRECATED: As of 0.2.3.x-alpha, you can
1064 now use multiple SOCKSPort entries, and provide addresses for SOCKSPort
1065 entries, so SOCKSListenAddress no longer has a purpose. For backward
1066 compatibility, SOCKSListenAddress is only allowed when SOCKSPort is just
1069 [[SocksPolicy]] **SocksPolicy** __policy__,__policy__,__...__::
1070 Set an entrance policy for this server, to limit who can connect to the
1071 SocksPort and DNSPort ports. The policies have the same form as exit
1072 policies below, except that port specifiers are ignored. Any address
1073 not matched by some entry in the policy is accepted.
1075 [[SocksTimeout]] **SocksTimeout** __NUM__::
1076 Let a socks connection wait NUM seconds handshaking, and NUM seconds
1077 unattached waiting for an appropriate circuit, before we fail it. (Default:
1080 [[TokenBucketRefillInterval]] **TokenBucketRefillInterval** __NUM__ [**msec**|**second**]::
1081 Set the refill interval of Tor's token bucket to NUM milliseconds.
1082 NUM must be between 1 and 1000, inclusive. Note that the configured
1083 bandwidth limits are still expressed in bytes per second: this
1084 option only affects the frequency with which Tor checks to see whether
1085 previously exhausted connections may read again. (Default: 100 msec)
1087 [[TrackHostExits]] **TrackHostExits** __host__,__.domain__,__...__::
1088 For each value in the comma separated list, Tor will track recent
1089 connections to hosts that match this value and attempt to reuse the same
1090 exit node for each. If the value is prepended with a \'.\', it is treated as
1091 matching an entire domain. If one of the values is just a \'.', it means
1092 match everything. This option is useful if you frequently connect to sites
1093 that will expire all your authentication cookies (i.e. log you out) if
1094 your IP address changes. Note that this option does have the disadvantage
1095 of making it more clear that a given history is associated with a single
1096 user. However, most people who would wish to observe this will observe it
1097 through cookies or other protocol-specific means anyhow.
1099 [[TrackHostExitsExpire]] **TrackHostExitsExpire** __NUM__::
1100 Since exit servers go up and down, it is desirable to expire the
1101 association between host and exit server after NUM seconds. The default is
1102 1800 seconds (30 minutes).
1104 [[UpdateBridgesFromAuthority]] **UpdateBridgesFromAuthority** **0**|**1**::
1105 When set (along with UseBridges), Tor will try to fetch bridge descriptors
1106 from the configured bridge authorities when feasible. It will fall back to
1107 a direct request if the authority responds with a 404. (Default: 0)
1109 [[UseBridges]] **UseBridges** **0**|**1**::
1110 When set, Tor will fetch descriptors for each bridge listed in the "Bridge"
1111 config lines, and use these relays as both entry guards and directory
1112 guards. (Default: 0)
1114 [[UseEntryGuards]] **UseEntryGuards** **0**|**1**::
1115 If this option is set to 1, we pick a few long-term entry servers, and try
1116 to stick with them. This is desirable because constantly changing servers
1117 increases the odds that an adversary who owns some servers will observe a
1118 fraction of your paths. (Default: 1)
1120 [[UseEntryGuardsAsDirGuards]] **UseEntryGuardsAsDirGuards** **0**|**1**::
1121 If this option is set to 1, and UseEntryGuards is also set to 1,
1122 we try to use our entry guards as directory
1123 guards, and failing that, pick more nodes to act as our directory guards.
1124 This helps prevent an adversary from enumerating clients. It's only
1125 available for clients (non-relay, non-bridge) that aren't configured to
1126 download any non-default directory material. It doesn't currently
1127 do anything when we lack a live consensus. (Default: 1)
1129 [[GuardfractionFile]] **GuardfractionFile** __FILENAME__::
1130 V3 authoritative directories only. Configures the location of the
1131 guardfraction file which contains information about how long relays
1132 have been guards. (Default: unset)
1134 [[UseGuardFraction]] **UseGuardFraction** **0**|**1**|**auto**::
1135 This torrc option specifies whether clients should use the
1136 guardfraction information found in the consensus during path
1137 selection. If it's set to 'auto', clients will do what the
1138 UseGuardFraction consensus parameter tells them to do. (Default: auto)
1140 [[NumEntryGuards]] **NumEntryGuards** __NUM__::
1141 If UseEntryGuards is set to 1, we will try to pick a total of NUM routers
1142 as long-term entries for our circuits. If NUM is 0, we try to learn
1143 the number from the NumEntryGuards consensus parameter, and default
1144 to 3 if the consensus parameter isn't set. (Default: 0)
1146 [[NumDirectoryGuards]] **NumDirectoryGuards** __NUM__::
1147 If UseEntryGuardsAsDirectoryGuards is enabled, we try to make sure we
1148 have at least NUM routers to use as directory guards. If this option
1149 is set to 0, use the value from the NumDirectoryGuards consensus
1150 parameter, falling back to the value from NumEntryGuards if the
1151 consensus parameter is 0 or isn't set. (Default: 0)
1153 [[GuardLifetime]] **GuardLifetime** __N__ **days**|**weeks**|**months**::
1154 If nonzero, and UseEntryGuards is set, minimum time to keep a guard before
1155 picking a new one. If zero, we use the GuardLifetime parameter from the
1156 consensus directory. No value here may be less than 1 month or greater
1157 than 5 years; out-of-range values are clamped. (Default: 0)
1159 [[SafeSocks]] **SafeSocks** **0**|**1**::
1160 When this option is enabled, Tor will reject application connections that
1161 use unsafe variants of the socks protocol -- ones that only provide an IP
1162 address, meaning the application is doing a DNS resolve first.
1163 Specifically, these are socks4 and socks5 when not doing remote DNS.
1166 [[TestSocks]] **TestSocks** **0**|**1**::
1167 When this option is enabled, Tor will make a notice-level log entry for
1168 each connection to the Socks port indicating whether the request used a
1169 safe socks protocol or an unsafe one (see above entry on SafeSocks). This
1170 helps to determine whether an application using Tor is possibly leaking
1171 DNS requests. (Default: 0)
1173 [[WarnUnsafeSocks]] **WarnUnsafeSocks** **0**|**1**::
1174 When this option is enabled, Tor will warn whenever a request is
1175 received that only contains an IP address instead of a hostname. Allowing
1176 applications to do DNS resolves themselves is usually a bad idea and
1177 can leak your location to attackers. (Default: 1)
1179 [[VirtualAddrNetworkIPv4]] **VirtualAddrNetworkIPv4** __Address__/__bits__ +
1181 [[VirtualAddrNetworkIPv6]] **VirtualAddrNetworkIPv6** [__Address__]/__bits__::
1182 When Tor needs to assign a virtual (unused) address because of a MAPADDRESS
1183 command from the controller or the AutomapHostsOnResolve feature, Tor
1184 picks an unassigned address from this range. (Defaults:
1185 127.192.0.0/10 and [FE80::]/10 respectively.) +
1187 When providing proxy server service to a network of computers using a tool
1188 like dns-proxy-tor, change the IPv4 network to "10.192.0.0/10" or
1189 "172.16.0.0/12" and change the IPv6 network to "[FC00]/7".
1190 The default **VirtualAddrNetwork** address ranges on a
1191 properly configured machine will route to the loopback or link-local
1193 local use, no change to the default VirtualAddrNetwork setting is needed.
1195 [[AllowNonRFC953Hostnames]] **AllowNonRFC953Hostnames** **0**|**1**::
1196 When this option is disabled, Tor blocks hostnames containing illegal
1197 characters (like @ and :) rather than sending them to an exit node to be
1198 resolved. This helps trap accidental attempts to resolve URLs and so on.
1201 [[AllowDotExit]] **AllowDotExit** **0**|**1**::
1202 If enabled, we convert "www.google.com.foo.exit" addresses on the
1203 SocksPort/TransPort/NATDPort into "www.google.com" addresses that exit from
1204 the node "foo". Disabled by default since attacking websites and exit
1205 relays can use it to manipulate your path selection. (Default: 0)
1207 [[FastFirstHopPK]] **FastFirstHopPK** **0**|**1**|**auto**::
1208 When this option is disabled, Tor uses the public key step for the first
1209 hop of creating circuits. Skipping it is generally safe since we have
1210 already used TLS to authenticate the relay and to establish forward-secure
1211 keys. Turning this option off makes circuit building a little
1212 slower. Setting this option to "auto" takes advice from the authorities
1213 in the latest consensus about whether to use this feature. +
1215 Note that Tor will always use the public key step for the first hop if it's
1216 operating as a relay, and it will never use the public key step if it
1217 doesn't yet know the onion key of the first hop. (Default: auto)
1219 [[TransPort]] **TransPort** \['address':]__port__|**auto** [_isolation flags_]::
1220 Open this port to listen for transparent proxy connections. Set this to
1221 0 if you don't want to allow transparent proxy connections. Set the port
1222 to "auto" to have Tor pick a port for you. This directive can be
1223 specified multiple times to bind to multiple addresses/ports. See
1224 SOCKSPort for an explanation of isolation flags. +
1226 TransPort requires OS support for transparent proxies, such as BSDs' pf or
1227 Linux's IPTables. If you're planning to use Tor as a transparent proxy for
1228 a network, you'll want to examine and change VirtualAddrNetwork from the
1229 default setting. You'll also want to set the TransListenAddress option for
1230 the network you'd like to proxy. (Default: 0)
1232 [[TransListenAddress]] **TransListenAddress** __IP__[:__PORT__]::
1233 Bind to this address to listen for transparent proxy connections. (Default:
1234 127.0.0.1). This is useful for exporting a transparent proxy server to an
1235 entire network. (DEPRECATED: As of 0.2.3.x-alpha, you can
1236 now use multiple TransPort entries, and provide addresses for TransPort
1237 entries, so TransListenAddress no longer has a purpose. For backward
1238 compatibility, TransListenAddress is only allowed when TransPort is just
1241 [[TransProxyType]] **TransProxyType** **default**|**TPROXY**|**ipfw**|**pf-divert**::
1242 TransProxyType may only be enabled when there is transparent proxy listener
1245 Set this to "TPROXY" if you wish to be able to use the TPROXY Linux module
1246 to transparently proxy connections that are configured using the TransPort
1247 option. This setting lets the listener on the TransPort accept connections
1248 for all addresses, even when the TransListenAddress is configured for an
1249 internal address. Detailed information on how to configure the TPROXY
1250 feature can be found in the Linux kernel source tree in the file
1251 Documentation/networking/tproxy.txt.
1253 Set this option to "ipfw" to use the FreeBSD ipfw interface.
1255 On *BSD operating systems when using pf, set this to "pf-divert" to take
1256 advantage of +divert-to+ rules, which do not modify the packets like
1257 +rdr-to+ rules do. Detailed information on how to configure pf to use
1258 +divert-to+ rules can be found in the pf.conf(5) manual page. On OpenBSD,
1259 +divert-to+ is available to use on versions greater than or equal to
1262 Set this to "default", or leave it unconfigured, to use regular IPTables
1263 on Linux, or to use pf +rdr-to+ rules on *BSD systems.
1265 (Default: "default".)
1267 [[NATDPort]] **NATDPort** \['address':]__port__|**auto** [_isolation flags_]::
1268 Open this port to listen for connections from old versions of ipfw (as
1269 included in old versions of FreeBSD, etc) using the NATD protocol.
1270 Use 0 if you don't want to allow NATD connections. Set the port
1271 to "auto" to have Tor pick a port for you. This directive can be
1272 specified multiple times to bind to multiple addresses/ports. See
1273 SOCKSPort for an explanation of isolation flags. +
1275 This option is only for people who cannot use TransPort. (Default: 0)
1277 [[NATDListenAddress]] **NATDListenAddress** __IP__[:__PORT__]::
1278 Bind to this address to listen for NATD connections. (DEPRECATED: As of
1279 0.2.3.x-alpha, you can now use multiple NATDPort entries, and provide
1280 addresses for NATDPort entries, so NATDListenAddress no longer has a
1281 purpose. For backward compatibility, NATDListenAddress is only allowed
1282 when NATDPort is just a port number.)
1284 [[AutomapHostsOnResolve]] **AutomapHostsOnResolve** **0**|**1**::
1285 When this option is enabled, and we get a request to resolve an address
1286 that ends with one of the suffixes in **AutomapHostsSuffixes**, we map an
1287 unused virtual address to that address, and return the new virtual address.
1288 This is handy for making ".onion" addresses work with applications that
1289 resolve an address and then connect to it. (Default: 0)
1291 [[AutomapHostsSuffixes]] **AutomapHostsSuffixes** __SUFFIX__,__SUFFIX__,__...__::
1292 A comma-separated list of suffixes to use with **AutomapHostsOnResolve**.
1293 The "." suffix is equivalent to "all addresses." (Default: .exit,.onion).
1295 [[DNSPort]] **DNSPort** \['address':]__port__|**auto** [_isolation flags_]::
1296 If non-zero, open this port to listen for UDP DNS requests, and resolve
1297 them anonymously. This port only handles A, AAAA, and PTR requests---it
1298 doesn't handle arbitrary DNS request types. Set the port to "auto" to
1299 have Tor pick a port for
1300 you. This directive can be specified multiple times to bind to multiple
1301 addresses/ports. See SOCKSPort for an explanation of isolation
1304 [[DNSListenAddress]] **DNSListenAddress** __IP__[:__PORT__]::
1305 Bind to this address to listen for DNS connections. (DEPRECATED: As of
1306 0.2.3.x-alpha, you can now use multiple DNSPort entries, and provide
1307 addresses for DNSPort entries, so DNSListenAddress no longer has a
1308 purpose. For backward compatibility, DNSListenAddress is only allowed
1309 when DNSPort is just a port number.)
1311 [[ClientDNSRejectInternalAddresses]] **ClientDNSRejectInternalAddresses** **0**|**1**::
1312 If true, Tor does not believe any anonymously retrieved DNS answer that
1313 tells it that an address resolves to an internal address (like 127.0.0.1 or
1314 192.168.0.1). This option prevents certain browser-based attacks; don't
1315 turn it off unless you know what you're doing. (Default: 1)
1317 [[ClientRejectInternalAddresses]] **ClientRejectInternalAddresses** **0**|**1**::
1318 If true, Tor does not try to fulfill requests to connect to an internal
1319 address (like 127.0.0.1 or 192.168.0.1) __unless a exit node is
1320 specifically requested__ (for example, via a .exit hostname, or a
1321 controller request). (Default: 1)
1323 [[DownloadExtraInfo]] **DownloadExtraInfo** **0**|**1**::
1324 If true, Tor downloads and caches "extra-info" documents. These documents
1325 contain information about servers other than the information in their
1326 regular server descriptors. Tor does not use this information for anything
1327 itself; to save bandwidth, leave this option turned off. (Default: 0)
1329 [[WarnPlaintextPorts]] **WarnPlaintextPorts** __port__,__port__,__...__::
1330 Tells Tor to issue a warnings whenever the user tries to make an anonymous
1331 connection to one of these ports. This option is designed to alert users
1332 to services that risk sending passwords in the clear. (Default:
1335 [[RejectPlaintextPorts]] **RejectPlaintextPorts** __port__,__port__,__...__::
1336 Like WarnPlaintextPorts, but instead of warning about risky port uses, Tor
1337 will instead refuse to make the connection. (Default: None)
1339 [[AllowSingleHopCircuits]] **AllowSingleHopCircuits** **0**|**1**::
1340 When this option is set, the attached Tor controller can use relays
1341 that have the **AllowSingleHopExits** option turned on to build
1342 one-hop Tor connections. (Default: 0)
1344 [[OptimisticData]] **OptimisticData** **0**|**1**|**auto**::
1345 When this option is set, and Tor is using an exit node that supports
1346 the feature, it will try optimistically to send data to the exit node
1347 without waiting for the exit node to report whether the connection
1348 succeeded. This can save a round-trip time for protocols like HTTP
1349 where the client talks first. If OptimisticData is set to **auto**,
1350 Tor will look at the UseOptimisticData parameter in the networkstatus.
1353 [[Tor2webMode]] **Tor2webMode** **0**|**1**::
1354 When this option is set, Tor connects to hidden services
1355 **non-anonymously**. This option also disables client connections to
1356 non-hidden-service hostnames through Tor. It **must only** be used when
1357 running a tor2web Hidden Service web proxy.
1358 To enable this option the compile time flag --enable-tor2webmode must be
1359 specified. (Default: 0)
1361 [[Tor2webRendezvousPoints]] **Tor2webRendezvousPoints** __node__,__node__,__...__::
1362 A list of identity fingerprints, nicknames, country codes and
1363 address patterns of nodes that are allowed to be used as RPs
1364 in HS circuits; any other nodes will not be used as RPs.
1366 Tor2webRendezvousPoints Fastyfasty, ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
1368 This feature can only be used if Tor2webMode is also enabled.
1370 ExcludeNodes have higher priority than Tor2webRendezvousPoints,
1371 which means that nodes specified in ExcludeNodes will not be
1374 If no nodes in Tor2webRendezvousPoints are currently available for
1375 use, Tor will choose a random node when building HS circuits.
1377 [[UseMicrodescriptors]] **UseMicrodescriptors** **0**|**1**|**auto**::
1378 Microdescriptors are a smaller version of the information that Tor needs
1379 in order to build its circuits. Using microdescriptors makes Tor clients
1380 download less directory information, thus saving bandwidth. Directory
1381 caches need to fetch regular descriptors and microdescriptors, so this
1382 option doesn't save any bandwidth for them. If this option is set to
1383 "auto" (recommended) then it is on for all clients that do not set
1384 FetchUselessDescriptors. (Default: auto)
1386 [[UseNTorHandshake]] **UseNTorHandshake** **0**|**1**|**auto**::
1387 The "ntor" circuit-creation handshake is faster and (we think) more
1388 secure than the original ("TAP") circuit handshake, but starting to use
1389 it too early might make your client stand out. If this option is 0, your
1390 Tor client won't use the ntor handshake. If it's 1, your Tor client
1391 will use the ntor handshake to extend circuits through servers that
1392 support it. If this option is "auto", then your client
1393 will use the ntor handshake once enough directory authorities recommend
1396 [[PathBiasCircThreshold]] **PathBiasCircThreshold** __NUM__ +
1398 [[PathBiasNoticeRate]] **PathBiasNoticeRate** __NUM__ +
1400 [[PathBiasWarnRate]] **PathBiasWarnRate** __NUM__ +
1402 [[PathBiasExtremeRate]] **PathBiasExtremeRate** __NUM__ +
1404 [[PathBiasDropGuards]] **PathBiasDropGuards** __NUM__ +
1406 [[PathBiasScaleThreshold]] **PathBiasScaleThreshold** __NUM__::
1407 These options override the default behavior of Tor's (**currently
1408 experimental**) path bias detection algorithm. To try to find broken or
1409 misbehaving guard nodes, Tor looks for nodes where more than a certain
1410 fraction of circuits through that guard fail to get built.
1412 The PathBiasCircThreshold option controls how many circuits we need to build
1413 through a guard before we make these checks. The PathBiasNoticeRate,
1414 PathBiasWarnRate and PathBiasExtremeRate options control what fraction of
1415 circuits must succeed through a guard so we won't write log messages.
1416 If less than PathBiasExtremeRate circuits succeed *and* PathBiasDropGuards
1417 is set to 1, we disable use of that guard. +
1419 When we have seen more than PathBiasScaleThreshold
1420 circuits through a guard, we scale our observations by 0.5 (governed by
1421 the consensus) so that new observations don't get swamped by old ones. +
1423 By default, or if a negative value is provided for one of these options,
1424 Tor uses reasonable defaults from the networkstatus consensus document.
1425 If no defaults are available there, these options default to 150, .70,
1426 .50, .30, 0, and 300 respectively.
1428 [[PathBiasUseThreshold]] **PathBiasUseThreshold** __NUM__ +
1430 [[PathBiasNoticeUseRate]] **PathBiasNoticeUseRate** __NUM__ +
1432 [[PathBiasExtremeUseRate]] **PathBiasExtremeUseRate** __NUM__ +
1434 [[PathBiasScaleUseThreshold]] **PathBiasScaleUseThreshold** __NUM__::
1435 Similar to the above options, these options override the default behavior
1436 of Tor's (**currently experimental**) path use bias detection algorithm.
1438 Where as the path bias parameters govern thresholds for successfully
1439 building circuits, these four path use bias parameters govern thresholds
1440 only for circuit usage. Circuits which receive no stream usage
1441 are not counted by this detection algorithm. A used circuit is considered
1442 successful if it is capable of carrying streams or otherwise receiving
1443 well-formed responses to RELAY cells.
1445 By default, or if a negative value is provided for one of these options,
1446 Tor uses reasonable defaults from the networkstatus consensus document.
1447 If no defaults are available there, these options default to 20, .80,
1448 .60, and 100, respectively.
1450 [[ClientUseIPv6]] **ClientUseIPv6** **0**|**1**::
1451 If this option is set to 1, Tor might connect to entry nodes over
1452 IPv6. Note that clients configured with an IPv6 address in a
1453 **Bridge** line will try connecting over IPv6 even if
1454 **ClientUseIPv6** is set to 0. (Default: 0)
1456 [[ClientPreferIPv6ORPort]] **ClientPreferIPv6ORPort** **0**|**1**::
1457 If this option is set to 1, Tor prefers an OR port with an IPv6
1458 address over one with IPv4 if a given entry node has both. Other
1459 things may influence the choice. This option breaks a tie to the
1460 favor of IPv6. (Default: 0)
1462 [[PathsNeededToBuildCircuits]] **PathsNeededToBuildCircuits** __NUM__::
1463 Tor clients don't build circuits for user traffic until they know
1464 about enough of the network so that they could potentially construct
1465 enough of the possible paths through the network. If this option
1466 is set to a fraction between 0.25 and 0.95, Tor won't build circuits
1467 until it has enough descriptors or microdescriptors to construct
1468 that fraction of possible paths. Note that setting this option too low
1469 can make your Tor client less anonymous, and setting it too high can
1470 prevent your Tor client from bootstrapping. If this option is negative,
1471 Tor will use a default value chosen by the directory
1472 authorities. (Default: -1.)
1477 The following options are useful only for servers (that is, if ORPort
1480 [[Address]] **Address** __address__::
1481 The IP address or fully qualified domain name of this server (e.g.
1482 moria.mit.edu). You can leave this unset, and Tor will guess your IP
1483 address. This IP address is the one used to tell clients and other
1484 servers where to find your Tor server; it doesn't affect the IP that your
1485 Tor client binds to. To bind to a different address, use the
1486 *ListenAddress and OutboundBindAddress options.
1488 [[AllowSingleHopExits]] **AllowSingleHopExits** **0**|**1**::
1489 This option controls whether clients can use this server as a single hop
1490 proxy. If set to 1, clients can use this server as an exit even if it is
1491 the only hop in the circuit. Note that most clients will refuse to use
1492 servers that set this option, since most clients have
1493 ExcludeSingleHopRelays set. (Default: 0)
1495 [[AssumeReachable]] **AssumeReachable** **0**|**1**::
1496 This option is used when bootstrapping a new Tor network. If set to 1,
1497 don't do self-reachability testing; just upload your server descriptor
1498 immediately. If **AuthoritativeDirectory** is also set, this option
1499 instructs the dirserver to bypass remote reachability testing too and list
1500 all connected servers as running.
1502 [[BridgeRelay]] **BridgeRelay** **0**|**1**::
1503 Sets the relay to act as a "bridge" with respect to relaying connections
1504 from bridge users to the Tor network. It mainly causes Tor to publish a
1505 server descriptor to the bridge database, rather than
1506 to the public directory authorities.
1508 [[ContactInfo]] **ContactInfo** __email_address__::
1509 Administrative contact information for this relay or bridge. This line
1510 can be used to contact you if your relay or bridge is misconfigured or
1511 something else goes wrong. Note that we archive and publish all
1512 descriptors containing these lines and that Google indexes them, so
1513 spammers might also collect them. You may want to obscure the fact
1514 that it's an email address and/or generate a new address for this
1517 [[ExitRelay]] **ExitRelay** **0**|**1**|**auto**::
1518 Tells Tor whether to run as an exit relay. If Tor is running as a
1519 non-bridge server, and ExitRelay is set to 1, then Tor allows traffic to
1520 exit according to the ExitPolicy option (or the default ExitPolicy if
1523 If ExitRelay is set to 0, no traffic is allowed to
1524 exit, and the ExitPolicy option is ignored. +
1526 If ExitRelay is set to "auto", then Tor behaves as if it were set to 1, but
1527 warns the user if this would cause traffic to exit. In a future version,
1528 the default value will be 0. (Default: auto)
1530 [[ExitPolicy]] **ExitPolicy** __policy__,__policy__,__...__::
1531 Set an exit policy for this server. Each policy is of the form
1532 "**accept[6]**|**reject[6]** __ADDR__[/__MASK__][:__PORT__]". If /__MASK__ is
1533 omitted then this policy just applies to the host given. Instead of giving
1534 a host or network you can also use "\*" to denote the universe (0.0.0.0/0
1535 and ::/128), or \*4 to denote all IPv4 addresses, and \*6 to denote all
1537 __PORT__ can be a single port number, an interval of ports
1538 "__FROM_PORT__-__TO_PORT__", or "\*". If __PORT__ is omitted, that means
1541 For example, "accept 18.7.22.69:\*,reject 18.0.0.0/8:\*,accept \*:\*" would
1542 reject any IPv4 traffic destined for MIT except for web.mit.edu, and accept
1543 any other IPv4 or IPv6 traffic. +
1545 Tor also allows IPv6 exit policy entries. For instance, "reject6 [FC00::]/7:\*"
1546 rejects all destinations that share 7 most significant bit prefix with
1547 address FC00::. Respectively, "accept6 [C000::]/3:\*" accepts all destinations
1548 that share 3 most significant bit prefix with address C000::. +
1550 accept6 and reject6 only produce IPv6 exit policy entries. Using an IPv4
1551 address with accept6 or reject6 is ignored and generates a warning.
1552 accept/reject allows either IPv4 or IPv6 addresses. Use \*4 as an IPv4
1553 wildcard address, and \*6 as an IPv6 wildcard address. accept/reject *
1554 expands to matching IPv4 and IPv6 wildcard address rules. +
1556 To specify all IPv4 and IPv6 internal and link-local networks (including
1557 0.0.0.0/8, 169.254.0.0/16, 127.0.0.0/8, 192.168.0.0/16, 10.0.0.0/8,
1558 172.16.0.0/12, [::]/8, [FC00::]/7, [FE80::]/10, [FEC0::]/10, [FF00::]/8,
1559 and [::]/127), you can use the "private" alias instead of an address.
1560 ("private" always produces rules for IPv4 and IPv6 addresses, even when
1561 used with accept6/reject6.) +
1563 Private addresses are rejected by default (at the beginning of your exit
1564 policy), along with the configured primary public IPv4 and IPv6 addresses,
1565 and any public IPv4 and IPv6 addresses on any interface on the relay.
1566 These private addresses are rejected unless you set the
1567 ExitPolicyRejectPrivate config option to 0. For example, once you've done
1568 that, you could allow HTTP to 127.0.0.1 and block all other connections to
1569 internal networks with "accept 127.0.0.1:80,reject private:\*", though that
1570 may also allow connections to your own computer that are addressed to its
1571 public (external) IP address. See RFC 1918 and RFC 3330 for more details
1572 about internal and reserved IP address space. +
1574 This directive can be specified multiple times so you don't have to put it
1577 Policies are considered first to last, and the first match wins. If you
1578 want to allow the same ports on IPv4 and IPv6, write your rules using
1579 accept/reject \*. If you want to allow different ports on IPv4 and IPv6,
1580 write your IPv6 rules using accept6/reject6 \*6, and your IPv4 rules using
1581 accept/reject \*4. If you want to \_replace_ the default exit policy, end
1582 your exit policy with either a reject \*:* or an accept \*:*. Otherwise,
1583 you're \_augmenting_ (prepending to) the default exit policy. The default
1598 Since the default exit policy uses accept/reject *, it applies to both
1599 IPv4 and IPv6 addresses.
1601 [[ExitPolicyRejectPrivate]] **ExitPolicyRejectPrivate** **0**|**1**::
1602 Reject all private (local) networks, along with your own configured public
1603 IPv4 and IPv6 addresses, at the beginning of your exit policy. Also reject
1604 any public IPv4 and IPv6 addresses on any interface on the relay. (If
1605 IPv6Exit is not set, all IPv6 addresses will be rejected anyway.)
1606 See above entry on ExitPolicy.
1609 [[IPv6Exit]] **IPv6Exit** **0**|**1**::
1610 If set, and we are an exit node, allow clients to use us for IPv6
1611 traffic. (Default: 0)
1613 [[MaxOnionQueueDelay]] **MaxOnionQueueDelay** __NUM__ [**msec**|**second**]::
1614 If we have more onionskins queued for processing than we can process in
1615 this amount of time, reject new ones. (Default: 1750 msec)
1617 [[MyFamily]] **MyFamily** __node__,__node__,__...__::
1618 Declare that this Tor server is controlled or administered by a group or
1619 organization identical or similar to that of the other servers, defined by
1620 their identity fingerprints. When two servers both declare
1621 that they are in the same \'family', Tor clients will not use them in the
1622 same circuit. (Each server only needs to list the other servers in its
1623 family; it doesn't need to list itself, but it won't hurt.) Do not list
1624 any bridge relay as it would compromise its concealment.
1626 When listing a node, it's better to list it by fingerprint than by
1627 nickname: fingerprints are more reliable.
1629 [[Nickname]] **Nickname** __name__::
1630 Set the server's nickname to \'name'. Nicknames must be between 1 and 19
1631 characters inclusive, and must contain only the characters [a-zA-Z0-9].
1633 [[NumCPUs]] **NumCPUs** __num__::
1634 How many processes to use at once for decrypting onionskins and other
1635 parallelizable operations. If this is set to 0, Tor will try to detect
1636 how many CPUs you have, defaulting to 1 if it can't tell. (Default: 0)
1638 [[ORPort]] **ORPort** \['address':]__PORT__|**auto** [_flags_]::
1639 Advertise this port to listen for connections from Tor clients and
1640 servers. This option is required to be a Tor server.
1641 Set it to "auto" to have Tor pick a port for you. Set it to 0 to not
1642 run an ORPort at all. This option can occur more than once. (Default: 0)
1644 Tor recognizes these flags on each ORPort:
1646 By default, we bind to a port and tell our users about it. If
1647 NoAdvertise is specified, we don't advertise, but listen anyway. This
1648 can be useful if the port everybody will be connecting to (for
1649 example, one that's opened on our firewall) is somewhere else.
1651 By default, we bind to a port and tell our users about it. If
1652 NoListen is specified, we don't bind, but advertise anyway. This
1653 can be useful if something else (for example, a firewall's port
1654 forwarding configuration) is causing connections to reach us.
1656 If the address is absent, or resolves to both an IPv4 and an IPv6
1657 address, only listen to the IPv4 address.
1659 If the address is absent, or resolves to both an IPv4 and an IPv6
1660 address, only listen to the IPv6 address.
1662 For obvious reasons, NoAdvertise and NoListen are mutually exclusive, and
1663 IPv4Only and IPv6Only are mutually exclusive.
1665 [[ORListenAddress]] **ORListenAddress** __IP__[:__PORT__]::
1666 Bind to this IP address to listen for connections from Tor clients and
1667 servers. If you specify a port, bind to this port rather than the one
1668 specified in ORPort. (Default: 0.0.0.0) This directive can be specified
1669 multiple times to bind to multiple addresses/ports.
1671 This option is deprecated; you can get the same behavior with ORPort now
1672 that it supports NoAdvertise and explicit addresses.
1674 [[PortForwarding]] **PortForwarding** **0**|**1**::
1675 Attempt to automatically forward the DirPort and ORPort on a NAT router
1676 connecting this Tor server to the Internet. If set, Tor will try both
1677 NAT-PMP (common on Apple routers) and UPnP (common on routers from other
1678 manufacturers). (Default: 0)
1680 [[PortForwardingHelper]] **PortForwardingHelper** __filename__|__pathname__::
1681 If PortForwarding is set, use this executable to configure the forwarding.
1682 If set to a filename, the system path will be searched for the executable.
1683 If set to a path, only the specified path will be executed.
1684 (Default: tor-fw-helper)
1686 [[PublishServerDescriptor]] **PublishServerDescriptor** **0**|**1**|**v3**|**bridge**,**...**::
1687 This option specifies which descriptors Tor will publish when acting as
1689 choose multiple arguments, separated by commas.
1691 If this option is set to 0, Tor will not publish its
1692 descriptors to any directories. (This is useful if you're testing
1693 out your server, or if you're using a Tor controller that handles directory
1694 publishing for you.) Otherwise, Tor will publish its descriptors of all
1695 type(s) specified. The default is "1",
1696 which means "if running as a server, publish the
1697 appropriate descriptors to the authorities".
1699 [[ShutdownWaitLength]] **ShutdownWaitLength** __NUM__::
1700 When we get a SIGINT and we're a server, we begin shutting down:
1701 we close listeners and start refusing new circuits. After **NUM**
1702 seconds, we exit. If we get a second SIGINT, we exit immediately.
1703 (Default: 30 seconds)
1705 [[SSLKeyLifetime]] **SSLKeyLifetime** __N__ **minutes**|**hours**|**days**|**weeks**::
1706 When creating a link certificate for our outermost SSL handshake,
1707 set its lifetime to this amount of time. If set to 0, Tor will choose
1708 some reasonable random defaults. (Default: 0)
1710 [[HeartbeatPeriod]] **HeartbeatPeriod** __N__ **minutes**|**hours**|**days**|**weeks**::
1711 Log a heartbeat message every **HeartbeatPeriod** seconds. This is
1712 a log level __notice__ message, designed to let you know your Tor
1713 server is still alive and doing useful things. Settings this
1714 to 0 will disable the heartbeat. (Default: 6 hours)
1716 [[AccountingMax]] **AccountingMax** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**|**TBytes**::
1717 Limits the max number of bytes sent and received within a set time period
1718 using a given calculation rule (see: AccountingStart, AccountingRule).
1719 Useful if you need to stay under a specific bandwidth. By default, the
1720 number used for calculation is the max of either the bytes sent or
1721 received. For example, with AccountingMax set to 1 GByte, a server
1722 could send 900 MBytes and receive 800 MBytes and continue running.
1723 It will only hibernate once one of the two reaches 1 GByte. This can
1724 be changed to use the sum of the both bytes received and sent by setting
1725 the AccountingRule option to "sum" (total bandwidth in/out). When the
1726 number of bytes remaining gets low, Tor will stop accepting new connections
1727 and circuits. When the number of bytes is exhausted, Tor will hibernate
1728 until some time in the next accounting period. To prevent all servers
1729 from waking at the same time, Tor will also wait until a random point
1730 in each period before waking up. If you have bandwidth cost issues,
1731 enabling hibernation is preferable to setting a low bandwidth, since
1732 it provides users with a collection of fast servers that are up some
1733 of the time, which is more useful than a set of slow servers that are
1736 [[AccountingRule]] **AccountingRule** **sum**|**max**::
1737 How we determine when our AccountingMax has been reached (when we
1738 should hibernate) during a time interval. Set to "max" to calculate
1739 using the higher of either the sent or received bytes (this is the
1740 default functionality). Set to "sum" to calculate using the sent
1741 plus received bytes. (Default: max)
1743 [[AccountingStart]] **AccountingStart** **day**|**week**|**month** [__day__] __HH:MM__::
1744 Specify how long accounting periods last. If **month** is given, each
1745 accounting period runs from the time __HH:MM__ on the __dayth__ day of one
1746 month to the same day and time of the next. (The day must be between 1 and
1747 28.) If **week** is given, each accounting period runs from the time __HH:MM__
1748 of the __dayth__ day of one week to the same day and time of the next week,
1749 with Monday as day 1 and Sunday as day 7. If **day** is given, each
1750 accounting period runs from the time __HH:MM__ each day to the same time on
1751 the next day. All times are local, and given in 24-hour time. (Default:
1754 [[RefuseUnknownExits]] **RefuseUnknownExits** **0**|**1**|**auto**::
1755 Prevent nodes that don't appear in the consensus from exiting using this
1756 relay. If the option is 1, we always block exit attempts from such
1757 nodes; if it's 0, we never do, and if the option is "auto", then we do
1758 whatever the authorities suggest in the consensus (and block if the consensus
1759 is quiet on the issue). (Default: auto)
1761 [[ServerDNSResolvConfFile]] **ServerDNSResolvConfFile** __filename__::
1762 Overrides the default DNS configuration with the configuration in
1763 __filename__. The file format is the same as the standard Unix
1764 "**resolv.conf**" file (7). This option, like all other ServerDNS options,
1765 only affects name lookups that your server does on behalf of clients.
1766 (Defaults to use the system DNS configuration.)
1768 [[ServerDNSAllowBrokenConfig]] **ServerDNSAllowBrokenConfig** **0**|**1**::
1769 If this option is false, Tor exits immediately if there are problems
1770 parsing the system DNS configuration or connecting to nameservers.
1771 Otherwise, Tor continues to periodically retry the system nameservers until
1772 it eventually succeeds. (Default: 1)
1774 [[ServerDNSSearchDomains]] **ServerDNSSearchDomains** **0**|**1**::
1775 If set to 1, then we will search for addresses in the local search domain.
1776 For example, if this system is configured to believe it is in
1777 "example.com", and a client tries to connect to "www", the client will be
1778 connected to "www.example.com". This option only affects name lookups that
1779 your server does on behalf of clients. (Default: 0)
1781 [[ServerDNSDetectHijacking]] **ServerDNSDetectHijacking** **0**|**1**::
1782 When this option is set to 1, we will test periodically to determine
1783 whether our local nameservers have been configured to hijack failing DNS
1784 requests (usually to an advertising site). If they are, we will attempt to
1785 correct this. This option only affects name lookups that your server does
1786 on behalf of clients. (Default: 1)
1788 [[ServerDNSTestAddresses]] **ServerDNSTestAddresses** __address__,__address__,__...__::
1789 When we're detecting DNS hijacking, make sure that these __valid__ addresses
1790 aren't getting redirected. If they are, then our DNS is completely useless,
1791 and we'll reset our exit policy to "reject *:*". This option only affects
1792 name lookups that your server does on behalf of clients. (Default:
1793 "www.google.com, www.mit.edu, www.yahoo.com, www.slashdot.org")
1795 [[ServerDNSAllowNonRFC953Hostnames]] **ServerDNSAllowNonRFC953Hostnames** **0**|**1**::
1796 When this option is disabled, Tor does not try to resolve hostnames
1797 containing illegal characters (like @ and :) rather than sending them to an
1798 exit node to be resolved. This helps trap accidental attempts to resolve
1799 URLs and so on. This option only affects name lookups that your server does
1800 on behalf of clients. (Default: 0)
1802 [[BridgeRecordUsageByCountry]] **BridgeRecordUsageByCountry** **0**|**1**::
1803 When this option is enabled and BridgeRelay is also enabled, and we have
1804 GeoIP data, Tor keeps a per-country count of how many client
1805 addresses have contacted it so that it can help the bridge authority guess
1806 which countries have blocked access to it. (Default: 1)
1808 [[ServerDNSRandomizeCase]] **ServerDNSRandomizeCase** **0**|**1**::
1809 When this option is set, Tor sets the case of each character randomly in
1810 outgoing DNS requests, and makes sure that the case matches in DNS replies.
1811 This so-called "0x20 hack" helps resist some types of DNS poisoning attack.
1812 For more information, see "Increased DNS Forgery Resistance through
1813 0x20-Bit Encoding". This option only affects name lookups that your server
1814 does on behalf of clients. (Default: 1)
1816 [[GeoIPFile]] **GeoIPFile** __filename__::
1817 A filename containing IPv4 GeoIP data, for use with by-country statistics.
1819 [[GeoIPv6File]] **GeoIPv6File** __filename__::
1820 A filename containing IPv6 GeoIP data, for use with by-country statistics.
1822 [[TLSECGroup]] **TLSECGroup** **P224**|**P256**::
1823 What EC group should we try to use for incoming TLS connections?
1824 P224 is faster, but makes us stand out more. Has no effect if
1825 we're a client, or if our OpenSSL version lacks support for ECDHE.
1828 [[CellStatistics]] **CellStatistics** **0**|**1**::
1830 When this option is enabled, Tor collects statistics about cell
1831 processing (i.e. mean time a cell is spending in a queue, mean
1832 number of cells in a queue and mean number of processed cells per
1833 circuit) and writes them into disk every 24 hours. Onion router
1834 operators may use the statistics for performance monitoring.
1835 If ExtraInfoStatistics is enabled, it will published as part of
1836 extra-info document. (Default: 0)
1838 [[DirReqStatistics]] **DirReqStatistics** **0**|**1**::
1839 Relays and bridges only.
1840 When this option is enabled, a Tor directory writes statistics on the
1841 number and response time of network status requests to disk every 24
1842 hours. Enables relay and bridge operators to monitor how much their
1843 server is being used by clients to learn about Tor network.
1844 If ExtraInfoStatistics is enabled, it will published as part of
1845 extra-info document. (Default: 1)
1847 [[EntryStatistics]] **EntryStatistics** **0**|**1**::
1849 When this option is enabled, Tor writes statistics on the number of
1850 directly connecting clients to disk every 24 hours. Enables relay
1851 operators to monitor how much inbound traffic that originates from
1852 Tor clients passes through their server to go further down the
1853 Tor network. If ExtraInfoStatistics is enabled, it will be published
1854 as part of extra-info document. (Default: 0)
1856 [[ExitPortStatistics]] **ExitPortStatistics** **0**|**1**::
1858 When this option is enabled, Tor writes statistics on the number of
1859 relayed bytes and opened stream per exit port to disk every 24 hours.
1860 Enables exit relay operators to measure and monitor amounts of traffic
1861 that leaves Tor network through their exit node. If ExtraInfoStatistics
1862 is enabled, it will be published as part of extra-info document.
1865 [[ConnDirectionStatistics]] **ConnDirectionStatistics** **0**|**1**::
1867 When this option is enabled, Tor writes statistics on the amounts of
1868 traffic it passes between itself and other relays to disk every 24
1869 hours. Enables relay operators to monitor how much their relay is
1870 being used as middle node in the circuit. If ExtraInfoStatistics is
1871 enabled, it will be published as part of extra-info document.
1874 [[HiddenServiceStatistics]] **HiddenServiceStatistics** **0**|**1**::
1876 When this option is enabled, a Tor relay writes obfuscated
1877 statistics on its role as hidden-service directory, introduction
1878 point, or rendezvous point to disk every 24 hours. If
1879 ExtraInfoStatistics is also enabled, these statistics are further
1880 published to the directory authorities. (Default: 1)
1882 [[ExtraInfoStatistics]] **ExtraInfoStatistics** **0**|**1**::
1883 When this option is enabled, Tor includes previously gathered statistics in
1884 its extra-info documents that it uploads to the directory authorities.
1887 [[ExtendAllowPrivateAddresses]] **ExtendAllowPrivateAddresses** **0**|**1**::
1888 When this option is enabled, Tor routers allow EXTEND request to
1889 localhost, RFC1918 addresses, and so on. This can create security issues;
1890 you should probably leave it off. (Default: 0)
1892 [[MaxMemInQueues]] **MaxMemInQueues** __N__ **bytes**|**KB**|**MB**|**GB**::
1893 This option configures a threshold above which Tor will assume that it
1894 needs to stop queueing or buffering data because it's about to run out of
1895 memory. If it hits this threshold, it will begin killing circuits until
1896 it has recovered at least 10% of this memory. Do not set this option too
1897 low, or your relay may be unreliable under load. This option only
1898 affects some queues, so the actual process size will be larger than
1899 this. If this option is set to 0, Tor will try to pick a reasonable
1900 default based on your system's physical memory. (Default: 0)
1902 [[SigningKeyLifetime]] **SigningKeyLifetime** __N__ **days**|**weeks**|**months**::
1903 For how long should each Ed25519 signing key be valid? Tor uses a
1904 permanent master identity key that can be kept offline, and periodically
1905 generates new "signing" keys that it uses online. This option
1906 configures their lifetime.
1909 [[OfflineMasterKey]] **OfflineMasterKey** **0**|**1**::
1910 If non-zero, the Tor relay will never generate or load its master secret
1911 key. Instead, you'll have to use "tor --keygen" to manage the master
1912 secret key. (Default: 0)
1914 DIRECTORY SERVER OPTIONS
1915 ------------------------
1917 The following options are useful only for directory servers (that is,
1918 if DirPort is non-zero):
1920 [[DirPortFrontPage]] **DirPortFrontPage** __FILENAME__::
1921 When this option is set, it takes an HTML file and publishes it as "/" on
1922 the DirPort. Now relay operators can provide a disclaimer without needing
1923 to set up a separate webserver. There's a sample disclaimer in
1924 contrib/operator-tools/tor-exit-notice.html.
1926 [[HidServDirectoryV2]] **HidServDirectoryV2** **0**|**1**::
1927 When this option is set, Tor accepts and serves v2 hidden service
1928 descriptors. Setting DirPort is not required for this, because clients
1929 connect via the ORPort by default. (Default: 1)
1931 [[DirPort]] **DirPort** \['address':]__PORT__|**auto** [_flags_]::
1932 If this option is nonzero, advertise the directory service on this port.
1933 Set it to "auto" to have Tor pick a port for you. This option can occur
1934 more than once, but only one advertised DirPort is supported: all
1935 but one DirPort must have the **NoAdvertise** flag set. (Default: 0)
1937 The same flags are supported here as are supported by ORPort.
1939 [[DirListenAddress]] **DirListenAddress** __IP__[:__PORT__]::
1940 Bind the directory service to this address. If you specify a port, bind to
1941 this port rather than the one specified in DirPort. (Default: 0.0.0.0)
1942 This directive can be specified multiple times to bind to multiple
1945 This option is deprecated; you can get the same behavior with DirPort now
1946 that it supports NoAdvertise and explicit addresses.
1948 [[DirPolicy]] **DirPolicy** __policy__,__policy__,__...__::
1949 Set an entrance policy for this server, to limit who can connect to the
1950 directory ports. The policies have the same form as exit policies above,
1951 except that port specifiers are ignored. Any address not matched by
1952 some entry in the policy is accepted.
1955 DIRECTORY AUTHORITY SERVER OPTIONS
1956 ----------------------------------
1958 The following options enable operation as a directory authority, and
1959 control how Tor behaves as a directory authority. You should not need
1960 to adjust any of them if you're running a regular relay or exit server
1961 on the public Tor network.
1963 [[AuthoritativeDirectory]] **AuthoritativeDirectory** **0**|**1**::
1964 When this option is set to 1, Tor operates as an authoritative directory
1965 server. Instead of caching the directory, it generates its own list of
1966 good servers, signs it, and sends that to the clients. Unless the clients
1967 already have you listed as a trusted directory, you probably do not want
1968 to set this option. Please coordinate with the other admins at
1969 tor-ops@torproject.org if you think you should be a directory.
1971 [[V3AuthoritativeDirectory]] **V3AuthoritativeDirectory** **0**|**1**::
1972 When this option is set in addition to **AuthoritativeDirectory**, Tor
1973 generates version 3 network statuses and serves descriptors, etc as
1974 described in doc/spec/dir-spec.txt (for Tor clients and servers running at
1977 [[VersioningAuthoritativeDirectory]] **VersioningAuthoritativeDirectory** **0**|**1**::
1978 When this option is set to 1, Tor adds information on which versions of
1979 Tor are still believed safe for use to the published directory. Each
1980 version 1 authority is automatically a versioning authority; version 2
1981 authorities provide this service optionally. See **RecommendedVersions**,
1982 **RecommendedClientVersions**, and **RecommendedServerVersions**.
1984 [[RecommendedVersions]] **RecommendedVersions** __STRING__::
1985 STRING is a comma-separated list of Tor versions currently believed to be
1986 safe. The list is included in each directory, and nodes which pull down the
1987 directory learn whether they need to upgrade. This option can appear
1988 multiple times: the values from multiple lines are spliced together. When
1989 this is set then **VersioningAuthoritativeDirectory** should be set too.
1991 [[RecommendedPackageVersions]] **RecommendedPackageVersions** __PACKAGENAME__ __VERSION__ __URL__ __DIGESTTYPE__**=**__DIGEST__ ::
1992 Adds "package" line to the directory authority's vote. This information
1993 is used to vote on the correct URL and digest for the released versions
1994 of different Tor-related packages, so that the consensus can certify
1995 them. This line may appear any number of times.
1997 [[RecommendedClientVersions]] **RecommendedClientVersions** __STRING__::
1998 STRING is a comma-separated list of Tor versions currently believed to be
1999 safe for clients to use. This information is included in version 2
2000 directories. If this is not set then the value of **RecommendedVersions**
2001 is used. When this is set then **VersioningAuthoritativeDirectory** should
2004 [[BridgeAuthoritativeDir]] **BridgeAuthoritativeDir** **0**|**1**::
2005 When this option is set in addition to **AuthoritativeDirectory**, Tor
2006 accepts and serves server descriptors, but it caches and serves the main
2007 networkstatus documents rather than generating its own. (Default: 0)
2009 [[MinUptimeHidServDirectoryV2]] **MinUptimeHidServDirectoryV2** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2010 Minimum uptime of a v2 hidden service directory to be accepted as such by
2011 authoritative directories. (Default: 25 hours)
2013 [[RecommendedServerVersions]] **RecommendedServerVersions** __STRING__::
2014 STRING is a comma-separated list of Tor versions currently believed to be
2015 safe for servers to use. This information is included in version 2
2016 directories. If this is not set then the value of **RecommendedVersions**
2017 is used. When this is set then **VersioningAuthoritativeDirectory** should
2020 [[ConsensusParams]] **ConsensusParams** __STRING__::
2021 STRING is a space-separated list of key=value pairs that Tor will include
2022 in the "params" line of its networkstatus vote.
2024 [[DirAllowPrivateAddresses]] **DirAllowPrivateAddresses** **0**|**1**::
2025 If set to 1, Tor will accept server descriptors with arbitrary "Address"
2026 elements. Otherwise, if the address is not an IP address or is a private IP
2027 address, it will reject the server descriptor. (Default: 0)
2029 [[AuthDirBadExit]] **AuthDirBadExit** __AddressPattern...__::
2030 Authoritative directories only. A set of address patterns for servers that
2031 will be listed as bad exits in any network status document this authority
2032 publishes, if **AuthDirListBadExits** is set.
2034 (The address pattern syntax here and in the options below
2035 is the same as for exit policies, except that you don't need to say
2036 "accept" or "reject", and ports are not needed.)
2038 [[AuthDirInvalid]] **AuthDirInvalid** __AddressPattern...__::
2039 Authoritative directories only. A set of address patterns for servers that
2040 will never be listed as "valid" in any network status document that this
2041 authority publishes.
2043 [[AuthDirReject]] **AuthDirReject** __AddressPattern__...::
2044 Authoritative directories only. A set of address patterns for servers that
2045 will never be listed at all in any network status document that this
2046 authority publishes, or accepted as an OR address in any descriptor
2047 submitted for publication by this authority.
2049 [[AuthDirBadExitCCs]] **AuthDirBadExitCCs** __CC__,... +
2051 [[AuthDirInvalidCCs]] **AuthDirInvalidCCs** __CC__,... +
2053 [[AuthDirRejectCCs]] **AuthDirRejectCCs** __CC__,...::
2054 Authoritative directories only. These options contain a comma-separated
2055 list of country codes such that any server in one of those country codes
2056 will be marked as a bad exit/invalid for use, or rejected
2059 [[AuthDirListBadExits]] **AuthDirListBadExits** **0**|**1**::
2060 Authoritative directories only. If set to 1, this directory has some
2061 opinion about which nodes are unsuitable as exit nodes. (Do not set this to
2062 1 unless you plan to list non-functioning exits as bad; otherwise, you are
2063 effectively voting in favor of every declared exit as an exit.)
2065 [[AuthDirMaxServersPerAddr]] **AuthDirMaxServersPerAddr** __NUM__::
2066 Authoritative directories only. The maximum number of servers that we will
2067 list as acceptable on a single IP address. Set this to "0" for "no limit".
2070 [[AuthDirMaxServersPerAuthAddr]] **AuthDirMaxServersPerAuthAddr** __NUM__::
2071 Authoritative directories only. Like AuthDirMaxServersPerAddr, but applies
2072 to addresses shared with directory authorities. (Default: 5)
2074 [[AuthDirFastGuarantee]] **AuthDirFastGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
2075 Authoritative directories only. If non-zero, always vote the
2076 Fast flag for any relay advertising this amount of capacity or
2077 more. (Default: 100 KBytes)
2079 [[AuthDirGuardBWGuarantee]] **AuthDirGuardBWGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
2080 Authoritative directories only. If non-zero, this advertised capacity
2081 or more is always sufficient to satisfy the bandwidth requirement
2082 for the Guard flag. (Default: 250 KBytes)
2084 [[AuthDirPinKeys]] **AuthDirPinKeys** **0**|**1**::
2085 Authoritative directories only. If non-zero, do not allow any relay to
2086 publish a descriptor if any other relay has reserved its <Ed25519,RSA>
2087 identity keypair. In all cases, Tor records every keypair it accepts
2088 in a journal if it is new, or if it differs from the most recently
2089 accepted pinning for one of the keys it contains. (Default: 0)
2091 [[BridgePassword]] **BridgePassword** __Password__::
2092 If set, contains an HTTP authenticator that tells a bridge authority to
2093 serve all requested bridge information. Used by the (only partially
2094 implemented) "bridge community" design, where a community of bridge
2095 relay operators all use an alternate bridge directory authority,
2096 and their target user audience can periodically fetch the list of
2097 available community bridges to stay up-to-date. (Default: not set)
2099 [[V3AuthVotingInterval]] **V3AuthVotingInterval** __N__ **minutes**|**hours**::
2100 V3 authoritative directories only. Configures the server's preferred voting
2101 interval. Note that voting will __actually__ happen at an interval chosen
2102 by consensus from all the authorities' preferred intervals. This time
2103 SHOULD divide evenly into a day. (Default: 1 hour)
2105 [[V3AuthVoteDelay]] **V3AuthVoteDelay** __N__ **minutes**|**hours**::
2106 V3 authoritative directories only. Configures the server's preferred delay
2107 between publishing its vote and assuming it has all the votes from all the
2108 other authorities. Note that the actual time used is not the server's
2109 preferred time, but the consensus of all preferences. (Default: 5 minutes)
2111 [[V3AuthDistDelay]] **V3AuthDistDelay** __N__ **minutes**|**hours**::
2112 V3 authoritative directories only. Configures the server's preferred delay
2113 between publishing its consensus and signature and assuming it has all the
2114 signatures from all the other authorities. Note that the actual time used
2115 is not the server's preferred time, but the consensus of all preferences.
2116 (Default: 5 minutes)
2118 [[V3AuthNIntervalsValid]] **V3AuthNIntervalsValid** __NUM__::
2119 V3 authoritative directories only. Configures the number of VotingIntervals
2120 for which each consensus should be valid for. Choosing high numbers
2121 increases network partitioning risks; choosing low numbers increases
2122 directory traffic. Note that the actual number of intervals used is not the
2123 server's preferred number, but the consensus of all preferences. Must be at
2124 least 2. (Default: 3)
2126 [[V3BandwidthsFile]] **V3BandwidthsFile** __FILENAME__::
2127 V3 authoritative directories only. Configures the location of the
2128 bandwidth-authority generated file storing information on relays' measured
2129 bandwidth capacities. (Default: unset)
2131 [[V3AuthUseLegacyKey]] **V3AuthUseLegacyKey** **0**|**1**::
2132 If set, the directory authority will sign consensuses not only with its
2133 own signing key, but also with a "legacy" key and certificate with a
2134 different identity. This feature is used to migrate directory authority
2135 keys in the event of a compromise. (Default: 0)
2137 [[RephistTrackTime]] **RephistTrackTime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2138 Tells an authority, or other node tracking node reliability and history,
2139 that fine-grained information about nodes can be discarded when it hasn't
2140 changed for a given amount of time. (Default: 24 hours)
2142 [[VoteOnHidServDirectoriesV2]] **VoteOnHidServDirectoriesV2** **0**|**1**::
2143 When this option is set in addition to **AuthoritativeDirectory**, Tor
2144 votes on whether to accept relays as hidden service directories.
2147 [[AuthDirHasIPv6Connectivity]] **AuthDirHasIPv6Connectivity** **0**|**1**::
2148 Authoritative directories only. When set to 0, OR ports with an
2149 IPv6 address are being accepted without reachability testing.
2150 When set to 1, IPv6 OR ports are being tested just like IPv4 OR
2153 [[MinMeasuredBWsForAuthToIgnoreAdvertised]] **MinMeasuredBWsForAuthToIgnoreAdvertised** __N__::
2154 A total value, in abstract bandwidth units, describing how much
2155 measured total bandwidth an authority should have observed on the network
2156 before it will treat advertised bandwidths as wholly
2157 unreliable. (Default: 500)
2159 HIDDEN SERVICE OPTIONS
2160 ----------------------
2162 The following options are used to configure a hidden service.
2164 [[HiddenServiceDir]] **HiddenServiceDir** __DIRECTORY__::
2165 Store data files for a hidden service in DIRECTORY. Every hidden service
2166 must have a separate directory. You may use this option multiple times to
2167 specify multiple services. DIRECTORY must be an existing directory.
2168 (Note: in current versions of Tor, if DIRECTORY is a relative path,
2169 it will be relative to current
2170 working directory of Tor instance, not to its DataDirectory. Do not
2171 rely on this behavior; it is not guaranteed to remain the same in future
2174 [[HiddenServicePort]] **HiddenServicePort** __VIRTPORT__ [__TARGET__]::
2175 Configure a virtual port VIRTPORT for a hidden service. You may use this
2176 option multiple times; each time applies to the service using the most
2177 recent HiddenServiceDir. By default, this option maps the virtual port to
2178 the same port on 127.0.0.1 over TCP. You may override the target port,
2179 address, or both by specifying a target of addr, port, addr:port, or
2180 **unix:**__path__. (You can specify an IPv6 target as [addr]:port.)
2181 You may also have multiple lines with the same VIRTPORT: when a user
2182 connects to that VIRTPORT, one of the TARGETs from those lines will be
2185 [[PublishHidServDescriptors]] **PublishHidServDescriptors** **0**|**1**::
2186 If set to 0, Tor will run any hidden services you configure, but it won't
2187 advertise them to the rendezvous directory. This option is only useful if
2188 you're using a Tor controller that handles hidserv publishing for you.
2191 [[HiddenServiceVersion]] **HiddenServiceVersion** __version__,__version__,__...__::
2192 A list of rendezvous service descriptor versions to publish for the hidden
2193 service. Currently, only version 2 is supported. (Default: 2)
2195 [[HiddenServiceAuthorizeClient]] **HiddenServiceAuthorizeClient** __auth-type__ __client-name__,__client-name__,__...__::
2196 If configured, the hidden service is accessible for authorized clients
2197 only. The auth-type can either be \'basic' for a general-purpose
2198 authorization protocol or \'stealth' for a less scalable protocol that also
2199 hides service activity from unauthorized clients. Only clients that are
2200 listed here are authorized to access the hidden service. Valid client names
2201 are 1 to 16 characters long and only use characters in A-Za-z0-9+-_ (no
2202 spaces). If this option is set, the hidden service is not accessible for
2203 clients without authorization any more. Generated authorization data can be
2204 found in the hostname file. Clients need to put this authorization data in
2205 their configuration file using **HidServAuth**.
2207 [[HiddenServiceAllowUnknownPorts]] **HiddenServiceAllowUnknownPorts** **0**|**1**::
2208 If set to 1, then connections to unrecognized ports do not cause the
2209 current hidden service to close rendezvous circuits. (Setting this to 0 is
2210 not an authorization mechanism; it is instead meant to be a mild
2211 inconvenience to port-scanners.) (Default: 0)
2213 [[HiddenServiceMaxStreams]] **HiddenServiceMaxStreams** __N__::
2214 The maximum number of simultaneous streams (connections) per rendezvous
2215 circuit. (Setting this to 0 will allow an unlimited number of simultanous
2216 streams.) (Default: 0)
2218 [[HiddenServiceMaxStreamsCloseCircuit]] **HiddenServiceMaxStreamsCloseCircuit** **0**|**1**::
2219 If set to 1, then exceeding **HiddenServiceMaxStreams** will cause the
2220 offending rendezvous circuit to be torn down, as opposed to stream creation
2221 requests that exceed the limit being silently ignored. (Default: 0)
2223 [[RendPostPeriod]] **RendPostPeriod** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2224 Every time the specified period elapses, Tor uploads any rendezvous
2225 service descriptors to the directory servers. This information is also
2226 uploaded whenever it changes. (Default: 1 hour)
2228 [[HiddenServiceDirGroupReadable]] **HiddenServiceDirGroupReadable** **0**|**1**::
2229 If this option is set to 1, allow the filesystem group to read the
2230 hidden service directory and hostname file. If the option is set to 0,
2231 only owner is able to read the hidden service directory. (Default: 0)
2232 Has no effect on Windows.
2234 [[HiddenServiceNumIntroductionPoints]] **HiddenServiceNumIntroductionPoints** __NUM__::
2235 Number of introduction points the hidden service will have. You can't
2236 have more than 10. (Default: 3)
2238 TESTING NETWORK OPTIONS
2239 -----------------------
2241 The following options are used for running a testing Tor network.
2243 [[TestingTorNetwork]] **TestingTorNetwork** **0**|**1**::
2244 If set to 1, Tor adjusts default values of the configuration options below,
2245 so that it is easier to set up a testing Tor network. May only be set if
2246 non-default set of DirAuthorities is set. Cannot be unset while Tor is
2250 ServerDNSAllowBrokenConfig 1
2251 DirAllowPrivateAddresses 1
2252 EnforceDistinctSubnets 0
2254 AuthDirMaxServersPerAddr 0
2255 AuthDirMaxServersPerAuthAddr 0
2256 ClientDNSRejectInternalAddresses 0
2257 ClientRejectInternalAddresses 0
2258 CountPrivateBandwidth 1
2259 ExitPolicyRejectPrivate 0
2260 ExtendAllowPrivateAddresses 1
2261 V3AuthVotingInterval 5 minutes
2262 V3AuthVoteDelay 20 seconds
2263 V3AuthDistDelay 20 seconds
2264 MinUptimeHidServDirectoryV2 0 seconds
2265 TestingV3AuthInitialVotingInterval 5 minutes
2266 TestingV3AuthInitialVoteDelay 20 seconds
2267 TestingV3AuthInitialDistDelay 20 seconds
2268 TestingAuthDirTimeToLearnReachability 0 minutes
2269 TestingEstimatedDescriptorPropagationTime 0 minutes
2270 TestingServerDownloadSchedule 0, 0, 0, 5, 10, 15, 20, 30, 60
2271 TestingClientDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2272 TestingServerConsensusDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2273 TestingClientConsensusDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2274 TestingBridgeDownloadSchedule 60, 30, 30, 60
2275 TestingClientMaxIntervalWithoutRequest 5 seconds
2276 TestingDirConnectionMaxStall 30 seconds
2277 TestingConsensusMaxDownloadTries 80
2278 TestingDescriptorMaxDownloadTries 80
2279 TestingMicrodescMaxDownloadTries 80
2280 TestingCertMaxDownloadTries 80
2281 TestingEnableConnBwEvent 1
2282 TestingEnableCellStatsEvent 1
2283 TestingEnableTbEmptyEvent 1
2285 [[TestingV3AuthInitialVotingInterval]] **TestingV3AuthInitialVotingInterval** __N__ **minutes**|**hours**::
2286 Like V3AuthVotingInterval, but for initial voting interval before the first
2287 consensus has been created. Changing this requires that
2288 **TestingTorNetwork** is set. (Default: 30 minutes)
2290 [[TestingV3AuthInitialVoteDelay]] **TestingV3AuthInitialVoteDelay** __N__ **minutes**|**hours**::
2291 Like V3AuthVoteDelay, but for initial voting interval before
2292 the first consensus has been created. Changing this requires that
2293 **TestingTorNetwork** is set. (Default: 5 minutes)
2295 [[TestingV3AuthInitialDistDelay]] **TestingV3AuthInitialDistDelay** __N__ **minutes**|**hours**::
2296 Like V3AuthDistDelay, but for initial voting interval before
2297 the first consensus has been created. Changing this requires that
2298 **TestingTorNetwork** is set. (Default: 5 minutes)
2300 [[TestingV3AuthVotingStartOffset]] **TestingV3AuthVotingStartOffset** __N__ **seconds**|**minutes**|**hours**::
2301 Directory authorities offset voting start time by this much.
2302 Changing this requires that **TestingTorNetwork** is set. (Default: 0)
2304 [[TestingAuthDirTimeToLearnReachability]] **TestingAuthDirTimeToLearnReachability** __N__ **minutes**|**hours**::
2305 After starting as an authority, do not make claims about whether routers
2306 are Running until this much time has passed. Changing this requires
2307 that **TestingTorNetwork** is set. (Default: 30 minutes)
2309 [[TestingEstimatedDescriptorPropagationTime]] **TestingEstimatedDescriptorPropagationTime** __N__ **minutes**|**hours**::
2310 Clients try downloading server descriptors from directory caches after this
2311 time. Changing this requires that **TestingTorNetwork** is set. (Default:
2314 [[TestingMinFastFlagThreshold]] **TestingMinFastFlagThreshold** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
2315 Minimum value for the Fast flag. Overrides the ordinary minimum taken
2316 from the consensus when TestingTorNetwork is set. (Default: 0.)
2318 [[TestingServerDownloadSchedule]] **TestingServerDownloadSchedule** __N__,__N__,__...__::
2319 Schedule for when servers should download things in general. Changing this
2320 requires that **TestingTorNetwork** is set. (Default: 0, 0, 0, 60, 60, 120,
2321 300, 900, 2147483647)
2323 [[TestingClientDownloadSchedule]] **TestingClientDownloadSchedule** __N__,__N__,__...__::
2324 Schedule for when clients should download things in general. Changing this
2325 requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2328 [[TestingServerConsensusDownloadSchedule]] **TestingServerConsensusDownloadSchedule** __N__,__N__,__...__::
2329 Schedule for when servers should download consensuses. Changing this
2330 requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2331 1800, 1800, 1800, 1800, 1800, 3600, 7200)
2333 [[TestingClientConsensusDownloadSchedule]] **TestingClientConsensusDownloadSchedule** __N__,__N__,__...__::
2334 Schedule for when clients should download consensuses. Changing this
2335 requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2336 1800, 3600, 3600, 3600, 10800, 21600, 43200)
2338 [[TestingBridgeDownloadSchedule]] **TestingBridgeDownloadSchedule** __N__,__N__,__...__::
2339 Schedule for when clients should download bridge descriptors. Changing this
2340 requires that **TestingTorNetwork** is set. (Default: 3600, 900, 900, 3600)
2342 [[TestingClientMaxIntervalWithoutRequest]] **TestingClientMaxIntervalWithoutRequest** __N__ **seconds**|**minutes**::
2343 When directory clients have only a few descriptors to request, they batch
2344 them until they have more, or until this amount of time has passed.
2345 Changing this requires that **TestingTorNetwork** is set. (Default: 10
2348 [[TestingDirConnectionMaxStall]] **TestingDirConnectionMaxStall** __N__ **seconds**|**minutes**::
2349 Let a directory connection stall this long before expiring it.
2350 Changing this requires that **TestingTorNetwork** is set. (Default:
2353 [[TestingConsensusMaxDownloadTries]] **TestingConsensusMaxDownloadTries** __NUM__::
2354 Try this often to download a consensus before giving up. Changing
2355 this requires that **TestingTorNetwork** is set. (Default: 8)
2357 [[TestingDescriptorMaxDownloadTries]] **TestingDescriptorMaxDownloadTries** __NUM__::
2358 Try this often to download a server descriptor before giving up.
2359 Changing this requires that **TestingTorNetwork** is set. (Default: 8)
2361 [[TestingMicrodescMaxDownloadTries]] **TestingMicrodescMaxDownloadTries** __NUM__::
2362 Try this often to download a microdesc descriptor before giving up.
2363 Changing this requires that **TestingTorNetwork** is set. (Default: 8)
2365 [[TestingCertMaxDownloadTries]] **TestingCertMaxDownloadTries** __NUM__::
2366 Try this often to download a v3 authority certificate before giving up.
2367 Changing this requires that **TestingTorNetwork** is set. (Default: 8)
2369 [[TestingDirAuthVoteExit]] **TestingDirAuthVoteExit** __node__,__node__,__...__::
2370 A list of identity fingerprints, country codes, and
2371 address patterns of nodes to vote Exit for regardless of their
2372 uptime, bandwidth, or exit policy. See the **ExcludeNodes**
2373 option for more information on how to specify nodes.
2375 In order for this option to have any effect, **TestingTorNetwork**
2376 has to be set. See the **ExcludeNodes** option for more
2377 information on how to specify nodes.
2379 [[TestingDirAuthVoteExitIsStrict]] **TestingDirAuthVoteExitIsStrict** **0**|**1** ::
2380 If True (1), a node will never receive the Exit flag unless it is specified
2381 in the **TestingDirAuthVoteExit** list, regardless of its uptime, bandwidth,
2384 In order for this option to have any effect, **TestingTorNetwork**
2387 [[TestingDirAuthVoteGuard]] **TestingDirAuthVoteGuard** __node__,__node__,__...__::
2388 A list of identity fingerprints and country codes and
2389 address patterns of nodes to vote Guard for regardless of their
2390 uptime and bandwidth. See the **ExcludeNodes** option for more
2391 information on how to specify nodes.
2393 In order for this option to have any effect, **TestingTorNetwork**
2396 [[TestingDirAuthVoteGuardIsStrict]] **TestingDirAuthVoteGuardIsStrict** **0**|**1** ::
2397 If True (1), a node will never receive the Guard flag unless it is specified
2398 in the **TestingDirAuthVoteGuard** list, regardless of its uptime and bandwidth.
2400 In order for this option to have any effect, **TestingTorNetwork**
2403 [[TestingDirAuthVoteHSDir]] **TestingDirAuthVoteHSDir** __node__,__node__,__...__::
2404 A list of identity fingerprints and country codes and
2405 address patterns of nodes to vote HSDir for regardless of their
2406 uptime and DirPort. See the **ExcludeNodes** option for more
2407 information on how to specify nodes.
2409 In order for this option to have any effect, **TestingTorNetwork**
2410 and **VoteOnHidServDirectoriesV2** both have to be set.
2412 [[TestingDirAuthVoteHSDirIsStrict]] **TestingDirAuthVoteHSDirIsStrict** **0**|**1** ::
2413 If True (1), a node will never receive the HSDir flag unless it is specified
2414 in the **TestingDirAuthVoteHSDir** list, regardless of its uptime and DirPort.
2416 In order for this option to have any effect, **TestingTorNetwork**
2419 [[TestingEnableConnBwEvent]] **TestingEnableConnBwEvent** **0**|**1**::
2420 If this option is set, then Tor controllers may register for CONN_BW
2421 events. Changing this requires that **TestingTorNetwork** is set.
2424 [[TestingEnableCellStatsEvent]] **TestingEnableCellStatsEvent** **0**|**1**::
2425 If this option is set, then Tor controllers may register for CELL_STATS
2426 events. Changing this requires that **TestingTorNetwork** is set.
2429 [[TestingEnableTbEmptyEvent]] **TestingEnableTbEmptyEvent** **0**|**1**::
2430 If this option is set, then Tor controllers may register for TB_EMPTY
2431 events. Changing this requires that **TestingTorNetwork** is set.
2434 [[TestingMinExitFlagThreshold]] **TestingMinExitFlagThreshold** __N__ **KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
2435 Sets a lower-bound for assigning an exit flag when running as an
2436 authority on a testing network. Overrides the usual default lower bound
2437 of 4 KB. (Default: 0)
2439 [[TestingLinkCertLifetime]] **TestingLinkCertifetime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**|**months**::
2440 Overrides the default lifetime for the certificates used to authenticate
2441 our X509 link cert with our ed25519 signing key.
2444 [[TestingAuthKeyLifetime]] **TestingAuthKeyLifetime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**|**months**::
2445 Overrides the default lifetime for a signing Ed25519 TLS Link authentication
2449 [[TestingLinkKeySlop]] **TestingLinkKeySlop** __N__ **seconds**|**minutes**|**hours**::
2450 [[TestingAuthKeySlop]] **TestingAuthKeySlop** __N__ **seconds**|**minutes**|**hours**::
2451 [[TestingSigningKeySlop]] **TestingSigningKeySlop** __N__ **seconds**|**minutes**|**hours**::
2452 How early before the official expiration of a an Ed25519 signing key do
2453 we replace it and issue a new key?
2454 (Default: 3 hours for link and auth; 1 day for signing.)
2459 Tor catches the following signals:
2461 [[SIGTERM]] **SIGTERM**::
2462 Tor will catch this, clean up and sync to disk if necessary, and exit.
2464 [[SIGINT]] **SIGINT**::
2465 Tor clients behave as with SIGTERM; but Tor servers will do a controlled
2466 slow shutdown, closing listeners and waiting 30 seconds before exiting.
2467 (The delay can be configured with the ShutdownWaitLength config option.)
2469 [[SIGHUP]] **SIGHUP**::
2470 The signal instructs Tor to reload its configuration (including closing and
2471 reopening logs), and kill and restart its helper processes if applicable.
2473 [[SIGUSR1]] **SIGUSR1**::
2474 Log statistics about current connections, past connections, and throughput.
2476 [[SIGUSR2]] **SIGUSR2**::
2477 Switch all logs to loglevel debug. You can go back to the old loglevels by
2480 [[SIGCHLD]] **SIGCHLD**::
2481 Tor receives this signal when one of its helper processes has exited, so it
2484 [[SIGPIPE]] **SIGPIPE**::
2485 Tor catches this signal and ignores it.
2487 [[SIGXFSZ]] **SIGXFSZ**::
2488 If this signal exists on your platform, Tor catches and ignores it.
2493 **@CONFDIR@/torrc**::
2494 The configuration file, which contains "option value" pairs.
2497 Fallback location for torrc, if @CONFDIR@/torrc is not found.
2499 **@LOCALSTATEDIR@/lib/tor/**::
2500 The tor process stores keys and other data here.
2502 __DataDirectory__**/cached-status/**::
2503 The most recently downloaded network status document for each authority.
2504 Each file holds one such document; the filenames are the hexadecimal
2505 identity key fingerprints of the directory authorities. Mostly obsolete.
2507 __DataDirectory__**/cached-certs**::
2508 This file holds downloaded directory key certificates that are used to
2509 verify authenticity of documents generated by Tor directory authorities.
2511 __DataDirectory__**/cached-consensus** and/or **cached-microdesc-consensus**::
2512 The most recent consensus network status document we've downloaded.
2514 __DataDirectory__**/cached-descriptors** and **cached-descriptors.new**::
2515 These files hold downloaded router statuses. Some routers may appear more
2516 than once; if so, the most recently published descriptor is used. Lines
2517 beginning with @-signs are annotations that contain more information about
2518 a given router. The ".new" file is an append-only journal; when it gets
2519 too large, all entries are merged into a new cached-descriptors file.
2521 __DataDirectory__**/cached-microdescs** and **cached-microdescs.new**::
2522 These files hold downloaded microdescriptors. Lines beginning with
2523 @-signs are annotations that contain more information about a given
2524 router. The ".new" file is an append-only journal; when it gets too
2525 large, all entries are merged into a new cached-microdescs file.
2527 __DataDirectory__**/cached-routers** and **cached-routers.new**::
2528 Obsolete versions of cached-descriptors and cached-descriptors.new. When
2529 Tor can't find the newer files, it looks here instead.
2531 __DataDirectory__**/state**::
2532 A set of persistent key-value mappings. These are documented in
2533 the file. These include:
2534 - The current entry guards and their status.
2535 - The current bandwidth accounting values (unused so far; see
2537 - When the file was last written
2538 - What version of Tor generated the state file
2539 - A short history of bandwidth usage, as produced in the server
2542 __DataDirectory__**/bw_accounting**::
2543 Used to track bandwidth accounting values (when the current period starts
2544 and ends; how much has been read and written so far this period). This file
2545 is obsolete, and the data is now stored in the \'state' file as well. Only
2546 used when bandwidth accounting is enabled.
2548 __DataDirectory__**/control_auth_cookie**::
2549 Used for cookie authentication with the controller. Location can be
2550 overridden by the CookieAuthFile config option. Regenerated on startup. See
2551 control-spec.txt for details. Only used when cookie authentication is
2554 __DataDirectory__**/lock**::
2555 This file is used to prevent two Tor instances from using same data
2556 directory. If access to this file is locked, data directory is already
2559 __DataDirectory__**/keys/***::
2560 Only used by servers. Holds identity keys and onion keys.
2562 __DataDirectory__**/fingerprint**::
2563 Only used by servers. Holds the fingerprint of the server's identity key.
2565 __DataDirectory__**/hashed-fingerprint**::
2566 Only used by bridges. Holds the hashed fingerprint of the bridge's
2567 identity key. (That is, the hash of the hash of the identity key.)
2569 __DataDirectory__**/v3-status-votes**::
2570 Only for authoritative directory servers. This file contains status votes
2571 from all the authoritative directory servers and is used to generate the
2572 network consensus document.
2574 __DataDirectory__**/unverified-consensus**::
2575 This file contains a network consensus document that has been downloaded,
2576 but which we didn't have the right certificates to check yet.
2578 __DataDirectory__**/unverified-microdesc-consensus**::
2579 This file contains a microdescriptor-flavored network consensus document
2580 that has been downloaded, but which we didn't have the right certificates
2583 __DataDirectory__**/unparseable-desc**::
2584 Onion server descriptors that Tor was unable to parse are dumped to this
2585 file. Only used for debugging.
2587 __DataDirectory__**/router-stability**::
2588 Only used by authoritative directory servers. Tracks measurements for
2589 router mean-time-between-failures so that authorities have a good idea of
2590 how to set their Stable flags.
2592 __DataDirectory__**/stats/dirreq-stats**::
2593 Only used by directory caches and authorities. This file is used to
2594 collect directory request statistics.
2596 __DataDirectory__**/stats/entry-stats**::
2597 Only used by servers. This file is used to collect incoming connection
2598 statistics by Tor entry nodes.
2600 __DataDirectory__**/stats/bridge-stats**::
2601 Only used by servers. This file is used to collect incoming connection
2602 statistics by Tor bridges.
2604 __DataDirectory__**/stats/exit-stats**::
2605 Only used by servers. This file is used to collect outgoing connection
2606 statistics by Tor exit routers.
2608 __DataDirectory__**/stats/buffer-stats**::
2609 Only used by servers. This file is used to collect buffer usage
2612 __DataDirectory__**/stats/conn-stats**::
2613 Only used by servers. This file is used to collect approximate connection
2614 history (number of active connections over time).
2616 __DataDirectory__**/networkstatus-bridges**::
2617 Only used by authoritative bridge directories. Contains information
2618 about bridges that have self-reported themselves to the bridge
2621 __HiddenServiceDirectory__**/hostname**::
2622 The <base32-encoded-fingerprint>.onion domain name for this hidden service.
2623 If the hidden service is restricted to authorized clients only, this file
2624 also contains authorization data for all clients.
2626 __HiddenServiceDirectory__**/private_key**::
2627 The private key for this hidden service.
2629 __HiddenServiceDirectory__**/client_keys**::
2630 Authorization data for a hidden service that is only accessible by
2635 **torsocks**(1), **torify**(1) +
2637 **https://www.torproject.org/**
2643 Plenty, probably. Tor is still in development. Please report them.
2647 Roger Dingledine [arma at mit.edu], Nick Mathewson [nickm at alum.mit.edu].