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 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-list-deprecated-options]] **--list-deprecated-options**::
88 List all valid options that are scheduled to become obsolete in a
89 future version. (This is a warning, not a promise.)
91 [[opt-version]] **--version**::
92 Display Tor version and exit.
94 [[opt-quiet]] **--quiet**|**--hush**::
95 Override the default console log. By default, Tor starts out logging
96 messages at level "notice" and higher to the console. It stops doing so
97 after it parses its configuration, if the configuration tells it to log
98 anywhere else. You can override this behavior with the **--hush** option,
99 which tells Tor to only send warnings and errors to the console, or with
100 the **--quiet** option, which tells Tor not to log to the console at all.
102 [[opt-keygen]] **--keygen** [**--newpass**]::
103 Running "tor --keygen" creates a new ed25519 master identity key for a
104 relay, or only a fresh temporary signing key and certificate, if you
105 already have a master key. Optionally you can encrypt the master identity
106 key with a passphrase: Tor will ask you for one. If you don't want to
107 encrypt the master key, just don't enter any passphrase when asked. +
109 The **--newpass** option should be used with --keygen only when you need
110 to add, change, or remove a passphrase on an existing ed25519 master
111 identity key. You will be prompted for the old passphase (if any),
112 and the new passphrase (if any). +
114 When generating a master key, you will probably want to use
115 **--DataDirectory** to control where the keys
116 and certificates will be stored, and **--SigningKeyLifetime** to
117 control their lifetimes. Their behavior is as documented in the
118 server options section below. (You must have write access to the specified
121 To use the generated files, you must copy them to the DataDirectory/keys
122 directory of your Tor daemon, and make sure that they are owned by the
123 user actually running the Tor daemon on your system.
125 **--passphrase-fd** __FILEDES__::
126 Filedescriptor to read the passphrase from. Note that unlike with the
127 tor-gencert program, the entire file contents are read and used as
128 the passphrase, including any trailing newlines.
129 Default: read from the terminal.
131 [[opt-key-expiration]] **--key-expiration** [**purpose**]::
132 The **purpose** specifies which type of key certificate to determine
133 the expiration of. The only currently recognised **purpose** is
136 Running "tor --key-expiration sign" will attempt to find your signing
137 key certificate and will output, both in the logs as well as to stdout,
138 the signing key certificate's expiration time in ISO-8601 format.
139 For example, the output sent to stdout will be of the form:
140 "signing-cert-expiry: 2017-07-25 08:30:15 UTC"
142 Other options can be specified on the command-line in the format "--option
143 value", in the format "option value", or in a configuration file. For
144 instance, you can tell Tor to start listening for SOCKS connections on port
145 9999 by passing --SocksPort 9999 or SocksPort 9999 to it on the command line,
146 or by putting "SocksPort 9999" in the configuration file. You will need to
147 quote options with spaces in them: if you want Tor to log all debugging
148 messages to debug.log, you will probably need to say --Log 'debug file
151 Options on the command line override those in configuration files. See the
152 next section for more information.
154 THE CONFIGURATION FILE FORMAT
155 -----------------------------
157 All configuration options in a configuration are written on a single line by
158 default. They take the form of an option name and a value, or an option name
159 and a quoted value (option value or option "value"). Anything after a #
160 character is treated as a comment. Options are
161 case-insensitive. C-style escaped characters are allowed inside quoted
162 values. To split one configuration entry into multiple lines, use a single
163 backslash character (\) before the end of the line. Comments can be used in
164 such multiline entries, but they must start at the beginning of a line.
166 Configuration options can be imported from files or folders using the %include
167 option with the value being a path. If the path is a file, the options from the
168 file will be parsed as if they were written where the %include option is. If
169 the path is a folder, all files on that folder will be parsed following lexical
170 order. Files starting with a dot are ignored. Files on subfolders are ignored.
171 The %include option can be used recursively.
173 By default, an option on the command line overrides an option found in the
174 configuration file, and an option in a configuration file overrides one in
177 This rule is simple for options that take a single value, but it can become
178 complicated for options that are allowed to occur more than once: if you
179 specify four SocksPorts in your configuration file, and one more SocksPort on
180 the command line, the option on the command line will replace __all__ of the
181 SocksPorts in the configuration file. If this isn't what you want, prefix
182 the option name with a plus sign (+), and it will be appended to the previous
183 set of options instead. For example, setting SocksPort 9100 will use only
184 port 9100, but setting +SocksPort 9100 will use ports 9100 and 9050 (because
185 this is the default).
187 Alternatively, you might want to remove every instance of an option in the
188 configuration file, and not replace it at all: you might want to say on the
189 command line that you want no SocksPorts at all. To do that, prefix the
190 option name with a forward slash (/). You can use the plus sign (+) and the
191 forward slash (/) in the configuration file and on the command line.
196 [[BandwidthRate]] **BandwidthRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
197 A token bucket limits the average incoming bandwidth usage on this node
198 to the specified number of bytes per second, and the average outgoing
199 bandwidth usage to that same value. If you want to run a relay in the
200 public network, this needs to be _at the very least_ 75 KBytes for a
201 relay (that is, 600 kbits) or 50 KBytes for a bridge (400 kbits) -- but of
202 course, more is better; we recommend at least 250 KBytes (2 mbits) if
203 possible. (Default: 1 GByte) +
205 Note that this option, and other bandwidth-limiting options, apply to TCP
206 data only: They do not count TCP headers or DNS traffic. +
208 With this option, and in other options that take arguments in bytes,
209 KBytes, and so on, other formats are also supported. Notably, "KBytes" can
210 also be written as "kilobytes" or "kb"; "MBytes" can be written as
211 "megabytes" or "MB"; "kbits" can be written as "kilobits"; and so forth.
212 Tor also accepts "byte" and "bit" in the singular.
213 The prefixes "tera" and "T" are also recognized.
214 If no units are given, we default to bytes.
215 To avoid confusion, we recommend writing "bytes" or "bits" explicitly,
216 since it's easy to forget that "B" means bytes, not bits.
218 [[BandwidthBurst]] **BandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
219 Limit the maximum token bucket size (also known as the burst) to the given
220 number of bytes in each direction. (Default: 1 GByte)
222 [[MaxAdvertisedBandwidth]] **MaxAdvertisedBandwidth** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
223 If set, we will not advertise more than this amount of bandwidth for our
224 BandwidthRate. Server operators who want to reduce the number of clients
225 who ask to build circuits through them (since this is proportional to
226 advertised bandwidth rate) can thus reduce the CPU demands on their server
227 without impacting network performance.
229 [[RelayBandwidthRate]] **RelayBandwidthRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
230 If not 0, a separate token bucket limits the average incoming bandwidth
231 usage for \_relayed traffic_ on this node to the specified number of bytes
232 per second, and the average outgoing bandwidth usage to that same value.
233 Relayed traffic currently is calculated to include answers to directory
234 requests, but that may change in future versions. They do not include directory
235 fetches by the relay (from authority or other relays), because that is considered
236 "client" activity. (Default: 0)
238 [[RelayBandwidthBurst]] **RelayBandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
239 If not 0, limit the maximum token bucket size (also known as the burst) for
240 \_relayed traffic_ to the given number of bytes in each direction.
241 They do not include directory fetches by the relay (from authority
242 or other relays), because that is considered "client" activity. (Default: 0)
244 [[PerConnBWRate]] **PerConnBWRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
245 If set, do separate rate limiting for each connection from a non-relay.
246 You should never need to change this value, since a network-wide value is
247 published in the consensus and your relay will use that value. (Default: 0)
249 [[PerConnBWBurst]] **PerConnBWBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
250 If set, do separate rate limiting for each connection from a non-relay.
251 You should never need to change this value, since a network-wide value is
252 published in the consensus and your relay will use that value. (Default: 0)
254 [[ClientTransportPlugin]] **ClientTransportPlugin** __transport__ socks4|socks5 __IP__:__PORT__::
255 **ClientTransportPlugin** __transport__ exec __path-to-binary__ [options]::
256 In its first form, when set along with a corresponding Bridge line, the Tor
257 client forwards its traffic to a SOCKS-speaking proxy on "IP:PORT".
258 (IPv4 addresses should written as-is; IPv6 addresses should be wrapped in
259 square brackets.) It's the
260 duty of that proxy to properly forward the traffic to the bridge. +
262 In its second form, when set along with a corresponding Bridge line, the Tor
263 client launches the pluggable transport proxy executable in
264 __path-to-binary__ using __options__ as its command-line options, and
265 forwards its traffic to it. It's the duty of that proxy to properly forward
266 the traffic to the bridge.
268 [[ServerTransportPlugin]] **ServerTransportPlugin** __transport__ exec __path-to-binary__ [options]::
269 The Tor relay launches the pluggable transport proxy in __path-to-binary__
270 using __options__ as its command-line options, and expects to receive
271 proxied client traffic from it.
273 [[ServerTransportListenAddr]] **ServerTransportListenAddr** __transport__ __IP__:__PORT__::
274 When this option is set, Tor will suggest __IP__:__PORT__ as the
275 listening address of any pluggable transport proxy that tries to
276 launch __transport__. (IPv4 addresses should written as-is; IPv6
277 addresses should be wrapped in square brackets.)
279 [[ServerTransportOptions]] **ServerTransportOptions** __transport__ __k=v__ __k=v__ ...::
280 When this option is set, Tor will pass the __k=v__ parameters to
281 any pluggable transport proxy that tries to launch __transport__. +
282 (Example: ServerTransportOptions obfs45 shared-secret=bridgepasswd cache=/var/lib/tor/cache)
284 [[ExtORPort]] **ExtORPort** \['address':]__port__|**auto**::
285 Open this port to listen for Extended ORPort connections from your
286 pluggable transports.
288 [[ExtORPortCookieAuthFile]] **ExtORPortCookieAuthFile** __Path__::
289 If set, this option overrides the default location and file name
290 for the Extended ORPort's cookie file -- the cookie file is needed
291 for pluggable transports to communicate through the Extended ORPort.
293 [[ExtORPortCookieAuthFileGroupReadable]] **ExtORPortCookieAuthFileGroupReadable** **0**|**1**::
294 If this option is set to 0, don't allow the filesystem group to read the
295 Extended OR Port cookie file. If the option is set to 1, make the cookie
296 file readable by the default GID. [Making the file readable by other
297 groups is not yet implemented; let us know if you need this for some
298 reason.] (Default: 0)
300 [[ConnLimit]] **ConnLimit** __NUM__::
301 The minimum number of file descriptors that must be available to the Tor
302 process before it will start. Tor will ask the OS for as many file
303 descriptors as the OS will allow (you can find this by "ulimit -H -n").
304 If this number is less than ConnLimit, then Tor will refuse to start. +
306 You probably don't need to adjust this. It has no effect on Windows
307 since that platform lacks getrlimit(). (Default: 1000)
309 [[DisableNetwork]] **DisableNetwork** **0**|**1**::
310 When this option is set, we don't listen for or accept any connections
311 other than controller connections, and we close (and don't reattempt)
313 connections. Controllers sometimes use this option to avoid using
314 the network until Tor is fully configured. (Default: 0)
316 [[ConstrainedSockets]] **ConstrainedSockets** **0**|**1**::
317 If set, Tor will tell the kernel to attempt to shrink the buffers for all
318 sockets to the size specified in **ConstrainedSockSize**. This is useful for
319 virtual servers and other environments where system level TCP buffers may
320 be limited. If you're on a virtual server, and you encounter the "Error
321 creating network socket: No buffer space available" message, you are
322 likely experiencing this problem. +
324 The preferred solution is to have the admin increase the buffer pool for
325 the host itself via /proc/sys/net/ipv4/tcp_mem or equivalent facility;
326 this configuration option is a second-resort. +
328 The DirPort option should also not be used if TCP buffers are scarce. The
329 cached directory requests consume additional sockets which exacerbates
332 You should **not** enable this feature unless you encounter the "no buffer
333 space available" issue. Reducing the TCP buffers affects window size for
334 the TCP stream and will reduce throughput in proportion to round trip
335 time on long paths. (Default: 0)
337 [[ConstrainedSockSize]] **ConstrainedSockSize** __N__ **bytes**|**KBytes**::
338 When **ConstrainedSockets** is enabled the receive and transmit buffers for
339 all sockets will be set to this limit. Must be a value between 2048 and
340 262144, in 1024 byte increments. Default of 8192 is recommended.
342 [[ControlPort]] **ControlPort** __PORT__|**unix:**__path__|**auto** [__flags__]::
343 If set, Tor will accept connections on this port and allow those
344 connections to control the Tor process using the Tor Control Protocol
345 (described in control-spec.txt in
346 https://spec.torproject.org[torspec]). Note: unless you also
347 specify one or more of **HashedControlPassword** or
348 **CookieAuthentication**, setting this option will cause Tor to allow
349 any process on the local host to control it. (Setting both authentication
350 methods means either method is sufficient to authenticate to Tor.) This
351 option is required for many Tor controllers; most use the value of 9051.
352 If a unix domain socket is used, you may quote the path using standard
354 Set it to "auto" to have Tor pick a port for you. (Default: 0) +
356 Recognized flags are...
358 Unix domain sockets only: makes the socket get created as
361 Unix domain sockets only: makes the socket get created as
363 **RelaxDirModeCheck**;;
364 Unix domain sockets only: Do not insist that the directory
365 that holds the socket be read-restricted.
367 [[ControlSocket]] **ControlSocket** __Path__::
368 Like ControlPort, but listens on a Unix domain socket, rather than a TCP
369 socket. '0' disables ControlSocket (Unix and Unix-like systems only.)
371 [[ControlSocketsGroupWritable]] **ControlSocketsGroupWritable** **0**|**1**::
372 If this option is set to 0, don't allow the filesystem group to read and
373 write unix sockets (e.g. ControlSocket). If the option is set to 1, make
374 the control socket readable and writable by the default GID. (Default: 0)
376 [[HashedControlPassword]] **HashedControlPassword** __hashed_password__::
377 Allow connections on the control port if they present
378 the password whose one-way hash is __hashed_password__. You
379 can compute the hash of a password by running "tor --hash-password
380 __password__". You can provide several acceptable passwords by using more
381 than one HashedControlPassword line.
383 [[CookieAuthentication]] **CookieAuthentication** **0**|**1**::
384 If this option is set to 1, allow connections on the control port
385 when the connecting process knows the contents of a file named
386 "control_auth_cookie", which Tor will create in its data directory. This
387 authentication method should only be used on systems with good filesystem
388 security. (Default: 0)
390 [[CookieAuthFile]] **CookieAuthFile** __Path__::
391 If set, this option overrides the default location and file name
392 for Tor's cookie file. (See CookieAuthentication above.)
394 [[CookieAuthFileGroupReadable]] **CookieAuthFileGroupReadable** **0**|**1**::
395 If this option is set to 0, don't allow the filesystem group to read the
396 cookie file. If the option is set to 1, make the cookie file readable by
397 the default GID. [Making the file readable by other groups is not yet
398 implemented; let us know if you need this for some reason.] (Default: 0)
400 [[ControlPortWriteToFile]] **ControlPortWriteToFile** __Path__::
401 If set, Tor writes the address and port of any control port it opens to
402 this address. Usable by controllers to learn the actual control port
403 when ControlPort is set to "auto".
405 [[ControlPortFileGroupReadable]] **ControlPortFileGroupReadable** **0**|**1**::
406 If this option is set to 0, don't allow the filesystem group to read the
407 control port file. If the option is set to 1, make the control port
408 file readable by the default GID. (Default: 0)
410 [[DataDirectory]] **DataDirectory** __DIR__::
411 Store working data in DIR. Can not be changed while tor is running.
412 (Default: ~/.tor if your home directory is not /; otherwise,
413 @LOCALSTATEDIR@/lib/tor. On Windows, the default is
414 your ApplicationData folder.)
416 [[DataDirectoryGroupReadable]] **DataDirectoryGroupReadable** **0**|**1**::
417 If this option is set to 0, don't allow the filesystem group to read the
418 DataDirectory. If the option is set to 1, make the DataDirectory readable
419 by the default GID. (Default: 0)
421 [[CacheDirectory]] **CacheDirectory** __DIR__::
422 Store cached directory data in DIR. Can not be changed while tor is
424 (Default: uses the value of DataDirectory.)
426 [[CacheDirectoryGroupReadable]] **CacheDirectoryGroupReadable** **0**|**1**::
427 If this option is set to 0, don't allow the filesystem group to read the
428 CacheDirectory. If the option is set to 1, make the CacheDirectory readable
429 by the default GID. (Default: 0)
431 [[FallbackDir]] **FallbackDir** __ipv4address__:__port__ orport=__port__ id=__fingerprint__ [weight=__num__] [ipv6=**[**__ipv6address__**]**:__orport__]::
432 When we're unable to connect to any directory cache for directory info
433 (usually because we don't know about any yet) we try a directory authority.
434 Clients also simultaneously try a FallbackDir, to avoid hangs on client
435 startup if a directory authority is down. Clients retry FallbackDirs more
436 often than directory authorities, to reduce the load on the directory
438 By default, the directory authorities are also FallbackDirs. Specifying a
439 FallbackDir replaces Tor's default hard-coded FallbackDirs (if any).
440 (See the **DirAuthority** entry for an explanation of each flag.)
442 [[UseDefaultFallbackDirs]] **UseDefaultFallbackDirs** **0**|**1**::
443 Use Tor's default hard-coded FallbackDirs (if any). (When a
444 FallbackDir line is present, it replaces the hard-coded FallbackDirs,
445 regardless of the value of UseDefaultFallbackDirs.) (Default: 1)
447 [[DirAuthority]] **DirAuthority** [__nickname__] [**flags**] __ipv4address__:__port__ __fingerprint__::
448 Use a nonstandard authoritative directory server at the provided address
449 and port, with the specified key fingerprint. This option can be repeated
450 many times, for multiple authoritative directory servers. Flags are
451 separated by spaces, and determine what kind of an authority this directory
452 is. By default, an authority is not authoritative for any directory style
453 or version unless an appropriate flag is given.
454 Tor will use this authority as a bridge authoritative directory if the
455 "bridge" flag is set. If a flag "orport=**port**" is given, Tor will use the
456 given port when opening encrypted tunnels to the dirserver. If a flag
457 "weight=**num**" is given, then the directory server is chosen randomly
458 with probability proportional to that weight (default 1.0). If a
459 flag "v3ident=**fp**" is given, the dirserver is a v3 directory authority
460 whose v3 long-term signing key has the fingerprint **fp**. Lastly,
461 if an "ipv6=**[**__ipv6address__**]**:__orport__" flag is present, then
463 authority is listening for IPv6 connections on the indicated IPv6 address
466 Tor will contact the authority at __ipv4address__ to
467 download directory documents. The provided __port__ value is a dirport;
468 clients ignore this in favor of the specified "orport=" value. If an
469 IPv6 ORPort is supplied, Tor will
470 also download directory documents at the IPv6 ORPort. +
472 If no **DirAuthority** line is given, Tor will use the default directory
473 authorities. NOTE: this option is intended for setting up a private Tor
474 network with its own directory authorities. If you use it, you will be
475 distinguishable from other users, because you won't believe the same
478 [[DirAuthorityFallbackRate]] **DirAuthorityFallbackRate** __NUM__::
479 When configured to use both directory authorities and fallback
480 directories, the directory authorities also work as fallbacks. They are
481 chosen with their regular weights, multiplied by this number, which
482 should be 1.0 or less. (Default: 1.0)
484 [[AlternateDirAuthority]] **AlternateDirAuthority** [__nickname__] [**flags**] __ipv4address__:__port__ __fingerprint__ +
486 [[AlternateBridgeAuthority]] **AlternateBridgeAuthority** [__nickname__] [**flags**] __ipv4address__:__port__ __ fingerprint__::
487 These options behave as DirAuthority, but they replace fewer of the
488 default directory authorities. Using
489 AlternateDirAuthority replaces the default Tor directory authorities, but
490 leaves the default bridge authorities in
492 AlternateBridgeAuthority replaces the default bridge authority,
493 but leaves the directory authorities alone.
495 [[DisableAllSwap]] **DisableAllSwap** **0**|**1**::
496 If set to 1, Tor will attempt to lock all current and future memory pages,
497 so that memory cannot be paged out. Windows, OS X and Solaris are currently
498 not supported. We believe that this feature works on modern Gnu/Linux
499 distributions, and that it should work on *BSD systems (untested). This
500 option requires that you start your Tor as root, and you should use the
501 **User** option to properly reduce Tor's privileges.
502 Can not be changed while tor is running. (Default: 0)
504 [[DisableDebuggerAttachment]] **DisableDebuggerAttachment** **0**|**1**::
505 If set to 1, Tor will attempt to prevent basic debugging attachment attempts
506 by other processes. This may also keep Tor from generating core files if
507 it crashes. It has no impact for users who wish to attach if they
508 have CAP_SYS_PTRACE or if they are root. We believe that this feature
509 works on modern Gnu/Linux distributions, and that it may also work on *BSD
510 systems (untested). Some modern Gnu/Linux systems such as Ubuntu have the
511 kernel.yama.ptrace_scope sysctl and by default enable it as an attempt to
512 limit the PTRACE scope for all user processes by default. This feature will
513 attempt to limit the PTRACE scope for Tor specifically - it will not attempt
514 to alter the system wide ptrace scope as it may not even exist. If you wish
515 to attach to Tor with a debugger such as gdb or strace you will want to set
516 this to 0 for the duration of your debugging. Normal users should leave it
517 on. Disabling this option while Tor is running is prohibited. (Default: 1)
519 [[FetchDirInfoEarly]] **FetchDirInfoEarly** **0**|**1**::
520 If set to 1, Tor will always fetch directory information like other
521 directory caches, even if you don't meet the normal criteria for fetching
522 early. Normal users should leave it off. (Default: 0)
524 [[FetchDirInfoExtraEarly]] **FetchDirInfoExtraEarly** **0**|**1**::
525 If set to 1, Tor will fetch directory information before other directory
526 caches. It will attempt to download directory information closer to the
527 start of the consensus period. Normal users should leave it off.
530 [[FetchHidServDescriptors]] **FetchHidServDescriptors** **0**|**1**::
531 If set to 0, Tor will never fetch any hidden service descriptors from the
532 rendezvous directories. This option is only useful if you're using a Tor
533 controller that handles hidden service fetches for you. (Default: 1)
535 [[FetchServerDescriptors]] **FetchServerDescriptors** **0**|**1**::
536 If set to 0, Tor will never fetch any network status summaries or server
537 descriptors from the directory servers. This option is only useful if
538 you're using a Tor controller that handles directory fetches for you.
541 [[FetchUselessDescriptors]] **FetchUselessDescriptors** **0**|**1**::
542 If set to 1, Tor will fetch every consensus flavor, descriptor, and
543 certificate that it hears about. Otherwise, it will avoid fetching useless
544 descriptors: flavors that it is not using to build circuits, and authority
545 certificates it does not trust. This option is useful if you're using a
546 tor client with an external parser that uses a full consensus.
547 This option fetches all documents, **DirCache** fetches and serves
548 all documents. (Default: 0)
550 [[HTTPProxy]] **HTTPProxy** __host__[:__port__]::
551 Tor will make all its directory requests through this host:port (or host:80
552 if port is not specified), rather than connecting directly to any directory
553 servers. (DEPRECATED: As of 0.3.1.0-alpha you should use HTTPSProxy.)
555 [[HTTPProxyAuthenticator]] **HTTPProxyAuthenticator** __username:password__::
556 If defined, Tor will use this username:password for Basic HTTP proxy
557 authentication, as in RFC 2617. This is currently the only form of HTTP
558 proxy authentication that Tor supports; feel free to submit a patch if you
559 want it to support others. (DEPRECATED: As of 0.3.1.0-alpha you should use
560 HTTPSProxyAuthenticator.)
562 [[HTTPSProxy]] **HTTPSProxy** __host__[:__port__]::
563 Tor will make all its OR (SSL) connections through this host:port (or
564 host:443 if port is not specified), via HTTP CONNECT rather than connecting
565 directly to servers. You may want to set **FascistFirewall** to restrict
566 the set of ports you might try to connect to, if your HTTPS proxy only
567 allows connecting to certain ports.
569 [[HTTPSProxyAuthenticator]] **HTTPSProxyAuthenticator** __username:password__::
570 If defined, Tor will use this username:password for Basic HTTPS proxy
571 authentication, as in RFC 2617. This is currently the only form of HTTPS
572 proxy authentication that Tor supports; feel free to submit a patch if you
573 want it to support others.
575 [[Sandbox]] **Sandbox** **0**|**1**::
576 If set to 1, Tor will run securely through the use of a syscall sandbox.
577 Otherwise the sandbox will be disabled. The option is currently an
578 experimental feature. It only works on Linux-based operating systems,
579 and only when Tor has been built with the libseccomp library. This option
580 can not be changed while tor is running.
582 When the Sandbox is 1, the following options can not be changed when tor
588 ExtORPortCookieAuthFile
590 ServerDNSResolvConfFile
591 Tor must remain in client or server mode (some changes to ClientOnly and
592 ORPort are not allowed).
595 [[Socks4Proxy]] **Socks4Proxy** __host__[:__port__]::
596 Tor will make all OR connections through the SOCKS 4 proxy at host:port
597 (or host:1080 if port is not specified).
599 [[Socks5Proxy]] **Socks5Proxy** __host__[:__port__]::
600 Tor will make all OR connections through the SOCKS 5 proxy at host:port
601 (or host:1080 if port is not specified).
603 [[Socks5ProxyUsername]] **Socks5ProxyUsername** __username__ +
605 [[Socks5ProxyPassword]] **Socks5ProxyPassword** __password__::
606 If defined, authenticate to the SOCKS 5 server using username and password
607 in accordance to RFC 1929. Both username and password must be between 1 and
610 [[SocksSocketsGroupWritable]] **SocksSocketsGroupWritable** **0**|**1**::
611 If this option is set to 0, don't allow the filesystem group to read and
612 write unix sockets (e.g. SocksSocket). If the option is set to 1, make
613 the SocksSocket socket readable and writable by the default GID. (Default: 0)
615 [[KeepalivePeriod]] **KeepalivePeriod** __NUM__::
616 To keep firewalls from expiring connections, send a padding keepalive cell
617 every NUM seconds on open connections that are in use. If the connection
618 has no open circuits, it will instead be closed after NUM seconds of
619 idleness. (Default: 5 minutes)
621 [[Log]] **Log** __minSeverity__[-__maxSeverity__] **stderr**|**stdout**|**syslog**::
622 Send all messages between __minSeverity__ and __maxSeverity__ to the standard
623 output stream, the standard error stream, or to the system log. (The
624 "syslog" value is only supported on Unix.) Recognized severity levels are
625 debug, info, notice, warn, and err. We advise using "notice" in most cases,
626 since anything more verbose may provide sensitive information to an
627 attacker who obtains the logs. If only one severity level is given, all
628 messages of that level or higher will be sent to the listed destination.
630 [[Log2]] **Log** __minSeverity__[-__maxSeverity__] **file** __FILENAME__::
631 As above, but send log messages to the listed filename. The
632 "Log" option may appear more than once in a configuration file.
633 Messages are sent to all the logs that match their severity
636 [[Log3]] **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **file** __FILENAME__ +
638 [[Log4]] **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **stderr**|**stdout**|**syslog**::
639 As above, but select messages by range of log severity __and__ by a
640 set of "logging domains". Each logging domain corresponds to an area of
641 functionality inside Tor. You can specify any number of severity ranges
642 for a single log statement, each of them prefixed by a comma-separated
643 list of logging domains. You can prefix a domain with $$~$$ to indicate
644 negation, and use * to indicate "all domains". If you specify a severity
645 range without a list of domains, it matches all domains. +
647 This is an advanced feature which is most useful for debugging one or two
648 of Tor's subsystems at a time. +
650 The currently recognized domains are: general, crypto, net, config, fs,
651 protocol, mm, http, app, control, circ, rend, bug, dir, dirserv, or, edge,
652 acct, hist, and handshake. Domain names are case-insensitive. +
654 For example, "`Log [handshake]debug [~net,~mm]info notice stdout`" sends
655 to stdout: all handshake messages of any severity, all info-and-higher
656 messages from domains other than networking and memory management, and all
657 messages of severity notice or higher.
659 [[LogMessageDomains]] **LogMessageDomains** **0**|**1**::
660 If 1, Tor includes message domains with each log message. Every log
661 message currently has at least one domain; most currently have exactly
662 one. This doesn't affect controller log messages. (Default: 0)
664 [[MaxUnparseableDescSizeToLog]] **MaxUnparseableDescSizeToLog** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**::
665 Unparseable descriptors (e.g. for votes, consensuses, routers) are logged
666 in separate files by hash, up to the specified size in total. Note that
667 only files logged during the lifetime of this Tor process count toward the
668 total; this is intended to be used to debug problems without opening live
669 servers to resource exhaustion attacks. (Default: 10 MB)
671 [[OutboundBindAddress]] **OutboundBindAddress** __IP__::
672 Make all outbound connections originate from the IP address specified. This
673 is only useful when you have multiple network interfaces, and you want all
674 of Tor's outgoing connections to use a single one. This option may
675 be used twice, once with an IPv4 address and once with an IPv6 address.
676 IPv6 addresses should be wrapped in square brackets.
677 This setting will be ignored for connections to the loopback addresses
678 (127.0.0.0/8 and ::1).
680 [[OutboundBindAddressOR]] **OutboundBindAddressOR** __IP__::
681 Make all outbound non-exit (relay and other) connections
682 originate from the IP address specified. This option overrides
683 **OutboundBindAddress** for the same IP version. This option may
684 be used twice, once with an IPv4 address and once with an IPv6
685 address. IPv6 addresses should be wrapped in square brackets.
686 This setting will be ignored for connections to the loopback
687 addresses (127.0.0.0/8 and ::1).
689 [[OutboundBindAddressExit]] **OutboundBindAddressExit** __IP__::
690 Make all outbound exit connections originate from the IP address
691 specified. This option overrides **OutboundBindAddress** for the
692 same IP version. This option may be used twice, once with an IPv4
693 address and once with an IPv6 address.
694 IPv6 addresses should be wrapped in square brackets.
695 This setting will be ignored
696 for connections to the loopback addresses (127.0.0.0/8 and ::1).
698 [[PidFile]] **PidFile** __FILE__::
699 On startup, write our PID to FILE. On clean shutdown, remove
700 FILE. Can not be changed while tor is running.
702 [[ProtocolWarnings]] **ProtocolWarnings** **0**|**1**::
703 If 1, Tor will log with severity \'warn' various cases of other parties not
704 following the Tor specification. Otherwise, they are logged with severity
705 \'info'. (Default: 0)
707 [[RunAsDaemon]] **RunAsDaemon** **0**|**1**::
708 If 1, Tor forks and daemonizes to the background. This option has no effect
709 on Windows; instead you should use the --service command-line option.
710 Can not be changed while tor is running.
713 [[LogTimeGranularity]] **LogTimeGranularity** __NUM__::
714 Set the resolution of timestamps in Tor's logs to NUM milliseconds.
715 NUM must be positive and either a divisor or a multiple of 1 second.
716 Note that this option only controls the granularity written by Tor to
717 a file or console log. Tor does not (for example) "batch up" log
718 messages to affect times logged by a controller, times attached to
719 syslog messages, or the mtime fields on log files. (Default: 1 second)
721 [[TruncateLogFile]] **TruncateLogFile** **0**|**1**::
722 If 1, Tor will overwrite logs at startup and in response to a HUP signal,
723 instead of appending to them. (Default: 0)
725 [[SyslogIdentityTag]] **SyslogIdentityTag** __tag__::
726 When logging to syslog, adds a tag to the syslog identity such that
727 log entries are marked with "Tor-__tag__". Can not be changed while tor is
728 running. (Default: none)
730 [[AndroidIdentityTag]] **AndroidIdentityTag** __tag__::
731 When logging to Android's logging subsystem, adds a tag to the log identity
732 such that log entries are marked with "Tor-__tag__". Can not be changed while
733 tor is running. (Default: none)
735 [[SafeLogging]] **SafeLogging** **0**|**1**|**relay**::
736 Tor can scrub potentially sensitive strings from log messages (e.g.
737 addresses) by replacing them with the string [scrubbed]. This way logs can
738 still be useful, but they don't leave behind personally identifying
739 information about what sites a user might have visited. +
741 If this option is set to 0, Tor will not perform any scrubbing, if it is
742 set to 1, all potentially sensitive strings are replaced. If it is set to
743 relay, all log messages generated when acting as a relay are sanitized, but
744 all messages generated when acting as a client are not. (Default: 1)
746 [[User]] **User** __Username__::
747 On startup, setuid to this user and setgid to their primary group.
748 Can not be changed while tor is running.
750 [[KeepBindCapabilities]] **KeepBindCapabilities** **0**|**1**|**auto**::
751 On Linux, when we are started as root and we switch our identity using
752 the **User** option, the **KeepBindCapabilities** option tells us whether to
753 try to retain our ability to bind to low ports. If this value is 1, we
754 try to keep the capability; if it is 0 we do not; and if it is **auto**,
755 we keep the capability only if we are configured to listen on a low port.
756 Can not be changed while tor is running.
759 [[HardwareAccel]] **HardwareAccel** **0**|**1**::
760 If non-zero, try to use built-in (static) crypto hardware acceleration when
761 available. Can not be changed while tor is running. (Default: 0)
763 [[AccelName]] **AccelName** __NAME__::
764 When using OpenSSL hardware crypto acceleration attempt to load the dynamic
765 engine of this name. This must be used for any dynamic hardware engine.
766 Names can be verified with the openssl engine command. Can not be changed
767 while tor is running.
769 [[AccelDir]] **AccelDir** __DIR__::
770 Specify this option if using dynamic hardware acceleration and the engine
771 implementation library resides somewhere other than the OpenSSL default.
772 Can not be changed while tor is running.
774 [[AvoidDiskWrites]] **AvoidDiskWrites** **0**|**1**::
775 If non-zero, try to write to disk less frequently than we would otherwise.
776 This is useful when running on flash memory or other media that support
777 only a limited number of writes. (Default: 0)
779 [[CircuitPriorityHalflife]] **CircuitPriorityHalflife** __NUM1__::
780 If this value is set, we override the default algorithm for choosing which
781 circuit's cell to deliver or relay next. When the value is 0, we
782 round-robin between the active circuits on a connection, delivering one
783 cell from each in turn. When the value is positive, we prefer delivering
784 cells from whichever connection has the lowest weighted cell count, where
785 cells are weighted exponentially according to the supplied
786 CircuitPriorityHalflife value (in seconds). If this option is not set at
787 all, we use the behavior recommended in the current consensus
788 networkstatus. This is an advanced option; you generally shouldn't have
789 to mess with it. (Default: not set)
791 [[CountPrivateBandwidth]] **CountPrivateBandwidth** **0**|**1**::
792 If this option is set, then Tor's rate-limiting applies not only to
793 remote connections, but also to connections to private addresses like
794 127.0.0.1 or 10.0.0.1. This is mostly useful for debugging
795 rate-limiting. (Default: 0)
797 [[ExtendByEd25519ID]] **ExtendByEd25519ID** **0**|**1**|**auto**::
798 If this option is set to 1, we always try to include a relay's Ed25519 ID
799 when telling the proceeding relay in a circuit to extend to it.
800 If this option is set to 0, we never include Ed25519 IDs when extending
801 circuits. If the option is set to "default", we obey a
802 parameter in the consensus document. (Default: auto)
804 [[NoExec]] **NoExec** **0**|**1**::
805 If this option is set to 1, then Tor will never launch another
806 executable, regardless of the settings of PortForwardingHelper,
807 ClientTransportPlugin, or ServerTransportPlugin. Once this
808 option has been set to 1, it cannot be set back to 0 without
809 restarting Tor. (Default: 0)
811 [[Schedulers]] **Schedulers** **KIST**|**KISTLite**|**Vanilla**::
812 Specify the scheduler type that tor should use. The scheduler is
813 responsible for moving data around within a Tor process. This is an ordered
814 list by priority which means that the first value will be tried first and if
815 unavailable, the second one is tried and so on. It is possible to change
816 these values at runtime. This option mostly effects relays, and most
817 operators should leave it set to its default value.
818 (Default: KIST,KISTLite,Vanilla)
820 The possible scheduler types are:
822 **KIST**: Kernel-Informed Socket Transport. Tor will use TCP information
823 from the kernel to make informed decisions regarding how much data to send
824 and when to send it. KIST also handles traffic in batches (see
825 KISTSchedRunInterval) in order to improve traffic prioritization decisions.
826 As implemented, KIST will only work on Linux kernel version 2.6.39 or
829 **KISTLite**: Same as KIST but without kernel support. Tor will use all
830 the same mechanics as with KIST, including the batching, but its decisions
831 regarding how much data to send will not be as good. KISTLite will work on
832 all kernels and operating systems, and the majority of the benefits of KIST
833 are still realized with KISTLite.
835 **Vanilla**: The scheduler that Tor used before KIST was implemented. It
836 sends as much data as possible, as soon as possible. Vanilla will work on
837 all kernels and operating systems.
839 [[KISTSchedRunInterval]] **KISTSchedRunInterval** __NUM__ **msec**::
840 If KIST or KISTLite is used in the Schedulers option, this controls at which
841 interval the scheduler tick is. If the value is 0 msec, the value is taken
842 from the consensus if possible else it will fallback to the default 10
843 msec. Maximum possible value is 100 msec. (Default: 0 msec)
845 [[KISTSockBufSizeFactor]] **KISTSockBufSizeFactor** __NUM__::
846 If KIST is used in Schedulers, this is a multiplier of the per-socket
847 limit calculation of the KIST algorithm. (Default: 1.0)
852 The following options are useful only for clients (that is, if
853 **SocksPort**, **HTTPTunnelPort**, **TransPort**, **DNSPort**, or
854 **NATDPort** is non-zero):
856 [[Bridge]] **Bridge** [__transport__] __IP__:__ORPort__ [__fingerprint__]::
857 When set along with UseBridges, instructs Tor to use the relay at
858 "IP:ORPort" as a "bridge" relaying into the Tor network. If "fingerprint"
859 is provided (using the same format as for DirAuthority), we will verify that
860 the relay running at that location has the right fingerprint. We also use
861 fingerprint to look up the bridge descriptor at the bridge authority, if
862 it's provided and if UpdateBridgesFromAuthority is set too. +
864 If "transport" is provided, it must match a ClientTransportPlugin line. We
865 then use that pluggable transport's proxy to transfer data to the bridge,
866 rather than connecting to the bridge directly. Some transports use a
867 transport-specific method to work out the remote address to connect to.
868 These transports typically ignore the "IP:ORPort" specified in the bridge
871 Tor passes any "key=val" settings to the pluggable transport proxy as
872 per-connection arguments when connecting to the bridge. Consult
873 the documentation of the pluggable transport for details of what
874 arguments it supports.
876 [[LearnCircuitBuildTimeout]] **LearnCircuitBuildTimeout** **0**|**1**::
877 If 0, CircuitBuildTimeout adaptive learning is disabled. (Default: 1)
879 [[CircuitBuildTimeout]] **CircuitBuildTimeout** __NUM__::
881 Try for at most NUM seconds when building circuits. If the circuit isn't
882 open in that time, give up on it. If LearnCircuitBuildTimeout is 1, this
883 value serves as the initial value to use before a timeout is learned. If
884 LearnCircuitBuildTimeout is 0, this value is the only value used.
885 (Default: 60 seconds)
887 [[CircuitsAvailableTimeout]] **CircuitsAvailableTimeout** __NUM__::
888 Tor will attempt to keep at least one open, unused circuit available for
889 this amount of time. This option governs how long idle circuits are kept
890 open, as well as the amount of time Tor will keep a circuit open to each
891 of the recently used ports. This way when the Tor client is entirely
892 idle, it can expire all of its circuits, and then expire its TLS
893 connections. Note that the actual timeout value is uniformly randomized
894 from the specified value to twice that amount. (Default: 30 minutes;
897 [[CircuitStreamTimeout]] **CircuitStreamTimeout** __NUM__::
898 If non-zero, this option overrides our internal timeout schedule for how
899 many seconds until we detach a stream from a circuit and try a new circuit.
900 If your network is particularly slow, you might want to set this to a
901 number like 60. (Default: 0)
903 [[ClientOnly]] **ClientOnly** **0**|**1**::
904 If set to 1, Tor will not run as a relay or serve
905 directory requests, even if the ORPort, ExtORPort, or DirPort options are
906 set. (This config option is
907 mostly unnecessary: we added it back when we were considering having
908 Tor clients auto-promote themselves to being relays if they were stable
909 and fast enough. The current behavior is simply that Tor is a client
910 unless ORPort, ExtORPort, or DirPort are configured.) (Default: 0)
912 [[ConnectionPadding]] **ConnectionPadding** **0**|**1**|**auto**::
913 This option governs Tor's use of padding to defend against some forms of
914 traffic analysis. If it is set to 'auto', Tor will send padding only
915 if both the client and the relay support it. If it is set to 0, Tor will
916 not send any padding cells. If it is set to 1, Tor will still send padding
917 for client connections regardless of relay support. Only clients may set
918 this option. This option should be offered via the UI to mobile users
919 for use where bandwidth may be expensive.
922 [[ReducedConnectionPadding]] **ReducedConnectionPadding** **0**|**1**::
923 If set to 1, Tor will not not hold OR connections open for very long,
924 and will send less padding on these connections. Only clients may set
925 this option. This option should be offered via the UI to mobile users
926 for use where bandwidth may be expensive. (Default: 0)
928 [[ExcludeNodes]] **ExcludeNodes** __node__,__node__,__...__::
929 A list of identity fingerprints, country codes, and address
930 patterns of nodes to avoid when building a circuit. Country codes are
931 2-letter ISO3166 codes, and must
932 be wrapped in braces; fingerprints may be preceded by a dollar sign.
934 ExcludeNodes ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
936 By default, this option is treated as a preference that Tor is allowed
937 to override in order to keep working.
938 For example, if you try to connect to a hidden service,
939 but you have excluded all of the hidden service's introduction points,
940 Tor will connect to one of them anyway. If you do not want this
941 behavior, set the StrictNodes option (documented below). +
943 Note also that if you are a relay, this (and the other node selection
944 options below) only affects your own circuits that Tor builds for you.
945 Clients can still build circuits through you to any node. Controllers
946 can tell Tor to build circuits through any node. +
948 Country codes are case-insensitive. The code "\{??}" refers to nodes whose
949 country can't be identified. No country code, including \{??}, works if
950 no GeoIPFile can be loaded. See also the GeoIPExcludeUnknown option below.
953 [[ExcludeExitNodes]] **ExcludeExitNodes** __node__,__node__,__...__::
954 A list of identity fingerprints, country codes, and address
955 patterns of nodes to never use when picking an exit node---that is, a
956 node that delivers traffic for you *outside* the Tor network. Note that any
957 node listed in ExcludeNodes is automatically considered to be part of this
959 the **ExcludeNodes** option for more information on how to specify
960 nodes. See also the caveats on the "ExitNodes" option below.
962 [[GeoIPExcludeUnknown]] **GeoIPExcludeUnknown** **0**|**1**|**auto**::
963 If this option is set to 'auto', then whenever any country code is set in
964 ExcludeNodes or ExcludeExitNodes, all nodes with unknown country (\{??} and
965 possibly \{A1}) are treated as excluded as well. If this option is set to
966 '1', then all unknown countries are treated as excluded in ExcludeNodes
967 and ExcludeExitNodes. This option has no effect when a GeoIP file isn't
968 configured or can't be found. (Default: auto)
970 [[ExitNodes]] **ExitNodes** __node__,__node__,__...__::
971 A list of identity fingerprints, country codes, and address
972 patterns of nodes to use as exit node---that is, a
973 node that delivers traffic for you *outside* the Tor network. See
974 the **ExcludeNodes** option for more information on how to specify nodes. +
976 Note that if you list too few nodes here, or if you exclude too many exit
977 nodes with ExcludeExitNodes, you can degrade functionality. For example,
978 if none of the exits you list allows traffic on port 80 or 443, you won't
979 be able to browse the web. +
981 Note also that not every circuit is used to deliver traffic *outside* of
982 the Tor network. It is normal to see non-exit circuits (such as those
983 used to connect to hidden services, those that do directory fetches,
984 those used for relay reachability self-tests, and so on) that end
985 at a non-exit node. To
986 keep a node from being used entirely, see ExcludeNodes and StrictNodes. +
988 The ExcludeNodes option overrides this option: any node listed in both
989 ExitNodes and ExcludeNodes is treated as excluded. +
991 The .exit address notation, if enabled via MapAddress, overrides
994 [[EntryNodes]] **EntryNodes** __node__,__node__,__...__::
995 A list of identity fingerprints and country codes of nodes
996 to use for the first hop in your normal circuits.
997 Normal circuits include all
998 circuits except for direct connections to directory servers. The Bridge
999 option overrides this option; if you have configured bridges and
1000 UseBridges is 1, the Bridges are used as your entry nodes. +
1002 The ExcludeNodes option overrides this option: any node listed in both
1003 EntryNodes and ExcludeNodes is treated as excluded. See
1004 the **ExcludeNodes** option for more information on how to specify nodes.
1006 [[StrictNodes]] **StrictNodes** **0**|**1**::
1007 If StrictNodes is set to 1, Tor will treat solely the ExcludeNodes option
1008 as a requirement to follow for all the circuits you generate, even if
1009 doing so will break functionality for you (StrictNodes applies to neither
1010 ExcludeExitNodes nor to ExitNodes). If StrictNodes is set to 0, Tor will
1011 still try to avoid nodes in the ExcludeNodes list, but it will err on the
1012 side of avoiding unexpected errors. Specifically, StrictNodes 0 tells Tor
1013 that it is okay to use an excluded node when it is *necessary* to perform
1014 relay reachability self-tests, connect to a hidden service, provide a
1015 hidden service to a client, fulfill a .exit request, upload directory
1016 information, or download directory information. (Default: 0)
1018 [[FascistFirewall]] **FascistFirewall** **0**|**1**::
1019 If 1, Tor will only create outgoing connections to ORs running on ports
1020 that your firewall allows (defaults to 80 and 443; see **FirewallPorts**).
1021 This will allow you to run Tor as a client behind a firewall with
1022 restrictive policies, but will not allow you to run as a server behind such
1023 a firewall. If you prefer more fine-grained control, use
1024 ReachableAddresses instead.
1026 [[FirewallPorts]] **FirewallPorts** __PORTS__::
1027 A list of ports that your firewall allows you to connect to. Only used when
1028 **FascistFirewall** is set. This option is deprecated; use ReachableAddresses
1029 instead. (Default: 80, 443)
1031 [[ReachableAddresses]] **ReachableAddresses** __IP__[/__MASK__][:__PORT__]...::
1032 A comma-separated list of IP addresses and ports that your firewall allows
1033 you to connect to. The format is as for the addresses in ExitPolicy, except
1034 that "accept" is understood unless "reject" is explicitly provided. For
1035 example, \'ReachableAddresses 99.0.0.0/8, reject 18.0.0.0/8:80, accept
1036 \*:80' means that your firewall allows connections to everything inside net
1037 99, rejects port 80 connections to net 18, and accepts connections to port
1038 80 otherwise. (Default: \'accept \*:*'.)
1040 [[ReachableDirAddresses]] **ReachableDirAddresses** __IP__[/__MASK__][:__PORT__]...::
1041 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
1042 these restrictions when fetching directory information, using standard HTTP
1043 GET requests. If not set explicitly then the value of
1044 **ReachableAddresses** is used. If **HTTPProxy** is set then these
1045 connections will go through that proxy. (DEPRECATED: This option has
1046 had no effect for some time.)
1048 [[ReachableORAddresses]] **ReachableORAddresses** __IP__[/__MASK__][:__PORT__]...::
1049 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
1050 these restrictions when connecting to Onion Routers, using TLS/SSL. If not
1051 set explicitly then the value of **ReachableAddresses** is used. If
1052 **HTTPSProxy** is set then these connections will go through that proxy. +
1054 The separation between **ReachableORAddresses** and
1055 **ReachableDirAddresses** is only interesting when you are connecting
1056 through proxies (see **HTTPProxy** and **HTTPSProxy**). Most proxies limit
1057 TLS connections (which Tor uses to connect to Onion Routers) to port 443,
1058 and some limit HTTP GET requests (which Tor uses for fetching directory
1059 information) to port 80.
1061 [[HidServAuth]] **HidServAuth** __onion-address__ __auth-cookie__ [__service-name__]::
1062 Client authorization for a hidden service. Valid onion addresses contain 16
1063 characters in a-z2-7 plus ".onion", and valid auth cookies contain 22
1064 characters in A-Za-z0-9+/. The service name is only used for internal
1065 purposes, e.g., for Tor controllers. This option may be used multiple times
1066 for different hidden services. If a hidden service uses authorization and
1067 this option is not set, the hidden service is not accessible. Hidden
1068 services can be configured to require authorization using the
1069 **HiddenServiceAuthorizeClient** option.
1071 [[LongLivedPorts]] **LongLivedPorts** __PORTS__::
1072 A list of ports for services that tend to have long-running connections
1073 (e.g. chat and interactive shells). Circuits for streams that use these
1074 ports will contain only high-uptime nodes, to reduce the chance that a node
1075 will go down before the stream is finished. Note that the list is also
1076 honored for circuits (both client and service side) involving hidden
1077 services whose virtual port is in this list. (Default: 21, 22, 706,
1078 1863, 5050, 5190, 5222, 5223, 6523, 6667, 6697, 8300)
1080 [[MapAddress]] **MapAddress** __address__ __newaddress__::
1081 When a request for address arrives to Tor, it will transform to newaddress
1082 before processing it. For example, if you always want connections to
1083 www.example.com to exit via __torserver__ (where __torserver__ is the
1084 fingerprint of the server), use "MapAddress www.example.com
1085 www.example.com.torserver.exit". If the value is prefixed with a
1086 "\*.", matches an entire domain. For example, if you
1087 always want connections to example.com and any if its subdomains
1089 __torserver__ (where __torserver__ is the fingerprint of the server), use
1090 "MapAddress \*.example.com \*.example.com.torserver.exit". (Note the
1091 leading "*." in each part of the directive.) You can also redirect all
1092 subdomains of a domain to a single address. For example, "MapAddress
1093 *.example.com www.example.com". +
1097 1. When evaluating MapAddress expressions Tor stops when it hits the most
1098 recently added expression that matches the requested address. So if you
1099 have the following in your torrc, www.torproject.org will map to 1.1.1.1:
1101 MapAddress www.torproject.org 2.2.2.2
1102 MapAddress www.torproject.org 1.1.1.1
1104 2. Tor evaluates the MapAddress configuration until it finds no matches. So
1105 if you have the following in your torrc, www.torproject.org will map to
1108 MapAddress 1.1.1.1 2.2.2.2
1109 MapAddress www.torproject.org 1.1.1.1
1111 3. The following MapAddress expression is invalid (and will be
1112 ignored) because you cannot map from a specific address to a wildcard
1115 MapAddress www.torproject.org *.torproject.org.torserver.exit
1117 4. Using a wildcard to match only part of a string (as in *ample.com) is
1120 [[NewCircuitPeriod]] **NewCircuitPeriod** __NUM__::
1121 Every NUM seconds consider whether to build a new circuit. (Default: 30
1124 [[MaxCircuitDirtiness]] **MaxCircuitDirtiness** __NUM__::
1125 Feel free to reuse a circuit that was first used at most NUM seconds ago,
1126 but never attach a new stream to a circuit that is too old. For hidden
1127 services, this applies to the __last__ time a circuit was used, not the
1128 first. Circuits with streams constructed with SOCKS authentication via
1129 SocksPorts that have **KeepAliveIsolateSOCKSAuth** also remain alive
1130 for MaxCircuitDirtiness seconds after carrying the last such stream.
1131 (Default: 10 minutes)
1133 [[MaxClientCircuitsPending]] **MaxClientCircuitsPending** __NUM__::
1134 Do not allow more than NUM circuits to be pending at a time for handling
1135 client streams. A circuit is pending if we have begun constructing it,
1136 but it has not yet been completely constructed. (Default: 32)
1138 [[NodeFamily]] **NodeFamily** __node__,__node__,__...__::
1139 The Tor servers, defined by their identity fingerprints,
1140 constitute a "family" of similar or co-administered servers, so never use
1141 any two of them in the same circuit. Defining a NodeFamily is only needed
1142 when a server doesn't list the family itself (with MyFamily). This option
1143 can be used multiple times; each instance defines a separate family. In
1144 addition to nodes, you can also list IP address and ranges and country
1145 codes in {curly braces}. See the **ExcludeNodes** option for more
1146 information on how to specify nodes.
1148 [[EnforceDistinctSubnets]] **EnforceDistinctSubnets** **0**|**1**::
1149 If 1, Tor will not put two servers whose IP addresses are "too close" on
1150 the same circuit. Currently, two addresses are "too close" if they lie in
1151 the same /16 range. (Default: 1)
1153 [[SocksPort]] **SocksPort** \['address':]__port__|**unix:**__path__|**auto** [_flags_] [_isolation flags_]::
1154 Open this port to listen for connections from SOCKS-speaking
1155 applications. Set this to 0 if you don't want to allow application
1156 connections via SOCKS. Set it to "auto" to have Tor pick a port for
1157 you. This directive can be specified multiple times to bind
1158 to multiple addresses/ports. If a unix domain socket is used, you may
1159 quote the path using standard C escape sequences.
1162 NOTE: Although this option allows you to specify an IP address
1163 other than localhost, you should do so only with extreme caution.
1164 The SOCKS protocol is unencrypted and (as we use it)
1165 unauthenticated, so exposing it in this way could leak your
1166 information to anybody watching your network, and allow anybody
1167 to use your computer as an open proxy. +
1169 The _isolation flags_ arguments give Tor rules for which streams
1170 received on this SocksPort are allowed to share circuits with one
1171 another. Recognized isolation flags are:
1172 **IsolateClientAddr**;;
1173 Don't share circuits with streams from a different
1174 client address. (On by default and strongly recommended when
1175 supported; you can disable it with **NoIsolateClientAddr**.
1176 Unsupported and force-disabled when using Unix domain sockets.)
1177 **IsolateSOCKSAuth**;;
1178 Don't share circuits with streams for which different
1179 SOCKS authentication was provided. (For HTTPTunnelPort
1180 connections, this option looks at the Proxy-Authorization and
1181 X-Tor-Stream-Isolation headers. On by default;
1182 you can disable it with **NoIsolateSOCKSAuth**.)
1183 **IsolateClientProtocol**;;
1184 Don't share circuits with streams using a different protocol.
1185 (SOCKS 4, SOCKS 5, TransPort connections, NATDPort connections,
1186 and DNSPort requests are all considered to be different protocols.)
1187 **IsolateDestPort**;;
1188 Don't share circuits with streams targeting a different
1190 **IsolateDestAddr**;;
1191 Don't share circuits with streams targeting a different
1192 destination address.
1193 **KeepAliveIsolateSOCKSAuth**;;
1194 If **IsolateSOCKSAuth** is enabled, keep alive circuits while they have
1195 at least one stream with SOCKS authentication active. After such a circuit
1196 is idle for more than MaxCircuitDirtiness seconds, it can be closed.
1197 **SessionGroup=**__INT__;;
1198 If no other isolation rules would prevent it, allow streams
1199 on this port to share circuits with streams from every other
1200 port with the same session group. (By default, streams received
1201 on different SocksPorts, TransPorts, etc are always isolated from one
1202 another. This option overrides that behavior.)
1204 [[OtherSocksPortFlags]]::
1205 Other recognized __flags__ for a SocksPort are:
1207 Tell exits to not connect to IPv4 addresses in response to SOCKS
1208 requests on this connection.
1210 Tell exits to allow IPv6 addresses in response to SOCKS requests on
1211 this connection, so long as SOCKS5 is in use. (SOCKS4 can't handle
1214 Tells exits that, if a host has both an IPv4 and an IPv6 address,
1215 we would prefer to connect to it via IPv6. (IPv4 is the default.)
1217 Do not ask exits to resolve DNS addresses in SOCKS5 requests. Tor will
1218 connect to IPv4 addresses, IPv6 addresses (if IPv6Traffic is set) and
1220 **NoOnionTraffic**;;
1221 Do not connect to .onion addresses in SOCKS5 requests.
1222 **OnionTrafficOnly**;;
1223 Tell the tor client to only connect to .onion addresses in response to
1224 SOCKS5 requests on this connection. This is equivalent to NoDNSRequest,
1225 NoIPv4Traffic, NoIPv6Traffic. The corresponding NoOnionTrafficOnly
1226 flag is not supported.
1228 Tells the client to remember IPv4 DNS answers we receive from exit
1229 nodes via this connection. (On by default.)
1231 Tells the client to remember IPv6 DNS answers we receive from exit
1232 nodes via this connection.
1234 Unix domain sockets only: makes the socket get created as
1237 Unix domain sockets only: makes the socket get created as
1240 Tells the client to remember all DNS answers we receive from exit
1241 nodes via this connection.
1243 Tells the client to use any cached IPv4 DNS answers we have when making
1244 requests via this connection. (NOTE: This option, or UseIPv6Cache
1245 or UseDNSCache, can harm your anonymity, and probably
1246 won't help performance as much as you might expect. Use with care!)
1248 Tells the client to use any cached IPv6 DNS answers we have when making
1249 requests via this connection.
1251 Tells the client to use any cached DNS answers we have when making
1252 requests via this connection.
1253 **PreferIPv6Automap**;;
1254 When serving a hostname lookup request on this port that
1255 should get automapped (according to AutomapHostsOnResolve),
1256 if we could return either an IPv4 or an IPv6 answer, prefer
1257 an IPv6 answer. (On by default.)
1258 **PreferSOCKSNoAuth**;;
1259 Ordinarily, when an application offers both "username/password
1260 authentication" and "no authentication" to Tor via SOCKS5, Tor
1261 selects username/password authentication so that IsolateSOCKSAuth can
1262 work. This can confuse some applications, if they offer a
1263 username/password combination then get confused when asked for
1264 one. You can disable this behavior, so that Tor will select "No
1265 authentication" when IsolateSOCKSAuth is disabled, or when this
1268 [[SocksPortFlagsMisc]]::
1269 Flags are processed left to right. If flags conflict, the last flag on the
1270 line is used, and all earlier flags are ignored. No error is issued for
1273 [[SocksPolicy]] **SocksPolicy** __policy__,__policy__,__...__::
1274 Set an entrance policy for this server, to limit who can connect to the
1275 SocksPort and DNSPort ports. The policies have the same form as exit
1276 policies below, except that port specifiers are ignored. Any address
1277 not matched by some entry in the policy is accepted.
1279 [[SocksTimeout]] **SocksTimeout** __NUM__::
1280 Let a socks connection wait NUM seconds handshaking, and NUM seconds
1281 unattached waiting for an appropriate circuit, before we fail it. (Default:
1284 [[TokenBucketRefillInterval]] **TokenBucketRefillInterval** __NUM__ [**msec**|**second**]::
1285 Set the refill interval of Tor's token bucket to NUM milliseconds.
1286 NUM must be between 1 and 1000, inclusive. Note that the configured
1287 bandwidth limits are still expressed in bytes per second: this
1288 option only affects the frequency with which Tor checks to see whether
1289 previously exhausted connections may read again.
1290 Can not be changed while tor is running. (Default: 100 msec)
1292 [[TrackHostExits]] **TrackHostExits** __host__,__.domain__,__...__::
1293 For each value in the comma separated list, Tor will track recent
1294 connections to hosts that match this value and attempt to reuse the same
1295 exit node for each. If the value is prepended with a \'.\', it is treated as
1296 matching an entire domain. If one of the values is just a \'.', it means
1297 match everything. This option is useful if you frequently connect to sites
1298 that will expire all your authentication cookies (i.e. log you out) if
1299 your IP address changes. Note that this option does have the disadvantage
1300 of making it more clear that a given history is associated with a single
1301 user. However, most people who would wish to observe this will observe it
1302 through cookies or other protocol-specific means anyhow.
1304 [[TrackHostExitsExpire]] **TrackHostExitsExpire** __NUM__::
1305 Since exit servers go up and down, it is desirable to expire the
1306 association between host and exit server after NUM seconds. The default is
1307 1800 seconds (30 minutes).
1309 [[UpdateBridgesFromAuthority]] **UpdateBridgesFromAuthority** **0**|**1**::
1310 When set (along with UseBridges), Tor will try to fetch bridge descriptors
1311 from the configured bridge authorities when feasible. It will fall back to
1312 a direct request if the authority responds with a 404. (Default: 0)
1314 [[UseBridges]] **UseBridges** **0**|**1**::
1315 When set, Tor will fetch descriptors for each bridge listed in the "Bridge"
1316 config lines, and use these relays as both entry guards and directory
1317 guards. (Default: 0)
1319 [[UseEntryGuards]] **UseEntryGuards** **0**|**1**::
1320 If this option is set to 1, we pick a few long-term entry servers, and try
1321 to stick with them. This is desirable because constantly changing servers
1322 increases the odds that an adversary who owns some servers will observe a
1323 fraction of your paths. Entry Guards can not be used by Directory
1324 Authorities, Single Onion Services, and Tor2web clients. In these cases,
1325 the this option is ignored. (Default: 1)
1327 [[GuardfractionFile]] **GuardfractionFile** __FILENAME__::
1328 V3 authoritative directories only. Configures the location of the
1329 guardfraction file which contains information about how long relays
1330 have been guards. (Default: unset)
1332 [[UseGuardFraction]] **UseGuardFraction** **0**|**1**|**auto**::
1333 This torrc option specifies whether clients should use the
1334 guardfraction information found in the consensus during path
1335 selection. If it's set to 'auto', clients will do what the
1336 UseGuardFraction consensus parameter tells them to do. (Default: auto)
1338 [[NumEntryGuards]] **NumEntryGuards** __NUM__::
1339 If UseEntryGuards is set to 1, we will try to pick a total of NUM routers
1340 as long-term entries for our circuits. If NUM is 0, we try to learn the
1341 number from the guard-n-primary-guards-to-use consensus parameter, and
1342 default to 1 if the consensus parameter isn't set. (Default: 0)
1344 [[NumDirectoryGuards]] **NumDirectoryGuards** __NUM__::
1345 If UseEntryGuards is set to 1, we try to make sure we have at least NUM
1346 routers to use as directory guards. If this option is set to 0, use the
1347 value from the guard-n-primary-dir-guards-to-use consensus parameter, and
1348 default to 3 if the consensus parameter isn't set. (Default: 0)
1350 [[GuardLifetime]] **GuardLifetime** __N__ **days**|**weeks**|**months**::
1351 If nonzero, and UseEntryGuards is set, minimum time to keep a guard before
1352 picking a new one. If zero, we use the GuardLifetime parameter from the
1353 consensus directory. No value here may be less than 1 month or greater
1354 than 5 years; out-of-range values are clamped. (Default: 0)
1356 [[SafeSocks]] **SafeSocks** **0**|**1**::
1357 When this option is enabled, Tor will reject application connections that
1358 use unsafe variants of the socks protocol -- ones that only provide an IP
1359 address, meaning the application is doing a DNS resolve first.
1360 Specifically, these are socks4 and socks5 when not doing remote DNS.
1363 [[TestSocks]] **TestSocks** **0**|**1**::
1364 When this option is enabled, Tor will make a notice-level log entry for
1365 each connection to the Socks port indicating whether the request used a
1366 safe socks protocol or an unsafe one (see above entry on SafeSocks). This
1367 helps to determine whether an application using Tor is possibly leaking
1368 DNS requests. (Default: 0)
1370 [[VirtualAddrNetworkIPv4]] **VirtualAddrNetworkIPv4** __IPv4Address__/__bits__ +
1372 [[VirtualAddrNetworkIPv6]] **VirtualAddrNetworkIPv6** [__IPv6Address__]/__bits__::
1373 When Tor needs to assign a virtual (unused) address because of a MAPADDRESS
1374 command from the controller or the AutomapHostsOnResolve feature, Tor
1375 picks an unassigned address from this range. (Defaults:
1376 127.192.0.0/10 and [FE80::]/10 respectively.) +
1378 When providing proxy server service to a network of computers using a tool
1379 like dns-proxy-tor, change the IPv4 network to "10.192.0.0/10" or
1380 "172.16.0.0/12" and change the IPv6 network to "[FC00::]/7".
1381 The default **VirtualAddrNetwork** address ranges on a
1382 properly configured machine will route to the loopback or link-local
1383 interface. The maximum number of bits for the network prefix is set to 104
1384 for IPv6 and 16 for IPv4. However, a wider network - smaller prefix length
1385 - is preferable since it reduces the chances for an attacker to guess the
1386 used IP. For local use, no change to the default VirtualAddrNetwork setting
1389 [[AllowNonRFC953Hostnames]] **AllowNonRFC953Hostnames** **0**|**1**::
1390 When this option is disabled, Tor blocks hostnames containing illegal
1391 characters (like @ and :) rather than sending them to an exit node to be
1392 resolved. This helps trap accidental attempts to resolve URLs and so on.
1395 [[HTTPTunnelPort]] **HTTPTunnelPort** \['address':]__port__|**auto** [_isolation flags_]::
1396 Open this port to listen for proxy connections using the "HTTP CONNECT"
1397 protocol instead of SOCKS. Set this to 0
1398 0 if you don't want to allow "HTTP CONNECT" connections. Set the port
1399 to "auto" to have Tor pick a port for you. This directive can be
1400 specified multiple times to bind to multiple addresses/ports. See
1401 SOCKSPort for an explanation of isolation flags. (Default: 0)
1403 [[TransPort]] **TransPort** \['address':]__port__|**auto** [_isolation flags_]::
1404 Open this port to listen for transparent proxy connections. Set this to
1405 0 if you don't want to allow transparent proxy connections. Set the port
1406 to "auto" to have Tor pick a port for you. This directive can be
1407 specified multiple times to bind to multiple addresses/ports. See
1408 SOCKSPort for an explanation of isolation flags. +
1410 TransPort requires OS support for transparent proxies, such as BSDs' pf or
1411 Linux's IPTables. If you're planning to use Tor as a transparent proxy for
1412 a network, you'll want to examine and change VirtualAddrNetwork from the
1413 default setting. (Default: 0)
1415 [[TransProxyType]] **TransProxyType** **default**|**TPROXY**|**ipfw**|**pf-divert**::
1416 TransProxyType may only be enabled when there is transparent proxy listener
1419 Set this to "TPROXY" if you wish to be able to use the TPROXY Linux module
1420 to transparently proxy connections that are configured using the TransPort
1421 option. Detailed information on how to configure the TPROXY
1422 feature can be found in the Linux kernel source tree in the file
1423 Documentation/networking/tproxy.txt. +
1425 Set this option to "ipfw" to use the FreeBSD ipfw interface. +
1427 On *BSD operating systems when using pf, set this to "pf-divert" to take
1428 advantage of +divert-to+ rules, which do not modify the packets like
1429 +rdr-to+ rules do. Detailed information on how to configure pf to use
1430 +divert-to+ rules can be found in the pf.conf(5) manual page. On OpenBSD,
1431 +divert-to+ is available to use on versions greater than or equal to
1434 Set this to "default", or leave it unconfigured, to use regular IPTables
1435 on Linux, or to use pf +rdr-to+ rules on *BSD systems. +
1437 (Default: "default".)
1439 [[NATDPort]] **NATDPort** \['address':]__port__|**auto** [_isolation flags_]::
1440 Open this port to listen for connections from old versions of ipfw (as
1441 included in old versions of FreeBSD, etc) using the NATD protocol.
1442 Use 0 if you don't want to allow NATD connections. Set the port
1443 to "auto" to have Tor pick a port for you. This directive can be
1444 specified multiple times to bind to multiple addresses/ports. See
1445 SocksPort for an explanation of isolation flags. +
1447 This option is only for people who cannot use TransPort. (Default: 0)
1449 [[AutomapHostsOnResolve]] **AutomapHostsOnResolve** **0**|**1**::
1450 When this option is enabled, and we get a request to resolve an address
1451 that ends with one of the suffixes in **AutomapHostsSuffixes**, we map an
1452 unused virtual address to that address, and return the new virtual address.
1453 This is handy for making ".onion" addresses work with applications that
1454 resolve an address and then connect to it. (Default: 0)
1456 [[AutomapHostsSuffixes]] **AutomapHostsSuffixes** __SUFFIX__,__SUFFIX__,__...__::
1457 A comma-separated list of suffixes to use with **AutomapHostsOnResolve**.
1458 The "." suffix is equivalent to "all addresses." (Default: .exit,.onion).
1460 [[DNSPort]] **DNSPort** \['address':]__port__|**auto** [_isolation flags_]::
1461 If non-zero, open this port to listen for UDP DNS requests, and resolve
1462 them anonymously. This port only handles A, AAAA, and PTR requests---it
1463 doesn't handle arbitrary DNS request types. Set the port to "auto" to
1464 have Tor pick a port for
1465 you. This directive can be specified multiple times to bind to multiple
1466 addresses/ports. See SocksPort for an explanation of isolation
1469 [[ClientDNSRejectInternalAddresses]] **ClientDNSRejectInternalAddresses** **0**|**1**::
1470 If true, Tor does not believe any anonymously retrieved DNS answer that
1471 tells it that an address resolves to an internal address (like 127.0.0.1 or
1472 192.168.0.1). This option prevents certain browser-based attacks; it
1473 is not allowed to be set on the default network. (Default: 1)
1475 [[ClientRejectInternalAddresses]] **ClientRejectInternalAddresses** **0**|**1**::
1476 If true, Tor does not try to fulfill requests to connect to an internal
1477 address (like 127.0.0.1 or 192.168.0.1) __unless an exit node is
1478 specifically requested__ (for example, via a .exit hostname, or a
1479 controller request). If true, multicast DNS hostnames for machines on the
1480 local network (of the form *.local) are also rejected. (Default: 1)
1482 [[DownloadExtraInfo]] **DownloadExtraInfo** **0**|**1**::
1483 If true, Tor downloads and caches "extra-info" documents. These documents
1484 contain information about servers other than the information in their
1485 regular server descriptors. Tor does not use this information for anything
1486 itself; to save bandwidth, leave this option turned off. (Default: 0)
1488 [[WarnPlaintextPorts]] **WarnPlaintextPorts** __port__,__port__,__...__::
1489 Tells Tor to issue a warnings whenever the user tries to make an anonymous
1490 connection to one of these ports. This option is designed to alert users
1491 to services that risk sending passwords in the clear. (Default:
1494 [[RejectPlaintextPorts]] **RejectPlaintextPorts** __port__,__port__,__...__::
1495 Like WarnPlaintextPorts, but instead of warning about risky port uses, Tor
1496 will instead refuse to make the connection. (Default: None)
1498 [[OptimisticData]] **OptimisticData** **0**|**1**|**auto**::
1499 When this option is set, and Tor is using an exit node that supports
1500 the feature, it will try optimistically to send data to the exit node
1501 without waiting for the exit node to report whether the connection
1502 succeeded. This can save a round-trip time for protocols like HTTP
1503 where the client talks first. If OptimisticData is set to **auto**,
1504 Tor will look at the UseOptimisticData parameter in the networkstatus.
1507 [[Tor2webMode]] **Tor2webMode** **0**|**1**::
1508 When this option is set, Tor connects to hidden services
1509 **non-anonymously**. This option also disables client connections to
1510 non-hidden-service hostnames through Tor. It **must only** be used when
1511 running a tor2web Hidden Service web proxy.
1512 To enable this option the compile time flag --enable-tor2web-mode must be
1513 specified. Since Tor2webMode is non-anonymous, you can not run an
1514 anonymous Hidden Service on a tor version compiled with Tor2webMode.
1517 [[Tor2webRendezvousPoints]] **Tor2webRendezvousPoints** __node__,__node__,__...__::
1518 A list of identity fingerprints, nicknames, country codes and
1519 address patterns of nodes that are allowed to be used as RPs
1520 in HS circuits; any other nodes will not be used as RPs.
1522 Tor2webRendezvousPoints Fastyfasty, ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
1524 This feature can only be used if Tor2webMode is also enabled. +
1526 ExcludeNodes have higher priority than Tor2webRendezvousPoints,
1527 which means that nodes specified in ExcludeNodes will not be
1530 If no nodes in Tor2webRendezvousPoints are currently available for
1531 use, Tor will choose a random node when building HS circuits.
1533 [[UseMicrodescriptors]] **UseMicrodescriptors** **0**|**1**|**auto**::
1534 Microdescriptors are a smaller version of the information that Tor needs
1535 in order to build its circuits. Using microdescriptors makes Tor clients
1536 download less directory information, thus saving bandwidth. Directory
1537 caches need to fetch regular descriptors and microdescriptors, so this
1538 option doesn't save any bandwidth for them. If this option is set to
1539 "auto" (recommended) then it is on for all clients that do not set
1540 FetchUselessDescriptors. (Default: auto)
1542 [[PathBiasCircThreshold]] **PathBiasCircThreshold** __NUM__ +
1544 [[PathBiasNoticeRate]] **PathBiasNoticeRate** __NUM__ +
1546 [[PathBiasWarnRate]] **PathBiasWarnRate** __NUM__ +
1548 [[PathBiasExtremeRate]] **PathBiasExtremeRate** __NUM__ +
1550 [[PathBiasDropGuards]] **PathBiasDropGuards** __NUM__ +
1552 [[PathBiasScaleThreshold]] **PathBiasScaleThreshold** __NUM__::
1553 These options override the default behavior of Tor's (**currently
1554 experimental**) path bias detection algorithm. To try to find broken or
1555 misbehaving guard nodes, Tor looks for nodes where more than a certain
1556 fraction of circuits through that guard fail to get built. +
1558 The PathBiasCircThreshold option controls how many circuits we need to build
1559 through a guard before we make these checks. The PathBiasNoticeRate,
1560 PathBiasWarnRate and PathBiasExtremeRate options control what fraction of
1561 circuits must succeed through a guard so we won't write log messages.
1562 If less than PathBiasExtremeRate circuits succeed *and* PathBiasDropGuards
1563 is set to 1, we disable use of that guard. +
1565 When we have seen more than PathBiasScaleThreshold
1566 circuits through a guard, we scale our observations by 0.5 (governed by
1567 the consensus) so that new observations don't get swamped by old ones. +
1569 By default, or if a negative value is provided for one of these options,
1570 Tor uses reasonable defaults from the networkstatus consensus document.
1571 If no defaults are available there, these options default to 150, .70,
1572 .50, .30, 0, and 300 respectively.
1574 [[PathBiasUseThreshold]] **PathBiasUseThreshold** __NUM__ +
1576 [[PathBiasNoticeUseRate]] **PathBiasNoticeUseRate** __NUM__ +
1578 [[PathBiasExtremeUseRate]] **PathBiasExtremeUseRate** __NUM__ +
1580 [[PathBiasScaleUseThreshold]] **PathBiasScaleUseThreshold** __NUM__::
1581 Similar to the above options, these options override the default behavior
1582 of Tor's (**currently experimental**) path use bias detection algorithm. +
1584 Where as the path bias parameters govern thresholds for successfully
1585 building circuits, these four path use bias parameters govern thresholds
1586 only for circuit usage. Circuits which receive no stream usage
1587 are not counted by this detection algorithm. A used circuit is considered
1588 successful if it is capable of carrying streams or otherwise receiving
1589 well-formed responses to RELAY cells. +
1591 By default, or if a negative value is provided for one of these options,
1592 Tor uses reasonable defaults from the networkstatus consensus document.
1593 If no defaults are available there, these options default to 20, .80,
1594 .60, and 100, respectively.
1596 [[ClientUseIPv4]] **ClientUseIPv4** **0**|**1**::
1597 If this option is set to 0, Tor will avoid connecting to directory servers
1598 and entry nodes over IPv4. Note that clients with an IPv4
1599 address in a **Bridge**, proxy, or pluggable transport line will try
1600 connecting over IPv4 even if **ClientUseIPv4** is set to 0. (Default: 1)
1602 [[ClientUseIPv6]] **ClientUseIPv6** **0**|**1**::
1603 If this option is set to 1, Tor might connect to directory servers or
1604 entry nodes over IPv6. Note that clients configured with an IPv6 address
1605 in a **Bridge**, proxy, or pluggable transport line will try connecting
1606 over IPv6 even if **ClientUseIPv6** is set to 0. (Default: 0)
1608 [[ClientPreferIPv6DirPort]] **ClientPreferIPv6DirPort** **0**|**1**|**auto**::
1609 If this option is set to 1, Tor prefers a directory port with an IPv6
1610 address over one with IPv4, for direct connections, if a given directory
1611 server has both. (Tor also prefers an IPv6 DirPort if IPv4Client is set to
1612 0.) If this option is set to auto, clients prefer IPv4. Other things may
1613 influence the choice. This option breaks a tie to the favor of IPv6.
1614 (Default: auto) (DEPRECATED: This option has had no effect for some
1617 [[ClientPreferIPv6ORPort]] **ClientPreferIPv6ORPort** **0**|**1**|**auto**::
1618 If this option is set to 1, Tor prefers an OR port with an IPv6
1619 address over one with IPv4 if a given entry node has both. (Tor also
1620 prefers an IPv6 ORPort if IPv4Client is set to 0.) If this option is set
1621 to auto, Tor bridge clients prefer the configured bridge address, and
1622 other clients prefer IPv4. Other things may influence the choice. This
1623 option breaks a tie to the favor of IPv6. (Default: auto)
1625 [[PathsNeededToBuildCircuits]] **PathsNeededToBuildCircuits** __NUM__::
1626 Tor clients don't build circuits for user traffic until they know
1627 about enough of the network so that they could potentially construct
1628 enough of the possible paths through the network. If this option
1629 is set to a fraction between 0.25 and 0.95, Tor won't build circuits
1630 until it has enough descriptors or microdescriptors to construct
1631 that fraction of possible paths. Note that setting this option too low
1632 can make your Tor client less anonymous, and setting it too high can
1633 prevent your Tor client from bootstrapping. If this option is negative,
1634 Tor will use a default value chosen by the directory authorities. If the
1635 directory authorities do not choose a value, Tor will default to 0.6.
1638 [[ClientBootstrapConsensusAuthorityDownloadSchedule]] **ClientBootstrapConsensusAuthorityDownloadSchedule** __N__,__N__,__...__::
1639 Schedule for when clients should download consensuses from authorities
1640 if they are bootstrapping (that is, they don't have a usable, reasonably
1641 live consensus). Only used by clients fetching from a list of fallback
1642 directory mirrors. This schedule is advanced by (potentially concurrent)
1643 connection attempts, unlike other schedules, which are advanced by
1644 connection failures. (Default: 6, 11, 3600, 10800, 25200, 54000, 111600,
1647 [[ClientBootstrapConsensusFallbackDownloadSchedule]] **ClientBootstrapConsensusFallbackDownloadSchedule** __N__,__N__,__...__::
1648 Schedule for when clients should download consensuses from fallback
1649 directory mirrors if they are bootstrapping (that is, they don't have a
1650 usable, reasonably live consensus). Only used by clients fetching from a
1651 list of fallback directory mirrors. This schedule is advanced by
1652 (potentially concurrent) connection attempts, unlike other schedules,
1653 which are advanced by connection failures. (Default: 0, 1, 4, 11, 3600,
1654 10800, 25200, 54000, 111600, 262800)
1656 [[ClientBootstrapConsensusAuthorityOnlyDownloadSchedule]] **ClientBootstrapConsensusAuthorityOnlyDownloadSchedule** __N__,__N__,__...__::
1657 Schedule for when clients should download consensuses from authorities
1658 if they are bootstrapping (that is, they don't have a usable, reasonably
1659 live consensus). Only used by clients which don't have or won't fetch
1660 from a list of fallback directory mirrors. This schedule is advanced by
1661 (potentially concurrent) connection attempts, unlike other schedules,
1662 which are advanced by connection failures. (Default: 0, 3, 7, 3600,
1663 10800, 25200, 54000, 111600, 262800)
1665 [[ClientBootstrapConsensusMaxDownloadTries]] **ClientBootstrapConsensusMaxDownloadTries** __NUM__::
1666 Try this many times to download a consensus while bootstrapping using
1667 fallback directory mirrors before giving up. (Default: 7)
1669 [[ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries]] **ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries** __NUM__::
1670 Try this many times to download a consensus while bootstrapping using
1671 authorities before giving up. (Default: 4)
1673 [[ClientBootstrapConsensusMaxInProgressTries]] **ClientBootstrapConsensusMaxInProgressTries** __NUM__::
1674 Try this many simultaneous connections to download a consensus before
1675 waiting for one to complete, timeout, or error out. (Default: 3)
1680 The following options are useful only for servers (that is, if ORPort
1683 [[Address]] **Address** __address__::
1684 The IPv4 address of this server, or a fully qualified domain name of
1685 this server that resolves to an IPv4 address. You can leave this
1686 unset, and Tor will try to guess your IPv4 address. This IPv4
1687 address is the one used to tell clients and other servers where to
1688 find your Tor server; it doesn't affect the address that your server
1689 binds to. To bind to a different address, use the ORPort and
1690 OutboundBindAddress options.
1692 [[AssumeReachable]] **AssumeReachable** **0**|**1**::
1693 This option is used when bootstrapping a new Tor network. If set to 1,
1694 don't do self-reachability testing; just upload your server descriptor
1695 immediately. If **AuthoritativeDirectory** is also set, this option
1696 instructs the dirserver to bypass remote reachability testing too and list
1697 all connected servers as running.
1699 [[BridgeRelay]] **BridgeRelay** **0**|**1**::
1700 Sets the relay to act as a "bridge" with respect to relaying connections
1701 from bridge users to the Tor network. It mainly causes Tor to publish a
1702 server descriptor to the bridge database, rather than
1703 to the public directory authorities.
1705 [[BridgeDistribution]] **BridgeDistribution** __string__::
1706 If set along with BridgeRelay, Tor will include a new line in its
1707 bridge descriptor which indicates to the BridgeDB service how it
1708 would like its bridge address to be given out. Set it to "none" if
1709 you want BridgeDB to avoid distributing your bridge address, or "any" to
1710 let BridgeDB decide. (Default: any)
1712 Note: as of Oct 2017, the BridgeDB part of this option is not yet
1713 implemented. Until BridgeDB is updated to obey this option, your
1714 bridge will make this request, but it will not (yet) be obeyed.
1716 [[ContactInfo]] **ContactInfo** __email_address__::
1717 Administrative contact information for this relay or bridge. This line
1718 can be used to contact you if your relay or bridge is misconfigured or
1719 something else goes wrong. Note that we archive and publish all
1720 descriptors containing these lines and that Google indexes them, so
1721 spammers might also collect them. You may want to obscure the fact
1722 that it's an email address and/or generate a new address for this
1725 [[ExitRelay]] **ExitRelay** **0**|**1**|**auto**::
1726 Tells Tor whether to run as an exit relay. If Tor is running as a
1727 non-bridge server, and ExitRelay is set to 1, then Tor allows traffic to
1728 exit according to the ExitPolicy option (or the default ExitPolicy if
1729 none is specified). +
1731 If ExitRelay is set to 0, no traffic is allowed to
1732 exit, and the ExitPolicy option is ignored. +
1734 If ExitRelay is set to "auto", then Tor behaves as if it were set to 1, but
1735 warns the user if this would cause traffic to exit. In a future version,
1736 the default value will be 0. (Default: auto)
1738 [[ExitPolicy]] **ExitPolicy** __policy__,__policy__,__...__::
1739 Set an exit policy for this server. Each policy is of the form
1740 "**accept[6]**|**reject[6]** __ADDR__[/__MASK__][:__PORT__]". If /__MASK__ is
1741 omitted then this policy just applies to the host given. Instead of giving
1742 a host or network you can also use "\*" to denote the universe (0.0.0.0/0
1743 and ::/128), or \*4 to denote all IPv4 addresses, and \*6 to denote all
1745 __PORT__ can be a single port number, an interval of ports
1746 "__FROM_PORT__-__TO_PORT__", or "\*". If __PORT__ is omitted, that means
1749 For example, "accept 18.7.22.69:\*,reject 18.0.0.0/8:\*,accept \*:\*" would
1750 reject any IPv4 traffic destined for MIT except for web.mit.edu, and accept
1751 any other IPv4 or IPv6 traffic. +
1753 Tor also allows IPv6 exit policy entries. For instance, "reject6 [FC00::]/7:\*"
1754 rejects all destinations that share 7 most significant bit prefix with
1755 address FC00::. Respectively, "accept6 [C000::]/3:\*" accepts all destinations
1756 that share 3 most significant bit prefix with address C000::. +
1758 accept6 and reject6 only produce IPv6 exit policy entries. Using an IPv4
1759 address with accept6 or reject6 is ignored and generates a warning.
1760 accept/reject allows either IPv4 or IPv6 addresses. Use \*4 as an IPv4
1761 wildcard address, and \*6 as an IPv6 wildcard address. accept/reject *
1762 expands to matching IPv4 and IPv6 wildcard address rules. +
1764 To specify all IPv4 and IPv6 internal and link-local networks (including
1765 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,
1766 172.16.0.0/12, [::]/8, [FC00::]/7, [FE80::]/10, [FEC0::]/10, [FF00::]/8,
1767 and [::]/127), you can use the "private" alias instead of an address.
1768 ("private" always produces rules for IPv4 and IPv6 addresses, even when
1769 used with accept6/reject6.) +
1771 Private addresses are rejected by default (at the beginning of your exit
1772 policy), along with any configured primary public IPv4 and IPv6 addresses.
1773 These private addresses are rejected unless you set the
1774 ExitPolicyRejectPrivate config option to 0. For example, once you've done
1775 that, you could allow HTTP to 127.0.0.1 and block all other connections to
1776 internal networks with "accept 127.0.0.1:80,reject private:\*", though that
1777 may also allow connections to your own computer that are addressed to its
1778 public (external) IP address. See RFC 1918 and RFC 3330 for more details
1779 about internal and reserved IP address space. See
1780 ExitPolicyRejectLocalInterfaces if you want to block every address on the
1781 relay, even those that aren't advertised in the descriptor. +
1783 This directive can be specified multiple times so you don't have to put it
1786 Policies are considered first to last, and the first match wins. If you
1787 want to allow the same ports on IPv4 and IPv6, write your rules using
1788 accept/reject \*. If you want to allow different ports on IPv4 and IPv6,
1789 write your IPv6 rules using accept6/reject6 \*6, and your IPv4 rules using
1790 accept/reject \*4. If you want to \_replace_ the default exit policy, end
1791 your exit policy with either a reject \*:* or an accept \*:*. Otherwise,
1792 you're \_augmenting_ (prepending to) the default exit policy. +
1794 If you want to use a reduced exit policy rather than the default exit
1795 policy, set "ReducedExitPolicy 1". If you want to _replace_ the default
1796 exit policy with your custom exit policy, end your exit policy with either
1797 a reject *:* or an accept *:*. Otherwise, you’re _augmenting_ (prepending
1798 to) the default or reduced exit policy. +
1800 The default exit policy is:
1814 [[ExitPolicyDefault]] **ExitPolicyDefault**::
1815 Since the default exit policy uses accept/reject *, it applies to both
1816 IPv4 and IPv6 addresses.
1818 [[ExitPolicyRejectPrivate]] **ExitPolicyRejectPrivate** **0**|**1**::
1819 Reject all private (local) networks, along with the relay's advertised
1820 public IPv4 and IPv6 addresses, at the beginning of your exit policy.
1821 See above entry on ExitPolicy.
1824 [[ExitPolicyRejectLocalInterfaces]] **ExitPolicyRejectLocalInterfaces** **0**|**1**::
1825 Reject all IPv4 and IPv6 addresses that the relay knows about, at the
1826 beginning of your exit policy. This includes any OutboundBindAddress, the
1827 bind addresses of any port options, such as ControlPort or DNSPort, and any
1828 public IPv4 and IPv6 addresses on any interface on the relay. (If IPv6Exit
1829 is not set, all IPv6 addresses will be rejected anyway.)
1830 See above entry on ExitPolicy.
1831 This option is off by default, because it lists all public relay IP
1832 addresses in the ExitPolicy, even those relay operators might prefer not
1836 [[ReducedExitPolicy]] **ReducedExitPolicy** **0**|**1**::
1837 If set, use a reduced exit policy rather than the default one. +
1839 The reduced exit policy is an alternative to the default exit policy. It
1840 allows as many Internet services as possible while still blocking the
1841 majority of TCP ports. Currently, the policy allows approximately 65 ports.
1842 This reduces the odds that your node will be used for peer-to-peer
1845 The reduced exit policy is:
1929 [[IPv6Exit]] **IPv6Exit** **0**|**1**::
1930 If set, and we are an exit node, allow clients to use us for IPv6
1931 traffic. (Default: 0)
1933 [[MaxOnionQueueDelay]] **MaxOnionQueueDelay** __NUM__ [**msec**|**second**]::
1934 If we have more onionskins queued for processing than we can process in
1935 this amount of time, reject new ones. (Default: 1750 msec)
1937 [[MyFamily]] **MyFamily** __fingerprint__,__fingerprint__,...::
1938 Declare that this Tor relay is controlled or administered by a group or
1939 organization identical or similar to that of the other relays, defined by
1940 their (possibly $-prefixed) identity fingerprints.
1941 This option can be repeated many times, for
1942 convenience in defining large families: all fingerprints in all MyFamily
1943 lines are merged into one list.
1944 When two relays both declare that they are in the
1945 same \'family', Tor clients will not use them in the same circuit. (Each
1946 relay only needs to list the other servers in its family; it doesn't need to
1947 list itself, but it won't hurt if it does.) Do not list any bridge relay as it would
1948 compromise its concealment. +
1950 When listing a node, it's better to list it by fingerprint than by
1951 nickname: fingerprints are more reliable.
1953 [[Nickname]] **Nickname** __name__::
1954 Set the server's nickname to \'name'. Nicknames must be between 1 and 19
1955 characters inclusive, and must contain only the characters [a-zA-Z0-9].
1957 [[NumCPUs]] **NumCPUs** __num__::
1958 How many processes to use at once for decrypting onionskins and other
1959 parallelizable operations. If this is set to 0, Tor will try to detect
1960 how many CPUs you have, defaulting to 1 if it can't tell. (Default: 0)
1962 [[ORPort]] **ORPort** \['address':]__PORT__|**auto** [_flags_]::
1963 Advertise this port to listen for connections from Tor clients and
1964 servers. This option is required to be a Tor server.
1965 Set it to "auto" to have Tor pick a port for you. Set it to 0 to not
1966 run an ORPort at all. This option can occur more than once. (Default: 0) +
1968 Tor recognizes these flags on each ORPort:
1970 By default, we bind to a port and tell our users about it. If
1971 NoAdvertise is specified, we don't advertise, but listen anyway. This
1972 can be useful if the port everybody will be connecting to (for
1973 example, one that's opened on our firewall) is somewhere else.
1975 By default, we bind to a port and tell our users about it. If
1976 NoListen is specified, we don't bind, but advertise anyway. This
1977 can be useful if something else (for example, a firewall's port
1978 forwarding configuration) is causing connections to reach us.
1980 If the address is absent, or resolves to both an IPv4 and an IPv6
1981 address, only listen to the IPv4 address.
1983 If the address is absent, or resolves to both an IPv4 and an IPv6
1984 address, only listen to the IPv6 address.
1986 [[ORPortFlagsExclusive]]::
1987 For obvious reasons, NoAdvertise and NoListen are mutually exclusive, and
1988 IPv4Only and IPv6Only are mutually exclusive.
1990 [[PortForwarding]] **PortForwarding** **0**|**1**::
1991 Attempt to automatically forward the DirPort and ORPort on a NAT router
1992 connecting this Tor server to the Internet. If set, Tor will try both
1993 NAT-PMP (common on Apple routers) and UPnP (common on routers from other
1994 manufacturers). (Default: 0)
1996 [[PortForwardingHelper]] **PortForwardingHelper** __filename__|__pathname__::
1997 If PortForwarding is set, use this executable to configure the forwarding.
1998 If set to a filename, the system path will be searched for the executable.
1999 If set to a path, only the specified path will be executed.
2000 (Default: tor-fw-helper)
2002 [[PublishServerDescriptor]] **PublishServerDescriptor** **0**|**1**|**v3**|**bridge**,**...**::
2003 This option specifies which descriptors Tor will publish when acting as
2005 choose multiple arguments, separated by commas. +
2007 If this option is set to 0, Tor will not publish its
2008 descriptors to any directories. (This is useful if you're testing
2009 out your server, or if you're using a Tor controller that handles
2010 directory publishing for you.) Otherwise, Tor will publish its
2011 descriptors of all type(s) specified. The default is "1", which
2012 means "if running as a relay or bridge, publish descriptors to the
2013 appropriate authorities". Other possibilities are "v3", meaning
2014 "publish as if you're a relay", and "bridge", meaning "publish as
2015 if you're a bridge".
2017 [[ShutdownWaitLength]] **ShutdownWaitLength** __NUM__::
2018 When we get a SIGINT and we're a server, we begin shutting down:
2019 we close listeners and start refusing new circuits. After **NUM**
2020 seconds, we exit. If we get a second SIGINT, we exit immediately.
2021 (Default: 30 seconds)
2023 [[SSLKeyLifetime]] **SSLKeyLifetime** __N__ **minutes**|**hours**|**days**|**weeks**::
2024 When creating a link certificate for our outermost SSL handshake,
2025 set its lifetime to this amount of time. If set to 0, Tor will choose
2026 some reasonable random defaults. (Default: 0)
2028 [[HeartbeatPeriod]] **HeartbeatPeriod** __N__ **minutes**|**hours**|**days**|**weeks**::
2029 Log a heartbeat message every **HeartbeatPeriod** seconds. This is
2030 a log level __notice__ message, designed to let you know your Tor
2031 server is still alive and doing useful things. Settings this
2032 to 0 will disable the heartbeat. Otherwise, it must be at least 30
2033 minutes. (Default: 6 hours)
2035 [[MainloopStats]] **MainloopStats** **0**|**1**::
2036 Log main loop statistics every **HeartbeatPeriod** seconds. This is a log
2037 level __notice__ message designed to help developers instrumenting Tor's
2038 main event loop. (Default: 0)
2040 [[AccountingMax]] **AccountingMax** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
2041 Limits the max number of bytes sent and received within a set time period
2042 using a given calculation rule (see: AccountingStart, AccountingRule).
2043 Useful if you need to stay under a specific bandwidth. By default, the
2044 number used for calculation is the max of either the bytes sent or
2045 received. For example, with AccountingMax set to 1 GByte, a server
2046 could send 900 MBytes and receive 800 MBytes and continue running.
2047 It will only hibernate once one of the two reaches 1 GByte. This can
2048 be changed to use the sum of the both bytes received and sent by setting
2049 the AccountingRule option to "sum" (total bandwidth in/out). When the
2050 number of bytes remaining gets low, Tor will stop accepting new connections
2051 and circuits. When the number of bytes is exhausted, Tor will hibernate
2052 until some time in the next accounting period. To prevent all servers
2053 from waking at the same time, Tor will also wait until a random point
2054 in each period before waking up. If you have bandwidth cost issues,
2055 enabling hibernation is preferable to setting a low bandwidth, since
2056 it provides users with a collection of fast servers that are up some
2057 of the time, which is more useful than a set of slow servers that are
2060 [[AccountingRule]] **AccountingRule** **sum**|**max**|**in**|**out**::
2061 How we determine when our AccountingMax has been reached (when we
2062 should hibernate) during a time interval. Set to "max" to calculate
2063 using the higher of either the sent or received bytes (this is the
2064 default functionality). Set to "sum" to calculate using the sent
2065 plus received bytes. Set to "in" to calculate using only the
2066 received bytes. Set to "out" to calculate using only the sent bytes.
2069 [[AccountingStart]] **AccountingStart** **day**|**week**|**month** [__day__] __HH:MM__::
2070 Specify how long accounting periods last. If **month** is given, each
2071 accounting period runs from the time __HH:MM__ on the __dayth__ day of one
2072 month to the same day and time of the next. (The day must be between 1 and
2073 28.) If **week** is given, each accounting period runs from the time __HH:MM__
2074 of the __dayth__ day of one week to the same day and time of the next week,
2075 with Monday as day 1 and Sunday as day 7. If **day** is given, each
2076 accounting period runs from the time __HH:MM__ each day to the same time on
2077 the next day. All times are local, and given in 24-hour time. (Default:
2080 [[RefuseUnknownExits]] **RefuseUnknownExits** **0**|**1**|**auto**::
2081 Prevent nodes that don't appear in the consensus from exiting using this
2082 relay. If the option is 1, we always block exit attempts from such
2083 nodes; if it's 0, we never do, and if the option is "auto", then we do
2084 whatever the authorities suggest in the consensus (and block if the consensus
2085 is quiet on the issue). (Default: auto)
2087 [[ServerDNSResolvConfFile]] **ServerDNSResolvConfFile** __filename__::
2088 Overrides the default DNS configuration with the configuration in
2089 __filename__. The file format is the same as the standard Unix
2090 "**resolv.conf**" file (7). This option, like all other ServerDNS options,
2091 only affects name lookups that your server does on behalf of clients.
2092 (Defaults to use the system DNS configuration.)
2094 [[ServerDNSAllowBrokenConfig]] **ServerDNSAllowBrokenConfig** **0**|**1**::
2095 If this option is false, Tor exits immediately if there are problems
2096 parsing the system DNS configuration or connecting to nameservers.
2097 Otherwise, Tor continues to periodically retry the system nameservers until
2098 it eventually succeeds. (Default: 1)
2100 [[ServerDNSSearchDomains]] **ServerDNSSearchDomains** **0**|**1**::
2101 If set to 1, then we will search for addresses in the local search domain.
2102 For example, if this system is configured to believe it is in
2103 "example.com", and a client tries to connect to "www", the client will be
2104 connected to "www.example.com". This option only affects name lookups that
2105 your server does on behalf of clients. (Default: 0)
2107 [[ServerDNSDetectHijacking]] **ServerDNSDetectHijacking** **0**|**1**::
2108 When this option is set to 1, we will test periodically to determine
2109 whether our local nameservers have been configured to hijack failing DNS
2110 requests (usually to an advertising site). If they are, we will attempt to
2111 correct this. This option only affects name lookups that your server does
2112 on behalf of clients. (Default: 1)
2114 [[ServerDNSTestAddresses]] **ServerDNSTestAddresses** __hostname__,__hostname__,__...__::
2115 When we're detecting DNS hijacking, make sure that these __valid__ addresses
2116 aren't getting redirected. If they are, then our DNS is completely useless,
2117 and we'll reset our exit policy to "reject \*:*". This option only affects
2118 name lookups that your server does on behalf of clients. (Default:
2119 "www.google.com, www.mit.edu, www.yahoo.com, www.slashdot.org")
2121 [[ServerDNSAllowNonRFC953Hostnames]] **ServerDNSAllowNonRFC953Hostnames** **0**|**1**::
2122 When this option is disabled, Tor does not try to resolve hostnames
2123 containing illegal characters (like @ and :) rather than sending them to an
2124 exit node to be resolved. This helps trap accidental attempts to resolve
2125 URLs and so on. This option only affects name lookups that your server does
2126 on behalf of clients. (Default: 0)
2128 [[BridgeRecordUsageByCountry]] **BridgeRecordUsageByCountry** **0**|**1**::
2129 When this option is enabled and BridgeRelay is also enabled, and we have
2130 GeoIP data, Tor keeps a per-country count of how many client
2131 addresses have contacted it so that it can help the bridge authority guess
2132 which countries have blocked access to it. (Default: 1)
2134 [[ServerDNSRandomizeCase]] **ServerDNSRandomizeCase** **0**|**1**::
2135 When this option is set, Tor sets the case of each character randomly in
2136 outgoing DNS requests, and makes sure that the case matches in DNS replies.
2137 This so-called "0x20 hack" helps resist some types of DNS poisoning attack.
2138 For more information, see "Increased DNS Forgery Resistance through
2139 0x20-Bit Encoding". This option only affects name lookups that your server
2140 does on behalf of clients. (Default: 1)
2142 [[GeoIPFile]] **GeoIPFile** __filename__::
2143 A filename containing IPv4 GeoIP data, for use with by-country statistics.
2145 [[GeoIPv6File]] **GeoIPv6File** __filename__::
2146 A filename containing IPv6 GeoIP data, for use with by-country statistics.
2148 [[CellStatistics]] **CellStatistics** **0**|**1**::
2150 When this option is enabled, Tor collects statistics about cell
2151 processing (i.e. mean time a cell is spending in a queue, mean
2152 number of cells in a queue and mean number of processed cells per
2153 circuit) and writes them into disk every 24 hours. Onion router
2154 operators may use the statistics for performance monitoring.
2155 If ExtraInfoStatistics is enabled, it will published as part of
2156 extra-info document. (Default: 0)
2158 [[PaddingStatistics]] **PaddingStatistics** **0**|**1**::
2160 When this option is enabled, Tor collects statistics for padding cells
2161 sent and received by this relay, in addition to total cell counts.
2162 These statistics are rounded, and omitted if traffic is low. This
2163 information is important for load balancing decisions related to padding.
2166 [[DirReqStatistics]] **DirReqStatistics** **0**|**1**::
2167 Relays and bridges only.
2168 When this option is enabled, a Tor directory writes statistics on the
2169 number and response time of network status requests to disk every 24
2170 hours. Enables relay and bridge operators to monitor how much their
2171 server is being used by clients to learn about Tor network.
2172 If ExtraInfoStatistics is enabled, it will published as part of
2173 extra-info document. (Default: 1)
2175 [[EntryStatistics]] **EntryStatistics** **0**|**1**::
2177 When this option is enabled, Tor writes statistics on the number of
2178 directly connecting clients to disk every 24 hours. Enables relay
2179 operators to monitor how much inbound traffic that originates from
2180 Tor clients passes through their server to go further down the
2181 Tor network. If ExtraInfoStatistics is enabled, it will be published
2182 as part of extra-info document. (Default: 0)
2184 [[ExitPortStatistics]] **ExitPortStatistics** **0**|**1**::
2186 When this option is enabled, Tor writes statistics on the number of
2187 relayed bytes and opened stream per exit port to disk every 24 hours.
2188 Enables exit relay operators to measure and monitor amounts of traffic
2189 that leaves Tor network through their exit node. If ExtraInfoStatistics
2190 is enabled, it will be published as part of extra-info document.
2193 [[ConnDirectionStatistics]] **ConnDirectionStatistics** **0**|**1**::
2195 When this option is enabled, Tor writes statistics on the amounts of
2196 traffic it passes between itself and other relays to disk every 24
2197 hours. Enables relay operators to monitor how much their relay is
2198 being used as middle node in the circuit. If ExtraInfoStatistics is
2199 enabled, it will be published as part of extra-info document.
2202 [[HiddenServiceStatistics]] **HiddenServiceStatistics** **0**|**1**::
2204 When this option is enabled, a Tor relay writes obfuscated
2205 statistics on its role as hidden-service directory, introduction
2206 point, or rendezvous point to disk every 24 hours. If
2207 ExtraInfoStatistics is also enabled, these statistics are further
2208 published to the directory authorities. (Default: 1)
2210 [[ExtraInfoStatistics]] **ExtraInfoStatistics** **0**|**1**::
2211 When this option is enabled, Tor includes previously gathered statistics in
2212 its extra-info documents that it uploads to the directory authorities.
2215 [[ExtendAllowPrivateAddresses]] **ExtendAllowPrivateAddresses** **0**|**1**::
2216 When this option is enabled, Tor will connect to relays on localhost,
2217 RFC1918 addresses, and so on. In particular, Tor will make direct OR
2218 connections, and Tor routers allow EXTEND requests, to these private
2219 addresses. (Tor will always allow connections to bridges, proxies, and
2220 pluggable transports configured on private addresses.) Enabling this
2221 option can create security issues; you should probably leave it off.
2224 [[MaxMemInQueues]] **MaxMemInQueues** __N__ **bytes**|**KB**|**MB**|**GB**::
2225 This option configures a threshold above which Tor will assume that it
2226 needs to stop queueing or buffering data because it's about to run out of
2227 memory. If it hits this threshold, it will begin killing circuits until
2228 it has recovered at least 10% of this memory. Do not set this option too
2229 low, or your relay may be unreliable under load. This option only
2230 affects some queues, so the actual process size will be larger than
2231 this. If this option is set to 0, Tor will try to pick a reasonable
2232 default based on your system's physical memory. (Default: 0)
2234 [[DisableOOSCheck]] **DisableOOSCheck** **0**|**1**::
2235 This option disables the code that closes connections when Tor notices
2236 that it is running low on sockets. Right now, it is on by default,
2237 since the existing out-of-sockets mechanism tends to kill OR connections
2238 more than it should. (Default: 1)
2240 [[SigningKeyLifetime]] **SigningKeyLifetime** __N__ **days**|**weeks**|**months**::
2241 For how long should each Ed25519 signing key be valid? Tor uses a
2242 permanent master identity key that can be kept offline, and periodically
2243 generates new "signing" keys that it uses online. This option
2244 configures their lifetime.
2247 [[OfflineMasterKey]] **OfflineMasterKey** **0**|**1**::
2248 If non-zero, the Tor relay will never generate or load its master secret
2249 key. Instead, you'll have to use "tor --keygen" to manage the permanent
2250 ed25519 master identity key, as well as the corresponding temporary
2251 signing keys and certificates. (Default: 0)
2253 [[KeyDirectory]] **KeyDirectory** __DIR__::
2254 Store secret keys in DIR. Can not be changed while tor is
2256 (Default: the "keys" subdirectory of DataDirectory.)
2258 [[KeyDirectoryGroupReadable]] **KeyDirectoryGroupReadable** **0**|**1**::
2259 If this option is set to 0, don't allow the filesystem group to read the
2260 KeywDirectory. If the option is set to 1, make the KeyDirectory readable
2261 by the default GID. (Default: 0)
2264 DIRECTORY SERVER OPTIONS
2265 ------------------------
2267 The following options are useful only for directory servers. (Relays with
2268 enough bandwidth automatically become directory servers; see DirCache for
2271 [[DirPortFrontPage]] **DirPortFrontPage** __FILENAME__::
2272 When this option is set, it takes an HTML file and publishes it as "/" on
2273 the DirPort. Now relay operators can provide a disclaimer without needing
2274 to set up a separate webserver. There's a sample disclaimer in
2275 contrib/operator-tools/tor-exit-notice.html.
2277 [[DirPort]] **DirPort** \['address':]__PORT__|**auto** [_flags_]::
2278 If this option is nonzero, advertise the directory service on this port.
2279 Set it to "auto" to have Tor pick a port for you. This option can occur
2280 more than once, but only one advertised DirPort is supported: all
2281 but one DirPort must have the **NoAdvertise** flag set. (Default: 0) +
2283 The same flags are supported here as are supported by ORPort.
2285 [[DirPolicy]] **DirPolicy** __policy__,__policy__,__...__::
2286 Set an entrance policy for this server, to limit who can connect to the
2287 directory ports. The policies have the same form as exit policies above,
2288 except that port specifiers are ignored. Any address not matched by
2289 some entry in the policy is accepted.
2291 [[DirCache]] **DirCache** **0**|**1**::
2292 When this option is set, Tor caches all current directory documents and
2293 accepts client requests for them. Setting DirPort is not required for this,
2294 because clients connect via the ORPort by default. Setting either DirPort
2295 or BridgeRelay and setting DirCache to 0 is not supported. (Default: 1)
2297 [[MaxConsensusAgeForDiffs]] **MaxConsensusAgeForDiffs** __N__ **minutes**|**hours**|**days**|**weeks**::
2298 When this option is nonzero, Tor caches will not try to generate
2299 consensus diffs for any consensus older than this amount of time.
2300 If this option is set to zero, Tor will pick a reasonable default from
2301 the current networkstatus document. You should not set this
2302 option unless your cache is severely low on disk space or CPU.
2303 If you need to set it, keeping it above 3 or 4 hours will help clients
2304 much more than setting it to zero.
2308 DIRECTORY AUTHORITY SERVER OPTIONS
2309 ----------------------------------
2311 The following options enable operation as a directory authority, and
2312 control how Tor behaves as a directory authority. You should not need
2313 to adjust any of them if you're running a regular relay or exit server
2314 on the public Tor network.
2316 [[AuthoritativeDirectory]] **AuthoritativeDirectory** **0**|**1**::
2317 When this option is set to 1, Tor operates as an authoritative directory
2318 server. Instead of caching the directory, it generates its own list of
2319 good servers, signs it, and sends that to the clients. Unless the clients
2320 already have you listed as a trusted directory, you probably do not want
2323 [[V3AuthoritativeDirectory]] **V3AuthoritativeDirectory** **0**|**1**::
2324 When this option is set in addition to **AuthoritativeDirectory**, Tor
2325 generates version 3 network statuses and serves descriptors, etc as
2326 described in dir-spec.txt file of https://spec.torproject.org/[torspec]
2327 (for Tor clients and servers running at least 0.2.0.x).
2329 [[VersioningAuthoritativeDirectory]] **VersioningAuthoritativeDirectory** **0**|**1**::
2330 When this option is set to 1, Tor adds information on which versions of
2331 Tor are still believed safe for use to the published directory. Each
2332 version 1 authority is automatically a versioning authority; version 2
2333 authorities provide this service optionally. See **RecommendedVersions**,
2334 **RecommendedClientVersions**, and **RecommendedServerVersions**.
2336 [[RecommendedVersions]] **RecommendedVersions** __STRING__::
2337 STRING is a comma-separated list of Tor versions currently believed to be
2338 safe. The list is included in each directory, and nodes which pull down the
2339 directory learn whether they need to upgrade. This option can appear
2340 multiple times: the values from multiple lines are spliced together. When
2341 this is set then **VersioningAuthoritativeDirectory** should be set too.
2343 [[RecommendedPackages]] **RecommendedPackages** __PACKAGENAME__ __VERSION__ __URL__ __DIGESTTYPE__**=**__DIGEST__ ::
2344 Adds "package" line to the directory authority's vote. This information
2345 is used to vote on the correct URL and digest for the released versions
2346 of different Tor-related packages, so that the consensus can certify
2347 them. This line may appear any number of times.
2349 [[RecommendedClientVersions]] **RecommendedClientVersions** __STRING__::
2350 STRING is a comma-separated list of Tor versions currently believed to be
2351 safe for clients to use. This information is included in version 2
2352 directories. If this is not set then the value of **RecommendedVersions**
2353 is used. When this is set then **VersioningAuthoritativeDirectory** should
2356 [[BridgeAuthoritativeDir]] **BridgeAuthoritativeDir** **0**|**1**::
2357 When this option is set in addition to **AuthoritativeDirectory**, Tor
2358 accepts and serves server descriptors, but it caches and serves the main
2359 networkstatus documents rather than generating its own. (Default: 0)
2361 [[MinUptimeHidServDirectoryV2]] **MinUptimeHidServDirectoryV2** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2362 Minimum uptime of a v2 hidden service directory to be accepted as such by
2363 authoritative directories. (Default: 25 hours)
2365 [[RecommendedServerVersions]] **RecommendedServerVersions** __STRING__::
2366 STRING is a comma-separated list of Tor versions currently believed to be
2367 safe for servers to use. This information is included in version 2
2368 directories. If this is not set then the value of **RecommendedVersions**
2369 is used. When this is set then **VersioningAuthoritativeDirectory** should
2372 [[ConsensusParams]] **ConsensusParams** __STRING__::
2373 STRING is a space-separated list of key=value pairs that Tor will include
2374 in the "params" line of its networkstatus vote.
2376 [[DirAllowPrivateAddresses]] **DirAllowPrivateAddresses** **0**|**1**::
2377 If set to 1, Tor will accept server descriptors with arbitrary "Address"
2378 elements. Otherwise, if the address is not an IP address or is a private IP
2379 address, it will reject the server descriptor. Additionally, Tor
2380 will allow exit policies for private networks to fulfill Exit flag
2381 requirements. (Default: 0)
2383 [[AuthDirBadExit]] **AuthDirBadExit** __AddressPattern...__::
2384 Authoritative directories only. A set of address patterns for servers that
2385 will be listed as bad exits in any network status document this authority
2386 publishes, if **AuthDirListBadExits** is set. +
2388 (The address pattern syntax here and in the options below
2389 is the same as for exit policies, except that you don't need to say
2390 "accept" or "reject", and ports are not needed.)
2392 [[AuthDirInvalid]] **AuthDirInvalid** __AddressPattern...__::
2393 Authoritative directories only. A set of address patterns for servers that
2394 will never be listed as "valid" in any network status document that this
2395 authority publishes.
2397 [[AuthDirReject]] **AuthDirReject** __AddressPattern__...::
2398 Authoritative directories only. A set of address patterns for servers that
2399 will never be listed at all in any network status document that this
2400 authority publishes, or accepted as an OR address in any descriptor
2401 submitted for publication by this authority.
2403 [[AuthDirBadExitCCs]] **AuthDirBadExitCCs** __CC__,... +
2405 [[AuthDirInvalidCCs]] **AuthDirInvalidCCs** __CC__,... +
2407 [[AuthDirRejectCCs]] **AuthDirRejectCCs** __CC__,...::
2408 Authoritative directories only. These options contain a comma-separated
2409 list of country codes such that any server in one of those country codes
2410 will be marked as a bad exit/invalid for use, or rejected
2413 [[AuthDirListBadExits]] **AuthDirListBadExits** **0**|**1**::
2414 Authoritative directories only. If set to 1, this directory has some
2415 opinion about which nodes are unsuitable as exit nodes. (Do not set this to
2416 1 unless you plan to list non-functioning exits as bad; otherwise, you are
2417 effectively voting in favor of every declared exit as an exit.)
2419 [[AuthDirMaxServersPerAddr]] **AuthDirMaxServersPerAddr** __NUM__::
2420 Authoritative directories only. The maximum number of servers that we will
2421 list as acceptable on a single IP address. Set this to "0" for "no limit".
2424 [[AuthDirFastGuarantee]] **AuthDirFastGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
2425 Authoritative directories only. If non-zero, always vote the
2426 Fast flag for any relay advertising this amount of capacity or
2427 more. (Default: 100 KBytes)
2429 [[AuthDirGuardBWGuarantee]] **AuthDirGuardBWGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
2430 Authoritative directories only. If non-zero, this advertised capacity
2431 or more is always sufficient to satisfy the bandwidth requirement
2432 for the Guard flag. (Default: 2 MBytes)
2434 [[AuthDirPinKeys]] **AuthDirPinKeys** **0**|**1**::
2435 Authoritative directories only. If non-zero, do not allow any relay to
2436 publish a descriptor if any other relay has reserved its <Ed25519,RSA>
2437 identity keypair. In all cases, Tor records every keypair it accepts
2438 in a journal if it is new, or if it differs from the most recently
2439 accepted pinning for one of the keys it contains. (Default: 1)
2441 [[AuthDirSharedRandomness]] **AuthDirSharedRandomness** **0**|**1**::
2442 Authoritative directories only. Switch for the shared random protocol.
2443 If zero, the authority won't participate in the protocol. If non-zero
2444 (default), the flag "shared-rand-participate" is added to the authority
2445 vote indicating participation in the protocol. (Default: 1)
2447 [[AuthDirTestEd25519LinkKeys]] **AuthDirTestEd25519LinkKeys** **0**|**1**::
2448 Authoritative directories only. If this option is set to 0, then we treat
2449 relays as "Running" if their RSA key is correct when we probe them,
2450 regardless of their Ed25519 key. We should only ever set this option to 0
2451 if there is some major bug in Ed25519 link authentication that causes us
2452 to label all the relays as not Running. (Default: 1)
2454 [[BridgePassword]] **BridgePassword** __Password__::
2455 If set, contains an HTTP authenticator that tells a bridge authority to
2456 serve all requested bridge information. Used by the (only partially
2457 implemented) "bridge community" design, where a community of bridge
2458 relay operators all use an alternate bridge directory authority,
2459 and their target user audience can periodically fetch the list of
2460 available community bridges to stay up-to-date. (Default: not set)
2462 [[V3AuthVotingInterval]] **V3AuthVotingInterval** __N__ **minutes**|**hours**::
2463 V3 authoritative directories only. Configures the server's preferred voting
2464 interval. Note that voting will __actually__ happen at an interval chosen
2465 by consensus from all the authorities' preferred intervals. This time
2466 SHOULD divide evenly into a day. (Default: 1 hour)
2468 [[V3AuthVoteDelay]] **V3AuthVoteDelay** __N__ **minutes**|**hours**::
2469 V3 authoritative directories only. Configures the server's preferred delay
2470 between publishing its vote and assuming it has all the votes from all the
2471 other authorities. Note that the actual time used is not the server's
2472 preferred time, but the consensus of all preferences. (Default: 5 minutes)
2474 [[V3AuthDistDelay]] **V3AuthDistDelay** __N__ **minutes**|**hours**::
2475 V3 authoritative directories only. Configures the server's preferred delay
2476 between publishing its consensus and signature and assuming it has all the
2477 signatures from all the other authorities. Note that the actual time used
2478 is not the server's preferred time, but the consensus of all preferences.
2479 (Default: 5 minutes)
2481 [[V3AuthNIntervalsValid]] **V3AuthNIntervalsValid** __NUM__::
2482 V3 authoritative directories only. Configures the number of VotingIntervals
2483 for which each consensus should be valid for. Choosing high numbers
2484 increases network partitioning risks; choosing low numbers increases
2485 directory traffic. Note that the actual number of intervals used is not the
2486 server's preferred number, but the consensus of all preferences. Must be at
2487 least 2. (Default: 3)
2489 [[V3BandwidthsFile]] **V3BandwidthsFile** __FILENAME__::
2490 V3 authoritative directories only. Configures the location of the
2491 bandwidth-authority generated file storing information on relays' measured
2492 bandwidth capacities. (Default: unset)
2494 [[V3AuthUseLegacyKey]] **V3AuthUseLegacyKey** **0**|**1**::
2495 If set, the directory authority will sign consensuses not only with its
2496 own signing key, but also with a "legacy" key and certificate with a
2497 different identity. This feature is used to migrate directory authority
2498 keys in the event of a compromise. (Default: 0)
2500 [[RephistTrackTime]] **RephistTrackTime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2501 Tells an authority, or other node tracking node reliability and history,
2502 that fine-grained information about nodes can be discarded when it hasn't
2503 changed for a given amount of time. (Default: 24 hours)
2505 [[AuthDirHasIPv6Connectivity]] **AuthDirHasIPv6Connectivity** **0**|**1**::
2506 Authoritative directories only. When set to 0, OR ports with an
2507 IPv6 address are not included in the authority's votes. When set to 1,
2508 IPv6 OR ports are tested for reachability like IPv4 OR ports. If the
2509 reachability test succeeds, the authority votes for the IPv6 ORPort, and
2510 votes Running for the relay. If the reachability test fails, the authority
2511 does not vote for the IPv6 ORPort, and does not vote Running (Default: 0) +
2513 The content of the consensus depends on the number of voting authorities
2514 that set AuthDirHasIPv6Connectivity:
2516 If no authorities set AuthDirHasIPv6Connectivity 1, there will be no
2517 IPv6 ORPorts in the consensus.
2519 If a minority of authorities set AuthDirHasIPv6Connectivity 1,
2520 unreachable IPv6 ORPorts will be removed from the consensus. But the
2521 majority of IPv4-only authorities will still vote the relay as Running.
2522 Reachable IPv6 ORPort lines will be included in the consensus
2524 If a majority of voting authorities set AuthDirHasIPv6Connectivity 1,
2525 relays with unreachable IPv6 ORPorts will not be listed as Running.
2526 Reachable IPv6 ORPort lines will be included in the consensus
2527 (To ensure that any valid majority will vote relays with unreachable
2528 IPv6 ORPorts not Running, 75% of authorities must set
2529 AuthDirHasIPv6Connectivity 1.)
2531 [[MinMeasuredBWsForAuthToIgnoreAdvertised]] **MinMeasuredBWsForAuthToIgnoreAdvertised** __N__::
2532 A total value, in abstract bandwidth units, describing how much
2533 measured total bandwidth an authority should have observed on the network
2534 before it will treat advertised bandwidths as wholly
2535 unreliable. (Default: 500)
2537 HIDDEN SERVICE OPTIONS
2538 ----------------------
2540 The following options are used to configure a hidden service.
2542 [[HiddenServiceDir]] **HiddenServiceDir** __DIRECTORY__::
2543 Store data files for a hidden service in DIRECTORY. Every hidden service
2544 must have a separate directory. You may use this option multiple times to
2545 specify multiple services. If DIRECTORY does not exist, Tor will create it.
2546 (Note: in current versions of Tor, if DIRECTORY is a relative path,
2547 it will be relative to the current
2548 working directory of Tor instance, not to its DataDirectory. Do not
2549 rely on this behavior; it is not guaranteed to remain the same in future
2552 [[HiddenServicePort]] **HiddenServicePort** __VIRTPORT__ [__TARGET__]::
2553 Configure a virtual port VIRTPORT for a hidden service. You may use this
2554 option multiple times; each time applies to the service using the most
2555 recent HiddenServiceDir. By default, this option maps the virtual port to
2556 the same port on 127.0.0.1 over TCP. You may override the target port,
2557 address, or both by specifying a target of addr, port, addr:port, or
2558 **unix:**__path__. (You can specify an IPv6 target as [addr]:port. Unix
2559 paths may be quoted, and may use standard C escapes.)
2560 You may also have multiple lines with the same VIRTPORT: when a user
2561 connects to that VIRTPORT, one of the TARGETs from those lines will be
2564 [[PublishHidServDescriptors]] **PublishHidServDescriptors** **0**|**1**::
2565 If set to 0, Tor will run any hidden services you configure, but it won't
2566 advertise them to the rendezvous directory. This option is only useful if
2567 you're using a Tor controller that handles hidserv publishing for you.
2570 [[HiddenServiceVersion]] **HiddenServiceVersion** __version__,__version__,__...__::
2571 A list of rendezvous service descriptor versions to publish for the hidden
2572 service. Currently, versions 2 and 3 are supported. (Default: 2)
2574 [[HiddenServiceAuthorizeClient]] **HiddenServiceAuthorizeClient** __auth-type__ __client-name__,__client-name__,__...__::
2575 If configured, the hidden service is accessible for authorized clients
2576 only. The auth-type can either be \'basic' for a general-purpose
2577 authorization protocol or \'stealth' for a less scalable protocol that also
2578 hides service activity from unauthorized clients. Only clients that are
2579 listed here are authorized to access the hidden service. Valid client names
2580 are 1 to 16 characters long and only use characters in A-Za-z0-9+-_ (no
2581 spaces). If this option is set, the hidden service is not accessible for
2582 clients without authorization any more. Generated authorization data can be
2583 found in the hostname file. Clients need to put this authorization data in
2584 their configuration file using **HidServAuth**.
2586 [[HiddenServiceAllowUnknownPorts]] **HiddenServiceAllowUnknownPorts** **0**|**1**::
2587 If set to 1, then connections to unrecognized ports do not cause the
2588 current hidden service to close rendezvous circuits. (Setting this to 0 is
2589 not an authorization mechanism; it is instead meant to be a mild
2590 inconvenience to port-scanners.) (Default: 0)
2592 [[HiddenServiceMaxStreams]] **HiddenServiceMaxStreams** __N__::
2593 The maximum number of simultaneous streams (connections) per rendezvous
2594 circuit. The maximum value allowed is 65535. (Setting this to 0 will allow
2595 an unlimited number of simultanous streams.) (Default: 0)
2597 [[HiddenServiceMaxStreamsCloseCircuit]] **HiddenServiceMaxStreamsCloseCircuit** **0**|**1**::
2598 If set to 1, then exceeding **HiddenServiceMaxStreams** will cause the
2599 offending rendezvous circuit to be torn down, as opposed to stream creation
2600 requests that exceed the limit being silently ignored. (Default: 0)
2602 [[RendPostPeriod]] **RendPostPeriod** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2603 Every time the specified period elapses, Tor uploads any rendezvous
2604 service descriptors to the directory servers. This information is also
2605 uploaded whenever it changes. Minimum value allowed is 10 minutes and
2606 maximum is 3.5 days. (Default: 1 hour)
2608 [[HiddenServiceDirGroupReadable]] **HiddenServiceDirGroupReadable** **0**|**1**::
2609 If this option is set to 1, allow the filesystem group to read the
2610 hidden service directory and hostname file. If the option is set to 0,
2611 only owner is able to read the hidden service directory. (Default: 0)
2612 Has no effect on Windows.
2614 [[HiddenServiceNumIntroductionPoints]] **HiddenServiceNumIntroductionPoints** __NUM__::
2615 Number of introduction points the hidden service will have. You can't
2616 have more than 10 for v2 service and 20 for v3. (Default: 3)
2618 [[HiddenServiceSingleHopMode]] **HiddenServiceSingleHopMode** **0**|**1**::
2619 **Experimental - Non Anonymous** Hidden Services on a tor instance in
2620 HiddenServiceSingleHopMode make one-hop (direct) circuits between the onion
2621 service server, and the introduction and rendezvous points. (Onion service
2622 descriptors are still posted using 3-hop paths, to avoid onion service
2623 directories blocking the service.)
2624 This option makes every hidden service instance hosted by a tor instance a
2625 Single Onion Service. One-hop circuits make Single Onion servers easily
2626 locatable, but clients remain location-anonymous. However, the fact that a
2627 client is accessing a Single Onion rather than a Hidden Service may be
2628 statistically distinguishable. +
2630 **WARNING:** Once a hidden service directory has been used by a tor
2631 instance in HiddenServiceSingleHopMode, it can **NEVER** be used again for
2632 a hidden service. It is best practice to create a new hidden service
2633 directory, key, and address for each new Single Onion Service and Hidden
2634 Service. It is not possible to run Single Onion Services and Hidden
2635 Services from the same tor instance: they should be run on different
2636 servers with different IP addresses. +
2638 HiddenServiceSingleHopMode requires HiddenServiceNonAnonymousMode to be set
2639 to 1. Since a Single Onion service is non-anonymous, you can not configure
2640 a SOCKSPort on a tor instance that is running in
2641 **HiddenServiceSingleHopMode**. Can not be changed while tor is running.
2644 [[HiddenServiceNonAnonymousMode]] **HiddenServiceNonAnonymousMode** **0**|**1**::
2645 Makes hidden services non-anonymous on this tor instance. Allows the
2646 non-anonymous HiddenServiceSingleHopMode. Enables direct connections in the
2647 server-side hidden service protocol. If you are using this option,
2648 you need to disable all client-side services on your Tor instance,
2649 including setting SOCKSPort to "0". Can not be changed while tor is
2650 running. (Default: 0)
2652 TESTING NETWORK OPTIONS
2653 -----------------------
2655 The following options are used for running a testing Tor network.
2657 [[TestingTorNetwork]] **TestingTorNetwork** **0**|**1**::
2658 If set to 1, Tor adjusts default values of the configuration options below,
2659 so that it is easier to set up a testing Tor network. May only be set if
2660 non-default set of DirAuthorities is set. Cannot be unset while Tor is
2664 ServerDNSAllowBrokenConfig 1
2665 DirAllowPrivateAddresses 1
2666 EnforceDistinctSubnets 0
2668 AuthDirMaxServersPerAddr 0
2669 AuthDirMaxServersPerAuthAddr 0
2670 ClientBootstrapConsensusAuthorityDownloadSchedule 0, 2,
2671 4 (for 40 seconds), 8, 16, 32, 60
2672 ClientBootstrapConsensusFallbackDownloadSchedule 0, 1,
2673 4 (for 40 seconds), 8, 16, 32, 60
2674 ClientBootstrapConsensusAuthorityOnlyDownloadSchedule 0, 1,
2675 4 (for 40 seconds), 8, 16, 32, 60
2676 ClientBootstrapConsensusMaxDownloadTries 80
2677 ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries 80
2678 ClientDNSRejectInternalAddresses 0
2679 ClientRejectInternalAddresses 0
2680 CountPrivateBandwidth 1
2681 ExitPolicyRejectPrivate 0
2682 ExtendAllowPrivateAddresses 1
2683 V3AuthVotingInterval 5 minutes
2684 V3AuthVoteDelay 20 seconds
2685 V3AuthDistDelay 20 seconds
2686 MinUptimeHidServDirectoryV2 0 seconds
2687 TestingV3AuthInitialVotingInterval 5 minutes
2688 TestingV3AuthInitialVoteDelay 20 seconds
2689 TestingV3AuthInitialDistDelay 20 seconds
2690 TestingAuthDirTimeToLearnReachability 0 minutes
2691 TestingEstimatedDescriptorPropagationTime 0 minutes
2692 TestingServerDownloadSchedule 0, 0, 0, 5, 10, 15, 20, 30, 60
2693 TestingClientDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2694 TestingServerConsensusDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2695 TestingClientConsensusDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2696 TestingBridgeDownloadSchedule 10, 30, 60
2697 TestingBridgeBootstrapDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2698 TestingClientMaxIntervalWithoutRequest 5 seconds
2699 TestingDirConnectionMaxStall 30 seconds
2700 TestingConsensusMaxDownloadTries 80
2701 TestingDescriptorMaxDownloadTries 80
2702 TestingMicrodescMaxDownloadTries 80
2703 TestingCertMaxDownloadTries 80
2704 TestingEnableConnBwEvent 1
2705 TestingEnableCellStatsEvent 1
2706 TestingEnableTbEmptyEvent 1
2708 [[TestingV3AuthInitialVotingInterval]] **TestingV3AuthInitialVotingInterval** __N__ **minutes**|**hours**::
2709 Like V3AuthVotingInterval, but for initial voting interval before the first
2710 consensus has been created. Changing this requires that
2711 **TestingTorNetwork** is set. (Default: 30 minutes)
2713 [[TestingV3AuthInitialVoteDelay]] **TestingV3AuthInitialVoteDelay** __N__ **minutes**|**hours**::
2714 Like V3AuthVoteDelay, but for initial voting interval before
2715 the first consensus has been created. Changing this requires that
2716 **TestingTorNetwork** is set. (Default: 5 minutes)
2718 [[TestingV3AuthInitialDistDelay]] **TestingV3AuthInitialDistDelay** __N__ **minutes**|**hours**::
2719 Like V3AuthDistDelay, but for initial voting interval before
2720 the first consensus has been created. Changing this requires that
2721 **TestingTorNetwork** is set. (Default: 5 minutes)
2723 [[TestingV3AuthVotingStartOffset]] **TestingV3AuthVotingStartOffset** __N__ **seconds**|**minutes**|**hours**::
2724 Directory authorities offset voting start time by this much.
2725 Changing this requires that **TestingTorNetwork** is set. (Default: 0)
2727 [[TestingAuthDirTimeToLearnReachability]] **TestingAuthDirTimeToLearnReachability** __N__ **minutes**|**hours**::
2728 After starting as an authority, do not make claims about whether routers
2729 are Running until this much time has passed. Changing this requires
2730 that **TestingTorNetwork** is set. (Default: 30 minutes)
2732 [[TestingEstimatedDescriptorPropagationTime]] **TestingEstimatedDescriptorPropagationTime** __N__ **minutes**|**hours**::
2733 Clients try downloading server descriptors from directory caches after this
2734 time. Changing this requires that **TestingTorNetwork** is set. (Default:
2737 [[TestingMinFastFlagThreshold]] **TestingMinFastFlagThreshold** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
2738 Minimum value for the Fast flag. Overrides the ordinary minimum taken
2739 from the consensus when TestingTorNetwork is set. (Default: 0.)
2741 [[TestingServerDownloadSchedule]] **TestingServerDownloadSchedule** __N__,__N__,__...__::
2742 Schedule for when servers should download things in general. Changing this
2743 requires that **TestingTorNetwork** is set. (Default: 0, 0, 0, 60, 60, 120,
2744 300, 900, 2147483647)
2746 [[TestingClientDownloadSchedule]] **TestingClientDownloadSchedule** __N__,__N__,__...__::
2747 Schedule for when clients should download things in general. Changing this
2748 requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2751 [[TestingServerConsensusDownloadSchedule]] **TestingServerConsensusDownloadSchedule** __N__,__N__,__...__::
2752 Schedule for when servers should download consensuses. Changing this
2753 requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2754 1800, 1800, 1800, 1800, 1800, 3600, 7200)
2756 [[TestingClientConsensusDownloadSchedule]] **TestingClientConsensusDownloadSchedule** __N__,__N__,__...__::
2757 Schedule for when clients should download consensuses. Changing this
2758 requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2759 1800, 3600, 3600, 3600, 10800, 21600, 43200)
2761 [[TestingBridgeDownloadSchedule]] **TestingBridgeDownloadSchedule** __N__,__N__,__...__::
2762 Schedule for when clients should download each bridge descriptor when they
2763 know that one or more of their configured bridges are running. Changing
2764 this requires that **TestingTorNetwork** is set. (Default: 10800, 25200,
2765 54000, 111600, 262800)
2767 [[TestingBridgeBootstrapDownloadSchedule]] **TestingBridgeBootstrapDownloadSchedule** __N__,__N__,__...__::
2768 Schedule for when clients should download each bridge descriptor when they
2769 have just started, or when they can not contact any of their bridges.
2770 Changing this requires that **TestingTorNetwork** is set. (Default: 0, 30,
2771 90, 600, 3600, 10800, 25200, 54000, 111600, 262800)
2773 [[TestingClientMaxIntervalWithoutRequest]] **TestingClientMaxIntervalWithoutRequest** __N__ **seconds**|**minutes**::
2774 When directory clients have only a few descriptors to request, they batch
2775 them until they have more, or until this amount of time has passed.
2776 Changing this requires that **TestingTorNetwork** is set. (Default: 10
2779 [[TestingDirConnectionMaxStall]] **TestingDirConnectionMaxStall** __N__ **seconds**|**minutes**::
2780 Let a directory connection stall this long before expiring it.
2781 Changing this requires that **TestingTorNetwork** is set. (Default:
2784 [[TestingConsensusMaxDownloadTries]] **TestingConsensusMaxDownloadTries** __NUM__::
2785 Try this many times to download a consensus before giving up. Changing
2786 this requires that **TestingTorNetwork** is set. (Default: 8)
2788 [[TestingDescriptorMaxDownloadTries]] **TestingDescriptorMaxDownloadTries** __NUM__::
2789 Try this often to download a server descriptor before giving up.
2790 Changing this requires that **TestingTorNetwork** is set. (Default: 8)
2792 [[TestingMicrodescMaxDownloadTries]] **TestingMicrodescMaxDownloadTries** __NUM__::
2793 Try this often to download a microdesc descriptor before giving up.
2794 Changing this requires that **TestingTorNetwork** is set. (Default: 8)
2796 [[TestingCertMaxDownloadTries]] **TestingCertMaxDownloadTries** __NUM__::
2797 Try this often to download a v3 authority certificate before giving up.
2798 Changing this requires that **TestingTorNetwork** is set. (Default: 8)
2800 [[TestingDirAuthVoteExit]] **TestingDirAuthVoteExit** __node__,__node__,__...__::
2801 A list of identity fingerprints, country codes, and
2802 address patterns of nodes to vote Exit for regardless of their
2803 uptime, bandwidth, or exit policy. See the **ExcludeNodes**
2804 option for more information on how to specify nodes. +
2806 In order for this option to have any effect, **TestingTorNetwork**
2807 has to be set. See the **ExcludeNodes** option for more
2808 information on how to specify nodes.
2810 [[TestingDirAuthVoteExitIsStrict]] **TestingDirAuthVoteExitIsStrict** **0**|**1** ::
2811 If True (1), a node will never receive the Exit flag unless it is specified
2812 in the **TestingDirAuthVoteExit** list, regardless of its uptime, bandwidth,
2815 In order for this option to have any effect, **TestingTorNetwork**
2818 [[TestingDirAuthVoteGuard]] **TestingDirAuthVoteGuard** __node__,__node__,__...__::
2819 A list of identity fingerprints and country codes and
2820 address patterns of nodes to vote Guard for regardless of their
2821 uptime and bandwidth. See the **ExcludeNodes** option for more
2822 information on how to specify nodes. +
2824 In order for this option to have any effect, **TestingTorNetwork**
2827 [[TestingDirAuthVoteGuardIsStrict]] **TestingDirAuthVoteGuardIsStrict** **0**|**1** ::
2828 If True (1), a node will never receive the Guard flag unless it is specified
2829 in the **TestingDirAuthVoteGuard** list, regardless of its uptime and bandwidth. +
2831 In order for this option to have any effect, **TestingTorNetwork**
2834 [[TestingDirAuthVoteHSDir]] **TestingDirAuthVoteHSDir** __node__,__node__,__...__::
2835 A list of identity fingerprints and country codes and
2836 address patterns of nodes to vote HSDir for regardless of their
2837 uptime and DirPort. See the **ExcludeNodes** option for more
2838 information on how to specify nodes. +
2840 In order for this option to have any effect, **TestingTorNetwork**
2843 [[TestingDirAuthVoteHSDirIsStrict]] **TestingDirAuthVoteHSDirIsStrict** **0**|**1** ::
2844 If True (1), a node will never receive the HSDir flag unless it is specified
2845 in the **TestingDirAuthVoteHSDir** list, regardless of its uptime and DirPort. +
2847 In order for this option to have any effect, **TestingTorNetwork**
2850 [[TestingEnableConnBwEvent]] **TestingEnableConnBwEvent** **0**|**1**::
2851 If this option is set, then Tor controllers may register for CONN_BW
2852 events. Changing this requires that **TestingTorNetwork** is set.
2855 [[TestingEnableCellStatsEvent]] **TestingEnableCellStatsEvent** **0**|**1**::
2856 If this option is set, then Tor controllers may register for CELL_STATS
2857 events. Changing this requires that **TestingTorNetwork** is set.
2860 [[TestingEnableTbEmptyEvent]] **TestingEnableTbEmptyEvent** **0**|**1**::
2861 If this option is set, then Tor controllers may register for TB_EMPTY
2862 events. Changing this requires that **TestingTorNetwork** is set.
2865 [[TestingMinExitFlagThreshold]] **TestingMinExitFlagThreshold** __N__ **KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
2866 Sets a lower-bound for assigning an exit flag when running as an
2867 authority on a testing network. Overrides the usual default lower bound
2868 of 4 KB. (Default: 0)
2870 [[TestingLinkCertLifetime]] **TestingLinkCertLifetime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**|**months**::
2871 Overrides the default lifetime for the certificates used to authenticate
2872 our X509 link cert with our ed25519 signing key.
2875 [[TestingAuthKeyLifetime]] **TestingAuthKeyLifetime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**|**months**::
2876 Overrides the default lifetime for a signing Ed25519 TLS Link authentication
2880 [[TestingLinkKeySlop]] **TestingLinkKeySlop** __N__ **seconds**|**minutes**|**hours** +
2882 [[TestingAuthKeySlop]] **TestingAuthKeySlop** __N__ **seconds**|**minutes**|**hours** +
2884 [[TestingSigningKeySlop]] **TestingSigningKeySlop** __N__ **seconds**|**minutes**|**hours**::
2885 How early before the official expiration of a an Ed25519 signing key do
2886 we replace it and issue a new key?
2887 (Default: 3 hours for link and auth; 1 day for signing.)
2889 NON-PERSISTENT OPTIONS
2890 ----------------------
2892 These options are not saved to the torrc file by the "SAVECONF" controller
2893 command. Other options of this type are documented in control-spec.txt,
2894 section 5.4. End-users should mostly ignore them.
2896 [[UnderscorePorts]] **\_\_ControlPort**, **\_\_DirPort**, **\_\_DNSPort**, **\_\_ExtORPort**, **\_\_NATDPort**, **\_\_ORPort**, **\_\_SocksPort**, **\_\_TransPort**::
2897 These underscore-prefixed options are variants of the regular Port
2898 options. They behave the same, except they are not saved to the
2899 torrc file by the controller's SAVECONF command.
2905 Tor catches the following signals:
2907 [[SIGTERM]] **SIGTERM**::
2908 Tor will catch this, clean up and sync to disk if necessary, and exit.
2910 [[SIGINT]] **SIGINT**::
2911 Tor clients behave as with SIGTERM; but Tor servers will do a controlled
2912 slow shutdown, closing listeners and waiting 30 seconds before exiting.
2913 (The delay can be configured with the ShutdownWaitLength config option.)
2915 [[SIGHUP]] **SIGHUP**::
2916 The signal instructs Tor to reload its configuration (including closing and
2917 reopening logs), and kill and restart its helper processes if applicable.
2919 [[SIGUSR1]] **SIGUSR1**::
2920 Log statistics about current connections, past connections, and throughput.
2922 [[SIGUSR2]] **SIGUSR2**::
2923 Switch all logs to loglevel debug. You can go back to the old loglevels by
2926 [[SIGCHLD]] **SIGCHLD**::
2927 Tor receives this signal when one of its helper processes has exited, so it
2930 [[SIGPIPE]] **SIGPIPE**::
2931 Tor catches this signal and ignores it.
2933 [[SIGXFSZ]] **SIGXFSZ**::
2934 If this signal exists on your platform, Tor catches and ignores it.
2939 **@CONFDIR@/torrc**::
2940 The configuration file, which contains "option value" pairs.
2943 Fallback location for torrc, if @CONFDIR@/torrc is not found.
2945 **@LOCALSTATEDIR@/lib/tor/**::
2946 The tor process stores keys and other data here.
2949 __CacheDirectory__**/cached-certs**::
2950 This file holds downloaded directory key certificates that are used to
2951 verify authenticity of documents generated by Tor directory authorities.
2953 __CacheDirectory__**/cached-consensus** and/or **cached-microdesc-consensus**::
2954 The most recent consensus network status document we've downloaded.
2956 __CacheDirectory__**/cached-descriptors** and **cached-descriptors.new**::
2957 These files hold downloaded router statuses. Some routers may appear more
2958 than once; if so, the most recently published descriptor is used. Lines
2959 beginning with @-signs are annotations that contain more information about
2960 a given router. The ".new" file is an append-only journal; when it gets
2961 too large, all entries are merged into a new cached-descriptors file.
2963 __CacheDirectory__**/cached-extrainfo** and **cached-extrainfo.new**::
2964 As "cached-descriptors", but holds optionally-downloaded "extra-info"
2965 documents. Relays use these documents to send inessential information
2966 about statistics, bandwidth history, and network health to the
2967 authorities. They aren't fetched by default; see the DownloadExtraInfo
2968 option for more info.
2970 __CacheDirectory__**/cached-microdescs** and **cached-microdescs.new**::
2971 These files hold downloaded microdescriptors. Lines beginning with
2972 @-signs are annotations that contain more information about a given
2973 router. The ".new" file is an append-only journal; when it gets too
2974 large, all entries are merged into a new cached-microdescs file.
2976 __CacheDirectory__**/cached-routers** and **cached-routers.new**::
2977 Obsolete versions of cached-descriptors and cached-descriptors.new. When
2978 Tor can't find the newer files, it looks here instead.
2980 __DataDirectory__**/state**::
2981 A set of persistent key-value mappings. These are documented in
2982 the file. These include:
2983 - The current entry guards and their status.
2984 - The current bandwidth accounting values.
2985 - When the file was last written
2986 - What version of Tor generated the state file
2987 - A short history of bandwidth usage, as produced in the server
2990 __DataDirectory__**/sr-state**::
2991 Authority only. State file used to record information about the current
2992 status of the shared-random-value voting state.
2994 __CacheDirectory__**/diff-cache**::
2995 Directory cache only. Holds older consensuses, and diffs from older
2996 consensuses to the most recent consensus of each type, compressed
2997 in various ways. Each file contains a set of key-value arguments
2998 decribing its contents, followed by a single NUL byte, followed by the
3001 __DataDirectory__**/bw_accounting**::
3002 Used to track bandwidth accounting values (when the current period starts
3003 and ends; how much has been read and written so far this period). This file
3004 is obsolete, and the data is now stored in the \'state' file instead.
3006 __DataDirectory__**/control_auth_cookie**::
3007 Used for cookie authentication with the controller. Location can be
3008 overridden by the CookieAuthFile config option. Regenerated on startup. See
3009 control-spec.txt in https://spec.torproject.org/[torspec] for details.
3010 Only used when cookie authentication is enabled.
3012 __DataDirectory__**/lock**::
3013 This file is used to prevent two Tor instances from using same data
3014 directory. If access to this file is locked, data directory is already
3017 __DataDirectory__**/key-pinning-journal**::
3018 Used by authorities. A line-based file that records mappings between
3019 RSA1024 identity keys and Ed25519 identity keys. Authorities enforce
3020 these mappings, so that once a relay has picked an Ed25519 key, stealing
3021 or factoring the RSA1024 key will no longer let an attacker impersonate
3024 __KeyDirectory__**/authority_identity_key**::
3025 A v3 directory authority's master identity key, used to authenticate its
3026 signing key. Tor doesn't use this while it's running. The tor-gencert
3027 program uses this. If you're running an authority, you should keep this
3028 key offline, and not actually put it here.
3030 __KeyDirectory__**/authority_certificate**::
3031 A v3 directory authority's certificate, which authenticates the authority's
3032 current vote- and consensus-signing key using its master identity key.
3033 Only directory authorities use this file.
3035 __KeyDirectory__**/authority_signing_key**::
3036 A v3 directory authority's signing key, used to sign votes and consensuses.
3037 Only directory authorities use this file. Corresponds to the
3038 **authority_certificate** cert.
3040 __KeyDirectory__**/legacy_certificate**::
3041 As authority_certificate: used only when V3AuthUseLegacyKey is set.
3042 See documentation for V3AuthUseLegacyKey.
3044 __KeyDirectory__**/legacy_signing_key**::
3045 As authority_signing_key: used only when V3AuthUseLegacyKey is set.
3046 See documentation for V3AuthUseLegacyKey.
3048 __KeyDirectory__**/secret_id_key**::
3049 A relay's RSA1024 permanent identity key, including private and public
3050 components. Used to sign router descriptors, and to sign other keys.
3052 __KeyDirectory__**/ed25519_master_id_public_key**::
3053 The public part of a relay's Ed25519 permanent identity key.
3055 __KeyDirectory__**/ed25519_master_id_secret_key**::
3056 The private part of a relay's Ed25519 permanent identity key. This key
3057 is used to sign the medium-term ed25519 signing key. This file can be
3058 kept offline, or kept encrypted. If so, Tor will not be able to generate
3059 new signing keys itself; you'll need to use tor --keygen yourself to do
3062 __KeyDirectory__**/ed25519_signing_secret_key**::
3063 The private and public components of a relay's medium-term Ed25519 signing
3064 key. This key is authenticated by the Ed25519 master key, in turn
3065 authenticates other keys (and router descriptors).
3067 __KeyDirectory__**/ed25519_signing_cert**::
3068 The certificate which authenticates "ed25519_signing_secret_key" as
3069 having been signed by the Ed25519 master key.
3071 __KeyDirectory__**/secret_onion_key** and **secret_onion_key.old**::
3072 A relay's RSA1024 short-term onion key. Used to decrypt old-style ("TAP")
3073 circuit extension requests. The ".old" file holds the previously
3074 generated key, which the relay uses to handle any requests that were
3075 made by clients that didn't have the new one.
3077 __KeyDirectory__**/secret_onion_key_ntor** and **secret_onion_key_ntor.old**::
3078 A relay's Curve25519 short-term onion key. Used to handle modern ("ntor")
3079 circuit extension requests. The ".old" file holds the previously
3080 generated key, which the relay uses to handle any requests that were
3081 made by clients that didn't have the new one.
3083 __DataDirectory__**/fingerprint**::
3084 Only used by servers. Holds the fingerprint of the server's identity key.
3086 __DataDirectory__**/hashed-fingerprint**::
3087 Only used by bridges. Holds the hashed fingerprint of the bridge's
3088 identity key. (That is, the hash of the hash of the identity key.)
3090 __DataDirectory__**/approved-routers**::
3091 Only used by authoritative directory servers. This file lists
3092 the status of routers by their identity fingerprint.
3093 Each line lists a status and a fingerprint separated by
3094 whitespace. See your **fingerprint** file in the __DataDirectory__ for an
3095 example line. If the status is **!reject** then descriptors from the
3096 given identity (fingerprint) are rejected by this server. If it is
3097 **!invalid** then descriptors are accepted but marked in the directory as
3098 not valid, that is, not recommended.
3100 __DataDirectory__**/v3-status-votes**::
3101 Only for v3 authoritative directory servers. This file contains
3102 status votes from all the authoritative directory servers.
3104 __CacheDirectory__**/unverified-consensus**::
3105 This file contains a network consensus document that has been downloaded,
3106 but which we didn't have the right certificates to check yet.
3108 __CacheDirectory__**/unverified-microdesc-consensus**::
3109 This file contains a microdescriptor-flavored network consensus document
3110 that has been downloaded, but which we didn't have the right certificates
3113 __DataDirectory__**/unparseable-desc**::
3114 Onion server descriptors that Tor was unable to parse are dumped to this
3115 file. Only used for debugging.
3117 __DataDirectory__**/router-stability**::
3118 Only used by authoritative directory servers. Tracks measurements for
3119 router mean-time-between-failures so that authorities have a good idea of
3120 how to set their Stable flags.
3122 __DataDirectory__**/stats/dirreq-stats**::
3123 Only used by directory caches and authorities. This file is used to
3124 collect directory request statistics.
3126 __DataDirectory__**/stats/entry-stats**::
3127 Only used by servers. This file is used to collect incoming connection
3128 statistics by Tor entry nodes.
3130 __DataDirectory__**/stats/bridge-stats**::
3131 Only used by servers. This file is used to collect incoming connection
3132 statistics by Tor bridges.
3134 __DataDirectory__**/stats/exit-stats**::
3135 Only used by servers. This file is used to collect outgoing connection
3136 statistics by Tor exit routers.
3138 __DataDirectory__**/stats/buffer-stats**::
3139 Only used by servers. This file is used to collect buffer usage
3142 __DataDirectory__**/stats/conn-stats**::
3143 Only used by servers. This file is used to collect approximate connection
3144 history (number of active connections over time).
3146 __DataDirectory__**/stats/hidserv-stats**::
3147 Only used by servers. This file is used to collect approximate counts
3148 of what fraction of the traffic is hidden service rendezvous traffic, and
3149 approximately how many hidden services the relay has seen.
3151 __DataDirectory__**/networkstatus-bridges**::
3152 Only used by authoritative bridge directories. Contains information
3153 about bridges that have self-reported themselves to the bridge
3156 __DataDirectory__**/approved-routers**::
3157 Authorities only. This file is used to configure which relays are
3158 known to be valid, invalid, and so forth.
3160 __HiddenServiceDirectory__**/hostname**::
3161 The <base32-encoded-fingerprint>.onion domain name for this hidden service.
3162 If the hidden service is restricted to authorized clients only, this file
3163 also contains authorization data for all clients.
3165 Note that clients will ignore any extra subdomains prepended to a hidden
3166 service hostname. So if you have "xyz.onion" as your hostname, you
3167 can tell clients to connect to "www.xyz.onion" or "irc.xyz.onion"
3168 for virtual-hosting purposes.
3170 __HiddenServiceDirectory__**/private_key**::
3171 The private key for this hidden service.
3173 __HiddenServiceDirectory__**/client_keys**::
3174 Authorization data for a hidden service that is only accessible by
3177 __HiddenServiceDirectory__**/onion_service_non_anonymous**::
3178 This file is present if a hidden service key was created in
3179 **HiddenServiceNonAnonymousMode**.
3183 **torsocks**(1), **torify**(1) +
3185 **https://www.torproject.org/**
3187 **torspec: https://spec.torproject.org **
3192 Plenty, probably. Tor is still in development. Please report them at https://trac.torproject.org/.
3196 Roger Dingledine [arma at mit.edu], Nick Mathewson [nickm at alum.mit.edu].