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. Tor will make still certain
315 network-related calls (like DNS lookups) as a part of its configuration
316 process, even if DisableNetwork is set. (Default: 0)
318 [[ConstrainedSockets]] **ConstrainedSockets** **0**|**1**::
319 If set, Tor will tell the kernel to attempt to shrink the buffers for all
320 sockets to the size specified in **ConstrainedSockSize**. This is useful for
321 virtual servers and other environments where system level TCP buffers may
322 be limited. If you're on a virtual server, and you encounter the "Error
323 creating network socket: No buffer space available" message, you are
324 likely experiencing this problem. +
326 The preferred solution is to have the admin increase the buffer pool for
327 the host itself via /proc/sys/net/ipv4/tcp_mem or equivalent facility;
328 this configuration option is a second-resort. +
330 The DirPort option should also not be used if TCP buffers are scarce. The
331 cached directory requests consume additional sockets which exacerbates
334 You should **not** enable this feature unless you encounter the "no buffer
335 space available" issue. Reducing the TCP buffers affects window size for
336 the TCP stream and will reduce throughput in proportion to round trip
337 time on long paths. (Default: 0)
339 [[ConstrainedSockSize]] **ConstrainedSockSize** __N__ **bytes**|**KBytes**::
340 When **ConstrainedSockets** is enabled the receive and transmit buffers for
341 all sockets will be set to this limit. Must be a value between 2048 and
342 262144, in 1024 byte increments. Default of 8192 is recommended.
344 [[ControlPort]] **ControlPort** __PORT__|**unix:**__path__|**auto** [__flags__]::
345 If set, Tor will accept connections on this port and allow those
346 connections to control the Tor process using the Tor Control Protocol
347 (described in control-spec.txt in
348 https://spec.torproject.org[torspec]). Note: unless you also
349 specify one or more of **HashedControlPassword** or
350 **CookieAuthentication**, setting this option will cause Tor to allow
351 any process on the local host to control it. (Setting both authentication
352 methods means either method is sufficient to authenticate to Tor.) This
353 option is required for many Tor controllers; most use the value of 9051.
354 If a unix domain socket is used, you may quote the path using standard
356 Set it to "auto" to have Tor pick a port for you. (Default: 0) +
358 Recognized flags are...
360 Unix domain sockets only: makes the socket get created as
363 Unix domain sockets only: makes the socket get created as
365 **RelaxDirModeCheck**;;
366 Unix domain sockets only: Do not insist that the directory
367 that holds the socket be read-restricted.
369 [[ControlSocket]] **ControlSocket** __Path__::
370 Like ControlPort, but listens on a Unix domain socket, rather than a TCP
371 socket. '0' disables ControlSocket (Unix and Unix-like systems only.)
373 [[ControlSocketsGroupWritable]] **ControlSocketsGroupWritable** **0**|**1**::
374 If this option is set to 0, don't allow the filesystem group to read and
375 write unix sockets (e.g. ControlSocket). If the option is set to 1, make
376 the control socket readable and writable by the default GID. (Default: 0)
378 [[HashedControlPassword]] **HashedControlPassword** __hashed_password__::
379 Allow connections on the control port if they present
380 the password whose one-way hash is __hashed_password__. You
381 can compute the hash of a password by running "tor --hash-password
382 __password__". You can provide several acceptable passwords by using more
383 than one HashedControlPassword line.
385 [[CookieAuthentication]] **CookieAuthentication** **0**|**1**::
386 If this option is set to 1, allow connections on the control port
387 when the connecting process knows the contents of a file named
388 "control_auth_cookie", which Tor will create in its data directory. This
389 authentication method should only be used on systems with good filesystem
390 security. (Default: 0)
392 [[CookieAuthFile]] **CookieAuthFile** __Path__::
393 If set, this option overrides the default location and file name
394 for Tor's cookie file. (See CookieAuthentication above.)
396 [[CookieAuthFileGroupReadable]] **CookieAuthFileGroupReadable** **0**|**1**::
397 If this option is set to 0, don't allow the filesystem group to read the
398 cookie file. If the option is set to 1, make the cookie file readable by
399 the default GID. [Making the file readable by other groups is not yet
400 implemented; let us know if you need this for some reason.] (Default: 0)
402 [[ControlPortWriteToFile]] **ControlPortWriteToFile** __Path__::
403 If set, Tor writes the address and port of any control port it opens to
404 this address. Usable by controllers to learn the actual control port
405 when ControlPort is set to "auto".
407 [[ControlPortFileGroupReadable]] **ControlPortFileGroupReadable** **0**|**1**::
408 If this option is set to 0, don't allow the filesystem group to read the
409 control port file. If the option is set to 1, make the control port
410 file readable by the default GID. (Default: 0)
412 [[DataDirectory]] **DataDirectory** __DIR__::
413 Store working data in DIR. Can not be changed while tor is running.
414 (Default: ~/.tor if your home directory is not /; otherwise,
415 @LOCALSTATEDIR@/lib/tor. On Windows, the default is
416 your ApplicationData folder.)
418 [[DataDirectoryGroupReadable]] **DataDirectoryGroupReadable** **0**|**1**::
419 If this option is set to 0, don't allow the filesystem group to read the
420 DataDirectory. If the option is set to 1, make the DataDirectory readable
421 by the default GID. (Default: 0)
423 [[CacheDirectory]] **CacheDirectory** __DIR__::
424 Store cached directory data in DIR. Can not be changed while tor is
426 (Default: uses the value of DataDirectory.)
428 [[CacheDirectoryGroupReadable]] **CacheDirectoryGroupReadable** **0**|**1**::
429 If this option is set to 0, don't allow the filesystem group to read the
430 CacheDirectory. If the option is set to 1, make the CacheDirectory readable
431 by the default GID. (Default: 0)
433 [[FallbackDir]] **FallbackDir** __ipv4address__:__port__ orport=__port__ id=__fingerprint__ [weight=__num__] [ipv6=**[**__ipv6address__**]**:__orport__]::
434 When we're unable to connect to any directory cache for directory info
435 (usually because we don't know about any yet) we try a directory authority.
436 Clients also simultaneously try a FallbackDir, to avoid hangs on client
437 startup if a directory authority is down. Clients retry FallbackDirs more
438 often than directory authorities, to reduce the load on the directory
440 By default, the directory authorities are also FallbackDirs. Specifying a
441 FallbackDir replaces Tor's default hard-coded FallbackDirs (if any).
442 (See the **DirAuthority** entry for an explanation of each flag.)
444 [[UseDefaultFallbackDirs]] **UseDefaultFallbackDirs** **0**|**1**::
445 Use Tor's default hard-coded FallbackDirs (if any). (When a
446 FallbackDir line is present, it replaces the hard-coded FallbackDirs,
447 regardless of the value of UseDefaultFallbackDirs.) (Default: 1)
449 [[DirAuthority]] **DirAuthority** [__nickname__] [**flags**] __ipv4address__:__port__ __fingerprint__::
450 Use a nonstandard authoritative directory server at the provided address
451 and port, with the specified key fingerprint. This option can be repeated
452 many times, for multiple authoritative directory servers. Flags are
453 separated by spaces, and determine what kind of an authority this directory
454 is. By default, an authority is not authoritative for any directory style
455 or version unless an appropriate flag is given.
456 Tor will use this authority as a bridge authoritative directory if the
457 "bridge" flag is set. If a flag "orport=**port**" is given, Tor will use the
458 given port when opening encrypted tunnels to the dirserver. If a flag
459 "weight=**num**" is given, then the directory server is chosen randomly
460 with probability proportional to that weight (default 1.0). If a
461 flag "v3ident=**fp**" is given, the dirserver is a v3 directory authority
462 whose v3 long-term signing key has the fingerprint **fp**. Lastly,
463 if an "ipv6=**[**__ipv6address__**]**:__orport__" flag is present, then
465 authority is listening for IPv6 connections on the indicated IPv6 address
468 Tor will contact the authority at __ipv4address__ to
469 download directory documents. The provided __port__ value is a dirport;
470 clients ignore this in favor of the specified "orport=" value. If an
471 IPv6 ORPort is supplied, Tor will
472 also download directory documents at the IPv6 ORPort. +
474 If no **DirAuthority** line is given, Tor will use the default directory
475 authorities. NOTE: this option is intended for setting up a private Tor
476 network with its own directory authorities. If you use it, you will be
477 distinguishable from other users, because you won't believe the same
480 [[DirAuthorityFallbackRate]] **DirAuthorityFallbackRate** __NUM__::
481 When configured to use both directory authorities and fallback
482 directories, the directory authorities also work as fallbacks. They are
483 chosen with their regular weights, multiplied by this number, which
484 should be 1.0 or less. The default is less than 1, to reduce load on
485 authorities. (Default: 0.1)
487 [[AlternateDirAuthority]] **AlternateDirAuthority** [__nickname__] [**flags**] __ipv4address__:__port__ __fingerprint__ +
489 [[AlternateBridgeAuthority]] **AlternateBridgeAuthority** [__nickname__] [**flags**] __ipv4address__:__port__ __ fingerprint__::
490 These options behave as DirAuthority, but they replace fewer of the
491 default directory authorities. Using
492 AlternateDirAuthority replaces the default Tor directory authorities, but
493 leaves the default bridge authorities in
495 AlternateBridgeAuthority replaces the default bridge authority,
496 but leaves the directory authorities alone.
498 [[DisableAllSwap]] **DisableAllSwap** **0**|**1**::
499 If set to 1, Tor will attempt to lock all current and future memory pages,
500 so that memory cannot be paged out. Windows, OS X and Solaris are currently
501 not supported. We believe that this feature works on modern Gnu/Linux
502 distributions, and that it should work on *BSD systems (untested). This
503 option requires that you start your Tor as root, and you should use the
504 **User** option to properly reduce Tor's privileges.
505 Can not be changed while tor is running. (Default: 0)
507 [[DisableDebuggerAttachment]] **DisableDebuggerAttachment** **0**|**1**::
508 If set to 1, Tor will attempt to prevent basic debugging attachment attempts
509 by other processes. This may also keep Tor from generating core files if
510 it crashes. It has no impact for users who wish to attach if they
511 have CAP_SYS_PTRACE or if they are root. We believe that this feature
512 works on modern Gnu/Linux distributions, and that it may also work on *BSD
513 systems (untested). Some modern Gnu/Linux systems such as Ubuntu have the
514 kernel.yama.ptrace_scope sysctl and by default enable it as an attempt to
515 limit the PTRACE scope for all user processes by default. This feature will
516 attempt to limit the PTRACE scope for Tor specifically - it will not attempt
517 to alter the system wide ptrace scope as it may not even exist. If you wish
518 to attach to Tor with a debugger such as gdb or strace you will want to set
519 this to 0 for the duration of your debugging. Normal users should leave it
520 on. Disabling this option while Tor is running is prohibited. (Default: 1)
522 [[FetchDirInfoEarly]] **FetchDirInfoEarly** **0**|**1**::
523 If set to 1, Tor will always fetch directory information like other
524 directory caches, even if you don't meet the normal criteria for fetching
525 early. Normal users should leave it off. (Default: 0)
527 [[FetchDirInfoExtraEarly]] **FetchDirInfoExtraEarly** **0**|**1**::
528 If set to 1, Tor will fetch directory information before other directory
529 caches. It will attempt to download directory information closer to the
530 start of the consensus period. Normal users should leave it off.
533 [[FetchHidServDescriptors]] **FetchHidServDescriptors** **0**|**1**::
534 If set to 0, Tor will never fetch any hidden service descriptors from the
535 rendezvous directories. This option is only useful if you're using a Tor
536 controller that handles hidden service fetches for you. (Default: 1)
538 [[FetchServerDescriptors]] **FetchServerDescriptors** **0**|**1**::
539 If set to 0, Tor will never fetch any network status summaries or server
540 descriptors from the directory servers. This option is only useful if
541 you're using a Tor controller that handles directory fetches for you.
544 [[FetchUselessDescriptors]] **FetchUselessDescriptors** **0**|**1**::
545 If set to 1, Tor will fetch every consensus flavor, descriptor, and
546 certificate that it hears about. Otherwise, it will avoid fetching useless
547 descriptors: flavors that it is not using to build circuits, and authority
548 certificates it does not trust. This option is useful if you're using a
549 tor client with an external parser that uses a full consensus.
550 This option fetches all documents, **DirCache** fetches and serves
551 all documents. (Default: 0)
553 [[HTTPProxy]] **HTTPProxy** __host__[:__port__]::
554 Tor will make all its directory requests through this host:port (or host:80
555 if port is not specified), rather than connecting directly to any directory
556 servers. (DEPRECATED: As of 0.3.1.0-alpha you should use HTTPSProxy.)
558 [[HTTPProxyAuthenticator]] **HTTPProxyAuthenticator** __username:password__::
559 If defined, Tor will use this username:password for Basic HTTP proxy
560 authentication, as in RFC 2617. This is currently the only form of HTTP
561 proxy authentication that Tor supports; feel free to submit a patch if you
562 want it to support others. (DEPRECATED: As of 0.3.1.0-alpha you should use
563 HTTPSProxyAuthenticator.)
565 [[HTTPSProxy]] **HTTPSProxy** __host__[:__port__]::
566 Tor will make all its OR (SSL) connections through this host:port (or
567 host:443 if port is not specified), via HTTP CONNECT rather than connecting
568 directly to servers. You may want to set **FascistFirewall** to restrict
569 the set of ports you might try to connect to, if your HTTPS proxy only
570 allows connecting to certain ports.
572 [[HTTPSProxyAuthenticator]] **HTTPSProxyAuthenticator** __username:password__::
573 If defined, Tor will use this username:password for Basic HTTPS proxy
574 authentication, as in RFC 2617. This is currently the only form of HTTPS
575 proxy authentication that Tor supports; feel free to submit a patch if you
576 want it to support others.
578 [[Sandbox]] **Sandbox** **0**|**1**::
579 If set to 1, Tor will run securely through the use of a syscall sandbox.
580 Otherwise the sandbox will be disabled. The option is currently an
581 experimental feature. It only works on Linux-based operating systems,
582 and only when Tor has been built with the libseccomp library. This option
583 can not be changed while tor is running.
585 When the Sandbox is 1, the following options can not be changed when tor
591 ExtORPortCookieAuthFile
593 ServerDNSResolvConfFile
594 Tor must remain in client or server mode (some changes to ClientOnly and
595 ORPort are not allowed).
598 [[Socks4Proxy]] **Socks4Proxy** __host__[:__port__]::
599 Tor will make all OR connections through the SOCKS 4 proxy at host:port
600 (or host:1080 if port is not specified).
602 [[Socks5Proxy]] **Socks5Proxy** __host__[:__port__]::
603 Tor will make all OR connections through the SOCKS 5 proxy at host:port
604 (or host:1080 if port is not specified).
606 [[Socks5ProxyUsername]] **Socks5ProxyUsername** __username__ +
608 [[Socks5ProxyPassword]] **Socks5ProxyPassword** __password__::
609 If defined, authenticate to the SOCKS 5 server using username and password
610 in accordance to RFC 1929. Both username and password must be between 1 and
613 [[UnixSocksGroupWritable]] **UnixSocksGroupWritable** **0**|**1**::
614 If this option is set to 0, don't allow the filesystem group to read and
615 write unix sockets (e.g. SocksPort unix:). If the option is set to 1, make
616 the Unix socket readable and writable by the default GID. (Default: 0)
618 [[KeepalivePeriod]] **KeepalivePeriod** __NUM__::
619 To keep firewalls from expiring connections, send a padding keepalive cell
620 every NUM seconds on open connections that are in use. If the connection
621 has no open circuits, it will instead be closed after NUM seconds of
622 idleness. (Default: 5 minutes)
624 [[Log]] **Log** __minSeverity__[-__maxSeverity__] **stderr**|**stdout**|**syslog**::
625 Send all messages between __minSeverity__ and __maxSeverity__ to the standard
626 output stream, the standard error stream, or to the system log. (The
627 "syslog" value is only supported on Unix.) Recognized severity levels are
628 debug, info, notice, warn, and err. We advise using "notice" in most cases,
629 since anything more verbose may provide sensitive information to an
630 attacker who obtains the logs. If only one severity level is given, all
631 messages of that level or higher will be sent to the listed destination.
633 [[Log2]] **Log** __minSeverity__[-__maxSeverity__] **file** __FILENAME__::
634 As above, but send log messages to the listed filename. The
635 "Log" option may appear more than once in a configuration file.
636 Messages are sent to all the logs that match their severity
639 [[Log3]] **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **file** __FILENAME__ +
641 [[Log4]] **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **stderr**|**stdout**|**syslog**::
642 As above, but select messages by range of log severity __and__ by a
643 set of "logging domains". Each logging domain corresponds to an area of
644 functionality inside Tor. You can specify any number of severity ranges
645 for a single log statement, each of them prefixed by a comma-separated
646 list of logging domains. You can prefix a domain with $$~$$ to indicate
647 negation, and use * to indicate "all domains". If you specify a severity
648 range without a list of domains, it matches all domains. +
650 This is an advanced feature which is most useful for debugging one or two
651 of Tor's subsystems at a time. +
653 The currently recognized domains are: general, crypto, net, config, fs,
654 protocol, mm, http, app, control, circ, rend, bug, dir, dirserv, or, edge,
655 acct, hist, handshake, heartbeat, channel, sched, guard, consdiff, and dos.
656 Domain names are case-insensitive. +
658 For example, "`Log [handshake]debug [~net,~mm]info notice stdout`" sends
659 to stdout: all handshake messages of any severity, all info-and-higher
660 messages from domains other than networking and memory management, and all
661 messages of severity notice or higher.
663 [[LogMessageDomains]] **LogMessageDomains** **0**|**1**::
664 If 1, Tor includes message domains with each log message. Every log
665 message currently has at least one domain; most currently have exactly
666 one. This doesn't affect controller log messages. (Default: 0)
668 [[MaxUnparseableDescSizeToLog]] **MaxUnparseableDescSizeToLog** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**::
669 Unparseable descriptors (e.g. for votes, consensuses, routers) are logged
670 in separate files by hash, up to the specified size in total. Note that
671 only files logged during the lifetime of this Tor process count toward the
672 total; this is intended to be used to debug problems without opening live
673 servers to resource exhaustion attacks. (Default: 10 MB)
675 [[OutboundBindAddress]] **OutboundBindAddress** __IP__::
676 Make all outbound connections originate from the IP address specified. This
677 is only useful when you have multiple network interfaces, and you want all
678 of Tor's outgoing connections to use a single one. This option may
679 be used twice, once with an IPv4 address and once with an IPv6 address.
680 IPv6 addresses should be wrapped in square brackets.
681 This setting will be ignored for connections to the loopback addresses
682 (127.0.0.0/8 and ::1), and is not used for DNS requests as well.
684 [[OutboundBindAddressOR]] **OutboundBindAddressOR** __IP__::
685 Make all outbound non-exit (relay and other) connections
686 originate from the IP address specified. This option overrides
687 **OutboundBindAddress** for the same IP version. This option may
688 be used twice, once with an IPv4 address and once with an IPv6
689 address. IPv6 addresses should be wrapped in square brackets.
690 This setting will be ignored for connections to the loopback
691 addresses (127.0.0.0/8 and ::1).
693 [[OutboundBindAddressExit]] **OutboundBindAddressExit** __IP__::
694 Make all outbound exit connections originate from the IP address
695 specified. This option overrides **OutboundBindAddress** for the
696 same IP version. This option may be used twice, once with an IPv4
697 address and once with an IPv6 address.
698 IPv6 addresses should be wrapped in square brackets.
699 This setting will be ignored
700 for connections to the loopback addresses (127.0.0.0/8 and ::1).
702 [[PidFile]] **PidFile** __FILE__::
703 On startup, write our PID to FILE. On clean shutdown, remove
704 FILE. Can not be changed while tor is running.
706 [[ProtocolWarnings]] **ProtocolWarnings** **0**|**1**::
707 If 1, Tor will log with severity \'warn' various cases of other parties not
708 following the Tor specification. Otherwise, they are logged with severity
709 \'info'. (Default: 0)
711 [[RunAsDaemon]] **RunAsDaemon** **0**|**1**::
712 If 1, Tor forks and daemonizes to the background. This option has no effect
713 on Windows; instead you should use the --service command-line option.
714 Can not be changed while tor is running.
717 [[LogTimeGranularity]] **LogTimeGranularity** __NUM__::
718 Set the resolution of timestamps in Tor's logs to NUM milliseconds.
719 NUM must be positive and either a divisor or a multiple of 1 second.
720 Note that this option only controls the granularity written by Tor to
721 a file or console log. Tor does not (for example) "batch up" log
722 messages to affect times logged by a controller, times attached to
723 syslog messages, or the mtime fields on log files. (Default: 1 second)
725 [[TruncateLogFile]] **TruncateLogFile** **0**|**1**::
726 If 1, Tor will overwrite logs at startup and in response to a HUP signal,
727 instead of appending to them. (Default: 0)
729 [[SyslogIdentityTag]] **SyslogIdentityTag** __tag__::
730 When logging to syslog, adds a tag to the syslog identity such that
731 log entries are marked with "Tor-__tag__". Can not be changed while tor is
732 running. (Default: none)
734 [[AndroidIdentityTag]] **AndroidIdentityTag** __tag__::
735 When logging to Android's logging subsystem, adds a tag to the log identity
736 such that log entries are marked with "Tor-__tag__". Can not be changed while
737 tor is running. (Default: none)
739 [[SafeLogging]] **SafeLogging** **0**|**1**|**relay**::
740 Tor can scrub potentially sensitive strings from log messages (e.g.
741 addresses) by replacing them with the string [scrubbed]. This way logs can
742 still be useful, but they don't leave behind personally identifying
743 information about what sites a user might have visited. +
745 If this option is set to 0, Tor will not perform any scrubbing, if it is
746 set to 1, all potentially sensitive strings are replaced. If it is set to
747 relay, all log messages generated when acting as a relay are sanitized, but
748 all messages generated when acting as a client are not. (Default: 1)
750 [[User]] **User** __Username__::
751 On startup, setuid to this user and setgid to their primary group.
752 Can not be changed while tor is running.
754 [[KeepBindCapabilities]] **KeepBindCapabilities** **0**|**1**|**auto**::
755 On Linux, when we are started as root and we switch our identity using
756 the **User** option, the **KeepBindCapabilities** option tells us whether to
757 try to retain our ability to bind to low ports. If this value is 1, we
758 try to keep the capability; if it is 0 we do not; and if it is **auto**,
759 we keep the capability only if we are configured to listen on a low port.
760 Can not be changed while tor is running.
763 [[HardwareAccel]] **HardwareAccel** **0**|**1**::
764 If non-zero, try to use built-in (static) crypto hardware acceleration when
765 available. Can not be changed while tor is running. (Default: 0)
767 [[AccelName]] **AccelName** __NAME__::
768 When using OpenSSL hardware crypto acceleration attempt to load the dynamic
769 engine of this name. This must be used for any dynamic hardware engine.
770 Names can be verified with the openssl engine command. Can not be changed
771 while tor is running.
773 [[AccelDir]] **AccelDir** __DIR__::
774 Specify this option if using dynamic hardware acceleration and the engine
775 implementation library resides somewhere other than the OpenSSL default.
776 Can not be changed while tor is running.
778 [[AvoidDiskWrites]] **AvoidDiskWrites** **0**|**1**::
779 If non-zero, try to write to disk less frequently than we would otherwise.
780 This is useful when running on flash memory or other media that support
781 only a limited number of writes. (Default: 0)
783 [[CircuitPriorityHalflife]] **CircuitPriorityHalflife** __NUM__::
784 If this value is set, we override the default algorithm for choosing which
785 circuit's cell to deliver or relay next. It is delivered first to the
786 circuit that has the lowest weighted cell count, where cells are weighted
787 exponentially according to this value (in seconds). If the value is -1, it
788 is taken from the consensus if possible else it will fallback to the
789 default value of 30. Minimum: 1, Maximum: 2147483647. This can be defined
790 as a float value. This is an advanced option; you generally shouldn't have
791 to mess with it. (Default: -1)
793 [[CountPrivateBandwidth]] **CountPrivateBandwidth** **0**|**1**::
794 If this option is set, then Tor's rate-limiting applies not only to
795 remote connections, but also to connections to private addresses like
796 127.0.0.1 or 10.0.0.1. This is mostly useful for debugging
797 rate-limiting. (Default: 0)
799 [[ExtendByEd25519ID]] **ExtendByEd25519ID** **0**|**1**|**auto**::
800 If this option is set to 1, we always try to include a relay's Ed25519 ID
801 when telling the proceeding relay in a circuit to extend to it.
802 If this option is set to 0, we never include Ed25519 IDs when extending
803 circuits. If the option is set to "default", we obey a
804 parameter in the consensus document. (Default: auto)
806 [[NoExec]] **NoExec** **0**|**1**::
807 If this option is set to 1, then Tor will never launch another
808 executable, regardless of the settings of PortForwardingHelper,
809 ClientTransportPlugin, or ServerTransportPlugin. Once this
810 option has been set to 1, it cannot be set back to 0 without
811 restarting Tor. (Default: 0)
813 [[Schedulers]] **Schedulers** **KIST**|**KISTLite**|**Vanilla**::
814 Specify the scheduler type that tor should use. The scheduler is
815 responsible for moving data around within a Tor process. This is an ordered
816 list by priority which means that the first value will be tried first and if
817 unavailable, the second one is tried and so on. It is possible to change
818 these values at runtime. This option mostly effects relays, and most
819 operators should leave it set to its default value.
820 (Default: KIST,KISTLite,Vanilla)
822 The possible scheduler types are:
824 **KIST**: Kernel-Informed Socket Transport. Tor will use TCP information
825 from the kernel to make informed decisions regarding how much data to send
826 and when to send it. KIST also handles traffic in batches (see
827 KISTSchedRunInterval) in order to improve traffic prioritization decisions.
828 As implemented, KIST will only work on Linux kernel version 2.6.39 or
831 **KISTLite**: Same as KIST but without kernel support. Tor will use all
832 the same mechanics as with KIST, including the batching, but its decisions
833 regarding how much data to send will not be as good. KISTLite will work on
834 all kernels and operating systems, and the majority of the benefits of KIST
835 are still realized with KISTLite.
837 **Vanilla**: The scheduler that Tor used before KIST was implemented. It
838 sends as much data as possible, as soon as possible. Vanilla will work on
839 all kernels and operating systems.
841 [[KISTSchedRunInterval]] **KISTSchedRunInterval** __NUM__ **msec**::
842 If KIST or KISTLite is used in the Schedulers option, this controls at which
843 interval the scheduler tick is. If the value is 0 msec, the value is taken
844 from the consensus if possible else it will fallback to the default 10
845 msec. Maximum possible value is 100 msec. (Default: 0 msec)
847 [[KISTSockBufSizeFactor]] **KISTSockBufSizeFactor** __NUM__::
848 If KIST is used in Schedulers, this is a multiplier of the per-socket
849 limit calculation of the KIST algorithm. (Default: 1.0)
854 The following options are useful only for clients (that is, if
855 **SocksPort**, **HTTPTunnelPort**, **TransPort**, **DNSPort**, or
856 **NATDPort** is non-zero):
858 [[Bridge]] **Bridge** [__transport__] __IP__:__ORPort__ [__fingerprint__]::
859 When set along with UseBridges, instructs Tor to use the relay at
860 "IP:ORPort" as a "bridge" relaying into the Tor network. If "fingerprint"
861 is provided (using the same format as for DirAuthority), we will verify that
862 the relay running at that location has the right fingerprint. We also use
863 fingerprint to look up the bridge descriptor at the bridge authority, if
864 it's provided and if UpdateBridgesFromAuthority is set too. +
866 If "transport" is provided, it must match a ClientTransportPlugin line. We
867 then use that pluggable transport's proxy to transfer data to the bridge,
868 rather than connecting to the bridge directly. Some transports use a
869 transport-specific method to work out the remote address to connect to.
870 These transports typically ignore the "IP:ORPort" specified in the bridge
873 Tor passes any "key=val" settings to the pluggable transport proxy as
874 per-connection arguments when connecting to the bridge. Consult
875 the documentation of the pluggable transport for details of what
876 arguments it supports.
878 [[LearnCircuitBuildTimeout]] **LearnCircuitBuildTimeout** **0**|**1**::
879 If 0, CircuitBuildTimeout adaptive learning is disabled. (Default: 1)
881 [[CircuitBuildTimeout]] **CircuitBuildTimeout** __NUM__::
883 Try for at most NUM seconds when building circuits. If the circuit isn't
884 open in that time, give up on it. If LearnCircuitBuildTimeout is 1, this
885 value serves as the initial value to use before a timeout is learned. If
886 LearnCircuitBuildTimeout is 0, this value is the only value used.
887 (Default: 60 seconds)
889 [[CircuitsAvailableTimeout]] **CircuitsAvailableTimeout** __NUM__::
890 Tor will attempt to keep at least one open, unused circuit available for
891 this amount of time. This option governs how long idle circuits are kept
892 open, as well as the amount of time Tor will keep a circuit open to each
893 of the recently used ports. This way when the Tor client is entirely
894 idle, it can expire all of its circuits, and then expire its TLS
895 connections. Note that the actual timeout value is uniformly randomized
896 from the specified value to twice that amount. (Default: 30 minutes;
899 [[CircuitStreamTimeout]] **CircuitStreamTimeout** __NUM__::
900 If non-zero, this option overrides our internal timeout schedule for how
901 many seconds until we detach a stream from a circuit and try a new circuit.
902 If your network is particularly slow, you might want to set this to a
903 number like 60. (Default: 0)
905 [[ClientOnly]] **ClientOnly** **0**|**1**::
906 If set to 1, Tor will not run as a relay or serve
907 directory requests, even if the ORPort, ExtORPort, or DirPort options are
908 set. (This config option is
909 mostly unnecessary: we added it back when we were considering having
910 Tor clients auto-promote themselves to being relays if they were stable
911 and fast enough. The current behavior is simply that Tor is a client
912 unless ORPort, ExtORPort, or DirPort are configured.) (Default: 0)
914 [[ConnectionPadding]] **ConnectionPadding** **0**|**1**|**auto**::
915 This option governs Tor's use of padding to defend against some forms of
916 traffic analysis. If it is set to 'auto', Tor will send padding only
917 if both the client and the relay support it. If it is set to 0, Tor will
918 not send any padding cells. If it is set to 1, Tor will still send padding
919 for client connections regardless of relay support. Only clients may set
920 this option. This option should be offered via the UI to mobile users
921 for use where bandwidth may be expensive.
924 [[ReducedConnectionPadding]] **ReducedConnectionPadding** **0**|**1**::
925 If set to 1, Tor will not not hold OR connections open for very long,
926 and will send less padding on these connections. Only clients may set
927 this option. This option should be offered via the UI to mobile users
928 for use where bandwidth may be expensive. (Default: 0)
930 [[ExcludeNodes]] **ExcludeNodes** __node__,__node__,__...__::
931 A list of identity fingerprints, country codes, and address
932 patterns of nodes to avoid when building a circuit. Country codes are
933 2-letter ISO3166 codes, and must
934 be wrapped in braces; fingerprints may be preceded by a dollar sign.
936 ExcludeNodes ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
938 By default, this option is treated as a preference that Tor is allowed
939 to override in order to keep working.
940 For example, if you try to connect to a hidden service,
941 but you have excluded all of the hidden service's introduction points,
942 Tor will connect to one of them anyway. If you do not want this
943 behavior, set the StrictNodes option (documented below). +
945 Note also that if you are a relay, this (and the other node selection
946 options below) only affects your own circuits that Tor builds for you.
947 Clients can still build circuits through you to any node. Controllers
948 can tell Tor to build circuits through any node. +
950 Country codes are case-insensitive. The code "\{??}" refers to nodes whose
951 country can't be identified. No country code, including \{??}, works if
952 no GeoIPFile can be loaded. See also the GeoIPExcludeUnknown option below.
955 [[ExcludeExitNodes]] **ExcludeExitNodes** __node__,__node__,__...__::
956 A list of identity fingerprints, country codes, and address
957 patterns of nodes to never use when picking an exit node---that is, a
958 node that delivers traffic for you *outside* the Tor network. Note that any
959 node listed in ExcludeNodes is automatically considered to be part of this
961 the **ExcludeNodes** option for more information on how to specify
962 nodes. See also the caveats on the "ExitNodes" option below.
964 [[GeoIPExcludeUnknown]] **GeoIPExcludeUnknown** **0**|**1**|**auto**::
965 If this option is set to 'auto', then whenever any country code is set in
966 ExcludeNodes or ExcludeExitNodes, all nodes with unknown country (\{??} and
967 possibly \{A1}) are treated as excluded as well. If this option is set to
968 '1', then all unknown countries are treated as excluded in ExcludeNodes
969 and ExcludeExitNodes. This option has no effect when a GeoIP file isn't
970 configured or can't be found. (Default: auto)
972 [[ExitNodes]] **ExitNodes** __node__,__node__,__...__::
973 A list of identity fingerprints, country codes, and address
974 patterns of nodes to use as exit node---that is, a
975 node that delivers traffic for you *outside* the Tor network. See
976 the **ExcludeNodes** option for more information on how to specify nodes. +
978 Note that if you list too few nodes here, or if you exclude too many exit
979 nodes with ExcludeExitNodes, you can degrade functionality. For example,
980 if none of the exits you list allows traffic on port 80 or 443, you won't
981 be able to browse the web. +
983 Note also that not every circuit is used to deliver traffic *outside* of
984 the Tor network. It is normal to see non-exit circuits (such as those
985 used to connect to hidden services, those that do directory fetches,
986 those used for relay reachability self-tests, and so on) that end
987 at a non-exit node. To
988 keep a node from being used entirely, see ExcludeNodes and StrictNodes. +
990 The ExcludeNodes option overrides this option: any node listed in both
991 ExitNodes and ExcludeNodes is treated as excluded. +
993 The .exit address notation, if enabled via MapAddress, overrides
996 [[EntryNodes]] **EntryNodes** __node__,__node__,__...__::
997 A list of identity fingerprints and country codes of nodes
998 to use for the first hop in your normal circuits.
999 Normal circuits include all
1000 circuits except for direct connections to directory servers. The Bridge
1001 option overrides this option; if you have configured bridges and
1002 UseBridges is 1, the Bridges are used as your entry nodes. +
1004 The ExcludeNodes option overrides this option: any node listed in both
1005 EntryNodes and ExcludeNodes is treated as excluded. See
1006 the **ExcludeNodes** option for more information on how to specify nodes.
1008 [[StrictNodes]] **StrictNodes** **0**|**1**::
1009 If StrictNodes is set to 1, Tor will treat solely the ExcludeNodes option
1010 as a requirement to follow for all the circuits you generate, even if
1011 doing so will break functionality for you (StrictNodes applies to neither
1012 ExcludeExitNodes nor to ExitNodes). If StrictNodes is set to 0, Tor will
1013 still try to avoid nodes in the ExcludeNodes list, but it will err on the
1014 side of avoiding unexpected errors. Specifically, StrictNodes 0 tells Tor
1015 that it is okay to use an excluded node when it is *necessary* to perform
1016 relay reachability self-tests, connect to a hidden service, provide a
1017 hidden service to a client, fulfill a .exit request, upload directory
1018 information, or download directory information. (Default: 0)
1020 [[FascistFirewall]] **FascistFirewall** **0**|**1**::
1021 If 1, Tor will only create outgoing connections to ORs running on ports
1022 that your firewall allows (defaults to 80 and 443; see **FirewallPorts**).
1023 This will allow you to run Tor as a client behind a firewall with
1024 restrictive policies, but will not allow you to run as a server behind such
1025 a firewall. If you prefer more fine-grained control, use
1026 ReachableAddresses instead.
1028 [[FirewallPorts]] **FirewallPorts** __PORTS__::
1029 A list of ports that your firewall allows you to connect to. Only used when
1030 **FascistFirewall** is set. This option is deprecated; use ReachableAddresses
1031 instead. (Default: 80, 443)
1033 [[ReachableAddresses]] **ReachableAddresses** __IP__[/__MASK__][:__PORT__]...::
1034 A comma-separated list of IP addresses and ports that your firewall allows
1035 you to connect to. The format is as for the addresses in ExitPolicy, except
1036 that "accept" is understood unless "reject" is explicitly provided. For
1037 example, \'ReachableAddresses 99.0.0.0/8, reject 18.0.0.0/8:80, accept
1038 \*:80' means that your firewall allows connections to everything inside net
1039 99, rejects port 80 connections to net 18, and accepts connections to port
1040 80 otherwise. (Default: \'accept \*:*'.)
1042 [[ReachableDirAddresses]] **ReachableDirAddresses** __IP__[/__MASK__][:__PORT__]...::
1043 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
1044 these restrictions when fetching directory information, using standard HTTP
1045 GET requests. If not set explicitly then the value of
1046 **ReachableAddresses** is used. If **HTTPProxy** is set then these
1047 connections will go through that proxy. (DEPRECATED: This option has
1048 had no effect for some time.)
1050 [[ReachableORAddresses]] **ReachableORAddresses** __IP__[/__MASK__][:__PORT__]...::
1051 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
1052 these restrictions when connecting to Onion Routers, using TLS/SSL. If not
1053 set explicitly then the value of **ReachableAddresses** is used. If
1054 **HTTPSProxy** is set then these connections will go through that proxy. +
1056 The separation between **ReachableORAddresses** and
1057 **ReachableDirAddresses** is only interesting when you are connecting
1058 through proxies (see **HTTPProxy** and **HTTPSProxy**). Most proxies limit
1059 TLS connections (which Tor uses to connect to Onion Routers) to port 443,
1060 and some limit HTTP GET requests (which Tor uses for fetching directory
1061 information) to port 80.
1063 [[HidServAuth]] **HidServAuth** __onion-address__ __auth-cookie__ [__service-name__]::
1064 Client authorization for a hidden service. Valid onion addresses contain 16
1065 characters in a-z2-7 plus ".onion", and valid auth cookies contain 22
1066 characters in A-Za-z0-9+/. The service name is only used for internal
1067 purposes, e.g., for Tor controllers. This option may be used multiple times
1068 for different hidden services. If a hidden service uses authorization and
1069 this option is not set, the hidden service is not accessible. Hidden
1070 services can be configured to require authorization using the
1071 **HiddenServiceAuthorizeClient** option.
1073 [[LongLivedPorts]] **LongLivedPorts** __PORTS__::
1074 A list of ports for services that tend to have long-running connections
1075 (e.g. chat and interactive shells). Circuits for streams that use these
1076 ports will contain only high-uptime nodes, to reduce the chance that a node
1077 will go down before the stream is finished. Note that the list is also
1078 honored for circuits (both client and service side) involving hidden
1079 services whose virtual port is in this list. (Default: 21, 22, 706,
1080 1863, 5050, 5190, 5222, 5223, 6523, 6667, 6697, 8300)
1082 [[MapAddress]] **MapAddress** __address__ __newaddress__::
1083 When a request for address arrives to Tor, it will transform to newaddress
1084 before processing it. For example, if you always want connections to
1085 www.example.com to exit via __torserver__ (where __torserver__ is the
1086 fingerprint of the server), use "MapAddress www.example.com
1087 www.example.com.torserver.exit". If the value is prefixed with a
1088 "\*.", matches an entire domain. For example, if you
1089 always want connections to example.com and any if its subdomains
1091 __torserver__ (where __torserver__ is the fingerprint of the server), use
1092 "MapAddress \*.example.com \*.example.com.torserver.exit". (Note the
1093 leading "*." in each part of the directive.) You can also redirect all
1094 subdomains of a domain to a single address. For example, "MapAddress
1095 *.example.com www.example.com". +
1099 1. When evaluating MapAddress expressions Tor stops when it hits the most
1100 recently added expression that matches the requested address. So if you
1101 have the following in your torrc, www.torproject.org will map to 1.1.1.1:
1103 MapAddress www.torproject.org 2.2.2.2
1104 MapAddress www.torproject.org 1.1.1.1
1106 2. Tor evaluates the MapAddress configuration until it finds no matches. So
1107 if you have the following in your torrc, www.torproject.org will map to
1110 MapAddress 1.1.1.1 2.2.2.2
1111 MapAddress www.torproject.org 1.1.1.1
1113 3. The following MapAddress expression is invalid (and will be
1114 ignored) because you cannot map from a specific address to a wildcard
1117 MapAddress www.torproject.org *.torproject.org.torserver.exit
1119 4. Using a wildcard to match only part of a string (as in *ample.com) is
1122 [[NewCircuitPeriod]] **NewCircuitPeriod** __NUM__::
1123 Every NUM seconds consider whether to build a new circuit. (Default: 30
1126 [[MaxCircuitDirtiness]] **MaxCircuitDirtiness** __NUM__::
1127 Feel free to reuse a circuit that was first used at most NUM seconds ago,
1128 but never attach a new stream to a circuit that is too old. For hidden
1129 services, this applies to the __last__ time a circuit was used, not the
1130 first. Circuits with streams constructed with SOCKS authentication via
1131 SocksPorts that have **KeepAliveIsolateSOCKSAuth** also remain alive
1132 for MaxCircuitDirtiness seconds after carrying the last such stream.
1133 (Default: 10 minutes)
1135 [[MaxClientCircuitsPending]] **MaxClientCircuitsPending** __NUM__::
1136 Do not allow more than NUM circuits to be pending at a time for handling
1137 client streams. A circuit is pending if we have begun constructing it,
1138 but it has not yet been completely constructed. (Default: 32)
1140 [[NodeFamily]] **NodeFamily** __node__,__node__,__...__::
1141 The Tor servers, defined by their identity fingerprints,
1142 constitute a "family" of similar or co-administered servers, so never use
1143 any two of them in the same circuit. Defining a NodeFamily is only needed
1144 when a server doesn't list the family itself (with MyFamily). This option
1145 can be used multiple times; each instance defines a separate family. In
1146 addition to nodes, you can also list IP address and ranges and country
1147 codes in {curly braces}. See the **ExcludeNodes** option for more
1148 information on how to specify nodes.
1150 [[EnforceDistinctSubnets]] **EnforceDistinctSubnets** **0**|**1**::
1151 If 1, Tor will not put two servers whose IP addresses are "too close" on
1152 the same circuit. Currently, two addresses are "too close" if they lie in
1153 the same /16 range. (Default: 1)
1155 [[SocksPort]] **SocksPort** \['address':]__port__|**unix:**__path__|**auto** [_flags_] [_isolation flags_]::
1156 Open this port to listen for connections from SOCKS-speaking
1157 applications. Set this to 0 if you don't want to allow application
1158 connections via SOCKS. Set it to "auto" to have Tor pick a port for
1159 you. This directive can be specified multiple times to bind
1160 to multiple addresses/ports. If a unix domain socket is used, you may
1161 quote the path using standard C escape sequences.
1164 NOTE: Although this option allows you to specify an IP address
1165 other than localhost, you should do so only with extreme caution.
1166 The SOCKS protocol is unencrypted and (as we use it)
1167 unauthenticated, so exposing it in this way could leak your
1168 information to anybody watching your network, and allow anybody
1169 to use your computer as an open proxy. +
1171 The _isolation flags_ arguments give Tor rules for which streams
1172 received on this SocksPort are allowed to share circuits with one
1173 another. Recognized isolation flags are:
1174 **IsolateClientAddr**;;
1175 Don't share circuits with streams from a different
1176 client address. (On by default and strongly recommended when
1177 supported; you can disable it with **NoIsolateClientAddr**.
1178 Unsupported and force-disabled when using Unix domain sockets.)
1179 **IsolateSOCKSAuth**;;
1180 Don't share circuits with streams for which different
1181 SOCKS authentication was provided. (For HTTPTunnelPort
1182 connections, this option looks at the Proxy-Authorization and
1183 X-Tor-Stream-Isolation headers. On by default;
1184 you can disable it with **NoIsolateSOCKSAuth**.)
1185 **IsolateClientProtocol**;;
1186 Don't share circuits with streams using a different protocol.
1187 (SOCKS 4, SOCKS 5, TransPort connections, NATDPort connections,
1188 and DNSPort requests are all considered to be different protocols.)
1189 **IsolateDestPort**;;
1190 Don't share circuits with streams targeting a different
1192 **IsolateDestAddr**;;
1193 Don't share circuits with streams targeting a different
1194 destination address.
1195 **KeepAliveIsolateSOCKSAuth**;;
1196 If **IsolateSOCKSAuth** is enabled, keep alive circuits while they have
1197 at least one stream with SOCKS authentication active. After such a circuit
1198 is idle for more than MaxCircuitDirtiness seconds, it can be closed.
1199 **SessionGroup=**__INT__;;
1200 If no other isolation rules would prevent it, allow streams
1201 on this port to share circuits with streams from every other
1202 port with the same session group. (By default, streams received
1203 on different SocksPorts, TransPorts, etc are always isolated from one
1204 another. This option overrides that behavior.)
1206 [[OtherSocksPortFlags]]::
1207 Other recognized __flags__ for a SocksPort are:
1209 Tell exits to not connect to IPv4 addresses in response to SOCKS
1210 requests on this connection.
1212 Tell exits to allow IPv6 addresses in response to SOCKS requests on
1213 this connection, so long as SOCKS5 is in use. (SOCKS4 can't handle
1216 Tells exits that, if a host has both an IPv4 and an IPv6 address,
1217 we would prefer to connect to it via IPv6. (IPv4 is the default.)
1219 Do not ask exits to resolve DNS addresses in SOCKS5 requests. Tor will
1220 connect to IPv4 addresses, IPv6 addresses (if IPv6Traffic is set) and
1222 **NoOnionTraffic**;;
1223 Do not connect to .onion addresses in SOCKS5 requests.
1224 **OnionTrafficOnly**;;
1225 Tell the tor client to only connect to .onion addresses in response to
1226 SOCKS5 requests on this connection. This is equivalent to NoDNSRequest,
1227 NoIPv4Traffic, NoIPv6Traffic. The corresponding NoOnionTrafficOnly
1228 flag is not supported.
1230 Tells the client to remember IPv4 DNS answers we receive from exit
1231 nodes via this connection. (On by default.)
1233 Tells the client to remember IPv6 DNS answers we receive from exit
1234 nodes via this connection.
1236 Unix domain sockets only: makes the socket get created as
1239 Unix domain sockets only: makes the socket get created as
1242 Tells the client to remember all DNS answers we receive from exit
1243 nodes via this connection.
1245 Tells the client to use any cached IPv4 DNS answers we have when making
1246 requests via this connection. (NOTE: This option, or UseIPv6Cache
1247 or UseDNSCache, can harm your anonymity, and probably
1248 won't help performance as much as you might expect. Use with care!)
1250 Tells the client to use any cached IPv6 DNS answers we have when making
1251 requests via this connection.
1253 Tells the client to use any cached DNS answers we have when making
1254 requests via this connection.
1255 **PreferIPv6Automap**;;
1256 When serving a hostname lookup request on this port that
1257 should get automapped (according to AutomapHostsOnResolve),
1258 if we could return either an IPv4 or an IPv6 answer, prefer
1259 an IPv6 answer. (On by default.)
1260 **PreferSOCKSNoAuth**;;
1261 Ordinarily, when an application offers both "username/password
1262 authentication" and "no authentication" to Tor via SOCKS5, Tor
1263 selects username/password authentication so that IsolateSOCKSAuth can
1264 work. This can confuse some applications, if they offer a
1265 username/password combination then get confused when asked for
1266 one. You can disable this behavior, so that Tor will select "No
1267 authentication" when IsolateSOCKSAuth is disabled, or when this
1270 [[SocksPortFlagsMisc]]::
1271 Flags are processed left to right. If flags conflict, the last flag on the
1272 line is used, and all earlier flags are ignored. No error is issued for
1275 [[SocksPolicy]] **SocksPolicy** __policy__,__policy__,__...__::
1276 Set an entrance policy for this server, to limit who can connect to the
1277 SocksPort and DNSPort ports. The policies have the same form as exit
1278 policies below, except that port specifiers are ignored. Any address
1279 not matched by some entry in the policy is accepted.
1281 [[SocksTimeout]] **SocksTimeout** __NUM__::
1282 Let a socks connection wait NUM seconds handshaking, and NUM seconds
1283 unattached waiting for an appropriate circuit, before we fail it. (Default:
1286 [[TokenBucketRefillInterval]] **TokenBucketRefillInterval** __NUM__ [**msec**|**second**]::
1287 Set the refill interval of Tor's token bucket to NUM milliseconds.
1288 NUM must be between 1 and 1000, inclusive. Note that the configured
1289 bandwidth limits are still expressed in bytes per second: this
1290 option only affects the frequency with which Tor checks to see whether
1291 previously exhausted connections may read again.
1292 Can not be changed while tor is running. (Default: 100 msec)
1294 [[TrackHostExits]] **TrackHostExits** __host__,__.domain__,__...__::
1295 For each value in the comma separated list, Tor will track recent
1296 connections to hosts that match this value and attempt to reuse the same
1297 exit node for each. If the value is prepended with a \'.\', it is treated as
1298 matching an entire domain. If one of the values is just a \'.', it means
1299 match everything. This option is useful if you frequently connect to sites
1300 that will expire all your authentication cookies (i.e. log you out) if
1301 your IP address changes. Note that this option does have the disadvantage
1302 of making it more clear that a given history is associated with a single
1303 user. However, most people who would wish to observe this will observe it
1304 through cookies or other protocol-specific means anyhow.
1306 [[TrackHostExitsExpire]] **TrackHostExitsExpire** __NUM__::
1307 Since exit servers go up and down, it is desirable to expire the
1308 association between host and exit server after NUM seconds. The default is
1309 1800 seconds (30 minutes).
1311 [[UpdateBridgesFromAuthority]] **UpdateBridgesFromAuthority** **0**|**1**::
1312 When set (along with UseBridges), Tor will try to fetch bridge descriptors
1313 from the configured bridge authorities when feasible. It will fall back to
1314 a direct request if the authority responds with a 404. (Default: 0)
1316 [[UseBridges]] **UseBridges** **0**|**1**::
1317 When set, Tor will fetch descriptors for each bridge listed in the "Bridge"
1318 config lines, and use these relays as both entry guards and directory
1319 guards. (Default: 0)
1321 [[UseEntryGuards]] **UseEntryGuards** **0**|**1**::
1322 If this option is set to 1, we pick a few long-term entry servers, and try
1323 to stick with them. This is desirable because constantly changing servers
1324 increases the odds that an adversary who owns some servers will observe a
1325 fraction of your paths. Entry Guards can not be used by Directory
1326 Authorities, Single Onion Services, and Tor2web clients. In these cases,
1327 the this option is ignored. (Default: 1)
1329 [[GuardfractionFile]] **GuardfractionFile** __FILENAME__::
1330 V3 authoritative directories only. Configures the location of the
1331 guardfraction file which contains information about how long relays
1332 have been guards. (Default: unset)
1334 [[UseGuardFraction]] **UseGuardFraction** **0**|**1**|**auto**::
1335 This torrc option specifies whether clients should use the
1336 guardfraction information found in the consensus during path
1337 selection. If it's set to 'auto', clients will do what the
1338 UseGuardFraction consensus parameter tells them to do. (Default: auto)
1340 [[NumEntryGuards]] **NumEntryGuards** __NUM__::
1341 If UseEntryGuards is set to 1, we will try to pick a total of NUM routers
1342 as long-term entries for our circuits. If NUM is 0, we try to learn the
1343 number from the guard-n-primary-guards-to-use consensus parameter, and
1344 default to 1 if the consensus parameter isn't set. (Default: 0)
1346 [[NumDirectoryGuards]] **NumDirectoryGuards** __NUM__::
1347 If UseEntryGuards is set to 1, we try to make sure we have at least NUM
1348 routers to use as directory guards. If this option is set to 0, use the
1349 value from the guard-n-primary-dir-guards-to-use consensus parameter, and
1350 default to 3 if the consensus parameter isn't set. (Default: 0)
1352 [[GuardLifetime]] **GuardLifetime** __N__ **days**|**weeks**|**months**::
1353 If nonzero, and UseEntryGuards is set, minimum time to keep a guard before
1354 picking a new one. If zero, we use the GuardLifetime parameter from the
1355 consensus directory. No value here may be less than 1 month or greater
1356 than 5 years; out-of-range values are clamped. (Default: 0)
1358 [[SafeSocks]] **SafeSocks** **0**|**1**::
1359 When this option is enabled, Tor will reject application connections that
1360 use unsafe variants of the socks protocol -- ones that only provide an IP
1361 address, meaning the application is doing a DNS resolve first.
1362 Specifically, these are socks4 and socks5 when not doing remote DNS.
1365 [[TestSocks]] **TestSocks** **0**|**1**::
1366 When this option is enabled, Tor will make a notice-level log entry for
1367 each connection to the Socks port indicating whether the request used a
1368 safe socks protocol or an unsafe one (see above entry on SafeSocks). This
1369 helps to determine whether an application using Tor is possibly leaking
1370 DNS requests. (Default: 0)
1372 [[VirtualAddrNetworkIPv4]] **VirtualAddrNetworkIPv4** __IPv4Address__/__bits__ +
1374 [[VirtualAddrNetworkIPv6]] **VirtualAddrNetworkIPv6** [__IPv6Address__]/__bits__::
1375 When Tor needs to assign a virtual (unused) address because of a MAPADDRESS
1376 command from the controller or the AutomapHostsOnResolve feature, Tor
1377 picks an unassigned address from this range. (Defaults:
1378 127.192.0.0/10 and [FE80::]/10 respectively.) +
1380 When providing proxy server service to a network of computers using a tool
1381 like dns-proxy-tor, change the IPv4 network to "10.192.0.0/10" or
1382 "172.16.0.0/12" and change the IPv6 network to "[FC00::]/7".
1383 The default **VirtualAddrNetwork** address ranges on a
1384 properly configured machine will route to the loopback or link-local
1385 interface. The maximum number of bits for the network prefix is set to 104
1386 for IPv6 and 16 for IPv4. However, a wider network - smaller prefix length
1387 - is preferable since it reduces the chances for an attacker to guess the
1388 used IP. For local use, no change to the default VirtualAddrNetwork setting
1391 [[AllowNonRFC953Hostnames]] **AllowNonRFC953Hostnames** **0**|**1**::
1392 When this option is disabled, Tor blocks hostnames containing illegal
1393 characters (like @ and :) rather than sending them to an exit node to be
1394 resolved. This helps trap accidental attempts to resolve URLs and so on.
1397 [[HTTPTunnelPort]] **HTTPTunnelPort** \['address':]__port__|**auto** [_isolation flags_]::
1398 Open this port to listen for proxy connections using the "HTTP CONNECT"
1399 protocol instead of SOCKS. Set this to
1400 0 if you don't want to allow "HTTP CONNECT" connections. Set the port
1401 to "auto" to have Tor pick a port for you. This directive can be
1402 specified multiple times to bind to multiple addresses/ports. See
1403 SOCKSPort for an explanation of isolation flags. (Default: 0)
1405 [[TransPort]] **TransPort** \['address':]__port__|**auto** [_isolation flags_]::
1406 Open this port to listen for transparent proxy connections. Set this to
1407 0 if you don't want to allow transparent proxy connections. Set the port
1408 to "auto" to have Tor pick a port for you. This directive can be
1409 specified multiple times to bind to multiple addresses/ports. See
1410 SOCKSPort for an explanation of isolation flags. +
1412 TransPort requires OS support for transparent proxies, such as BSDs' pf or
1413 Linux's IPTables. If you're planning to use Tor as a transparent proxy for
1414 a network, you'll want to examine and change VirtualAddrNetwork from the
1415 default setting. (Default: 0)
1417 [[TransProxyType]] **TransProxyType** **default**|**TPROXY**|**ipfw**|**pf-divert**::
1418 TransProxyType may only be enabled when there is transparent proxy listener
1421 Set this to "TPROXY" if you wish to be able to use the TPROXY Linux module
1422 to transparently proxy connections that are configured using the TransPort
1423 option. Detailed information on how to configure the TPROXY
1424 feature can be found in the Linux kernel source tree in the file
1425 Documentation/networking/tproxy.txt. +
1427 Set this option to "ipfw" to use the FreeBSD ipfw interface. +
1429 On *BSD operating systems when using pf, set this to "pf-divert" to take
1430 advantage of +divert-to+ rules, which do not modify the packets like
1431 +rdr-to+ rules do. Detailed information on how to configure pf to use
1432 +divert-to+ rules can be found in the pf.conf(5) manual page. On OpenBSD,
1433 +divert-to+ is available to use on versions greater than or equal to
1436 Set this to "default", or leave it unconfigured, to use regular IPTables
1437 on Linux, or to use pf +rdr-to+ rules on *BSD systems. +
1439 (Default: "default")
1441 [[NATDPort]] **NATDPort** \['address':]__port__|**auto** [_isolation flags_]::
1442 Open this port to listen for connections from old versions of ipfw (as
1443 included in old versions of FreeBSD, etc) using the NATD protocol.
1444 Use 0 if you don't want to allow NATD connections. Set the port
1445 to "auto" to have Tor pick a port for you. This directive can be
1446 specified multiple times to bind to multiple addresses/ports. See
1447 SocksPort for an explanation of isolation flags. +
1449 This option is only for people who cannot use TransPort. (Default: 0)
1451 [[AutomapHostsOnResolve]] **AutomapHostsOnResolve** **0**|**1**::
1452 When this option is enabled, and we get a request to resolve an address
1453 that ends with one of the suffixes in **AutomapHostsSuffixes**, we map an
1454 unused virtual address to that address, and return the new virtual address.
1455 This is handy for making ".onion" addresses work with applications that
1456 resolve an address and then connect to it. (Default: 0)
1458 [[AutomapHostsSuffixes]] **AutomapHostsSuffixes** __SUFFIX__,__SUFFIX__,__...__::
1459 A comma-separated list of suffixes to use with **AutomapHostsOnResolve**.
1460 The "." suffix is equivalent to "all addresses." (Default: .exit,.onion).
1462 [[DNSPort]] **DNSPort** \['address':]__port__|**auto** [_isolation flags_]::
1463 If non-zero, open this port to listen for UDP DNS requests, and resolve
1464 them anonymously. This port only handles A, AAAA, and PTR requests---it
1465 doesn't handle arbitrary DNS request types. Set the port to "auto" to
1466 have Tor pick a port for
1467 you. This directive can be specified multiple times to bind to multiple
1468 addresses/ports. See SocksPort for an explanation of isolation
1471 [[ClientDNSRejectInternalAddresses]] **ClientDNSRejectInternalAddresses** **0**|**1**::
1472 If true, Tor does not believe any anonymously retrieved DNS answer that
1473 tells it that an address resolves to an internal address (like 127.0.0.1 or
1474 192.168.0.1). This option prevents certain browser-based attacks; it
1475 is not allowed to be set on the default network. (Default: 1)
1477 [[ClientRejectInternalAddresses]] **ClientRejectInternalAddresses** **0**|**1**::
1478 If true, Tor does not try to fulfill requests to connect to an internal
1479 address (like 127.0.0.1 or 192.168.0.1) __unless an exit node is
1480 specifically requested__ (for example, via a .exit hostname, or a
1481 controller request). If true, multicast DNS hostnames for machines on the
1482 local network (of the form *.local) are also rejected. (Default: 1)
1484 [[DownloadExtraInfo]] **DownloadExtraInfo** **0**|**1**::
1485 If true, Tor downloads and caches "extra-info" documents. These documents
1486 contain information about servers other than the information in their
1487 regular server descriptors. Tor does not use this information for anything
1488 itself; to save bandwidth, leave this option turned off. (Default: 0)
1490 [[WarnPlaintextPorts]] **WarnPlaintextPorts** __port__,__port__,__...__::
1491 Tells Tor to issue a warnings whenever the user tries to make an anonymous
1492 connection to one of these ports. This option is designed to alert users
1493 to services that risk sending passwords in the clear. (Default:
1496 [[RejectPlaintextPorts]] **RejectPlaintextPorts** __port__,__port__,__...__::
1497 Like WarnPlaintextPorts, but instead of warning about risky port uses, Tor
1498 will instead refuse to make the connection. (Default: None)
1500 [[OptimisticData]] **OptimisticData** **0**|**1**|**auto**::
1501 When this option is set, and Tor is using an exit node that supports
1502 the feature, it will try optimistically to send data to the exit node
1503 without waiting for the exit node to report whether the connection
1504 succeeded. This can save a round-trip time for protocols like HTTP
1505 where the client talks first. If OptimisticData is set to **auto**,
1506 Tor will look at the UseOptimisticData parameter in the networkstatus.
1509 [[Tor2webMode]] **Tor2webMode** **0**|**1**::
1510 When this option is set, Tor connects to hidden services
1511 **non-anonymously**. This option also disables client connections to
1512 non-hidden-service hostnames through Tor. It **must only** be used when
1513 running a tor2web Hidden Service web proxy.
1514 To enable this option the compile time flag --enable-tor2web-mode must be
1515 specified. Since Tor2webMode is non-anonymous, you can not run an
1516 anonymous Hidden Service on a tor version compiled with Tor2webMode.
1519 [[Tor2webRendezvousPoints]] **Tor2webRendezvousPoints** __node__,__node__,__...__::
1520 A list of identity fingerprints, nicknames, country codes and
1521 address patterns of nodes that are allowed to be used as RPs
1522 in HS circuits; any other nodes will not be used as RPs.
1524 Tor2webRendezvousPoints Fastyfasty, ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
1526 This feature can only be used if Tor2webMode is also enabled. +
1528 ExcludeNodes have higher priority than Tor2webRendezvousPoints,
1529 which means that nodes specified in ExcludeNodes will not be
1532 If no nodes in Tor2webRendezvousPoints are currently available for
1533 use, Tor will choose a random node when building HS circuits.
1535 [[_HSLayer2Nodes]] **_HSLayer2Nodes** __node__,__node__,__...__::
1536 A list of identity fingerprints, nicknames, country codes, and
1537 address patterns of nodes that are allowed to be used as the
1538 second hop in all client or service-side Onion Service circuits.
1539 This option mitigates attacks where the adversary runs middle nodes
1540 and induces your client or service to create many circuits, in order
1541 to discover your primary guard node.
1542 (Default: Any node in the network may be used in the second hop.)
1545 _HSLayer2Nodes ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
1547 When this is set, the resulting hidden service paths will
1550 C - G - L2 - M - Rend +
1551 C - G - L2 - M - HSDir +
1552 C - G - L2 - M - Intro +
1553 S - G - L2 - M - Rend +
1554 S - G - L2 - M - HSDir +
1555 S - G - L2 - M - Intro +
1557 where C is this client, S is the service, G is the Guard node,
1558 L2 is a node from this option, and M is a random middle node.
1559 Rend, HSDir, and Intro point selection is not affected by this
1562 This option may be combined with _HSLayer3Nodes to create
1565 C - G - L2 - L3 - Rend +
1566 C - G - L2 - L3 - M - HSDir +
1567 C - G - L2 - L3 - M - Intro +
1568 S - G - L2 - L3 - M - Rend +
1569 S - G - L2 - L3 - HSDir +
1570 S - G - L2 - L3 - Intro +
1572 ExcludeNodes have higher priority than _HSLayer2Nodes,
1573 which means that nodes specified in ExcludeNodes will not be
1576 This option is meant to be managed by a Tor controller such as
1577 https://github.com/mikeperry-tor/vanguards that selects and
1578 updates this set of nodes for you. Hence it does not do load
1579 balancing if fewer than 20 nodes are selected, and if no nodes in
1580 _HSLayer2Nodes are currently available for use, Tor will not work.
1581 Please use extreme care if you are setting this option manually.
1583 [[_HSLayer3Nodes]] **_HSLayer3Nodes** __node__,__node__,__...__::
1584 A list of identity fingerprints, nicknames, country codes, and
1585 address patterns of nodes that are allowed to be used as the
1586 third hop in all client and service-side Onion Service circuits.
1587 This option mitigates attacks where the adversary runs middle nodes
1588 and induces your client or service to create many circuits, in order
1589 to discover your primary or Layer2 guard nodes.
1590 (Default: Any node in the network may be used in the third hop.)
1593 _HSLayer3Nodes ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
1595 When this is set by itself, the resulting hidden service paths
1597 C - G - M - L3 - Rend +
1598 C - G - M - L3 - M - HSDir +
1599 C - G - M - L3 - M - Intro +
1600 S - G - M - L3 - M - Rend +
1601 S - G - M - L3 - HSDir +
1602 S - G - M - L3 - Intro +
1603 where C is this client, S is the service, G is the Guard node,
1604 L2 is a node from this option, and M is a random middle node.
1605 Rend, HSDir, and Intro point selection is not affected by this
1608 While it is possible to use this option by itself, it should be
1609 combined with _HSLayer2Nodes to create paths of the form:
1611 C - G - L2 - L3 - Rend +
1612 C - G - L2 - L3 - M - HSDir +
1613 C - G - L2 - L3 - M - Intro +
1614 S - G - L2 - L3 - M - Rend +
1615 S - G - L2 - L3 - HSDir +
1616 S - G - L2 - L3 - Intro +
1618 ExcludeNodes have higher priority than _HSLayer3Nodes,
1619 which means that nodes specified in ExcludeNodes will not be
1622 This option is meant to be managed by a Tor controller such as
1623 https://github.com/mikeperry-tor/vanguards that selects and
1624 updates this set of nodes for you. Hence it does not do load
1625 balancing if fewer than 20 nodes are selected, and if no nodes in
1626 _HSLayer3Nodes are currently available for use, Tor will not work.
1627 Please use extreme care if you are setting this option manually.
1629 [[UseMicrodescriptors]] **UseMicrodescriptors** **0**|**1**|**auto**::
1630 Microdescriptors are a smaller version of the information that Tor needs
1631 in order to build its circuits. Using microdescriptors makes Tor clients
1632 download less directory information, thus saving bandwidth. Directory
1633 caches need to fetch regular descriptors and microdescriptors, so this
1634 option doesn't save any bandwidth for them. If this option is set to
1635 "auto" (recommended) then it is on for all clients that do not set
1636 FetchUselessDescriptors. (Default: auto)
1638 [[PathBiasCircThreshold]] **PathBiasCircThreshold** __NUM__ +
1640 [[PathBiasNoticeRate]] **PathBiasNoticeRate** __NUM__ +
1642 [[PathBiasWarnRate]] **PathBiasWarnRate** __NUM__ +
1644 [[PathBiasExtremeRate]] **PathBiasExtremeRate** __NUM__ +
1646 [[PathBiasDropGuards]] **PathBiasDropGuards** __NUM__ +
1648 [[PathBiasScaleThreshold]] **PathBiasScaleThreshold** __NUM__::
1649 These options override the default behavior of Tor's (**currently
1650 experimental**) path bias detection algorithm. To try to find broken or
1651 misbehaving guard nodes, Tor looks for nodes where more than a certain
1652 fraction of circuits through that guard fail to get built. +
1654 The PathBiasCircThreshold option controls how many circuits we need to build
1655 through a guard before we make these checks. The PathBiasNoticeRate,
1656 PathBiasWarnRate and PathBiasExtremeRate options control what fraction of
1657 circuits must succeed through a guard so we won't write log messages.
1658 If less than PathBiasExtremeRate circuits succeed *and* PathBiasDropGuards
1659 is set to 1, we disable use of that guard. +
1661 When we have seen more than PathBiasScaleThreshold
1662 circuits through a guard, we scale our observations by 0.5 (governed by
1663 the consensus) so that new observations don't get swamped by old ones. +
1665 By default, or if a negative value is provided for one of these options,
1666 Tor uses reasonable defaults from the networkstatus consensus document.
1667 If no defaults are available there, these options default to 150, .70,
1668 .50, .30, 0, and 300 respectively.
1670 [[PathBiasUseThreshold]] **PathBiasUseThreshold** __NUM__ +
1672 [[PathBiasNoticeUseRate]] **PathBiasNoticeUseRate** __NUM__ +
1674 [[PathBiasExtremeUseRate]] **PathBiasExtremeUseRate** __NUM__ +
1676 [[PathBiasScaleUseThreshold]] **PathBiasScaleUseThreshold** __NUM__::
1677 Similar to the above options, these options override the default behavior
1678 of Tor's (**currently experimental**) path use bias detection algorithm. +
1680 Where as the path bias parameters govern thresholds for successfully
1681 building circuits, these four path use bias parameters govern thresholds
1682 only for circuit usage. Circuits which receive no stream usage
1683 are not counted by this detection algorithm. A used circuit is considered
1684 successful if it is capable of carrying streams or otherwise receiving
1685 well-formed responses to RELAY cells. +
1687 By default, or if a negative value is provided for one of these options,
1688 Tor uses reasonable defaults from the networkstatus consensus document.
1689 If no defaults are available there, these options default to 20, .80,
1690 .60, and 100, respectively.
1692 [[ClientUseIPv4]] **ClientUseIPv4** **0**|**1**::
1693 If this option is set to 0, Tor will avoid connecting to directory servers
1694 and entry nodes over IPv4. Note that clients with an IPv4
1695 address in a **Bridge**, proxy, or pluggable transport line will try
1696 connecting over IPv4 even if **ClientUseIPv4** is set to 0. (Default: 1)
1698 [[ClientUseIPv6]] **ClientUseIPv6** **0**|**1**::
1699 If this option is set to 1, Tor might connect to directory servers or
1700 entry nodes over IPv6. Note that clients configured with an IPv6 address
1701 in a **Bridge**, proxy, or pluggable transport line will try connecting
1702 over IPv6 even if **ClientUseIPv6** is set to 0. (Default: 0)
1704 [[ClientPreferIPv6DirPort]] **ClientPreferIPv6DirPort** **0**|**1**|**auto**::
1705 If this option is set to 1, Tor prefers a directory port with an IPv6
1706 address over one with IPv4, for direct connections, if a given directory
1707 server has both. (Tor also prefers an IPv6 DirPort if IPv4Client is set to
1708 0.) If this option is set to auto, clients prefer IPv4. Other things may
1709 influence the choice. This option breaks a tie to the favor of IPv6.
1710 (Default: auto) (DEPRECATED: This option has had no effect for some
1713 [[ClientPreferIPv6ORPort]] **ClientPreferIPv6ORPort** **0**|**1**|**auto**::
1714 If this option is set to 1, Tor prefers an OR port with an IPv6
1715 address over one with IPv4 if a given entry node has both. (Tor also
1716 prefers an IPv6 ORPort if IPv4Client is set to 0.) If this option is set
1717 to auto, Tor bridge clients prefer the configured bridge address, and
1718 other clients prefer IPv4. Other things may influence the choice. This
1719 option breaks a tie to the favor of IPv6. (Default: auto)
1721 [[PathsNeededToBuildCircuits]] **PathsNeededToBuildCircuits** __NUM__::
1722 Tor clients don't build circuits for user traffic until they know
1723 about enough of the network so that they could potentially construct
1724 enough of the possible paths through the network. If this option
1725 is set to a fraction between 0.25 and 0.95, Tor won't build circuits
1726 until it has enough descriptors or microdescriptors to construct
1727 that fraction of possible paths. Note that setting this option too low
1728 can make your Tor client less anonymous, and setting it too high can
1729 prevent your Tor client from bootstrapping. If this option is negative,
1730 Tor will use a default value chosen by the directory authorities. If the
1731 directory authorities do not choose a value, Tor will default to 0.6.
1734 [[ClientBootstrapConsensusAuthorityDownloadSchedule]] **ClientBootstrapConsensusAuthorityDownloadSchedule** __N__,__N__,__...__::
1735 Schedule for when clients should download consensuses from authorities
1736 if they are bootstrapping (that is, they don't have a usable, reasonably
1737 live consensus). Only used by clients fetching from a list of fallback
1738 directory mirrors. This schedule is advanced by (potentially concurrent)
1739 connection attempts, unlike other schedules, which are advanced by
1740 connection failures. (Default: 6, 11, 3600, 10800, 25200, 54000, 111600,
1743 [[ClientBootstrapConsensusFallbackDownloadSchedule]] **ClientBootstrapConsensusFallbackDownloadSchedule** __N__,__N__,__...__::
1744 Schedule for when clients should download consensuses from fallback
1745 directory mirrors if they are bootstrapping (that is, they don't have a
1746 usable, reasonably live consensus). Only used by clients fetching from a
1747 list of fallback directory mirrors. This schedule is advanced by
1748 (potentially concurrent) connection attempts, unlike other schedules,
1749 which are advanced by connection failures. (Default: 0, 1, 4, 11, 3600,
1750 10800, 25200, 54000, 111600, 262800)
1752 [[ClientBootstrapConsensusAuthorityOnlyDownloadSchedule]] **ClientBootstrapConsensusAuthorityOnlyDownloadSchedule** __N__,__N__,__...__::
1753 Schedule for when clients should download consensuses from authorities
1754 if they are bootstrapping (that is, they don't have a usable, reasonably
1755 live consensus). Only used by clients which don't have or won't fetch
1756 from a list of fallback directory mirrors. This schedule is advanced by
1757 (potentially concurrent) connection attempts, unlike other schedules,
1758 which are advanced by connection failures. (Default: 0, 3, 7, 3600,
1759 10800, 25200, 54000, 111600, 262800)
1761 [[ClientBootstrapConsensusMaxInProgressTries]] **ClientBootstrapConsensusMaxInProgressTries** __NUM__::
1762 Try this many simultaneous connections to download a consensus before
1763 waiting for one to complete, timeout, or error out. (Default: 3)
1768 The following options are useful only for servers (that is, if ORPort
1771 [[Address]] **Address** __address__::
1772 The IPv4 address of this server, or a fully qualified domain name of
1773 this server that resolves to an IPv4 address. You can leave this
1774 unset, and Tor will try to guess your IPv4 address. This IPv4
1775 address is the one used to tell clients and other servers where to
1776 find your Tor server; it doesn't affect the address that your server
1777 binds to. To bind to a different address, use the ORPort and
1778 OutboundBindAddress options.
1780 [[AssumeReachable]] **AssumeReachable** **0**|**1**::
1781 This option is used when bootstrapping a new Tor network. If set to 1,
1782 don't do self-reachability testing; just upload your server descriptor
1783 immediately. If **AuthoritativeDirectory** is also set, this option
1784 instructs the dirserver to bypass remote reachability testing too and list
1785 all connected servers as running.
1787 [[BridgeRelay]] **BridgeRelay** **0**|**1**::
1788 Sets the relay to act as a "bridge" with respect to relaying connections
1789 from bridge users to the Tor network. It mainly causes Tor to publish a
1790 server descriptor to the bridge database, rather than
1791 to the public directory authorities.
1793 [[BridgeDistribution]] **BridgeDistribution** __string__::
1794 If set along with BridgeRelay, Tor will include a new line in its
1795 bridge descriptor which indicates to the BridgeDB service how it
1796 would like its bridge address to be given out. Set it to "none" if
1797 you want BridgeDB to avoid distributing your bridge address, or "any" to
1798 let BridgeDB decide. (Default: any)
1800 Note: as of Oct 2017, the BridgeDB part of this option is not yet
1801 implemented. Until BridgeDB is updated to obey this option, your
1802 bridge will make this request, but it will not (yet) be obeyed.
1804 [[ContactInfo]] **ContactInfo** __email_address__::
1805 Administrative contact information for this relay or bridge. This line
1806 can be used to contact you if your relay or bridge is misconfigured or
1807 something else goes wrong. Note that we archive and publish all
1808 descriptors containing these lines and that Google indexes them, so
1809 spammers might also collect them. You may want to obscure the fact
1810 that it's an email address and/or generate a new address for this
1813 ContactInfo **must** be set to a working address if you run more than one
1814 relay or bridge. (Really, everybody running a relay or bridge should set
1818 [[ExitRelay]] **ExitRelay** **0**|**1**|**auto**::
1819 Tells Tor whether to run as an exit relay. If Tor is running as a
1820 non-bridge server, and ExitRelay is set to 1, then Tor allows traffic to
1821 exit according to the ExitPolicy option (or the default ExitPolicy if
1822 none is specified). +
1824 If ExitRelay is set to 0, no traffic is allowed to
1825 exit, and the ExitPolicy option is ignored. +
1827 If ExitRelay is set to "auto", then Tor behaves as if it were set to 1, but
1828 warns the user if this would cause traffic to exit. In a future version,
1829 the default value will be 0. (Default: auto)
1831 [[ExitPolicy]] **ExitPolicy** __policy__,__policy__,__...__::
1832 Set an exit policy for this server. Each policy is of the form
1833 "**accept[6]**|**reject[6]** __ADDR__[/__MASK__][:__PORT__]". If /__MASK__ is
1834 omitted then this policy just applies to the host given. Instead of giving
1835 a host or network you can also use "\*" to denote the universe (0.0.0.0/0
1836 and ::/128), or \*4 to denote all IPv4 addresses, and \*6 to denote all
1838 __PORT__ can be a single port number, an interval of ports
1839 "__FROM_PORT__-__TO_PORT__", or "\*". If __PORT__ is omitted, that means
1842 For example, "accept 18.7.22.69:\*,reject 18.0.0.0/8:\*,accept \*:\*" would
1843 reject any IPv4 traffic destined for MIT except for web.mit.edu, and accept
1844 any other IPv4 or IPv6 traffic. +
1846 Tor also allows IPv6 exit policy entries. For instance, "reject6 [FC00::]/7:\*"
1847 rejects all destinations that share 7 most significant bit prefix with
1848 address FC00::. Respectively, "accept6 [C000::]/3:\*" accepts all destinations
1849 that share 3 most significant bit prefix with address C000::. +
1851 accept6 and reject6 only produce IPv6 exit policy entries. Using an IPv4
1852 address with accept6 or reject6 is ignored and generates a warning.
1853 accept/reject allows either IPv4 or IPv6 addresses. Use \*4 as an IPv4
1854 wildcard address, and \*6 as an IPv6 wildcard address. accept/reject *
1855 expands to matching IPv4 and IPv6 wildcard address rules. +
1857 To specify all IPv4 and IPv6 internal and link-local networks (including
1858 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,
1859 172.16.0.0/12, [::]/8, [FC00::]/7, [FE80::]/10, [FEC0::]/10, [FF00::]/8,
1860 and [::]/127), you can use the "private" alias instead of an address.
1861 ("private" always produces rules for IPv4 and IPv6 addresses, even when
1862 used with accept6/reject6.) +
1864 Private addresses are rejected by default (at the beginning of your exit
1865 policy), along with any configured primary public IPv4 and IPv6 addresses.
1866 These private addresses are rejected unless you set the
1867 ExitPolicyRejectPrivate config option to 0. For example, once you've done
1868 that, you could allow HTTP to 127.0.0.1 and block all other connections to
1869 internal networks with "accept 127.0.0.1:80,reject private:\*", though that
1870 may also allow connections to your own computer that are addressed to its
1871 public (external) IP address. See RFC 1918 and RFC 3330 for more details
1872 about internal and reserved IP address space. See
1873 ExitPolicyRejectLocalInterfaces if you want to block every address on the
1874 relay, even those that aren't advertised in the descriptor. +
1876 This directive can be specified multiple times so you don't have to put it
1879 Policies are considered first to last, and the first match wins. If you
1880 want to allow the same ports on IPv4 and IPv6, write your rules using
1881 accept/reject \*. If you want to allow different ports on IPv4 and IPv6,
1882 write your IPv6 rules using accept6/reject6 \*6, and your IPv4 rules using
1883 accept/reject \*4. If you want to \_replace_ the default exit policy, end
1884 your exit policy with either a reject \*:* or an accept \*:*. Otherwise,
1885 you're \_augmenting_ (prepending to) the default exit policy. +
1887 If you want to use a reduced exit policy rather than the default exit
1888 policy, set "ReducedExitPolicy 1". If you want to _replace_ the default
1889 exit policy with your custom exit policy, end your exit policy with either
1890 a reject *:* or an accept *:*. Otherwise, you're _augmenting_ (prepending
1891 to) the default or reduced exit policy. +
1893 The default exit policy is:
1907 [[ExitPolicyDefault]] **ExitPolicyDefault**::
1908 Since the default exit policy uses accept/reject *, it applies to both
1909 IPv4 and IPv6 addresses.
1911 [[ExitPolicyRejectPrivate]] **ExitPolicyRejectPrivate** **0**|**1**::
1912 Reject all private (local) networks, along with the relay's advertised
1913 public IPv4 and IPv6 addresses, at the beginning of your exit policy.
1914 See above entry on ExitPolicy.
1917 [[ExitPolicyRejectLocalInterfaces]] **ExitPolicyRejectLocalInterfaces** **0**|**1**::
1918 Reject all IPv4 and IPv6 addresses that the relay knows about, at the
1919 beginning of your exit policy. This includes any OutboundBindAddress, the
1920 bind addresses of any port options, such as ControlPort or DNSPort, and any
1921 public IPv4 and IPv6 addresses on any interface on the relay. (If IPv6Exit
1922 is not set, all IPv6 addresses will be rejected anyway.)
1923 See above entry on ExitPolicy.
1924 This option is off by default, because it lists all public relay IP
1925 addresses in the ExitPolicy, even those relay operators might prefer not
1929 [[ReducedExitPolicy]] **ReducedExitPolicy** **0**|**1**::
1930 If set, use a reduced exit policy rather than the default one. +
1932 The reduced exit policy is an alternative to the default exit policy. It
1933 allows as many Internet services as possible while still blocking the
1934 majority of TCP ports. Currently, the policy allows approximately 65 ports.
1935 This reduces the odds that your node will be used for peer-to-peer
1938 The reduced exit policy is:
2022 [[IPv6Exit]] **IPv6Exit** **0**|**1**::
2023 If set, and we are an exit node, allow clients to use us for IPv6
2024 traffic. (Default: 0)
2026 [[MaxOnionQueueDelay]] **MaxOnionQueueDelay** __NUM__ [**msec**|**second**]::
2027 If we have more onionskins queued for processing than we can process in
2028 this amount of time, reject new ones. (Default: 1750 msec)
2030 [[MyFamily]] **MyFamily** __fingerprint__,__fingerprint__,...::
2031 Declare that this Tor relay is controlled or administered by a group or
2032 organization identical or similar to that of the other relays, defined by
2033 their (possibly $-prefixed) identity fingerprints.
2034 This option can be repeated many times, for
2035 convenience in defining large families: all fingerprints in all MyFamily
2036 lines are merged into one list.
2037 When two relays both declare that they are in the
2038 same \'family', Tor clients will not use them in the same circuit. (Each
2039 relay only needs to list the other servers in its family; it doesn't need to
2040 list itself, but it won't hurt if it does.) Do not list any bridge relay as it would
2041 compromise its concealment. +
2043 When listing a node, it's better to list it by fingerprint than by
2044 nickname: fingerprints are more reliable. +
2046 If you run more than one relay, the MyFamily option on each relay
2047 **must** list all other relays, as described above.
2049 [[Nickname]] **Nickname** __name__::
2050 Set the server's nickname to \'name'. Nicknames must be between 1 and 19
2051 characters inclusive, and must contain only the characters [a-zA-Z0-9].
2053 [[NumCPUs]] **NumCPUs** __num__::
2054 How many processes to use at once for decrypting onionskins and other
2055 parallelizable operations. If this is set to 0, Tor will try to detect
2056 how many CPUs you have, defaulting to 1 if it can't tell. (Default: 0)
2058 [[ORPort]] **ORPort** \['address':]__PORT__|**auto** [_flags_]::
2059 Advertise this port to listen for connections from Tor clients and
2060 servers. This option is required to be a Tor server.
2061 Set it to "auto" to have Tor pick a port for you. Set it to 0 to not
2062 run an ORPort at all. This option can occur more than once. (Default: 0) +
2064 Tor recognizes these flags on each ORPort:
2066 By default, we bind to a port and tell our users about it. If
2067 NoAdvertise is specified, we don't advertise, but listen anyway. This
2068 can be useful if the port everybody will be connecting to (for
2069 example, one that's opened on our firewall) is somewhere else.
2071 By default, we bind to a port and tell our users about it. If
2072 NoListen is specified, we don't bind, but advertise anyway. This
2073 can be useful if something else (for example, a firewall's port
2074 forwarding configuration) is causing connections to reach us.
2076 If the address is absent, or resolves to both an IPv4 and an IPv6
2077 address, only listen to the IPv4 address.
2079 If the address is absent, or resolves to both an IPv4 and an IPv6
2080 address, only listen to the IPv6 address.
2082 [[ORPortFlagsExclusive]]::
2083 For obvious reasons, NoAdvertise and NoListen are mutually exclusive, and
2084 IPv4Only and IPv6Only are mutually exclusive.
2086 [[PortForwarding]] **PortForwarding** **0**|**1**::
2087 Attempt to automatically forward the DirPort and ORPort on a NAT router
2088 connecting this Tor server to the Internet. If set, Tor will try both
2089 NAT-PMP (common on Apple routers) and UPnP (common on routers from other
2090 manufacturers). (Default: 0)
2092 [[PortForwardingHelper]] **PortForwardingHelper** __filename__|__pathname__::
2093 If PortForwarding is set, use this executable to configure the forwarding.
2094 If set to a filename, the system path will be searched for the executable.
2095 If set to a path, only the specified path will be executed.
2096 (Default: tor-fw-helper)
2098 [[PublishServerDescriptor]] **PublishServerDescriptor** **0**|**1**|**v3**|**bridge**,**...**::
2099 This option specifies which descriptors Tor will publish when acting as
2101 choose multiple arguments, separated by commas. +
2103 If this option is set to 0, Tor will not publish its
2104 descriptors to any directories. (This is useful if you're testing
2105 out your server, or if you're using a Tor controller that handles
2106 directory publishing for you.) Otherwise, Tor will publish its
2107 descriptors of all type(s) specified. The default is "1", which
2108 means "if running as a relay or bridge, publish descriptors to the
2109 appropriate authorities". Other possibilities are "v3", meaning
2110 "publish as if you're a relay", and "bridge", meaning "publish as
2111 if you're a bridge".
2113 [[ShutdownWaitLength]] **ShutdownWaitLength** __NUM__::
2114 When we get a SIGINT and we're a server, we begin shutting down:
2115 we close listeners and start refusing new circuits. After **NUM**
2116 seconds, we exit. If we get a second SIGINT, we exit immediately.
2117 (Default: 30 seconds)
2119 [[SSLKeyLifetime]] **SSLKeyLifetime** __N__ **minutes**|**hours**|**days**|**weeks**::
2120 When creating a link certificate for our outermost SSL handshake,
2121 set its lifetime to this amount of time. If set to 0, Tor will choose
2122 some reasonable random defaults. (Default: 0)
2124 [[HeartbeatPeriod]] **HeartbeatPeriod** __N__ **minutes**|**hours**|**days**|**weeks**::
2125 Log a heartbeat message every **HeartbeatPeriod** seconds. This is
2126 a log level __notice__ message, designed to let you know your Tor
2127 server is still alive and doing useful things. Settings this
2128 to 0 will disable the heartbeat. Otherwise, it must be at least 30
2129 minutes. (Default: 6 hours)
2131 [[MainloopStats]] **MainloopStats** **0**|**1**::
2132 Log main loop statistics every **HeartbeatPeriod** seconds. This is a log
2133 level __notice__ message designed to help developers instrumenting Tor's
2134 main event loop. (Default: 0)
2136 [[AccountingMax]] **AccountingMax** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
2137 Limits the max number of bytes sent and received within a set time period
2138 using a given calculation rule (see: AccountingStart, AccountingRule).
2139 Useful if you need to stay under a specific bandwidth. By default, the
2140 number used for calculation is the max of either the bytes sent or
2141 received. For example, with AccountingMax set to 1 GByte, a server
2142 could send 900 MBytes and receive 800 MBytes and continue running.
2143 It will only hibernate once one of the two reaches 1 GByte. This can
2144 be changed to use the sum of the both bytes received and sent by setting
2145 the AccountingRule option to "sum" (total bandwidth in/out). When the
2146 number of bytes remaining gets low, Tor will stop accepting new connections
2147 and circuits. When the number of bytes is exhausted, Tor will hibernate
2148 until some time in the next accounting period. To prevent all servers
2149 from waking at the same time, Tor will also wait until a random point
2150 in each period before waking up. If you have bandwidth cost issues,
2151 enabling hibernation is preferable to setting a low bandwidth, since
2152 it provides users with a collection of fast servers that are up some
2153 of the time, which is more useful than a set of slow servers that are
2156 [[AccountingRule]] **AccountingRule** **sum**|**max**|**in**|**out**::
2157 How we determine when our AccountingMax has been reached (when we
2158 should hibernate) during a time interval. Set to "max" to calculate
2159 using the higher of either the sent or received bytes (this is the
2160 default functionality). Set to "sum" to calculate using the sent
2161 plus received bytes. Set to "in" to calculate using only the
2162 received bytes. Set to "out" to calculate using only the sent bytes.
2165 [[AccountingStart]] **AccountingStart** **day**|**week**|**month** [__day__] __HH:MM__::
2166 Specify how long accounting periods last. If **month** is given,
2167 each accounting period runs from the time __HH:MM__ on the __dayth__ day of one
2168 month to the same day and time of the next. The relay will go at full speed,
2169 use all the quota you specify, then hibernate for the rest of the period. (The
2170 day must be between 1 and 28.) If **week** is given, each accounting period
2171 runs from the time __HH:MM__ of the __dayth__ day of one week to the same day
2172 and time of the next week, with Monday as day 1 and Sunday as day 7. If **day**
2173 is given, each accounting period runs from the time __HH:MM__ each day to the
2174 same time on the next day. All times are local, and given in 24-hour time.
2175 (Default: "month 1 0:00")
2177 [[RefuseUnknownExits]] **RefuseUnknownExits** **0**|**1**|**auto**::
2178 Prevent nodes that don't appear in the consensus from exiting using this
2179 relay. If the option is 1, we always block exit attempts from such
2180 nodes; if it's 0, we never do, and if the option is "auto", then we do
2181 whatever the authorities suggest in the consensus (and block if the consensus
2182 is quiet on the issue). (Default: auto)
2184 [[ServerDNSResolvConfFile]] **ServerDNSResolvConfFile** __filename__::
2185 Overrides the default DNS configuration with the configuration in
2186 __filename__. The file format is the same as the standard Unix
2187 "**resolv.conf**" file (7). This option, like all other ServerDNS options,
2188 only affects name lookups that your server does on behalf of clients.
2189 (Defaults to use the system DNS configuration.)
2191 [[ServerDNSAllowBrokenConfig]] **ServerDNSAllowBrokenConfig** **0**|**1**::
2192 If this option is false, Tor exits immediately if there are problems
2193 parsing the system DNS configuration or connecting to nameservers.
2194 Otherwise, Tor continues to periodically retry the system nameservers until
2195 it eventually succeeds. (Default: 1)
2197 [[ServerDNSSearchDomains]] **ServerDNSSearchDomains** **0**|**1**::
2198 If set to 1, then we will search for addresses in the local search domain.
2199 For example, if this system is configured to believe it is in
2200 "example.com", and a client tries to connect to "www", the client will be
2201 connected to "www.example.com". This option only affects name lookups that
2202 your server does on behalf of clients. (Default: 0)
2204 [[ServerDNSDetectHijacking]] **ServerDNSDetectHijacking** **0**|**1**::
2205 When this option is set to 1, we will test periodically to determine
2206 whether our local nameservers have been configured to hijack failing DNS
2207 requests (usually to an advertising site). If they are, we will attempt to
2208 correct this. This option only affects name lookups that your server does
2209 on behalf of clients. (Default: 1)
2211 [[ServerDNSTestAddresses]] **ServerDNSTestAddresses** __hostname__,__hostname__,__...__::
2212 When we're detecting DNS hijacking, make sure that these __valid__ addresses
2213 aren't getting redirected. If they are, then our DNS is completely useless,
2214 and we'll reset our exit policy to "reject \*:*". This option only affects
2215 name lookups that your server does on behalf of clients. (Default:
2216 "www.google.com, www.mit.edu, www.yahoo.com, www.slashdot.org")
2218 [[ServerDNSAllowNonRFC953Hostnames]] **ServerDNSAllowNonRFC953Hostnames** **0**|**1**::
2219 When this option is disabled, Tor does not try to resolve hostnames
2220 containing illegal characters (like @ and :) rather than sending them to an
2221 exit node to be resolved. This helps trap accidental attempts to resolve
2222 URLs and so on. This option only affects name lookups that your server does
2223 on behalf of clients. (Default: 0)
2225 [[BridgeRecordUsageByCountry]] **BridgeRecordUsageByCountry** **0**|**1**::
2226 When this option is enabled and BridgeRelay is also enabled, and we have
2227 GeoIP data, Tor keeps a per-country count of how many client
2228 addresses have contacted it so that it can help the bridge authority guess
2229 which countries have blocked access to it. (Default: 1)
2231 [[ServerDNSRandomizeCase]] **ServerDNSRandomizeCase** **0**|**1**::
2232 When this option is set, Tor sets the case of each character randomly in
2233 outgoing DNS requests, and makes sure that the case matches in DNS replies.
2234 This so-called "0x20 hack" helps resist some types of DNS poisoning attack.
2235 For more information, see "Increased DNS Forgery Resistance through
2236 0x20-Bit Encoding". This option only affects name lookups that your server
2237 does on behalf of clients. (Default: 1)
2239 [[GeoIPFile]] **GeoIPFile** __filename__::
2240 A filename containing IPv4 GeoIP data, for use with by-country statistics.
2242 [[GeoIPv6File]] **GeoIPv6File** __filename__::
2243 A filename containing IPv6 GeoIP data, for use with by-country statistics.
2245 [[CellStatistics]] **CellStatistics** **0**|**1**::
2247 When this option is enabled, Tor collects statistics about cell
2248 processing (i.e. mean time a cell is spending in a queue, mean
2249 number of cells in a queue and mean number of processed cells per
2250 circuit) and writes them into disk every 24 hours. Onion router
2251 operators may use the statistics for performance monitoring.
2252 If ExtraInfoStatistics is enabled, it will published as part of
2253 extra-info document. (Default: 0)
2255 [[PaddingStatistics]] **PaddingStatistics** **0**|**1**::
2257 When this option is enabled, Tor collects statistics for padding cells
2258 sent and received by this relay, in addition to total cell counts.
2259 These statistics are rounded, and omitted if traffic is low. This
2260 information is important for load balancing decisions related to padding.
2261 If ExtraInfoStatistics is enabled, it will be published
2262 as a part of extra-info document. (Default: 1)
2264 [[DirReqStatistics]] **DirReqStatistics** **0**|**1**::
2265 Relays and bridges only.
2266 When this option is enabled, a Tor directory writes statistics on the
2267 number and response time of network status requests to disk every 24
2268 hours. Enables relay and bridge operators to monitor how much their
2269 server is being used by clients to learn about Tor network.
2270 If ExtraInfoStatistics is enabled, it will published as part of
2271 extra-info document. (Default: 1)
2273 [[EntryStatistics]] **EntryStatistics** **0**|**1**::
2275 When this option is enabled, Tor writes statistics on the number of
2276 directly connecting clients to disk every 24 hours. Enables relay
2277 operators to monitor how much inbound traffic that originates from
2278 Tor clients passes through their server to go further down the
2279 Tor network. If ExtraInfoStatistics is enabled, it will be published
2280 as part of extra-info document. (Default: 0)
2282 [[ExitPortStatistics]] **ExitPortStatistics** **0**|**1**::
2284 When this option is enabled, Tor writes statistics on the number of
2285 relayed bytes and opened stream per exit port to disk every 24 hours.
2286 Enables exit relay operators to measure and monitor amounts of traffic
2287 that leaves Tor network through their exit node. If ExtraInfoStatistics
2288 is enabled, it will be published as part of extra-info document.
2291 [[ConnDirectionStatistics]] **ConnDirectionStatistics** **0**|**1**::
2293 When this option is enabled, Tor writes statistics on the amounts of
2294 traffic it passes between itself and other relays to disk every 24
2295 hours. Enables relay operators to monitor how much their relay is
2296 being used as middle node in the circuit. If ExtraInfoStatistics is
2297 enabled, it will be published as part of extra-info document.
2300 [[HiddenServiceStatistics]] **HiddenServiceStatistics** **0**|**1**::
2302 When this option is enabled, a Tor relay writes obfuscated
2303 statistics on its role as hidden-service directory, introduction
2304 point, or rendezvous point to disk every 24 hours. If
2305 ExtraInfoStatistics is also enabled, these statistics are further
2306 published to the directory authorities. (Default: 1)
2308 [[ExtraInfoStatistics]] **ExtraInfoStatistics** **0**|**1**::
2309 When this option is enabled, Tor includes previously gathered statistics in
2310 its extra-info documents that it uploads to the directory authorities.
2313 [[ExtendAllowPrivateAddresses]] **ExtendAllowPrivateAddresses** **0**|**1**::
2314 When this option is enabled, Tor will connect to relays on localhost,
2315 RFC1918 addresses, and so on. In particular, Tor will make direct OR
2316 connections, and Tor routers allow EXTEND requests, to these private
2317 addresses. (Tor will always allow connections to bridges, proxies, and
2318 pluggable transports configured on private addresses.) Enabling this
2319 option can create security issues; you should probably leave it off.
2322 [[MaxMemInQueues]] **MaxMemInQueues** __N__ **bytes**|**KB**|**MB**|**GB**::
2323 This option configures a threshold above which Tor will assume that it
2324 needs to stop queueing or buffering data because it's about to run out of
2325 memory. If it hits this threshold, it will begin killing circuits until
2326 it has recovered at least 10% of this memory. Do not set this option too
2327 low, or your relay may be unreliable under load. This option only
2328 affects some queues, so the actual process size will be larger than
2329 this. If this option is set to 0, Tor will try to pick a reasonable
2330 default based on your system's physical memory. (Default: 0)
2332 [[DisableOOSCheck]] **DisableOOSCheck** **0**|**1**::
2333 This option disables the code that closes connections when Tor notices
2334 that it is running low on sockets. Right now, it is on by default,
2335 since the existing out-of-sockets mechanism tends to kill OR connections
2336 more than it should. (Default: 1)
2338 [[SigningKeyLifetime]] **SigningKeyLifetime** __N__ **days**|**weeks**|**months**::
2339 For how long should each Ed25519 signing key be valid? Tor uses a
2340 permanent master identity key that can be kept offline, and periodically
2341 generates new "signing" keys that it uses online. This option
2342 configures their lifetime.
2345 [[OfflineMasterKey]] **OfflineMasterKey** **0**|**1**::
2346 If non-zero, the Tor relay will never generate or load its master secret
2347 key. Instead, you'll have to use "tor --keygen" to manage the permanent
2348 ed25519 master identity key, as well as the corresponding temporary
2349 signing keys and certificates. (Default: 0)
2351 [[KeyDirectory]] **KeyDirectory** __DIR__::
2352 Store secret keys in DIR. Can not be changed while tor is
2354 (Default: the "keys" subdirectory of DataDirectory.)
2356 [[KeyDirectoryGroupReadable]] **KeyDirectoryGroupReadable** **0**|**1**::
2357 If this option is set to 0, don't allow the filesystem group to read the
2358 KeywDirectory. If the option is set to 1, make the KeyDirectory readable
2359 by the default GID. (Default: 0)
2362 DIRECTORY SERVER OPTIONS
2363 ------------------------
2365 The following options are useful only for directory servers. (Relays with
2366 enough bandwidth automatically become directory servers; see DirCache for
2369 [[DirPortFrontPage]] **DirPortFrontPage** __FILENAME__::
2370 When this option is set, it takes an HTML file and publishes it as "/" on
2371 the DirPort. Now relay operators can provide a disclaimer without needing
2372 to set up a separate webserver. There's a sample disclaimer in
2373 contrib/operator-tools/tor-exit-notice.html.
2375 [[DirPort]] **DirPort** \['address':]__PORT__|**auto** [_flags_]::
2376 If this option is nonzero, advertise the directory service on this port.
2377 Set it to "auto" to have Tor pick a port for you. This option can occur
2378 more than once, but only one advertised DirPort is supported: all
2379 but one DirPort must have the **NoAdvertise** flag set. (Default: 0) +
2381 The same flags are supported here as are supported by ORPort.
2383 [[DirPolicy]] **DirPolicy** __policy__,__policy__,__...__::
2384 Set an entrance policy for this server, to limit who can connect to the
2385 directory ports. The policies have the same form as exit policies above,
2386 except that port specifiers are ignored. Any address not matched by
2387 some entry in the policy is accepted.
2389 [[DirCache]] **DirCache** **0**|**1**::
2390 When this option is set, Tor caches all current directory documents and
2391 accepts client requests for them. Setting DirPort is not required for this,
2392 because clients connect via the ORPort by default. Setting either DirPort
2393 or BridgeRelay and setting DirCache to 0 is not supported. (Default: 1)
2395 [[MaxConsensusAgeForDiffs]] **MaxConsensusAgeForDiffs** __N__ **minutes**|**hours**|**days**|**weeks**::
2396 When this option is nonzero, Tor caches will not try to generate
2397 consensus diffs for any consensus older than this amount of time.
2398 If this option is set to zero, Tor will pick a reasonable default from
2399 the current networkstatus document. You should not set this
2400 option unless your cache is severely low on disk space or CPU.
2401 If you need to set it, keeping it above 3 or 4 hours will help clients
2402 much more than setting it to zero.
2406 DIRECTORY AUTHORITY SERVER OPTIONS
2407 ----------------------------------
2409 The following options enable operation as a directory authority, and
2410 control how Tor behaves as a directory authority. You should not need
2411 to adjust any of them if you're running a regular relay or exit server
2412 on the public Tor network.
2414 [[AuthoritativeDirectory]] **AuthoritativeDirectory** **0**|**1**::
2415 When this option is set to 1, Tor operates as an authoritative directory
2416 server. Instead of caching the directory, it generates its own list of
2417 good servers, signs it, and sends that to the clients. Unless the clients
2418 already have you listed as a trusted directory, you probably do not want
2421 [[V3AuthoritativeDirectory]] **V3AuthoritativeDirectory** **0**|**1**::
2422 When this option is set in addition to **AuthoritativeDirectory**, Tor
2423 generates version 3 network statuses and serves descriptors, etc as
2424 described in dir-spec.txt file of https://spec.torproject.org/[torspec]
2425 (for Tor clients and servers running at least 0.2.0.x).
2427 [[VersioningAuthoritativeDirectory]] **VersioningAuthoritativeDirectory** **0**|**1**::
2428 When this option is set to 1, Tor adds information on which versions of
2429 Tor are still believed safe for use to the published directory. Each
2430 version 1 authority is automatically a versioning authority; version 2
2431 authorities provide this service optionally. See **RecommendedVersions**,
2432 **RecommendedClientVersions**, and **RecommendedServerVersions**.
2434 [[RecommendedVersions]] **RecommendedVersions** __STRING__::
2435 STRING is a comma-separated list of Tor versions currently believed to be
2436 safe. The list is included in each directory, and nodes which pull down the
2437 directory learn whether they need to upgrade. This option can appear
2438 multiple times: the values from multiple lines are spliced together. When
2439 this is set then **VersioningAuthoritativeDirectory** should be set too.
2441 [[RecommendedPackages]] **RecommendedPackages** __PACKAGENAME__ __VERSION__ __URL__ __DIGESTTYPE__**=**__DIGEST__ ::
2442 Adds "package" line to the directory authority's vote. This information
2443 is used to vote on the correct URL and digest for the released versions
2444 of different Tor-related packages, so that the consensus can certify
2445 them. This line may appear any number of times.
2447 [[RecommendedClientVersions]] **RecommendedClientVersions** __STRING__::
2448 STRING is a comma-separated list of Tor versions currently believed to be
2449 safe for clients to use. This information is included in version 2
2450 directories. If this is not set then the value of **RecommendedVersions**
2451 is used. When this is set then **VersioningAuthoritativeDirectory** should
2454 [[BridgeAuthoritativeDir]] **BridgeAuthoritativeDir** **0**|**1**::
2455 When this option is set in addition to **AuthoritativeDirectory**, Tor
2456 accepts and serves server descriptors, but it caches and serves the main
2457 networkstatus documents rather than generating its own. (Default: 0)
2459 [[MinUptimeHidServDirectoryV2]] **MinUptimeHidServDirectoryV2** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2460 Minimum uptime of a v2 hidden service directory to be accepted as such by
2461 authoritative directories. (Default: 25 hours)
2463 [[RecommendedServerVersions]] **RecommendedServerVersions** __STRING__::
2464 STRING is a comma-separated list of Tor versions currently believed to be
2465 safe for servers to use. This information is included in version 2
2466 directories. If this is not set then the value of **RecommendedVersions**
2467 is used. When this is set then **VersioningAuthoritativeDirectory** should
2470 [[ConsensusParams]] **ConsensusParams** __STRING__::
2471 STRING is a space-separated list of key=value pairs that Tor will include
2472 in the "params" line of its networkstatus vote.
2474 [[DirAllowPrivateAddresses]] **DirAllowPrivateAddresses** **0**|**1**::
2475 If set to 1, Tor will accept server descriptors with arbitrary "Address"
2476 elements. Otherwise, if the address is not an IP address or is a private IP
2477 address, it will reject the server descriptor. Additionally, Tor
2478 will allow exit policies for private networks to fulfill Exit flag
2479 requirements. (Default: 0)
2481 [[AuthDirBadExit]] **AuthDirBadExit** __AddressPattern...__::
2482 Authoritative directories only. A set of address patterns for servers that
2483 will be listed as bad exits in any network status document this authority
2484 publishes, if **AuthDirListBadExits** is set. +
2486 (The address pattern syntax here and in the options below
2487 is the same as for exit policies, except that you don't need to say
2488 "accept" or "reject", and ports are not needed.)
2490 [[AuthDirInvalid]] **AuthDirInvalid** __AddressPattern...__::
2491 Authoritative directories only. A set of address patterns for servers that
2492 will never be listed as "valid" in any network status document that this
2493 authority publishes.
2495 [[AuthDirReject]] **AuthDirReject** __AddressPattern__...::
2496 Authoritative directories only. A set of address patterns for servers that
2497 will never be listed at all in any network status document that this
2498 authority publishes, or accepted as an OR address in any descriptor
2499 submitted for publication by this authority.
2501 [[AuthDirBadExitCCs]] **AuthDirBadExitCCs** __CC__,... +
2503 [[AuthDirInvalidCCs]] **AuthDirInvalidCCs** __CC__,... +
2505 [[AuthDirRejectCCs]] **AuthDirRejectCCs** __CC__,...::
2506 Authoritative directories only. These options contain a comma-separated
2507 list of country codes such that any server in one of those country codes
2508 will be marked as a bad exit/invalid for use, or rejected
2511 [[AuthDirListBadExits]] **AuthDirListBadExits** **0**|**1**::
2512 Authoritative directories only. If set to 1, this directory has some
2513 opinion about which nodes are unsuitable as exit nodes. (Do not set this to
2514 1 unless you plan to list non-functioning exits as bad; otherwise, you are
2515 effectively voting in favor of every declared exit as an exit.)
2517 [[AuthDirMaxServersPerAddr]] **AuthDirMaxServersPerAddr** __NUM__::
2518 Authoritative directories only. The maximum number of servers that we will
2519 list as acceptable on a single IP address. Set this to "0" for "no limit".
2522 [[AuthDirFastGuarantee]] **AuthDirFastGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
2523 Authoritative directories only. If non-zero, always vote the
2524 Fast flag for any relay advertising this amount of capacity or
2525 more. (Default: 100 KBytes)
2527 [[AuthDirGuardBWGuarantee]] **AuthDirGuardBWGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
2528 Authoritative directories only. If non-zero, this advertised capacity
2529 or more is always sufficient to satisfy the bandwidth requirement
2530 for the Guard flag. (Default: 2 MBytes)
2532 [[AuthDirPinKeys]] **AuthDirPinKeys** **0**|**1**::
2533 Authoritative directories only. If non-zero, do not allow any relay to
2534 publish a descriptor if any other relay has reserved its <Ed25519,RSA>
2535 identity keypair. In all cases, Tor records every keypair it accepts
2536 in a journal if it is new, or if it differs from the most recently
2537 accepted pinning for one of the keys it contains. (Default: 1)
2539 [[AuthDirSharedRandomness]] **AuthDirSharedRandomness** **0**|**1**::
2540 Authoritative directories only. Switch for the shared random protocol.
2541 If zero, the authority won't participate in the protocol. If non-zero
2542 (default), the flag "shared-rand-participate" is added to the authority
2543 vote indicating participation in the protocol. (Default: 1)
2545 [[AuthDirTestEd25519LinkKeys]] **AuthDirTestEd25519LinkKeys** **0**|**1**::
2546 Authoritative directories only. If this option is set to 0, then we treat
2547 relays as "Running" if their RSA key is correct when we probe them,
2548 regardless of their Ed25519 key. We should only ever set this option to 0
2549 if there is some major bug in Ed25519 link authentication that causes us
2550 to label all the relays as not Running. (Default: 1)
2552 [[BridgePassword]] **BridgePassword** __Password__::
2553 If set, contains an HTTP authenticator that tells a bridge authority to
2554 serve all requested bridge information. Used by the (only partially
2555 implemented) "bridge community" design, where a community of bridge
2556 relay operators all use an alternate bridge directory authority,
2557 and their target user audience can periodically fetch the list of
2558 available community bridges to stay up-to-date. (Default: not set)
2560 [[V3AuthVotingInterval]] **V3AuthVotingInterval** __N__ **minutes**|**hours**::
2561 V3 authoritative directories only. Configures the server's preferred voting
2562 interval. Note that voting will __actually__ happen at an interval chosen
2563 by consensus from all the authorities' preferred intervals. This time
2564 SHOULD divide evenly into a day. (Default: 1 hour)
2566 [[V3AuthVoteDelay]] **V3AuthVoteDelay** __N__ **minutes**|**hours**::
2567 V3 authoritative directories only. Configures the server's preferred delay
2568 between publishing its vote and assuming it has all the votes from all the
2569 other authorities. Note that the actual time used is not the server's
2570 preferred time, but the consensus of all preferences. (Default: 5 minutes)
2572 [[V3AuthDistDelay]] **V3AuthDistDelay** __N__ **minutes**|**hours**::
2573 V3 authoritative directories only. Configures the server's preferred delay
2574 between publishing its consensus and signature and assuming it has all the
2575 signatures from all the other authorities. Note that the actual time used
2576 is not the server's preferred time, but the consensus of all preferences.
2577 (Default: 5 minutes)
2579 [[V3AuthNIntervalsValid]] **V3AuthNIntervalsValid** __NUM__::
2580 V3 authoritative directories only. Configures the number of VotingIntervals
2581 for which each consensus should be valid for. Choosing high numbers
2582 increases network partitioning risks; choosing low numbers increases
2583 directory traffic. Note that the actual number of intervals used is not the
2584 server's preferred number, but the consensus of all preferences. Must be at
2585 least 2. (Default: 3)
2587 [[V3BandwidthsFile]] **V3BandwidthsFile** __FILENAME__::
2588 V3 authoritative directories only. Configures the location of the
2589 bandwidth-authority generated file storing information on relays' measured
2590 bandwidth capacities. (Default: unset)
2592 [[V3AuthUseLegacyKey]] **V3AuthUseLegacyKey** **0**|**1**::
2593 If set, the directory authority will sign consensuses not only with its
2594 own signing key, but also with a "legacy" key and certificate with a
2595 different identity. This feature is used to migrate directory authority
2596 keys in the event of a compromise. (Default: 0)
2598 [[RephistTrackTime]] **RephistTrackTime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2599 Tells an authority, or other node tracking node reliability and history,
2600 that fine-grained information about nodes can be discarded when it hasn't
2601 changed for a given amount of time. (Default: 24 hours)
2603 [[AuthDirHasIPv6Connectivity]] **AuthDirHasIPv6Connectivity** **0**|**1**::
2604 Authoritative directories only. When set to 0, OR ports with an
2605 IPv6 address are not included in the authority's votes. When set to 1,
2606 IPv6 OR ports are tested for reachability like IPv4 OR ports. If the
2607 reachability test succeeds, the authority votes for the IPv6 ORPort, and
2608 votes Running for the relay. If the reachability test fails, the authority
2609 does not vote for the IPv6 ORPort, and does not vote Running (Default: 0) +
2611 The content of the consensus depends on the number of voting authorities
2612 that set AuthDirHasIPv6Connectivity:
2614 If no authorities set AuthDirHasIPv6Connectivity 1, there will be no
2615 IPv6 ORPorts in the consensus.
2617 If a minority of authorities set AuthDirHasIPv6Connectivity 1,
2618 unreachable IPv6 ORPorts will be removed from the consensus. But the
2619 majority of IPv4-only authorities will still vote the relay as Running.
2620 Reachable IPv6 ORPort lines will be included in the consensus
2622 If a majority of voting authorities set AuthDirHasIPv6Connectivity 1,
2623 relays with unreachable IPv6 ORPorts will not be listed as Running.
2624 Reachable IPv6 ORPort lines will be included in the consensus
2625 (To ensure that any valid majority will vote relays with unreachable
2626 IPv6 ORPorts not Running, 75% of authorities must set
2627 AuthDirHasIPv6Connectivity 1.)
2629 [[MinMeasuredBWsForAuthToIgnoreAdvertised]] **MinMeasuredBWsForAuthToIgnoreAdvertised** __N__::
2630 A total value, in abstract bandwidth units, describing how much
2631 measured total bandwidth an authority should have observed on the network
2632 before it will treat advertised bandwidths as wholly
2633 unreliable. (Default: 500)
2635 HIDDEN SERVICE OPTIONS
2636 ----------------------
2638 The following options are used to configure a hidden service.
2640 [[HiddenServiceDir]] **HiddenServiceDir** __DIRECTORY__::
2641 Store data files for a hidden service in DIRECTORY. Every hidden service
2642 must have a separate directory. You may use this option multiple times to
2643 specify multiple services. If DIRECTORY does not exist, Tor will create it.
2644 (Note: in current versions of Tor, if DIRECTORY is a relative path,
2645 it will be relative to the current
2646 working directory of Tor instance, not to its DataDirectory. Do not
2647 rely on this behavior; it is not guaranteed to remain the same in future
2650 [[HiddenServicePort]] **HiddenServicePort** __VIRTPORT__ [__TARGET__]::
2651 Configure a virtual port VIRTPORT for a hidden service. You may use this
2652 option multiple times; each time applies to the service using the most
2653 recent HiddenServiceDir. By default, this option maps the virtual port to
2654 the same port on 127.0.0.1 over TCP. You may override the target port,
2655 address, or both by specifying a target of addr, port, addr:port, or
2656 **unix:**__path__. (You can specify an IPv6 target as [addr]:port. Unix
2657 paths may be quoted, and may use standard C escapes.)
2658 You may also have multiple lines with the same VIRTPORT: when a user
2659 connects to that VIRTPORT, one of the TARGETs from those lines will be
2662 [[PublishHidServDescriptors]] **PublishHidServDescriptors** **0**|**1**::
2663 If set to 0, Tor will run any hidden services you configure, but it won't
2664 advertise them to the rendezvous directory. This option is only useful if
2665 you're using a Tor controller that handles hidserv publishing for you.
2668 [[HiddenServiceVersion]] **HiddenServiceVersion** **2**|**3**::
2669 A list of rendezvous service descriptor versions to publish for the hidden
2670 service. Currently, versions 2 and 3 are supported. (Default: 2)
2672 [[HiddenServiceAuthorizeClient]] **HiddenServiceAuthorizeClient** __auth-type__ __client-name__,__client-name__,__...__::
2673 If configured, the hidden service is accessible for authorized clients
2674 only. The auth-type can either be \'basic' for a general-purpose
2675 authorization protocol or \'stealth' for a less scalable protocol that also
2676 hides service activity from unauthorized clients. Only clients that are
2677 listed here are authorized to access the hidden service. Valid client names
2678 are 1 to 16 characters long and only use characters in A-Za-z0-9+-_ (no
2679 spaces). If this option is set, the hidden service is not accessible for
2680 clients without authorization any more. Generated authorization data can be
2681 found in the hostname file. Clients need to put this authorization data in
2682 their configuration file using **HidServAuth**. This option is only for v2
2685 [[HiddenServiceAllowUnknownPorts]] **HiddenServiceAllowUnknownPorts** **0**|**1**::
2686 If set to 1, then connections to unrecognized ports do not cause the
2687 current hidden service to close rendezvous circuits. (Setting this to 0 is
2688 not an authorization mechanism; it is instead meant to be a mild
2689 inconvenience to port-scanners.) (Default: 0)
2691 [[HiddenServiceMaxStreams]] **HiddenServiceMaxStreams** __N__::
2692 The maximum number of simultaneous streams (connections) per rendezvous
2693 circuit. The maximum value allowed is 65535. (Setting this to 0 will allow
2694 an unlimited number of simultaneous streams.) (Default: 0)
2696 [[HiddenServiceMaxStreamsCloseCircuit]] **HiddenServiceMaxStreamsCloseCircuit** **0**|**1**::
2697 If set to 1, then exceeding **HiddenServiceMaxStreams** will cause the
2698 offending rendezvous circuit to be torn down, as opposed to stream creation
2699 requests that exceed the limit being silently ignored. (Default: 0)
2701 [[RendPostPeriod]] **RendPostPeriod** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2702 Every time the specified period elapses, Tor uploads any rendezvous
2703 service descriptors to the directory servers. This information is also
2704 uploaded whenever it changes. Minimum value allowed is 10 minutes and
2705 maximum is 3.5 days. This option is only for v2 services.
2708 [[HiddenServiceDirGroupReadable]] **HiddenServiceDirGroupReadable** **0**|**1**::
2709 If this option is set to 1, allow the filesystem group to read the
2710 hidden service directory and hostname file. If the option is set to 0,
2711 only owner is able to read the hidden service directory. (Default: 0)
2712 Has no effect on Windows.
2714 [[HiddenServiceNumIntroductionPoints]] **HiddenServiceNumIntroductionPoints** __NUM__::
2715 Number of introduction points the hidden service will have. You can't
2716 have more than 10 for v2 service and 20 for v3. (Default: 3)
2718 [[HiddenServiceSingleHopMode]] **HiddenServiceSingleHopMode** **0**|**1**::
2719 **Experimental - Non Anonymous** Hidden Services on a tor instance in
2720 HiddenServiceSingleHopMode make one-hop (direct) circuits between the onion
2721 service server, and the introduction and rendezvous points. (Onion service
2722 descriptors are still posted using 3-hop paths, to avoid onion service
2723 directories blocking the service.)
2724 This option makes every hidden service instance hosted by a tor instance a
2725 Single Onion Service. One-hop circuits make Single Onion servers easily
2726 locatable, but clients remain location-anonymous. However, the fact that a
2727 client is accessing a Single Onion rather than a Hidden Service may be
2728 statistically distinguishable. +
2730 **WARNING:** Once a hidden service directory has been used by a tor
2731 instance in HiddenServiceSingleHopMode, it can **NEVER** be used again for
2732 a hidden service. It is best practice to create a new hidden service
2733 directory, key, and address for each new Single Onion Service and Hidden
2734 Service. It is not possible to run Single Onion Services and Hidden
2735 Services from the same tor instance: they should be run on different
2736 servers with different IP addresses. +
2738 HiddenServiceSingleHopMode requires HiddenServiceNonAnonymousMode to be set
2739 to 1. Since a Single Onion service is non-anonymous, you can not configure
2740 a SOCKSPort on a tor instance that is running in
2741 **HiddenServiceSingleHopMode**. Can not be changed while tor is running.
2744 [[HiddenServiceNonAnonymousMode]] **HiddenServiceNonAnonymousMode** **0**|**1**::
2745 Makes hidden services non-anonymous on this tor instance. Allows the
2746 non-anonymous HiddenServiceSingleHopMode. Enables direct connections in the
2747 server-side hidden service protocol. If you are using this option,
2748 you need to disable all client-side services on your Tor instance,
2749 including setting SOCKSPort to "0". Can not be changed while tor is
2750 running. (Default: 0)
2752 DENIAL OF SERVICE MITIGATION OPTIONS
2753 ------------------------------------
2755 The following options are useful only for a public relay. They control the
2756 Denial of Service mitigation subsystem.
2758 [[DoSCircuitCreationEnabled]] **DoSCircuitCreationEnabled** **0**|**1**|**auto**::
2760 Enable circuit creation DoS mitigation. If enabled, tor will cache client
2761 IPs along with statistics in order to detect circuit DoS attacks. If an
2762 address is positively identified, tor will activate defenses against the
2763 address. See the DoSCircuitCreationDefenseType option for more details.
2764 This is a client to relay detection only. "auto" means use the consensus
2765 parameter. If not defined in the consensus, the value is 0.
2768 [[DoSCircuitCreationMinConnections]] **DoSCircuitCreationMinConnections** __NUM__::
2770 Minimum threshold of concurrent connections before a client address can be
2771 flagged as executing a circuit creation DoS. In other words, once a client
2772 address reaches the circuit rate and has a minimum of NUM concurrent
2773 connections, a detection is positive. "0" means use the consensus
2774 parameter. If not defined in the consensus, the value is 3.
2777 [[DoSCircuitCreationRate]] **DoSCircuitCreationRate** __NUM__::
2779 The allowed circuit creation rate per second applied per client IP
2780 address. If this option is 0, it obeys a consensus parameter. If not
2781 defined in the consensus, the value is 3.
2784 [[DoSCircuitCreationBurst]] **DoSCircuitCreationBurst** __NUM__::
2786 The allowed circuit creation burst per client IP address. If the circuit
2787 rate and the burst are reached, a client is marked as executing a circuit
2788 creation DoS. "0" means use the consensus parameter. If not defined in the
2789 consensus, the value is 90.
2792 [[DoSCircuitCreationDefenseType]] **DoSCircuitCreationDefenseType** __NUM__::
2794 This is the type of defense applied to a detected client address. The
2795 possible values are:
2798 2: Refuse circuit creation for the DoSCircuitCreationDefenseTimePeriod period of time.
2800 "0" means use the consensus parameter. If not defined in the consensus,
2804 [[DoSCircuitCreationDefenseTimePeriod]] **DoSCircuitCreationDefenseTimePeriod** __N__ **seconds**|**minutes**|**hours**::
2806 The base time period in seconds that the DoS defense is activated for. The
2807 actual value is selected randomly for each activation from N+1 to 3/2 * N.
2808 "0" means use the consensus parameter. If not defined in the consensus,
2809 the value is 3600 seconds (1 hour). (Default: 0)
2811 [[DoSConnectionEnabled]] **DoSConnectionEnabled** **0**|**1**|**auto**::
2813 Enable the connection DoS mitigation. For client address only, this allows
2814 tor to mitigate against large number of concurrent connections made by a
2815 single IP address. "auto" means use the consensus parameter. If not
2816 defined in the consensus, the value is 0.
2819 [[DoSConnectionMaxConcurrentCount]] **DoSConnectionMaxConcurrentCount** __NUM__::
2821 The maximum threshold of concurrent connection from a client IP address.
2822 Above this limit, a defense selected by DoSConnectionDefenseType is
2823 applied. "0" means use the consensus parameter. If not defined in the
2824 consensus, the value is 100.
2827 [[DoSConnectionDefenseType]] **DoSConnectionDefenseType** __NUM__::
2829 This is the type of defense applied to a detected client address for the
2830 connection mitigation. The possible values are:
2833 2: Immediately close new connections.
2835 "0" means use the consensus parameter. If not defined in the consensus,
2839 [[DoSRefuseSingleHopClientRendezvous]] **DoSRefuseSingleHopClientRendezvous** **0**|**1**|**auto**::
2841 Refuse establishment of rendezvous points for single hop clients. In other
2842 words, if a client directly connects to the relay and sends an
2843 ESTABLISH_RENDEZVOUS cell, it is silently dropped. "auto" means use the
2844 consensus parameter. If not defined in the consensus, the value is 0.
2847 TESTING NETWORK OPTIONS
2848 -----------------------
2850 The following options are used for running a testing Tor network.
2852 [[TestingTorNetwork]] **TestingTorNetwork** **0**|**1**::
2853 If set to 1, Tor adjusts default values of the configuration options below,
2854 so that it is easier to set up a testing Tor network. May only be set if
2855 non-default set of DirAuthorities is set. Cannot be unset while Tor is
2859 ServerDNSAllowBrokenConfig 1
2860 DirAllowPrivateAddresses 1
2861 EnforceDistinctSubnets 0
2863 AuthDirMaxServersPerAddr 0
2864 AuthDirMaxServersPerAuthAddr 0
2865 ClientBootstrapConsensusAuthorityDownloadSchedule 0, 2,
2866 4 (for 40 seconds), 8, 16, 32, 60
2867 ClientBootstrapConsensusFallbackDownloadSchedule 0, 1,
2868 4 (for 40 seconds), 8, 16, 32, 60
2869 ClientBootstrapConsensusAuthorityOnlyDownloadSchedule 0, 1,
2870 4 (for 40 seconds), 8, 16, 32, 60
2871 ClientDNSRejectInternalAddresses 0
2872 ClientRejectInternalAddresses 0
2873 CountPrivateBandwidth 1
2874 ExitPolicyRejectPrivate 0
2875 ExtendAllowPrivateAddresses 1
2876 V3AuthVotingInterval 5 minutes
2877 V3AuthVoteDelay 20 seconds
2878 V3AuthDistDelay 20 seconds
2879 MinUptimeHidServDirectoryV2 0 seconds
2880 TestingV3AuthInitialVotingInterval 5 minutes
2881 TestingV3AuthInitialVoteDelay 20 seconds
2882 TestingV3AuthInitialDistDelay 20 seconds
2883 TestingAuthDirTimeToLearnReachability 0 minutes
2884 TestingEstimatedDescriptorPropagationTime 0 minutes
2885 TestingServerDownloadSchedule 0, 0, 0, 5, 10, 15, 20, 30, 60
2886 TestingClientDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2887 TestingServerConsensusDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2888 TestingClientConsensusDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2889 TestingBridgeDownloadSchedule 10, 30, 60
2890 TestingBridgeBootstrapDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2891 TestingClientMaxIntervalWithoutRequest 5 seconds
2892 TestingDirConnectionMaxStall 30 seconds
2893 TestingEnableConnBwEvent 1
2894 TestingEnableCellStatsEvent 1
2895 TestingEnableTbEmptyEvent 1
2897 [[TestingV3AuthInitialVotingInterval]] **TestingV3AuthInitialVotingInterval** __N__ **minutes**|**hours**::
2898 Like V3AuthVotingInterval, but for initial voting interval before the first
2899 consensus has been created. Changing this requires that
2900 **TestingTorNetwork** is set. (Default: 30 minutes)
2902 [[TestingV3AuthInitialVoteDelay]] **TestingV3AuthInitialVoteDelay** __N__ **minutes**|**hours**::
2903 Like V3AuthVoteDelay, but for initial voting interval before
2904 the first consensus has been created. Changing this requires that
2905 **TestingTorNetwork** is set. (Default: 5 minutes)
2907 [[TestingV3AuthInitialDistDelay]] **TestingV3AuthInitialDistDelay** __N__ **minutes**|**hours**::
2908 Like V3AuthDistDelay, but for initial voting interval before
2909 the first consensus has been created. Changing this requires that
2910 **TestingTorNetwork** is set. (Default: 5 minutes)
2912 [[TestingV3AuthVotingStartOffset]] **TestingV3AuthVotingStartOffset** __N__ **seconds**|**minutes**|**hours**::
2913 Directory authorities offset voting start time by this much.
2914 Changing this requires that **TestingTorNetwork** is set. (Default: 0)
2916 [[TestingAuthDirTimeToLearnReachability]] **TestingAuthDirTimeToLearnReachability** __N__ **minutes**|**hours**::
2917 After starting as an authority, do not make claims about whether routers
2918 are Running until this much time has passed. Changing this requires
2919 that **TestingTorNetwork** is set. (Default: 30 minutes)
2921 [[TestingEstimatedDescriptorPropagationTime]] **TestingEstimatedDescriptorPropagationTime** __N__ **minutes**|**hours**::
2922 Clients try downloading server descriptors from directory caches after this
2923 time. Changing this requires that **TestingTorNetwork** is set. (Default:
2926 [[TestingMinFastFlagThreshold]] **TestingMinFastFlagThreshold** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
2927 Minimum value for the Fast flag. Overrides the ordinary minimum taken
2928 from the consensus when TestingTorNetwork is set. (Default: 0.)
2930 [[TestingServerDownloadSchedule]] **TestingServerDownloadSchedule** __N__,__N__,__...__::
2931 Schedule for when servers should download things in general. Changing this
2932 requires that **TestingTorNetwork** is set. (Default: 0, 0, 0, 60, 60, 120,
2933 300, 900, 2147483647)
2935 [[TestingClientDownloadSchedule]] **TestingClientDownloadSchedule** __N__,__N__,__...__::
2936 Schedule for when clients should download things in general. Changing this
2937 requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2940 [[TestingServerConsensusDownloadSchedule]] **TestingServerConsensusDownloadSchedule** __N__,__N__,__...__::
2941 Schedule for when servers should download consensuses. Changing this
2942 requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2943 1800, 1800, 1800, 1800, 1800, 3600, 7200)
2945 [[TestingClientConsensusDownloadSchedule]] **TestingClientConsensusDownloadSchedule** __N__,__N__,__...__::
2946 Schedule for when clients should download consensuses. Changing this
2947 requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2948 1800, 3600, 3600, 3600, 10800, 21600, 43200)
2950 [[TestingBridgeDownloadSchedule]] **TestingBridgeDownloadSchedule** __N__,__N__,__...__::
2951 Schedule for when clients should download each bridge descriptor when they
2952 know that one or more of their configured bridges are running. Changing
2953 this requires that **TestingTorNetwork** is set. (Default: 10800, 25200,
2954 54000, 111600, 262800)
2956 [[TestingBridgeBootstrapDownloadSchedule]] **TestingBridgeBootstrapDownloadSchedule** __N__,__N__,__...__::
2957 Schedule for when clients should download each bridge descriptor when they
2958 have just started, or when they can not contact any of their bridges.
2959 Changing this requires that **TestingTorNetwork** is set. (Default: 0, 30,
2960 90, 600, 3600, 10800, 25200, 54000, 111600, 262800)
2962 [[TestingClientMaxIntervalWithoutRequest]] **TestingClientMaxIntervalWithoutRequest** __N__ **seconds**|**minutes**::
2963 When directory clients have only a few descriptors to request, they batch
2964 them until they have more, or until this amount of time has passed.
2965 Changing this requires that **TestingTorNetwork** is set. (Default: 10
2968 [[TestingDirConnectionMaxStall]] **TestingDirConnectionMaxStall** __N__ **seconds**|**minutes**::
2969 Let a directory connection stall this long before expiring it.
2970 Changing this requires that **TestingTorNetwork** is set. (Default:
2973 [[TestingDirAuthVoteExit]] **TestingDirAuthVoteExit** __node__,__node__,__...__::
2974 A list of identity fingerprints, country codes, and
2975 address patterns of nodes to vote Exit for regardless of their
2976 uptime, bandwidth, or exit policy. See the **ExcludeNodes**
2977 option for more information on how to specify nodes. +
2979 In order for this option to have any effect, **TestingTorNetwork**
2980 has to be set. See the **ExcludeNodes** option for more
2981 information on how to specify nodes.
2983 [[TestingDirAuthVoteExitIsStrict]] **TestingDirAuthVoteExitIsStrict** **0**|**1** ::
2984 If True (1), a node will never receive the Exit flag unless it is specified
2985 in the **TestingDirAuthVoteExit** list, regardless of its uptime, bandwidth,
2988 In order for this option to have any effect, **TestingTorNetwork**
2991 [[TestingDirAuthVoteGuard]] **TestingDirAuthVoteGuard** __node__,__node__,__...__::
2992 A list of identity fingerprints and country codes and
2993 address patterns of nodes to vote Guard for regardless of their
2994 uptime and bandwidth. See the **ExcludeNodes** option for more
2995 information on how to specify nodes. +
2997 In order for this option to have any effect, **TestingTorNetwork**
3000 [[TestingDirAuthVoteGuardIsStrict]] **TestingDirAuthVoteGuardIsStrict** **0**|**1** ::
3001 If True (1), a node will never receive the Guard flag unless it is specified
3002 in the **TestingDirAuthVoteGuard** list, regardless of its uptime and bandwidth. +
3004 In order for this option to have any effect, **TestingTorNetwork**
3007 [[TestingDirAuthVoteHSDir]] **TestingDirAuthVoteHSDir** __node__,__node__,__...__::
3008 A list of identity fingerprints and country codes and
3009 address patterns of nodes to vote HSDir for regardless of their
3010 uptime and DirPort. See the **ExcludeNodes** option for more
3011 information on how to specify nodes. +
3013 In order for this option to have any effect, **TestingTorNetwork**
3016 [[TestingDirAuthVoteHSDirIsStrict]] **TestingDirAuthVoteHSDirIsStrict** **0**|**1** ::
3017 If True (1), a node will never receive the HSDir flag unless it is specified
3018 in the **TestingDirAuthVoteHSDir** list, regardless of its uptime and DirPort. +
3020 In order for this option to have any effect, **TestingTorNetwork**
3023 [[TestingEnableConnBwEvent]] **TestingEnableConnBwEvent** **0**|**1**::
3024 If this option is set, then Tor controllers may register for CONN_BW
3025 events. Changing this requires that **TestingTorNetwork** is set.
3028 [[TestingEnableCellStatsEvent]] **TestingEnableCellStatsEvent** **0**|**1**::
3029 If this option is set, then Tor controllers may register for CELL_STATS
3030 events. Changing this requires that **TestingTorNetwork** is set.
3033 [[TestingEnableTbEmptyEvent]] **TestingEnableTbEmptyEvent** **0**|**1**::
3034 If this option is set, then Tor controllers may register for TB_EMPTY
3035 events. Changing this requires that **TestingTorNetwork** is set.
3038 [[TestingMinExitFlagThreshold]] **TestingMinExitFlagThreshold** __N__ **KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
3039 Sets a lower-bound for assigning an exit flag when running as an
3040 authority on a testing network. Overrides the usual default lower bound
3041 of 4 KB. (Default: 0)
3043 [[TestingLinkCertLifetime]] **TestingLinkCertLifetime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**|**months**::
3044 Overrides the default lifetime for the certificates used to authenticate
3045 our X509 link cert with our ed25519 signing key.
3048 [[TestingAuthKeyLifetime]] **TestingAuthKeyLifetime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**|**months**::
3049 Overrides the default lifetime for a signing Ed25519 TLS Link authentication
3053 [[TestingLinkKeySlop]] **TestingLinkKeySlop** __N__ **seconds**|**minutes**|**hours** +
3055 [[TestingAuthKeySlop]] **TestingAuthKeySlop** __N__ **seconds**|**minutes**|**hours** +
3057 [[TestingSigningKeySlop]] **TestingSigningKeySlop** __N__ **seconds**|**minutes**|**hours**::
3058 How early before the official expiration of a an Ed25519 signing key do
3059 we replace it and issue a new key?
3060 (Default: 3 hours for link and auth; 1 day for signing.)
3062 NON-PERSISTENT OPTIONS
3063 ----------------------
3065 These options are not saved to the torrc file by the "SAVECONF" controller
3066 command. Other options of this type are documented in control-spec.txt,
3067 section 5.4. End-users should mostly ignore them.
3069 [[UnderscorePorts]] **\_\_ControlPort**, **\_\_DirPort**, **\_\_DNSPort**, **\_\_ExtORPort**, **\_\_NATDPort**, **\_\_ORPort**, **\_\_SocksPort**, **\_\_TransPort**::
3070 These underscore-prefixed options are variants of the regular Port
3071 options. They behave the same, except they are not saved to the
3072 torrc file by the controller's SAVECONF command.
3078 Tor catches the following signals:
3080 [[SIGTERM]] **SIGTERM**::
3081 Tor will catch this, clean up and sync to disk if necessary, and exit.
3083 [[SIGINT]] **SIGINT**::
3084 Tor clients behave as with SIGTERM; but Tor servers will do a controlled
3085 slow shutdown, closing listeners and waiting 30 seconds before exiting.
3086 (The delay can be configured with the ShutdownWaitLength config option.)
3088 [[SIGHUP]] **SIGHUP**::
3089 The signal instructs Tor to reload its configuration (including closing and
3090 reopening logs), and kill and restart its helper processes if applicable.
3092 [[SIGUSR1]] **SIGUSR1**::
3093 Log statistics about current connections, past connections, and throughput.
3095 [[SIGUSR2]] **SIGUSR2**::
3096 Switch all logs to loglevel debug. You can go back to the old loglevels by
3099 [[SIGCHLD]] **SIGCHLD**::
3100 Tor receives this signal when one of its helper processes has exited, so it
3103 [[SIGPIPE]] **SIGPIPE**::
3104 Tor catches this signal and ignores it.
3106 [[SIGXFSZ]] **SIGXFSZ**::
3107 If this signal exists on your platform, Tor catches and ignores it.
3112 **@CONFDIR@/torrc**::
3113 The configuration file, which contains "option value" pairs.
3116 Fallback location for torrc, if @CONFDIR@/torrc is not found.
3118 **@LOCALSTATEDIR@/lib/tor/**::
3119 The tor process stores keys and other data here.
3122 __CacheDirectory__**/cached-certs**::
3123 This file holds downloaded directory key certificates that are used to
3124 verify authenticity of documents generated by Tor directory authorities.
3126 __CacheDirectory__**/cached-consensus** and/or **cached-microdesc-consensus**::
3127 The most recent consensus network status document we've downloaded.
3129 __CacheDirectory__**/cached-descriptors** and **cached-descriptors.new**::
3130 These files hold downloaded router statuses. Some routers may appear more
3131 than once; if so, the most recently published descriptor is used. Lines
3132 beginning with @-signs are annotations that contain more information about
3133 a given router. The ".new" file is an append-only journal; when it gets
3134 too large, all entries are merged into a new cached-descriptors file.
3136 __CacheDirectory__**/cached-extrainfo** and **cached-extrainfo.new**::
3137 As "cached-descriptors", but holds optionally-downloaded "extra-info"
3138 documents. Relays use these documents to send inessential information
3139 about statistics, bandwidth history, and network health to the
3140 authorities. They aren't fetched by default; see the DownloadExtraInfo
3141 option for more info.
3143 __CacheDirectory__**/cached-microdescs** and **cached-microdescs.new**::
3144 These files hold downloaded microdescriptors. Lines beginning with
3145 @-signs are annotations that contain more information about a given
3146 router. The ".new" file is an append-only journal; when it gets too
3147 large, all entries are merged into a new cached-microdescs file.
3149 __CacheDirectory__**/cached-routers** and **cached-routers.new**::
3150 Obsolete versions of cached-descriptors and cached-descriptors.new. When
3151 Tor can't find the newer files, it looks here instead.
3153 __DataDirectory__**/state**::
3154 A set of persistent key-value mappings. These are documented in
3155 the file. These include:
3156 - The current entry guards and their status.
3157 - The current bandwidth accounting values.
3158 - When the file was last written
3159 - What version of Tor generated the state file
3160 - A short history of bandwidth usage, as produced in the server
3163 __DataDirectory__**/sr-state**::
3164 Authority only. State file used to record information about the current
3165 status of the shared-random-value voting state.
3167 __CacheDirectory__**/diff-cache**::
3168 Directory cache only. Holds older consensuses, and diffs from older
3169 consensuses to the most recent consensus of each type, compressed
3170 in various ways. Each file contains a set of key-value arguments
3171 describing its contents, followed by a single NUL byte, followed by the
3174 __DataDirectory__**/bw_accounting**::
3175 Used to track bandwidth accounting values (when the current period starts
3176 and ends; how much has been read and written so far this period). This file
3177 is obsolete, and the data is now stored in the \'state' file instead.
3179 __DataDirectory__**/control_auth_cookie**::
3180 Used for cookie authentication with the controller. Location can be
3181 overridden by the CookieAuthFile config option. Regenerated on startup. See
3182 control-spec.txt in https://spec.torproject.org/[torspec] for details.
3183 Only used when cookie authentication is enabled.
3185 __DataDirectory__**/lock**::
3186 This file is used to prevent two Tor instances from using same data
3187 directory. If access to this file is locked, data directory is already
3190 __DataDirectory__**/key-pinning-journal**::
3191 Used by authorities. A line-based file that records mappings between
3192 RSA1024 identity keys and Ed25519 identity keys. Authorities enforce
3193 these mappings, so that once a relay has picked an Ed25519 key, stealing
3194 or factoring the RSA1024 key will no longer let an attacker impersonate
3197 __KeyDirectory__**/authority_identity_key**::
3198 A v3 directory authority's master identity key, used to authenticate its
3199 signing key. Tor doesn't use this while it's running. The tor-gencert
3200 program uses this. If you're running an authority, you should keep this
3201 key offline, and not actually put it here.
3203 __KeyDirectory__**/authority_certificate**::
3204 A v3 directory authority's certificate, which authenticates the authority's
3205 current vote- and consensus-signing key using its master identity key.
3206 Only directory authorities use this file.
3208 __KeyDirectory__**/authority_signing_key**::
3209 A v3 directory authority's signing key, used to sign votes and consensuses.
3210 Only directory authorities use this file. Corresponds to the
3211 **authority_certificate** cert.
3213 __KeyDirectory__**/legacy_certificate**::
3214 As authority_certificate: used only when V3AuthUseLegacyKey is set.
3215 See documentation for V3AuthUseLegacyKey.
3217 __KeyDirectory__**/legacy_signing_key**::
3218 As authority_signing_key: used only when V3AuthUseLegacyKey is set.
3219 See documentation for V3AuthUseLegacyKey.
3221 __KeyDirectory__**/secret_id_key**::
3222 A relay's RSA1024 permanent identity key, including private and public
3223 components. Used to sign router descriptors, and to sign other keys.
3225 __KeyDirectory__**/ed25519_master_id_public_key**::
3226 The public part of a relay's Ed25519 permanent identity key.
3228 __KeyDirectory__**/ed25519_master_id_secret_key**::
3229 The private part of a relay's Ed25519 permanent identity key. This key
3230 is used to sign the medium-term ed25519 signing key. This file can be
3231 kept offline, or kept encrypted. If so, Tor will not be able to generate
3232 new signing keys itself; you'll need to use tor --keygen yourself to do
3235 __KeyDirectory__**/ed25519_signing_secret_key**::
3236 The private and public components of a relay's medium-term Ed25519 signing
3237 key. This key is authenticated by the Ed25519 master key, in turn
3238 authenticates other keys (and router descriptors).
3240 __KeyDirectory__**/ed25519_signing_cert**::
3241 The certificate which authenticates "ed25519_signing_secret_key" as
3242 having been signed by the Ed25519 master key.
3244 __KeyDirectory__**/secret_onion_key** and **secret_onion_key.old**::
3245 A relay's RSA1024 short-term onion key. Used to decrypt old-style ("TAP")
3246 circuit extension requests. The ".old" file holds the previously
3247 generated key, which the relay uses to handle any requests that were
3248 made by clients that didn't have the new one.
3250 __KeyDirectory__**/secret_onion_key_ntor** and **secret_onion_key_ntor.old**::
3251 A relay's Curve25519 short-term onion key. Used to handle modern ("ntor")
3252 circuit extension requests. The ".old" file holds the previously
3253 generated key, which the relay uses to handle any requests that were
3254 made by clients that didn't have the new one.
3256 __DataDirectory__**/fingerprint**::
3257 Only used by servers. Holds the fingerprint of the server's identity key.
3259 __DataDirectory__**/hashed-fingerprint**::
3260 Only used by bridges. Holds the hashed fingerprint of the bridge's
3261 identity key. (That is, the hash of the hash of the identity key.)
3263 __DataDirectory__**/approved-routers**::
3264 Only used by authoritative directory servers. This file lists
3265 the status of routers by their identity fingerprint.
3266 Each line lists a status and a fingerprint separated by
3267 whitespace. See your **fingerprint** file in the __DataDirectory__ for an
3268 example line. If the status is **!reject** then descriptors from the
3269 given identity (fingerprint) are rejected by this server. If it is
3270 **!invalid** then descriptors are accepted but marked in the directory as
3271 not valid, that is, not recommended.
3273 __DataDirectory__**/v3-status-votes**::
3274 Only for v3 authoritative directory servers. This file contains
3275 status votes from all the authoritative directory servers.
3277 __CacheDirectory__**/unverified-consensus**::
3278 This file contains a network consensus document that has been downloaded,
3279 but which we didn't have the right certificates to check yet.
3281 __CacheDirectory__**/unverified-microdesc-consensus**::
3282 This file contains a microdescriptor-flavored network consensus document
3283 that has been downloaded, but which we didn't have the right certificates
3286 __DataDirectory__**/unparseable-desc**::
3287 Onion server descriptors that Tor was unable to parse are dumped to this
3288 file. Only used for debugging.
3290 __DataDirectory__**/router-stability**::
3291 Only used by authoritative directory servers. Tracks measurements for
3292 router mean-time-between-failures so that authorities have a good idea of
3293 how to set their Stable flags.
3295 __DataDirectory__**/stats/dirreq-stats**::
3296 Only used by directory caches and authorities. This file is used to
3297 collect directory request statistics.
3299 __DataDirectory__**/stats/entry-stats**::
3300 Only used by servers. This file is used to collect incoming connection
3301 statistics by Tor entry nodes.
3303 __DataDirectory__**/stats/bridge-stats**::
3304 Only used by servers. This file is used to collect incoming connection
3305 statistics by Tor bridges.
3307 __DataDirectory__**/stats/exit-stats**::
3308 Only used by servers. This file is used to collect outgoing connection
3309 statistics by Tor exit routers.
3311 __DataDirectory__**/stats/buffer-stats**::
3312 Only used by servers. This file is used to collect buffer usage
3315 __DataDirectory__**/stats/conn-stats**::
3316 Only used by servers. This file is used to collect approximate connection
3317 history (number of active connections over time).
3319 __DataDirectory__**/stats/hidserv-stats**::
3320 Only used by servers. This file is used to collect approximate counts
3321 of what fraction of the traffic is hidden service rendezvous traffic, and
3322 approximately how many hidden services the relay has seen.
3324 __DataDirectory__**/networkstatus-bridges**::
3325 Only used by authoritative bridge directories. Contains information
3326 about bridges that have self-reported themselves to the bridge
3329 __DataDirectory__**/approved-routers**::
3330 Authorities only. This file is used to configure which relays are
3331 known to be valid, invalid, and so forth.
3333 __HiddenServiceDirectory__**/hostname**::
3334 The <base32-encoded-fingerprint>.onion domain name for this hidden service.
3335 If the hidden service is restricted to authorized clients only, this file
3336 also contains authorization data for all clients.
3338 Note that clients will ignore any extra subdomains prepended to a hidden
3339 service hostname. So if you have "xyz.onion" as your hostname, you
3340 can tell clients to connect to "www.xyz.onion" or "irc.xyz.onion"
3341 for virtual-hosting purposes.
3343 __HiddenServiceDirectory__**/private_key**::
3344 The private key for this hidden service.
3346 __HiddenServiceDirectory__**/client_keys**::
3347 Authorization data for a hidden service that is only accessible by
3350 __HiddenServiceDirectory__**/onion_service_non_anonymous**::
3351 This file is present if a hidden service key was created in
3352 **HiddenServiceNonAnonymousMode**.
3356 **torsocks**(1), **torify**(1) +
3358 **https://www.torproject.org/**
3360 **torspec: https://spec.torproject.org **
3365 Plenty, probably. Tor is still in development. Please report them at https://trac.torproject.org/.
3369 Roger Dingledine [arma at mit.edu], Nick Mathewson [nickm at alum.mit.edu].