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. (Default: 0)
236 [[RelayBandwidthBurst]] **RelayBandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
237 If not 0, limit the maximum token bucket size (also known as the burst) for
238 \_relayed traffic_ to the given number of bytes in each direction.
241 [[PerConnBWRate]] **PerConnBWRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
242 If set, do separate rate limiting for each connection from a non-relay.
243 You should never need to change this value, since a network-wide value is
244 published in the consensus and your relay will use that value. (Default: 0)
246 [[PerConnBWBurst]] **PerConnBWBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
247 If set, do separate rate limiting for each connection from a non-relay.
248 You should never need to change this value, since a network-wide value is
249 published in the consensus and your relay will use that value. (Default: 0)
251 [[ClientTransportPlugin]] **ClientTransportPlugin** __transport__ socks4|socks5 __IP__:__PORT__::
252 **ClientTransportPlugin** __transport__ exec __path-to-binary__ [options]::
253 In its first form, when set along with a corresponding Bridge line, the Tor
254 client forwards its traffic to a SOCKS-speaking proxy on "IP:PORT". It's the
255 duty of that proxy to properly forward the traffic to the bridge. +
257 In its second form, when set along with a corresponding Bridge line, the Tor
258 client launches the pluggable transport proxy executable in
259 __path-to-binary__ using __options__ as its command-line options, and
260 forwards its traffic to it. It's the duty of that proxy to properly forward
261 the traffic to the bridge.
263 [[ServerTransportPlugin]] **ServerTransportPlugin** __transport__ exec __path-to-binary__ [options]::
264 The Tor relay launches the pluggable transport proxy in __path-to-binary__
265 using __options__ as its command-line options, and expects to receive
266 proxied client traffic from it.
268 [[ServerTransportListenAddr]] **ServerTransportListenAddr** __transport__ __IP__:__PORT__::
269 When this option is set, Tor will suggest __IP__:__PORT__ as the
270 listening address of any pluggable transport proxy that tries to
271 launch __transport__.
273 [[ServerTransportOptions]] **ServerTransportOptions** __transport__ __k=v__ __k=v__ ...::
274 When this option is set, Tor will pass the __k=v__ parameters to
275 any pluggable transport proxy that tries to launch __transport__. +
276 (Example: ServerTransportOptions obfs45 shared-secret=bridgepasswd cache=/var/lib/tor/cache)
278 [[ExtORPort]] **ExtORPort** \['address':]__port__|**auto**::
279 Open this port to listen for Extended ORPort connections from your
280 pluggable transports.
282 [[ExtORPortCookieAuthFile]] **ExtORPortCookieAuthFile** __Path__::
283 If set, this option overrides the default location and file name
284 for the Extended ORPort's cookie file -- the cookie file is needed
285 for pluggable transports to communicate through the Extended ORPort.
287 [[ExtORPortCookieAuthFileGroupReadable]] **ExtORPortCookieAuthFileGroupReadable** **0**|**1**::
288 If this option is set to 0, don't allow the filesystem group to read the
289 Extended OR Port cookie file. If the option is set to 1, make the cookie
290 file readable by the default GID. [Making the file readable by other
291 groups is not yet implemented; let us know if you need this for some
292 reason.] (Default: 0)
294 [[ConnLimit]] **ConnLimit** __NUM__::
295 The minimum number of file descriptors that must be available to the Tor
296 process before it will start. Tor will ask the OS for as many file
297 descriptors as the OS will allow (you can find this by "ulimit -H -n").
298 If this number is less than ConnLimit, then Tor will refuse to start. +
300 You probably don't need to adjust this. It has no effect on Windows
301 since that platform lacks getrlimit(). (Default: 1000)
303 [[DisableNetwork]] **DisableNetwork** **0**|**1**::
304 When this option is set, we don't listen for or accept any connections
305 other than controller connections, and we close (and don't reattempt)
307 connections. Controllers sometimes use this option to avoid using
308 the network until Tor is fully configured. (Default: 0)
310 [[ConstrainedSockets]] **ConstrainedSockets** **0**|**1**::
311 If set, Tor will tell the kernel to attempt to shrink the buffers for all
312 sockets to the size specified in **ConstrainedSockSize**. This is useful for
313 virtual servers and other environments where system level TCP buffers may
314 be limited. If you're on a virtual server, and you encounter the "Error
315 creating network socket: No buffer space available" message, you are
316 likely experiencing this problem. +
318 The preferred solution is to have the admin increase the buffer pool for
319 the host itself via /proc/sys/net/ipv4/tcp_mem or equivalent facility;
320 this configuration option is a second-resort. +
322 The DirPort option should also not be used if TCP buffers are scarce. The
323 cached directory requests consume additional sockets which exacerbates
326 You should **not** enable this feature unless you encounter the "no buffer
327 space available" issue. Reducing the TCP buffers affects window size for
328 the TCP stream and will reduce throughput in proportion to round trip
329 time on long paths. (Default: 0)
331 [[ConstrainedSockSize]] **ConstrainedSockSize** __N__ **bytes**|**KBytes**::
332 When **ConstrainedSockets** is enabled the receive and transmit buffers for
333 all sockets will be set to this limit. Must be a value between 2048 and
334 262144, in 1024 byte increments. Default of 8192 is recommended.
336 [[ControlPort]] **ControlPort** __PORT__|**unix:**__path__|**auto** [__flags__]::
337 If set, Tor will accept connections on this port and allow those
338 connections to control the Tor process using the Tor Control Protocol
339 (described in control-spec.txt in
340 https://spec.torproject.org[torspec]). Note: unless you also
341 specify one or more of **HashedControlPassword** or
342 **CookieAuthentication**, setting this option will cause Tor to allow
343 any process on the local host to control it. (Setting both authentication
344 methods means either method is sufficient to authenticate to Tor.) This
345 option is required for many Tor controllers; most use the value of 9051.
346 If a unix domain socket is used, you may quote the path using standard
348 Set it to "auto" to have Tor pick a port for you. (Default: 0) +
350 Recognized flags are...
352 Unix domain sockets only: makes the socket get created as
355 Unix domain sockets only: makes the socket get created as
357 **RelaxDirModeCheck**;;
358 Unix domain sockets only: Do not insist that the directory
359 that holds the socket be read-restricted.
361 [[ControlSocket]] **ControlSocket** __Path__::
362 Like ControlPort, but listens on a Unix domain socket, rather than a TCP
363 socket. '0' disables ControlSocket (Unix and Unix-like systems only.)
365 [[ControlSocketsGroupWritable]] **ControlSocketsGroupWritable** **0**|**1**::
366 If this option is set to 0, don't allow the filesystem group to read and
367 write unix sockets (e.g. ControlSocket). If the option is set to 1, make
368 the control socket readable and writable by the default GID. (Default: 0)
370 [[HashedControlPassword]] **HashedControlPassword** __hashed_password__::
371 Allow connections on the control port if they present
372 the password whose one-way hash is __hashed_password__. You
373 can compute the hash of a password by running "tor --hash-password
374 __password__". You can provide several acceptable passwords by using more
375 than one HashedControlPassword line.
377 [[CookieAuthentication]] **CookieAuthentication** **0**|**1**::
378 If this option is set to 1, allow connections on the control port
379 when the connecting process knows the contents of a file named
380 "control_auth_cookie", which Tor will create in its data directory. This
381 authentication method should only be used on systems with good filesystem
382 security. (Default: 0)
384 [[CookieAuthFile]] **CookieAuthFile** __Path__::
385 If set, this option overrides the default location and file name
386 for Tor's cookie file. (See CookieAuthentication above.)
388 [[CookieAuthFileGroupReadable]] **CookieAuthFileGroupReadable** **0**|**1**::
389 If this option is set to 0, don't allow the filesystem group to read the
390 cookie file. If the option is set to 1, make the cookie file readable by
391 the default GID. [Making the file readable by other groups is not yet
392 implemented; let us know if you need this for some reason.] (Default: 0)
394 [[ControlPortWriteToFile]] **ControlPortWriteToFile** __Path__::
395 If set, Tor writes the address and port of any control port it opens to
396 this address. Usable by controllers to learn the actual control port
397 when ControlPort is set to "auto".
399 [[ControlPortFileGroupReadable]] **ControlPortFileGroupReadable** **0**|**1**::
400 If this option is set to 0, don't allow the filesystem group to read the
401 control port file. If the option is set to 1, make the control port
402 file readable by the default GID. (Default: 0)
404 [[DataDirectory]] **DataDirectory** __DIR__::
405 Store working data in DIR. Can not be changed while tor is running.
406 (Default: ~/.tor if your home directory is not /; otherwise,
407 @LOCALSTATEDIR@/lib/tor. On Windows, the default is
408 your ApplicationData folder.)
410 [[DataDirectoryGroupReadable]] **DataDirectoryGroupReadable** **0**|**1**::
411 If this option is set to 0, don't allow the filesystem group to read the
412 DataDirectory. If the option is set to 1, make the DataDirectory readable
413 by the default GID. (Default: 0)
415 [[FallbackDir]] **FallbackDir** __address__:__port__ orport=__port__ id=__fingerprint__ [weight=__num__] [ipv6=__address__:__orport__]::
416 When we're unable to connect to any directory cache for directory info
417 (usually because we don't know about any yet) we try a directory authority.
418 Clients also simultaneously try a FallbackDir, to avoid hangs on client
419 startup if a directory authority is down. Clients retry FallbackDirs more
420 often than directory authorities, to reduce the load on the directory
422 By default, the directory authorities are also FallbackDirs. Specifying a
423 FallbackDir replaces Tor's default hard-coded FallbackDirs (if any).
424 (See the **DirAuthority** entry for an explanation of each flag.)
426 [[UseDefaultFallbackDirs]] **UseDefaultFallbackDirs** **0**|**1**::
427 Use Tor's default hard-coded FallbackDirs (if any). (When a
428 FallbackDir line is present, it replaces the hard-coded FallbackDirs,
429 regardless of the value of UseDefaultFallbackDirs.) (Default: 1)
431 [[DirAuthority]] **DirAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__::
432 Use a nonstandard authoritative directory server at the provided address
433 and port, with the specified key fingerprint. This option can be repeated
434 many times, for multiple authoritative directory servers. Flags are
435 separated by spaces, and determine what kind of an authority this directory
436 is. By default, an authority is not authoritative for any directory style
437 or version unless an appropriate flag is given.
438 Tor will use this authority as a bridge authoritative directory if the
439 "bridge" flag is set. If a flag "orport=**port**" is given, Tor will use the
440 given port when opening encrypted tunnels to the dirserver. If a flag
441 "weight=**num**" is given, then the directory server is chosen randomly
442 with probability proportional to that weight (default 1.0). If a
443 flag "v3ident=**fp**" is given, the dirserver is a v3 directory authority
444 whose v3 long-term signing key has the fingerprint **fp**. Lastly,
445 if an "ipv6=__address__:__orport__" flag is present, then the directory
446 authority is listening for IPv6 connections on the indicated IPv6 address
449 Tor will contact the authority at __address__ to
450 download directory documents. The provided __port__ value is a dirport;
451 clients ignore this in favor of the specified "orport=" value. If an
452 IPv6 ORPort is supplied, Tor will
453 also download directory documents at the IPv6 ORPort. +
455 If no **DirAuthority** line is given, Tor will use the default directory
456 authorities. NOTE: this option is intended for setting up a private Tor
457 network with its own directory authorities. If you use it, you will be
458 distinguishable from other users, because you won't believe the same
461 [[DirAuthorityFallbackRate]] **DirAuthorityFallbackRate** __NUM__::
462 When configured to use both directory authorities and fallback
463 directories, the directory authorities also work as fallbacks. They are
464 chosen with their regular weights, multiplied by this number, which
465 should be 1.0 or less. (Default: 1.0)
467 [[AlternateDirAuthority]] **AlternateDirAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__ +
469 [[AlternateBridgeAuthority]] **AlternateBridgeAuthority** [__nickname__] [**flags**] __address__:__port__ __ fingerprint__::
470 These options behave as DirAuthority, but they replace fewer of the
471 default directory authorities. Using
472 AlternateDirAuthority replaces the default Tor directory authorities, but
473 leaves the default bridge authorities in
475 AlternateBridgeAuthority replaces the default bridge authority,
476 but leaves the directory authorities alone.
478 [[DisableAllSwap]] **DisableAllSwap** **0**|**1**::
479 If set to 1, Tor will attempt to lock all current and future memory pages,
480 so that memory cannot be paged out. Windows, OS X and Solaris are currently
481 not supported. We believe that this feature works on modern Gnu/Linux
482 distributions, and that it should work on *BSD systems (untested). This
483 option requires that you start your Tor as root, and you should use the
484 **User** option to properly reduce Tor's privileges.
485 Can not be changed while tor is running. (Default: 0)
487 [[DisableDebuggerAttachment]] **DisableDebuggerAttachment** **0**|**1**::
488 If set to 1, Tor will attempt to prevent basic debugging attachment attempts
489 by other processes. This may also keep Tor from generating core files if
490 it crashes. It has no impact for users who wish to attach if they
491 have CAP_SYS_PTRACE or if they are root. We believe that this feature
492 works on modern Gnu/Linux distributions, and that it may also work on *BSD
493 systems (untested). Some modern Gnu/Linux systems such as Ubuntu have the
494 kernel.yama.ptrace_scope sysctl and by default enable it as an attempt to
495 limit the PTRACE scope for all user processes by default. This feature will
496 attempt to limit the PTRACE scope for Tor specifically - it will not attempt
497 to alter the system wide ptrace scope as it may not even exist. If you wish
498 to attach to Tor with a debugger such as gdb or strace you will want to set
499 this to 0 for the duration of your debugging. Normal users should leave it
500 on. Disabling this option while Tor is running is prohibited. (Default: 1)
502 [[FetchDirInfoEarly]] **FetchDirInfoEarly** **0**|**1**::
503 If set to 1, Tor will always fetch directory information like other
504 directory caches, even if you don't meet the normal criteria for fetching
505 early. Normal users should leave it off. (Default: 0)
507 [[FetchDirInfoExtraEarly]] **FetchDirInfoExtraEarly** **0**|**1**::
508 If set to 1, Tor will fetch directory information before other directory
509 caches. It will attempt to download directory information closer to the
510 start of the consensus period. Normal users should leave it off.
513 [[FetchHidServDescriptors]] **FetchHidServDescriptors** **0**|**1**::
514 If set to 0, Tor will never fetch any hidden service descriptors from the
515 rendezvous directories. This option is only useful if you're using a Tor
516 controller that handles hidden service fetches for you. (Default: 1)
518 [[FetchServerDescriptors]] **FetchServerDescriptors** **0**|**1**::
519 If set to 0, Tor will never fetch any network status summaries or server
520 descriptors from the directory servers. This option is only useful if
521 you're using a Tor controller that handles directory fetches for you.
524 [[FetchUselessDescriptors]] **FetchUselessDescriptors** **0**|**1**::
525 If set to 1, Tor will fetch every consensus flavor, descriptor, and
526 certificate that it hears about. Otherwise, it will avoid fetching useless
527 descriptors: flavors that it is not using to build circuits, and authority
528 certificates it does not trust. This option is useful if you're using a
529 tor client with an external parser that uses a full consensus.
530 This option fetches all documents, **DirCache** fetches and serves
531 all documents. (Default: 0)
533 [[HTTPProxy]] **HTTPProxy** __host__[:__port__]::
534 Tor will make all its directory requests through this host:port (or host:80
535 if port is not specified), rather than connecting directly to any directory
536 servers. (DEPRECATED: As of 0.3.1.0-alpha you should use HTTPSProxy.)
538 [[HTTPProxyAuthenticator]] **HTTPProxyAuthenticator** __username:password__::
539 If defined, Tor will use this username:password for Basic HTTP proxy
540 authentication, as in RFC 2617. This is currently the only form of HTTP
541 proxy authentication that Tor supports; feel free to submit a patch if you
542 want it to support others. (DEPRECATED: As of 0.3.1.0-alpha you should use
543 HTTPSProxyAuthenticator.)
545 [[HTTPSProxy]] **HTTPSProxy** __host__[:__port__]::
546 Tor will make all its OR (SSL) connections through this host:port (or
547 host:443 if port is not specified), via HTTP CONNECT rather than connecting
548 directly to servers. You may want to set **FascistFirewall** to restrict
549 the set of ports you might try to connect to, if your HTTPS proxy only
550 allows connecting to certain ports.
552 [[HTTPSProxyAuthenticator]] **HTTPSProxyAuthenticator** __username:password__::
553 If defined, Tor will use this username:password for Basic HTTPS proxy
554 authentication, as in RFC 2617. This is currently the only form of HTTPS
555 proxy authentication that Tor supports; feel free to submit a patch if you
556 want it to support others.
558 [[Sandbox]] **Sandbox** **0**|**1**::
559 If set to 1, Tor will run securely through the use of a syscall sandbox.
560 Otherwise the sandbox will be disabled. The option is currently an
561 experimental feature. Can not be changed while tor is running.
563 When the Sandbox is 1, the following options can not be changed when tor
569 ExtORPortCookieAuthFile
571 ServerDNSResolvConfFile
572 Tor must remain in client or server mode (some changes to ClientOnly and
573 ORPort are not allowed).
576 [[Socks4Proxy]] **Socks4Proxy** __host__[:__port__]::
577 Tor will make all OR connections through the SOCKS 4 proxy at host:port
578 (or host:1080 if port is not specified).
580 [[Socks5Proxy]] **Socks5Proxy** __host__[:__port__]::
581 Tor will make all OR connections through the SOCKS 5 proxy at host:port
582 (or host:1080 if port is not specified).
584 [[Socks5ProxyUsername]] **Socks5ProxyUsername** __username__ +
586 [[Socks5ProxyPassword]] **Socks5ProxyPassword** __password__::
587 If defined, authenticate to the SOCKS 5 server using username and password
588 in accordance to RFC 1929. Both username and password must be between 1 and
591 [[SocksSocketsGroupWritable]] **SocksSocketsGroupWritable** **0**|**1**::
592 If this option is set to 0, don't allow the filesystem group to read and
593 write unix sockets (e.g. SocksSocket). If the option is set to 1, make
594 the SocksSocket socket readable and writable by the default GID. (Default: 0)
596 [[KeepalivePeriod]] **KeepalivePeriod** __NUM__::
597 To keep firewalls from expiring connections, send a padding keepalive cell
598 every NUM seconds on open connections that are in use. If the connection
599 has no open circuits, it will instead be closed after NUM seconds of
600 idleness. (Default: 5 minutes)
602 [[Log]] **Log** __minSeverity__[-__maxSeverity__] **stderr**|**stdout**|**syslog**::
603 Send all messages between __minSeverity__ and __maxSeverity__ to the standard
604 output stream, the standard error stream, or to the system log. (The
605 "syslog" value is only supported on Unix.) Recognized severity levels are
606 debug, info, notice, warn, and err. We advise using "notice" in most cases,
607 since anything more verbose may provide sensitive information to an
608 attacker who obtains the logs. If only one severity level is given, all
609 messages of that level or higher will be sent to the listed destination.
611 [[Log2]] **Log** __minSeverity__[-__maxSeverity__] **file** __FILENAME__::
612 As above, but send log messages to the listed filename. The
613 "Log" option may appear more than once in a configuration file.
614 Messages are sent to all the logs that match their severity
617 [[Log3]] **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **file** __FILENAME__ +
619 [[Log4]] **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **stderr**|**stdout**|**syslog**::
620 As above, but select messages by range of log severity __and__ by a
621 set of "logging domains". Each logging domain corresponds to an area of
622 functionality inside Tor. You can specify any number of severity ranges
623 for a single log statement, each of them prefixed by a comma-separated
624 list of logging domains. You can prefix a domain with $$~$$ to indicate
625 negation, and use * to indicate "all domains". If you specify a severity
626 range without a list of domains, it matches all domains. +
628 This is an advanced feature which is most useful for debugging one or two
629 of Tor's subsystems at a time. +
631 The currently recognized domains are: general, crypto, net, config, fs,
632 protocol, mm, http, app, control, circ, rend, bug, dir, dirserv, or, edge,
633 acct, hist, and handshake. Domain names are case-insensitive. +
635 For example, "`Log [handshake]debug [~net,~mm]info notice stdout`" sends
636 to stdout: all handshake messages of any severity, all info-and-higher
637 messages from domains other than networking and memory management, and all
638 messages of severity notice or higher.
640 [[LogMessageDomains]] **LogMessageDomains** **0**|**1**::
641 If 1, Tor includes message domains with each log message. Every log
642 message currently has at least one domain; most currently have exactly
643 one. This doesn't affect controller log messages. (Default: 0)
645 [[MaxUnparseableDescSizeToLog]] **MaxUnparseableDescSizeToLog** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**::
646 Unparseable descriptors (e.g. for votes, consensuses, routers) are logged
647 in separate files by hash, up to the specified size in total. Note that
648 only files logged during the lifetime of this Tor process count toward the
649 total; this is intended to be used to debug problems without opening live
650 servers to resource exhaustion attacks. (Default: 10 MB)
652 [[OutboundBindAddress]] **OutboundBindAddress** __IP__::
653 Make all outbound connections originate from the IP address specified. This
654 is only useful when you have multiple network interfaces, and you want all
655 of Tor's outgoing connections to use a single one. This option may
656 be used twice, once with an IPv4 address and once with an IPv6 address.
657 This setting will be ignored for connections to the loopback addresses
658 (127.0.0.0/8 and ::1).
660 [[OutboundBindAddressOR]] **OutboundBindAddressOR** __IP__::
661 Make all outbound non-exit (relay and other) connections
662 originate from the IP address specified. This option overrides
663 **OutboundBindAddress** for the same IP version. This option may
664 be used twice, once with an IPv4 address and once with an IPv6
665 address. This setting will be ignored for connections to the loopback
666 addresses (127.0.0.0/8 and ::1).
668 [[OutboundBindAddressExit]] **OutboundBindAddressExit** __IP__::
669 Make all outbound exit connections originate from the IP address
670 specified. This option overrides **OutboundBindAddress** for the
671 same IP version. This option may be used twice, once with an IPv4
672 address and once with an IPv6 address. This setting will be ignored
673 for connections to the loopback addresses (127.0.0.0/8 and ::1).
675 [[PidFile]] **PidFile** __FILE__::
676 On startup, write our PID to FILE. On clean shutdown, remove
677 FILE. Can not be changed while tor is running.
679 [[ProtocolWarnings]] **ProtocolWarnings** **0**|**1**::
680 If 1, Tor will log with severity \'warn' various cases of other parties not
681 following the Tor specification. Otherwise, they are logged with severity
682 \'info'. (Default: 0)
684 [[RunAsDaemon]] **RunAsDaemon** **0**|**1**::
685 If 1, Tor forks and daemonizes to the background. This option has no effect
686 on Windows; instead you should use the --service command-line option.
687 Can not be changed while tor is running.
690 [[LogTimeGranularity]] **LogTimeGranularity** __NUM__::
691 Set the resolution of timestamps in Tor's logs to NUM milliseconds.
692 NUM must be positive and either a divisor or a multiple of 1 second.
693 Note that this option only controls the granularity written by Tor to
694 a file or console log. Tor does not (for example) "batch up" log
695 messages to affect times logged by a controller, times attached to
696 syslog messages, or the mtime fields on log files. (Default: 1 second)
698 [[TruncateLogFile]] **TruncateLogFile** **0**|**1**::
699 If 1, Tor will overwrite logs at startup and in response to a HUP signal,
700 instead of appending to them. (Default: 0)
702 [[SyslogIdentityTag]] **SyslogIdentityTag** __tag__::
703 When logging to syslog, adds a tag to the syslog identity such that
704 log entries are marked with "Tor-__tag__". Can not be changed while tor is
705 running. (Default: none)
707 [[SafeLogging]] **SafeLogging** **0**|**1**|**relay**::
708 Tor can scrub potentially sensitive strings from log messages (e.g.
709 addresses) by replacing them with the string [scrubbed]. This way logs can
710 still be useful, but they don't leave behind personally identifying
711 information about what sites a user might have visited. +
713 If this option is set to 0, Tor will not perform any scrubbing, if it is
714 set to 1, all potentially sensitive strings are replaced. If it is set to
715 relay, all log messages generated when acting as a relay are sanitized, but
716 all messages generated when acting as a client are not. (Default: 1)
718 [[User]] **User** __Username__::
719 On startup, setuid to this user and setgid to their primary group.
720 Can not be changed while tor is running.
722 [[KeepBindCapabilities]] **KeepBindCapabilities** **0**|**1**|**auto**::
723 On Linux, when we are started as root and we switch our identity using
724 the **User** option, the **KeepBindCapabilities** option tells us whether to
725 try to retain our ability to bind to low ports. If this value is 1, we
726 try to keep the capability; if it is 0 we do not; and if it is **auto**,
727 we keep the capability only if we are configured to listen on a low port.
728 Can not be changed while tor is running.
731 [[HardwareAccel]] **HardwareAccel** **0**|**1**::
732 If non-zero, try to use built-in (static) crypto hardware acceleration when
733 available. Can not be changed while tor is running. (Default: 0)
735 [[AccelName]] **AccelName** __NAME__::
736 When using OpenSSL hardware crypto acceleration attempt to load the dynamic
737 engine of this name. This must be used for any dynamic hardware engine.
738 Names can be verified with the openssl engine command. Can not be changed
739 while tor is running.
741 [[AccelDir]] **AccelDir** __DIR__::
742 Specify this option if using dynamic hardware acceleration and the engine
743 implementation library resides somewhere other than the OpenSSL default.
744 Can not be changed while tor is running.
746 [[AvoidDiskWrites]] **AvoidDiskWrites** **0**|**1**::
747 If non-zero, try to write to disk less frequently than we would otherwise.
748 This is useful when running on flash memory or other media that support
749 only a limited number of writes. (Default: 0)
751 [[CircuitPriorityHalflife]] **CircuitPriorityHalflife** __NUM1__::
752 If this value is set, we override the default algorithm for choosing which
753 circuit's cell to deliver or relay next. When the value is 0, we
754 round-robin between the active circuits on a connection, delivering one
755 cell from each in turn. When the value is positive, we prefer delivering
756 cells from whichever connection has the lowest weighted cell count, where
757 cells are weighted exponentially according to the supplied
758 CircuitPriorityHalflife value (in seconds). If this option is not set at
759 all, we use the behavior recommended in the current consensus
760 networkstatus. This is an advanced option; you generally shouldn't have
761 to mess with it. (Default: not set)
763 [[CountPrivateBandwidth]] **CountPrivateBandwidth** **0**|**1**::
764 If this option is set, then Tor's rate-limiting applies not only to
765 remote connections, but also to connections to private addresses like
766 127.0.0.1 or 10.0.0.1. This is mostly useful for debugging
767 rate-limiting. (Default: 0)
769 [[ExtendByEd25519ID]] **ExtendByEd25519ID** **0**|**1**|**auto**::
770 If this option is set to 1, we always try to include a relay's Ed25519 ID
771 when telling the proceeding relay in a circuit to extend to it.
772 If this option is set to 0, we never include Ed25519 IDs when extending
773 circuits. If the option is set to "default", we obey a
774 parameter in the consensus document. (Default: auto)
779 The following options are useful only for clients (that is, if
780 **SocksPort**, **HTTPTunnelPort**, **TransPort**, **DNSPort**, or
781 **NATDPort** is non-zero):
783 [[Bridge]] **Bridge** [__transport__] __IP__:__ORPort__ [__fingerprint__]::
784 When set along with UseBridges, instructs Tor to use the relay at
785 "IP:ORPort" as a "bridge" relaying into the Tor network. If "fingerprint"
786 is provided (using the same format as for DirAuthority), we will verify that
787 the relay running at that location has the right fingerprint. We also use
788 fingerprint to look up the bridge descriptor at the bridge authority, if
789 it's provided and if UpdateBridgesFromAuthority is set too. +
791 If "transport" is provided, it must match a ClientTransportPlugin line. We
792 then use that pluggable transport's proxy to transfer data to the bridge,
793 rather than connecting to the bridge directly. Some transports use a
794 transport-specific method to work out the remote address to connect to.
795 These transports typically ignore the "IP:ORPort" specified in the bridge
798 Tor passes any "key=val" settings to the pluggable transport proxy as
799 per-connection arguments when connecting to the bridge. Consult
800 the documentation of the pluggable transport for details of what
801 arguments it supports.
803 [[LearnCircuitBuildTimeout]] **LearnCircuitBuildTimeout** **0**|**1**::
804 If 0, CircuitBuildTimeout adaptive learning is disabled. (Default: 1)
806 [[CircuitBuildTimeout]] **CircuitBuildTimeout** __NUM__::
808 Try for at most NUM seconds when building circuits. If the circuit isn't
809 open in that time, give up on it. If LearnCircuitBuildTimeout is 1, this
810 value serves as the initial value to use before a timeout is learned. If
811 LearnCircuitBuildTimeout is 0, this value is the only value used.
812 (Default: 60 seconds)
814 [[CircuitsAvailableTimeout]] **CircuitsAvailableTimeout** __NUM__::
815 Tor will attempt to keep at least one open, unused circuit available for
816 this amount of time. This option governs how long idle circuits are kept
817 open, as well as the amount of time Tor will keep a circuit open to each
818 of the recently used ports. This way when the Tor client is entirely
819 idle, it can expire all of its circuits, and then expire its TLS
820 connections. Note that the actual timeout value is uniformly randomized
821 from the specified value to twice that amount. (Default: 30 minutes;
824 [[CircuitStreamTimeout]] **CircuitStreamTimeout** __NUM__::
825 If non-zero, this option overrides our internal timeout schedule for how
826 many seconds until we detach a stream from a circuit and try a new circuit.
827 If your network is particularly slow, you might want to set this to a
828 number like 60. (Default: 0)
830 [[ClientOnly]] **ClientOnly** **0**|**1**::
831 If set to 1, Tor will not run as a relay or serve
832 directory requests, even if the ORPort, ExtORPort, or DirPort options are
833 set. (This config option is
834 mostly unnecessary: we added it back when we were considering having
835 Tor clients auto-promote themselves to being relays if they were stable
836 and fast enough. The current behavior is simply that Tor is a client
837 unless ORPort, ExtORPort, or DirPort are configured.) (Default: 0)
839 [[ConnectionPadding]] **ConnectionPadding** **0**|**1**|**auto**::
840 This option governs Tor's use of padding to defend against some forms of
841 traffic analysis. If it is set to 'auto', Tor will send padding only
842 if both the client and the relay support it. If it is set to 0, Tor will
843 not send any padding cells. If it is set to 1, Tor will still send padding
844 for client connections regardless of relay support. Only clients may set
845 this option. This option should be offered via the UI to mobile users
846 for use where bandwidth may be expensive.
849 [[ReducedConnectionPadding]] **ReducedConnectionPadding** **0**|**1**::
850 If set to 1, Tor will not not hold OR connections open for very long,
851 and will send less padding on these connections. Only clients may set
852 this option. This option should be offered via the UI to mobile users
853 for use where bandwidth may be expensive. (Default: 0)
855 [[ExcludeNodes]] **ExcludeNodes** __node__,__node__,__...__::
856 A list of identity fingerprints, country codes, and address
857 patterns of nodes to avoid when building a circuit. Country codes are
858 2-letter ISO3166 codes, and must
859 be wrapped in braces; fingerprints may be preceded by a dollar sign.
861 ExcludeNodes ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
863 By default, this option is treated as a preference that Tor is allowed
864 to override in order to keep working.
865 For example, if you try to connect to a hidden service,
866 but you have excluded all of the hidden service's introduction points,
867 Tor will connect to one of them anyway. If you do not want this
868 behavior, set the StrictNodes option (documented below). +
870 Note also that if you are a relay, this (and the other node selection
871 options below) only affects your own circuits that Tor builds for you.
872 Clients can still build circuits through you to any node. Controllers
873 can tell Tor to build circuits through any node. +
875 Country codes are case-insensitive. The code "\{??}" refers to nodes whose
876 country can't be identified. No country code, including \{??}, works if
877 no GeoIPFile can be loaded. See also the GeoIPExcludeUnknown option below.
880 [[ExcludeExitNodes]] **ExcludeExitNodes** __node__,__node__,__...__::
881 A list of identity fingerprints, country codes, and address
882 patterns of nodes to never use when picking an exit node---that is, a
883 node that delivers traffic for you *outside* the Tor network. Note that any
884 node listed in ExcludeNodes is automatically considered to be part of this
886 the **ExcludeNodes** option for more information on how to specify
887 nodes. See also the caveats on the "ExitNodes" option below.
889 [[GeoIPExcludeUnknown]] **GeoIPExcludeUnknown** **0**|**1**|**auto**::
890 If this option is set to 'auto', then whenever any country code is set in
891 ExcludeNodes or ExcludeExitNodes, all nodes with unknown country (\{??} and
892 possibly \{A1}) are treated as excluded as well. If this option is set to
893 '1', then all unknown countries are treated as excluded in ExcludeNodes
894 and ExcludeExitNodes. This option has no effect when a GeoIP file isn't
895 configured or can't be found. (Default: auto)
897 [[ExitNodes]] **ExitNodes** __node__,__node__,__...__::
898 A list of identity fingerprints, country codes, and address
899 patterns of nodes to use as exit node---that is, a
900 node that delivers traffic for you *outside* the Tor network. See
901 the **ExcludeNodes** option for more information on how to specify nodes. +
903 Note that if you list too few nodes here, or if you exclude too many exit
904 nodes with ExcludeExitNodes, you can degrade functionality. For example,
905 if none of the exits you list allows traffic on port 80 or 443, you won't
906 be able to browse the web. +
908 Note also that not every circuit is used to deliver traffic *outside* of
909 the Tor network. It is normal to see non-exit circuits (such as those
910 used to connect to hidden services, those that do directory fetches,
911 those used for relay reachability self-tests, and so on) that end
912 at a non-exit node. To
913 keep a node from being used entirely, see ExcludeNodes and StrictNodes. +
915 The ExcludeNodes option overrides this option: any node listed in both
916 ExitNodes and ExcludeNodes is treated as excluded. +
918 The .exit address notation, if enabled via AllowDotExit, overrides
921 [[EntryNodes]] **EntryNodes** __node__,__node__,__...__::
922 A list of identity fingerprints and country codes of nodes
923 to use for the first hop in your normal circuits.
924 Normal circuits include all
925 circuits except for direct connections to directory servers. The Bridge
926 option overrides this option; if you have configured bridges and
927 UseBridges is 1, the Bridges are used as your entry nodes. +
929 The ExcludeNodes option overrides this option: any node listed in both
930 EntryNodes and ExcludeNodes is treated as excluded. See
931 the **ExcludeNodes** option for more information on how to specify nodes.
933 [[StrictNodes]] **StrictNodes** **0**|**1**::
934 If StrictNodes is set to 1, Tor will treat solely the ExcludeNodes option
935 as a requirement to follow for all the circuits you generate, even if
936 doing so will break functionality for you (StrictNodes applies to neither
937 ExcludeExitNodes nor to ExitNodes). If StrictNodes is set to 0, Tor will
938 still try to avoid nodes in the ExcludeNodes list, but it will err on the
939 side of avoiding unexpected errors. Specifically, StrictNodes 0 tells Tor
940 that it is okay to use an excluded node when it is *necessary* to perform
941 relay reachability self-tests, connect to a hidden service, provide a
942 hidden service to a client, fulfill a .exit request, upload directory
943 information, or download directory information. (Default: 0)
945 [[FascistFirewall]] **FascistFirewall** **0**|**1**::
946 If 1, Tor will only create outgoing connections to ORs running on ports
947 that your firewall allows (defaults to 80 and 443; see **FirewallPorts**).
948 This will allow you to run Tor as a client behind a firewall with
949 restrictive policies, but will not allow you to run as a server behind such
950 a firewall. If you prefer more fine-grained control, use
951 ReachableAddresses instead.
953 [[FirewallPorts]] **FirewallPorts** __PORTS__::
954 A list of ports that your firewall allows you to connect to. Only used when
955 **FascistFirewall** is set. This option is deprecated; use ReachableAddresses
956 instead. (Default: 80, 443)
958 [[ReachableAddresses]] **ReachableAddresses** __ADDR__[/__MASK__][:__PORT__]...::
959 A comma-separated list of IP addresses and ports that your firewall allows
960 you to connect to. The format is as for the addresses in ExitPolicy, except
961 that "accept" is understood unless "reject" is explicitly provided. For
962 example, \'ReachableAddresses 99.0.0.0/8, reject 18.0.0.0/8:80, accept
963 \*:80' means that your firewall allows connections to everything inside net
964 99, rejects port 80 connections to net 18, and accepts connections to port
965 80 otherwise. (Default: \'accept \*:*'.)
967 [[ReachableDirAddresses]] **ReachableDirAddresses** __ADDR__[/__MASK__][:__PORT__]...::
968 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
969 these restrictions when fetching directory information, using standard HTTP
970 GET requests. If not set explicitly then the value of
971 **ReachableAddresses** is used. If **HTTPProxy** is set then these
972 connections will go through that proxy.
974 [[ReachableORAddresses]] **ReachableORAddresses** __ADDR__[/__MASK__][:__PORT__]...::
975 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
976 these restrictions when connecting to Onion Routers, using TLS/SSL. If not
977 set explicitly then the value of **ReachableAddresses** is used. If
978 **HTTPSProxy** is set then these connections will go through that proxy. +
980 The separation between **ReachableORAddresses** and
981 **ReachableDirAddresses** is only interesting when you are connecting
982 through proxies (see **HTTPProxy** and **HTTPSProxy**). Most proxies limit
983 TLS connections (which Tor uses to connect to Onion Routers) to port 443,
984 and some limit HTTP GET requests (which Tor uses for fetching directory
985 information) to port 80.
987 [[HidServAuth]] **HidServAuth** __onion-address__ __auth-cookie__ [__service-name__]::
988 Client authorization for a hidden service. Valid onion addresses contain 16
989 characters in a-z2-7 plus ".onion", and valid auth cookies contain 22
990 characters in A-Za-z0-9+/. The service name is only used for internal
991 purposes, e.g., for Tor controllers. This option may be used multiple times
992 for different hidden services. If a hidden service uses authorization and
993 this option is not set, the hidden service is not accessible. Hidden
994 services can be configured to require authorization using the
995 **HiddenServiceAuthorizeClient** option.
997 [[LongLivedPorts]] **LongLivedPorts** __PORTS__::
998 A list of ports for services that tend to have long-running connections
999 (e.g. chat and interactive shells). Circuits for streams that use these
1000 ports will contain only high-uptime nodes, to reduce the chance that a node
1001 will go down before the stream is finished. Note that the list is also
1002 honored for circuits (both client and service side) involving hidden
1003 services whose virtual port is in this list. (Default: 21, 22, 706,
1004 1863, 5050, 5190, 5222, 5223, 6523, 6667, 6697, 8300)
1006 [[MapAddress]] **MapAddress** __address__ __newaddress__::
1007 When a request for address arrives to Tor, it will transform to newaddress
1008 before processing it. For example, if you always want connections to
1009 www.example.com to exit via __torserver__ (where __torserver__ is the
1010 fingerprint of the server), use "MapAddress www.example.com
1011 www.example.com.torserver.exit". If the value is prefixed with a
1012 "\*.", matches an entire domain. For example, if you
1013 always want connections to example.com and any if its subdomains
1015 __torserver__ (where __torserver__ is the fingerprint of the server), use
1016 "MapAddress \*.example.com \*.example.com.torserver.exit". (Note the
1017 leading "*." in each part of the directive.) You can also redirect all
1018 subdomains of a domain to a single address. For example, "MapAddress
1019 *.example.com www.example.com". +
1023 1. When evaluating MapAddress expressions Tor stops when it hits the most
1024 recently added expression that matches the requested address. So if you
1025 have the following in your torrc, www.torproject.org will map to 1.1.1.1:
1027 MapAddress www.torproject.org 2.2.2.2
1028 MapAddress www.torproject.org 1.1.1.1
1030 2. Tor evaluates the MapAddress configuration until it finds no matches. So
1031 if you have the following in your torrc, www.torproject.org will map to
1034 MapAddress 1.1.1.1 2.2.2.2
1035 MapAddress www.torproject.org 1.1.1.1
1037 3. The following MapAddress expression is invalid (and will be
1038 ignored) because you cannot map from a specific address to a wildcard
1041 MapAddress www.torproject.org *.torproject.org.torserver.exit
1043 4. Using a wildcard to match only part of a string (as in *ample.com) is
1046 [[NewCircuitPeriod]] **NewCircuitPeriod** __NUM__::
1047 Every NUM seconds consider whether to build a new circuit. (Default: 30
1050 [[MaxCircuitDirtiness]] **MaxCircuitDirtiness** __NUM__::
1051 Feel free to reuse a circuit that was first used at most NUM seconds ago,
1052 but never attach a new stream to a circuit that is too old. For hidden
1053 services, this applies to the __last__ time a circuit was used, not the
1054 first. Circuits with streams constructed with SOCKS authentication via
1055 SocksPorts that have **KeepAliveIsolateSOCKSAuth** also remain alive
1056 for MaxCircuitDirtiness seconds after carrying the last such stream.
1057 (Default: 10 minutes)
1059 [[MaxClientCircuitsPending]] **MaxClientCircuitsPending** __NUM__::
1060 Do not allow more than NUM circuits to be pending at a time for handling
1061 client streams. A circuit is pending if we have begun constructing it,
1062 but it has not yet been completely constructed. (Default: 32)
1064 [[NodeFamily]] **NodeFamily** __node__,__node__,__...__::
1065 The Tor servers, defined by their identity fingerprints,
1066 constitute a "family" of similar or co-administered servers, so never use
1067 any two of them in the same circuit. Defining a NodeFamily is only needed
1068 when a server doesn't list the family itself (with MyFamily). This option
1069 can be used multiple times; each instance defines a separate family. In
1070 addition to nodes, you can also list IP address and ranges and country
1071 codes in {curly braces}. See the **ExcludeNodes** option for more
1072 information on how to specify nodes.
1074 [[EnforceDistinctSubnets]] **EnforceDistinctSubnets** **0**|**1**::
1075 If 1, Tor will not put two servers whose IP addresses are "too close" on
1076 the same circuit. Currently, two addresses are "too close" if they lie in
1077 the same /16 range. (Default: 1)
1079 [[SocksPort]] **SocksPort** \['address':]__port__|**unix:**__path__|**auto** [_flags_] [_isolation flags_]::
1080 Open this port to listen for connections from SOCKS-speaking
1081 applications. Set this to 0 if you don't want to allow application
1082 connections via SOCKS. Set it to "auto" to have Tor pick a port for
1083 you. This directive can be specified multiple times to bind
1084 to multiple addresses/ports. If a unix domain socket is used, you may
1085 quote the path using standard C escape sequences.
1088 NOTE: Although this option allows you to specify an IP address
1089 other than localhost, you should do so only with extreme caution.
1090 The SOCKS protocol is unencrypted and (as we use it)
1091 unauthenticated, so exposing it in this way could leak your
1092 information to anybody watching your network, and allow anybody
1093 to use your computer as an open proxy. +
1095 The _isolation flags_ arguments give Tor rules for which streams
1096 received on this SocksPort are allowed to share circuits with one
1097 another. Recognized isolation flags are:
1098 **IsolateClientAddr**;;
1099 Don't share circuits with streams from a different
1100 client address. (On by default and strongly recommended when
1101 supported; you can disable it with **NoIsolateClientAddr**.
1102 Unsupported and force-disabled when using Unix domain sockets.)
1103 **IsolateSOCKSAuth**;;
1104 Don't share circuits with streams for which different
1105 SOCKS authentication was provided. (For HTTPTunnelPort
1106 connections, this option looks at the Proxy-Authorization and
1107 X-Tor-Stream-Isolation headers. On by default;
1108 you can disable it with **NoIsolateSOCKSAuth**.)
1109 **IsolateClientProtocol**;;
1110 Don't share circuits with streams using a different protocol.
1111 (SOCKS 4, SOCKS 5, TransPort connections, NATDPort connections,
1112 and DNSPort requests are all considered to be different protocols.)
1113 **IsolateDestPort**;;
1114 Don't share circuits with streams targeting a different
1116 **IsolateDestAddr**;;
1117 Don't share circuits with streams targeting a different
1118 destination address.
1119 **KeepAliveIsolateSOCKSAuth**;;
1120 If **IsolateSOCKSAuth** is enabled, keep alive circuits while they have
1121 at least one stream with SOCKS authentication active. After such a circuit
1122 is idle for more than MaxCircuitDirtiness seconds, it can be closed.
1123 **SessionGroup=**__INT__;;
1124 If no other isolation rules would prevent it, allow streams
1125 on this port to share circuits with streams from every other
1126 port with the same session group. (By default, streams received
1127 on different SocksPorts, TransPorts, etc are always isolated from one
1128 another. This option overrides that behavior.)
1130 [[OtherSocksPortFlags]]::
1131 Other recognized __flags__ for a SocksPort are:
1133 Tell exits to not connect to IPv4 addresses in response to SOCKS
1134 requests on this connection.
1136 Tell exits to allow IPv6 addresses in response to SOCKS requests on
1137 this connection, so long as SOCKS5 is in use. (SOCKS4 can't handle
1140 Tells exits that, if a host has both an IPv4 and an IPv6 address,
1141 we would prefer to connect to it via IPv6. (IPv4 is the default.)
1143 Do not ask exits to resolve DNS addresses in SOCKS5 requests. Tor will
1144 connect to IPv4 addresses, IPv6 addresses (if IPv6Traffic is set) and
1146 **NoOnionTraffic**;;
1147 Do not connect to .onion addresses in SOCKS5 requests.
1148 **OnionTrafficOnly**;;
1149 Tell the tor client to only connect to .onion addresses in response to
1150 SOCKS5 requests on this connection. This is equivalent to NoDNSRequest,
1151 NoIPv4Traffic, NoIPv6Traffic. The corresponding NoOnionTrafficOnly
1152 flag is not supported.
1154 Tells the client to remember IPv4 DNS answers we receive from exit
1155 nodes via this connection. (On by default.)
1157 Tells the client to remember IPv6 DNS answers we receive from exit
1158 nodes via this connection.
1160 Unix domain sockets only: makes the socket get created as
1163 Unix domain sockets only: makes the socket get created as
1166 Tells the client to remember all DNS answers we receive from exit
1167 nodes via this connection.
1169 Tells the client to use any cached IPv4 DNS answers we have when making
1170 requests via this connection. (NOTE: This option, along UseIPv6Cache
1171 and UseDNSCache, can harm your anonymity, and probably
1172 won't help performance as much as you might expect. Use with care!)
1174 Tells the client to use any cached IPv6 DNS answers we have when making
1175 requests via this connection.
1177 Tells the client to use any cached DNS answers we have when making
1178 requests via this connection.
1179 **PreferIPv6Automap**;;
1180 When serving a hostname lookup request on this port that
1181 should get automapped (according to AutomapHostsOnResolve),
1182 if we could return either an IPv4 or an IPv6 answer, prefer
1183 an IPv6 answer. (On by default.)
1184 **PreferSOCKSNoAuth**;;
1185 Ordinarily, when an application offers both "username/password
1186 authentication" and "no authentication" to Tor via SOCKS5, Tor
1187 selects username/password authentication so that IsolateSOCKSAuth can
1188 work. This can confuse some applications, if they offer a
1189 username/password combination then get confused when asked for
1190 one. You can disable this behavior, so that Tor will select "No
1191 authentication" when IsolateSOCKSAuth is disabled, or when this
1194 [[SocksPortFlagsMisc]]::
1195 Flags are processed left to right. If flags conflict, the last flag on the
1196 line is used, and all earlier flags are ignored. No error is issued for
1199 [[SocksPolicy]] **SocksPolicy** __policy__,__policy__,__...__::
1200 Set an entrance policy for this server, to limit who can connect to the
1201 SocksPort and DNSPort ports. The policies have the same form as exit
1202 policies below, except that port specifiers are ignored. Any address
1203 not matched by some entry in the policy is accepted.
1205 [[SocksTimeout]] **SocksTimeout** __NUM__::
1206 Let a socks connection wait NUM seconds handshaking, and NUM seconds
1207 unattached waiting for an appropriate circuit, before we fail it. (Default:
1210 [[TokenBucketRefillInterval]] **TokenBucketRefillInterval** __NUM__ [**msec**|**second**]::
1211 Set the refill interval of Tor's token bucket to NUM milliseconds.
1212 NUM must be between 1 and 1000, inclusive. Note that the configured
1213 bandwidth limits are still expressed in bytes per second: this
1214 option only affects the frequency with which Tor checks to see whether
1215 previously exhausted connections may read again.
1216 Can not be changed while tor is running. (Default: 100 msec)
1218 [[TrackHostExits]] **TrackHostExits** __host__,__.domain__,__...__::
1219 For each value in the comma separated list, Tor will track recent
1220 connections to hosts that match this value and attempt to reuse the same
1221 exit node for each. If the value is prepended with a \'.\', it is treated as
1222 matching an entire domain. If one of the values is just a \'.', it means
1223 match everything. This option is useful if you frequently connect to sites
1224 that will expire all your authentication cookies (i.e. log you out) if
1225 your IP address changes. Note that this option does have the disadvantage
1226 of making it more clear that a given history is associated with a single
1227 user. However, most people who would wish to observe this will observe it
1228 through cookies or other protocol-specific means anyhow.
1230 [[TrackHostExitsExpire]] **TrackHostExitsExpire** __NUM__::
1231 Since exit servers go up and down, it is desirable to expire the
1232 association between host and exit server after NUM seconds. The default is
1233 1800 seconds (30 minutes).
1235 [[UpdateBridgesFromAuthority]] **UpdateBridgesFromAuthority** **0**|**1**::
1236 When set (along with UseBridges), Tor will try to fetch bridge descriptors
1237 from the configured bridge authorities when feasible. It will fall back to
1238 a direct request if the authority responds with a 404. (Default: 0)
1240 [[UseBridges]] **UseBridges** **0**|**1**::
1241 When set, Tor will fetch descriptors for each bridge listed in the "Bridge"
1242 config lines, and use these relays as both entry guards and directory
1243 guards. (Default: 0)
1245 [[UseEntryGuards]] **UseEntryGuards** **0**|**1**::
1246 If this option is set to 1, we pick a few long-term entry servers, and try
1247 to stick with them. This is desirable because constantly changing servers
1248 increases the odds that an adversary who owns some servers will observe a
1249 fraction of your paths. Entry Guards can not be used by Directory
1250 Authorities, Single Onion Services, and Tor2web clients. In these cases,
1251 the this option is ignored. (Default: 1)
1253 [[GuardfractionFile]] **GuardfractionFile** __FILENAME__::
1254 V3 authoritative directories only. Configures the location of the
1255 guardfraction file which contains information about how long relays
1256 have been guards. (Default: unset)
1258 [[UseGuardFraction]] **UseGuardFraction** **0**|**1**|**auto**::
1259 This torrc option specifies whether clients should use the
1260 guardfraction information found in the consensus during path
1261 selection. If it's set to 'auto', clients will do what the
1262 UseGuardFraction consensus parameter tells them to do. (Default: auto)
1264 [[NumEntryGuards]] **NumEntryGuards** __NUM__::
1265 If UseEntryGuards is set to 1, we will try to pick a total of NUM routers
1266 as long-term entries for our circuits. If NUM is 0, we try to learn the
1267 number from the guard-n-primary-guards-to-use consensus parameter, and
1268 default to 1 if the consensus parameter isn't set. (Default: 0)
1270 [[NumDirectoryGuards]] **NumDirectoryGuards** __NUM__::
1271 If UseEntryGuardsAsDirectoryGuards is enabled, we try to make sure we have
1272 at least NUM routers to use as directory guards. If this option is set to
1273 0, use the value from the guard-n-primary-dir-guards-to-use consensus
1274 parameter, and default to 3 if the consensus parameter isn't set.
1277 [[GuardLifetime]] **GuardLifetime** __N__ **days**|**weeks**|**months**::
1278 If nonzero, and UseEntryGuards is set, minimum time to keep a guard before
1279 picking a new one. If zero, we use the GuardLifetime parameter from the
1280 consensus directory. No value here may be less than 1 month or greater
1281 than 5 years; out-of-range values are clamped. (Default: 0)
1283 [[SafeSocks]] **SafeSocks** **0**|**1**::
1284 When this option is enabled, Tor will reject application connections that
1285 use unsafe variants of the socks protocol -- ones that only provide an IP
1286 address, meaning the application is doing a DNS resolve first.
1287 Specifically, these are socks4 and socks5 when not doing remote DNS.
1290 [[TestSocks]] **TestSocks** **0**|**1**::
1291 When this option is enabled, Tor will make a notice-level log entry for
1292 each connection to the Socks port indicating whether the request used a
1293 safe socks protocol or an unsafe one (see above entry on SafeSocks). This
1294 helps to determine whether an application using Tor is possibly leaking
1295 DNS requests. (Default: 0)
1297 [[VirtualAddrNetworkIPv4]] **VirtualAddrNetworkIPv4** __Address__/__bits__ +
1299 [[VirtualAddrNetworkIPv6]] **VirtualAddrNetworkIPv6** [__Address__]/__bits__::
1300 When Tor needs to assign a virtual (unused) address because of a MAPADDRESS
1301 command from the controller or the AutomapHostsOnResolve feature, Tor
1302 picks an unassigned address from this range. (Defaults:
1303 127.192.0.0/10 and [FE80::]/10 respectively.) +
1305 When providing proxy server service to a network of computers using a tool
1306 like dns-proxy-tor, change the IPv4 network to "10.192.0.0/10" or
1307 "172.16.0.0/12" and change the IPv6 network to "[FC00::]/7".
1308 The default **VirtualAddrNetwork** address ranges on a
1309 properly configured machine will route to the loopback or link-local
1310 interface. The maximum number of bits for the network prefix is set to 104
1311 for IPv6 and 16 for IPv4. However, a wider network - smaller prefix length
1312 - is preferable since it reduces the chances for an attacker to guess the
1313 used IP. For local use, no change to the default VirtualAddrNetwork setting
1316 [[AllowNonRFC953Hostnames]] **AllowNonRFC953Hostnames** **0**|**1**::
1317 When this option is disabled, Tor blocks hostnames containing illegal
1318 characters (like @ and :) rather than sending them to an exit node to be
1319 resolved. This helps trap accidental attempts to resolve URLs and so on.
1322 [[AllowDotExit]] **AllowDotExit** **0**|**1**::
1323 If enabled, we convert "www.google.com.foo.exit" addresses on the
1324 SocksPort/TransPort/NATDPort into "www.google.com" addresses that exit from
1325 the node "foo". Disabled by default since attacking websites and exit
1326 relays can use it to manipulate your path selection. (Default: 0)
1328 [[HTTPTunnelPort]] **HTTPTunnelPort** \['address':]__port__|**auto** [_isolation flags_]::
1329 Open this port to listen for proxy connections using the "HTTP CONNECT"
1330 protocol instead of SOCKS. Set this to 0
1331 0 if you don't want to allow "HTTP CONNECT" connections. Set the port
1332 to "auto" to have Tor pick a port for you. This directive can be
1333 specified multiple times to bind to multiple addresses/ports. See
1334 SOCKSPort for an explanation of isolation flags. (Default: 0)
1336 [[TransPort]] **TransPort** \['address':]__port__|**auto** [_isolation flags_]::
1337 Open this port to listen for transparent proxy connections. Set this to
1338 0 if you don't want to allow transparent proxy connections. Set the port
1339 to "auto" to have Tor pick a port for you. This directive can be
1340 specified multiple times to bind to multiple addresses/ports. See
1341 SOCKSPort for an explanation of isolation flags. +
1343 TransPort requires OS support for transparent proxies, such as BSDs' pf or
1344 Linux's IPTables. If you're planning to use Tor as a transparent proxy for
1345 a network, you'll want to examine and change VirtualAddrNetwork from the
1346 default setting. (Default: 0)
1348 [[TransProxyType]] **TransProxyType** **default**|**TPROXY**|**ipfw**|**pf-divert**::
1349 TransProxyType may only be enabled when there is transparent proxy listener
1352 Set this to "TPROXY" if you wish to be able to use the TPROXY Linux module
1353 to transparently proxy connections that are configured using the TransPort
1354 option. Detailed information on how to configure the TPROXY
1355 feature can be found in the Linux kernel source tree in the file
1356 Documentation/networking/tproxy.txt. +
1358 Set this option to "ipfw" to use the FreeBSD ipfw interface. +
1360 On *BSD operating systems when using pf, set this to "pf-divert" to take
1361 advantage of +divert-to+ rules, which do not modify the packets like
1362 +rdr-to+ rules do. Detailed information on how to configure pf to use
1363 +divert-to+ rules can be found in the pf.conf(5) manual page. On OpenBSD,
1364 +divert-to+ is available to use on versions greater than or equal to
1367 Set this to "default", or leave it unconfigured, to use regular IPTables
1368 on Linux, or to use pf +rdr-to+ rules on *BSD systems. +
1370 (Default: "default".)
1372 [[NATDPort]] **NATDPort** \['address':]__port__|**auto** [_isolation flags_]::
1373 Open this port to listen for connections from old versions of ipfw (as
1374 included in old versions of FreeBSD, etc) using the NATD protocol.
1375 Use 0 if you don't want to allow NATD connections. Set the port
1376 to "auto" to have Tor pick a port for you. This directive can be
1377 specified multiple times to bind to multiple addresses/ports. See
1378 SocksPort for an explanation of isolation flags. +
1380 This option is only for people who cannot use TransPort. (Default: 0)
1382 [[AutomapHostsOnResolve]] **AutomapHostsOnResolve** **0**|**1**::
1383 When this option is enabled, and we get a request to resolve an address
1384 that ends with one of the suffixes in **AutomapHostsSuffixes**, we map an
1385 unused virtual address to that address, and return the new virtual address.
1386 This is handy for making ".onion" addresses work with applications that
1387 resolve an address and then connect to it. (Default: 0)
1389 [[AutomapHostsSuffixes]] **AutomapHostsSuffixes** __SUFFIX__,__SUFFIX__,__...__::
1390 A comma-separated list of suffixes to use with **AutomapHostsOnResolve**.
1391 The "." suffix is equivalent to "all addresses." (Default: .exit,.onion).
1393 [[DNSPort]] **DNSPort** \['address':]__port__|**auto** [_isolation flags_]::
1394 If non-zero, open this port to listen for UDP DNS requests, and resolve
1395 them anonymously. This port only handles A, AAAA, and PTR requests---it
1396 doesn't handle arbitrary DNS request types. Set the port to "auto" to
1397 have Tor pick a port for
1398 you. This directive can be specified multiple times to bind to multiple
1399 addresses/ports. See SocksPort for an explanation of isolation
1402 [[ClientDNSRejectInternalAddresses]] **ClientDNSRejectInternalAddresses** **0**|**1**::
1403 If true, Tor does not believe any anonymously retrieved DNS answer that
1404 tells it that an address resolves to an internal address (like 127.0.0.1 or
1405 192.168.0.1). This option prevents certain browser-based attacks; don't
1406 turn it off unless you know what you're doing. (Default: 1)
1408 [[ClientRejectInternalAddresses]] **ClientRejectInternalAddresses** **0**|**1**::
1409 If true, Tor does not try to fulfill requests to connect to an internal
1410 address (like 127.0.0.1 or 192.168.0.1) __unless a exit node is
1411 specifically requested__ (for example, via a .exit hostname, or a
1412 controller request). If true, multicast DNS hostnames for machines on the
1413 local network (of the form *.local) are also rejected. (Default: 1)
1415 [[DownloadExtraInfo]] **DownloadExtraInfo** **0**|**1**::
1416 If true, Tor downloads and caches "extra-info" documents. These documents
1417 contain information about servers other than the information in their
1418 regular server descriptors. Tor does not use this information for anything
1419 itself; to save bandwidth, leave this option turned off. (Default: 0)
1421 [[WarnPlaintextPorts]] **WarnPlaintextPorts** __port__,__port__,__...__::
1422 Tells Tor to issue a warnings whenever the user tries to make an anonymous
1423 connection to one of these ports. This option is designed to alert users
1424 to services that risk sending passwords in the clear. (Default:
1427 [[RejectPlaintextPorts]] **RejectPlaintextPorts** __port__,__port__,__...__::
1428 Like WarnPlaintextPorts, but instead of warning about risky port uses, Tor
1429 will instead refuse to make the connection. (Default: None)
1431 [[OptimisticData]] **OptimisticData** **0**|**1**|**auto**::
1432 When this option is set, and Tor is using an exit node that supports
1433 the feature, it will try optimistically to send data to the exit node
1434 without waiting for the exit node to report whether the connection
1435 succeeded. This can save a round-trip time for protocols like HTTP
1436 where the client talks first. If OptimisticData is set to **auto**,
1437 Tor will look at the UseOptimisticData parameter in the networkstatus.
1440 [[Tor2webMode]] **Tor2webMode** **0**|**1**::
1441 When this option is set, Tor connects to hidden services
1442 **non-anonymously**. This option also disables client connections to
1443 non-hidden-service hostnames through Tor. It **must only** be used when
1444 running a tor2web Hidden Service web proxy.
1445 To enable this option the compile time flag --enable-tor2web-mode must be
1446 specified. Since Tor2webMode is non-anonymous, you can not run an
1447 anonymous Hidden Service on a tor version compiled with Tor2webMode.
1450 [[Tor2webRendezvousPoints]] **Tor2webRendezvousPoints** __node__,__node__,__...__::
1451 A list of identity fingerprints, nicknames, country codes and
1452 address patterns of nodes that are allowed to be used as RPs
1453 in HS circuits; any other nodes will not be used as RPs.
1455 Tor2webRendezvousPoints Fastyfasty, ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
1457 This feature can only be used if Tor2webMode is also enabled. +
1459 ExcludeNodes have higher priority than Tor2webRendezvousPoints,
1460 which means that nodes specified in ExcludeNodes will not be
1463 If no nodes in Tor2webRendezvousPoints are currently available for
1464 use, Tor will choose a random node when building HS circuits.
1466 [[UseMicrodescriptors]] **UseMicrodescriptors** **0**|**1**|**auto**::
1467 Microdescriptors are a smaller version of the information that Tor needs
1468 in order to build its circuits. Using microdescriptors makes Tor clients
1469 download less directory information, thus saving bandwidth. Directory
1470 caches need to fetch regular descriptors and microdescriptors, so this
1471 option doesn't save any bandwidth for them. If this option is set to
1472 "auto" (recommended) then it is on for all clients that do not set
1473 FetchUselessDescriptors. (Default: auto)
1475 [[PathBiasCircThreshold]] **PathBiasCircThreshold** __NUM__ +
1477 [[PathBiasNoticeRate]] **PathBiasNoticeRate** __NUM__ +
1479 [[PathBiasWarnRate]] **PathBiasWarnRate** __NUM__ +
1481 [[PathBiasExtremeRate]] **PathBiasExtremeRate** __NUM__ +
1483 [[PathBiasDropGuards]] **PathBiasDropGuards** __NUM__ +
1485 [[PathBiasScaleThreshold]] **PathBiasScaleThreshold** __NUM__::
1486 These options override the default behavior of Tor's (**currently
1487 experimental**) path bias detection algorithm. To try to find broken or
1488 misbehaving guard nodes, Tor looks for nodes where more than a certain
1489 fraction of circuits through that guard fail to get built. +
1491 The PathBiasCircThreshold option controls how many circuits we need to build
1492 through a guard before we make these checks. The PathBiasNoticeRate,
1493 PathBiasWarnRate and PathBiasExtremeRate options control what fraction of
1494 circuits must succeed through a guard so we won't write log messages.
1495 If less than PathBiasExtremeRate circuits succeed *and* PathBiasDropGuards
1496 is set to 1, we disable use of that guard. +
1498 When we have seen more than PathBiasScaleThreshold
1499 circuits through a guard, we scale our observations by 0.5 (governed by
1500 the consensus) so that new observations don't get swamped by old ones. +
1502 By default, or if a negative value is provided for one of these options,
1503 Tor uses reasonable defaults from the networkstatus consensus document.
1504 If no defaults are available there, these options default to 150, .70,
1505 .50, .30, 0, and 300 respectively.
1507 [[PathBiasUseThreshold]] **PathBiasUseThreshold** __NUM__ +
1509 [[PathBiasNoticeUseRate]] **PathBiasNoticeUseRate** __NUM__ +
1511 [[PathBiasExtremeUseRate]] **PathBiasExtremeUseRate** __NUM__ +
1513 [[PathBiasScaleUseThreshold]] **PathBiasScaleUseThreshold** __NUM__::
1514 Similar to the above options, these options override the default behavior
1515 of Tor's (**currently experimental**) path use bias detection algorithm. +
1517 Where as the path bias parameters govern thresholds for successfully
1518 building circuits, these four path use bias parameters govern thresholds
1519 only for circuit usage. Circuits which receive no stream usage
1520 are not counted by this detection algorithm. A used circuit is considered
1521 successful if it is capable of carrying streams or otherwise receiving
1522 well-formed responses to RELAY cells. +
1524 By default, or if a negative value is provided for one of these options,
1525 Tor uses reasonable defaults from the networkstatus consensus document.
1526 If no defaults are available there, these options default to 20, .80,
1527 .60, and 100, respectively.
1529 [[ClientUseIPv4]] **ClientUseIPv4** **0**|**1**::
1530 If this option is set to 0, Tor will avoid connecting to directory servers
1531 and entry nodes over IPv4. Note that clients with an IPv4
1532 address in a **Bridge**, proxy, or pluggable transport line will try
1533 connecting over IPv4 even if **ClientUseIPv4** is set to 0. (Default: 1)
1535 [[ClientUseIPv6]] **ClientUseIPv6** **0**|**1**::
1536 If this option is set to 1, Tor might connect to directory servers or
1537 entry nodes over IPv6. Note that clients configured with an IPv6 address
1538 in a **Bridge**, proxy, or pluggable transport line will try connecting
1539 over IPv6 even if **ClientUseIPv6** is set to 0. (Default: 0)
1541 [[ClientPreferIPv6DirPort]] **ClientPreferIPv6DirPort** **0**|**1**|**auto**::
1542 If this option is set to 1, Tor prefers a directory port with an IPv6
1543 address over one with IPv4, for direct connections, if a given directory
1544 server has both. (Tor also prefers an IPv6 DirPort if IPv4Client is set to
1545 0.) If this option is set to auto, clients prefer IPv4. Other things may
1546 influence the choice. This option breaks a tie to the favor of IPv6.
1549 [[ClientPreferIPv6ORPort]] **ClientPreferIPv6ORPort** **0**|**1**|**auto**::
1550 If this option is set to 1, Tor prefers an OR port with an IPv6
1551 address over one with IPv4 if a given entry node has both. (Tor also
1552 prefers an IPv6 ORPort if IPv4Client is set to 0.) If this option is set
1553 to auto, Tor bridge clients prefer the configured bridge address, and
1554 other clients prefer IPv4. Other things may influence the choice. This
1555 option breaks a tie to the favor of IPv6. (Default: auto)
1557 [[PathsNeededToBuildCircuits]] **PathsNeededToBuildCircuits** __NUM__::
1558 Tor clients don't build circuits for user traffic until they know
1559 about enough of the network so that they could potentially construct
1560 enough of the possible paths through the network. If this option
1561 is set to a fraction between 0.25 and 0.95, Tor won't build circuits
1562 until it has enough descriptors or microdescriptors to construct
1563 that fraction of possible paths. Note that setting this option too low
1564 can make your Tor client less anonymous, and setting it too high can
1565 prevent your Tor client from bootstrapping. If this option is negative,
1566 Tor will use a default value chosen by the directory authorities. If the
1567 directory authorities do not choose a value, Tor will default to 0.6.
1570 [[ClientBootstrapConsensusAuthorityDownloadSchedule]] **ClientBootstrapConsensusAuthorityDownloadSchedule** __N__,__N__,__...__::
1571 Schedule for when clients should download consensuses from authorities
1572 if they are bootstrapping (that is, they don't have a usable, reasonably
1573 live consensus). Only used by clients fetching from a list of fallback
1574 directory mirrors. This schedule is advanced by (potentially concurrent)
1575 connection attempts, unlike other schedules, which are advanced by
1576 connection failures. (Default: 10, 11, 3600, 10800, 25200, 54000,
1579 [[ClientBootstrapConsensusFallbackDownloadSchedule]] **ClientBootstrapConsensusFallbackDownloadSchedule** __N__,__N__,__...__::
1580 Schedule for when clients should download consensuses from fallback
1581 directory mirrors if they are bootstrapping (that is, they don't have a
1582 usable, reasonably live consensus). Only used by clients fetching from a
1583 list of fallback directory mirrors. This schedule is advanced by
1584 (potentially concurrent) connection attempts, unlike other schedules,
1585 which are advanced by connection failures. (Default: 0, 1, 4, 11, 3600,
1586 10800, 25200, 54000, 111600, 262800)
1588 [[ClientBootstrapConsensusAuthorityOnlyDownloadSchedule]] **ClientBootstrapConsensusAuthorityOnlyDownloadSchedule** __N__,__N__,__...__::
1589 Schedule for when clients should download consensuses from authorities
1590 if they are bootstrapping (that is, they don't have a usable, reasonably
1591 live consensus). Only used by clients which don't have or won't fetch
1592 from a list of fallback directory mirrors. This schedule is advanced by
1593 (potentially concurrent) connection attempts, unlike other schedules,
1594 which are advanced by connection failures. (Default: 0, 3, 7, 3600,
1595 10800, 25200, 54000, 111600, 262800)
1597 [[ClientBootstrapConsensusMaxDownloadTries]] **ClientBootstrapConsensusMaxDownloadTries** __NUM__::
1598 Try this many times to download a consensus while bootstrapping using
1599 fallback directory mirrors before giving up. (Default: 7)
1601 [[ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries]] **ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries** __NUM__::
1602 Try this many times to download a consensus while bootstrapping using
1603 authorities before giving up. (Default: 4)
1605 [[ClientBootstrapConsensusMaxInProgressTries]] **ClientBootstrapConsensusMaxInProgressTries** __NUM__::
1606 Try this many simultaneous connections to download a consensus before
1607 waiting for one to complete, timeout, or error out. (Default: 4)
1612 The following options are useful only for servers (that is, if ORPort
1615 [[Address]] **Address** __address__::
1616 The IP address or fully qualified domain name of this server (e.g.
1617 moria.mit.edu). You can leave this unset, and Tor will guess your IP
1618 address. This IP address is the one used to tell clients and other
1619 servers where to find your Tor server; it doesn't affect the IP that your
1620 Tor client binds to. To bind to a different address, use the
1621 *ListenAddress and OutboundBindAddress options.
1623 [[AssumeReachable]] **AssumeReachable** **0**|**1**::
1624 This option is used when bootstrapping a new Tor network. If set to 1,
1625 don't do self-reachability testing; just upload your server descriptor
1626 immediately. If **AuthoritativeDirectory** is also set, this option
1627 instructs the dirserver to bypass remote reachability testing too and list
1628 all connected servers as running.
1630 [[BridgeRelay]] **BridgeRelay** **0**|**1**::
1631 Sets the relay to act as a "bridge" with respect to relaying connections
1632 from bridge users to the Tor network. It mainly causes Tor to publish a
1633 server descriptor to the bridge database, rather than
1634 to the public directory authorities.
1636 [[ContactInfo]] **ContactInfo** __email_address__::
1637 Administrative contact information for this relay or bridge. This line
1638 can be used to contact you if your relay or bridge is misconfigured or
1639 something else goes wrong. Note that we archive and publish all
1640 descriptors containing these lines and that Google indexes them, so
1641 spammers might also collect them. You may want to obscure the fact
1642 that it's an email address and/or generate a new address for this
1645 [[ExitRelay]] **ExitRelay** **0**|**1**|**auto**::
1646 Tells Tor whether to run as an exit relay. If Tor is running as a
1647 non-bridge server, and ExitRelay is set to 1, then Tor allows traffic to
1648 exit according to the ExitPolicy option (or the default ExitPolicy if
1649 none is specified). +
1651 If ExitRelay is set to 0, no traffic is allowed to
1652 exit, and the ExitPolicy option is ignored. +
1654 If ExitRelay is set to "auto", then Tor behaves as if it were set to 1, but
1655 warns the user if this would cause traffic to exit. In a future version,
1656 the default value will be 0. (Default: auto)
1658 [[ExitPolicy]] **ExitPolicy** __policy__,__policy__,__...__::
1659 Set an exit policy for this server. Each policy is of the form
1660 "**accept[6]**|**reject[6]** __ADDR__[/__MASK__][:__PORT__]". If /__MASK__ is
1661 omitted then this policy just applies to the host given. Instead of giving
1662 a host or network you can also use "\*" to denote the universe (0.0.0.0/0
1663 and ::/128), or \*4 to denote all IPv4 addresses, and \*6 to denote all
1665 __PORT__ can be a single port number, an interval of ports
1666 "__FROM_PORT__-__TO_PORT__", or "\*". If __PORT__ is omitted, that means
1669 For example, "accept 18.7.22.69:\*,reject 18.0.0.0/8:\*,accept \*:\*" would
1670 reject any IPv4 traffic destined for MIT except for web.mit.edu, and accept
1671 any other IPv4 or IPv6 traffic. +
1673 Tor also allows IPv6 exit policy entries. For instance, "reject6 [FC00::]/7:\*"
1674 rejects all destinations that share 7 most significant bit prefix with
1675 address FC00::. Respectively, "accept6 [C000::]/3:\*" accepts all destinations
1676 that share 3 most significant bit prefix with address C000::. +
1678 accept6 and reject6 only produce IPv6 exit policy entries. Using an IPv4
1679 address with accept6 or reject6 is ignored and generates a warning.
1680 accept/reject allows either IPv4 or IPv6 addresses. Use \*4 as an IPv4
1681 wildcard address, and \*6 as an IPv6 wildcard address. accept/reject *
1682 expands to matching IPv4 and IPv6 wildcard address rules. +
1684 To specify all IPv4 and IPv6 internal and link-local networks (including
1685 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,
1686 172.16.0.0/12, [::]/8, [FC00::]/7, [FE80::]/10, [FEC0::]/10, [FF00::]/8,
1687 and [::]/127), you can use the "private" alias instead of an address.
1688 ("private" always produces rules for IPv4 and IPv6 addresses, even when
1689 used with accept6/reject6.) +
1691 Private addresses are rejected by default (at the beginning of your exit
1692 policy), along with any configured primary public IPv4 and IPv6 addresses.
1693 These private addresses are rejected unless you set the
1694 ExitPolicyRejectPrivate config option to 0. For example, once you've done
1695 that, you could allow HTTP to 127.0.0.1 and block all other connections to
1696 internal networks with "accept 127.0.0.1:80,reject private:\*", though that
1697 may also allow connections to your own computer that are addressed to its
1698 public (external) IP address. See RFC 1918 and RFC 3330 for more details
1699 about internal and reserved IP address space. See
1700 ExitPolicyRejectLocalInterfaces if you want to block every address on the
1701 relay, even those that aren't advertised in the descriptor. +
1703 This directive can be specified multiple times so you don't have to put it
1706 Policies are considered first to last, and the first match wins. If you
1707 want to allow the same ports on IPv4 and IPv6, write your rules using
1708 accept/reject \*. If you want to allow different ports on IPv4 and IPv6,
1709 write your IPv6 rules using accept6/reject6 \*6, and your IPv4 rules using
1710 accept/reject \*4. If you want to \_replace_ the default exit policy, end
1711 your exit policy with either a reject \*:* or an accept \*:*. Otherwise,
1712 you're \_augmenting_ (prepending to) the default exit policy. The default
1727 [[ExitPolicyDefault]]::
1728 Since the default exit policy uses accept/reject *, it applies to both
1729 IPv4 and IPv6 addresses.
1731 [[ExitPolicyRejectPrivate]] **ExitPolicyRejectPrivate** **0**|**1**::
1732 Reject all private (local) networks, along with the relay's advertised
1733 public IPv4 and IPv6 addresses, at the beginning of your exit policy.
1734 See above entry on ExitPolicy.
1737 [[ExitPolicyRejectLocalInterfaces]] **ExitPolicyRejectLocalInterfaces** **0**|**1**::
1738 Reject all IPv4 and IPv6 addresses that the relay knows about, at the
1739 beginning of your exit policy. This includes any OutboundBindAddress, the
1740 bind addresses of any port options, such as ControlPort or DNSPort, and any
1741 public IPv4 and IPv6 addresses on any interface on the relay. (If IPv6Exit
1742 is not set, all IPv6 addresses will be rejected anyway.)
1743 See above entry on ExitPolicy.
1744 This option is off by default, because it lists all public relay IP
1745 addresses in the ExitPolicy, even those relay operators might prefer not
1749 [[IPv6Exit]] **IPv6Exit** **0**|**1**::
1750 If set, and we are an exit node, allow clients to use us for IPv6
1751 traffic. (Default: 0)
1753 [[MaxOnionQueueDelay]] **MaxOnionQueueDelay** __NUM__ [**msec**|**second**]::
1754 If we have more onionskins queued for processing than we can process in
1755 this amount of time, reject new ones. (Default: 1750 msec)
1757 [[MyFamily]] **MyFamily** __fingerprint__,__fingerprint__,...::
1758 Declare that this Tor relay is controlled or administered by a group or
1759 organization identical or similar to that of the other relays, defined by
1760 their (possibly $-prefixed) identity fingerprints.
1761 This option can be repeated many times, for
1762 convenience in defining large families: all fingerprints in all MyFamily
1763 lines are merged into one list.
1764 When two relays both declare that they are in the
1765 same \'family', Tor clients will not use them in the same circuit. (Each
1766 relay only needs to list the other servers in its family; it doesn't need to
1767 list itself, but it won't hurt if it does.) Do not list any bridge relay as it would
1768 compromise its concealment. +
1770 When listing a node, it's better to list it by fingerprint than by
1771 nickname: fingerprints are more reliable.
1773 [[Nickname]] **Nickname** __name__::
1774 Set the server's nickname to \'name'. Nicknames must be between 1 and 19
1775 characters inclusive, and must contain only the characters [a-zA-Z0-9].
1777 [[NumCPUs]] **NumCPUs** __num__::
1778 How many processes to use at once for decrypting onionskins and other
1779 parallelizable operations. If this is set to 0, Tor will try to detect
1780 how many CPUs you have, defaulting to 1 if it can't tell. (Default: 0)
1782 [[ORPort]] **ORPort** \['address':]__PORT__|**auto** [_flags_]::
1783 Advertise this port to listen for connections from Tor clients and
1784 servers. This option is required to be a Tor server.
1785 Set it to "auto" to have Tor pick a port for you. Set it to 0 to not
1786 run an ORPort at all. This option can occur more than once. (Default: 0) +
1788 Tor recognizes these flags on each ORPort:
1790 By default, we bind to a port and tell our users about it. If
1791 NoAdvertise is specified, we don't advertise, but listen anyway. This
1792 can be useful if the port everybody will be connecting to (for
1793 example, one that's opened on our firewall) is somewhere else.
1795 By default, we bind to a port and tell our users about it. If
1796 NoListen is specified, we don't bind, but advertise anyway. This
1797 can be useful if something else (for example, a firewall's port
1798 forwarding configuration) is causing connections to reach us.
1800 If the address is absent, or resolves to both an IPv4 and an IPv6
1801 address, only listen to the IPv4 address.
1803 If the address is absent, or resolves to both an IPv4 and an IPv6
1804 address, only listen to the IPv6 address.
1806 [[ORPortFlagsExclusive]]::
1807 For obvious reasons, NoAdvertise and NoListen are mutually exclusive, and
1808 IPv4Only and IPv6Only are mutually exclusive.
1810 [[PortForwarding]] **PortForwarding** **0**|**1**::
1811 Attempt to automatically forward the DirPort and ORPort on a NAT router
1812 connecting this Tor server to the Internet. If set, Tor will try both
1813 NAT-PMP (common on Apple routers) and UPnP (common on routers from other
1814 manufacturers). (Default: 0)
1816 [[PortForwardingHelper]] **PortForwardingHelper** __filename__|__pathname__::
1817 If PortForwarding is set, use this executable to configure the forwarding.
1818 If set to a filename, the system path will be searched for the executable.
1819 If set to a path, only the specified path will be executed.
1820 (Default: tor-fw-helper)
1822 [[PublishServerDescriptor]] **PublishServerDescriptor** **0**|**1**|**v3**|**bridge**,**...**::
1823 This option specifies which descriptors Tor will publish when acting as
1825 choose multiple arguments, separated by commas. +
1827 If this option is set to 0, Tor will not publish its
1828 descriptors to any directories. (This is useful if you're testing
1829 out your server, or if you're using a Tor controller that handles
1830 directory publishing for you.) Otherwise, Tor will publish its
1831 descriptors of all type(s) specified. The default is "1", which
1832 means "if running as a relay or bridge, publish descriptors to the
1833 appropriate authorities". Other possibilities are "v3", meaning
1834 "publish as if you're a relay", and "bridge", meaning "publish as
1835 if you're a bridge".
1837 [[ShutdownWaitLength]] **ShutdownWaitLength** __NUM__::
1838 When we get a SIGINT and we're a server, we begin shutting down:
1839 we close listeners and start refusing new circuits. After **NUM**
1840 seconds, we exit. If we get a second SIGINT, we exit immediately.
1841 (Default: 30 seconds)
1843 [[SSLKeyLifetime]] **SSLKeyLifetime** __N__ **minutes**|**hours**|**days**|**weeks**::
1844 When creating a link certificate for our outermost SSL handshake,
1845 set its lifetime to this amount of time. If set to 0, Tor will choose
1846 some reasonable random defaults. (Default: 0)
1848 [[HeartbeatPeriod]] **HeartbeatPeriod** __N__ **minutes**|**hours**|**days**|**weeks**::
1849 Log a heartbeat message every **HeartbeatPeriod** seconds. This is
1850 a log level __notice__ message, designed to let you know your Tor
1851 server is still alive and doing useful things. Settings this
1852 to 0 will disable the heartbeat. Otherwise, it must be at least 30
1853 minutes. (Default: 6 hours)
1855 [[AccountingMax]] **AccountingMax** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
1856 Limits the max number of bytes sent and received within a set time period
1857 using a given calculation rule (see: AccountingStart, AccountingRule).
1858 Useful if you need to stay under a specific bandwidth. By default, the
1859 number used for calculation is the max of either the bytes sent or
1860 received. For example, with AccountingMax set to 1 GByte, a server
1861 could send 900 MBytes and receive 800 MBytes and continue running.
1862 It will only hibernate once one of the two reaches 1 GByte. This can
1863 be changed to use the sum of the both bytes received and sent by setting
1864 the AccountingRule option to "sum" (total bandwidth in/out). When the
1865 number of bytes remaining gets low, Tor will stop accepting new connections
1866 and circuits. When the number of bytes is exhausted, Tor will hibernate
1867 until some time in the next accounting period. To prevent all servers
1868 from waking at the same time, Tor will also wait until a random point
1869 in each period before waking up. If you have bandwidth cost issues,
1870 enabling hibernation is preferable to setting a low bandwidth, since
1871 it provides users with a collection of fast servers that are up some
1872 of the time, which is more useful than a set of slow servers that are
1875 [[AccountingRule]] **AccountingRule** **sum**|**max**|**in**|**out**::
1876 How we determine when our AccountingMax has been reached (when we
1877 should hibernate) during a time interval. Set to "max" to calculate
1878 using the higher of either the sent or received bytes (this is the
1879 default functionality). Set to "sum" to calculate using the sent
1880 plus received bytes. Set to "in" to calculate using only the
1881 received bytes. Set to "out" to calculate using only the sent bytes.
1884 [[AccountingStart]] **AccountingStart** **day**|**week**|**month** [__day__] __HH:MM__::
1885 Specify how long accounting periods last. If **month** is given, each
1886 accounting period runs from the time __HH:MM__ on the __dayth__ day of one
1887 month to the same day and time of the next. (The day must be between 1 and
1888 28.) If **week** is given, each accounting period runs from the time __HH:MM__
1889 of the __dayth__ day of one week to the same day and time of the next week,
1890 with Monday as day 1 and Sunday as day 7. If **day** is given, each
1891 accounting period runs from the time __HH:MM__ each day to the same time on
1892 the next day. All times are local, and given in 24-hour time. (Default:
1895 [[RefuseUnknownExits]] **RefuseUnknownExits** **0**|**1**|**auto**::
1896 Prevent nodes that don't appear in the consensus from exiting using this
1897 relay. If the option is 1, we always block exit attempts from such
1898 nodes; if it's 0, we never do, and if the option is "auto", then we do
1899 whatever the authorities suggest in the consensus (and block if the consensus
1900 is quiet on the issue). (Default: auto)
1902 [[ServerDNSResolvConfFile]] **ServerDNSResolvConfFile** __filename__::
1903 Overrides the default DNS configuration with the configuration in
1904 __filename__. The file format is the same as the standard Unix
1905 "**resolv.conf**" file (7). This option, like all other ServerDNS options,
1906 only affects name lookups that your server does on behalf of clients.
1907 (Defaults to use the system DNS configuration.)
1909 [[ServerDNSAllowBrokenConfig]] **ServerDNSAllowBrokenConfig** **0**|**1**::
1910 If this option is false, Tor exits immediately if there are problems
1911 parsing the system DNS configuration or connecting to nameservers.
1912 Otherwise, Tor continues to periodically retry the system nameservers until
1913 it eventually succeeds. (Default: 1)
1915 [[ServerDNSSearchDomains]] **ServerDNSSearchDomains** **0**|**1**::
1916 If set to 1, then we will search for addresses in the local search domain.
1917 For example, if this system is configured to believe it is in
1918 "example.com", and a client tries to connect to "www", the client will be
1919 connected to "www.example.com". This option only affects name lookups that
1920 your server does on behalf of clients. (Default: 0)
1922 [[ServerDNSDetectHijacking]] **ServerDNSDetectHijacking** **0**|**1**::
1923 When this option is set to 1, we will test periodically to determine
1924 whether our local nameservers have been configured to hijack failing DNS
1925 requests (usually to an advertising site). If they are, we will attempt to
1926 correct this. This option only affects name lookups that your server does
1927 on behalf of clients. (Default: 1)
1929 [[ServerDNSTestAddresses]] **ServerDNSTestAddresses** __address__,__address__,__...__::
1930 When we're detecting DNS hijacking, make sure that these __valid__ addresses
1931 aren't getting redirected. If they are, then our DNS is completely useless,
1932 and we'll reset our exit policy to "reject \*:*". This option only affects
1933 name lookups that your server does on behalf of clients. (Default:
1934 "www.google.com, www.mit.edu, www.yahoo.com, www.slashdot.org")
1936 [[ServerDNSAllowNonRFC953Hostnames]] **ServerDNSAllowNonRFC953Hostnames** **0**|**1**::
1937 When this option is disabled, Tor does not try to resolve hostnames
1938 containing illegal characters (like @ and :) rather than sending them to an
1939 exit node to be resolved. This helps trap accidental attempts to resolve
1940 URLs and so on. This option only affects name lookups that your server does
1941 on behalf of clients. (Default: 0)
1943 [[BridgeRecordUsageByCountry]] **BridgeRecordUsageByCountry** **0**|**1**::
1944 When this option is enabled and BridgeRelay is also enabled, and we have
1945 GeoIP data, Tor keeps a per-country count of how many client
1946 addresses have contacted it so that it can help the bridge authority guess
1947 which countries have blocked access to it. (Default: 1)
1949 [[ServerDNSRandomizeCase]] **ServerDNSRandomizeCase** **0**|**1**::
1950 When this option is set, Tor sets the case of each character randomly in
1951 outgoing DNS requests, and makes sure that the case matches in DNS replies.
1952 This so-called "0x20 hack" helps resist some types of DNS poisoning attack.
1953 For more information, see "Increased DNS Forgery Resistance through
1954 0x20-Bit Encoding". This option only affects name lookups that your server
1955 does on behalf of clients. (Default: 1)
1957 [[GeoIPFile]] **GeoIPFile** __filename__::
1958 A filename containing IPv4 GeoIP data, for use with by-country statistics.
1960 [[GeoIPv6File]] **GeoIPv6File** __filename__::
1961 A filename containing IPv6 GeoIP data, for use with by-country statistics.
1963 [[CellStatistics]] **CellStatistics** **0**|**1**::
1965 When this option is enabled, Tor collects statistics about cell
1966 processing (i.e. mean time a cell is spending in a queue, mean
1967 number of cells in a queue and mean number of processed cells per
1968 circuit) and writes them into disk every 24 hours. Onion router
1969 operators may use the statistics for performance monitoring.
1970 If ExtraInfoStatistics is enabled, it will published as part of
1971 extra-info document. (Default: 0)
1973 [[PaddingStatistics]] **PaddingStatistics** **0**|**1**::
1975 When this option is enabled, Tor collects statistics for padding cells
1976 sent and received by this relay, in addition to total cell counts.
1977 These statistics are rounded, and omitted if traffic is low. This
1978 information is important for load balancing decisions related to padding.
1981 [[DirReqStatistics]] **DirReqStatistics** **0**|**1**::
1982 Relays and bridges only.
1983 When this option is enabled, a Tor directory writes statistics on the
1984 number and response time of network status requests to disk every 24
1985 hours. Enables relay and bridge operators to monitor how much their
1986 server is being used by clients to learn about Tor network.
1987 If ExtraInfoStatistics is enabled, it will published as part of
1988 extra-info document. (Default: 1)
1990 [[EntryStatistics]] **EntryStatistics** **0**|**1**::
1992 When this option is enabled, Tor writes statistics on the number of
1993 directly connecting clients to disk every 24 hours. Enables relay
1994 operators to monitor how much inbound traffic that originates from
1995 Tor clients passes through their server to go further down the
1996 Tor network. If ExtraInfoStatistics is enabled, it will be published
1997 as part of extra-info document. (Default: 0)
1999 [[ExitPortStatistics]] **ExitPortStatistics** **0**|**1**::
2001 When this option is enabled, Tor writes statistics on the number of
2002 relayed bytes and opened stream per exit port to disk every 24 hours.
2003 Enables exit relay operators to measure and monitor amounts of traffic
2004 that leaves Tor network through their exit node. If ExtraInfoStatistics
2005 is enabled, it will be published as part of extra-info document.
2008 [[ConnDirectionStatistics]] **ConnDirectionStatistics** **0**|**1**::
2010 When this option is enabled, Tor writes statistics on the amounts of
2011 traffic it passes between itself and other relays to disk every 24
2012 hours. Enables relay operators to monitor how much their relay is
2013 being used as middle node in the circuit. If ExtraInfoStatistics is
2014 enabled, it will be published as part of extra-info document.
2017 [[HiddenServiceStatistics]] **HiddenServiceStatistics** **0**|**1**::
2019 When this option is enabled, a Tor relay writes obfuscated
2020 statistics on its role as hidden-service directory, introduction
2021 point, or rendezvous point to disk every 24 hours. If
2022 ExtraInfoStatistics is also enabled, these statistics are further
2023 published to the directory authorities. (Default: 1)
2025 [[ExtraInfoStatistics]] **ExtraInfoStatistics** **0**|**1**::
2026 When this option is enabled, Tor includes previously gathered statistics in
2027 its extra-info documents that it uploads to the directory authorities.
2030 [[ExtendAllowPrivateAddresses]] **ExtendAllowPrivateAddresses** **0**|**1**::
2031 When this option is enabled, Tor will connect to relays on localhost,
2032 RFC1918 addresses, and so on. In particular, Tor will make direct OR
2033 connections, and Tor routers allow EXTEND requests, to these private
2034 addresses. (Tor will always allow connections to bridges, proxies, and
2035 pluggable transports configured on private addresses.) Enabling this
2036 option can create security issues; you should probably leave it off.
2039 [[MaxMemInQueues]] **MaxMemInQueues** __N__ **bytes**|**KB**|**MB**|**GB**::
2040 This option configures a threshold above which Tor will assume that it
2041 needs to stop queueing or buffering data because it's about to run out of
2042 memory. If it hits this threshold, it will begin killing circuits until
2043 it has recovered at least 10% of this memory. Do not set this option too
2044 low, or your relay may be unreliable under load. This option only
2045 affects some queues, so the actual process size will be larger than
2046 this. If this option is set to 0, Tor will try to pick a reasonable
2047 default based on your system's physical memory. (Default: 0)
2049 [[DisableOOSCheck]] **DisableOOSCheck** **0**|**1**::
2050 This option disables the code that closes connections when Tor notices
2051 that it is running low on sockets. Right now, it is on by default,
2052 since the existing out-of-sockets mechanism tends to kill OR connections
2053 more than it should. (Default: 1)
2055 [[SigningKeyLifetime]] **SigningKeyLifetime** __N__ **days**|**weeks**|**months**::
2056 For how long should each Ed25519 signing key be valid? Tor uses a
2057 permanent master identity key that can be kept offline, and periodically
2058 generates new "signing" keys that it uses online. This option
2059 configures their lifetime.
2062 [[OfflineMasterKey]] **OfflineMasterKey** **0**|**1**::
2063 If non-zero, the Tor relay will never generate or load its master secret
2064 key. Instead, you'll have to use "tor --keygen" to manage the permanent
2065 ed25519 master identity key, as well as the corresponding temporary
2066 signing keys and certificates. (Default: 0)
2068 DIRECTORY SERVER OPTIONS
2069 ------------------------
2071 The following options are useful only for directory servers. (Relays with
2072 enough bandwidth automatically become directory servers; see DirCache for
2075 [[DirPortFrontPage]] **DirPortFrontPage** __FILENAME__::
2076 When this option is set, it takes an HTML file and publishes it as "/" on
2077 the DirPort. Now relay operators can provide a disclaimer without needing
2078 to set up a separate webserver. There's a sample disclaimer in
2079 contrib/operator-tools/tor-exit-notice.html.
2081 [[DirPort]] **DirPort** \['address':]__PORT__|**auto** [_flags_]::
2082 If this option is nonzero, advertise the directory service on this port.
2083 Set it to "auto" to have Tor pick a port for you. This option can occur
2084 more than once, but only one advertised DirPort is supported: all
2085 but one DirPort must have the **NoAdvertise** flag set. (Default: 0) +
2087 The same flags are supported here as are supported by ORPort.
2089 [[DirPolicy]] **DirPolicy** __policy__,__policy__,__...__::
2090 Set an entrance policy for this server, to limit who can connect to the
2091 directory ports. The policies have the same form as exit policies above,
2092 except that port specifiers are ignored. Any address not matched by
2093 some entry in the policy is accepted.
2095 [[DirCache]] **DirCache** **0**|**1**::
2096 When this option is set, Tor caches all current directory documents and
2097 accepts client requests for them. Setting DirPort is not required for this,
2098 because clients connect via the ORPort by default. Setting either DirPort
2099 or BridgeRelay and setting DirCache to 0 is not supported. (Default: 1)
2101 [[MaxConsensusAgeForDiffs]] **MaxConsensusAgeForDiffs** __N__ **minutes**|**hours**|**days**|**weeks**::
2102 When this option is nonzero, Tor caches will not try to generate
2103 consensus diffs for any consensus older than this amount of time.
2104 If this option is set to zero, Tor will pick a reasonable default from
2105 the current networkstatus document. You should not set this
2106 option unless your cache is severely low on disk space or CPU.
2107 If you need to set it, keeping it above 3 or 4 hours will help clients
2108 much more than setting it to zero.
2112 DIRECTORY AUTHORITY SERVER OPTIONS
2113 ----------------------------------
2115 The following options enable operation as a directory authority, and
2116 control how Tor behaves as a directory authority. You should not need
2117 to adjust any of them if you're running a regular relay or exit server
2118 on the public Tor network.
2120 [[AuthoritativeDirectory]] **AuthoritativeDirectory** **0**|**1**::
2121 When this option is set to 1, Tor operates as an authoritative directory
2122 server. Instead of caching the directory, it generates its own list of
2123 good servers, signs it, and sends that to the clients. Unless the clients
2124 already have you listed as a trusted directory, you probably do not want
2127 [[V3AuthoritativeDirectory]] **V3AuthoritativeDirectory** **0**|**1**::
2128 When this option is set in addition to **AuthoritativeDirectory**, Tor
2129 generates version 3 network statuses and serves descriptors, etc as
2130 described in dir-spec.txt file of https://spec.torproject.org/[torspec]
2131 (for Tor clients and servers running at least 0.2.0.x).
2133 [[VersioningAuthoritativeDirectory]] **VersioningAuthoritativeDirectory** **0**|**1**::
2134 When this option is set to 1, Tor adds information on which versions of
2135 Tor are still believed safe for use to the published directory. Each
2136 version 1 authority is automatically a versioning authority; version 2
2137 authorities provide this service optionally. See **RecommendedVersions**,
2138 **RecommendedClientVersions**, and **RecommendedServerVersions**.
2140 [[RecommendedVersions]] **RecommendedVersions** __STRING__::
2141 STRING is a comma-separated list of Tor versions currently believed to be
2142 safe. The list is included in each directory, and nodes which pull down the
2143 directory learn whether they need to upgrade. This option can appear
2144 multiple times: the values from multiple lines are spliced together. When
2145 this is set then **VersioningAuthoritativeDirectory** should be set too.
2147 [[RecommendedPackages]] **RecommendedPackages** __PACKAGENAME__ __VERSION__ __URL__ __DIGESTTYPE__**=**__DIGEST__ ::
2148 Adds "package" line to the directory authority's vote. This information
2149 is used to vote on the correct URL and digest for the released versions
2150 of different Tor-related packages, so that the consensus can certify
2151 them. This line may appear any number of times.
2153 [[RecommendedClientVersions]] **RecommendedClientVersions** __STRING__::
2154 STRING is a comma-separated list of Tor versions currently believed to be
2155 safe for clients to use. This information is included in version 2
2156 directories. If this is not set then the value of **RecommendedVersions**
2157 is used. When this is set then **VersioningAuthoritativeDirectory** should
2160 [[BridgeAuthoritativeDir]] **BridgeAuthoritativeDir** **0**|**1**::
2161 When this option is set in addition to **AuthoritativeDirectory**, Tor
2162 accepts and serves server descriptors, but it caches and serves the main
2163 networkstatus documents rather than generating its own. (Default: 0)
2165 [[MinUptimeHidServDirectoryV2]] **MinUptimeHidServDirectoryV2** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2166 Minimum uptime of a v2 hidden service directory to be accepted as such by
2167 authoritative directories. (Default: 25 hours)
2169 [[RecommendedServerVersions]] **RecommendedServerVersions** __STRING__::
2170 STRING is a comma-separated list of Tor versions currently believed to be
2171 safe for servers to use. This information is included in version 2
2172 directories. If this is not set then the value of **RecommendedVersions**
2173 is used. When this is set then **VersioningAuthoritativeDirectory** should
2176 [[ConsensusParams]] **ConsensusParams** __STRING__::
2177 STRING is a space-separated list of key=value pairs that Tor will include
2178 in the "params" line of its networkstatus vote.
2180 [[DirAllowPrivateAddresses]] **DirAllowPrivateAddresses** **0**|**1**::
2181 If set to 1, Tor will accept server descriptors with arbitrary "Address"
2182 elements. Otherwise, if the address is not an IP address or is a private IP
2183 address, it will reject the server descriptor. Additionally, Tor
2184 will allow exit policies for private networks to fulfill Exit flag
2185 requirements. (Default: 0)
2187 [[AuthDirBadExit]] **AuthDirBadExit** __AddressPattern...__::
2188 Authoritative directories only. A set of address patterns for servers that
2189 will be listed as bad exits in any network status document this authority
2190 publishes, if **AuthDirListBadExits** is set. +
2192 (The address pattern syntax here and in the options below
2193 is the same as for exit policies, except that you don't need to say
2194 "accept" or "reject", and ports are not needed.)
2196 [[AuthDirInvalid]] **AuthDirInvalid** __AddressPattern...__::
2197 Authoritative directories only. A set of address patterns for servers that
2198 will never be listed as "valid" in any network status document that this
2199 authority publishes.
2201 [[AuthDirReject]] **AuthDirReject** __AddressPattern__...::
2202 Authoritative directories only. A set of address patterns for servers that
2203 will never be listed at all in any network status document that this
2204 authority publishes, or accepted as an OR address in any descriptor
2205 submitted for publication by this authority.
2207 [[AuthDirBadExitCCs]] **AuthDirBadExitCCs** __CC__,... +
2209 [[AuthDirInvalidCCs]] **AuthDirInvalidCCs** __CC__,... +
2211 [[AuthDirRejectCCs]] **AuthDirRejectCCs** __CC__,...::
2212 Authoritative directories only. These options contain a comma-separated
2213 list of country codes such that any server in one of those country codes
2214 will be marked as a bad exit/invalid for use, or rejected
2217 [[AuthDirListBadExits]] **AuthDirListBadExits** **0**|**1**::
2218 Authoritative directories only. If set to 1, this directory has some
2219 opinion about which nodes are unsuitable as exit nodes. (Do not set this to
2220 1 unless you plan to list non-functioning exits as bad; otherwise, you are
2221 effectively voting in favor of every declared exit as an exit.)
2223 [[AuthDirMaxServersPerAddr]] **AuthDirMaxServersPerAddr** __NUM__::
2224 Authoritative directories only. The maximum number of servers that we will
2225 list as acceptable on a single IP address. Set this to "0" for "no limit".
2228 [[AuthDirFastGuarantee]] **AuthDirFastGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
2229 Authoritative directories only. If non-zero, always vote the
2230 Fast flag for any relay advertising this amount of capacity or
2231 more. (Default: 100 KBytes)
2233 [[AuthDirGuardBWGuarantee]] **AuthDirGuardBWGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
2234 Authoritative directories only. If non-zero, this advertised capacity
2235 or more is always sufficient to satisfy the bandwidth requirement
2236 for the Guard flag. (Default: 2 MBytes)
2238 [[AuthDirPinKeys]] **AuthDirPinKeys** **0**|**1**::
2239 Authoritative directories only. If non-zero, do not allow any relay to
2240 publish a descriptor if any other relay has reserved its <Ed25519,RSA>
2241 identity keypair. In all cases, Tor records every keypair it accepts
2242 in a journal if it is new, or if it differs from the most recently
2243 accepted pinning for one of the keys it contains. (Default: 1)
2245 [[AuthDirSharedRandomness]] **AuthDirSharedRandomness** **0**|**1**::
2246 Authoritative directories only. Switch for the shared random protocol.
2247 If zero, the authority won't participate in the protocol. If non-zero
2248 (default), the flag "shared-rand-participate" is added to the authority
2249 vote indicating participation in the protocol. (Default: 1)
2251 [[AuthDirTestEd25519LinkKeys]] **AuthDirTestEd25519LinkKeys** **0**|**1**::
2252 Authoritative directories only. If this option is set to 0, then we treat
2253 relays as "Running" if their RSA key is correct when we probe them,
2254 regardless of their Ed25519 key. We should only ever set this option to 0
2255 if there is some major bug in Ed25519 link authentication that causes us
2256 to label all the relays as not Running. (Default: 1)
2258 [[BridgePassword]] **BridgePassword** __Password__::
2259 If set, contains an HTTP authenticator that tells a bridge authority to
2260 serve all requested bridge information. Used by the (only partially
2261 implemented) "bridge community" design, where a community of bridge
2262 relay operators all use an alternate bridge directory authority,
2263 and their target user audience can periodically fetch the list of
2264 available community bridges to stay up-to-date. (Default: not set)
2266 [[V3AuthVotingInterval]] **V3AuthVotingInterval** __N__ **minutes**|**hours**::
2267 V3 authoritative directories only. Configures the server's preferred voting
2268 interval. Note that voting will __actually__ happen at an interval chosen
2269 by consensus from all the authorities' preferred intervals. This time
2270 SHOULD divide evenly into a day. (Default: 1 hour)
2272 [[V3AuthVoteDelay]] **V3AuthVoteDelay** __N__ **minutes**|**hours**::
2273 V3 authoritative directories only. Configures the server's preferred delay
2274 between publishing its vote and assuming it has all the votes from all the
2275 other authorities. Note that the actual time used is not the server's
2276 preferred time, but the consensus of all preferences. (Default: 5 minutes)
2278 [[V3AuthDistDelay]] **V3AuthDistDelay** __N__ **minutes**|**hours**::
2279 V3 authoritative directories only. Configures the server's preferred delay
2280 between publishing its consensus and signature and assuming it has all the
2281 signatures from all the other authorities. Note that the actual time used
2282 is not the server's preferred time, but the consensus of all preferences.
2283 (Default: 5 minutes)
2285 [[V3AuthNIntervalsValid]] **V3AuthNIntervalsValid** __NUM__::
2286 V3 authoritative directories only. Configures the number of VotingIntervals
2287 for which each consensus should be valid for. Choosing high numbers
2288 increases network partitioning risks; choosing low numbers increases
2289 directory traffic. Note that the actual number of intervals used is not the
2290 server's preferred number, but the consensus of all preferences. Must be at
2291 least 2. (Default: 3)
2293 [[V3BandwidthsFile]] **V3BandwidthsFile** __FILENAME__::
2294 V3 authoritative directories only. Configures the location of the
2295 bandwidth-authority generated file storing information on relays' measured
2296 bandwidth capacities. (Default: unset)
2298 [[V3AuthUseLegacyKey]] **V3AuthUseLegacyKey** **0**|**1**::
2299 If set, the directory authority will sign consensuses not only with its
2300 own signing key, but also with a "legacy" key and certificate with a
2301 different identity. This feature is used to migrate directory authority
2302 keys in the event of a compromise. (Default: 0)
2304 [[RephistTrackTime]] **RephistTrackTime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2305 Tells an authority, or other node tracking node reliability and history,
2306 that fine-grained information about nodes can be discarded when it hasn't
2307 changed for a given amount of time. (Default: 24 hours)
2309 [[AuthDirHasIPv6Connectivity]] **AuthDirHasIPv6Connectivity** **0**|**1**::
2310 Authoritative directories only. When set to 0, OR ports with an
2311 IPv6 address are being accepted without reachability testing.
2312 When set to 1, IPv6 OR ports are being tested just like IPv4 OR
2315 [[MinMeasuredBWsForAuthToIgnoreAdvertised]] **MinMeasuredBWsForAuthToIgnoreAdvertised** __N__::
2316 A total value, in abstract bandwidth units, describing how much
2317 measured total bandwidth an authority should have observed on the network
2318 before it will treat advertised bandwidths as wholly
2319 unreliable. (Default: 500)
2321 HIDDEN SERVICE OPTIONS
2322 ----------------------
2324 The following options are used to configure a hidden service.
2326 [[HiddenServiceDir]] **HiddenServiceDir** __DIRECTORY__::
2327 Store data files for a hidden service in DIRECTORY. Every hidden service
2328 must have a separate directory. You may use this option multiple times to
2329 specify multiple services. If DIRECTORY does not exist, Tor will create it.
2330 (Note: in current versions of Tor, if DIRECTORY is a relative path,
2331 it will be relative to the current
2332 working directory of Tor instance, not to its DataDirectory. Do not
2333 rely on this behavior; it is not guaranteed to remain the same in future
2336 [[HiddenServicePort]] **HiddenServicePort** __VIRTPORT__ [__TARGET__]::
2337 Configure a virtual port VIRTPORT for a hidden service. You may use this
2338 option multiple times; each time applies to the service using the most
2339 recent HiddenServiceDir. By default, this option maps the virtual port to
2340 the same port on 127.0.0.1 over TCP. You may override the target port,
2341 address, or both by specifying a target of addr, port, addr:port, or
2342 **unix:**__path__. (You can specify an IPv6 target as [addr]:port. Unix
2343 paths may be quoted, and may use standard C escapes.)
2344 You may also have multiple lines with the same VIRTPORT: when a user
2345 connects to that VIRTPORT, one of the TARGETs from those lines will be
2348 [[PublishHidServDescriptors]] **PublishHidServDescriptors** **0**|**1**::
2349 If set to 0, Tor will run any hidden services you configure, but it won't
2350 advertise them to the rendezvous directory. This option is only useful if
2351 you're using a Tor controller that handles hidserv publishing for you.
2354 [[HiddenServiceVersion]] **HiddenServiceVersion** __version__,__version__,__...__::
2355 A list of rendezvous service descriptor versions to publish for the hidden
2356 service. Currently, only version 2 is supported. (Default: 2)
2358 [[HiddenServiceAuthorizeClient]] **HiddenServiceAuthorizeClient** __auth-type__ __client-name__,__client-name__,__...__::
2359 If configured, the hidden service is accessible for authorized clients
2360 only. The auth-type can either be \'basic' for a general-purpose
2361 authorization protocol or \'stealth' for a less scalable protocol that also
2362 hides service activity from unauthorized clients. Only clients that are
2363 listed here are authorized to access the hidden service. Valid client names
2364 are 1 to 16 characters long and only use characters in A-Za-z0-9+-_ (no
2365 spaces). If this option is set, the hidden service is not accessible for
2366 clients without authorization any more. Generated authorization data can be
2367 found in the hostname file. Clients need to put this authorization data in
2368 their configuration file using **HidServAuth**.
2370 [[HiddenServiceAllowUnknownPorts]] **HiddenServiceAllowUnknownPorts** **0**|**1**::
2371 If set to 1, then connections to unrecognized ports do not cause the
2372 current hidden service to close rendezvous circuits. (Setting this to 0 is
2373 not an authorization mechanism; it is instead meant to be a mild
2374 inconvenience to port-scanners.) (Default: 0)
2376 [[HiddenServiceMaxStreams]] **HiddenServiceMaxStreams** __N__::
2377 The maximum number of simultaneous streams (connections) per rendezvous
2378 circuit. The maximum value allowed is 65535. (Setting this to 0 will allow
2379 an unlimited number of simultanous streams.) (Default: 0)
2381 [[HiddenServiceMaxStreamsCloseCircuit]] **HiddenServiceMaxStreamsCloseCircuit** **0**|**1**::
2382 If set to 1, then exceeding **HiddenServiceMaxStreams** will cause the
2383 offending rendezvous circuit to be torn down, as opposed to stream creation
2384 requests that exceed the limit being silently ignored. (Default: 0)
2386 [[RendPostPeriod]] **RendPostPeriod** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2387 Every time the specified period elapses, Tor uploads any rendezvous
2388 service descriptors to the directory servers. This information is also
2389 uploaded whenever it changes. Minimum value allowed is 10 minutes and
2390 maximum is 3.5 days. (Default: 1 hour)
2392 [[HiddenServiceDirGroupReadable]] **HiddenServiceDirGroupReadable** **0**|**1**::
2393 If this option is set to 1, allow the filesystem group to read the
2394 hidden service directory and hostname file. If the option is set to 0,
2395 only owner is able to read the hidden service directory. (Default: 0)
2396 Has no effect on Windows.
2398 [[HiddenServiceNumIntroductionPoints]] **HiddenServiceNumIntroductionPoints** __NUM__::
2399 Number of introduction points the hidden service will have. You can't
2400 have more than 10. (Default: 3)
2402 [[HiddenServiceSingleHopMode]] **HiddenServiceSingleHopMode** **0**|**1**::
2403 **Experimental - Non Anonymous** Hidden Services on a tor instance in
2404 HiddenServiceSingleHopMode make one-hop (direct) circuits between the onion
2405 service server, and the introduction and rendezvous points. (Onion service
2406 descriptors are still posted using 3-hop paths, to avoid onion service
2407 directories blocking the service.)
2408 This option makes every hidden service instance hosted by a tor instance a
2409 Single Onion Service. One-hop circuits make Single Onion servers easily
2410 locatable, but clients remain location-anonymous. However, the fact that a
2411 client is accessing a Single Onion rather than a Hidden Service may be
2412 statistically distinguishable. +
2414 **WARNING:** Once a hidden service directory has been used by a tor
2415 instance in HiddenServiceSingleHopMode, it can **NEVER** be used again for
2416 a hidden service. It is best practice to create a new hidden service
2417 directory, key, and address for each new Single Onion Service and Hidden
2418 Service. It is not possible to run Single Onion Services and Hidden
2419 Services from the same tor instance: they should be run on different
2420 servers with different IP addresses. +
2422 HiddenServiceSingleHopMode requires HiddenServiceNonAnonymousMode to be set
2423 to 1. Since a Single Onion service is non-anonymous, you can not configure
2424 a SOCKSPort on a tor instance that is running in
2425 **HiddenServiceSingleHopMode**. Can not be changed while tor is running.
2428 [[HiddenServiceNonAnonymousMode]] **HiddenServiceNonAnonymousMode** **0**|**1**::
2429 Makes hidden services non-anonymous on this tor instance. Allows the
2430 non-anonymous HiddenServiceSingleHopMode. Enables direct connections in the
2431 server-side hidden service protocol. If you are using this option,
2432 you need to disable all client-side services on your Tor instance,
2433 including setting SOCKSPort to "0". Can not be changed while tor is
2434 running. (Default: 0)
2436 TESTING NETWORK OPTIONS
2437 -----------------------
2439 The following options are used for running a testing Tor network.
2441 [[TestingTorNetwork]] **TestingTorNetwork** **0**|**1**::
2442 If set to 1, Tor adjusts default values of the configuration options below,
2443 so that it is easier to set up a testing Tor network. May only be set if
2444 non-default set of DirAuthorities is set. Cannot be unset while Tor is
2448 ServerDNSAllowBrokenConfig 1
2449 DirAllowPrivateAddresses 1
2450 EnforceDistinctSubnets 0
2452 AuthDirMaxServersPerAddr 0
2453 AuthDirMaxServersPerAuthAddr 0
2454 ClientBootstrapConsensusAuthorityDownloadSchedule 0, 2,
2455 4 (for 40 seconds), 8, 16, 32, 60
2456 ClientBootstrapConsensusFallbackDownloadSchedule 0, 1,
2457 4 (for 40 seconds), 8, 16, 32, 60
2458 ClientBootstrapConsensusAuthorityOnlyDownloadSchedule 0, 1,
2459 4 (for 40 seconds), 8, 16, 32, 60
2460 ClientBootstrapConsensusMaxDownloadTries 80
2461 ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries 80
2462 ClientDNSRejectInternalAddresses 0
2463 ClientRejectInternalAddresses 0
2464 CountPrivateBandwidth 1
2465 ExitPolicyRejectPrivate 0
2466 ExtendAllowPrivateAddresses 1
2467 V3AuthVotingInterval 5 minutes
2468 V3AuthVoteDelay 20 seconds
2469 V3AuthDistDelay 20 seconds
2470 MinUptimeHidServDirectoryV2 0 seconds
2471 TestingV3AuthInitialVotingInterval 5 minutes
2472 TestingV3AuthInitialVoteDelay 20 seconds
2473 TestingV3AuthInitialDistDelay 20 seconds
2474 TestingAuthDirTimeToLearnReachability 0 minutes
2475 TestingEstimatedDescriptorPropagationTime 0 minutes
2476 TestingServerDownloadSchedule 0, 0, 0, 5, 10, 15, 20, 30, 60
2477 TestingClientDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2478 TestingServerConsensusDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2479 TestingClientConsensusDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2480 TestingBridgeDownloadSchedule 60, 30, 30, 60
2481 TestingClientMaxIntervalWithoutRequest 5 seconds
2482 TestingDirConnectionMaxStall 30 seconds
2483 TestingConsensusMaxDownloadTries 80
2484 TestingDescriptorMaxDownloadTries 80
2485 TestingMicrodescMaxDownloadTries 80
2486 TestingCertMaxDownloadTries 80
2487 TestingEnableConnBwEvent 1
2488 TestingEnableCellStatsEvent 1
2489 TestingEnableTbEmptyEvent 1
2491 [[TestingV3AuthInitialVotingInterval]] **TestingV3AuthInitialVotingInterval** __N__ **minutes**|**hours**::
2492 Like V3AuthVotingInterval, but for initial voting interval before the first
2493 consensus has been created. Changing this requires that
2494 **TestingTorNetwork** is set. (Default: 30 minutes)
2496 [[TestingV3AuthInitialVoteDelay]] **TestingV3AuthInitialVoteDelay** __N__ **minutes**|**hours**::
2497 Like V3AuthVoteDelay, but for initial voting interval before
2498 the first consensus has been created. Changing this requires that
2499 **TestingTorNetwork** is set. (Default: 5 minutes)
2501 [[TestingV3AuthInitialDistDelay]] **TestingV3AuthInitialDistDelay** __N__ **minutes**|**hours**::
2502 Like V3AuthDistDelay, but for initial voting interval before
2503 the first consensus has been created. Changing this requires that
2504 **TestingTorNetwork** is set. (Default: 5 minutes)
2506 [[TestingV3AuthVotingStartOffset]] **TestingV3AuthVotingStartOffset** __N__ **seconds**|**minutes**|**hours**::
2507 Directory authorities offset voting start time by this much.
2508 Changing this requires that **TestingTorNetwork** is set. (Default: 0)
2510 [[TestingAuthDirTimeToLearnReachability]] **TestingAuthDirTimeToLearnReachability** __N__ **minutes**|**hours**::
2511 After starting as an authority, do not make claims about whether routers
2512 are Running until this much time has passed. Changing this requires
2513 that **TestingTorNetwork** is set. (Default: 30 minutes)
2515 [[TestingEstimatedDescriptorPropagationTime]] **TestingEstimatedDescriptorPropagationTime** __N__ **minutes**|**hours**::
2516 Clients try downloading server descriptors from directory caches after this
2517 time. Changing this requires that **TestingTorNetwork** is set. (Default:
2520 [[TestingMinFastFlagThreshold]] **TestingMinFastFlagThreshold** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
2521 Minimum value for the Fast flag. Overrides the ordinary minimum taken
2522 from the consensus when TestingTorNetwork is set. (Default: 0.)
2524 [[TestingServerDownloadSchedule]] **TestingServerDownloadSchedule** __N__,__N__,__...__::
2525 Schedule for when servers should download things in general. Changing this
2526 requires that **TestingTorNetwork** is set. (Default: 0, 0, 0, 60, 60, 120,
2527 300, 900, 2147483647)
2529 [[TestingClientDownloadSchedule]] **TestingClientDownloadSchedule** __N__,__N__,__...__::
2530 Schedule for when clients should download things in general. Changing this
2531 requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2534 [[TestingServerConsensusDownloadSchedule]] **TestingServerConsensusDownloadSchedule** __N__,__N__,__...__::
2535 Schedule for when servers should download consensuses. Changing this
2536 requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2537 1800, 1800, 1800, 1800, 1800, 3600, 7200)
2539 [[TestingClientConsensusDownloadSchedule]] **TestingClientConsensusDownloadSchedule** __N__,__N__,__...__::
2540 Schedule for when clients should download consensuses. Changing this
2541 requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2542 1800, 3600, 3600, 3600, 10800, 21600, 43200)
2544 [[TestingBridgeDownloadSchedule]] **TestingBridgeDownloadSchedule** __N__,__N__,__...__::
2545 Schedule for when clients should download bridge descriptors. Changing this
2546 requires that **TestingTorNetwork** is set. (Default: 3600, 900, 900, 3600)
2548 [[TestingClientMaxIntervalWithoutRequest]] **TestingClientMaxIntervalWithoutRequest** __N__ **seconds**|**minutes**::
2549 When directory clients have only a few descriptors to request, they batch
2550 them until they have more, or until this amount of time has passed.
2551 Changing this requires that **TestingTorNetwork** is set. (Default: 10
2554 [[TestingDirConnectionMaxStall]] **TestingDirConnectionMaxStall** __N__ **seconds**|**minutes**::
2555 Let a directory connection stall this long before expiring it.
2556 Changing this requires that **TestingTorNetwork** is set. (Default:
2559 [[TestingConsensusMaxDownloadTries]] **TestingConsensusMaxDownloadTries** __NUM__::
2560 Try this many times to download a consensus before giving up. Changing
2561 this requires that **TestingTorNetwork** is set. (Default: 8)
2563 [[TestingDescriptorMaxDownloadTries]] **TestingDescriptorMaxDownloadTries** __NUM__::
2564 Try this often to download a server descriptor before giving up.
2565 Changing this requires that **TestingTorNetwork** is set. (Default: 8)
2567 [[TestingMicrodescMaxDownloadTries]] **TestingMicrodescMaxDownloadTries** __NUM__::
2568 Try this often to download a microdesc descriptor before giving up.
2569 Changing this requires that **TestingTorNetwork** is set. (Default: 8)
2571 [[TestingCertMaxDownloadTries]] **TestingCertMaxDownloadTries** __NUM__::
2572 Try this often to download a v3 authority certificate before giving up.
2573 Changing this requires that **TestingTorNetwork** is set. (Default: 8)
2575 [[TestingDirAuthVoteExit]] **TestingDirAuthVoteExit** __node__,__node__,__...__::
2576 A list of identity fingerprints, country codes, and
2577 address patterns of nodes to vote Exit for regardless of their
2578 uptime, bandwidth, or exit policy. See the **ExcludeNodes**
2579 option for more information on how to specify nodes. +
2581 In order for this option to have any effect, **TestingTorNetwork**
2582 has to be set. See the **ExcludeNodes** option for more
2583 information on how to specify nodes.
2585 [[TestingDirAuthVoteExitIsStrict]] **TestingDirAuthVoteExitIsStrict** **0**|**1** ::
2586 If True (1), a node will never receive the Exit flag unless it is specified
2587 in the **TestingDirAuthVoteExit** list, regardless of its uptime, bandwidth,
2590 In order for this option to have any effect, **TestingTorNetwork**
2593 [[TestingDirAuthVoteGuard]] **TestingDirAuthVoteGuard** __node__,__node__,__...__::
2594 A list of identity fingerprints and country codes and
2595 address patterns of nodes to vote Guard for regardless of their
2596 uptime and bandwidth. See the **ExcludeNodes** option for more
2597 information on how to specify nodes. +
2599 In order for this option to have any effect, **TestingTorNetwork**
2602 [[TestingDirAuthVoteGuardIsStrict]] **TestingDirAuthVoteGuardIsStrict** **0**|**1** ::
2603 If True (1), a node will never receive the Guard flag unless it is specified
2604 in the **TestingDirAuthVoteGuard** list, regardless of its uptime and bandwidth. +
2606 In order for this option to have any effect, **TestingTorNetwork**
2609 [[TestingDirAuthVoteHSDir]] **TestingDirAuthVoteHSDir** __node__,__node__,__...__::
2610 A list of identity fingerprints and country codes and
2611 address patterns of nodes to vote HSDir for regardless of their
2612 uptime and DirPort. See the **ExcludeNodes** option for more
2613 information on how to specify nodes. +
2615 In order for this option to have any effect, **TestingTorNetwork**
2618 [[TestingDirAuthVoteHSDirIsStrict]] **TestingDirAuthVoteHSDirIsStrict** **0**|**1** ::
2619 If True (1), a node will never receive the HSDir flag unless it is specified
2620 in the **TestingDirAuthVoteHSDir** list, regardless of its uptime and DirPort. +
2622 In order for this option to have any effect, **TestingTorNetwork**
2625 [[TestingEnableConnBwEvent]] **TestingEnableConnBwEvent** **0**|**1**::
2626 If this option is set, then Tor controllers may register for CONN_BW
2627 events. Changing this requires that **TestingTorNetwork** is set.
2630 [[TestingEnableCellStatsEvent]] **TestingEnableCellStatsEvent** **0**|**1**::
2631 If this option is set, then Tor controllers may register for CELL_STATS
2632 events. Changing this requires that **TestingTorNetwork** is set.
2635 [[TestingEnableTbEmptyEvent]] **TestingEnableTbEmptyEvent** **0**|**1**::
2636 If this option is set, then Tor controllers may register for TB_EMPTY
2637 events. Changing this requires that **TestingTorNetwork** is set.
2640 [[TestingMinExitFlagThreshold]] **TestingMinExitFlagThreshold** __N__ **KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
2641 Sets a lower-bound for assigning an exit flag when running as an
2642 authority on a testing network. Overrides the usual default lower bound
2643 of 4 KB. (Default: 0)
2645 [[TestingLinkCertLifetime]] **TestingLinkCertLifetime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**|**months**::
2646 Overrides the default lifetime for the certificates used to authenticate
2647 our X509 link cert with our ed25519 signing key.
2650 [[TestingAuthKeyLifetime]] **TestingAuthKeyLifetime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**|**months**::
2651 Overrides the default lifetime for a signing Ed25519 TLS Link authentication
2655 [[TestingLinkKeySlop]] **TestingLinkKeySlop** __N__ **seconds**|**minutes**|**hours** +
2657 [[TestingAuthKeySlop]] **TestingAuthKeySlop** __N__ **seconds**|**minutes**|**hours** +
2659 [[TestingSigningKeySlop]] **TestingSigningKeySlop** __N__ **seconds**|**minutes**|**hours**::
2660 How early before the official expiration of a an Ed25519 signing key do
2661 we replace it and issue a new key?
2662 (Default: 3 hours for link and auth; 1 day for signing.)
2664 NON-PERSISTENT OPTIONS
2665 ----------------------
2667 These options are not saved to the torrc file by the "SAVECONF" controller
2668 command. Other options of this type are documented in control-spec.txt,
2669 section 5.4. End-users should mostly ignore them.
2671 [[UnderscorePorts]] **\_\_ControlPort**, **\_\_DirPort**, **\_\_DNSPort**, **\_\_ExtORPort**, **\_\_NATDPort**, **\_\_ORPort**, **\_\_SocksPort**, **\_\_TransPort**::
2672 These underscore-prefixed options are variants of the regular Port
2673 options. They behave the same, except they are not saved to the
2674 torrc file by the controller's SAVECONF command.
2680 Tor catches the following signals:
2682 [[SIGTERM]] **SIGTERM**::
2683 Tor will catch this, clean up and sync to disk if necessary, and exit.
2685 [[SIGINT]] **SIGINT**::
2686 Tor clients behave as with SIGTERM; but Tor servers will do a controlled
2687 slow shutdown, closing listeners and waiting 30 seconds before exiting.
2688 (The delay can be configured with the ShutdownWaitLength config option.)
2690 [[SIGHUP]] **SIGHUP**::
2691 The signal instructs Tor to reload its configuration (including closing and
2692 reopening logs), and kill and restart its helper processes if applicable.
2694 [[SIGUSR1]] **SIGUSR1**::
2695 Log statistics about current connections, past connections, and throughput.
2697 [[SIGUSR2]] **SIGUSR2**::
2698 Switch all logs to loglevel debug. You can go back to the old loglevels by
2701 [[SIGCHLD]] **SIGCHLD**::
2702 Tor receives this signal when one of its helper processes has exited, so it
2705 [[SIGPIPE]] **SIGPIPE**::
2706 Tor catches this signal and ignores it.
2708 [[SIGXFSZ]] **SIGXFSZ**::
2709 If this signal exists on your platform, Tor catches and ignores it.
2714 **@CONFDIR@/torrc**::
2715 The configuration file, which contains "option value" pairs.
2718 Fallback location for torrc, if @CONFDIR@/torrc is not found.
2720 **@LOCALSTATEDIR@/lib/tor/**::
2721 The tor process stores keys and other data here.
2723 __DataDirectory__**/cached-status/**::
2724 The most recently downloaded network status document for each authority.
2725 Each file holds one such document; the filenames are the hexadecimal
2726 identity key fingerprints of the directory authorities. Obsolete;
2729 __DataDirectory__**/cached-certs**::
2730 This file holds downloaded directory key certificates that are used to
2731 verify authenticity of documents generated by Tor directory authorities.
2733 __DataDirectory__**/cached-consensus** and/or **cached-microdesc-consensus**::
2734 The most recent consensus network status document we've downloaded.
2736 __DataDirectory__**/cached-descriptors** and **cached-descriptors.new**::
2737 These files hold downloaded router statuses. Some routers may appear more
2738 than once; if so, the most recently published descriptor is used. Lines
2739 beginning with @-signs are annotations that contain more information about
2740 a given router. The ".new" file is an append-only journal; when it gets
2741 too large, all entries are merged into a new cached-descriptors file.
2743 __DataDirectory__**/cached-extrainfo** and **cached-extrainfo.new**::
2744 As "cached-descriptors", but holds optionally-downloaded "extra-info"
2745 documents. Relays use these documents to send inessential information
2746 about statistics, bandwidth history, and network health to the
2747 authorities. They aren't fetched by default; see the DownloadExtraInfo
2748 option for more info.
2750 __DataDirectory__**/cached-microdescs** and **cached-microdescs.new**::
2751 These files hold downloaded microdescriptors. Lines beginning with
2752 @-signs are annotations that contain more information about a given
2753 router. The ".new" file is an append-only journal; when it gets too
2754 large, all entries are merged into a new cached-microdescs file.
2756 __DataDirectory__**/cached-routers** and **cached-routers.new**::
2757 Obsolete versions of cached-descriptors and cached-descriptors.new. When
2758 Tor can't find the newer files, it looks here instead.
2760 __DataDirectory__**/state**::
2761 A set of persistent key-value mappings. These are documented in
2762 the file. These include:
2763 - The current entry guards and their status.
2764 - The current bandwidth accounting values.
2765 - When the file was last written
2766 - What version of Tor generated the state file
2767 - A short history of bandwidth usage, as produced in the server
2770 __DataDirectory__**/sr-state**::
2771 Authority only. State file used to record information about the current
2772 status of the shared-random-value voting state.
2774 __DataDirectory__**/diff-cache**::
2775 Directory cache only. Holds older consensuses, and diffs from older
2776 consensuses to the most recent consensus of each type, compressed
2777 in various ways. Each file contains a set of key-value arguments
2778 decribing its contents, followed by a single NUL byte, followed by the
2781 __DataDirectory__**/bw_accounting**::
2782 Used to track bandwidth accounting values (when the current period starts
2783 and ends; how much has been read and written so far this period). This file
2784 is obsolete, and the data is now stored in the \'state' file instead.
2786 __DataDirectory__**/control_auth_cookie**::
2787 Used for cookie authentication with the controller. Location can be
2788 overridden by the CookieAuthFile config option. Regenerated on startup. See
2789 control-spec.txt in https://spec.torproject.org/[torspec] for details.
2790 Only used when cookie authentication is enabled.
2792 __DataDirectory__**/lock**::
2793 This file is used to prevent two Tor instances from using same data
2794 directory. If access to this file is locked, data directory is already
2797 __DataDirectory__**/key-pinning-journal**::
2798 Used by authorities. A line-based file that records mappings between
2799 RSA1024 identity keys and Ed25519 identity keys. Authorities enforce
2800 these mappings, so that once a relay has picked an Ed25519 key, stealing
2801 or factoring the RSA1024 key will no longer let an attacker impersonate
2804 __DataDirectory__**/keys/***::
2805 Only used by servers. Holds identity keys and onion keys.
2807 __DataDirectory__**/keys/authority_identity_key**::
2808 A v3 directory authority's master identity key, used to authenticate its
2809 signing key. Tor doesn't use this while it's running. The tor-gencert
2810 program uses this. If you're running an authority, you should keep this
2811 key offline, and not actually put it here.
2813 __DataDirectory__**/keys/authority_certificate**::
2814 A v3 directory authority's certificate, which authenticates the authority's
2815 current vote- and consensus-signing key using its master identity key.
2816 Only directory authorities use this file.
2818 __DataDirectory__**/keys/authority_signing_key**::
2819 A v3 directory authority's signing key, used to sign votes and consensuses.
2820 Only directory authorities use this file. Corresponds to the
2821 **authority_certificate** cert.
2823 __DataDirectory__**/keys/legacy_certificate**::
2824 As authority_certificate: used only when V3AuthUseLegacyKey is set.
2825 See documentation for V3AuthUseLegacyKey.
2827 __DataDirectory__**/keys/legacy_signing_key**::
2828 As authority_signing_key: used only when V3AuthUseLegacyKey is set.
2829 See documentation for V3AuthUseLegacyKey.
2831 __DataDirectory__**/keys/secret_id_key**::
2832 A relay's RSA1024 permanent identity key, including private and public
2833 components. Used to sign router descriptors, and to sign other keys.
2835 __DataDirectory__**/keys/ed25519_master_id_public_key**::
2836 The public part of a relay's Ed25519 permanent identity key.
2838 __DataDirectory__**/keys/ed25519_master_id_secret_key**::
2839 The private part of a relay's Ed25519 permanent identity key. This key
2840 is used to sign the medium-term ed25519 signing key. This file can be
2841 kept offline, or kept encrypted. If so, Tor will not be able to generate
2842 new signing keys itself; you'll need to use tor --keygen yourself to do
2845 __DataDirectory__**/keys/ed25519_signing_secret_key**::
2846 The private and public components of a relay's medium-term Ed25519 signing
2847 key. This key is authenticated by the Ed25519 master key, in turn
2848 authenticates other keys (and router descriptors).
2850 __DataDirectory__**/keys/ed25519_signing_cert**::
2851 The certificate which authenticates "ed25519_signing_secret_key" as
2852 having been signed by the Ed25519 master key.
2854 __DataDirectory__**/keys/secret_onion_key** and **secret_onion_key.old**::
2855 A relay's RSA1024 short-term onion key. Used to decrypt old-style ("TAP")
2856 circuit extension requests. The ".old" file holds the previously
2857 generated key, which the relay uses to handle any requests that were
2858 made by clients that didn't have the new one.
2860 __DataDirectory__**/keys/secret_onion_key_ntor** and **secret_onion_key_ntor.old**::
2861 A relay's Curve25519 short-term onion key. Used to handle modern ("ntor")
2862 circuit extension requests. The ".old" file holds the previously
2863 generated key, which the relay uses to handle any requests that were
2864 made by clients that didn't have the new one.
2866 __DataDirectory__**/fingerprint**::
2867 Only used by servers. Holds the fingerprint of the server's identity key.
2869 __DataDirectory__**/hashed-fingerprint**::
2870 Only used by bridges. Holds the hashed fingerprint of the bridge's
2871 identity key. (That is, the hash of the hash of the identity key.)
2873 __DataDirectory__**/v3-status-votes**::
2874 Only for v3 authoritative directory servers. This file contains
2875 status votes from all the authoritative directory servers.
2877 __DataDirectory__**/unverified-consensus**::
2878 This file contains a network consensus document that has been downloaded,
2879 but which we didn't have the right certificates to check yet.
2881 __DataDirectory__**/unverified-microdesc-consensus**::
2882 This file contains a microdescriptor-flavored network consensus document
2883 that has been downloaded, but which we didn't have the right certificates
2886 __DataDirectory__**/unparseable-desc**::
2887 Onion server descriptors that Tor was unable to parse are dumped to this
2888 file. Only used for debugging.
2890 __DataDirectory__**/router-stability**::
2891 Only used by authoritative directory servers. Tracks measurements for
2892 router mean-time-between-failures so that authorities have a good idea of
2893 how to set their Stable flags.
2895 __DataDirectory__**/stats/dirreq-stats**::
2896 Only used by directory caches and authorities. This file is used to
2897 collect directory request statistics.
2899 __DataDirectory__**/stats/entry-stats**::
2900 Only used by servers. This file is used to collect incoming connection
2901 statistics by Tor entry nodes.
2903 __DataDirectory__**/stats/bridge-stats**::
2904 Only used by servers. This file is used to collect incoming connection
2905 statistics by Tor bridges.
2907 __DataDirectory__**/stats/exit-stats**::
2908 Only used by servers. This file is used to collect outgoing connection
2909 statistics by Tor exit routers.
2911 __DataDirectory__**/stats/buffer-stats**::
2912 Only used by servers. This file is used to collect buffer usage
2915 __DataDirectory__**/stats/conn-stats**::
2916 Only used by servers. This file is used to collect approximate connection
2917 history (number of active connections over time).
2919 __DataDirectory__**/stats/hidserv-stats**::
2920 Only used by servers. This file is used to collect approximate counts
2921 of what fraction of the traffic is hidden service rendezvous traffic, and
2922 approximately how many hidden services the relay has seen.
2924 __DataDirectory__**/networkstatus-bridges**::
2925 Only used by authoritative bridge directories. Contains information
2926 about bridges that have self-reported themselves to the bridge
2929 __DataDirectory__**/approved-routers**::
2930 Authorities only. This file is used to configure which relays are
2931 known to be valid, invalid, and so forth.
2933 __HiddenServiceDirectory__**/hostname**::
2934 The <base32-encoded-fingerprint>.onion domain name for this hidden service.
2935 If the hidden service is restricted to authorized clients only, this file
2936 also contains authorization data for all clients.
2938 __HiddenServiceDirectory__**/private_key**::
2939 The private key for this hidden service.
2941 __HiddenServiceDirectory__**/client_keys**::
2942 Authorization data for a hidden service that is only accessible by
2945 __HiddenServiceDirectory__**/onion_service_non_anonymous**::
2946 This file is present if a hidden service key was created in
2947 **HiddenServiceNonAnonymousMode**.
2951 **torsocks**(1), **torify**(1) +
2953 **https://www.torproject.org/**
2955 **torspec: https://spec.torproject.org **
2960 Plenty, probably. Tor is still in development. Please report them at https://trac.torproject.org/.
2964 Roger Dingledine [arma at mit.edu], Nick Mathewson [nickm at alum.mit.edu].