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. It only works on Linux-based operating systems,
562 and only when Tor has been built with the libseccomp library. This option
563 can not be changed while tor is running.
565 When the Sandbox is 1, the following options can not be changed when tor
571 ExtORPortCookieAuthFile
573 ServerDNSResolvConfFile
574 Tor must remain in client or server mode (some changes to ClientOnly and
575 ORPort are not allowed).
578 [[Socks4Proxy]] **Socks4Proxy** __host__[:__port__]::
579 Tor will make all OR connections through the SOCKS 4 proxy at host:port
580 (or host:1080 if port is not specified).
582 [[Socks5Proxy]] **Socks5Proxy** __host__[:__port__]::
583 Tor will make all OR connections through the SOCKS 5 proxy at host:port
584 (or host:1080 if port is not specified).
586 [[Socks5ProxyUsername]] **Socks5ProxyUsername** __username__ +
588 [[Socks5ProxyPassword]] **Socks5ProxyPassword** __password__::
589 If defined, authenticate to the SOCKS 5 server using username and password
590 in accordance to RFC 1929. Both username and password must be between 1 and
593 [[SocksSocketsGroupWritable]] **SocksSocketsGroupWritable** **0**|**1**::
594 If this option is set to 0, don't allow the filesystem group to read and
595 write unix sockets (e.g. SocksSocket). If the option is set to 1, make
596 the SocksSocket socket readable and writable by the default GID. (Default: 0)
598 [[KeepalivePeriod]] **KeepalivePeriod** __NUM__::
599 To keep firewalls from expiring connections, send a padding keepalive cell
600 every NUM seconds on open connections that are in use. If the connection
601 has no open circuits, it will instead be closed after NUM seconds of
602 idleness. (Default: 5 minutes)
604 [[Log]] **Log** __minSeverity__[-__maxSeverity__] **stderr**|**stdout**|**syslog**::
605 Send all messages between __minSeverity__ and __maxSeverity__ to the standard
606 output stream, the standard error stream, or to the system log. (The
607 "syslog" value is only supported on Unix.) Recognized severity levels are
608 debug, info, notice, warn, and err. We advise using "notice" in most cases,
609 since anything more verbose may provide sensitive information to an
610 attacker who obtains the logs. If only one severity level is given, all
611 messages of that level or higher will be sent to the listed destination.
613 [[Log2]] **Log** __minSeverity__[-__maxSeverity__] **file** __FILENAME__::
614 As above, but send log messages to the listed filename. The
615 "Log" option may appear more than once in a configuration file.
616 Messages are sent to all the logs that match their severity
619 [[Log3]] **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **file** __FILENAME__ +
621 [[Log4]] **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **stderr**|**stdout**|**syslog**::
622 As above, but select messages by range of log severity __and__ by a
623 set of "logging domains". Each logging domain corresponds to an area of
624 functionality inside Tor. You can specify any number of severity ranges
625 for a single log statement, each of them prefixed by a comma-separated
626 list of logging domains. You can prefix a domain with $$~$$ to indicate
627 negation, and use * to indicate "all domains". If you specify a severity
628 range without a list of domains, it matches all domains. +
630 This is an advanced feature which is most useful for debugging one or two
631 of Tor's subsystems at a time. +
633 The currently recognized domains are: general, crypto, net, config, fs,
634 protocol, mm, http, app, control, circ, rend, bug, dir, dirserv, or, edge,
635 acct, hist, and handshake. Domain names are case-insensitive. +
637 For example, "`Log [handshake]debug [~net,~mm]info notice stdout`" sends
638 to stdout: all handshake messages of any severity, all info-and-higher
639 messages from domains other than networking and memory management, and all
640 messages of severity notice or higher.
642 [[LogMessageDomains]] **LogMessageDomains** **0**|**1**::
643 If 1, Tor includes message domains with each log message. Every log
644 message currently has at least one domain; most currently have exactly
645 one. This doesn't affect controller log messages. (Default: 0)
647 [[MaxUnparseableDescSizeToLog]] **MaxUnparseableDescSizeToLog** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**::
648 Unparseable descriptors (e.g. for votes, consensuses, routers) are logged
649 in separate files by hash, up to the specified size in total. Note that
650 only files logged during the lifetime of this Tor process count toward the
651 total; this is intended to be used to debug problems without opening live
652 servers to resource exhaustion attacks. (Default: 10 MB)
654 [[OutboundBindAddress]] **OutboundBindAddress** __IP__::
655 Make all outbound connections originate from the IP address specified. This
656 is only useful when you have multiple network interfaces, and you want all
657 of Tor's outgoing connections to use a single one. This option may
658 be used twice, once with an IPv4 address and once with an IPv6 address.
659 This setting will be ignored for connections to the loopback addresses
660 (127.0.0.0/8 and ::1).
662 [[OutboundBindAddressOR]] **OutboundBindAddressOR** __IP__::
663 Make all outbound non-exit (relay and other) connections
664 originate from the IP address specified. This option overrides
665 **OutboundBindAddress** for the same IP version. This option may
666 be used twice, once with an IPv4 address and once with an IPv6
667 address. This setting will be ignored for connections to the loopback
668 addresses (127.0.0.0/8 and ::1).
670 [[OutboundBindAddressExit]] **OutboundBindAddressExit** __IP__::
671 Make all outbound exit connections originate from the IP address
672 specified. This option overrides **OutboundBindAddress** for the
673 same IP version. This option may be used twice, once with an IPv4
674 address and once with an IPv6 address. This setting will be ignored
675 for connections to the loopback addresses (127.0.0.0/8 and ::1).
677 [[PidFile]] **PidFile** __FILE__::
678 On startup, write our PID to FILE. On clean shutdown, remove
679 FILE. Can not be changed while tor is running.
681 [[ProtocolWarnings]] **ProtocolWarnings** **0**|**1**::
682 If 1, Tor will log with severity \'warn' various cases of other parties not
683 following the Tor specification. Otherwise, they are logged with severity
684 \'info'. (Default: 0)
686 [[RunAsDaemon]] **RunAsDaemon** **0**|**1**::
687 If 1, Tor forks and daemonizes to the background. This option has no effect
688 on Windows; instead you should use the --service command-line option.
689 Can not be changed while tor is running.
692 [[LogTimeGranularity]] **LogTimeGranularity** __NUM__::
693 Set the resolution of timestamps in Tor's logs to NUM milliseconds.
694 NUM must be positive and either a divisor or a multiple of 1 second.
695 Note that this option only controls the granularity written by Tor to
696 a file or console log. Tor does not (for example) "batch up" log
697 messages to affect times logged by a controller, times attached to
698 syslog messages, or the mtime fields on log files. (Default: 1 second)
700 [[TruncateLogFile]] **TruncateLogFile** **0**|**1**::
701 If 1, Tor will overwrite logs at startup and in response to a HUP signal,
702 instead of appending to them. (Default: 0)
704 [[SyslogIdentityTag]] **SyslogIdentityTag** __tag__::
705 When logging to syslog, adds a tag to the syslog identity such that
706 log entries are marked with "Tor-__tag__". Can not be changed while tor is
707 running. (Default: none)
709 [[SafeLogging]] **SafeLogging** **0**|**1**|**relay**::
710 Tor can scrub potentially sensitive strings from log messages (e.g.
711 addresses) by replacing them with the string [scrubbed]. This way logs can
712 still be useful, but they don't leave behind personally identifying
713 information about what sites a user might have visited. +
715 If this option is set to 0, Tor will not perform any scrubbing, if it is
716 set to 1, all potentially sensitive strings are replaced. If it is set to
717 relay, all log messages generated when acting as a relay are sanitized, but
718 all messages generated when acting as a client are not. (Default: 1)
720 [[User]] **User** __Username__::
721 On startup, setuid to this user and setgid to their primary group.
722 Can not be changed while tor is running.
724 [[KeepBindCapabilities]] **KeepBindCapabilities** **0**|**1**|**auto**::
725 On Linux, when we are started as root and we switch our identity using
726 the **User** option, the **KeepBindCapabilities** option tells us whether to
727 try to retain our ability to bind to low ports. If this value is 1, we
728 try to keep the capability; if it is 0 we do not; and if it is **auto**,
729 we keep the capability only if we are configured to listen on a low port.
730 Can not be changed while tor is running.
733 [[HardwareAccel]] **HardwareAccel** **0**|**1**::
734 If non-zero, try to use built-in (static) crypto hardware acceleration when
735 available. Can not be changed while tor is running. (Default: 0)
737 [[AccelName]] **AccelName** __NAME__::
738 When using OpenSSL hardware crypto acceleration attempt to load the dynamic
739 engine of this name. This must be used for any dynamic hardware engine.
740 Names can be verified with the openssl engine command. Can not be changed
741 while tor is running.
743 [[AccelDir]] **AccelDir** __DIR__::
744 Specify this option if using dynamic hardware acceleration and the engine
745 implementation library resides somewhere other than the OpenSSL default.
746 Can not be changed while tor is running.
748 [[AvoidDiskWrites]] **AvoidDiskWrites** **0**|**1**::
749 If non-zero, try to write to disk less frequently than we would otherwise.
750 This is useful when running on flash memory or other media that support
751 only a limited number of writes. (Default: 0)
753 [[CircuitPriorityHalflife]] **CircuitPriorityHalflife** __NUM1__::
754 If this value is set, we override the default algorithm for choosing which
755 circuit's cell to deliver or relay next. When the value is 0, we
756 round-robin between the active circuits on a connection, delivering one
757 cell from each in turn. When the value is positive, we prefer delivering
758 cells from whichever connection has the lowest weighted cell count, where
759 cells are weighted exponentially according to the supplied
760 CircuitPriorityHalflife value (in seconds). If this option is not set at
761 all, we use the behavior recommended in the current consensus
762 networkstatus. This is an advanced option; you generally shouldn't have
763 to mess with it. (Default: not set)
765 [[CountPrivateBandwidth]] **CountPrivateBandwidth** **0**|**1**::
766 If this option is set, then Tor's rate-limiting applies not only to
767 remote connections, but also to connections to private addresses like
768 127.0.0.1 or 10.0.0.1. This is mostly useful for debugging
769 rate-limiting. (Default: 0)
771 [[ExtendByEd25519ID]] **ExtendByEd25519ID** **0**|**1**|**auto**::
772 If this option is set to 1, we always try to include a relay's Ed25519 ID
773 when telling the proceeding relay in a circuit to extend to it.
774 If this option is set to 0, we never include Ed25519 IDs when extending
775 circuits. If the option is set to "default", we obey a
776 parameter in the consensus document. (Default: auto)
778 [[NoExec]] **NoExec** **0**|**1**::
779 If this option is set to 1, then Tor will never launch another
780 executable, regardless of the settings of PortForwardingHelper,
781 ClientTransportPlugin, or ServerTransportPlugin. Once this
782 option has been set to 1, it cannot be set back to 0 without
783 restarting Tor. (Default: 0)
785 [[Schedulers]] **Schedulers** **KIST**|**KISTLite**|**Vanilla**::
786 Specify the scheduler type that tor should use to handle outbound data on
787 channels. This is an ordered list by priority which means that the first
788 value will be tried first and if unavailable, the second one is tried and
789 so on. It is possible to change thse values at runtime.
790 (Default: KIST,KISTLite,Vanilla)
792 The possible scheduler types are:
794 **KIST**: Kernel Informed Socket Transport. Tor will use the kernel tcp
795 information stack per-socket to make an informed decision on if it should
796 send or not the data. (Only available on Linux)
798 **KISTLite**: Same as KIST but without kernel support which means that tor
799 will use all the same mecanics as KIST but without the TCP information the
802 **Vanilla**: The scheduler that tor has always used that is do as much as
805 [[KISTSchedRunInterval]] **KISTSchedRunInterval** __NUM__ **msec**::
806 If KIST or KISTLite is used in Schedulers option, this control at which
807 interval the scheduler tick is. If the value is 0 msec, the value is taken
808 from the consensus if possible else it will fallback to the default 10
809 msec. Maximum possible value is 100 msec. (Default: 0 msec)
811 [[KISTSockBufSizeFactor]] **KISTSockBufSizeFactor** __NUM__::
812 If KIST is used in Schedulers, this is a multiplier of the per-socket
813 limit calculation of the KIST algorithm. (Default: 1.0)
818 The following options are useful only for clients (that is, if
819 **SocksPort**, **HTTPTunnelPort**, **TransPort**, **DNSPort**, or
820 **NATDPort** is non-zero):
822 [[Bridge]] **Bridge** [__transport__] __IP__:__ORPort__ [__fingerprint__]::
823 When set along with UseBridges, instructs Tor to use the relay at
824 "IP:ORPort" as a "bridge" relaying into the Tor network. If "fingerprint"
825 is provided (using the same format as for DirAuthority), we will verify that
826 the relay running at that location has the right fingerprint. We also use
827 fingerprint to look up the bridge descriptor at the bridge authority, if
828 it's provided and if UpdateBridgesFromAuthority is set too. +
830 If "transport" is provided, it must match a ClientTransportPlugin line. We
831 then use that pluggable transport's proxy to transfer data to the bridge,
832 rather than connecting to the bridge directly. Some transports use a
833 transport-specific method to work out the remote address to connect to.
834 These transports typically ignore the "IP:ORPort" specified in the bridge
837 Tor passes any "key=val" settings to the pluggable transport proxy as
838 per-connection arguments when connecting to the bridge. Consult
839 the documentation of the pluggable transport for details of what
840 arguments it supports.
842 [[LearnCircuitBuildTimeout]] **LearnCircuitBuildTimeout** **0**|**1**::
843 If 0, CircuitBuildTimeout adaptive learning is disabled. (Default: 1)
845 [[CircuitBuildTimeout]] **CircuitBuildTimeout** __NUM__::
847 Try for at most NUM seconds when building circuits. If the circuit isn't
848 open in that time, give up on it. If LearnCircuitBuildTimeout is 1, this
849 value serves as the initial value to use before a timeout is learned. If
850 LearnCircuitBuildTimeout is 0, this value is the only value used.
851 (Default: 60 seconds)
853 [[CircuitsAvailableTimeout]] **CircuitsAvailableTimeout** __NUM__::
854 Tor will attempt to keep at least one open, unused circuit available for
855 this amount of time. This option governs how long idle circuits are kept
856 open, as well as the amount of time Tor will keep a circuit open to each
857 of the recently used ports. This way when the Tor client is entirely
858 idle, it can expire all of its circuits, and then expire its TLS
859 connections. Note that the actual timeout value is uniformly randomized
860 from the specified value to twice that amount. (Default: 30 minutes;
863 [[CircuitStreamTimeout]] **CircuitStreamTimeout** __NUM__::
864 If non-zero, this option overrides our internal timeout schedule for how
865 many seconds until we detach a stream from a circuit and try a new circuit.
866 If your network is particularly slow, you might want to set this to a
867 number like 60. (Default: 0)
869 [[ClientOnly]] **ClientOnly** **0**|**1**::
870 If set to 1, Tor will not run as a relay or serve
871 directory requests, even if the ORPort, ExtORPort, or DirPort options are
872 set. (This config option is
873 mostly unnecessary: we added it back when we were considering having
874 Tor clients auto-promote themselves to being relays if they were stable
875 and fast enough. The current behavior is simply that Tor is a client
876 unless ORPort, ExtORPort, or DirPort are configured.) (Default: 0)
878 [[ConnectionPadding]] **ConnectionPadding** **0**|**1**|**auto**::
879 This option governs Tor's use of padding to defend against some forms of
880 traffic analysis. If it is set to 'auto', Tor will send padding only
881 if both the client and the relay support it. If it is set to 0, Tor will
882 not send any padding cells. If it is set to 1, Tor will still send padding
883 for client connections regardless of relay support. Only clients may set
884 this option. This option should be offered via the UI to mobile users
885 for use where bandwidth may be expensive.
888 [[ReducedConnectionPadding]] **ReducedConnectionPadding** **0**|**1**::
889 If set to 1, Tor will not not hold OR connections open for very long,
890 and will send less padding on these connections. Only clients may set
891 this option. This option should be offered via the UI to mobile users
892 for use where bandwidth may be expensive. (Default: 0)
894 [[ExcludeNodes]] **ExcludeNodes** __node__,__node__,__...__::
895 A list of identity fingerprints, country codes, and address
896 patterns of nodes to avoid when building a circuit. Country codes are
897 2-letter ISO3166 codes, and must
898 be wrapped in braces; fingerprints may be preceded by a dollar sign.
900 ExcludeNodes ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
902 By default, this option is treated as a preference that Tor is allowed
903 to override in order to keep working.
904 For example, if you try to connect to a hidden service,
905 but you have excluded all of the hidden service's introduction points,
906 Tor will connect to one of them anyway. If you do not want this
907 behavior, set the StrictNodes option (documented below). +
909 Note also that if you are a relay, this (and the other node selection
910 options below) only affects your own circuits that Tor builds for you.
911 Clients can still build circuits through you to any node. Controllers
912 can tell Tor to build circuits through any node. +
914 Country codes are case-insensitive. The code "\{??}" refers to nodes whose
915 country can't be identified. No country code, including \{??}, works if
916 no GeoIPFile can be loaded. See also the GeoIPExcludeUnknown option below.
919 [[ExcludeExitNodes]] **ExcludeExitNodes** __node__,__node__,__...__::
920 A list of identity fingerprints, country codes, and address
921 patterns of nodes to never use when picking an exit node---that is, a
922 node that delivers traffic for you *outside* the Tor network. Note that any
923 node listed in ExcludeNodes is automatically considered to be part of this
925 the **ExcludeNodes** option for more information on how to specify
926 nodes. See also the caveats on the "ExitNodes" option below.
928 [[GeoIPExcludeUnknown]] **GeoIPExcludeUnknown** **0**|**1**|**auto**::
929 If this option is set to 'auto', then whenever any country code is set in
930 ExcludeNodes or ExcludeExitNodes, all nodes with unknown country (\{??} and
931 possibly \{A1}) are treated as excluded as well. If this option is set to
932 '1', then all unknown countries are treated as excluded in ExcludeNodes
933 and ExcludeExitNodes. This option has no effect when a GeoIP file isn't
934 configured or can't be found. (Default: auto)
936 [[ExitNodes]] **ExitNodes** __node__,__node__,__...__::
937 A list of identity fingerprints, country codes, and address
938 patterns of nodes to use as exit node---that is, a
939 node that delivers traffic for you *outside* the Tor network. See
940 the **ExcludeNodes** option for more information on how to specify nodes. +
942 Note that if you list too few nodes here, or if you exclude too many exit
943 nodes with ExcludeExitNodes, you can degrade functionality. For example,
944 if none of the exits you list allows traffic on port 80 or 443, you won't
945 be able to browse the web. +
947 Note also that not every circuit is used to deliver traffic *outside* of
948 the Tor network. It is normal to see non-exit circuits (such as those
949 used to connect to hidden services, those that do directory fetches,
950 those used for relay reachability self-tests, and so on) that end
951 at a non-exit node. To
952 keep a node from being used entirely, see ExcludeNodes and StrictNodes. +
954 The ExcludeNodes option overrides this option: any node listed in both
955 ExitNodes and ExcludeNodes is treated as excluded. +
957 The .exit address notation, if enabled via MapAddress, overrides
960 [[EntryNodes]] **EntryNodes** __node__,__node__,__...__::
961 A list of identity fingerprints and country codes of nodes
962 to use for the first hop in your normal circuits.
963 Normal circuits include all
964 circuits except for direct connections to directory servers. The Bridge
965 option overrides this option; if you have configured bridges and
966 UseBridges is 1, the Bridges are used as your entry nodes. +
968 The ExcludeNodes option overrides this option: any node listed in both
969 EntryNodes and ExcludeNodes is treated as excluded. See
970 the **ExcludeNodes** option for more information on how to specify nodes.
972 [[StrictNodes]] **StrictNodes** **0**|**1**::
973 If StrictNodes is set to 1, Tor will treat solely the ExcludeNodes option
974 as a requirement to follow for all the circuits you generate, even if
975 doing so will break functionality for you (StrictNodes applies to neither
976 ExcludeExitNodes nor to ExitNodes). If StrictNodes is set to 0, Tor will
977 still try to avoid nodes in the ExcludeNodes list, but it will err on the
978 side of avoiding unexpected errors. Specifically, StrictNodes 0 tells Tor
979 that it is okay to use an excluded node when it is *necessary* to perform
980 relay reachability self-tests, connect to a hidden service, provide a
981 hidden service to a client, fulfill a .exit request, upload directory
982 information, or download directory information. (Default: 0)
984 [[FascistFirewall]] **FascistFirewall** **0**|**1**::
985 If 1, Tor will only create outgoing connections to ORs running on ports
986 that your firewall allows (defaults to 80 and 443; see **FirewallPorts**).
987 This will allow you to run Tor as a client behind a firewall with
988 restrictive policies, but will not allow you to run as a server behind such
989 a firewall. If you prefer more fine-grained control, use
990 ReachableAddresses instead.
992 [[FirewallPorts]] **FirewallPorts** __PORTS__::
993 A list of ports that your firewall allows you to connect to. Only used when
994 **FascistFirewall** is set. This option is deprecated; use ReachableAddresses
995 instead. (Default: 80, 443)
997 [[ReachableAddresses]] **ReachableAddresses** __ADDR__[/__MASK__][:__PORT__]...::
998 A comma-separated list of IP addresses and ports that your firewall allows
999 you to connect to. The format is as for the addresses in ExitPolicy, except
1000 that "accept" is understood unless "reject" is explicitly provided. For
1001 example, \'ReachableAddresses 99.0.0.0/8, reject 18.0.0.0/8:80, accept
1002 \*:80' means that your firewall allows connections to everything inside net
1003 99, rejects port 80 connections to net 18, and accepts connections to port
1004 80 otherwise. (Default: \'accept \*:*'.)
1006 [[ReachableDirAddresses]] **ReachableDirAddresses** __ADDR__[/__MASK__][:__PORT__]...::
1007 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
1008 these restrictions when fetching directory information, using standard HTTP
1009 GET requests. If not set explicitly then the value of
1010 **ReachableAddresses** is used. If **HTTPProxy** is set then these
1011 connections will go through that proxy. (DEPRECATED: This option has
1012 had no effect for some time.)
1014 [[ReachableORAddresses]] **ReachableORAddresses** __ADDR__[/__MASK__][:__PORT__]...::
1015 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
1016 these restrictions when connecting to Onion Routers, using TLS/SSL. If not
1017 set explicitly then the value of **ReachableAddresses** is used. If
1018 **HTTPSProxy** is set then these connections will go through that proxy. +
1020 The separation between **ReachableORAddresses** and
1021 **ReachableDirAddresses** is only interesting when you are connecting
1022 through proxies (see **HTTPProxy** and **HTTPSProxy**). Most proxies limit
1023 TLS connections (which Tor uses to connect to Onion Routers) to port 443,
1024 and some limit HTTP GET requests (which Tor uses for fetching directory
1025 information) to port 80.
1027 [[HidServAuth]] **HidServAuth** __onion-address__ __auth-cookie__ [__service-name__]::
1028 Client authorization for a hidden service. Valid onion addresses contain 16
1029 characters in a-z2-7 plus ".onion", and valid auth cookies contain 22
1030 characters in A-Za-z0-9+/. The service name is only used for internal
1031 purposes, e.g., for Tor controllers. This option may be used multiple times
1032 for different hidden services. If a hidden service uses authorization and
1033 this option is not set, the hidden service is not accessible. Hidden
1034 services can be configured to require authorization using the
1035 **HiddenServiceAuthorizeClient** option.
1037 [[LongLivedPorts]] **LongLivedPorts** __PORTS__::
1038 A list of ports for services that tend to have long-running connections
1039 (e.g. chat and interactive shells). Circuits for streams that use these
1040 ports will contain only high-uptime nodes, to reduce the chance that a node
1041 will go down before the stream is finished. Note that the list is also
1042 honored for circuits (both client and service side) involving hidden
1043 services whose virtual port is in this list. (Default: 21, 22, 706,
1044 1863, 5050, 5190, 5222, 5223, 6523, 6667, 6697, 8300)
1046 [[MapAddress]] **MapAddress** __address__ __newaddress__::
1047 When a request for address arrives to Tor, it will transform to newaddress
1048 before processing it. For example, if you always want connections to
1049 www.example.com to exit via __torserver__ (where __torserver__ is the
1050 fingerprint of the server), use "MapAddress www.example.com
1051 www.example.com.torserver.exit". If the value is prefixed with a
1052 "\*.", matches an entire domain. For example, if you
1053 always want connections to example.com and any if its subdomains
1055 __torserver__ (where __torserver__ is the fingerprint of the server), use
1056 "MapAddress \*.example.com \*.example.com.torserver.exit". (Note the
1057 leading "*." in each part of the directive.) You can also redirect all
1058 subdomains of a domain to a single address. For example, "MapAddress
1059 *.example.com www.example.com". +
1063 1. When evaluating MapAddress expressions Tor stops when it hits the most
1064 recently added expression that matches the requested address. So if you
1065 have the following in your torrc, www.torproject.org will map to 1.1.1.1:
1067 MapAddress www.torproject.org 2.2.2.2
1068 MapAddress www.torproject.org 1.1.1.1
1070 2. Tor evaluates the MapAddress configuration until it finds no matches. So
1071 if you have the following in your torrc, www.torproject.org will map to
1074 MapAddress 1.1.1.1 2.2.2.2
1075 MapAddress www.torproject.org 1.1.1.1
1077 3. The following MapAddress expression is invalid (and will be
1078 ignored) because you cannot map from a specific address to a wildcard
1081 MapAddress www.torproject.org *.torproject.org.torserver.exit
1083 4. Using a wildcard to match only part of a string (as in *ample.com) is
1086 [[NewCircuitPeriod]] **NewCircuitPeriod** __NUM__::
1087 Every NUM seconds consider whether to build a new circuit. (Default: 30
1090 [[MaxCircuitDirtiness]] **MaxCircuitDirtiness** __NUM__::
1091 Feel free to reuse a circuit that was first used at most NUM seconds ago,
1092 but never attach a new stream to a circuit that is too old. For hidden
1093 services, this applies to the __last__ time a circuit was used, not the
1094 first. Circuits with streams constructed with SOCKS authentication via
1095 SocksPorts that have **KeepAliveIsolateSOCKSAuth** also remain alive
1096 for MaxCircuitDirtiness seconds after carrying the last such stream.
1097 (Default: 10 minutes)
1099 [[MaxClientCircuitsPending]] **MaxClientCircuitsPending** __NUM__::
1100 Do not allow more than NUM circuits to be pending at a time for handling
1101 client streams. A circuit is pending if we have begun constructing it,
1102 but it has not yet been completely constructed. (Default: 32)
1104 [[NodeFamily]] **NodeFamily** __node__,__node__,__...__::
1105 The Tor servers, defined by their identity fingerprints,
1106 constitute a "family" of similar or co-administered servers, so never use
1107 any two of them in the same circuit. Defining a NodeFamily is only needed
1108 when a server doesn't list the family itself (with MyFamily). This option
1109 can be used multiple times; each instance defines a separate family. In
1110 addition to nodes, you can also list IP address and ranges and country
1111 codes in {curly braces}. See the **ExcludeNodes** option for more
1112 information on how to specify nodes.
1114 [[EnforceDistinctSubnets]] **EnforceDistinctSubnets** **0**|**1**::
1115 If 1, Tor will not put two servers whose IP addresses are "too close" on
1116 the same circuit. Currently, two addresses are "too close" if they lie in
1117 the same /16 range. (Default: 1)
1119 [[SocksPort]] **SocksPort** \['address':]__port__|**unix:**__path__|**auto** [_flags_] [_isolation flags_]::
1120 Open this port to listen for connections from SOCKS-speaking
1121 applications. Set this to 0 if you don't want to allow application
1122 connections via SOCKS. Set it to "auto" to have Tor pick a port for
1123 you. This directive can be specified multiple times to bind
1124 to multiple addresses/ports. If a unix domain socket is used, you may
1125 quote the path using standard C escape sequences.
1128 NOTE: Although this option allows you to specify an IP address
1129 other than localhost, you should do so only with extreme caution.
1130 The SOCKS protocol is unencrypted and (as we use it)
1131 unauthenticated, so exposing it in this way could leak your
1132 information to anybody watching your network, and allow anybody
1133 to use your computer as an open proxy. +
1135 The _isolation flags_ arguments give Tor rules for which streams
1136 received on this SocksPort are allowed to share circuits with one
1137 another. Recognized isolation flags are:
1138 **IsolateClientAddr**;;
1139 Don't share circuits with streams from a different
1140 client address. (On by default and strongly recommended when
1141 supported; you can disable it with **NoIsolateClientAddr**.
1142 Unsupported and force-disabled when using Unix domain sockets.)
1143 **IsolateSOCKSAuth**;;
1144 Don't share circuits with streams for which different
1145 SOCKS authentication was provided. (For HTTPTunnelPort
1146 connections, this option looks at the Proxy-Authorization and
1147 X-Tor-Stream-Isolation headers. On by default;
1148 you can disable it with **NoIsolateSOCKSAuth**.)
1149 **IsolateClientProtocol**;;
1150 Don't share circuits with streams using a different protocol.
1151 (SOCKS 4, SOCKS 5, TransPort connections, NATDPort connections,
1152 and DNSPort requests are all considered to be different protocols.)
1153 **IsolateDestPort**;;
1154 Don't share circuits with streams targeting a different
1156 **IsolateDestAddr**;;
1157 Don't share circuits with streams targeting a different
1158 destination address.
1159 **KeepAliveIsolateSOCKSAuth**;;
1160 If **IsolateSOCKSAuth** is enabled, keep alive circuits while they have
1161 at least one stream with SOCKS authentication active. After such a circuit
1162 is idle for more than MaxCircuitDirtiness seconds, it can be closed.
1163 **SessionGroup=**__INT__;;
1164 If no other isolation rules would prevent it, allow streams
1165 on this port to share circuits with streams from every other
1166 port with the same session group. (By default, streams received
1167 on different SocksPorts, TransPorts, etc are always isolated from one
1168 another. This option overrides that behavior.)
1170 [[OtherSocksPortFlags]]::
1171 Other recognized __flags__ for a SocksPort are:
1173 Tell exits to not connect to IPv4 addresses in response to SOCKS
1174 requests on this connection.
1176 Tell exits to allow IPv6 addresses in response to SOCKS requests on
1177 this connection, so long as SOCKS5 is in use. (SOCKS4 can't handle
1180 Tells exits that, if a host has both an IPv4 and an IPv6 address,
1181 we would prefer to connect to it via IPv6. (IPv4 is the default.)
1183 Do not ask exits to resolve DNS addresses in SOCKS5 requests. Tor will
1184 connect to IPv4 addresses, IPv6 addresses (if IPv6Traffic is set) and
1186 **NoOnionTraffic**;;
1187 Do not connect to .onion addresses in SOCKS5 requests.
1188 **OnionTrafficOnly**;;
1189 Tell the tor client to only connect to .onion addresses in response to
1190 SOCKS5 requests on this connection. This is equivalent to NoDNSRequest,
1191 NoIPv4Traffic, NoIPv6Traffic. The corresponding NoOnionTrafficOnly
1192 flag is not supported.
1194 Tells the client to remember IPv4 DNS answers we receive from exit
1195 nodes via this connection. (On by default.)
1197 Tells the client to remember IPv6 DNS answers we receive from exit
1198 nodes via this connection.
1200 Unix domain sockets only: makes the socket get created as
1203 Unix domain sockets only: makes the socket get created as
1206 Tells the client to remember all DNS answers we receive from exit
1207 nodes via this connection.
1209 Tells the client to use any cached IPv4 DNS answers we have when making
1210 requests via this connection. (NOTE: This option, along UseIPv6Cache
1211 and UseDNSCache, can harm your anonymity, and probably
1212 won't help performance as much as you might expect. Use with care!)
1214 Tells the client to use any cached IPv6 DNS answers we have when making
1215 requests via this connection.
1217 Tells the client to use any cached DNS answers we have when making
1218 requests via this connection.
1219 **PreferIPv6Automap**;;
1220 When serving a hostname lookup request on this port that
1221 should get automapped (according to AutomapHostsOnResolve),
1222 if we could return either an IPv4 or an IPv6 answer, prefer
1223 an IPv6 answer. (On by default.)
1224 **PreferSOCKSNoAuth**;;
1225 Ordinarily, when an application offers both "username/password
1226 authentication" and "no authentication" to Tor via SOCKS5, Tor
1227 selects username/password authentication so that IsolateSOCKSAuth can
1228 work. This can confuse some applications, if they offer a
1229 username/password combination then get confused when asked for
1230 one. You can disable this behavior, so that Tor will select "No
1231 authentication" when IsolateSOCKSAuth is disabled, or when this
1234 [[SocksPortFlagsMisc]]::
1235 Flags are processed left to right. If flags conflict, the last flag on the
1236 line is used, and all earlier flags are ignored. No error is issued for
1239 [[SocksPolicy]] **SocksPolicy** __policy__,__policy__,__...__::
1240 Set an entrance policy for this server, to limit who can connect to the
1241 SocksPort and DNSPort ports. The policies have the same form as exit
1242 policies below, except that port specifiers are ignored. Any address
1243 not matched by some entry in the policy is accepted.
1245 [[SocksTimeout]] **SocksTimeout** __NUM__::
1246 Let a socks connection wait NUM seconds handshaking, and NUM seconds
1247 unattached waiting for an appropriate circuit, before we fail it. (Default:
1250 [[TokenBucketRefillInterval]] **TokenBucketRefillInterval** __NUM__ [**msec**|**second**]::
1251 Set the refill interval of Tor's token bucket to NUM milliseconds.
1252 NUM must be between 1 and 1000, inclusive. Note that the configured
1253 bandwidth limits are still expressed in bytes per second: this
1254 option only affects the frequency with which Tor checks to see whether
1255 previously exhausted connections may read again.
1256 Can not be changed while tor is running. (Default: 100 msec)
1258 [[TrackHostExits]] **TrackHostExits** __host__,__.domain__,__...__::
1259 For each value in the comma separated list, Tor will track recent
1260 connections to hosts that match this value and attempt to reuse the same
1261 exit node for each. If the value is prepended with a \'.\', it is treated as
1262 matching an entire domain. If one of the values is just a \'.', it means
1263 match everything. This option is useful if you frequently connect to sites
1264 that will expire all your authentication cookies (i.e. log you out) if
1265 your IP address changes. Note that this option does have the disadvantage
1266 of making it more clear that a given history is associated with a single
1267 user. However, most people who would wish to observe this will observe it
1268 through cookies or other protocol-specific means anyhow.
1270 [[TrackHostExitsExpire]] **TrackHostExitsExpire** __NUM__::
1271 Since exit servers go up and down, it is desirable to expire the
1272 association between host and exit server after NUM seconds. The default is
1273 1800 seconds (30 minutes).
1275 [[UpdateBridgesFromAuthority]] **UpdateBridgesFromAuthority** **0**|**1**::
1276 When set (along with UseBridges), Tor will try to fetch bridge descriptors
1277 from the configured bridge authorities when feasible. It will fall back to
1278 a direct request if the authority responds with a 404. (Default: 0)
1280 [[UseBridges]] **UseBridges** **0**|**1**::
1281 When set, Tor will fetch descriptors for each bridge listed in the "Bridge"
1282 config lines, and use these relays as both entry guards and directory
1283 guards. (Default: 0)
1285 [[UseEntryGuards]] **UseEntryGuards** **0**|**1**::
1286 If this option is set to 1, we pick a few long-term entry servers, and try
1287 to stick with them. This is desirable because constantly changing servers
1288 increases the odds that an adversary who owns some servers will observe a
1289 fraction of your paths. Entry Guards can not be used by Directory
1290 Authorities, Single Onion Services, and Tor2web clients. In these cases,
1291 the this option is ignored. (Default: 1)
1293 [[GuardfractionFile]] **GuardfractionFile** __FILENAME__::
1294 V3 authoritative directories only. Configures the location of the
1295 guardfraction file which contains information about how long relays
1296 have been guards. (Default: unset)
1298 [[UseGuardFraction]] **UseGuardFraction** **0**|**1**|**auto**::
1299 This torrc option specifies whether clients should use the
1300 guardfraction information found in the consensus during path
1301 selection. If it's set to 'auto', clients will do what the
1302 UseGuardFraction consensus parameter tells them to do. (Default: auto)
1304 [[NumEntryGuards]] **NumEntryGuards** __NUM__::
1305 If UseEntryGuards is set to 1, we will try to pick a total of NUM routers
1306 as long-term entries for our circuits. If NUM is 0, we try to learn the
1307 number from the guard-n-primary-guards-to-use consensus parameter, and
1308 default to 1 if the consensus parameter isn't set. (Default: 0)
1310 [[NumDirectoryGuards]] **NumDirectoryGuards** __NUM__::
1311 If UseEntryGuardsAsDirectoryGuards is enabled, we try to make sure we have
1312 at least NUM routers to use as directory guards. If this option is set to
1313 0, use the value from the guard-n-primary-dir-guards-to-use consensus
1314 parameter, and default to 3 if the consensus parameter isn't set.
1317 [[GuardLifetime]] **GuardLifetime** __N__ **days**|**weeks**|**months**::
1318 If nonzero, and UseEntryGuards is set, minimum time to keep a guard before
1319 picking a new one. If zero, we use the GuardLifetime parameter from the
1320 consensus directory. No value here may be less than 1 month or greater
1321 than 5 years; out-of-range values are clamped. (Default: 0)
1323 [[SafeSocks]] **SafeSocks** **0**|**1**::
1324 When this option is enabled, Tor will reject application connections that
1325 use unsafe variants of the socks protocol -- ones that only provide an IP
1326 address, meaning the application is doing a DNS resolve first.
1327 Specifically, these are socks4 and socks5 when not doing remote DNS.
1330 [[TestSocks]] **TestSocks** **0**|**1**::
1331 When this option is enabled, Tor will make a notice-level log entry for
1332 each connection to the Socks port indicating whether the request used a
1333 safe socks protocol or an unsafe one (see above entry on SafeSocks). This
1334 helps to determine whether an application using Tor is possibly leaking
1335 DNS requests. (Default: 0)
1337 [[VirtualAddrNetworkIPv4]] **VirtualAddrNetworkIPv4** __Address__/__bits__ +
1339 [[VirtualAddrNetworkIPv6]] **VirtualAddrNetworkIPv6** [__Address__]/__bits__::
1340 When Tor needs to assign a virtual (unused) address because of a MAPADDRESS
1341 command from the controller or the AutomapHostsOnResolve feature, Tor
1342 picks an unassigned address from this range. (Defaults:
1343 127.192.0.0/10 and [FE80::]/10 respectively.) +
1345 When providing proxy server service to a network of computers using a tool
1346 like dns-proxy-tor, change the IPv4 network to "10.192.0.0/10" or
1347 "172.16.0.0/12" and change the IPv6 network to "[FC00::]/7".
1348 The default **VirtualAddrNetwork** address ranges on a
1349 properly configured machine will route to the loopback or link-local
1350 interface. The maximum number of bits for the network prefix is set to 104
1351 for IPv6 and 16 for IPv4. However, a wider network - smaller prefix length
1352 - is preferable since it reduces the chances for an attacker to guess the
1353 used IP. For local use, no change to the default VirtualAddrNetwork setting
1356 [[AllowNonRFC953Hostnames]] **AllowNonRFC953Hostnames** **0**|**1**::
1357 When this option is disabled, Tor blocks hostnames containing illegal
1358 characters (like @ and :) rather than sending them to an exit node to be
1359 resolved. This helps trap accidental attempts to resolve URLs and so on.
1362 [[HTTPTunnelPort]] **HTTPTunnelPort** \['address':]__port__|**auto** [_isolation flags_]::
1363 Open this port to listen for proxy connections using the "HTTP CONNECT"
1364 protocol instead of SOCKS. Set this to 0
1365 0 if you don't want to allow "HTTP CONNECT" connections. Set the port
1366 to "auto" to have Tor pick a port for you. This directive can be
1367 specified multiple times to bind to multiple addresses/ports. See
1368 SOCKSPort for an explanation of isolation flags. (Default: 0)
1370 [[TransPort]] **TransPort** \['address':]__port__|**auto** [_isolation flags_]::
1371 Open this port to listen for transparent proxy connections. Set this to
1372 0 if you don't want to allow transparent proxy connections. Set the port
1373 to "auto" to have Tor pick a port for you. This directive can be
1374 specified multiple times to bind to multiple addresses/ports. See
1375 SOCKSPort for an explanation of isolation flags. +
1377 TransPort requires OS support for transparent proxies, such as BSDs' pf or
1378 Linux's IPTables. If you're planning to use Tor as a transparent proxy for
1379 a network, you'll want to examine and change VirtualAddrNetwork from the
1380 default setting. (Default: 0)
1382 [[TransProxyType]] **TransProxyType** **default**|**TPROXY**|**ipfw**|**pf-divert**::
1383 TransProxyType may only be enabled when there is transparent proxy listener
1386 Set this to "TPROXY" if you wish to be able to use the TPROXY Linux module
1387 to transparently proxy connections that are configured using the TransPort
1388 option. Detailed information on how to configure the TPROXY
1389 feature can be found in the Linux kernel source tree in the file
1390 Documentation/networking/tproxy.txt. +
1392 Set this option to "ipfw" to use the FreeBSD ipfw interface. +
1394 On *BSD operating systems when using pf, set this to "pf-divert" to take
1395 advantage of +divert-to+ rules, which do not modify the packets like
1396 +rdr-to+ rules do. Detailed information on how to configure pf to use
1397 +divert-to+ rules can be found in the pf.conf(5) manual page. On OpenBSD,
1398 +divert-to+ is available to use on versions greater than or equal to
1401 Set this to "default", or leave it unconfigured, to use regular IPTables
1402 on Linux, or to use pf +rdr-to+ rules on *BSD systems. +
1404 (Default: "default".)
1406 [[NATDPort]] **NATDPort** \['address':]__port__|**auto** [_isolation flags_]::
1407 Open this port to listen for connections from old versions of ipfw (as
1408 included in old versions of FreeBSD, etc) using the NATD protocol.
1409 Use 0 if you don't want to allow NATD connections. Set the port
1410 to "auto" to have Tor pick a port for you. This directive can be
1411 specified multiple times to bind to multiple addresses/ports. See
1412 SocksPort for an explanation of isolation flags. +
1414 This option is only for people who cannot use TransPort. (Default: 0)
1416 [[AutomapHostsOnResolve]] **AutomapHostsOnResolve** **0**|**1**::
1417 When this option is enabled, and we get a request to resolve an address
1418 that ends with one of the suffixes in **AutomapHostsSuffixes**, we map an
1419 unused virtual address to that address, and return the new virtual address.
1420 This is handy for making ".onion" addresses work with applications that
1421 resolve an address and then connect to it. (Default: 0)
1423 [[AutomapHostsSuffixes]] **AutomapHostsSuffixes** __SUFFIX__,__SUFFIX__,__...__::
1424 A comma-separated list of suffixes to use with **AutomapHostsOnResolve**.
1425 The "." suffix is equivalent to "all addresses." (Default: .exit,.onion).
1427 [[DNSPort]] **DNSPort** \['address':]__port__|**auto** [_isolation flags_]::
1428 If non-zero, open this port to listen for UDP DNS requests, and resolve
1429 them anonymously. This port only handles A, AAAA, and PTR requests---it
1430 doesn't handle arbitrary DNS request types. Set the port to "auto" to
1431 have Tor pick a port for
1432 you. This directive can be specified multiple times to bind to multiple
1433 addresses/ports. See SocksPort for an explanation of isolation
1436 [[ClientRejectInternalAddresses]] **ClientRejectInternalAddresses** **0**|**1**::
1437 If true, Tor does not try to fulfill requests to connect to an internal
1438 address (like 127.0.0.1 or 192.168.0.1) __unless a exit node is
1439 specifically requested__ (for example, via a .exit hostname, or a
1440 controller request). If true, multicast DNS hostnames for machines on the
1441 local network (of the form *.local) are also rejected. (Default: 1)
1443 [[DownloadExtraInfo]] **DownloadExtraInfo** **0**|**1**::
1444 If true, Tor downloads and caches "extra-info" documents. These documents
1445 contain information about servers other than the information in their
1446 regular server descriptors. Tor does not use this information for anything
1447 itself; to save bandwidth, leave this option turned off. (Default: 0)
1449 [[WarnPlaintextPorts]] **WarnPlaintextPorts** __port__,__port__,__...__::
1450 Tells Tor to issue a warnings whenever the user tries to make an anonymous
1451 connection to one of these ports. This option is designed to alert users
1452 to services that risk sending passwords in the clear. (Default:
1455 [[RejectPlaintextPorts]] **RejectPlaintextPorts** __port__,__port__,__...__::
1456 Like WarnPlaintextPorts, but instead of warning about risky port uses, Tor
1457 will instead refuse to make the connection. (Default: None)
1459 [[OptimisticData]] **OptimisticData** **0**|**1**|**auto**::
1460 When this option is set, and Tor is using an exit node that supports
1461 the feature, it will try optimistically to send data to the exit node
1462 without waiting for the exit node to report whether the connection
1463 succeeded. This can save a round-trip time for protocols like HTTP
1464 where the client talks first. If OptimisticData is set to **auto**,
1465 Tor will look at the UseOptimisticData parameter in the networkstatus.
1468 [[Tor2webMode]] **Tor2webMode** **0**|**1**::
1469 When this option is set, Tor connects to hidden services
1470 **non-anonymously**. This option also disables client connections to
1471 non-hidden-service hostnames through Tor. It **must only** be used when
1472 running a tor2web Hidden Service web proxy.
1473 To enable this option the compile time flag --enable-tor2web-mode must be
1474 specified. Since Tor2webMode is non-anonymous, you can not run an
1475 anonymous Hidden Service on a tor version compiled with Tor2webMode.
1478 [[Tor2webRendezvousPoints]] **Tor2webRendezvousPoints** __node__,__node__,__...__::
1479 A list of identity fingerprints, nicknames, country codes and
1480 address patterns of nodes that are allowed to be used as RPs
1481 in HS circuits; any other nodes will not be used as RPs.
1483 Tor2webRendezvousPoints Fastyfasty, ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
1485 This feature can only be used if Tor2webMode is also enabled. +
1487 ExcludeNodes have higher priority than Tor2webRendezvousPoints,
1488 which means that nodes specified in ExcludeNodes will not be
1491 If no nodes in Tor2webRendezvousPoints are currently available for
1492 use, Tor will choose a random node when building HS circuits.
1494 [[UseMicrodescriptors]] **UseMicrodescriptors** **0**|**1**|**auto**::
1495 Microdescriptors are a smaller version of the information that Tor needs
1496 in order to build its circuits. Using microdescriptors makes Tor clients
1497 download less directory information, thus saving bandwidth. Directory
1498 caches need to fetch regular descriptors and microdescriptors, so this
1499 option doesn't save any bandwidth for them. If this option is set to
1500 "auto" (recommended) then it is on for all clients that do not set
1501 FetchUselessDescriptors. (Default: auto)
1503 [[PathBiasCircThreshold]] **PathBiasCircThreshold** __NUM__ +
1505 [[PathBiasNoticeRate]] **PathBiasNoticeRate** __NUM__ +
1507 [[PathBiasWarnRate]] **PathBiasWarnRate** __NUM__ +
1509 [[PathBiasExtremeRate]] **PathBiasExtremeRate** __NUM__ +
1511 [[PathBiasDropGuards]] **PathBiasDropGuards** __NUM__ +
1513 [[PathBiasScaleThreshold]] **PathBiasScaleThreshold** __NUM__::
1514 These options override the default behavior of Tor's (**currently
1515 experimental**) path bias detection algorithm. To try to find broken or
1516 misbehaving guard nodes, Tor looks for nodes where more than a certain
1517 fraction of circuits through that guard fail to get built. +
1519 The PathBiasCircThreshold option controls how many circuits we need to build
1520 through a guard before we make these checks. The PathBiasNoticeRate,
1521 PathBiasWarnRate and PathBiasExtremeRate options control what fraction of
1522 circuits must succeed through a guard so we won't write log messages.
1523 If less than PathBiasExtremeRate circuits succeed *and* PathBiasDropGuards
1524 is set to 1, we disable use of that guard. +
1526 When we have seen more than PathBiasScaleThreshold
1527 circuits through a guard, we scale our observations by 0.5 (governed by
1528 the consensus) so that new observations don't get swamped by old ones. +
1530 By default, or if a negative value is provided for one of these options,
1531 Tor uses reasonable defaults from the networkstatus consensus document.
1532 If no defaults are available there, these options default to 150, .70,
1533 .50, .30, 0, and 300 respectively.
1535 [[PathBiasUseThreshold]] **PathBiasUseThreshold** __NUM__ +
1537 [[PathBiasNoticeUseRate]] **PathBiasNoticeUseRate** __NUM__ +
1539 [[PathBiasExtremeUseRate]] **PathBiasExtremeUseRate** __NUM__ +
1541 [[PathBiasScaleUseThreshold]] **PathBiasScaleUseThreshold** __NUM__::
1542 Similar to the above options, these options override the default behavior
1543 of Tor's (**currently experimental**) path use bias detection algorithm. +
1545 Where as the path bias parameters govern thresholds for successfully
1546 building circuits, these four path use bias parameters govern thresholds
1547 only for circuit usage. Circuits which receive no stream usage
1548 are not counted by this detection algorithm. A used circuit is considered
1549 successful if it is capable of carrying streams or otherwise receiving
1550 well-formed responses to RELAY cells. +
1552 By default, or if a negative value is provided for one of these options,
1553 Tor uses reasonable defaults from the networkstatus consensus document.
1554 If no defaults are available there, these options default to 20, .80,
1555 .60, and 100, respectively.
1557 [[ClientUseIPv4]] **ClientUseIPv4** **0**|**1**::
1558 If this option is set to 0, Tor will avoid connecting to directory servers
1559 and entry nodes over IPv4. Note that clients with an IPv4
1560 address in a **Bridge**, proxy, or pluggable transport line will try
1561 connecting over IPv4 even if **ClientUseIPv4** is set to 0. (Default: 1)
1563 [[ClientUseIPv6]] **ClientUseIPv6** **0**|**1**::
1564 If this option is set to 1, Tor might connect to directory servers or
1565 entry nodes over IPv6. Note that clients configured with an IPv6 address
1566 in a **Bridge**, proxy, or pluggable transport line will try connecting
1567 over IPv6 even if **ClientUseIPv6** is set to 0. (Default: 0)
1569 [[ClientPreferIPv6DirPort]] **ClientPreferIPv6DirPort** **0**|**1**|**auto**::
1570 If this option is set to 1, Tor prefers a directory port with an IPv6
1571 address over one with IPv4, for direct connections, if a given directory
1572 server has both. (Tor also prefers an IPv6 DirPort if IPv4Client is set to
1573 0.) If this option is set to auto, clients prefer IPv4. Other things may
1574 influence the choice. This option breaks a tie to the favor of IPv6.
1575 (Default: auto) (DEPRECATED: This option has had no effect for some
1578 [[ClientPreferIPv6ORPort]] **ClientPreferIPv6ORPort** **0**|**1**|**auto**::
1579 If this option is set to 1, Tor prefers an OR port with an IPv6
1580 address over one with IPv4 if a given entry node has both. (Tor also
1581 prefers an IPv6 ORPort if IPv4Client is set to 0.) If this option is set
1582 to auto, Tor bridge clients prefer the configured bridge address, and
1583 other clients prefer IPv4. Other things may influence the choice. This
1584 option breaks a tie to the favor of IPv6. (Default: auto)
1586 [[PathsNeededToBuildCircuits]] **PathsNeededToBuildCircuits** __NUM__::
1587 Tor clients don't build circuits for user traffic until they know
1588 about enough of the network so that they could potentially construct
1589 enough of the possible paths through the network. If this option
1590 is set to a fraction between 0.25 and 0.95, Tor won't build circuits
1591 until it has enough descriptors or microdescriptors to construct
1592 that fraction of possible paths. Note that setting this option too low
1593 can make your Tor client less anonymous, and setting it too high can
1594 prevent your Tor client from bootstrapping. If this option is negative,
1595 Tor will use a default value chosen by the directory authorities. If the
1596 directory authorities do not choose a value, Tor will default to 0.6.
1599 [[ClientBootstrapConsensusAuthorityDownloadSchedule]] **ClientBootstrapConsensusAuthorityDownloadSchedule** __N__,__N__,__...__::
1600 Schedule for when clients should download consensuses from authorities
1601 if they are bootstrapping (that is, they don't have a usable, reasonably
1602 live consensus). Only used by clients fetching from a list of fallback
1603 directory mirrors. This schedule is advanced by (potentially concurrent)
1604 connection attempts, unlike other schedules, which are advanced by
1605 connection failures. (Default: 6, 11, 3600, 10800, 25200, 54000, 111600,
1608 [[ClientBootstrapConsensusFallbackDownloadSchedule]] **ClientBootstrapConsensusFallbackDownloadSchedule** __N__,__N__,__...__::
1609 Schedule for when clients should download consensuses from fallback
1610 directory mirrors if they are bootstrapping (that is, they don't have a
1611 usable, reasonably live consensus). Only used by clients fetching from a
1612 list of fallback directory mirrors. This schedule is advanced by
1613 (potentially concurrent) connection attempts, unlike other schedules,
1614 which are advanced by connection failures. (Default: 0, 1, 4, 11, 3600,
1615 10800, 25200, 54000, 111600, 262800)
1617 [[ClientBootstrapConsensusAuthorityOnlyDownloadSchedule]] **ClientBootstrapConsensusAuthorityOnlyDownloadSchedule** __N__,__N__,__...__::
1618 Schedule for when clients should download consensuses from authorities
1619 if they are bootstrapping (that is, they don't have a usable, reasonably
1620 live consensus). Only used by clients which don't have or won't fetch
1621 from a list of fallback directory mirrors. This schedule is advanced by
1622 (potentially concurrent) connection attempts, unlike other schedules,
1623 which are advanced by connection failures. (Default: 0, 3, 7, 3600,
1624 10800, 25200, 54000, 111600, 262800)
1626 [[ClientBootstrapConsensusMaxDownloadTries]] **ClientBootstrapConsensusMaxDownloadTries** __NUM__::
1627 Try this many times to download a consensus while bootstrapping using
1628 fallback directory mirrors before giving up. (Default: 7)
1630 [[ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries]] **ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries** __NUM__::
1631 Try this many times to download a consensus while bootstrapping using
1632 authorities before giving up. (Default: 4)
1634 [[ClientBootstrapConsensusMaxInProgressTries]] **ClientBootstrapConsensusMaxInProgressTries** __NUM__::
1635 Try this many simultaneous connections to download a consensus before
1636 waiting for one to complete, timeout, or error out. (Default: 3)
1641 The following options are useful only for servers (that is, if ORPort
1644 [[Address]] **Address** __address__::
1645 The IPv4 address of this server, or a fully qualified domain name of
1646 this server that resolves to an IPv4 address. You can leave this
1647 unset, and Tor will try to guess your IPv4 address. This IPv4
1648 address is the one used to tell clients and other servers where to
1649 find your Tor server; it doesn't affect the address that your server
1650 binds to. To bind to a different address, use the ORPort and
1651 OutboundBindAddress options.
1653 [[AssumeReachable]] **AssumeReachable** **0**|**1**::
1654 This option is used when bootstrapping a new Tor network. If set to 1,
1655 don't do self-reachability testing; just upload your server descriptor
1656 immediately. If **AuthoritativeDirectory** is also set, this option
1657 instructs the dirserver to bypass remote reachability testing too and list
1658 all connected servers as running.
1660 [[BridgeRelay]] **BridgeRelay** **0**|**1**::
1661 Sets the relay to act as a "bridge" with respect to relaying connections
1662 from bridge users to the Tor network. It mainly causes Tor to publish a
1663 server descriptor to the bridge database, rather than
1664 to the public directory authorities.
1666 [[ContactInfo]] **ContactInfo** __email_address__::
1667 Administrative contact information for this relay or bridge. This line
1668 can be used to contact you if your relay or bridge is misconfigured or
1669 something else goes wrong. Note that we archive and publish all
1670 descriptors containing these lines and that Google indexes them, so
1671 spammers might also collect them. You may want to obscure the fact
1672 that it's an email address and/or generate a new address for this
1675 [[ExitRelay]] **ExitRelay** **0**|**1**|**auto**::
1676 Tells Tor whether to run as an exit relay. If Tor is running as a
1677 non-bridge server, and ExitRelay is set to 1, then Tor allows traffic to
1678 exit according to the ExitPolicy option (or the default ExitPolicy if
1679 none is specified). +
1681 If ExitRelay is set to 0, no traffic is allowed to
1682 exit, and the ExitPolicy option is ignored. +
1684 If ExitRelay is set to "auto", then Tor behaves as if it were set to 1, but
1685 warns the user if this would cause traffic to exit. In a future version,
1686 the default value will be 0. (Default: auto)
1688 [[ExitPolicy]] **ExitPolicy** __policy__,__policy__,__...__::
1689 Set an exit policy for this server. Each policy is of the form
1690 "**accept[6]**|**reject[6]** __ADDR__[/__MASK__][:__PORT__]". If /__MASK__ is
1691 omitted then this policy just applies to the host given. Instead of giving
1692 a host or network you can also use "\*" to denote the universe (0.0.0.0/0
1693 and ::/128), or \*4 to denote all IPv4 addresses, and \*6 to denote all
1695 __PORT__ can be a single port number, an interval of ports
1696 "__FROM_PORT__-__TO_PORT__", or "\*". If __PORT__ is omitted, that means
1699 For example, "accept 18.7.22.69:\*,reject 18.0.0.0/8:\*,accept \*:\*" would
1700 reject any IPv4 traffic destined for MIT except for web.mit.edu, and accept
1701 any other IPv4 or IPv6 traffic. +
1703 Tor also allows IPv6 exit policy entries. For instance, "reject6 [FC00::]/7:\*"
1704 rejects all destinations that share 7 most significant bit prefix with
1705 address FC00::. Respectively, "accept6 [C000::]/3:\*" accepts all destinations
1706 that share 3 most significant bit prefix with address C000::. +
1708 accept6 and reject6 only produce IPv6 exit policy entries. Using an IPv4
1709 address with accept6 or reject6 is ignored and generates a warning.
1710 accept/reject allows either IPv4 or IPv6 addresses. Use \*4 as an IPv4
1711 wildcard address, and \*6 as an IPv6 wildcard address. accept/reject *
1712 expands to matching IPv4 and IPv6 wildcard address rules. +
1714 To specify all IPv4 and IPv6 internal and link-local networks (including
1715 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,
1716 172.16.0.0/12, [::]/8, [FC00::]/7, [FE80::]/10, [FEC0::]/10, [FF00::]/8,
1717 and [::]/127), you can use the "private" alias instead of an address.
1718 ("private" always produces rules for IPv4 and IPv6 addresses, even when
1719 used with accept6/reject6.) +
1721 Private addresses are rejected by default (at the beginning of your exit
1722 policy), along with any configured primary public IPv4 and IPv6 addresses.
1723 These private addresses are rejected unless you set the
1724 ExitPolicyRejectPrivate config option to 0. For example, once you've done
1725 that, you could allow HTTP to 127.0.0.1 and block all other connections to
1726 internal networks with "accept 127.0.0.1:80,reject private:\*", though that
1727 may also allow connections to your own computer that are addressed to its
1728 public (external) IP address. See RFC 1918 and RFC 3330 for more details
1729 about internal and reserved IP address space. See
1730 ExitPolicyRejectLocalInterfaces if you want to block every address on the
1731 relay, even those that aren't advertised in the descriptor. +
1733 This directive can be specified multiple times so you don't have to put it
1736 Policies are considered first to last, and the first match wins. If you
1737 want to allow the same ports on IPv4 and IPv6, write your rules using
1738 accept/reject \*. If you want to allow different ports on IPv4 and IPv6,
1739 write your IPv6 rules using accept6/reject6 \*6, and your IPv4 rules using
1740 accept/reject \*4. If you want to \_replace_ the default exit policy, end
1741 your exit policy with either a reject \*:* or an accept \*:*. Otherwise,
1742 you're \_augmenting_ (prepending to) the default exit policy. The default
1757 [[ExitPolicyDefault]]::
1758 Since the default exit policy uses accept/reject *, it applies to both
1759 IPv4 and IPv6 addresses.
1761 [[ExitPolicyRejectPrivate]] **ExitPolicyRejectPrivate** **0**|**1**::
1762 Reject all private (local) networks, along with the relay's advertised
1763 public IPv4 and IPv6 addresses, at the beginning of your exit policy.
1764 See above entry on ExitPolicy.
1767 [[ExitPolicyRejectLocalInterfaces]] **ExitPolicyRejectLocalInterfaces** **0**|**1**::
1768 Reject all IPv4 and IPv6 addresses that the relay knows about, at the
1769 beginning of your exit policy. This includes any OutboundBindAddress, the
1770 bind addresses of any port options, such as ControlPort or DNSPort, and any
1771 public IPv4 and IPv6 addresses on any interface on the relay. (If IPv6Exit
1772 is not set, all IPv6 addresses will be rejected anyway.)
1773 See above entry on ExitPolicy.
1774 This option is off by default, because it lists all public relay IP
1775 addresses in the ExitPolicy, even those relay operators might prefer not
1779 [[IPv6Exit]] **IPv6Exit** **0**|**1**::
1780 If set, and we are an exit node, allow clients to use us for IPv6
1781 traffic. (Default: 0)
1783 [[MaxOnionQueueDelay]] **MaxOnionQueueDelay** __NUM__ [**msec**|**second**]::
1784 If we have more onionskins queued for processing than we can process in
1785 this amount of time, reject new ones. (Default: 1750 msec)
1787 [[MyFamily]] **MyFamily** __fingerprint__,__fingerprint__,...::
1788 Declare that this Tor relay is controlled or administered by a group or
1789 organization identical or similar to that of the other relays, defined by
1790 their (possibly $-prefixed) identity fingerprints.
1791 This option can be repeated many times, for
1792 convenience in defining large families: all fingerprints in all MyFamily
1793 lines are merged into one list.
1794 When two relays both declare that they are in the
1795 same \'family', Tor clients will not use them in the same circuit. (Each
1796 relay only needs to list the other servers in its family; it doesn't need to
1797 list itself, but it won't hurt if it does.) Do not list any bridge relay as it would
1798 compromise its concealment. +
1800 When listing a node, it's better to list it by fingerprint than by
1801 nickname: fingerprints are more reliable.
1803 [[Nickname]] **Nickname** __name__::
1804 Set the server's nickname to \'name'. Nicknames must be between 1 and 19
1805 characters inclusive, and must contain only the characters [a-zA-Z0-9].
1807 [[NumCPUs]] **NumCPUs** __num__::
1808 How many processes to use at once for decrypting onionskins and other
1809 parallelizable operations. If this is set to 0, Tor will try to detect
1810 how many CPUs you have, defaulting to 1 if it can't tell. (Default: 0)
1812 [[ORPort]] **ORPort** \['address':]__PORT__|**auto** [_flags_]::
1813 Advertise this port to listen for connections from Tor clients and
1814 servers. This option is required to be a Tor server.
1815 Set it to "auto" to have Tor pick a port for you. Set it to 0 to not
1816 run an ORPort at all. This option can occur more than once. (Default: 0) +
1818 Tor recognizes these flags on each ORPort:
1820 By default, we bind to a port and tell our users about it. If
1821 NoAdvertise is specified, we don't advertise, but listen anyway. This
1822 can be useful if the port everybody will be connecting to (for
1823 example, one that's opened on our firewall) is somewhere else.
1825 By default, we bind to a port and tell our users about it. If
1826 NoListen is specified, we don't bind, but advertise anyway. This
1827 can be useful if something else (for example, a firewall's port
1828 forwarding configuration) is causing connections to reach us.
1830 If the address is absent, or resolves to both an IPv4 and an IPv6
1831 address, only listen to the IPv4 address.
1833 If the address is absent, or resolves to both an IPv4 and an IPv6
1834 address, only listen to the IPv6 address.
1836 [[ORPortFlagsExclusive]]::
1837 For obvious reasons, NoAdvertise and NoListen are mutually exclusive, and
1838 IPv4Only and IPv6Only are mutually exclusive.
1840 [[PortForwarding]] **PortForwarding** **0**|**1**::
1841 Attempt to automatically forward the DirPort and ORPort on a NAT router
1842 connecting this Tor server to the Internet. If set, Tor will try both
1843 NAT-PMP (common on Apple routers) and UPnP (common on routers from other
1844 manufacturers). (Default: 0)
1846 [[PortForwardingHelper]] **PortForwardingHelper** __filename__|__pathname__::
1847 If PortForwarding is set, use this executable to configure the forwarding.
1848 If set to a filename, the system path will be searched for the executable.
1849 If set to a path, only the specified path will be executed.
1850 (Default: tor-fw-helper)
1852 [[PublishServerDescriptor]] **PublishServerDescriptor** **0**|**1**|**v3**|**bridge**,**...**::
1853 This option specifies which descriptors Tor will publish when acting as
1855 choose multiple arguments, separated by commas. +
1857 If this option is set to 0, Tor will not publish its
1858 descriptors to any directories. (This is useful if you're testing
1859 out your server, or if you're using a Tor controller that handles
1860 directory publishing for you.) Otherwise, Tor will publish its
1861 descriptors of all type(s) specified. The default is "1", which
1862 means "if running as a relay or bridge, publish descriptors to the
1863 appropriate authorities". Other possibilities are "v3", meaning
1864 "publish as if you're a relay", and "bridge", meaning "publish as
1865 if you're a bridge".
1867 [[ShutdownWaitLength]] **ShutdownWaitLength** __NUM__::
1868 When we get a SIGINT and we're a server, we begin shutting down:
1869 we close listeners and start refusing new circuits. After **NUM**
1870 seconds, we exit. If we get a second SIGINT, we exit immediately.
1871 (Default: 30 seconds)
1873 [[SSLKeyLifetime]] **SSLKeyLifetime** __N__ **minutes**|**hours**|**days**|**weeks**::
1874 When creating a link certificate for our outermost SSL handshake,
1875 set its lifetime to this amount of time. If set to 0, Tor will choose
1876 some reasonable random defaults. (Default: 0)
1878 [[HeartbeatPeriod]] **HeartbeatPeriod** __N__ **minutes**|**hours**|**days**|**weeks**::
1879 Log a heartbeat message every **HeartbeatPeriod** seconds. This is
1880 a log level __notice__ message, designed to let you know your Tor
1881 server is still alive and doing useful things. Settings this
1882 to 0 will disable the heartbeat. Otherwise, it must be at least 30
1883 minutes. (Default: 6 hours)
1885 [[AccountingMax]] **AccountingMax** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
1886 Limits the max number of bytes sent and received within a set time period
1887 using a given calculation rule (see: AccountingStart, AccountingRule).
1888 Useful if you need to stay under a specific bandwidth. By default, the
1889 number used for calculation is the max of either the bytes sent or
1890 received. For example, with AccountingMax set to 1 GByte, a server
1891 could send 900 MBytes and receive 800 MBytes and continue running.
1892 It will only hibernate once one of the two reaches 1 GByte. This can
1893 be changed to use the sum of the both bytes received and sent by setting
1894 the AccountingRule option to "sum" (total bandwidth in/out). When the
1895 number of bytes remaining gets low, Tor will stop accepting new connections
1896 and circuits. When the number of bytes is exhausted, Tor will hibernate
1897 until some time in the next accounting period. To prevent all servers
1898 from waking at the same time, Tor will also wait until a random point
1899 in each period before waking up. If you have bandwidth cost issues,
1900 enabling hibernation is preferable to setting a low bandwidth, since
1901 it provides users with a collection of fast servers that are up some
1902 of the time, which is more useful than a set of slow servers that are
1905 [[AccountingRule]] **AccountingRule** **sum**|**max**|**in**|**out**::
1906 How we determine when our AccountingMax has been reached (when we
1907 should hibernate) during a time interval. Set to "max" to calculate
1908 using the higher of either the sent or received bytes (this is the
1909 default functionality). Set to "sum" to calculate using the sent
1910 plus received bytes. Set to "in" to calculate using only the
1911 received bytes. Set to "out" to calculate using only the sent bytes.
1914 [[AccountingStart]] **AccountingStart** **day**|**week**|**month** [__day__] __HH:MM__::
1915 Specify how long accounting periods last. If **month** is given, each
1916 accounting period runs from the time __HH:MM__ on the __dayth__ day of one
1917 month to the same day and time of the next. (The day must be between 1 and
1918 28.) If **week** is given, each accounting period runs from the time __HH:MM__
1919 of the __dayth__ day of one week to the same day and time of the next week,
1920 with Monday as day 1 and Sunday as day 7. If **day** is given, each
1921 accounting period runs from the time __HH:MM__ each day to the same time on
1922 the next day. All times are local, and given in 24-hour time. (Default:
1925 [[RefuseUnknownExits]] **RefuseUnknownExits** **0**|**1**|**auto**::
1926 Prevent nodes that don't appear in the consensus from exiting using this
1927 relay. If the option is 1, we always block exit attempts from such
1928 nodes; if it's 0, we never do, and if the option is "auto", then we do
1929 whatever the authorities suggest in the consensus (and block if the consensus
1930 is quiet on the issue). (Default: auto)
1932 [[ServerDNSResolvConfFile]] **ServerDNSResolvConfFile** __filename__::
1933 Overrides the default DNS configuration with the configuration in
1934 __filename__. The file format is the same as the standard Unix
1935 "**resolv.conf**" file (7). This option, like all other ServerDNS options,
1936 only affects name lookups that your server does on behalf of clients.
1937 (Defaults to use the system DNS configuration.)
1939 [[ServerDNSAllowBrokenConfig]] **ServerDNSAllowBrokenConfig** **0**|**1**::
1940 If this option is false, Tor exits immediately if there are problems
1941 parsing the system DNS configuration or connecting to nameservers.
1942 Otherwise, Tor continues to periodically retry the system nameservers until
1943 it eventually succeeds. (Default: 1)
1945 [[ServerDNSSearchDomains]] **ServerDNSSearchDomains** **0**|**1**::
1946 If set to 1, then we will search for addresses in the local search domain.
1947 For example, if this system is configured to believe it is in
1948 "example.com", and a client tries to connect to "www", the client will be
1949 connected to "www.example.com". This option only affects name lookups that
1950 your server does on behalf of clients. (Default: 0)
1952 [[ServerDNSDetectHijacking]] **ServerDNSDetectHijacking** **0**|**1**::
1953 When this option is set to 1, we will test periodically to determine
1954 whether our local nameservers have been configured to hijack failing DNS
1955 requests (usually to an advertising site). If they are, we will attempt to
1956 correct this. This option only affects name lookups that your server does
1957 on behalf of clients. (Default: 1)
1959 [[ServerDNSTestAddresses]] **ServerDNSTestAddresses** __address__,__address__,__...__::
1960 When we're detecting DNS hijacking, make sure that these __valid__ addresses
1961 aren't getting redirected. If they are, then our DNS is completely useless,
1962 and we'll reset our exit policy to "reject \*:*". This option only affects
1963 name lookups that your server does on behalf of clients. (Default:
1964 "www.google.com, www.mit.edu, www.yahoo.com, www.slashdot.org")
1966 [[ServerDNSAllowNonRFC953Hostnames]] **ServerDNSAllowNonRFC953Hostnames** **0**|**1**::
1967 When this option is disabled, Tor does not try to resolve hostnames
1968 containing illegal characters (like @ and :) rather than sending them to an
1969 exit node to be resolved. This helps trap accidental attempts to resolve
1970 URLs and so on. This option only affects name lookups that your server does
1971 on behalf of clients. (Default: 0)
1973 [[BridgeRecordUsageByCountry]] **BridgeRecordUsageByCountry** **0**|**1**::
1974 When this option is enabled and BridgeRelay is also enabled, and we have
1975 GeoIP data, Tor keeps a per-country count of how many client
1976 addresses have contacted it so that it can help the bridge authority guess
1977 which countries have blocked access to it. (Default: 1)
1979 [[ServerDNSRandomizeCase]] **ServerDNSRandomizeCase** **0**|**1**::
1980 When this option is set, Tor sets the case of each character randomly in
1981 outgoing DNS requests, and makes sure that the case matches in DNS replies.
1982 This so-called "0x20 hack" helps resist some types of DNS poisoning attack.
1983 For more information, see "Increased DNS Forgery Resistance through
1984 0x20-Bit Encoding". This option only affects name lookups that your server
1985 does on behalf of clients. (Default: 1)
1987 [[GeoIPFile]] **GeoIPFile** __filename__::
1988 A filename containing IPv4 GeoIP data, for use with by-country statistics.
1990 [[GeoIPv6File]] **GeoIPv6File** __filename__::
1991 A filename containing IPv6 GeoIP data, for use with by-country statistics.
1993 [[CellStatistics]] **CellStatistics** **0**|**1**::
1995 When this option is enabled, Tor collects statistics about cell
1996 processing (i.e. mean time a cell is spending in a queue, mean
1997 number of cells in a queue and mean number of processed cells per
1998 circuit) and writes them into disk every 24 hours. Onion router
1999 operators may use the statistics for performance monitoring.
2000 If ExtraInfoStatistics is enabled, it will published as part of
2001 extra-info document. (Default: 0)
2003 [[PaddingStatistics]] **PaddingStatistics** **0**|**1**::
2005 When this option is enabled, Tor collects statistics for padding cells
2006 sent and received by this relay, in addition to total cell counts.
2007 These statistics are rounded, and omitted if traffic is low. This
2008 information is important for load balancing decisions related to padding.
2011 [[DirReqStatistics]] **DirReqStatistics** **0**|**1**::
2012 Relays and bridges only.
2013 When this option is enabled, a Tor directory writes statistics on the
2014 number and response time of network status requests to disk every 24
2015 hours. Enables relay and bridge operators to monitor how much their
2016 server is being used by clients to learn about Tor network.
2017 If ExtraInfoStatistics is enabled, it will published as part of
2018 extra-info document. (Default: 1)
2020 [[EntryStatistics]] **EntryStatistics** **0**|**1**::
2022 When this option is enabled, Tor writes statistics on the number of
2023 directly connecting clients to disk every 24 hours. Enables relay
2024 operators to monitor how much inbound traffic that originates from
2025 Tor clients passes through their server to go further down the
2026 Tor network. If ExtraInfoStatistics is enabled, it will be published
2027 as part of extra-info document. (Default: 0)
2029 [[ExitPortStatistics]] **ExitPortStatistics** **0**|**1**::
2031 When this option is enabled, Tor writes statistics on the number of
2032 relayed bytes and opened stream per exit port to disk every 24 hours.
2033 Enables exit relay operators to measure and monitor amounts of traffic
2034 that leaves Tor network through their exit node. If ExtraInfoStatistics
2035 is enabled, it will be published as part of extra-info document.
2038 [[ConnDirectionStatistics]] **ConnDirectionStatistics** **0**|**1**::
2040 When this option is enabled, Tor writes statistics on the amounts of
2041 traffic it passes between itself and other relays to disk every 24
2042 hours. Enables relay operators to monitor how much their relay is
2043 being used as middle node in the circuit. If ExtraInfoStatistics is
2044 enabled, it will be published as part of extra-info document.
2047 [[HiddenServiceStatistics]] **HiddenServiceStatistics** **0**|**1**::
2049 When this option is enabled, a Tor relay writes obfuscated
2050 statistics on its role as hidden-service directory, introduction
2051 point, or rendezvous point to disk every 24 hours. If
2052 ExtraInfoStatistics is also enabled, these statistics are further
2053 published to the directory authorities. (Default: 1)
2055 [[ExtraInfoStatistics]] **ExtraInfoStatistics** **0**|**1**::
2056 When this option is enabled, Tor includes previously gathered statistics in
2057 its extra-info documents that it uploads to the directory authorities.
2060 [[ExtendAllowPrivateAddresses]] **ExtendAllowPrivateAddresses** **0**|**1**::
2061 When this option is enabled, Tor will connect to relays on localhost,
2062 RFC1918 addresses, and so on. In particular, Tor will make direct OR
2063 connections, and Tor routers allow EXTEND requests, to these private
2064 addresses. (Tor will always allow connections to bridges, proxies, and
2065 pluggable transports configured on private addresses.) Enabling this
2066 option can create security issues; you should probably leave it off.
2069 [[MaxMemInQueues]] **MaxMemInQueues** __N__ **bytes**|**KB**|**MB**|**GB**::
2070 This option configures a threshold above which Tor will assume that it
2071 needs to stop queueing or buffering data because it's about to run out of
2072 memory. If it hits this threshold, it will begin killing circuits until
2073 it has recovered at least 10% of this memory. Do not set this option too
2074 low, or your relay may be unreliable under load. This option only
2075 affects some queues, so the actual process size will be larger than
2076 this. If this option is set to 0, Tor will try to pick a reasonable
2077 default based on your system's physical memory. (Default: 0)
2079 [[DisableOOSCheck]] **DisableOOSCheck** **0**|**1**::
2080 This option disables the code that closes connections when Tor notices
2081 that it is running low on sockets. Right now, it is on by default,
2082 since the existing out-of-sockets mechanism tends to kill OR connections
2083 more than it should. (Default: 1)
2085 [[SigningKeyLifetime]] **SigningKeyLifetime** __N__ **days**|**weeks**|**months**::
2086 For how long should each Ed25519 signing key be valid? Tor uses a
2087 permanent master identity key that can be kept offline, and periodically
2088 generates new "signing" keys that it uses online. This option
2089 configures their lifetime.
2092 [[OfflineMasterKey]] **OfflineMasterKey** **0**|**1**::
2093 If non-zero, the Tor relay will never generate or load its master secret
2094 key. Instead, you'll have to use "tor --keygen" to manage the permanent
2095 ed25519 master identity key, as well as the corresponding temporary
2096 signing keys and certificates. (Default: 0)
2098 DIRECTORY SERVER OPTIONS
2099 ------------------------
2101 The following options are useful only for directory servers. (Relays with
2102 enough bandwidth automatically become directory servers; see DirCache for
2105 [[DirPortFrontPage]] **DirPortFrontPage** __FILENAME__::
2106 When this option is set, it takes an HTML file and publishes it as "/" on
2107 the DirPort. Now relay operators can provide a disclaimer without needing
2108 to set up a separate webserver. There's a sample disclaimer in
2109 contrib/operator-tools/tor-exit-notice.html.
2111 [[DirPort]] **DirPort** \['address':]__PORT__|**auto** [_flags_]::
2112 If this option is nonzero, advertise the directory service on this port.
2113 Set it to "auto" to have Tor pick a port for you. This option can occur
2114 more than once, but only one advertised DirPort is supported: all
2115 but one DirPort must have the **NoAdvertise** flag set. (Default: 0) +
2117 The same flags are supported here as are supported by ORPort.
2119 [[DirPolicy]] **DirPolicy** __policy__,__policy__,__...__::
2120 Set an entrance policy for this server, to limit who can connect to the
2121 directory ports. The policies have the same form as exit policies above,
2122 except that port specifiers are ignored. Any address not matched by
2123 some entry in the policy is accepted.
2125 [[DirCache]] **DirCache** **0**|**1**::
2126 When this option is set, Tor caches all current directory documents and
2127 accepts client requests for them. Setting DirPort is not required for this,
2128 because clients connect via the ORPort by default. Setting either DirPort
2129 or BridgeRelay and setting DirCache to 0 is not supported. (Default: 1)
2131 [[MaxConsensusAgeForDiffs]] **MaxConsensusAgeForDiffs** __N__ **minutes**|**hours**|**days**|**weeks**::
2132 When this option is nonzero, Tor caches will not try to generate
2133 consensus diffs for any consensus older than this amount of time.
2134 If this option is set to zero, Tor will pick a reasonable default from
2135 the current networkstatus document. You should not set this
2136 option unless your cache is severely low on disk space or CPU.
2137 If you need to set it, keeping it above 3 or 4 hours will help clients
2138 much more than setting it to zero.
2142 DIRECTORY AUTHORITY SERVER OPTIONS
2143 ----------------------------------
2145 The following options enable operation as a directory authority, and
2146 control how Tor behaves as a directory authority. You should not need
2147 to adjust any of them if you're running a regular relay or exit server
2148 on the public Tor network.
2150 [[AuthoritativeDirectory]] **AuthoritativeDirectory** **0**|**1**::
2151 When this option is set to 1, Tor operates as an authoritative directory
2152 server. Instead of caching the directory, it generates its own list of
2153 good servers, signs it, and sends that to the clients. Unless the clients
2154 already have you listed as a trusted directory, you probably do not want
2157 [[V3AuthoritativeDirectory]] **V3AuthoritativeDirectory** **0**|**1**::
2158 When this option is set in addition to **AuthoritativeDirectory**, Tor
2159 generates version 3 network statuses and serves descriptors, etc as
2160 described in dir-spec.txt file of https://spec.torproject.org/[torspec]
2161 (for Tor clients and servers running at least 0.2.0.x).
2163 [[VersioningAuthoritativeDirectory]] **VersioningAuthoritativeDirectory** **0**|**1**::
2164 When this option is set to 1, Tor adds information on which versions of
2165 Tor are still believed safe for use to the published directory. Each
2166 version 1 authority is automatically a versioning authority; version 2
2167 authorities provide this service optionally. See **RecommendedVersions**,
2168 **RecommendedClientVersions**, and **RecommendedServerVersions**.
2170 [[RecommendedVersions]] **RecommendedVersions** __STRING__::
2171 STRING is a comma-separated list of Tor versions currently believed to be
2172 safe. The list is included in each directory, and nodes which pull down the
2173 directory learn whether they need to upgrade. This option can appear
2174 multiple times: the values from multiple lines are spliced together. When
2175 this is set then **VersioningAuthoritativeDirectory** should be set too.
2177 [[RecommendedPackages]] **RecommendedPackages** __PACKAGENAME__ __VERSION__ __URL__ __DIGESTTYPE__**=**__DIGEST__ ::
2178 Adds "package" line to the directory authority's vote. This information
2179 is used to vote on the correct URL and digest for the released versions
2180 of different Tor-related packages, so that the consensus can certify
2181 them. This line may appear any number of times.
2183 [[RecommendedClientVersions]] **RecommendedClientVersions** __STRING__::
2184 STRING is a comma-separated list of Tor versions currently believed to be
2185 safe for clients to use. This information is included in version 2
2186 directories. If this is not set then the value of **RecommendedVersions**
2187 is used. When this is set then **VersioningAuthoritativeDirectory** should
2190 [[BridgeAuthoritativeDir]] **BridgeAuthoritativeDir** **0**|**1**::
2191 When this option is set in addition to **AuthoritativeDirectory**, Tor
2192 accepts and serves server descriptors, but it caches and serves the main
2193 networkstatus documents rather than generating its own. (Default: 0)
2195 [[MinUptimeHidServDirectoryV2]] **MinUptimeHidServDirectoryV2** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2196 Minimum uptime of a v2 hidden service directory to be accepted as such by
2197 authoritative directories. (Default: 25 hours)
2199 [[RecommendedServerVersions]] **RecommendedServerVersions** __STRING__::
2200 STRING is a comma-separated list of Tor versions currently believed to be
2201 safe for servers to use. This information is included in version 2
2202 directories. If this is not set then the value of **RecommendedVersions**
2203 is used. When this is set then **VersioningAuthoritativeDirectory** should
2206 [[ConsensusParams]] **ConsensusParams** __STRING__::
2207 STRING is a space-separated list of key=value pairs that Tor will include
2208 in the "params" line of its networkstatus vote.
2210 [[DirAllowPrivateAddresses]] **DirAllowPrivateAddresses** **0**|**1**::
2211 If set to 1, Tor will accept server descriptors with arbitrary "Address"
2212 elements. Otherwise, if the address is not an IP address or is a private IP
2213 address, it will reject the server descriptor. Additionally, Tor
2214 will allow exit policies for private networks to fulfill Exit flag
2215 requirements. (Default: 0)
2217 [[AuthDirBadExit]] **AuthDirBadExit** __AddressPattern...__::
2218 Authoritative directories only. A set of address patterns for servers that
2219 will be listed as bad exits in any network status document this authority
2220 publishes, if **AuthDirListBadExits** is set. +
2222 (The address pattern syntax here and in the options below
2223 is the same as for exit policies, except that you don't need to say
2224 "accept" or "reject", and ports are not needed.)
2226 [[AuthDirInvalid]] **AuthDirInvalid** __AddressPattern...__::
2227 Authoritative directories only. A set of address patterns for servers that
2228 will never be listed as "valid" in any network status document that this
2229 authority publishes.
2231 [[AuthDirReject]] **AuthDirReject** __AddressPattern__...::
2232 Authoritative directories only. A set of address patterns for servers that
2233 will never be listed at all in any network status document that this
2234 authority publishes, or accepted as an OR address in any descriptor
2235 submitted for publication by this authority.
2237 [[AuthDirBadExitCCs]] **AuthDirBadExitCCs** __CC__,... +
2239 [[AuthDirInvalidCCs]] **AuthDirInvalidCCs** __CC__,... +
2241 [[AuthDirRejectCCs]] **AuthDirRejectCCs** __CC__,...::
2242 Authoritative directories only. These options contain a comma-separated
2243 list of country codes such that any server in one of those country codes
2244 will be marked as a bad exit/invalid for use, or rejected
2247 [[AuthDirListBadExits]] **AuthDirListBadExits** **0**|**1**::
2248 Authoritative directories only. If set to 1, this directory has some
2249 opinion about which nodes are unsuitable as exit nodes. (Do not set this to
2250 1 unless you plan to list non-functioning exits as bad; otherwise, you are
2251 effectively voting in favor of every declared exit as an exit.)
2253 [[AuthDirMaxServersPerAddr]] **AuthDirMaxServersPerAddr** __NUM__::
2254 Authoritative directories only. The maximum number of servers that we will
2255 list as acceptable on a single IP address. Set this to "0" for "no limit".
2258 [[AuthDirFastGuarantee]] **AuthDirFastGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
2259 Authoritative directories only. If non-zero, always vote the
2260 Fast flag for any relay advertising this amount of capacity or
2261 more. (Default: 100 KBytes)
2263 [[AuthDirGuardBWGuarantee]] **AuthDirGuardBWGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
2264 Authoritative directories only. If non-zero, this advertised capacity
2265 or more is always sufficient to satisfy the bandwidth requirement
2266 for the Guard flag. (Default: 2 MBytes)
2268 [[AuthDirPinKeys]] **AuthDirPinKeys** **0**|**1**::
2269 Authoritative directories only. If non-zero, do not allow any relay to
2270 publish a descriptor if any other relay has reserved its <Ed25519,RSA>
2271 identity keypair. In all cases, Tor records every keypair it accepts
2272 in a journal if it is new, or if it differs from the most recently
2273 accepted pinning for one of the keys it contains. (Default: 1)
2275 [[AuthDirSharedRandomness]] **AuthDirSharedRandomness** **0**|**1**::
2276 Authoritative directories only. Switch for the shared random protocol.
2277 If zero, the authority won't participate in the protocol. If non-zero
2278 (default), the flag "shared-rand-participate" is added to the authority
2279 vote indicating participation in the protocol. (Default: 1)
2281 [[AuthDirTestEd25519LinkKeys]] **AuthDirTestEd25519LinkKeys** **0**|**1**::
2282 Authoritative directories only. If this option is set to 0, then we treat
2283 relays as "Running" if their RSA key is correct when we probe them,
2284 regardless of their Ed25519 key. We should only ever set this option to 0
2285 if there is some major bug in Ed25519 link authentication that causes us
2286 to label all the relays as not Running. (Default: 1)
2288 [[BridgePassword]] **BridgePassword** __Password__::
2289 If set, contains an HTTP authenticator that tells a bridge authority to
2290 serve all requested bridge information. Used by the (only partially
2291 implemented) "bridge community" design, where a community of bridge
2292 relay operators all use an alternate bridge directory authority,
2293 and their target user audience can periodically fetch the list of
2294 available community bridges to stay up-to-date. (Default: not set)
2296 [[V3AuthVotingInterval]] **V3AuthVotingInterval** __N__ **minutes**|**hours**::
2297 V3 authoritative directories only. Configures the server's preferred voting
2298 interval. Note that voting will __actually__ happen at an interval chosen
2299 by consensus from all the authorities' preferred intervals. This time
2300 SHOULD divide evenly into a day. (Default: 1 hour)
2302 [[V3AuthVoteDelay]] **V3AuthVoteDelay** __N__ **minutes**|**hours**::
2303 V3 authoritative directories only. Configures the server's preferred delay
2304 between publishing its vote and assuming it has all the votes from all the
2305 other authorities. Note that the actual time used is not the server's
2306 preferred time, but the consensus of all preferences. (Default: 5 minutes)
2308 [[V3AuthDistDelay]] **V3AuthDistDelay** __N__ **minutes**|**hours**::
2309 V3 authoritative directories only. Configures the server's preferred delay
2310 between publishing its consensus and signature and assuming it has all the
2311 signatures from all the other authorities. Note that the actual time used
2312 is not the server's preferred time, but the consensus of all preferences.
2313 (Default: 5 minutes)
2315 [[V3AuthNIntervalsValid]] **V3AuthNIntervalsValid** __NUM__::
2316 V3 authoritative directories only. Configures the number of VotingIntervals
2317 for which each consensus should be valid for. Choosing high numbers
2318 increases network partitioning risks; choosing low numbers increases
2319 directory traffic. Note that the actual number of intervals used is not the
2320 server's preferred number, but the consensus of all preferences. Must be at
2321 least 2. (Default: 3)
2323 [[V3BandwidthsFile]] **V3BandwidthsFile** __FILENAME__::
2324 V3 authoritative directories only. Configures the location of the
2325 bandwidth-authority generated file storing information on relays' measured
2326 bandwidth capacities. (Default: unset)
2328 [[V3AuthUseLegacyKey]] **V3AuthUseLegacyKey** **0**|**1**::
2329 If set, the directory authority will sign consensuses not only with its
2330 own signing key, but also with a "legacy" key and certificate with a
2331 different identity. This feature is used to migrate directory authority
2332 keys in the event of a compromise. (Default: 0)
2334 [[RephistTrackTime]] **RephistTrackTime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2335 Tells an authority, or other node tracking node reliability and history,
2336 that fine-grained information about nodes can be discarded when it hasn't
2337 changed for a given amount of time. (Default: 24 hours)
2339 [[AuthDirHasIPv6Connectivity]] **AuthDirHasIPv6Connectivity** **0**|**1**::
2340 Authoritative directories only. When set to 0, OR ports with an
2341 IPv6 address are being accepted without reachability testing.
2342 When set to 1, IPv6 OR ports are being tested just like IPv4 OR
2345 [[MinMeasuredBWsForAuthToIgnoreAdvertised]] **MinMeasuredBWsForAuthToIgnoreAdvertised** __N__::
2346 A total value, in abstract bandwidth units, describing how much
2347 measured total bandwidth an authority should have observed on the network
2348 before it will treat advertised bandwidths as wholly
2349 unreliable. (Default: 500)
2351 HIDDEN SERVICE OPTIONS
2352 ----------------------
2354 The following options are used to configure a hidden service.
2356 [[HiddenServiceDir]] **HiddenServiceDir** __DIRECTORY__::
2357 Store data files for a hidden service in DIRECTORY. Every hidden service
2358 must have a separate directory. You may use this option multiple times to
2359 specify multiple services. If DIRECTORY does not exist, Tor will create it.
2360 (Note: in current versions of Tor, if DIRECTORY is a relative path,
2361 it will be relative to the current
2362 working directory of Tor instance, not to its DataDirectory. Do not
2363 rely on this behavior; it is not guaranteed to remain the same in future
2366 [[HiddenServicePort]] **HiddenServicePort** __VIRTPORT__ [__TARGET__]::
2367 Configure a virtual port VIRTPORT for a hidden service. You may use this
2368 option multiple times; each time applies to the service using the most
2369 recent HiddenServiceDir. By default, this option maps the virtual port to
2370 the same port on 127.0.0.1 over TCP. You may override the target port,
2371 address, or both by specifying a target of addr, port, addr:port, or
2372 **unix:**__path__. (You can specify an IPv6 target as [addr]:port. Unix
2373 paths may be quoted, and may use standard C escapes.)
2374 You may also have multiple lines with the same VIRTPORT: when a user
2375 connects to that VIRTPORT, one of the TARGETs from those lines will be
2378 [[PublishHidServDescriptors]] **PublishHidServDescriptors** **0**|**1**::
2379 If set to 0, Tor will run any hidden services you configure, but it won't
2380 advertise them to the rendezvous directory. This option is only useful if
2381 you're using a Tor controller that handles hidserv publishing for you.
2384 [[HiddenServiceVersion]] **HiddenServiceVersion** __version__,__version__,__...__::
2385 A list of rendezvous service descriptor versions to publish for the hidden
2386 service. Currently, versions 2 and 3 are supported. (Default: 2)
2388 [[HiddenServiceAuthorizeClient]] **HiddenServiceAuthorizeClient** __auth-type__ __client-name__,__client-name__,__...__::
2389 If configured, the hidden service is accessible for authorized clients
2390 only. The auth-type can either be \'basic' for a general-purpose
2391 authorization protocol or \'stealth' for a less scalable protocol that also
2392 hides service activity from unauthorized clients. Only clients that are
2393 listed here are authorized to access the hidden service. Valid client names
2394 are 1 to 16 characters long and only use characters in A-Za-z0-9+-_ (no
2395 spaces). If this option is set, the hidden service is not accessible for
2396 clients without authorization any more. Generated authorization data can be
2397 found in the hostname file. Clients need to put this authorization data in
2398 their configuration file using **HidServAuth**.
2400 [[HiddenServiceAllowUnknownPorts]] **HiddenServiceAllowUnknownPorts** **0**|**1**::
2401 If set to 1, then connections to unrecognized ports do not cause the
2402 current hidden service to close rendezvous circuits. (Setting this to 0 is
2403 not an authorization mechanism; it is instead meant to be a mild
2404 inconvenience to port-scanners.) (Default: 0)
2406 [[HiddenServiceMaxStreams]] **HiddenServiceMaxStreams** __N__::
2407 The maximum number of simultaneous streams (connections) per rendezvous
2408 circuit. The maximum value allowed is 65535. (Setting this to 0 will allow
2409 an unlimited number of simultanous streams.) (Default: 0)
2411 [[HiddenServiceMaxStreamsCloseCircuit]] **HiddenServiceMaxStreamsCloseCircuit** **0**|**1**::
2412 If set to 1, then exceeding **HiddenServiceMaxStreams** will cause the
2413 offending rendezvous circuit to be torn down, as opposed to stream creation
2414 requests that exceed the limit being silently ignored. (Default: 0)
2416 [[RendPostPeriod]] **RendPostPeriod** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2417 Every time the specified period elapses, Tor uploads any rendezvous
2418 service descriptors to the directory servers. This information is also
2419 uploaded whenever it changes. Minimum value allowed is 10 minutes and
2420 maximum is 3.5 days. (Default: 1 hour)
2422 [[HiddenServiceDirGroupReadable]] **HiddenServiceDirGroupReadable** **0**|**1**::
2423 If this option is set to 1, allow the filesystem group to read the
2424 hidden service directory and hostname file. If the option is set to 0,
2425 only owner is able to read the hidden service directory. (Default: 0)
2426 Has no effect on Windows.
2428 [[HiddenServiceNumIntroductionPoints]] **HiddenServiceNumIntroductionPoints** __NUM__::
2429 Number of introduction points the hidden service will have. You can't
2430 have more than 10. (Default: 3)
2432 [[HiddenServiceSingleHopMode]] **HiddenServiceSingleHopMode** **0**|**1**::
2433 **Experimental - Non Anonymous** Hidden Services on a tor instance in
2434 HiddenServiceSingleHopMode make one-hop (direct) circuits between the onion
2435 service server, and the introduction and rendezvous points. (Onion service
2436 descriptors are still posted using 3-hop paths, to avoid onion service
2437 directories blocking the service.)
2438 This option makes every hidden service instance hosted by a tor instance a
2439 Single Onion Service. One-hop circuits make Single Onion servers easily
2440 locatable, but clients remain location-anonymous. However, the fact that a
2441 client is accessing a Single Onion rather than a Hidden Service may be
2442 statistically distinguishable. +
2444 **WARNING:** Once a hidden service directory has been used by a tor
2445 instance in HiddenServiceSingleHopMode, it can **NEVER** be used again for
2446 a hidden service. It is best practice to create a new hidden service
2447 directory, key, and address for each new Single Onion Service and Hidden
2448 Service. It is not possible to run Single Onion Services and Hidden
2449 Services from the same tor instance: they should be run on different
2450 servers with different IP addresses. +
2452 HiddenServiceSingleHopMode requires HiddenServiceNonAnonymousMode to be set
2453 to 1. Since a Single Onion service is non-anonymous, you can not configure
2454 a SOCKSPort on a tor instance that is running in
2455 **HiddenServiceSingleHopMode**. Can not be changed while tor is running.
2458 [[HiddenServiceNonAnonymousMode]] **HiddenServiceNonAnonymousMode** **0**|**1**::
2459 Makes hidden services non-anonymous on this tor instance. Allows the
2460 non-anonymous HiddenServiceSingleHopMode. Enables direct connections in the
2461 server-side hidden service protocol. If you are using this option,
2462 you need to disable all client-side services on your Tor instance,
2463 including setting SOCKSPort to "0". Can not be changed while tor is
2464 running. (Default: 0)
2466 TESTING NETWORK OPTIONS
2467 -----------------------
2469 The following options are used for running a testing Tor network.
2471 [[TestingTorNetwork]] **TestingTorNetwork** **0**|**1**::
2472 If set to 1, Tor adjusts default values of the configuration options below,
2473 so that it is easier to set up a testing Tor network. May only be set if
2474 non-default set of DirAuthorities is set. Cannot be unset while Tor is
2478 ServerDNSAllowBrokenConfig 1
2479 DirAllowPrivateAddresses 1
2480 EnforceDistinctSubnets 0
2482 AuthDirMaxServersPerAddr 0
2483 AuthDirMaxServersPerAuthAddr 0
2484 ClientBootstrapConsensusAuthorityDownloadSchedule 0, 2,
2485 4 (for 40 seconds), 8, 16, 32, 60
2486 ClientBootstrapConsensusFallbackDownloadSchedule 0, 1,
2487 4 (for 40 seconds), 8, 16, 32, 60
2488 ClientBootstrapConsensusAuthorityOnlyDownloadSchedule 0, 1,
2489 4 (for 40 seconds), 8, 16, 32, 60
2490 ClientBootstrapConsensusMaxDownloadTries 80
2491 ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries 80
2492 TestingClientDNSRejectInternalAddresses 0
2493 ClientRejectInternalAddresses 0
2494 CountPrivateBandwidth 1
2495 ExitPolicyRejectPrivate 0
2496 ExtendAllowPrivateAddresses 1
2497 V3AuthVotingInterval 5 minutes
2498 V3AuthVoteDelay 20 seconds
2499 V3AuthDistDelay 20 seconds
2500 MinUptimeHidServDirectoryV2 0 seconds
2501 TestingV3AuthInitialVotingInterval 5 minutes
2502 TestingV3AuthInitialVoteDelay 20 seconds
2503 TestingV3AuthInitialDistDelay 20 seconds
2504 TestingAuthDirTimeToLearnReachability 0 minutes
2505 TestingEstimatedDescriptorPropagationTime 0 minutes
2506 TestingServerDownloadSchedule 0, 0, 0, 5, 10, 15, 20, 30, 60
2507 TestingClientDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2508 TestingServerConsensusDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2509 TestingClientConsensusDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2510 TestingBridgeDownloadSchedule 10, 30, 60
2511 TestingBridgeBootstrapDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2512 TestingClientMaxIntervalWithoutRequest 5 seconds
2513 TestingDirConnectionMaxStall 30 seconds
2514 TestingConsensusMaxDownloadTries 80
2515 TestingDescriptorMaxDownloadTries 80
2516 TestingMicrodescMaxDownloadTries 80
2517 TestingCertMaxDownloadTries 80
2518 TestingEnableConnBwEvent 1
2519 TestingEnableCellStatsEvent 1
2520 TestingEnableTbEmptyEvent 1
2522 [[TestingV3AuthInitialVotingInterval]] **TestingV3AuthInitialVotingInterval** __N__ **minutes**|**hours**::
2523 Like V3AuthVotingInterval, but for initial voting interval before the first
2524 consensus has been created. Changing this requires that
2525 **TestingTorNetwork** is set. (Default: 30 minutes)
2527 [[TestingV3AuthInitialVoteDelay]] **TestingV3AuthInitialVoteDelay** __N__ **minutes**|**hours**::
2528 Like V3AuthVoteDelay, but for initial voting interval before
2529 the first consensus has been created. Changing this requires that
2530 **TestingTorNetwork** is set. (Default: 5 minutes)
2532 [[TestingV3AuthInitialDistDelay]] **TestingV3AuthInitialDistDelay** __N__ **minutes**|**hours**::
2533 Like V3AuthDistDelay, but for initial voting interval before
2534 the first consensus has been created. Changing this requires that
2535 **TestingTorNetwork** is set. (Default: 5 minutes)
2537 [[TestingV3AuthVotingStartOffset]] **TestingV3AuthVotingStartOffset** __N__ **seconds**|**minutes**|**hours**::
2538 Directory authorities offset voting start time by this much.
2539 Changing this requires that **TestingTorNetwork** is set. (Default: 0)
2541 [[TestingAuthDirTimeToLearnReachability]] **TestingAuthDirTimeToLearnReachability** __N__ **minutes**|**hours**::
2542 After starting as an authority, do not make claims about whether routers
2543 are Running until this much time has passed. Changing this requires
2544 that **TestingTorNetwork** is set. (Default: 30 minutes)
2546 [[TestingEstimatedDescriptorPropagationTime]] **TestingEstimatedDescriptorPropagationTime** __N__ **minutes**|**hours**::
2547 Clients try downloading server descriptors from directory caches after this
2548 time. Changing this requires that **TestingTorNetwork** is set. (Default:
2551 [[TestingMinFastFlagThreshold]] **TestingMinFastFlagThreshold** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
2552 Minimum value for the Fast flag. Overrides the ordinary minimum taken
2553 from the consensus when TestingTorNetwork is set. (Default: 0.)
2555 [[TestingServerDownloadSchedule]] **TestingServerDownloadSchedule** __N__,__N__,__...__::
2556 Schedule for when servers should download things in general. Changing this
2557 requires that **TestingTorNetwork** is set. (Default: 0, 0, 0, 60, 60, 120,
2558 300, 900, 2147483647)
2560 [[TestingClientDownloadSchedule]] **TestingClientDownloadSchedule** __N__,__N__,__...__::
2561 Schedule for when clients should download things in general. Changing this
2562 requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2565 [[TestingServerConsensusDownloadSchedule]] **TestingServerConsensusDownloadSchedule** __N__,__N__,__...__::
2566 Schedule for when servers should download consensuses. Changing this
2567 requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2568 1800, 1800, 1800, 1800, 1800, 3600, 7200)
2570 [[TestingClientConsensusDownloadSchedule]] **TestingClientConsensusDownloadSchedule** __N__,__N__,__...__::
2571 Schedule for when clients should download consensuses. Changing this
2572 requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2573 1800, 3600, 3600, 3600, 10800, 21600, 43200)
2575 [[TestingBridgeDownloadSchedule]] **TestingBridgeDownloadSchedule** __N__,__N__,__...__::
2576 Schedule for when clients should download each bridge descriptor when they
2577 know that one or more of their configured bridges are running. Changing
2578 this requires that **TestingTorNetwork** is set. (Default: 10800, 25200,
2579 54000, 111600, 262800)
2581 [[TestingBridgeBootstrapDownloadSchedule]] **TestingBridgeBootstrapDownloadSchedule** __N__,__N__,__...__::
2582 Schedule for when clients should download each bridge descriptor when they
2583 have just started, or when they can not contact any of their bridges.
2584 Changing this requires that **TestingTorNetwork** is set. (Default: 0, 30,
2585 90, 600, 3600, 10800, 25200, 54000, 111600, 262800)
2587 [[TestingClientMaxIntervalWithoutRequest]] **TestingClientMaxIntervalWithoutRequest** __N__ **seconds**|**minutes**::
2588 When directory clients have only a few descriptors to request, they batch
2589 them until they have more, or until this amount of time has passed.
2590 Changing this requires that **TestingTorNetwork** is set. (Default: 10
2593 [[TestingDirConnectionMaxStall]] **TestingDirConnectionMaxStall** __N__ **seconds**|**minutes**::
2594 Let a directory connection stall this long before expiring it.
2595 Changing this requires that **TestingTorNetwork** is set. (Default:
2598 [[TestingConsensusMaxDownloadTries]] **TestingConsensusMaxDownloadTries** __NUM__::
2599 Try this many times to download a consensus before giving up. Changing
2600 this requires that **TestingTorNetwork** is set. (Default: 8)
2602 [[TestingDescriptorMaxDownloadTries]] **TestingDescriptorMaxDownloadTries** __NUM__::
2603 Try this often to download a server descriptor before giving up.
2604 Changing this requires that **TestingTorNetwork** is set. (Default: 8)
2606 [[TestingMicrodescMaxDownloadTries]] **TestingMicrodescMaxDownloadTries** __NUM__::
2607 Try this often to download a microdesc descriptor before giving up.
2608 Changing this requires that **TestingTorNetwork** is set. (Default: 8)
2610 [[TestingCertMaxDownloadTries]] **TestingCertMaxDownloadTries** __NUM__::
2611 Try this often to download a v3 authority certificate before giving up.
2612 Changing this requires that **TestingTorNetwork** is set. (Default: 8)
2614 [[TestingDirAuthVoteExit]] **TestingDirAuthVoteExit** __node__,__node__,__...__::
2615 A list of identity fingerprints, country codes, and
2616 address patterns of nodes to vote Exit for regardless of their
2617 uptime, bandwidth, or exit policy. See the **ExcludeNodes**
2618 option for more information on how to specify nodes. +
2620 In order for this option to have any effect, **TestingTorNetwork**
2621 has to be set. See the **ExcludeNodes** option for more
2622 information on how to specify nodes.
2624 [[TestingDirAuthVoteExitIsStrict]] **TestingDirAuthVoteExitIsStrict** **0**|**1** ::
2625 If True (1), a node will never receive the Exit flag unless it is specified
2626 in the **TestingDirAuthVoteExit** list, regardless of its uptime, bandwidth,
2629 In order for this option to have any effect, **TestingTorNetwork**
2632 [[TestingDirAuthVoteGuard]] **TestingDirAuthVoteGuard** __node__,__node__,__...__::
2633 A list of identity fingerprints and country codes and
2634 address patterns of nodes to vote Guard for regardless of their
2635 uptime and bandwidth. See the **ExcludeNodes** option for more
2636 information on how to specify nodes. +
2638 In order for this option to have any effect, **TestingTorNetwork**
2641 [[TestingDirAuthVoteGuardIsStrict]] **TestingDirAuthVoteGuardIsStrict** **0**|**1** ::
2642 If True (1), a node will never receive the Guard flag unless it is specified
2643 in the **TestingDirAuthVoteGuard** list, regardless of its uptime and bandwidth. +
2645 In order for this option to have any effect, **TestingTorNetwork**
2648 [[TestingDirAuthVoteHSDir]] **TestingDirAuthVoteHSDir** __node__,__node__,__...__::
2649 A list of identity fingerprints and country codes and
2650 address patterns of nodes to vote HSDir for regardless of their
2651 uptime and DirPort. See the **ExcludeNodes** option for more
2652 information on how to specify nodes. +
2654 In order for this option to have any effect, **TestingTorNetwork**
2657 [[TestingDirAuthVoteHSDirIsStrict]] **TestingDirAuthVoteHSDirIsStrict** **0**|**1** ::
2658 If True (1), a node will never receive the HSDir flag unless it is specified
2659 in the **TestingDirAuthVoteHSDir** list, regardless of its uptime and DirPort. +
2661 In order for this option to have any effect, **TestingTorNetwork**
2664 [[TestingEnableConnBwEvent]] **TestingEnableConnBwEvent** **0**|**1**::
2665 If this option is set, then Tor controllers may register for CONN_BW
2666 events. Changing this requires that **TestingTorNetwork** is set.
2669 [[TestingEnableCellStatsEvent]] **TestingEnableCellStatsEvent** **0**|**1**::
2670 If this option is set, then Tor controllers may register for CELL_STATS
2671 events. Changing this requires that **TestingTorNetwork** is set.
2674 [[TestingEnableTbEmptyEvent]] **TestingEnableTbEmptyEvent** **0**|**1**::
2675 If this option is set, then Tor controllers may register for TB_EMPTY
2676 events. Changing this requires that **TestingTorNetwork** is set.
2679 [[TestingMinExitFlagThreshold]] **TestingMinExitFlagThreshold** __N__ **KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
2680 Sets a lower-bound for assigning an exit flag when running as an
2681 authority on a testing network. Overrides the usual default lower bound
2682 of 4 KB. (Default: 0)
2684 [[TestingLinkCertLifetime]] **TestingLinkCertLifetime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**|**months**::
2685 Overrides the default lifetime for the certificates used to authenticate
2686 our X509 link cert with our ed25519 signing key.
2689 [[TestingAuthKeyLifetime]] **TestingAuthKeyLifetime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**|**months**::
2690 Overrides the default lifetime for a signing Ed25519 TLS Link authentication
2694 [[TestingLinkKeySlop]] **TestingLinkKeySlop** __N__ **seconds**|**minutes**|**hours** +
2696 [[TestingAuthKeySlop]] **TestingAuthKeySlop** __N__ **seconds**|**minutes**|**hours** +
2698 [[TestingSigningKeySlop]] **TestingSigningKeySlop** __N__ **seconds**|**minutes**|**hours**::
2699 How early before the official expiration of a an Ed25519 signing key do
2700 we replace it and issue a new key?
2701 (Default: 3 hours for link and auth; 1 day for signing.)
2703 [[ClientDNSRejectInternalAddresses]] [[TestingClientDNSRejectInternalAddresses]] **TestingClientDNSRejectInternalAddresses** **0**|**1**::
2704 If true, Tor does not believe any anonymously retrieved DNS answer that
2705 tells it that an address resolves to an internal address (like 127.0.0.1 or
2706 192.168.0.1). This option prevents certain browser-based attacks; don't
2707 turn it off unless you know what you're doing. (Default: 1)
2710 NON-PERSISTENT OPTIONS
2711 ----------------------
2713 These options are not saved to the torrc file by the "SAVECONF" controller
2714 command. Other options of this type are documented in control-spec.txt,
2715 section 5.4. End-users should mostly ignore them.
2717 [[UnderscorePorts]] **\_\_ControlPort**, **\_\_DirPort**, **\_\_DNSPort**, **\_\_ExtORPort**, **\_\_NATDPort**, **\_\_ORPort**, **\_\_SocksPort**, **\_\_TransPort**::
2718 These underscore-prefixed options are variants of the regular Port
2719 options. They behave the same, except they are not saved to the
2720 torrc file by the controller's SAVECONF command.
2726 Tor catches the following signals:
2728 [[SIGTERM]] **SIGTERM**::
2729 Tor will catch this, clean up and sync to disk if necessary, and exit.
2731 [[SIGINT]] **SIGINT**::
2732 Tor clients behave as with SIGTERM; but Tor servers will do a controlled
2733 slow shutdown, closing listeners and waiting 30 seconds before exiting.
2734 (The delay can be configured with the ShutdownWaitLength config option.)
2736 [[SIGHUP]] **SIGHUP**::
2737 The signal instructs Tor to reload its configuration (including closing and
2738 reopening logs), and kill and restart its helper processes if applicable.
2740 [[SIGUSR1]] **SIGUSR1**::
2741 Log statistics about current connections, past connections, and throughput.
2743 [[SIGUSR2]] **SIGUSR2**::
2744 Switch all logs to loglevel debug. You can go back to the old loglevels by
2747 [[SIGCHLD]] **SIGCHLD**::
2748 Tor receives this signal when one of its helper processes has exited, so it
2751 [[SIGPIPE]] **SIGPIPE**::
2752 Tor catches this signal and ignores it.
2754 [[SIGXFSZ]] **SIGXFSZ**::
2755 If this signal exists on your platform, Tor catches and ignores it.
2760 **@CONFDIR@/torrc**::
2761 The configuration file, which contains "option value" pairs.
2764 Fallback location for torrc, if @CONFDIR@/torrc is not found.
2766 **@LOCALSTATEDIR@/lib/tor/**::
2767 The tor process stores keys and other data here.
2769 __DataDirectory__**/cached-status/**::
2770 The most recently downloaded network status document for each authority.
2771 Each file holds one such document; the filenames are the hexadecimal
2772 identity key fingerprints of the directory authorities. Obsolete;
2775 __DataDirectory__**/cached-certs**::
2776 This file holds downloaded directory key certificates that are used to
2777 verify authenticity of documents generated by Tor directory authorities.
2779 __DataDirectory__**/cached-consensus** and/or **cached-microdesc-consensus**::
2780 The most recent consensus network status document we've downloaded.
2782 __DataDirectory__**/cached-descriptors** and **cached-descriptors.new**::
2783 These files hold downloaded router statuses. Some routers may appear more
2784 than once; if so, the most recently published descriptor is used. Lines
2785 beginning with @-signs are annotations that contain more information about
2786 a given router. The ".new" file is an append-only journal; when it gets
2787 too large, all entries are merged into a new cached-descriptors file.
2789 __DataDirectory__**/cached-extrainfo** and **cached-extrainfo.new**::
2790 As "cached-descriptors", but holds optionally-downloaded "extra-info"
2791 documents. Relays use these documents to send inessential information
2792 about statistics, bandwidth history, and network health to the
2793 authorities. They aren't fetched by default; see the DownloadExtraInfo
2794 option for more info.
2796 __DataDirectory__**/cached-microdescs** and **cached-microdescs.new**::
2797 These files hold downloaded microdescriptors. Lines beginning with
2798 @-signs are annotations that contain more information about a given
2799 router. The ".new" file is an append-only journal; when it gets too
2800 large, all entries are merged into a new cached-microdescs file.
2802 __DataDirectory__**/cached-routers** and **cached-routers.new**::
2803 Obsolete versions of cached-descriptors and cached-descriptors.new. When
2804 Tor can't find the newer files, it looks here instead.
2806 __DataDirectory__**/state**::
2807 A set of persistent key-value mappings. These are documented in
2808 the file. These include:
2809 - The current entry guards and their status.
2810 - The current bandwidth accounting values.
2811 - When the file was last written
2812 - What version of Tor generated the state file
2813 - A short history of bandwidth usage, as produced in the server
2816 __DataDirectory__**/sr-state**::
2817 Authority only. State file used to record information about the current
2818 status of the shared-random-value voting state.
2820 __DataDirectory__**/diff-cache**::
2821 Directory cache only. Holds older consensuses, and diffs from older
2822 consensuses to the most recent consensus of each type, compressed
2823 in various ways. Each file contains a set of key-value arguments
2824 decribing its contents, followed by a single NUL byte, followed by the
2827 __DataDirectory__**/bw_accounting**::
2828 Used to track bandwidth accounting values (when the current period starts
2829 and ends; how much has been read and written so far this period). This file
2830 is obsolete, and the data is now stored in the \'state' file instead.
2832 __DataDirectory__**/control_auth_cookie**::
2833 Used for cookie authentication with the controller. Location can be
2834 overridden by the CookieAuthFile config option. Regenerated on startup. See
2835 control-spec.txt in https://spec.torproject.org/[torspec] for details.
2836 Only used when cookie authentication is enabled.
2838 __DataDirectory__**/lock**::
2839 This file is used to prevent two Tor instances from using same data
2840 directory. If access to this file is locked, data directory is already
2843 __DataDirectory__**/key-pinning-journal**::
2844 Used by authorities. A line-based file that records mappings between
2845 RSA1024 identity keys and Ed25519 identity keys. Authorities enforce
2846 these mappings, so that once a relay has picked an Ed25519 key, stealing
2847 or factoring the RSA1024 key will no longer let an attacker impersonate
2850 __DataDirectory__**/keys/***::
2851 Only used by servers. Holds identity keys and onion keys.
2853 __DataDirectory__**/keys/authority_identity_key**::
2854 A v3 directory authority's master identity key, used to authenticate its
2855 signing key. Tor doesn't use this while it's running. The tor-gencert
2856 program uses this. If you're running an authority, you should keep this
2857 key offline, and not actually put it here.
2859 __DataDirectory__**/keys/authority_certificate**::
2860 A v3 directory authority's certificate, which authenticates the authority's
2861 current vote- and consensus-signing key using its master identity key.
2862 Only directory authorities use this file.
2864 __DataDirectory__**/keys/authority_signing_key**::
2865 A v3 directory authority's signing key, used to sign votes and consensuses.
2866 Only directory authorities use this file. Corresponds to the
2867 **authority_certificate** cert.
2869 __DataDirectory__**/keys/legacy_certificate**::
2870 As authority_certificate: used only when V3AuthUseLegacyKey is set.
2871 See documentation for V3AuthUseLegacyKey.
2873 __DataDirectory__**/keys/legacy_signing_key**::
2874 As authority_signing_key: used only when V3AuthUseLegacyKey is set.
2875 See documentation for V3AuthUseLegacyKey.
2877 __DataDirectory__**/keys/secret_id_key**::
2878 A relay's RSA1024 permanent identity key, including private and public
2879 components. Used to sign router descriptors, and to sign other keys.
2881 __DataDirectory__**/keys/ed25519_master_id_public_key**::
2882 The public part of a relay's Ed25519 permanent identity key.
2884 __DataDirectory__**/keys/ed25519_master_id_secret_key**::
2885 The private part of a relay's Ed25519 permanent identity key. This key
2886 is used to sign the medium-term ed25519 signing key. This file can be
2887 kept offline, or kept encrypted. If so, Tor will not be able to generate
2888 new signing keys itself; you'll need to use tor --keygen yourself to do
2891 __DataDirectory__**/keys/ed25519_signing_secret_key**::
2892 The private and public components of a relay's medium-term Ed25519 signing
2893 key. This key is authenticated by the Ed25519 master key, in turn
2894 authenticates other keys (and router descriptors).
2896 __DataDirectory__**/keys/ed25519_signing_cert**::
2897 The certificate which authenticates "ed25519_signing_secret_key" as
2898 having been signed by the Ed25519 master key.
2900 __DataDirectory__**/keys/secret_onion_key** and **secret_onion_key.old**::
2901 A relay's RSA1024 short-term onion key. Used to decrypt old-style ("TAP")
2902 circuit extension requests. The ".old" file holds the previously
2903 generated key, which the relay uses to handle any requests that were
2904 made by clients that didn't have the new one.
2906 __DataDirectory__**/keys/secret_onion_key_ntor** and **secret_onion_key_ntor.old**::
2907 A relay's Curve25519 short-term onion key. Used to handle modern ("ntor")
2908 circuit extension requests. The ".old" file holds the previously
2909 generated key, which the relay uses to handle any requests that were
2910 made by clients that didn't have the new one.
2912 __DataDirectory__**/fingerprint**::
2913 Only used by servers. Holds the fingerprint of the server's identity key.
2915 __DataDirectory__**/hashed-fingerprint**::
2916 Only used by bridges. Holds the hashed fingerprint of the bridge's
2917 identity key. (That is, the hash of the hash of the identity key.)
2919 __DataDirectory__**/approved-routers**::
2920 Only used by authoritative directory servers. This file lists
2921 the status of routers by their identity fingerprint.
2922 Each line lists a status and a fingerprint separated by
2923 whitespace. See your **fingerprint** file in the __DataDirectory__ for an
2924 example line. If the status is **!reject** then descriptors from the
2925 given identity (fingerprint) are rejected by this server. If it is
2926 **!invalid** then descriptors are accepted but marked in the directory as
2927 not valid, that is, not recommended.
2929 __DataDirectory__**/v3-status-votes**::
2930 Only for v3 authoritative directory servers. This file contains
2931 status votes from all the authoritative directory servers.
2933 __DataDirectory__**/unverified-consensus**::
2934 This file contains a network consensus document that has been downloaded,
2935 but which we didn't have the right certificates to check yet.
2937 __DataDirectory__**/unverified-microdesc-consensus**::
2938 This file contains a microdescriptor-flavored network consensus document
2939 that has been downloaded, but which we didn't have the right certificates
2942 __DataDirectory__**/unparseable-desc**::
2943 Onion server descriptors that Tor was unable to parse are dumped to this
2944 file. Only used for debugging.
2946 __DataDirectory__**/router-stability**::
2947 Only used by authoritative directory servers. Tracks measurements for
2948 router mean-time-between-failures so that authorities have a good idea of
2949 how to set their Stable flags.
2951 __DataDirectory__**/stats/dirreq-stats**::
2952 Only used by directory caches and authorities. This file is used to
2953 collect directory request statistics.
2955 __DataDirectory__**/stats/entry-stats**::
2956 Only used by servers. This file is used to collect incoming connection
2957 statistics by Tor entry nodes.
2959 __DataDirectory__**/stats/bridge-stats**::
2960 Only used by servers. This file is used to collect incoming connection
2961 statistics by Tor bridges.
2963 __DataDirectory__**/stats/exit-stats**::
2964 Only used by servers. This file is used to collect outgoing connection
2965 statistics by Tor exit routers.
2967 __DataDirectory__**/stats/buffer-stats**::
2968 Only used by servers. This file is used to collect buffer usage
2971 __DataDirectory__**/stats/conn-stats**::
2972 Only used by servers. This file is used to collect approximate connection
2973 history (number of active connections over time).
2975 __DataDirectory__**/stats/hidserv-stats**::
2976 Only used by servers. This file is used to collect approximate counts
2977 of what fraction of the traffic is hidden service rendezvous traffic, and
2978 approximately how many hidden services the relay has seen.
2980 __DataDirectory__**/networkstatus-bridges**::
2981 Only used by authoritative bridge directories. Contains information
2982 about bridges that have self-reported themselves to the bridge
2985 __DataDirectory__**/approved-routers**::
2986 Authorities only. This file is used to configure which relays are
2987 known to be valid, invalid, and so forth.
2989 __HiddenServiceDirectory__**/hostname**::
2990 The <base32-encoded-fingerprint>.onion domain name for this hidden service.
2991 If the hidden service is restricted to authorized clients only, this file
2992 also contains authorization data for all clients.
2994 Note that clients will ignore any extra subdomains prepended to a hidden
2995 service hostname. So if you have "xyz.onion" as your hostname, you
2996 can tell clients to connect to "www.xyz.onion" or "irc.xyz.onion"
2997 for virtual-hosting purposes.
2999 __HiddenServiceDirectory__**/private_key**::
3000 The private key for this hidden service.
3002 __HiddenServiceDirectory__**/client_keys**::
3003 Authorization data for a hidden service that is only accessible by
3006 __HiddenServiceDirectory__**/onion_service_non_anonymous**::
3007 This file is present if a hidden service key was created in
3008 **HiddenServiceNonAnonymousMode**.
3012 **torsocks**(1), **torify**(1) +
3014 **https://www.torproject.org/**
3016 **torspec: https://spec.torproject.org **
3021 Plenty, probably. Tor is still in development. Please report them at https://trac.torproject.org/.
3025 Roger Dingledine [arma at mit.edu], Nick Mathewson [nickm at alum.mit.edu].