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.
132 Other options can be specified on the command-line in the format "--option
133 value", in the format "option value", or in a configuration file. For
134 instance, you can tell Tor to start listening for SOCKS connections on port
135 9999 by passing --SocksPort 9999 or SocksPort 9999 to it on the command line,
136 or by putting "SocksPort 9999" in the configuration file. You will need to
137 quote options with spaces in them: if you want Tor to log all debugging
138 messages to debug.log, you will probably need to say --Log 'debug file
141 Options on the command line override those in configuration files. See the
142 next section for more information.
144 THE CONFIGURATION FILE FORMAT
145 -----------------------------
147 All configuration options in a configuration are written on a single line by
148 default. They take the form of an option name and a value, or an option name
149 and a quoted value (option value or option "value"). Anything after a #
150 character is treated as a comment. Options are
151 case-insensitive. C-style escaped characters are allowed inside quoted
152 values. To split one configuration entry into multiple lines, use a single
153 backslash character (\) before the end of the line. Comments can be used in
154 such multiline entries, but they must start at the beginning of a line.
156 By default, an option on the command line overrides an option found in the
157 configuration file, and an option in a configuration file overrides one in
160 This rule is simple for options that take a single value, but it can become
161 complicated for options that are allowed to occur more than once: if you
162 specify four SocksPorts in your configuration file, and one more SocksPort on
163 the command line, the option on the command line will replace __all__ of the
164 SocksPorts in the configuration file. If this isn't what you want, prefix
165 the option name with a plus sign (+), and it will be appended to the previous
166 set of options instead. For example, setting SocksPort 9100 will use only
167 port 9100, but setting +SocksPort 9100 will use ports 9100 and 9050 (because
168 this is the default).
170 Alternatively, you might want to remove every instance of an option in the
171 configuration file, and not replace it at all: you might want to say on the
172 command line that you want no SocksPorts at all. To do that, prefix the
173 option name with a forward slash (/). You can use the plus sign (+) and the
174 forward slash (/) in the configuration file and on the command line.
179 [[BandwidthRate]] **BandwidthRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
180 A token bucket limits the average incoming bandwidth usage on this node
181 to the specified number of bytes per second, and the average outgoing
182 bandwidth usage to that same value. If you want to run a relay in the
183 public network, this needs to be _at the very least_ 75 KBytes for a
184 relay (that is, 600 kbits) or 50 KBytes for a bridge (400 kbits) -- but of
185 course, more is better; we recommend at least 250 KBytes (2 mbits) if
186 possible. (Default: 1 GByte) +
188 With this option, and in other options that take arguments in bytes,
189 KBytes, and so on, other formats are also supported. Notably, "KBytes" can
190 also be written as "kilobytes" or "kb"; "MBytes" can be written as
191 "megabytes" or "MB"; "kbits" can be written as "kilobits"; and so forth.
192 Tor also accepts "byte" and "bit" in the singular.
193 The prefixes "tera" and "T" are also recognized.
194 If no units are given, we default to bytes.
195 To avoid confusion, we recommend writing "bytes" or "bits" explicitly,
196 since it's easy to forget that "B" means bytes, not bits.
198 [[BandwidthBurst]] **BandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
199 Limit the maximum token bucket size (also known as the burst) to the given
200 number of bytes in each direction. (Default: 1 GByte)
202 [[MaxAdvertisedBandwidth]] **MaxAdvertisedBandwidth** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
203 If set, we will not advertise more than this amount of bandwidth for our
204 BandwidthRate. Server operators who want to reduce the number of clients
205 who ask to build circuits through them (since this is proportional to
206 advertised bandwidth rate) can thus reduce the CPU demands on their server
207 without impacting network performance.
209 [[RelayBandwidthRate]] **RelayBandwidthRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
210 If not 0, a separate token bucket limits the average incoming bandwidth
211 usage for \_relayed traffic_ on this node to the specified number of bytes
212 per second, and the average outgoing bandwidth usage to that same value.
213 Relayed traffic currently is calculated to include answers to directory
214 requests, but that may change in future versions. (Default: 0)
216 [[RelayBandwidthBurst]] **RelayBandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
217 If not 0, limit the maximum token bucket size (also known as the burst) for
218 \_relayed traffic_ to the given number of bytes in each direction.
221 [[PerConnBWRate]] **PerConnBWRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
222 If set, do separate rate limiting for each connection from a non-relay.
223 You should never need to change this value, since a network-wide value is
224 published in the consensus and your relay will use that value. (Default: 0)
226 [[PerConnBWBurst]] **PerConnBWBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
227 If set, do separate rate limiting for each connection from a non-relay.
228 You should never need to change this value, since a network-wide value is
229 published in the consensus and your relay will use that value. (Default: 0)
231 [[ClientTransportPlugin]] **ClientTransportPlugin** __transport__ socks4|socks5 __IP__:__PORT__::
232 **ClientTransportPlugin** __transport__ exec __path-to-binary__ [options]::
233 In its first form, when set along with a corresponding Bridge line, the Tor
234 client forwards its traffic to a SOCKS-speaking proxy on "IP:PORT". It's the
235 duty of that proxy to properly forward the traffic to the bridge. +
237 In its second form, when set along with a corresponding Bridge line, the Tor
238 client launches the pluggable transport proxy executable in
239 __path-to-binary__ using __options__ as its command-line options, and
240 forwards its traffic to it. It's the duty of that proxy to properly forward
241 the traffic to the bridge.
243 [[ServerTransportPlugin]] **ServerTransportPlugin** __transport__ exec __path-to-binary__ [options]::
244 The Tor relay launches the pluggable transport proxy in __path-to-binary__
245 using __options__ as its command-line options, and expects to receive
246 proxied client traffic from it.
248 [[ServerTransportListenAddr]] **ServerTransportListenAddr** __transport__ __IP__:__PORT__::
249 When this option is set, Tor will suggest __IP__:__PORT__ as the
250 listening address of any pluggable transport proxy that tries to
251 launch __transport__.
253 [[ServerTransportOptions]] **ServerTransportOptions** __transport__ __k=v__ __k=v__ ...::
254 When this option is set, Tor will pass the __k=v__ parameters to
255 any pluggable transport proxy that tries to launch __transport__. +
256 (Example: ServerTransportOptions obfs45 shared-secret=bridgepasswd cache=/var/lib/tor/cache)
258 [[ExtORPort]] **ExtORPort** \['address':]__port__|**auto**::
259 Open this port to listen for Extended ORPort connections from your
260 pluggable transports.
262 [[ExtORPortCookieAuthFile]] **ExtORPortCookieAuthFile** __Path__::
263 If set, this option overrides the default location and file name
264 for the Extended ORPort's cookie file -- the cookie file is needed
265 for pluggable transports to communicate through the Extended ORPort.
267 [[ExtORPortCookieAuthFileGroupReadable]] **ExtORPortCookieAuthFileGroupReadable** **0**|**1**::
268 If this option is set to 0, don't allow the filesystem group to read the
269 Extended OR Port cookie file. If the option is set to 1, make the cookie
270 file readable by the default GID. [Making the file readable by other
271 groups is not yet implemented; let us know if you need this for some
272 reason.] (Default: 0)
274 [[ConnLimit]] **ConnLimit** __NUM__::
275 The minimum number of file descriptors that must be available to the Tor
276 process before it will start. Tor will ask the OS for as many file
277 descriptors as the OS will allow (you can find this by "ulimit -H -n").
278 If this number is less than ConnLimit, then Tor will refuse to start. +
280 You probably don't need to adjust this. It has no effect on Windows
281 since that platform lacks getrlimit(). (Default: 1000)
283 [[DisableNetwork]] **DisableNetwork** **0**|**1**::
284 When this option is set, we don't listen for or accept any connections
285 other than controller connections, and we close (and don't reattempt)
287 connections. Controllers sometimes use this option to avoid using
288 the network until Tor is fully configured. (Default: 0)
290 [[ConstrainedSockets]] **ConstrainedSockets** **0**|**1**::
291 If set, Tor will tell the kernel to attempt to shrink the buffers for all
292 sockets to the size specified in **ConstrainedSockSize**. This is useful for
293 virtual servers and other environments where system level TCP buffers may
294 be limited. If you're on a virtual server, and you encounter the "Error
295 creating network socket: No buffer space available" message, you are
296 likely experiencing this problem. +
298 The preferred solution is to have the admin increase the buffer pool for
299 the host itself via /proc/sys/net/ipv4/tcp_mem or equivalent facility;
300 this configuration option is a second-resort. +
302 The DirPort option should also not be used if TCP buffers are scarce. The
303 cached directory requests consume additional sockets which exacerbates
306 You should **not** enable this feature unless you encounter the "no buffer
307 space available" issue. Reducing the TCP buffers affects window size for
308 the TCP stream and will reduce throughput in proportion to round trip
309 time on long paths. (Default: 0)
311 [[ConstrainedSockSize]] **ConstrainedSockSize** __N__ **bytes**|**KBytes**::
312 When **ConstrainedSockets** is enabled the receive and transmit buffers for
313 all sockets will be set to this limit. Must be a value between 2048 and
314 262144, in 1024 byte increments. Default of 8192 is recommended.
316 [[ControlPort]] **ControlPort** __PORT__|**unix:**__path__|**auto** [__flags__]::
317 If set, Tor will accept connections on this port and allow those
318 connections to control the Tor process using the Tor Control Protocol
319 (described in control-spec.txt in
320 https://spec.torproject.org[torspec]). Note: unless you also
321 specify one or more of **HashedControlPassword** or
322 **CookieAuthentication**, setting this option will cause Tor to allow
323 any process on the local host to control it. (Setting both authentication
324 methods means either method is sufficient to authenticate to Tor.) This
325 option is required for many Tor controllers; most use the value of 9051.
326 If a unix domain socket is used, you may quote the path using standard
328 Set it to "auto" to have Tor pick a port for you. (Default: 0) +
330 Recognized flags are...
332 Unix domain sockets only: makes the socket get created as
335 Unix domain sockets only: makes the socket get created as
337 **RelaxDirModeCheck**;;
338 Unix domain sockets only: Do not insist that the directory
339 that holds the socket be read-restricted.
341 [[ControlListenAddress]] **ControlListenAddress** __IP__[:__PORT__]::
342 Bind the controller listener to this address. If you specify a port, bind
343 to this port rather than the one specified in ControlPort. We strongly
344 recommend that you leave this alone unless you know what you're doing,
345 since giving attackers access to your control listener is really
346 dangerous. This directive can be specified multiple
347 times to bind to multiple addresses/ports. (Default: 127.0.0.1)
349 [[ControlSocket]] **ControlSocket** __Path__::
350 Like ControlPort, but listens on a Unix domain socket, rather than a TCP
351 socket. '0' disables ControlSocket (Unix and Unix-like systems only.)
353 [[ControlSocketsGroupWritable]] **ControlSocketsGroupWritable** **0**|**1**::
354 If this option is set to 0, don't allow the filesystem group to read and
355 write unix sockets (e.g. ControlSocket). If the option is set to 1, make
356 the control socket readable and writable by the default GID. (Default: 0)
358 [[HashedControlPassword]] **HashedControlPassword** __hashed_password__::
359 Allow connections on the control port if they present
360 the password whose one-way hash is __hashed_password__. You
361 can compute the hash of a password by running "tor --hash-password
362 __password__". You can provide several acceptable passwords by using more
363 than one HashedControlPassword line.
365 [[CookieAuthentication]] **CookieAuthentication** **0**|**1**::
366 If this option is set to 1, allow connections on the control port
367 when the connecting process knows the contents of a file named
368 "control_auth_cookie", which Tor will create in its data directory. This
369 authentication method should only be used on systems with good filesystem
370 security. (Default: 0)
372 [[CookieAuthFile]] **CookieAuthFile** __Path__::
373 If set, this option overrides the default location and file name
374 for Tor's cookie file. (See CookieAuthentication above.)
376 [[CookieAuthFileGroupReadable]] **CookieAuthFileGroupReadable** **0**|**1**::
377 If this option is set to 0, don't allow the filesystem group to read the
378 cookie file. If the option is set to 1, make the cookie file readable by
379 the default GID. [Making the file readable by other groups is not yet
380 implemented; let us know if you need this for some reason.] (Default: 0)
382 [[ControlPortWriteToFile]] **ControlPortWriteToFile** __Path__::
383 If set, Tor writes the address and port of any control port it opens to
384 this address. Usable by controllers to learn the actual control port
385 when ControlPort is set to "auto".
387 [[ControlPortFileGroupReadable]] **ControlPortFileGroupReadable** **0**|**1**::
388 If this option is set to 0, don't allow the filesystem group to read the
389 control port file. If the option is set to 1, make the control port
390 file readable by the default GID. (Default: 0)
392 [[DataDirectory]] **DataDirectory** __DIR__::
393 Store working data in DIR. Can not be changed while tor is running.
394 (Default: @LOCALSTATEDIR@/lib/tor)
396 [[DataDirectoryGroupReadable]] **DataDirectoryGroupReadable** **0**|**1**::
397 If this option is set to 0, don't allow the filesystem group to read the
398 DataDirectory. If the option is set to 1, make the DataDirectory readable
399 by the default GID. (Default: 0)
401 [[FallbackDir]] **FallbackDir** __address__:__port__ orport=__port__ id=__fingerprint__ [weight=__num__] [ipv6=__address__:__orport__]::
402 When we're unable to connect to any directory cache for directory info
403 (usually because we don't know about any yet) we try a directory authority.
404 Clients also simultaneously try a FallbackDir, to avoid hangs on client
405 startup if a directory authority is down. Clients retry FallbackDirs more
406 often than directory authorities, to reduce the load on the directory
408 By default, the directory authorities are also FallbackDirs. Specifying a
409 FallbackDir replaces Tor's default hard-coded FallbackDirs (if any).
410 (See the **DirAuthority** entry for an explanation of each flag.)
412 [[UseDefaultFallbackDirs]] **UseDefaultFallbackDirs** **0**|**1**::
413 Use Tor's default hard-coded FallbackDirs (if any). (When a
414 FallbackDir line is present, it replaces the hard-coded FallbackDirs,
415 regardless of the value of UseDefaultFallbackDirs.) (Default: 1)
417 [[DirAuthority]] **DirAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__::
418 Use a nonstandard authoritative directory server at the provided address
419 and port, with the specified key fingerprint. This option can be repeated
420 many times, for multiple authoritative directory servers. Flags are
421 separated by spaces, and determine what kind of an authority this directory
422 is. By default, an authority is not authoritative for any directory style
423 or version unless an appropriate flag is given.
424 Tor will use this authority as a bridge authoritative directory if the
425 "bridge" flag is set. If a flag "orport=**port**" is given, Tor will use the
426 given port when opening encrypted tunnels to the dirserver. If a flag
427 "weight=**num**" is given, then the directory server is chosen randomly
428 with probability proportional to that weight (default 1.0). If a
429 flag "v3ident=**fp**" is given, the dirserver is a v3 directory authority
430 whose v3 long-term signing key has the fingerprint **fp**. Lastly,
431 if an "ipv6=__address__:__orport__" flag is present, then the directory
432 authority is listening for IPv6 connections on the indicated IPv6 address
435 Tor will contact the authority at __address__:__port__ (the DirPort) to
436 download directory documents. If an IPv6 address is supplied, Tor will
437 also download directory documents at the IPv6 address on the DirPort. +
439 If no **DirAuthority** line is given, Tor will use the default directory
440 authorities. NOTE: this option is intended for setting up a private Tor
441 network with its own directory authorities. If you use it, you will be
442 distinguishable from other users, because you won't believe the same
445 [[DirAuthorityFallbackRate]] **DirAuthorityFallbackRate** __NUM__::
446 When configured to use both directory authorities and fallback
447 directories, the directory authorities also work as fallbacks. They are
448 chosen with their regular weights, multiplied by this number, which
449 should be 1.0 or less. (Default: 1.0)
451 [[AlternateDirAuthority]] **AlternateDirAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__ +
453 [[AlternateBridgeAuthority]] **AlternateBridgeAuthority** [__nickname__] [**flags**] __address__:__port__ __ fingerprint__::
454 These options behave as DirAuthority, but they replace fewer of the
455 default directory authorities. Using
456 AlternateDirAuthority replaces the default Tor directory authorities, but
457 leaves the default bridge authorities in
459 AlternateBridgeAuthority replaces the default bridge authority,
460 but leaves the directory authorities alone.
462 [[DisableAllSwap]] **DisableAllSwap** **0**|**1**::
463 If set to 1, Tor will attempt to lock all current and future memory pages,
464 so that memory cannot be paged out. Windows, OS X and Solaris are currently
465 not supported. We believe that this feature works on modern Gnu/Linux
466 distributions, and that it should work on *BSD systems (untested). This
467 option requires that you start your Tor as root, and you should use the
468 **User** option to properly reduce Tor's privileges.
469 Can not be changed while tor is running. (Default: 0)
471 [[DisableDebuggerAttachment]] **DisableDebuggerAttachment** **0**|**1**::
472 If set to 1, Tor will attempt to prevent basic debugging attachment attempts
473 by other processes. This may also keep Tor from generating core files if
474 it crashes. It has no impact for users who wish to attach if they
475 have CAP_SYS_PTRACE or if they are root. We believe that this feature
476 works on modern Gnu/Linux distributions, and that it may also work on *BSD
477 systems (untested). Some modern Gnu/Linux systems such as Ubuntu have the
478 kernel.yama.ptrace_scope sysctl and by default enable it as an attempt to
479 limit the PTRACE scope for all user processes by default. This feature will
480 attempt to limit the PTRACE scope for Tor specifically - it will not attempt
481 to alter the system wide ptrace scope as it may not even exist. If you wish
482 to attach to Tor with a debugger such as gdb or strace you will want to set
483 this to 0 for the duration of your debugging. Normal users should leave it
484 on. Disabling this option while Tor is running is prohibited. (Default: 1)
486 [[FetchDirInfoEarly]] **FetchDirInfoEarly** **0**|**1**::
487 If set to 1, Tor will always fetch directory information like other
488 directory caches, even if you don't meet the normal criteria for fetching
489 early. Normal users should leave it off. (Default: 0)
491 [[FetchDirInfoExtraEarly]] **FetchDirInfoExtraEarly** **0**|**1**::
492 If set to 1, Tor will fetch directory information before other directory
493 caches. It will attempt to download directory information closer to the
494 start of the consensus period. Normal users should leave it off.
497 [[FetchHidServDescriptors]] **FetchHidServDescriptors** **0**|**1**::
498 If set to 0, Tor will never fetch any hidden service descriptors from the
499 rendezvous directories. This option is only useful if you're using a Tor
500 controller that handles hidden service fetches for you. (Default: 1)
502 [[FetchServerDescriptors]] **FetchServerDescriptors** **0**|**1**::
503 If set to 0, Tor will never fetch any network status summaries or server
504 descriptors from the directory servers. This option is only useful if
505 you're using a Tor controller that handles directory fetches for you.
508 [[FetchUselessDescriptors]] **FetchUselessDescriptors** **0**|**1**::
509 If set to 1, Tor will fetch every consensus flavor, descriptor, and
510 certificate that it hears about. Otherwise, it will avoid fetching useless
511 descriptors: flavors that it is not using to build circuits, and authority
512 certificates it does not trust. This option is useful if you're using a
513 tor client with an external parser that uses a full consensus.
514 This option fetches all documents, **DirCache** fetches and serves
515 all documents. (Default: 0)
517 [[HTTPProxy]] **HTTPProxy** __host__[:__port__]::
518 Tor will make all its directory requests through this host:port (or host:80
519 if port is not specified), rather than connecting directly to any directory
522 [[HTTPProxyAuthenticator]] **HTTPProxyAuthenticator** __username:password__::
523 If defined, Tor will use this username:password for Basic HTTP proxy
524 authentication, as in RFC 2617. This is currently the only form of HTTP
525 proxy authentication that Tor supports; feel free to submit a patch if you
526 want it to support others.
528 [[HTTPSProxy]] **HTTPSProxy** __host__[:__port__]::
529 Tor will make all its OR (SSL) connections through this host:port (or
530 host:443 if port is not specified), via HTTP CONNECT rather than connecting
531 directly to servers. You may want to set **FascistFirewall** to restrict
532 the set of ports you might try to connect to, if your HTTPS proxy only
533 allows connecting to certain ports.
535 [[HTTPSProxyAuthenticator]] **HTTPSProxyAuthenticator** __username:password__::
536 If defined, Tor will use this username:password for Basic HTTPS proxy
537 authentication, as in RFC 2617. This is currently the only form of HTTPS
538 proxy authentication that Tor supports; feel free to submit a patch if you
539 want it to support others.
541 [[Sandbox]] **Sandbox** **0**|**1**::
542 If set to 1, Tor will run securely through the use of a syscall sandbox.
543 Otherwise the sandbox will be disabled. The option is currently an
544 experimental feature. Can not be changed while tor is running.
546 When the Sandbox is 1, the following options can not be changed when tor
552 ExtORPortCookieAuthFile
554 ServerDNSResolvConfFile
555 Tor must remain in client or server mode (some changes to ClientOnly and
556 ORPort are not allowed).
559 [[Socks4Proxy]] **Socks4Proxy** __host__[:__port__]::
560 Tor will make all OR connections through the SOCKS 4 proxy at host:port
561 (or host:1080 if port is not specified).
563 [[Socks5Proxy]] **Socks5Proxy** __host__[:__port__]::
564 Tor will make all OR connections through the SOCKS 5 proxy at host:port
565 (or host:1080 if port is not specified).
567 [[Socks5ProxyUsername]] **Socks5ProxyUsername** __username__ +
569 [[Socks5ProxyPassword]] **Socks5ProxyPassword** __password__::
570 If defined, authenticate to the SOCKS 5 server using username and password
571 in accordance to RFC 1929. Both username and password must be between 1 and
574 [[SocksSocketsGroupWritable]] **SocksSocketsGroupWritable** **0**|**1**::
575 If this option is set to 0, don't allow the filesystem group to read and
576 write unix sockets (e.g. SocksSocket). If the option is set to 1, make
577 the SocksSocket socket readable and writable by the default GID. (Default: 0)
579 [[KeepalivePeriod]] **KeepalivePeriod** __NUM__::
580 To keep firewalls from expiring connections, send a padding keepalive cell
581 every NUM seconds on open connections that are in use. If the connection
582 has no open circuits, it will instead be closed after NUM seconds of
583 idleness. (Default: 5 minutes)
585 [[Log]] **Log** __minSeverity__[-__maxSeverity__] **stderr**|**stdout**|**syslog**::
586 Send all messages between __minSeverity__ and __maxSeverity__ to the standard
587 output stream, the standard error stream, or to the system log. (The
588 "syslog" value is only supported on Unix.) Recognized severity levels are
589 debug, info, notice, warn, and err. We advise using "notice" in most cases,
590 since anything more verbose may provide sensitive information to an
591 attacker who obtains the logs. If only one severity level is given, all
592 messages of that level or higher will be sent to the listed destination.
594 [[Log2]] **Log** __minSeverity__[-__maxSeverity__] **file** __FILENAME__::
595 As above, but send log messages to the listed filename. The
596 "Log" option may appear more than once in a configuration file.
597 Messages are sent to all the logs that match their severity
600 [[Log3]] **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **file** __FILENAME__ +
602 [[Log4]] **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **stderr**|**stdout**|**syslog**::
603 As above, but select messages by range of log severity __and__ by a
604 set of "logging domains". Each logging domain corresponds to an area of
605 functionality inside Tor. You can specify any number of severity ranges
606 for a single log statement, each of them prefixed by a comma-separated
607 list of logging domains. You can prefix a domain with $$~$$ to indicate
608 negation, and use * to indicate "all domains". If you specify a severity
609 range without a list of domains, it matches all domains. +
611 This is an advanced feature which is most useful for debugging one or two
612 of Tor's subsystems at a time. +
614 The currently recognized domains are: general, crypto, net, config, fs,
615 protocol, mm, http, app, control, circ, rend, bug, dir, dirserv, or, edge,
616 acct, hist, and handshake. Domain names are case-insensitive. +
618 For example, "`Log [handshake]debug [~net,~mm]info notice stdout`" sends
619 to stdout: all handshake messages of any severity, all info-and-higher
620 messages from domains other than networking and memory management, and all
621 messages of severity notice or higher.
623 [[LogMessageDomains]] **LogMessageDomains** **0**|**1**::
624 If 1, Tor includes message domains with each log message. Every log
625 message currently has at least one domain; most currently have exactly
626 one. This doesn't affect controller log messages. (Default: 0)
628 [[MaxUnparseableDescSizeToLog]] **MaxUnparseableDescSizeToLog** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**::
629 Unparseable descriptors (e.g. for votes, consensuses, routers) are logged
630 in separate files by hash, up to the specified size in total. Note that
631 only files logged during the lifetime of this Tor process count toward the
632 total; this is intended to be used to debug problems without opening live
633 servers to resource exhaustion attacks. (Default: 10 MB)
635 [[OutboundBindAddress]] **OutboundBindAddress** __IP__::
636 Make all outbound connections originate from the IP address specified. This
637 is only useful when you have multiple network interfaces, and you want all
638 of Tor's outgoing connections to use a single one. This option may
639 be used twice, once with an IPv4 address and once with an IPv6 address.
640 This setting will be ignored for connections to the loopback addresses
641 (127.0.0.0/8 and ::1).
643 [[OutboundBindAddressOR]] **OutboundBindAddressOR** __IP__::
644 Make all outbound non-exit (=relay and other) connections originate from the IP
645 address specified. This option overrides **OutboundBindAddress** for the same
646 IP version. This option may be used twice, once with an IPv4 address and once
647 with an IPv6 address. This setting will be ignored for connections to the
648 loopback addresses (127.0.0.0/8 and ::1).
650 [[OutboundBindAddressExit]] **OutboundBindAddressExit** __IP__::
651 Make all outbound exit connections originate from the IP address specified. This
652 option overrides **OutboundBindAddress** for the same IP version. This option
653 may be used twice, once with an IPv4 address and once with an IPv6 address. This
654 setting will be ignored for connections to the loopback addresses (127.0.0.0/8
657 [[PidFile]] **PidFile** __FILE__::
658 On startup, write our PID to FILE. On clean shutdown, remove
659 FILE. Can not be changed while tor is running.
661 [[ProtocolWarnings]] **ProtocolWarnings** **0**|**1**::
662 If 1, Tor will log with severity \'warn' various cases of other parties not
663 following the Tor specification. Otherwise, they are logged with severity
664 \'info'. (Default: 0)
666 [[PredictedPortsRelevanceTime]] **PredictedPortsRelevanceTime** __NUM__::
667 Set how long, after the client has made an anonymized connection to a
668 given port, we will try to make sure that we build circuits to
669 exits that support that port. The maximum value for this option is 1
670 hour. (Default: 1 hour)
672 [[RunAsDaemon]] **RunAsDaemon** **0**|**1**::
673 If 1, Tor forks and daemonizes to the background. This option has no effect
674 on Windows; instead you should use the --service command-line option.
675 Can not be changed while tor is running.
678 [[LogTimeGranularity]] **LogTimeGranularity** __NUM__::
679 Set the resolution of timestamps in Tor's logs to NUM milliseconds.
680 NUM must be positive and either a divisor or a multiple of 1 second.
681 Note that this option only controls the granularity written by Tor to
682 a file or console log. Tor does not (for example) "batch up" log
683 messages to affect times logged by a controller, times attached to
684 syslog messages, or the mtime fields on log files. (Default: 1 second)
686 [[TruncateLogFile]] **TruncateLogFile** **0**|**1**::
687 If 1, Tor will overwrite logs at startup and in response to a HUP signal,
688 instead of appending to them. (Default: 0)
690 [[SyslogIdentityTag]] **SyslogIdentityTag** __tag__::
691 When logging to syslog, adds a tag to the syslog identity such that
692 log entries are marked with "Tor-__tag__". Can not be changed while tor is
693 running. (Default: none)
695 [[SafeLogging]] **SafeLogging** **0**|**1**|**relay**::
696 Tor can scrub potentially sensitive strings from log messages (e.g.
697 addresses) by replacing them with the string [scrubbed]. This way logs can
698 still be useful, but they don't leave behind personally identifying
699 information about what sites a user might have visited. +
701 If this option is set to 0, Tor will not perform any scrubbing, if it is
702 set to 1, all potentially sensitive strings are replaced. If it is set to
703 relay, all log messages generated when acting as a relay are sanitized, but
704 all messages generated when acting as a client are not. (Default: 1)
706 [[User]] **User** __Username__::
707 On startup, setuid to this user and setgid to their primary group.
708 Can not be changed while tor is running.
710 [[KeepBindCapabilities]] **KeepBindCapabilities** **0**|**1**|**auto**::
711 On Linux, when we are started as root and we switch our identity using
712 the **User** option, the **KeepBindCapabilities** option tells us whether to
713 try to retain our ability to bind to low ports. If this value is 1, we
714 try to keep the capability; if it is 0 we do not; and if it is **auto**,
715 we keep the capability only if we are configured to listen on a low port.
716 Can not be changed while tor is running.
719 [[HardwareAccel]] **HardwareAccel** **0**|**1**::
720 If non-zero, try to use built-in (static) crypto hardware acceleration when
721 available. Can not be changed while tor is running. (Default: 0)
723 [[AccelName]] **AccelName** __NAME__::
724 When using OpenSSL hardware crypto acceleration attempt to load the dynamic
725 engine of this name. This must be used for any dynamic hardware engine.
726 Names can be verified with the openssl engine command. Can not be changed
727 while tor is running.
729 [[AccelDir]] **AccelDir** __DIR__::
730 Specify this option if using dynamic hardware acceleration and the engine
731 implementation library resides somewhere other than the OpenSSL default.
732 Can not be changed while tor is running.
734 [[AvoidDiskWrites]] **AvoidDiskWrites** **0**|**1**::
735 If non-zero, try to write to disk less frequently than we would otherwise.
736 This is useful when running on flash memory or other media that support
737 only a limited number of writes. (Default: 0)
739 [[CircuitPriorityHalflife]] **CircuitPriorityHalflife** __NUM1__::
740 If this value is set, we override the default algorithm for choosing which
741 circuit's cell to deliver or relay next. When the value is 0, we
742 round-robin between the active circuits on a connection, delivering one
743 cell from each in turn. When the value is positive, we prefer delivering
744 cells from whichever connection has the lowest weighted cell count, where
745 cells are weighted exponentially according to the supplied
746 CircuitPriorityHalflife value (in seconds). If this option is not set at
747 all, we use the behavior recommended in the current consensus
748 networkstatus. This is an advanced option; you generally shouldn't have
749 to mess with it. (Default: not set)
751 [[CountPrivateBandwidth]] **CountPrivateBandwidth** **0**|**1**::
752 If this option is set, then Tor's rate-limiting applies not only to
753 remote connections, but also to connections to private addresses like
754 127.0.0.1 or 10.0.0.1. This is mostly useful for debugging
755 rate-limiting. (Default: 0)
757 [[ExtendByEd25519ID]] **ExtendByEd25519ID** **0**|**1**|**auto**::
758 If this option is set to 1, we always try to include a relay's Ed25519 ID
759 when telling the proceeding relay in a circuit to extend to it.
760 If this option is set to 0, we never include Ed25519 IDs when extending
761 circuits. If the option is set to "default", we obey a
762 parameter in the consensus document. (Default: auto)
767 The following options are useful only for clients (that is, if
768 **SocksPort**, **TransPort**, **DNSPort**, or **NATDPort** is non-zero):
770 [[AllowInvalidNodes]] **AllowInvalidNodes** **entry**|**exit**|**middle**|**introduction**|**rendezvous**|**...**::
771 If some Tor servers are obviously not working right, the directory
772 authorities can manually mark them as invalid, meaning that it's not
773 recommended you use them for entry or exit positions in your circuits. You
774 can opt to use them in some circuit positions, though. The default is
775 "middle,rendezvous", and other choices are not advised.
777 [[ExcludeSingleHopRelays]] **ExcludeSingleHopRelays** **0**|**1**::
778 This option controls whether circuits built by Tor will include relays with
779 the AllowSingleHopExits flag set to true. If ExcludeSingleHopRelays is set
780 to 0, these relays will be included. Note that these relays might be at
781 higher risk of being seized or observed, so they are not normally
782 included. Also note that relatively few clients turn off this option,
783 so using these relays might make your client stand out.
786 [[Bridge]] **Bridge** [__transport__] __IP__:__ORPort__ [__fingerprint__]::
787 When set along with UseBridges, instructs Tor to use the relay at
788 "IP:ORPort" as a "bridge" relaying into the Tor network. If "fingerprint"
789 is provided (using the same format as for DirAuthority), we will verify that
790 the relay running at that location has the right fingerprint. We also use
791 fingerprint to look up the bridge descriptor at the bridge authority, if
792 it's provided and if UpdateBridgesFromAuthority is set too. +
794 If "transport" is provided, it must match a ClientTransportPlugin line. We
795 then use that pluggable transport's proxy to transfer data to the bridge,
796 rather than connecting to the bridge directly. Some transports use a
797 transport-specific method to work out the remote address to connect to.
798 These transports typically ignore the "IP:ORPort" specified in the bridge
801 [[LearnCircuitBuildTimeout]] **LearnCircuitBuildTimeout** **0**|**1**::
802 If 0, CircuitBuildTimeout adaptive learning is disabled. (Default: 1)
804 [[CircuitBuildTimeout]] **CircuitBuildTimeout** __NUM__::
806 Try for at most NUM seconds when building circuits. If the circuit isn't
807 open in that time, give up on it. If LearnCircuitBuildTimeout is 1, this
808 value serves as the initial value to use before a timeout is learned. If
809 LearnCircuitBuildTimeout is 0, this value is the only value used.
810 (Default: 60 seconds)
812 [[CircuitIdleTimeout]] **CircuitIdleTimeout** __NUM__::
813 If we have kept a clean (never used) circuit around for NUM seconds, then
814 close it. This way when the Tor client is entirely idle, it can expire all
815 of its circuits, and then expire its TLS connections. Also, if we end up
816 making a circuit that is not useful for exiting any of the requests we're
817 receiving, it won't forever take up a slot in the circuit list. (Default: 1
820 [[CircuitStreamTimeout]] **CircuitStreamTimeout** __NUM__::
821 If non-zero, this option overrides our internal timeout schedule for how
822 many seconds until we detach a stream from a circuit and try a new circuit.
823 If your network is particularly slow, you might want to set this to a
824 number like 60. (Default: 0)
826 [[ClientOnly]] **ClientOnly** **0**|**1**::
827 If set to 1, Tor will not run as a relay or serve
828 directory requests, even if the ORPort, ExtORPort, or DirPort options are
829 set. (This config option is
830 mostly unnecessary: we added it back when we were considering having
831 Tor clients auto-promote themselves to being relays if they were stable
832 and fast enough. The current behavior is simply that Tor is a client
833 unless ORPort, ExtORPort, or DirPort are configured.) (Default: 0)
835 [[ExcludeNodes]] **ExcludeNodes** __node__,__node__,__...__::
836 A list of identity fingerprints, country codes, and address
837 patterns of nodes to avoid when building a circuit. Country codes are
838 2-letter ISO3166 codes, and must
839 be wrapped in braces; fingerprints may be preceded by a dollar sign.
841 ExcludeNodes ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
843 By default, this option is treated as a preference that Tor is allowed
844 to override in order to keep working.
845 For example, if you try to connect to a hidden service,
846 but you have excluded all of the hidden service's introduction points,
847 Tor will connect to one of them anyway. If you do not want this
848 behavior, set the StrictNodes option (documented below). +
850 Note also that if you are a relay, this (and the other node selection
851 options below) only affects your own circuits that Tor builds for you.
852 Clients can still build circuits through you to any node. Controllers
853 can tell Tor to build circuits through any node. +
855 Country codes are case-insensitive. The code "\{??}" refers to nodes whose
856 country can't be identified. No country code, including \{??}, works if
857 no GeoIPFile can be loaded. See also the GeoIPExcludeUnknown option below.
860 [[ExcludeExitNodes]] **ExcludeExitNodes** __node__,__node__,__...__::
861 A list of identity fingerprints, country codes, and address
862 patterns of nodes to never use when picking an exit node---that is, a
863 node that delivers traffic for you *outside* the Tor network. Note that any
864 node listed in ExcludeNodes is automatically considered to be part of this
866 the **ExcludeNodes** option for more information on how to specify
867 nodes. See also the caveats on the "ExitNodes" option below.
869 [[GeoIPExcludeUnknown]] **GeoIPExcludeUnknown** **0**|**1**|**auto**::
870 If this option is set to 'auto', then whenever any country code is set in
871 ExcludeNodes or ExcludeExitNodes, all nodes with unknown country (\{??} and
872 possibly \{A1}) are treated as excluded as well. If this option is set to
873 '1', then all unknown countries are treated as excluded in ExcludeNodes
874 and ExcludeExitNodes. This option has no effect when a GeoIP file isn't
875 configured or can't be found. (Default: auto)
877 [[ExitNodes]] **ExitNodes** __node__,__node__,__...__::
878 A list of identity fingerprints, country codes, and address
879 patterns of nodes to use as exit node---that is, a
880 node that delivers traffic for you *outside* the Tor network. See
881 the **ExcludeNodes** option for more information on how to specify nodes. +
883 Note that if you list too few nodes here, or if you exclude too many exit
884 nodes with ExcludeExitNodes, you can degrade functionality. For example,
885 if none of the exits you list allows traffic on port 80 or 443, you won't
886 be able to browse the web. +
888 Note also that not every circuit is used to deliver traffic *outside* of
889 the Tor network. It is normal to see non-exit circuits (such as those
890 used to connect to hidden services, those that do directory fetches,
891 those used for relay reachability self-tests, and so on) that end
892 at a non-exit node. To
893 keep a node from being used entirely, see ExcludeNodes and StrictNodes. +
895 The ExcludeNodes option overrides this option: any node listed in both
896 ExitNodes and ExcludeNodes is treated as excluded. +
898 The .exit address notation, if enabled via AllowDotExit, overrides
901 [[EntryNodes]] **EntryNodes** __node__,__node__,__...__::
902 A list of identity fingerprints and country codes of nodes
903 to use for the first hop in your normal circuits.
904 Normal circuits include all
905 circuits except for direct connections to directory servers. The Bridge
906 option overrides this option; if you have configured bridges and
907 UseBridges is 1, the Bridges are used as your entry nodes. +
909 The ExcludeNodes option overrides this option: any node listed in both
910 EntryNodes and ExcludeNodes is treated as excluded. See
911 the **ExcludeNodes** option for more information on how to specify nodes.
913 [[StrictNodes]] **StrictNodes** **0**|**1**::
914 If StrictNodes is set to 1, Tor will treat solely the ExcludeNodes option
915 as a requirement to follow for all the circuits you generate, even if
916 doing so will break functionality for you (StrictNodes applies to neither
917 ExcludeExitNodes nor to ExitNodes). If StrictNodes is set to 0, Tor will
918 still try to avoid nodes in the ExcludeNodes list, but it will err on the
919 side of avoiding unexpected errors. Specifically, StrictNodes 0 tells Tor
920 that it is okay to use an excluded node when it is *necessary* to perform
921 relay reachability self-tests, connect to a hidden service, provide a
922 hidden service to a client, fulfill a .exit request, upload directory
923 information, or download directory information. (Default: 0)
925 [[FascistFirewall]] **FascistFirewall** **0**|**1**::
926 If 1, Tor will only create outgoing connections to ORs running on ports
927 that your firewall allows (defaults to 80 and 443; see **FirewallPorts**).
928 This will allow you to run Tor as a client behind a firewall with
929 restrictive policies, but will not allow you to run as a server behind such
930 a firewall. If you prefer more fine-grained control, use
931 ReachableAddresses instead.
933 [[FirewallPorts]] **FirewallPorts** __PORTS__::
934 A list of ports that your firewall allows you to connect to. Only used when
935 **FascistFirewall** is set. This option is deprecated; use ReachableAddresses
936 instead. (Default: 80, 443)
938 [[ReachableAddresses]] **ReachableAddresses** __ADDR__[/__MASK__][:__PORT__]...::
939 A comma-separated list of IP addresses and ports that your firewall allows
940 you to connect to. The format is as for the addresses in ExitPolicy, except
941 that "accept" is understood unless "reject" is explicitly provided. For
942 example, \'ReachableAddresses 99.0.0.0/8, reject 18.0.0.0/8:80, accept
943 \*:80' means that your firewall allows connections to everything inside net
944 99, rejects port 80 connections to net 18, and accepts connections to port
945 80 otherwise. (Default: \'accept \*:*'.)
947 [[ReachableDirAddresses]] **ReachableDirAddresses** __ADDR__[/__MASK__][:__PORT__]...::
948 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
949 these restrictions when fetching directory information, using standard HTTP
950 GET requests. If not set explicitly then the value of
951 **ReachableAddresses** is used. If **HTTPProxy** is set then these
952 connections will go through that proxy.
954 [[ReachableORAddresses]] **ReachableORAddresses** __ADDR__[/__MASK__][:__PORT__]...::
955 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
956 these restrictions when connecting to Onion Routers, using TLS/SSL. If not
957 set explicitly then the value of **ReachableAddresses** is used. If
958 **HTTPSProxy** is set then these connections will go through that proxy. +
960 The separation between **ReachableORAddresses** and
961 **ReachableDirAddresses** is only interesting when you are connecting
962 through proxies (see **HTTPProxy** and **HTTPSProxy**). Most proxies limit
963 TLS connections (which Tor uses to connect to Onion Routers) to port 443,
964 and some limit HTTP GET requests (which Tor uses for fetching directory
965 information) to port 80.
967 [[HidServAuth]] **HidServAuth** __onion-address__ __auth-cookie__ [__service-name__]::
968 Client authorization for a hidden service. Valid onion addresses contain 16
969 characters in a-z2-7 plus ".onion", and valid auth cookies contain 22
970 characters in A-Za-z0-9+/. The service name is only used for internal
971 purposes, e.g., for Tor controllers. This option may be used multiple times
972 for different hidden services. If a hidden service uses authorization and
973 this option is not set, the hidden service is not accessible. Hidden
974 services can be configured to require authorization using the
975 **HiddenServiceAuthorizeClient** option.
977 [[CloseHSClientCircuitsImmediatelyOnTimeout]] **CloseHSClientCircuitsImmediatelyOnTimeout** **0**|**1**::
978 If 1, Tor will close unfinished hidden service client circuits
979 which have not moved closer to connecting to their destination
980 hidden service when their internal state has not changed for the
981 duration of the current circuit-build timeout. Otherwise, such
982 circuits will be left open, in the hope that they will finish
983 connecting to their destination hidden services. In either case,
984 another set of introduction and rendezvous circuits for the same
985 destination hidden service will be launched. (Default: 0)
987 [[CloseHSServiceRendCircuitsImmediatelyOnTimeout]] **CloseHSServiceRendCircuitsImmediatelyOnTimeout** **0**|**1**::
988 If 1, Tor will close unfinished hidden-service-side rendezvous
989 circuits after the current circuit-build timeout. Otherwise, such
990 circuits will be left open, in the hope that they will finish
991 connecting to their destinations. In either case, another
992 rendezvous circuit for the same destination client will be
993 launched. (Default: 0)
995 [[LongLivedPorts]] **LongLivedPorts** __PORTS__::
996 A list of ports for services that tend to have long-running connections
997 (e.g. chat and interactive shells). Circuits for streams that use these
998 ports will contain only high-uptime nodes, to reduce the chance that a node
999 will go down before the stream is finished. Note that the list is also
1000 honored for circuits (both client and service side) involving hidden
1001 services whose virtual port is in this list. (Default: 21, 22, 706,
1002 1863, 5050, 5190, 5222, 5223, 6523, 6667, 6697, 8300)
1004 [[MapAddress]] **MapAddress** __address__ __newaddress__::
1005 When a request for address arrives to Tor, it will transform to newaddress
1006 before processing it. For example, if you always want connections to
1007 www.example.com to exit via __torserver__ (where __torserver__ is the
1008 fingerprint of the server), use "MapAddress www.example.com
1009 www.example.com.torserver.exit". If the value is prefixed with a
1010 "\*.", matches an entire domain. For example, if you
1011 always want connections to example.com and any if its subdomains
1013 __torserver__ (where __torserver__ is the fingerprint of the server), use
1014 "MapAddress \*.example.com \*.example.com.torserver.exit". (Note the
1015 leading "*." in each part of the directive.) You can also redirect all
1016 subdomains of a domain to a single address. For example, "MapAddress
1017 *.example.com www.example.com". +
1021 1. When evaluating MapAddress expressions Tor stops when it hits the most
1022 recently added expression that matches the requested address. So if you
1023 have the following in your torrc, www.torproject.org will map to 1.1.1.1:
1025 MapAddress www.torproject.org 2.2.2.2
1026 MapAddress www.torproject.org 1.1.1.1
1028 2. Tor evaluates the MapAddress configuration until it finds no matches. So
1029 if you have the following in your torrc, www.torproject.org will map to
1032 MapAddress 1.1.1.1 2.2.2.2
1033 MapAddress www.torproject.org 1.1.1.1
1035 3. The following MapAddress expression is invalid (and will be
1036 ignored) because you cannot map from a specific address to a wildcard
1039 MapAddress www.torproject.org *.torproject.org.torserver.exit
1041 4. Using a wildcard to match only part of a string (as in *ample.com) is
1044 [[NewCircuitPeriod]] **NewCircuitPeriod** __NUM__::
1045 Every NUM seconds consider whether to build a new circuit. (Default: 30
1048 [[MaxCircuitDirtiness]] **MaxCircuitDirtiness** __NUM__::
1049 Feel free to reuse a circuit that was first used at most NUM seconds ago,
1050 but never attach a new stream to a circuit that is too old. For hidden
1051 services, this applies to the __last__ time a circuit was used, not the
1052 first. Circuits with streams constructed with SOCKS authentication via
1053 SocksPorts that have **KeepAliveIsolateSOCKSAuth** ignore this value.
1054 (Default: 10 minutes)
1056 [[MaxClientCircuitsPending]] **MaxClientCircuitsPending** __NUM__::
1057 Do not allow more than NUM circuits to be pending at a time for handling
1058 client streams. A circuit is pending if we have begun constructing it,
1059 but it has not yet been completely constructed. (Default: 32)
1061 [[NodeFamily]] **NodeFamily** __node__,__node__,__...__::
1062 The Tor servers, defined by their identity fingerprints,
1063 constitute a "family" of similar or co-administered servers, so never use
1064 any two of them in the same circuit. Defining a NodeFamily is only needed
1065 when a server doesn't list the family itself (with MyFamily). This option
1066 can be used multiple times; each instance defines a separate family. In
1067 addition to nodes, you can also list IP address and ranges and country
1068 codes in {curly braces}. See the **ExcludeNodes** option for more
1069 information on how to specify nodes.
1071 [[EnforceDistinctSubnets]] **EnforceDistinctSubnets** **0**|**1**::
1072 If 1, Tor will not put two servers whose IP addresses are "too close" on
1073 the same circuit. Currently, two addresses are "too close" if they lie in
1074 the same /16 range. (Default: 1)
1076 [[SocksPort]] **SocksPort** \['address':]__port__|**unix:**__path__|**auto** [_flags_] [_isolation flags_]::
1077 Open this port to listen for connections from SOCKS-speaking
1078 applications. Set this to 0 if you don't want to allow application
1079 connections via SOCKS. Set it to "auto" to have Tor pick a port for
1080 you. This directive can be specified multiple times to bind
1081 to multiple addresses/ports. If a unix domain socket is used, you may
1082 quote the path using standard C escape sequences.
1085 NOTE: Although this option allows you to specify an IP address
1086 other than localhost, you should do so only with extreme caution.
1087 The SOCKS protocol is unencrypted and (as we use it)
1088 unauthenticated, so exposing it in this way could leak your
1089 information to anybody watching your network, and allow anybody
1090 to use your computer as an open proxy. +
1092 The _isolation flags_ arguments give Tor rules for which streams
1093 received on this SocksPort are allowed to share circuits with one
1094 another. Recognized isolation flags are:
1095 **IsolateClientAddr**;;
1096 Don't share circuits with streams from a different
1097 client address. (On by default and strongly recommended when
1098 supported; you can disable it with **NoIsolateClientAddr**.
1099 Unsupported and force-disabled when using Unix domain sockets.)
1100 **IsolateSOCKSAuth**;;
1101 Don't share circuits with streams for which different
1102 SOCKS authentication was provided. (On by default;
1103 you can disable it with **NoIsolateSOCKSAuth**.)
1104 **IsolateClientProtocol**;;
1105 Don't share circuits with streams using a different protocol.
1106 (SOCKS 4, SOCKS 5, TransPort connections, NATDPort connections,
1107 and DNSPort requests are all considered to be different protocols.)
1108 **IsolateDestPort**;;
1109 Don't share circuits with streams targeting a different
1111 **IsolateDestAddr**;;
1112 Don't share circuits with streams targeting a different
1113 destination address.
1114 **KeepAliveIsolateSOCKSAuth**;;
1115 If **IsolateSOCKSAuth** is enabled, keep alive circuits that have
1116 streams with SOCKS authentication set indefinitely.
1117 **SessionGroup=**__INT__;;
1118 If no other isolation rules would prevent it, allow streams
1119 on this port to share circuits with streams from every other
1120 port with the same session group. (By default, streams received
1121 on different SocksPorts, TransPorts, etc are always isolated from one
1122 another. This option overrides that behavior.)
1124 [[OtherSocksPortFlags]]::
1125 Other recognized __flags__ for a SocksPort are:
1127 Tell exits to not connect to IPv4 addresses in response to SOCKS
1128 requests on this connection.
1130 Tell exits to allow IPv6 addresses in response to SOCKS requests on
1131 this connection, so long as SOCKS5 is in use. (SOCKS4 can't handle
1134 Tells exits that, if a host has both an IPv4 and an IPv6 address,
1135 we would prefer to connect to it via IPv6. (IPv4 is the default.)
1137 Do not ask exits to resolve DNS addresses in SOCKS5 requests. Tor will
1138 connect to IPv4 addresses, IPv6 addresses (if IPv6Traffic is set) and
1140 **NoOnionTraffic**;;
1141 Do not connect to .onion addresses in SOCKS5 requests.
1142 **OnionTrafficOnly**;;
1143 Tell the tor client to only connect to .onion addresses in response to
1144 SOCKS5 requests on this connection. This is equivalent to NoDNSRequest,
1145 NoIPv4Traffic, NoIPv6Traffic. The corresponding NoOnionTrafficOnly
1146 flag is not supported.
1148 Tells the client to remember IPv4 DNS answers we receive from exit
1149 nodes via this connection. (On by default.)
1151 Tells the client to remember IPv6 DNS answers we receive from exit
1152 nodes via this connection.
1154 Unix domain sockets only: makes the socket get created as
1157 Unix domain sockets only: makes the socket get created as
1160 Tells the client to remember all DNS answers we receive from exit
1161 nodes via this connection.
1163 Tells the client to use any cached IPv4 DNS answers we have when making
1164 requests via this connection. (NOTE: This option, along UseIPv6Cache
1165 and UseDNSCache, can harm your anonymity, and probably
1166 won't help performance as much as you might expect. Use with care!)
1168 Tells the client to use any cached IPv6 DNS answers we have when making
1169 requests via this connection.
1171 Tells the client to use any cached DNS answers we have when making
1172 requests via this connection.
1173 **PreferIPv6Automap**;;
1174 When serving a hostname lookup request on this port that
1175 should get automapped (according to AutomapHostsOnResolve),
1176 if we could return either an IPv4 or an IPv6 answer, prefer
1177 an IPv6 answer. (On by default.)
1178 **PreferSOCKSNoAuth**;;
1179 Ordinarily, when an application offers both "username/password
1180 authentication" and "no authentication" to Tor via SOCKS5, Tor
1181 selects username/password authentication so that IsolateSOCKSAuth can
1182 work. This can confuse some applications, if they offer a
1183 username/password combination then get confused when asked for
1184 one. You can disable this behavior, so that Tor will select "No
1185 authentication" when IsolateSOCKSAuth is disabled, or when this
1188 [[SocksPortFlagsMisc]]::
1189 Flags are processed left to right. If flags conflict, the last flag on the
1190 line is used, and all earlier flags are ignored. No error is issued for
1193 [[SocksListenAddress]] **SocksListenAddress** __IP__[:__PORT__]::
1194 Bind to this address to listen for connections from Socks-speaking
1195 applications. (Default: 127.0.0.1) You can also specify a port (e.g.
1196 192.168.0.1:9100). This directive can be specified multiple times to bind
1197 to multiple addresses/ports. (DEPRECATED: As of 0.2.3.x-alpha, you can
1198 now use multiple SocksPort entries, and provide addresses for SocksPort
1199 entries, so SocksListenAddress no longer has a purpose. For backward
1200 compatibility, SocksListenAddress is only allowed when SocksPort is just
1203 [[SocksPolicy]] **SocksPolicy** __policy__,__policy__,__...__::
1204 Set an entrance policy for this server, to limit who can connect to the
1205 SocksPort and DNSPort ports. The policies have the same form as exit
1206 policies below, except that port specifiers are ignored. Any address
1207 not matched by some entry in the policy is accepted.
1209 [[SocksTimeout]] **SocksTimeout** __NUM__::
1210 Let a socks connection wait NUM seconds handshaking, and NUM seconds
1211 unattached waiting for an appropriate circuit, before we fail it. (Default:
1214 [[TokenBucketRefillInterval]] **TokenBucketRefillInterval** __NUM__ [**msec**|**second**]::
1215 Set the refill interval of Tor's token bucket to NUM milliseconds.
1216 NUM must be between 1 and 1000, inclusive. Note that the configured
1217 bandwidth limits are still expressed in bytes per second: this
1218 option only affects the frequency with which Tor checks to see whether
1219 previously exhausted connections may read again.
1220 Can not be changed while tor is running. (Default: 100 msec)
1222 [[TrackHostExits]] **TrackHostExits** __host__,__.domain__,__...__::
1223 For each value in the comma separated list, Tor will track recent
1224 connections to hosts that match this value and attempt to reuse the same
1225 exit node for each. If the value is prepended with a \'.\', it is treated as
1226 matching an entire domain. If one of the values is just a \'.', it means
1227 match everything. This option is useful if you frequently connect to sites
1228 that will expire all your authentication cookies (i.e. log you out) if
1229 your IP address changes. Note that this option does have the disadvantage
1230 of making it more clear that a given history is associated with a single
1231 user. However, most people who would wish to observe this will observe it
1232 through cookies or other protocol-specific means anyhow.
1234 [[TrackHostExitsExpire]] **TrackHostExitsExpire** __NUM__::
1235 Since exit servers go up and down, it is desirable to expire the
1236 association between host and exit server after NUM seconds. The default is
1237 1800 seconds (30 minutes).
1239 [[UpdateBridgesFromAuthority]] **UpdateBridgesFromAuthority** **0**|**1**::
1240 When set (along with UseBridges), Tor will try to fetch bridge descriptors
1241 from the configured bridge authorities when feasible. It will fall back to
1242 a direct request if the authority responds with a 404. (Default: 0)
1244 [[UseBridges]] **UseBridges** **0**|**1**::
1245 When set, Tor will fetch descriptors for each bridge listed in the "Bridge"
1246 config lines, and use these relays as both entry guards and directory
1247 guards. (Default: 0)
1249 [[UseEntryGuards]] **UseEntryGuards** **0**|**1**::
1250 If this option is set to 1, we pick a few long-term entry servers, and try
1251 to stick with them. This is desirable because constantly changing servers
1252 increases the odds that an adversary who owns some servers will observe a
1253 fraction of your paths. Entry Guards can not be used by Directory
1254 Authorities, Single Onion Services, and Tor2web clients. In these cases,
1255 the this option is ignored. (Default: 1)
1257 [[GuardfractionFile]] **GuardfractionFile** __FILENAME__::
1258 V3 authoritative directories only. Configures the location of the
1259 guardfraction file which contains information about how long relays
1260 have been guards. (Default: unset)
1262 [[UseGuardFraction]] **UseGuardFraction** **0**|**1**|**auto**::
1263 This torrc option specifies whether clients should use the
1264 guardfraction information found in the consensus during path
1265 selection. If it's set to 'auto', clients will do what the
1266 UseGuardFraction consensus parameter tells them to do. (Default: auto)
1268 [[NumEntryGuards]] **NumEntryGuards** __NUM__::
1269 If UseEntryGuards is set to 1, we will try to pick a total of NUM routers
1270 as long-term entries for our circuits. If NUM is 0, we try to learn
1271 the number from the NumEntryGuards consensus parameter, and default
1272 to 3 if the consensus parameter isn't set. (Default: 0)
1274 [[NumDirectoryGuards]] **NumDirectoryGuards** __NUM__::
1275 If UseEntryGuardsAsDirectoryGuards is enabled, we try to make sure we
1276 have at least NUM routers to use as directory guards. If this option
1277 is set to 0, use the value from the NumDirectoryGuards consensus
1278 parameter, falling back to the value from NumEntryGuards if the
1279 consensus parameter is 0 or isn't set. (Default: 0)
1281 [[GuardLifetime]] **GuardLifetime** __N__ **days**|**weeks**|**months**::
1282 If nonzero, and UseEntryGuards is set, minimum time to keep a guard before
1283 picking a new one. If zero, we use the GuardLifetime parameter from the
1284 consensus directory. No value here may be less than 1 month or greater
1285 than 5 years; out-of-range values are clamped. (Default: 0)
1287 [[SafeSocks]] **SafeSocks** **0**|**1**::
1288 When this option is enabled, Tor will reject application connections that
1289 use unsafe variants of the socks protocol -- ones that only provide an IP
1290 address, meaning the application is doing a DNS resolve first.
1291 Specifically, these are socks4 and socks5 when not doing remote DNS.
1294 [[TestSocks]] **TestSocks** **0**|**1**::
1295 When this option is enabled, Tor will make a notice-level log entry for
1296 each connection to the Socks port indicating whether the request used a
1297 safe socks protocol or an unsafe one (see above entry on SafeSocks). This
1298 helps to determine whether an application using Tor is possibly leaking
1299 DNS requests. (Default: 0)
1301 [[WarnUnsafeSocks]] **WarnUnsafeSocks** **0**|**1**::
1302 When this option is enabled, Tor will warn whenever a request is
1303 received that only contains an IP address instead of a hostname. Allowing
1304 applications to do DNS resolves themselves is usually a bad idea and
1305 can leak your location to attackers. (Default: 1)
1307 [[VirtualAddrNetworkIPv4]] **VirtualAddrNetworkIPv4** __Address__/__bits__ +
1309 [[VirtualAddrNetworkIPv6]] **VirtualAddrNetworkIPv6** [__Address__]/__bits__::
1310 When Tor needs to assign a virtual (unused) address because of a MAPADDRESS
1311 command from the controller or the AutomapHostsOnResolve feature, Tor
1312 picks an unassigned address from this range. (Defaults:
1313 127.192.0.0/10 and [FE80::]/10 respectively.) +
1315 When providing proxy server service to a network of computers using a tool
1316 like dns-proxy-tor, change the IPv4 network to "10.192.0.0/10" or
1317 "172.16.0.0/12" and change the IPv6 network to "[FC00::]/7".
1318 The default **VirtualAddrNetwork** address ranges on a
1319 properly configured machine will route to the loopback or link-local
1320 interface. The maximum number of bits for the network prefix is set to 104
1321 for IPv6 and 16 for IPv4. However, a wider network - smaller prefix length
1322 - is preferable since it reduces the chances for an attacker to guess the
1323 used IP. For local use, no change to the default VirtualAddrNetwork setting
1326 [[AllowNonRFC953Hostnames]] **AllowNonRFC953Hostnames** **0**|**1**::
1327 When this option is disabled, Tor blocks hostnames containing illegal
1328 characters (like @ and :) rather than sending them to an exit node to be
1329 resolved. This helps trap accidental attempts to resolve URLs and so on.
1332 [[AllowDotExit]] **AllowDotExit** **0**|**1**::
1333 If enabled, we convert "www.google.com.foo.exit" addresses on the
1334 SocksPort/TransPort/NATDPort into "www.google.com" addresses that exit from
1335 the node "foo". Disabled by default since attacking websites and exit
1336 relays can use it to manipulate your path selection. (Default: 0)
1338 [[FastFirstHopPK]] **FastFirstHopPK** **0**|**1**|**auto**::
1339 When this option is disabled, Tor uses the public key step for the first
1340 hop of creating circuits. Skipping it is generally safe since we have
1341 already used TLS to authenticate the relay and to establish forward-secure
1342 keys. Turning this option off makes circuit building a little
1343 slower. Setting this option to "auto" takes advice from the authorities
1344 in the latest consensus about whether to use this feature. +
1346 Note that Tor will always use the public key step for the first hop if it's
1347 operating as a relay, and it will never use the public key step if it
1348 doesn't yet know the onion key of the first hop. (Default: auto)
1350 [[TransPort]] **TransPort** \['address':]__port__|**auto** [_isolation flags_]::
1351 Open this port to listen for transparent proxy connections. Set this to
1352 0 if you don't want to allow transparent proxy connections. Set the port
1353 to "auto" to have Tor pick a port for you. This directive can be
1354 specified multiple times to bind to multiple addresses/ports. See
1355 SOCKSPort for an explanation of isolation flags. +
1357 TransPort requires OS support for transparent proxies, such as BSDs' pf or
1358 Linux's IPTables. If you're planning to use Tor as a transparent proxy for
1359 a network, you'll want to examine and change VirtualAddrNetwork from the
1360 default setting. You'll also want to set the TransListenAddress option for
1361 the network you'd like to proxy. (Default: 0)
1363 [[TransListenAddress]] **TransListenAddress** __IP__[:__PORT__]::
1364 Bind to this address to listen for transparent proxy connections. (Default:
1365 127.0.0.1). This is useful for exporting a transparent proxy server to an
1366 entire network. (DEPRECATED: As of 0.2.3.x-alpha, you can
1367 now use multiple TransPort entries, and provide addresses for TransPort
1368 entries, so TransListenAddress no longer has a purpose. For backward
1369 compatibility, TransListenAddress is only allowed when TransPort is just
1372 [[TransProxyType]] **TransProxyType** **default**|**TPROXY**|**ipfw**|**pf-divert**::
1373 TransProxyType may only be enabled when there is transparent proxy listener
1376 Set this to "TPROXY" if you wish to be able to use the TPROXY Linux module
1377 to transparently proxy connections that are configured using the TransPort
1378 option. This setting lets the listener on the TransPort accept connections
1379 for all addresses, even when the TransListenAddress is configured for an
1380 internal address. Detailed information on how to configure the TPROXY
1381 feature can be found in the Linux kernel source tree in the file
1382 Documentation/networking/tproxy.txt. +
1384 Set this option to "ipfw" to use the FreeBSD ipfw interface. +
1386 On *BSD operating systems when using pf, set this to "pf-divert" to take
1387 advantage of +divert-to+ rules, which do not modify the packets like
1388 +rdr-to+ rules do. Detailed information on how to configure pf to use
1389 +divert-to+ rules can be found in the pf.conf(5) manual page. On OpenBSD,
1390 +divert-to+ is available to use on versions greater than or equal to
1393 Set this to "default", or leave it unconfigured, to use regular IPTables
1394 on Linux, or to use pf +rdr-to+ rules on *BSD systems. +
1396 (Default: "default".)
1398 [[NATDPort]] **NATDPort** \['address':]__port__|**auto** [_isolation flags_]::
1399 Open this port to listen for connections from old versions of ipfw (as
1400 included in old versions of FreeBSD, etc) using the NATD protocol.
1401 Use 0 if you don't want to allow NATD connections. Set the port
1402 to "auto" to have Tor pick a port for you. This directive can be
1403 specified multiple times to bind to multiple addresses/ports. See
1404 SocksPort for an explanation of isolation flags. +
1406 This option is only for people who cannot use TransPort. (Default: 0)
1408 [[NATDListenAddress]] **NATDListenAddress** __IP__[:__PORT__]::
1409 Bind to this address to listen for NATD connections. (DEPRECATED: As of
1410 0.2.3.x-alpha, you can now use multiple NATDPort entries, and provide
1411 addresses for NATDPort entries, so NATDListenAddress no longer has a
1412 purpose. For backward compatibility, NATDListenAddress is only allowed
1413 when NATDPort is just a port number.)
1415 [[AutomapHostsOnResolve]] **AutomapHostsOnResolve** **0**|**1**::
1416 When this option is enabled, and we get a request to resolve an address
1417 that ends with one of the suffixes in **AutomapHostsSuffixes**, we map an
1418 unused virtual address to that address, and return the new virtual address.
1419 This is handy for making ".onion" addresses work with applications that
1420 resolve an address and then connect to it. (Default: 0)
1422 [[AutomapHostsSuffixes]] **AutomapHostsSuffixes** __SUFFIX__,__SUFFIX__,__...__::
1423 A comma-separated list of suffixes to use with **AutomapHostsOnResolve**.
1424 The "." suffix is equivalent to "all addresses." (Default: .exit,.onion).
1426 [[DNSPort]] **DNSPort** \['address':]__port__|**auto** [_isolation flags_]::
1427 If non-zero, open this port to listen for UDP DNS requests, and resolve
1428 them anonymously. This port only handles A, AAAA, and PTR requests---it
1429 doesn't handle arbitrary DNS request types. Set the port to "auto" to
1430 have Tor pick a port for
1431 you. This directive can be specified multiple times to bind to multiple
1432 addresses/ports. See SocksPort for an explanation of isolation
1435 [[DNSListenAddress]] **DNSListenAddress** __IP__[:__PORT__]::
1436 Bind to this address to listen for DNS connections. (DEPRECATED: As of
1437 0.2.3.x-alpha, you can now use multiple DNSPort entries, and provide
1438 addresses for DNSPort entries, so DNSListenAddress no longer has a
1439 purpose. For backward compatibility, DNSListenAddress is only allowed
1440 when DNSPort is just a port number.)
1442 [[ClientDNSRejectInternalAddresses]] **ClientDNSRejectInternalAddresses** **0**|**1**::
1443 If true, Tor does not believe any anonymously retrieved DNS answer that
1444 tells it that an address resolves to an internal address (like 127.0.0.1 or
1445 192.168.0.1). This option prevents certain browser-based attacks; don't
1446 turn it off unless you know what you're doing. (Default: 1)
1448 [[ClientRejectInternalAddresses]] **ClientRejectInternalAddresses** **0**|**1**::
1449 If true, Tor does not try to fulfill requests to connect to an internal
1450 address (like 127.0.0.1 or 192.168.0.1) __unless a exit node is
1451 specifically requested__ (for example, via a .exit hostname, or a
1452 controller request). If true, multicast DNS hostnames for machines on the
1453 local network (of the form *.local) are also rejected. (Default: 1)
1455 [[DownloadExtraInfo]] **DownloadExtraInfo** **0**|**1**::
1456 If true, Tor downloads and caches "extra-info" documents. These documents
1457 contain information about servers other than the information in their
1458 regular server descriptors. Tor does not use this information for anything
1459 itself; to save bandwidth, leave this option turned off. (Default: 0)
1461 [[WarnPlaintextPorts]] **WarnPlaintextPorts** __port__,__port__,__...__::
1462 Tells Tor to issue a warnings whenever the user tries to make an anonymous
1463 connection to one of these ports. This option is designed to alert users
1464 to services that risk sending passwords in the clear. (Default:
1467 [[RejectPlaintextPorts]] **RejectPlaintextPorts** __port__,__port__,__...__::
1468 Like WarnPlaintextPorts, but instead of warning about risky port uses, Tor
1469 will instead refuse to make the connection. (Default: None)
1471 [[AllowSingleHopCircuits]] **AllowSingleHopCircuits** **0**|**1**::
1472 When this option is set, the attached Tor controller can use relays
1473 that have the **AllowSingleHopExits** option turned on to build
1474 one-hop Tor connections. (Default: 0)
1476 [[OptimisticData]] **OptimisticData** **0**|**1**|**auto**::
1477 When this option is set, and Tor is using an exit node that supports
1478 the feature, it will try optimistically to send data to the exit node
1479 without waiting for the exit node to report whether the connection
1480 succeeded. This can save a round-trip time for protocols like HTTP
1481 where the client talks first. If OptimisticData is set to **auto**,
1482 Tor will look at the UseOptimisticData parameter in the networkstatus.
1485 [[Tor2webMode]] **Tor2webMode** **0**|**1**::
1486 When this option is set, Tor connects to hidden services
1487 **non-anonymously**. This option also disables client connections to
1488 non-hidden-service hostnames through Tor. It **must only** be used when
1489 running a tor2web Hidden Service web proxy.
1490 To enable this option the compile time flag --enable-tor2web-mode must be
1491 specified. Since Tor2webMode is non-anonymous, you can not run an
1492 anonymous Hidden Service on a tor version compiled with Tor2webMode.
1495 [[Tor2webRendezvousPoints]] **Tor2webRendezvousPoints** __node__,__node__,__...__::
1496 A list of identity fingerprints, nicknames, country codes and
1497 address patterns of nodes that are allowed to be used as RPs
1498 in HS circuits; any other nodes will not be used as RPs.
1500 Tor2webRendezvousPoints Fastyfasty, ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
1502 This feature can only be used if Tor2webMode is also enabled. +
1504 ExcludeNodes have higher priority than Tor2webRendezvousPoints,
1505 which means that nodes specified in ExcludeNodes will not be
1508 If no nodes in Tor2webRendezvousPoints are currently available for
1509 use, Tor will choose a random node when building HS circuits.
1511 [[UseMicrodescriptors]] **UseMicrodescriptors** **0**|**1**|**auto**::
1512 Microdescriptors are a smaller version of the information that Tor needs
1513 in order to build its circuits. Using microdescriptors makes Tor clients
1514 download less directory information, thus saving bandwidth. Directory
1515 caches need to fetch regular descriptors and microdescriptors, so this
1516 option doesn't save any bandwidth for them. If this option is set to
1517 "auto" (recommended) then it is on for all clients that do not set
1518 FetchUselessDescriptors. (Default: auto)
1520 [[PathBiasCircThreshold]] **PathBiasCircThreshold** __NUM__ +
1522 [[PathBiasNoticeRate]] **PathBiasNoticeRate** __NUM__ +
1524 [[PathBiasWarnRate]] **PathBiasWarnRate** __NUM__ +
1526 [[PathBiasExtremeRate]] **PathBiasExtremeRate** __NUM__ +
1528 [[PathBiasDropGuards]] **PathBiasDropGuards** __NUM__ +
1530 [[PathBiasScaleThreshold]] **PathBiasScaleThreshold** __NUM__::
1531 These options override the default behavior of Tor's (**currently
1532 experimental**) path bias detection algorithm. To try to find broken or
1533 misbehaving guard nodes, Tor looks for nodes where more than a certain
1534 fraction of circuits through that guard fail to get built. +
1536 The PathBiasCircThreshold option controls how many circuits we need to build
1537 through a guard before we make these checks. The PathBiasNoticeRate,
1538 PathBiasWarnRate and PathBiasExtremeRate options control what fraction of
1539 circuits must succeed through a guard so we won't write log messages.
1540 If less than PathBiasExtremeRate circuits succeed *and* PathBiasDropGuards
1541 is set to 1, we disable use of that guard. +
1543 When we have seen more than PathBiasScaleThreshold
1544 circuits through a guard, we scale our observations by 0.5 (governed by
1545 the consensus) so that new observations don't get swamped by old ones. +
1547 By default, or if a negative value is provided for one of these options,
1548 Tor uses reasonable defaults from the networkstatus consensus document.
1549 If no defaults are available there, these options default to 150, .70,
1550 .50, .30, 0, and 300 respectively.
1552 [[PathBiasUseThreshold]] **PathBiasUseThreshold** __NUM__ +
1554 [[PathBiasNoticeUseRate]] **PathBiasNoticeUseRate** __NUM__ +
1556 [[PathBiasExtremeUseRate]] **PathBiasExtremeUseRate** __NUM__ +
1558 [[PathBiasScaleUseThreshold]] **PathBiasScaleUseThreshold** __NUM__::
1559 Similar to the above options, these options override the default behavior
1560 of Tor's (**currently experimental**) path use bias detection algorithm. +
1562 Where as the path bias parameters govern thresholds for successfully
1563 building circuits, these four path use bias parameters govern thresholds
1564 only for circuit usage. Circuits which receive no stream usage
1565 are not counted by this detection algorithm. A used circuit is considered
1566 successful if it is capable of carrying streams or otherwise receiving
1567 well-formed responses to RELAY cells. +
1569 By default, or if a negative value is provided for one of these options,
1570 Tor uses reasonable defaults from the networkstatus consensus document.
1571 If no defaults are available there, these options default to 20, .80,
1572 .60, and 100, respectively.
1574 [[ClientUseIPv4]] **ClientUseIPv4** **0**|**1**::
1575 If this option is set to 0, Tor will avoid connecting to directory servers
1576 and entry nodes over IPv4. Note that clients with an IPv4
1577 address in a **Bridge**, proxy, or pluggable transport line will try
1578 connecting over IPv4 even if **ClientUseIPv4** is set to 0. (Default: 1)
1580 [[ClientUseIPv6]] **ClientUseIPv6** **0**|**1**::
1581 If this option is set to 1, Tor might connect to directory servers or
1582 entry nodes over IPv6. Note that clients configured with an IPv6 address
1583 in a **Bridge**, proxy, or pluggable transport line will try connecting
1584 over IPv6 even if **ClientUseIPv6** is set to 0. (Default: 0)
1586 [[ClientPreferIPv6DirPort]] **ClientPreferIPv6DirPort** **0**|**1**|**auto**::
1587 If this option is set to 1, Tor prefers a directory port with an IPv6
1588 address over one with IPv4, for direct connections, if a given directory
1589 server has both. (Tor also prefers an IPv6 DirPort if IPv4Client is set to
1590 0.) If this option is set to auto, clients prefer IPv4. Other things may
1591 influence the choice. This option breaks a tie to the favor of IPv6.
1594 [[ClientPreferIPv6ORPort]] **ClientPreferIPv6ORPort** **0**|**1**|**auto**::
1595 If this option is set to 1, Tor prefers an OR port with an IPv6
1596 address over one with IPv4 if a given entry node has both. (Tor also
1597 prefers an IPv6 ORPort if IPv4Client is set to 0.) If this option is set
1598 to auto, Tor bridge clients prefer the configured bridge address, and
1599 other clients prefer IPv4. Other things may influence the choice. This
1600 option breaks a tie to the favor of IPv6. (Default: auto)
1602 [[PathsNeededToBuildCircuits]] **PathsNeededToBuildCircuits** __NUM__::
1603 Tor clients don't build circuits for user traffic until they know
1604 about enough of the network so that they could potentially construct
1605 enough of the possible paths through the network. If this option
1606 is set to a fraction between 0.25 and 0.95, Tor won't build circuits
1607 until it has enough descriptors or microdescriptors to construct
1608 that fraction of possible paths. Note that setting this option too low
1609 can make your Tor client less anonymous, and setting it too high can
1610 prevent your Tor client from bootstrapping. If this option is negative,
1611 Tor will use a default value chosen by the directory authorities. If the
1612 directory authorities do not choose a value, Tor will default to 0.6.
1615 [[ClientBootstrapConsensusAuthorityDownloadSchedule]] **ClientBootstrapConsensusAuthorityDownloadSchedule** __N__,__N__,__...__::
1616 Schedule for when clients should download consensuses from authorities
1617 if they are bootstrapping (that is, they don't have a usable, reasonably
1618 live consensus). Only used by clients fetching from a list of fallback
1619 directory mirrors. This schedule is advanced by (potentially concurrent)
1620 connection attempts, unlike other schedules, which are advanced by
1621 connection failures. (Default: 10, 11, 3600, 10800, 25200, 54000,
1624 [[ClientBootstrapConsensusFallbackDownloadSchedule]] **ClientBootstrapConsensusFallbackDownloadSchedule** __N__,__N__,__...__::
1625 Schedule for when clients should download consensuses from fallback
1626 directory mirrors if they are bootstrapping (that is, they don't have a
1627 usable, reasonably live consensus). Only used by clients fetching from a
1628 list of fallback directory mirrors. This schedule is advanced by
1629 (potentially concurrent) connection attempts, unlike other schedules,
1630 which are advanced by connection failures. (Default: 0, 1, 4, 11, 3600,
1631 10800, 25200, 54000, 111600, 262800)
1633 [[ClientBootstrapConsensusAuthorityOnlyDownloadSchedule]] **ClientBootstrapConsensusAuthorityOnlyDownloadSchedule** __N__,__N__,__...__::
1634 Schedule for when clients should download consensuses from authorities
1635 if they are bootstrapping (that is, they don't have a usable, reasonably
1636 live consensus). Only used by clients which don't have or won't fetch
1637 from a list of fallback directory mirrors. This schedule is advanced by
1638 (potentially concurrent) connection attempts, unlike other schedules,
1639 which are advanced by connection failures. (Default: 0, 3, 7, 3600,
1640 10800, 25200, 54000, 111600, 262800)
1642 [[ClientBootstrapConsensusMaxDownloadTries]] **ClientBootstrapConsensusMaxDownloadTries** __NUM__::
1643 Try this many times to download a consensus while bootstrapping using
1644 fallback directory mirrors before giving up. (Default: 7)
1646 [[ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries]] **ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries** __NUM__::
1647 Try this many times to download a consensus while bootstrapping using
1648 authorities before giving up. (Default: 4)
1650 [[ClientBootstrapConsensusMaxInProgressTries]] **ClientBootstrapConsensusMaxInProgressTries** __NUM__::
1651 Try this many simultaneous connections to download a consensus before
1652 waiting for one to complete, timeout, or error out. (Default: 4)
1657 The following options are useful only for servers (that is, if ORPort
1660 [[Address]] **Address** __address__::
1661 The IP address or fully qualified domain name of this server (e.g.
1662 moria.mit.edu). You can leave this unset, and Tor will guess your IP
1663 address. This IP address is the one used to tell clients and other
1664 servers where to find your Tor server; it doesn't affect the IP that your
1665 Tor client binds to. To bind to a different address, use the
1666 *ListenAddress and OutboundBindAddress options.
1668 [[AllowSingleHopExits]] **AllowSingleHopExits** **0**|**1**::
1669 This option controls whether clients can use this server as a single hop
1670 proxy. If set to 1, clients can use this server as an exit even if it is
1671 the only hop in the circuit. Note that most clients will refuse to use
1672 servers that set this option, since most clients have
1673 ExcludeSingleHopRelays set. (Default: 0)
1675 [[AssumeReachable]] **AssumeReachable** **0**|**1**::
1676 This option is used when bootstrapping a new Tor network. If set to 1,
1677 don't do self-reachability testing; just upload your server descriptor
1678 immediately. If **AuthoritativeDirectory** is also set, this option
1679 instructs the dirserver to bypass remote reachability testing too and list
1680 all connected servers as running.
1682 [[BridgeRelay]] **BridgeRelay** **0**|**1**::
1683 Sets the relay to act as a "bridge" with respect to relaying connections
1684 from bridge users to the Tor network. It mainly causes Tor to publish a
1685 server descriptor to the bridge database, rather than
1686 to the public directory authorities.
1688 [[ContactInfo]] **ContactInfo** __email_address__::
1689 Administrative contact information for this relay or bridge. This line
1690 can be used to contact you if your relay or bridge is misconfigured or
1691 something else goes wrong. Note that we archive and publish all
1692 descriptors containing these lines and that Google indexes them, so
1693 spammers might also collect them. You may want to obscure the fact
1694 that it's an email address and/or generate a new address for this
1697 [[ExitRelay]] **ExitRelay** **0**|**1**|**auto**::
1698 Tells Tor whether to run as an exit relay. If Tor is running as a
1699 non-bridge server, and ExitRelay is set to 1, then Tor allows traffic to
1700 exit according to the ExitPolicy option (or the default ExitPolicy if
1701 none is specified). +
1703 If ExitRelay is set to 0, no traffic is allowed to
1704 exit, and the ExitPolicy option is ignored. +
1706 If ExitRelay is set to "auto", then Tor behaves as if it were set to 1, but
1707 warns the user if this would cause traffic to exit. In a future version,
1708 the default value will be 0. (Default: auto)
1710 [[ExitPolicy]] **ExitPolicy** __policy__,__policy__,__...__::
1711 Set an exit policy for this server. Each policy is of the form
1712 "**accept[6]**|**reject[6]** __ADDR__[/__MASK__][:__PORT__]". If /__MASK__ is
1713 omitted then this policy just applies to the host given. Instead of giving
1714 a host or network you can also use "\*" to denote the universe (0.0.0.0/0
1715 and ::/128), or \*4 to denote all IPv4 addresses, and \*6 to denote all
1717 __PORT__ can be a single port number, an interval of ports
1718 "__FROM_PORT__-__TO_PORT__", or "\*". If __PORT__ is omitted, that means
1721 For example, "accept 18.7.22.69:\*,reject 18.0.0.0/8:\*,accept \*:\*" would
1722 reject any IPv4 traffic destined for MIT except for web.mit.edu, and accept
1723 any other IPv4 or IPv6 traffic. +
1725 Tor also allows IPv6 exit policy entries. For instance, "reject6 [FC00::]/7:\*"
1726 rejects all destinations that share 7 most significant bit prefix with
1727 address FC00::. Respectively, "accept6 [C000::]/3:\*" accepts all destinations
1728 that share 3 most significant bit prefix with address C000::. +
1730 accept6 and reject6 only produce IPv6 exit policy entries. Using an IPv4
1731 address with accept6 or reject6 is ignored and generates a warning.
1732 accept/reject allows either IPv4 or IPv6 addresses. Use \*4 as an IPv4
1733 wildcard address, and \*6 as an IPv6 wildcard address. accept/reject *
1734 expands to matching IPv4 and IPv6 wildcard address rules. +
1736 To specify all IPv4 and IPv6 internal and link-local networks (including
1737 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,
1738 172.16.0.0/12, [::]/8, [FC00::]/7, [FE80::]/10, [FEC0::]/10, [FF00::]/8,
1739 and [::]/127), you can use the "private" alias instead of an address.
1740 ("private" always produces rules for IPv4 and IPv6 addresses, even when
1741 used with accept6/reject6.) +
1743 Private addresses are rejected by default (at the beginning of your exit
1744 policy), along with any configured primary public IPv4 and IPv6 addresses.
1745 These private addresses are rejected unless you set the
1746 ExitPolicyRejectPrivate config option to 0. For example, once you've done
1747 that, you could allow HTTP to 127.0.0.1 and block all other connections to
1748 internal networks with "accept 127.0.0.1:80,reject private:\*", though that
1749 may also allow connections to your own computer that are addressed to its
1750 public (external) IP address. See RFC 1918 and RFC 3330 for more details
1751 about internal and reserved IP address space. See
1752 ExitPolicyRejectLocalInterfaces if you want to block every address on the
1753 relay, even those that aren't advertised in the descriptor. +
1755 This directive can be specified multiple times so you don't have to put it
1758 Policies are considered first to last, and the first match wins. If you
1759 want to allow the same ports on IPv4 and IPv6, write your rules using
1760 accept/reject \*. If you want to allow different ports on IPv4 and IPv6,
1761 write your IPv6 rules using accept6/reject6 \*6, and your IPv4 rules using
1762 accept/reject \*4. If you want to \_replace_ the default exit policy, end
1763 your exit policy with either a reject \*:* or an accept \*:*. Otherwise,
1764 you're \_augmenting_ (prepending to) the default exit policy. The default
1779 [[ExitPolicyDefault]]::
1780 Since the default exit policy uses accept/reject *, it applies to both
1781 IPv4 and IPv6 addresses.
1783 [[ExitPolicyRejectPrivate]] **ExitPolicyRejectPrivate** **0**|**1**::
1784 Reject all private (local) networks, along with the relay's advertised
1785 public IPv4 and IPv6 addresses, at the beginning of your exit policy.
1786 See above entry on ExitPolicy.
1789 [[ExitPolicyRejectLocalInterfaces]] **ExitPolicyRejectLocalInterfaces** **0**|**1**::
1790 Reject all IPv4 and IPv6 addresses that the relay knows about, at the
1791 beginning of your exit policy. This includes any OutboundBindAddress, the
1792 bind addresses of any port options, such as ControlPort or DNSPort, and any
1793 public IPv4 and IPv6 addresses on any interface on the relay. (If IPv6Exit
1794 is not set, all IPv6 addresses will be rejected anyway.)
1795 See above entry on ExitPolicy.
1796 This option is off by default, because it lists all public relay IP
1797 addresses in the ExitPolicy, even those relay operators might prefer not
1801 [[IPv6Exit]] **IPv6Exit** **0**|**1**::
1802 If set, and we are an exit node, allow clients to use us for IPv6
1803 traffic. (Default: 0)
1805 [[MaxOnionQueueDelay]] **MaxOnionQueueDelay** __NUM__ [**msec**|**second**]::
1806 If we have more onionskins queued for processing than we can process in
1807 this amount of time, reject new ones. (Default: 1750 msec)
1809 [[MyFamily]] **MyFamily** __node__,__node__,__...__::
1810 Declare that this Tor server is controlled or administered by a group or
1811 organization identical or similar to that of the other servers, defined by
1812 their identity fingerprints. When two servers both declare
1813 that they are in the same \'family', Tor clients will not use them in the
1814 same circuit. (Each server only needs to list the other servers in its
1815 family; it doesn't need to list itself, but it won't hurt.) Do not list
1816 any bridge relay as it would compromise its concealment. +
1818 When listing a node, it's better to list it by fingerprint than by
1819 nickname: fingerprints are more reliable.
1821 [[Nickname]] **Nickname** __name__::
1822 Set the server's nickname to \'name'. Nicknames must be between 1 and 19
1823 characters inclusive, and must contain only the characters [a-zA-Z0-9].
1825 [[NumCPUs]] **NumCPUs** __num__::
1826 How many processes to use at once for decrypting onionskins and other
1827 parallelizable operations. If this is set to 0, Tor will try to detect
1828 how many CPUs you have, defaulting to 1 if it can't tell. (Default: 0)
1830 [[ORPort]] **ORPort** \['address':]__PORT__|**auto** [_flags_]::
1831 Advertise this port to listen for connections from Tor clients and
1832 servers. This option is required to be a Tor server.
1833 Set it to "auto" to have Tor pick a port for you. Set it to 0 to not
1834 run an ORPort at all. This option can occur more than once. (Default: 0) +
1836 Tor recognizes these flags on each ORPort:
1838 By default, we bind to a port and tell our users about it. If
1839 NoAdvertise is specified, we don't advertise, but listen anyway. This
1840 can be useful if the port everybody will be connecting to (for
1841 example, one that's opened on our firewall) is somewhere else.
1843 By default, we bind to a port and tell our users about it. If
1844 NoListen is specified, we don't bind, but advertise anyway. This
1845 can be useful if something else (for example, a firewall's port
1846 forwarding configuration) is causing connections to reach us.
1848 If the address is absent, or resolves to both an IPv4 and an IPv6
1849 address, only listen to the IPv4 address.
1851 If the address is absent, or resolves to both an IPv4 and an IPv6
1852 address, only listen to the IPv6 address.
1854 [[ORPortFlagsExclusive]]::
1855 For obvious reasons, NoAdvertise and NoListen are mutually exclusive, and
1856 IPv4Only and IPv6Only are mutually exclusive.
1858 [[ORListenAddress]] **ORListenAddress** __IP__[:__PORT__]::
1859 Bind to this IP address to listen for connections from Tor clients and
1860 servers. If you specify a port, bind to this port rather than the one
1861 specified in ORPort. (Default: 0.0.0.0) This directive can be specified
1862 multiple times to bind to multiple addresses/ports. +
1864 This option is deprecated; you can get the same behavior with ORPort now
1865 that it supports NoAdvertise and explicit addresses.
1867 [[PortForwarding]] **PortForwarding** **0**|**1**::
1868 Attempt to automatically forward the DirPort and ORPort on a NAT router
1869 connecting this Tor server to the Internet. If set, Tor will try both
1870 NAT-PMP (common on Apple routers) and UPnP (common on routers from other
1871 manufacturers). (Default: 0)
1873 [[PortForwardingHelper]] **PortForwardingHelper** __filename__|__pathname__::
1874 If PortForwarding is set, use this executable to configure the forwarding.
1875 If set to a filename, the system path will be searched for the executable.
1876 If set to a path, only the specified path will be executed.
1877 (Default: tor-fw-helper)
1879 [[PublishServerDescriptor]] **PublishServerDescriptor** **0**|**1**|**v3**|**bridge**,**...**::
1880 This option specifies which descriptors Tor will publish when acting as
1882 choose multiple arguments, separated by commas. +
1884 If this option is set to 0, Tor will not publish its
1885 descriptors to any directories. (This is useful if you're testing
1886 out your server, or if you're using a Tor controller that handles directory
1887 publishing for you.) Otherwise, Tor will publish its descriptors of all
1888 type(s) specified. The default is "1",
1889 which means "if running as a server, publish the
1890 appropriate descriptors to the authorities".
1892 [[ShutdownWaitLength]] **ShutdownWaitLength** __NUM__::
1893 When we get a SIGINT and we're a server, we begin shutting down:
1894 we close listeners and start refusing new circuits. After **NUM**
1895 seconds, we exit. If we get a second SIGINT, we exit immediately.
1896 (Default: 30 seconds)
1898 [[SSLKeyLifetime]] **SSLKeyLifetime** __N__ **minutes**|**hours**|**days**|**weeks**::
1899 When creating a link certificate for our outermost SSL handshake,
1900 set its lifetime to this amount of time. If set to 0, Tor will choose
1901 some reasonable random defaults. (Default: 0)
1903 [[HeartbeatPeriod]] **HeartbeatPeriod** __N__ **minutes**|**hours**|**days**|**weeks**::
1904 Log a heartbeat message every **HeartbeatPeriod** seconds. This is
1905 a log level __notice__ message, designed to let you know your Tor
1906 server is still alive and doing useful things. Settings this
1907 to 0 will disable the heartbeat. Otherwise, it must be at least 30
1908 minutes. (Default: 6 hours)
1910 [[AccountingMax]] **AccountingMax** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
1911 Limits the max number of bytes sent and received within a set time period
1912 using a given calculation rule (see: AccountingStart, AccountingRule).
1913 Useful if you need to stay under a specific bandwidth. By default, the
1914 number used for calculation is the max of either the bytes sent or
1915 received. For example, with AccountingMax set to 1 GByte, a server
1916 could send 900 MBytes and receive 800 MBytes and continue running.
1917 It will only hibernate once one of the two reaches 1 GByte. This can
1918 be changed to use the sum of the both bytes received and sent by setting
1919 the AccountingRule option to "sum" (total bandwidth in/out). When the
1920 number of bytes remaining gets low, Tor will stop accepting new connections
1921 and circuits. When the number of bytes is exhausted, Tor will hibernate
1922 until some time in the next accounting period. To prevent all servers
1923 from waking at the same time, Tor will also wait until a random point
1924 in each period before waking up. If you have bandwidth cost issues,
1925 enabling hibernation is preferable to setting a low bandwidth, since
1926 it provides users with a collection of fast servers that are up some
1927 of the time, which is more useful than a set of slow servers that are
1930 [[AccountingRule]] **AccountingRule** **sum**|**max**|**in**|**out**::
1931 How we determine when our AccountingMax has been reached (when we
1932 should hibernate) during a time interval. Set to "max" to calculate
1933 using the higher of either the sent or received bytes (this is the
1934 default functionality). Set to "sum" to calculate using the sent
1935 plus received bytes. Set to "in" to calculate using only the
1936 received bytes. Set to "out" to calculate using only the sent bytes.
1939 [[AccountingStart]] **AccountingStart** **day**|**week**|**month** [__day__] __HH:MM__::
1940 Specify how long accounting periods last. If **month** is given, each
1941 accounting period runs from the time __HH:MM__ on the __dayth__ day of one
1942 month to the same day and time of the next. (The day must be between 1 and
1943 28.) If **week** is given, each accounting period runs from the time __HH:MM__
1944 of the __dayth__ day of one week to the same day and time of the next week,
1945 with Monday as day 1 and Sunday as day 7. If **day** is given, each
1946 accounting period runs from the time __HH:MM__ each day to the same time on
1947 the next day. All times are local, and given in 24-hour time. (Default:
1950 [[RefuseUnknownExits]] **RefuseUnknownExits** **0**|**1**|**auto**::
1951 Prevent nodes that don't appear in the consensus from exiting using this
1952 relay. If the option is 1, we always block exit attempts from such
1953 nodes; if it's 0, we never do, and if the option is "auto", then we do
1954 whatever the authorities suggest in the consensus (and block if the consensus
1955 is quiet on the issue). (Default: auto)
1957 [[ServerDNSResolvConfFile]] **ServerDNSResolvConfFile** __filename__::
1958 Overrides the default DNS configuration with the configuration in
1959 __filename__. The file format is the same as the standard Unix
1960 "**resolv.conf**" file (7). This option, like all other ServerDNS options,
1961 only affects name lookups that your server does on behalf of clients.
1962 (Defaults to use the system DNS configuration.)
1964 [[ServerDNSAllowBrokenConfig]] **ServerDNSAllowBrokenConfig** **0**|**1**::
1965 If this option is false, Tor exits immediately if there are problems
1966 parsing the system DNS configuration or connecting to nameservers.
1967 Otherwise, Tor continues to periodically retry the system nameservers until
1968 it eventually succeeds. (Default: 1)
1970 [[ServerDNSSearchDomains]] **ServerDNSSearchDomains** **0**|**1**::
1971 If set to 1, then we will search for addresses in the local search domain.
1972 For example, if this system is configured to believe it is in
1973 "example.com", and a client tries to connect to "www", the client will be
1974 connected to "www.example.com". This option only affects name lookups that
1975 your server does on behalf of clients. (Default: 0)
1977 [[ServerDNSDetectHijacking]] **ServerDNSDetectHijacking** **0**|**1**::
1978 When this option is set to 1, we will test periodically to determine
1979 whether our local nameservers have been configured to hijack failing DNS
1980 requests (usually to an advertising site). If they are, we will attempt to
1981 correct this. This option only affects name lookups that your server does
1982 on behalf of clients. (Default: 1)
1984 [[ServerDNSTestAddresses]] **ServerDNSTestAddresses** __address__,__address__,__...__::
1985 When we're detecting DNS hijacking, make sure that these __valid__ addresses
1986 aren't getting redirected. If they are, then our DNS is completely useless,
1987 and we'll reset our exit policy to "reject \*:*". This option only affects
1988 name lookups that your server does on behalf of clients. (Default:
1989 "www.google.com, www.mit.edu, www.yahoo.com, www.slashdot.org")
1991 [[ServerDNSAllowNonRFC953Hostnames]] **ServerDNSAllowNonRFC953Hostnames** **0**|**1**::
1992 When this option is disabled, Tor does not try to resolve hostnames
1993 containing illegal characters (like @ and :) rather than sending them to an
1994 exit node to be resolved. This helps trap accidental attempts to resolve
1995 URLs and so on. This option only affects name lookups that your server does
1996 on behalf of clients. (Default: 0)
1998 [[BridgeRecordUsageByCountry]] **BridgeRecordUsageByCountry** **0**|**1**::
1999 When this option is enabled and BridgeRelay is also enabled, and we have
2000 GeoIP data, Tor keeps a per-country count of how many client
2001 addresses have contacted it so that it can help the bridge authority guess
2002 which countries have blocked access to it. (Default: 1)
2004 [[ServerDNSRandomizeCase]] **ServerDNSRandomizeCase** **0**|**1**::
2005 When this option is set, Tor sets the case of each character randomly in
2006 outgoing DNS requests, and makes sure that the case matches in DNS replies.
2007 This so-called "0x20 hack" helps resist some types of DNS poisoning attack.
2008 For more information, see "Increased DNS Forgery Resistance through
2009 0x20-Bit Encoding". This option only affects name lookups that your server
2010 does on behalf of clients. (Default: 1)
2012 [[GeoIPFile]] **GeoIPFile** __filename__::
2013 A filename containing IPv4 GeoIP data, for use with by-country statistics.
2015 [[GeoIPv6File]] **GeoIPv6File** __filename__::
2016 A filename containing IPv6 GeoIP data, for use with by-country statistics.
2018 [[TLSECGroup]] **TLSECGroup** **P224**|**P256**::
2019 What EC group should we try to use for incoming TLS connections?
2020 P224 is faster, but makes us stand out more. Has no effect if
2021 we're a client, or if our OpenSSL version lacks support for ECDHE.
2024 [[CellStatistics]] **CellStatistics** **0**|**1**::
2026 When this option is enabled, Tor collects statistics about cell
2027 processing (i.e. mean time a cell is spending in a queue, mean
2028 number of cells in a queue and mean number of processed cells per
2029 circuit) and writes them into disk every 24 hours. Onion router
2030 operators may use the statistics for performance monitoring.
2031 If ExtraInfoStatistics is enabled, it will published as part of
2032 extra-info document. (Default: 0)
2034 [[DirReqStatistics]] **DirReqStatistics** **0**|**1**::
2035 Relays and bridges only.
2036 When this option is enabled, a Tor directory writes statistics on the
2037 number and response time of network status requests to disk every 24
2038 hours. Enables relay and bridge operators to monitor how much their
2039 server is being used by clients to learn about Tor network.
2040 If ExtraInfoStatistics is enabled, it will published as part of
2041 extra-info document. (Default: 1)
2043 [[EntryStatistics]] **EntryStatistics** **0**|**1**::
2045 When this option is enabled, Tor writes statistics on the number of
2046 directly connecting clients to disk every 24 hours. Enables relay
2047 operators to monitor how much inbound traffic that originates from
2048 Tor clients passes through their server to go further down the
2049 Tor network. If ExtraInfoStatistics is enabled, it will be published
2050 as part of extra-info document. (Default: 0)
2052 [[ExitPortStatistics]] **ExitPortStatistics** **0**|**1**::
2054 When this option is enabled, Tor writes statistics on the number of
2055 relayed bytes and opened stream per exit port to disk every 24 hours.
2056 Enables exit relay operators to measure and monitor amounts of traffic
2057 that leaves Tor network through their exit node. If ExtraInfoStatistics
2058 is enabled, it will be published as part of extra-info document.
2061 [[ConnDirectionStatistics]] **ConnDirectionStatistics** **0**|**1**::
2063 When this option is enabled, Tor writes statistics on the amounts of
2064 traffic it passes between itself and other relays to disk every 24
2065 hours. Enables relay operators to monitor how much their relay is
2066 being used as middle node in the circuit. If ExtraInfoStatistics is
2067 enabled, it will be published as part of extra-info document.
2070 [[HiddenServiceStatistics]] **HiddenServiceStatistics** **0**|**1**::
2072 When this option is enabled, a Tor relay writes obfuscated
2073 statistics on its role as hidden-service directory, introduction
2074 point, or rendezvous point to disk every 24 hours. If
2075 ExtraInfoStatistics is also enabled, these statistics are further
2076 published to the directory authorities. (Default: 1)
2078 [[ExtraInfoStatistics]] **ExtraInfoStatistics** **0**|**1**::
2079 When this option is enabled, Tor includes previously gathered statistics in
2080 its extra-info documents that it uploads to the directory authorities.
2083 [[ExtendAllowPrivateAddresses]] **ExtendAllowPrivateAddresses** **0**|**1**::
2084 When this option is enabled, Tor will connect to relays on localhost,
2085 RFC1918 addresses, and so on. In particular, Tor will make direct OR
2086 connections, and Tor routers allow EXTEND requests, to these private
2087 addresses. (Tor will always allow connections to bridges, proxies, and
2088 pluggable transports configured on private addresses.) Enabling this
2089 option can create security issues; you should probably leave it off.
2092 [[MaxMemInQueues]] **MaxMemInQueues** __N__ **bytes**|**KB**|**MB**|**GB**::
2093 This option configures a threshold above which Tor will assume that it
2094 needs to stop queueing or buffering data because it's about to run out of
2095 memory. If it hits this threshold, it will begin killing circuits until
2096 it has recovered at least 10% of this memory. Do not set this option too
2097 low, or your relay may be unreliable under load. This option only
2098 affects some queues, so the actual process size will be larger than
2099 this. If this option is set to 0, Tor will try to pick a reasonable
2100 default based on your system's physical memory. (Default: 0)
2102 [[DisableOOSCheck]] **DisableOOSCheck** **0**|**1**::
2103 This option disables the code that closes connections when Tor notices
2104 that it is running low on sockets. Right now, it is on by default,
2105 since the existing out-of-sockets mechanism tends to kill OR connections
2106 more than it should. (Default: 1)
2108 [[SigningKeyLifetime]] **SigningKeyLifetime** __N__ **days**|**weeks**|**months**::
2109 For how long should each Ed25519 signing key be valid? Tor uses a
2110 permanent master identity key that can be kept offline, and periodically
2111 generates new "signing" keys that it uses online. This option
2112 configures their lifetime.
2115 [[OfflineMasterKey]] **OfflineMasterKey** **0**|**1**::
2116 If non-zero, the Tor relay will never generate or load its master secret
2117 key. Instead, you'll have to use "tor --keygen" to manage the permanent
2118 ed25519 master identity key, as well as the corresponding temporary
2119 signing keys and certificates. (Default: 0)
2121 DIRECTORY SERVER OPTIONS
2122 ------------------------
2124 The following options are useful only for directory servers. (Relays with
2125 enough bandwidth automatically become directory servers; see DirCache for
2128 [[DirPortFrontPage]] **DirPortFrontPage** __FILENAME__::
2129 When this option is set, it takes an HTML file and publishes it as "/" on
2130 the DirPort. Now relay operators can provide a disclaimer without needing
2131 to set up a separate webserver. There's a sample disclaimer in
2132 contrib/operator-tools/tor-exit-notice.html.
2134 [[DirPort]] **DirPort** \['address':]__PORT__|**auto** [_flags_]::
2135 If this option is nonzero, advertise the directory service on this port.
2136 Set it to "auto" to have Tor pick a port for you. This option can occur
2137 more than once, but only one advertised DirPort is supported: all
2138 but one DirPort must have the **NoAdvertise** flag set. (Default: 0) +
2140 The same flags are supported here as are supported by ORPort.
2142 [[DirListenAddress]] **DirListenAddress** __IP__[:__PORT__]::
2143 Bind the directory service to this address. If you specify a port, bind to
2144 this port rather than the one specified in DirPort. (Default: 0.0.0.0)
2145 This directive can be specified multiple times to bind to multiple
2148 This option is deprecated; you can get the same behavior with DirPort now
2149 that it supports NoAdvertise and explicit addresses.
2151 [[DirPolicy]] **DirPolicy** __policy__,__policy__,__...__::
2152 Set an entrance policy for this server, to limit who can connect to the
2153 directory ports. The policies have the same form as exit policies above,
2154 except that port specifiers are ignored. Any address not matched by
2155 some entry in the policy is accepted.
2157 [[DirCache]] **DirCache** **0**|**1**::
2158 When this option is set, Tor caches all current directory documents and
2159 accepts client requests for them. Setting DirPort is not required for this,
2160 because clients connect via the ORPort by default. Setting either DirPort
2161 or BridgeRelay and setting DirCache to 0 is not supported. (Default: 1)
2164 DIRECTORY AUTHORITY SERVER OPTIONS
2165 ----------------------------------
2167 The following options enable operation as a directory authority, and
2168 control how Tor behaves as a directory authority. You should not need
2169 to adjust any of them if you're running a regular relay or exit server
2170 on the public Tor network.
2172 [[AuthoritativeDirectory]] **AuthoritativeDirectory** **0**|**1**::
2173 When this option is set to 1, Tor operates as an authoritative directory
2174 server. Instead of caching the directory, it generates its own list of
2175 good servers, signs it, and sends that to the clients. Unless the clients
2176 already have you listed as a trusted directory, you probably do not want
2179 [[V3AuthoritativeDirectory]] **V3AuthoritativeDirectory** **0**|**1**::
2180 When this option is set in addition to **AuthoritativeDirectory**, Tor
2181 generates version 3 network statuses and serves descriptors, etc as
2182 described in dir-spec.txt file of https://spec.torproject.org/[torspec]
2183 (for Tor clients and servers running at least 0.2.0.x).
2185 [[VersioningAuthoritativeDirectory]] **VersioningAuthoritativeDirectory** **0**|**1**::
2186 When this option is set to 1, Tor adds information on which versions of
2187 Tor are still believed safe for use to the published directory. Each
2188 version 1 authority is automatically a versioning authority; version 2
2189 authorities provide this service optionally. See **RecommendedVersions**,
2190 **RecommendedClientVersions**, and **RecommendedServerVersions**.
2192 [[RecommendedVersions]] **RecommendedVersions** __STRING__::
2193 STRING is a comma-separated list of Tor versions currently believed to be
2194 safe. The list is included in each directory, and nodes which pull down the
2195 directory learn whether they need to upgrade. This option can appear
2196 multiple times: the values from multiple lines are spliced together. When
2197 this is set then **VersioningAuthoritativeDirectory** should be set too.
2199 [[RecommendedPackages]] **RecommendedPackages** __PACKAGENAME__ __VERSION__ __URL__ __DIGESTTYPE__**=**__DIGEST__ ::
2200 Adds "package" line to the directory authority's vote. This information
2201 is used to vote on the correct URL and digest for the released versions
2202 of different Tor-related packages, so that the consensus can certify
2203 them. This line may appear any number of times.
2205 [[RecommendedClientVersions]] **RecommendedClientVersions** __STRING__::
2206 STRING is a comma-separated list of Tor versions currently believed to be
2207 safe for clients to use. This information is included in version 2
2208 directories. If this is not set then the value of **RecommendedVersions**
2209 is used. When this is set then **VersioningAuthoritativeDirectory** should
2212 [[BridgeAuthoritativeDir]] **BridgeAuthoritativeDir** **0**|**1**::
2213 When this option is set in addition to **AuthoritativeDirectory**, Tor
2214 accepts and serves server descriptors, but it caches and serves the main
2215 networkstatus documents rather than generating its own. (Default: 0)
2217 [[MinUptimeHidServDirectoryV2]] **MinUptimeHidServDirectoryV2** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2218 Minimum uptime of a v2 hidden service directory to be accepted as such by
2219 authoritative directories. (Default: 25 hours)
2221 [[RecommendedServerVersions]] **RecommendedServerVersions** __STRING__::
2222 STRING is a comma-separated list of Tor versions currently believed to be
2223 safe for servers to use. This information is included in version 2
2224 directories. If this is not set then the value of **RecommendedVersions**
2225 is used. When this is set then **VersioningAuthoritativeDirectory** should
2228 [[ConsensusParams]] **ConsensusParams** __STRING__::
2229 STRING is a space-separated list of key=value pairs that Tor will include
2230 in the "params" line of its networkstatus vote.
2232 [[DirAllowPrivateAddresses]] **DirAllowPrivateAddresses** **0**|**1**::
2233 If set to 1, Tor will accept server descriptors with arbitrary "Address"
2234 elements. Otherwise, if the address is not an IP address or is a private IP
2235 address, it will reject the server descriptor. Additionally, Tor
2236 will allow exit policies for private networks to fulfill Exit flag
2237 requirements. (Default: 0)
2239 [[AuthDirBadExit]] **AuthDirBadExit** __AddressPattern...__::
2240 Authoritative directories only. A set of address patterns for servers that
2241 will be listed as bad exits in any network status document this authority
2242 publishes, if **AuthDirListBadExits** is set. +
2244 (The address pattern syntax here and in the options below
2245 is the same as for exit policies, except that you don't need to say
2246 "accept" or "reject", and ports are not needed.)
2248 [[AuthDirInvalid]] **AuthDirInvalid** __AddressPattern...__::
2249 Authoritative directories only. A set of address patterns for servers that
2250 will never be listed as "valid" in any network status document that this
2251 authority publishes.
2253 [[AuthDirReject]] **AuthDirReject** __AddressPattern__...::
2254 Authoritative directories only. A set of address patterns for servers that
2255 will never be listed at all in any network status document that this
2256 authority publishes, or accepted as an OR address in any descriptor
2257 submitted for publication by this authority.
2259 [[AuthDirBadExitCCs]] **AuthDirBadExitCCs** __CC__,... +
2261 [[AuthDirInvalidCCs]] **AuthDirInvalidCCs** __CC__,... +
2263 [[AuthDirRejectCCs]] **AuthDirRejectCCs** __CC__,...::
2264 Authoritative directories only. These options contain a comma-separated
2265 list of country codes such that any server in one of those country codes
2266 will be marked as a bad exit/invalid for use, or rejected
2269 [[AuthDirListBadExits]] **AuthDirListBadExits** **0**|**1**::
2270 Authoritative directories only. If set to 1, this directory has some
2271 opinion about which nodes are unsuitable as exit nodes. (Do not set this to
2272 1 unless you plan to list non-functioning exits as bad; otherwise, you are
2273 effectively voting in favor of every declared exit as an exit.)
2275 [[AuthDirMaxServersPerAddr]] **AuthDirMaxServersPerAddr** __NUM__::
2276 Authoritative directories only. The maximum number of servers that we will
2277 list as acceptable on a single IP address. Set this to "0" for "no limit".
2280 [[AuthDirFastGuarantee]] **AuthDirFastGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
2281 Authoritative directories only. If non-zero, always vote the
2282 Fast flag for any relay advertising this amount of capacity or
2283 more. (Default: 100 KBytes)
2285 [[AuthDirGuardBWGuarantee]] **AuthDirGuardBWGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
2286 Authoritative directories only. If non-zero, this advertised capacity
2287 or more is always sufficient to satisfy the bandwidth requirement
2288 for the Guard flag. (Default: 2 MBytes)
2290 [[AuthDirPinKeys]] **AuthDirPinKeys** **0**|**1**::
2291 Authoritative directories only. If non-zero, do not allow any relay to
2292 publish a descriptor if any other relay has reserved its <Ed25519,RSA>
2293 identity keypair. In all cases, Tor records every keypair it accepts
2294 in a journal if it is new, or if it differs from the most recently
2295 accepted pinning for one of the keys it contains. (Default: 1)
2297 [[AuthDirSharedRandomness]] **AuthDirSharedRandomness** **0**|**1**::
2298 Authoritative directories only. Switch for the shared random protocol.
2299 If zero, the authority won't participate in the protocol. If non-zero
2300 (default), the flag "shared-rand-participate" is added to the authority
2301 vote indicating participation in the protocol. (Default: 1)
2303 [[AuthDirTestEd25519LinkKeys]] **AuthDirTestEd25519LinkKeys** **0**|**1**::
2304 Authoritative directories only. If this option is set to 0, then we treat
2305 relays as "Running" if their RSA key is correct when we probe them,
2306 regardless of their Ed25519 key. We should only ever set this option to 0
2307 if there is some major bug in Ed25519 link authentication that causes us
2308 to label all the relays as not Running. (Default: 1)
2310 [[BridgePassword]] **BridgePassword** __Password__::
2311 If set, contains an HTTP authenticator that tells a bridge authority to
2312 serve all requested bridge information. Used by the (only partially
2313 implemented) "bridge community" design, where a community of bridge
2314 relay operators all use an alternate bridge directory authority,
2315 and their target user audience can periodically fetch the list of
2316 available community bridges to stay up-to-date. (Default: not set)
2318 [[V3AuthVotingInterval]] **V3AuthVotingInterval** __N__ **minutes**|**hours**::
2319 V3 authoritative directories only. Configures the server's preferred voting
2320 interval. Note that voting will __actually__ happen at an interval chosen
2321 by consensus from all the authorities' preferred intervals. This time
2322 SHOULD divide evenly into a day. (Default: 1 hour)
2324 [[V3AuthVoteDelay]] **V3AuthVoteDelay** __N__ **minutes**|**hours**::
2325 V3 authoritative directories only. Configures the server's preferred delay
2326 between publishing its vote and assuming it has all the votes from all the
2327 other authorities. Note that the actual time used is not the server's
2328 preferred time, but the consensus of all preferences. (Default: 5 minutes)
2330 [[V3AuthDistDelay]] **V3AuthDistDelay** __N__ **minutes**|**hours**::
2331 V3 authoritative directories only. Configures the server's preferred delay
2332 between publishing its consensus and signature and assuming it has all the
2333 signatures from all the other authorities. Note that the actual time used
2334 is not the server's preferred time, but the consensus of all preferences.
2335 (Default: 5 minutes)
2337 [[V3AuthNIntervalsValid]] **V3AuthNIntervalsValid** __NUM__::
2338 V3 authoritative directories only. Configures the number of VotingIntervals
2339 for which each consensus should be valid for. Choosing high numbers
2340 increases network partitioning risks; choosing low numbers increases
2341 directory traffic. Note that the actual number of intervals used is not the
2342 server's preferred number, but the consensus of all preferences. Must be at
2343 least 2. (Default: 3)
2345 [[V3BandwidthsFile]] **V3BandwidthsFile** __FILENAME__::
2346 V3 authoritative directories only. Configures the location of the
2347 bandwidth-authority generated file storing information on relays' measured
2348 bandwidth capacities. (Default: unset)
2350 [[V3AuthUseLegacyKey]] **V3AuthUseLegacyKey** **0**|**1**::
2351 If set, the directory authority will sign consensuses not only with its
2352 own signing key, but also with a "legacy" key and certificate with a
2353 different identity. This feature is used to migrate directory authority
2354 keys in the event of a compromise. (Default: 0)
2356 [[RephistTrackTime]] **RephistTrackTime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2357 Tells an authority, or other node tracking node reliability and history,
2358 that fine-grained information about nodes can be discarded when it hasn't
2359 changed for a given amount of time. (Default: 24 hours)
2361 [[AuthDirHasIPv6Connectivity]] **AuthDirHasIPv6Connectivity** **0**|**1**::
2362 Authoritative directories only. When set to 0, OR ports with an
2363 IPv6 address are being accepted without reachability testing.
2364 When set to 1, IPv6 OR ports are being tested just like IPv4 OR
2367 [[MinMeasuredBWsForAuthToIgnoreAdvertised]] **MinMeasuredBWsForAuthToIgnoreAdvertised** __N__::
2368 A total value, in abstract bandwidth units, describing how much
2369 measured total bandwidth an authority should have observed on the network
2370 before it will treat advertised bandwidths as wholly
2371 unreliable. (Default: 500)
2373 HIDDEN SERVICE OPTIONS
2374 ----------------------
2376 The following options are used to configure a hidden service.
2378 [[HiddenServiceDir]] **HiddenServiceDir** __DIRECTORY__::
2379 Store data files for a hidden service in DIRECTORY. Every hidden service
2380 must have a separate directory. You may use this option multiple times to
2381 specify multiple services. If DIRECTORY does not exist, Tor will create it.
2382 (Note: in current versions of Tor, if DIRECTORY is a relative path,
2383 it will be relative to the current
2384 working directory of Tor instance, not to its DataDirectory. Do not
2385 rely on this behavior; it is not guaranteed to remain the same in future
2388 [[HiddenServicePort]] **HiddenServicePort** __VIRTPORT__ [__TARGET__]::
2389 Configure a virtual port VIRTPORT for a hidden service. You may use this
2390 option multiple times; each time applies to the service using the most
2391 recent HiddenServiceDir. By default, this option maps the virtual port to
2392 the same port on 127.0.0.1 over TCP. You may override the target port,
2393 address, or both by specifying a target of addr, port, addr:port, or
2394 **unix:**__path__. (You can specify an IPv6 target as [addr]:port. Unix
2395 paths may be quoted, and may use standard C escapes.)
2396 You may also have multiple lines with the same VIRTPORT: when a user
2397 connects to that VIRTPORT, one of the TARGETs from those lines will be
2400 [[PublishHidServDescriptors]] **PublishHidServDescriptors** **0**|**1**::
2401 If set to 0, Tor will run any hidden services you configure, but it won't
2402 advertise them to the rendezvous directory. This option is only useful if
2403 you're using a Tor controller that handles hidserv publishing for you.
2406 [[HiddenServiceVersion]] **HiddenServiceVersion** __version__,__version__,__...__::
2407 A list of rendezvous service descriptor versions to publish for the hidden
2408 service. Currently, only version 2 is supported. (Default: 2)
2410 [[HiddenServiceAuthorizeClient]] **HiddenServiceAuthorizeClient** __auth-type__ __client-name__,__client-name__,__...__::
2411 If configured, the hidden service is accessible for authorized clients
2412 only. The auth-type can either be \'basic' for a general-purpose
2413 authorization protocol or \'stealth' for a less scalable protocol that also
2414 hides service activity from unauthorized clients. Only clients that are
2415 listed here are authorized to access the hidden service. Valid client names
2416 are 1 to 16 characters long and only use characters in A-Za-z0-9+-_ (no
2417 spaces). If this option is set, the hidden service is not accessible for
2418 clients without authorization any more. Generated authorization data can be
2419 found in the hostname file. Clients need to put this authorization data in
2420 their configuration file using **HidServAuth**.
2422 [[HiddenServiceAllowUnknownPorts]] **HiddenServiceAllowUnknownPorts** **0**|**1**::
2423 If set to 1, then connections to unrecognized ports do not cause the
2424 current hidden service to close rendezvous circuits. (Setting this to 0 is
2425 not an authorization mechanism; it is instead meant to be a mild
2426 inconvenience to port-scanners.) (Default: 0)
2428 [[HiddenServiceMaxStreams]] **HiddenServiceMaxStreams** __N__::
2429 The maximum number of simultaneous streams (connections) per rendezvous
2430 circuit. The maximum value allowed is 65535. (Setting this to 0 will allow
2431 an unlimited number of simultanous streams.) (Default: 0)
2433 [[HiddenServiceMaxStreamsCloseCircuit]] **HiddenServiceMaxStreamsCloseCircuit** **0**|**1**::
2434 If set to 1, then exceeding **HiddenServiceMaxStreams** will cause the
2435 offending rendezvous circuit to be torn down, as opposed to stream creation
2436 requests that exceed the limit being silently ignored. (Default: 0)
2438 [[RendPostPeriod]] **RendPostPeriod** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2439 Every time the specified period elapses, Tor uploads any rendezvous
2440 service descriptors to the directory servers. This information is also
2441 uploaded whenever it changes. Minimum value allowed is 10 minutes and
2442 maximum is 3.5 days. (Default: 1 hour)
2444 [[HiddenServiceDirGroupReadable]] **HiddenServiceDirGroupReadable** **0**|**1**::
2445 If this option is set to 1, allow the filesystem group to read the
2446 hidden service directory and hostname file. If the option is set to 0,
2447 only owner is able to read the hidden service directory. (Default: 0)
2448 Has no effect on Windows.
2450 [[HiddenServiceNumIntroductionPoints]] **HiddenServiceNumIntroductionPoints** __NUM__::
2451 Number of introduction points the hidden service will have. You can't
2452 have more than 10. (Default: 3)
2454 [[HiddenServiceSingleHopMode]] **HiddenServiceSingleHopMode** **0**|**1**::
2455 **Experimental - Non Anonymous** Hidden Services on a tor instance in
2456 HiddenServiceSingleHopMode make one-hop (direct) circuits between the onion
2457 service server, and the introduction and rendezvous points. (Onion service
2458 descriptors are still posted using 3-hop paths, to avoid onion service
2459 directories blocking the service.)
2460 This option makes every hidden service instance hosted by a tor instance a
2461 Single Onion Service. One-hop circuits make Single Onion servers easily
2462 locatable, but clients remain location-anonymous. However, the fact that a
2463 client is accessing a Single Onion rather than a Hidden Service may be
2464 statistically distinguishable. +
2466 **WARNING:** Once a hidden service directory has been used by a tor
2467 instance in HiddenServiceSingleHopMode, it can **NEVER** be used again for
2468 a hidden service. It is best practice to create a new hidden service
2469 directory, key, and address for each new Single Onion Service and Hidden
2470 Service. It is not possible to run Single Onion Services and Hidden
2471 Services from the same tor instance: they should be run on different
2472 servers with different IP addresses. +
2474 HiddenServiceSingleHopMode requires HiddenServiceNonAnonymousMode to be set
2475 to 1. Since a Single Onion service is non-anonymous, you can not configure
2476 a SOCKSPort on a tor instance that is running in
2477 **HiddenServiceSingleHopMode**. Can not be changed while tor is running.
2480 [[HiddenServiceNonAnonymousMode]] **HiddenServiceNonAnonymousMode** **0**|**1**::
2481 Makes hidden services non-anonymous on this tor instance. Allows the
2482 non-anonymous HiddenServiceSingleHopMode. Enables direct connections in the
2483 server-side hidden service protocol. If you are using this option,
2484 you need to disable all client-side services on your Tor instance,
2485 including setting SOCKSPort to "0". Can not be changed while tor is
2486 running. (Default: 0)
2488 TESTING NETWORK OPTIONS
2489 -----------------------
2491 The following options are used for running a testing Tor network.
2493 [[TestingTorNetwork]] **TestingTorNetwork** **0**|**1**::
2494 If set to 1, Tor adjusts default values of the configuration options below,
2495 so that it is easier to set up a testing Tor network. May only be set if
2496 non-default set of DirAuthorities is set. Cannot be unset while Tor is
2500 ServerDNSAllowBrokenConfig 1
2501 DirAllowPrivateAddresses 1
2502 EnforceDistinctSubnets 0
2504 AuthDirMaxServersPerAddr 0
2505 AuthDirMaxServersPerAuthAddr 0
2506 ClientBootstrapConsensusAuthorityDownloadSchedule 0, 2,
2507 4 (for 40 seconds), 8, 16, 32, 60
2508 ClientBootstrapConsensusFallbackDownloadSchedule 0, 1,
2509 4 (for 40 seconds), 8, 16, 32, 60
2510 ClientBootstrapConsensusAuthorityOnlyDownloadSchedule 0, 1,
2511 4 (for 40 seconds), 8, 16, 32, 60
2512 ClientBootstrapConsensusMaxDownloadTries 80
2513 ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries 80
2514 ClientDNSRejectInternalAddresses 0
2515 ClientRejectInternalAddresses 0
2516 CountPrivateBandwidth 1
2517 ExitPolicyRejectPrivate 0
2518 ExtendAllowPrivateAddresses 1
2519 V3AuthVotingInterval 5 minutes
2520 V3AuthVoteDelay 20 seconds
2521 V3AuthDistDelay 20 seconds
2522 MinUptimeHidServDirectoryV2 0 seconds
2523 TestingV3AuthInitialVotingInterval 5 minutes
2524 TestingV3AuthInitialVoteDelay 20 seconds
2525 TestingV3AuthInitialDistDelay 20 seconds
2526 TestingAuthDirTimeToLearnReachability 0 minutes
2527 TestingEstimatedDescriptorPropagationTime 0 minutes
2528 TestingServerDownloadSchedule 0, 0, 0, 5, 10, 15, 20, 30, 60
2529 TestingClientDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2530 TestingServerConsensusDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2531 TestingClientConsensusDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2532 TestingBridgeDownloadSchedule 60, 30, 30, 60
2533 TestingClientMaxIntervalWithoutRequest 5 seconds
2534 TestingDirConnectionMaxStall 30 seconds
2535 TestingConsensusMaxDownloadTries 80
2536 TestingDescriptorMaxDownloadTries 80
2537 TestingMicrodescMaxDownloadTries 80
2538 TestingCertMaxDownloadTries 80
2539 TestingEnableConnBwEvent 1
2540 TestingEnableCellStatsEvent 1
2541 TestingEnableTbEmptyEvent 1
2543 [[TestingV3AuthInitialVotingInterval]] **TestingV3AuthInitialVotingInterval** __N__ **minutes**|**hours**::
2544 Like V3AuthVotingInterval, but for initial voting interval before the first
2545 consensus has been created. Changing this requires that
2546 **TestingTorNetwork** is set. (Default: 30 minutes)
2548 [[TestingV3AuthInitialVoteDelay]] **TestingV3AuthInitialVoteDelay** __N__ **minutes**|**hours**::
2549 Like V3AuthVoteDelay, but for initial voting interval before
2550 the first consensus has been created. Changing this requires that
2551 **TestingTorNetwork** is set. (Default: 5 minutes)
2553 [[TestingV3AuthInitialDistDelay]] **TestingV3AuthInitialDistDelay** __N__ **minutes**|**hours**::
2554 Like V3AuthDistDelay, but for initial voting interval before
2555 the first consensus has been created. Changing this requires that
2556 **TestingTorNetwork** is set. (Default: 5 minutes)
2558 [[TestingV3AuthVotingStartOffset]] **TestingV3AuthVotingStartOffset** __N__ **seconds**|**minutes**|**hours**::
2559 Directory authorities offset voting start time by this much.
2560 Changing this requires that **TestingTorNetwork** is set. (Default: 0)
2562 [[TestingAuthDirTimeToLearnReachability]] **TestingAuthDirTimeToLearnReachability** __N__ **minutes**|**hours**::
2563 After starting as an authority, do not make claims about whether routers
2564 are Running until this much time has passed. Changing this requires
2565 that **TestingTorNetwork** is set. (Default: 30 minutes)
2567 [[TestingEstimatedDescriptorPropagationTime]] **TestingEstimatedDescriptorPropagationTime** __N__ **minutes**|**hours**::
2568 Clients try downloading server descriptors from directory caches after this
2569 time. Changing this requires that **TestingTorNetwork** is set. (Default:
2572 [[TestingMinFastFlagThreshold]] **TestingMinFastFlagThreshold** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
2573 Minimum value for the Fast flag. Overrides the ordinary minimum taken
2574 from the consensus when TestingTorNetwork is set. (Default: 0.)
2576 [[TestingServerDownloadSchedule]] **TestingServerDownloadSchedule** __N__,__N__,__...__::
2577 Schedule for when servers should download things in general. Changing this
2578 requires that **TestingTorNetwork** is set. (Default: 0, 0, 0, 60, 60, 120,
2579 300, 900, 2147483647)
2581 [[TestingClientDownloadSchedule]] **TestingClientDownloadSchedule** __N__,__N__,__...__::
2582 Schedule for when clients should download things in general. Changing this
2583 requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2586 [[TestingServerConsensusDownloadSchedule]] **TestingServerConsensusDownloadSchedule** __N__,__N__,__...__::
2587 Schedule for when servers should download consensuses. Changing this
2588 requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2589 1800, 1800, 1800, 1800, 1800, 3600, 7200)
2591 [[TestingClientConsensusDownloadSchedule]] **TestingClientConsensusDownloadSchedule** __N__,__N__,__...__::
2592 Schedule for when clients should download consensuses. Changing this
2593 requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2594 1800, 3600, 3600, 3600, 10800, 21600, 43200)
2596 [[TestingBridgeDownloadSchedule]] **TestingBridgeDownloadSchedule** __N__,__N__,__...__::
2597 Schedule for when clients should download bridge descriptors. Changing this
2598 requires that **TestingTorNetwork** is set. (Default: 3600, 900, 900, 3600)
2600 [[TestingClientMaxIntervalWithoutRequest]] **TestingClientMaxIntervalWithoutRequest** __N__ **seconds**|**minutes**::
2601 When directory clients have only a few descriptors to request, they batch
2602 them until they have more, or until this amount of time has passed.
2603 Changing this requires that **TestingTorNetwork** is set. (Default: 10
2606 [[TestingDirConnectionMaxStall]] **TestingDirConnectionMaxStall** __N__ **seconds**|**minutes**::
2607 Let a directory connection stall this long before expiring it.
2608 Changing this requires that **TestingTorNetwork** is set. (Default:
2611 [[TestingConsensusMaxDownloadTries]] **TestingConsensusMaxDownloadTries** __NUM__::
2612 Try this many times to download a consensus before giving up. Changing
2613 this requires that **TestingTorNetwork** is set. (Default: 8)
2615 [[TestingDescriptorMaxDownloadTries]] **TestingDescriptorMaxDownloadTries** __NUM__::
2616 Try this often to download a server descriptor before giving up.
2617 Changing this requires that **TestingTorNetwork** is set. (Default: 8)
2619 [[TestingMicrodescMaxDownloadTries]] **TestingMicrodescMaxDownloadTries** __NUM__::
2620 Try this often to download a microdesc descriptor before giving up.
2621 Changing this requires that **TestingTorNetwork** is set. (Default: 8)
2623 [[TestingCertMaxDownloadTries]] **TestingCertMaxDownloadTries** __NUM__::
2624 Try this often to download a v3 authority certificate before giving up.
2625 Changing this requires that **TestingTorNetwork** is set. (Default: 8)
2627 [[TestingDirAuthVoteExit]] **TestingDirAuthVoteExit** __node__,__node__,__...__::
2628 A list of identity fingerprints, country codes, and
2629 address patterns of nodes to vote Exit for regardless of their
2630 uptime, bandwidth, or exit policy. See the **ExcludeNodes**
2631 option for more information on how to specify nodes. +
2633 In order for this option to have any effect, **TestingTorNetwork**
2634 has to be set. See the **ExcludeNodes** option for more
2635 information on how to specify nodes.
2637 [[TestingDirAuthVoteExitIsStrict]] **TestingDirAuthVoteExitIsStrict** **0**|**1** ::
2638 If True (1), a node will never receive the Exit flag unless it is specified
2639 in the **TestingDirAuthVoteExit** list, regardless of its uptime, bandwidth,
2642 In order for this option to have any effect, **TestingTorNetwork**
2645 [[TestingDirAuthVoteGuard]] **TestingDirAuthVoteGuard** __node__,__node__,__...__::
2646 A list of identity fingerprints and country codes and
2647 address patterns of nodes to vote Guard for regardless of their
2648 uptime and bandwidth. See the **ExcludeNodes** option for more
2649 information on how to specify nodes. +
2651 In order for this option to have any effect, **TestingTorNetwork**
2654 [[TestingDirAuthVoteGuardIsStrict]] **TestingDirAuthVoteGuardIsStrict** **0**|**1** ::
2655 If True (1), a node will never receive the Guard flag unless it is specified
2656 in the **TestingDirAuthVoteGuard** list, regardless of its uptime and bandwidth. +
2658 In order for this option to have any effect, **TestingTorNetwork**
2661 [[TestingDirAuthVoteHSDir]] **TestingDirAuthVoteHSDir** __node__,__node__,__...__::
2662 A list of identity fingerprints and country codes and
2663 address patterns of nodes to vote HSDir for regardless of their
2664 uptime and DirPort. See the **ExcludeNodes** option for more
2665 information on how to specify nodes. +
2667 In order for this option to have any effect, **TestingTorNetwork**
2670 [[TestingDirAuthVoteHSDirIsStrict]] **TestingDirAuthVoteHSDirIsStrict** **0**|**1** ::
2671 If True (1), a node will never receive the HSDir flag unless it is specified
2672 in the **TestingDirAuthVoteHSDir** list, regardless of its uptime and DirPort. +
2674 In order for this option to have any effect, **TestingTorNetwork**
2677 [[TestingEnableConnBwEvent]] **TestingEnableConnBwEvent** **0**|**1**::
2678 If this option is set, then Tor controllers may register for CONN_BW
2679 events. Changing this requires that **TestingTorNetwork** is set.
2682 [[TestingEnableCellStatsEvent]] **TestingEnableCellStatsEvent** **0**|**1**::
2683 If this option is set, then Tor controllers may register for CELL_STATS
2684 events. Changing this requires that **TestingTorNetwork** is set.
2687 [[TestingEnableTbEmptyEvent]] **TestingEnableTbEmptyEvent** **0**|**1**::
2688 If this option is set, then Tor controllers may register for TB_EMPTY
2689 events. Changing this requires that **TestingTorNetwork** is set.
2692 [[TestingMinExitFlagThreshold]] **TestingMinExitFlagThreshold** __N__ **KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
2693 Sets a lower-bound for assigning an exit flag when running as an
2694 authority on a testing network. Overrides the usual default lower bound
2695 of 4 KB. (Default: 0)
2697 [[TestingLinkCertLifetime]] **TestingLinkCertLifetime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**|**months**::
2698 Overrides the default lifetime for the certificates used to authenticate
2699 our X509 link cert with our ed25519 signing key.
2702 [[TestingAuthKeyLifetime]] **TestingAuthKeyLifetime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**|**months**::
2703 Overrides the default lifetime for a signing Ed25519 TLS Link authentication
2707 [[TestingLinkKeySlop]] **TestingLinkKeySlop** __N__ **seconds**|**minutes**|**hours** +
2709 [[TestingAuthKeySlop]] **TestingAuthKeySlop** __N__ **seconds**|**minutes**|**hours** +
2711 [[TestingSigningKeySlop]] **TestingSigningKeySlop** __N__ **seconds**|**minutes**|**hours**::
2712 How early before the official expiration of a an Ed25519 signing key do
2713 we replace it and issue a new key?
2714 (Default: 3 hours for link and auth; 1 day for signing.)
2716 NON-PERSISTENT OPTIONS
2717 ----------------------
2719 These options are not saved to the torrc file by the "SAVECONF" controller
2720 command. Other options of this type are documented in control-spec.txt,
2721 section 5.4. End-users should mostly ignore them.
2723 [[UnderscorePorts]] **\_\_ControlPort**, **\_\_DirPort**, **\_\_DNSPort**, **\_\_ExtORPort**, **\_\_NATDPort**, **\_\_ORPort**, **\_\_SocksPort**, **\_\_TransPort**::
2724 These underscore-prefixed options are variants of the regular Port
2725 options. They behave the same, except they are not saved to the
2726 torrc file by the controller's SAVECONF command.
2732 Tor catches the following signals:
2734 [[SIGTERM]] **SIGTERM**::
2735 Tor will catch this, clean up and sync to disk if necessary, and exit.
2737 [[SIGINT]] **SIGINT**::
2738 Tor clients behave as with SIGTERM; but Tor servers will do a controlled
2739 slow shutdown, closing listeners and waiting 30 seconds before exiting.
2740 (The delay can be configured with the ShutdownWaitLength config option.)
2742 [[SIGHUP]] **SIGHUP**::
2743 The signal instructs Tor to reload its configuration (including closing and
2744 reopening logs), and kill and restart its helper processes if applicable.
2746 [[SIGUSR1]] **SIGUSR1**::
2747 Log statistics about current connections, past connections, and throughput.
2749 [[SIGUSR2]] **SIGUSR2**::
2750 Switch all logs to loglevel debug. You can go back to the old loglevels by
2753 [[SIGCHLD]] **SIGCHLD**::
2754 Tor receives this signal when one of its helper processes has exited, so it
2757 [[SIGPIPE]] **SIGPIPE**::
2758 Tor catches this signal and ignores it.
2760 [[SIGXFSZ]] **SIGXFSZ**::
2761 If this signal exists on your platform, Tor catches and ignores it.
2766 **@CONFDIR@/torrc**::
2767 The configuration file, which contains "option value" pairs.
2770 Fallback location for torrc, if @CONFDIR@/torrc is not found.
2772 **@LOCALSTATEDIR@/lib/tor/**::
2773 The tor process stores keys and other data here.
2775 __DataDirectory__**/cached-status/**::
2776 The most recently downloaded network status document for each authority.
2777 Each file holds one such document; the filenames are the hexadecimal
2778 identity key fingerprints of the directory authorities. Mostly obsolete.
2780 __DataDirectory__**/cached-certs**::
2781 This file holds downloaded directory key certificates that are used to
2782 verify authenticity of documents generated by Tor directory authorities.
2784 __DataDirectory__**/cached-consensus** and/or **cached-microdesc-consensus**::
2785 The most recent consensus network status document we've downloaded.
2787 __DataDirectory__**/cached-descriptors** and **cached-descriptors.new**::
2788 These files hold downloaded router statuses. Some routers may appear more
2789 than once; if so, the most recently published descriptor is used. Lines
2790 beginning with @-signs are annotations that contain more information about
2791 a given router. The ".new" file is an append-only journal; when it gets
2792 too large, all entries are merged into a new cached-descriptors file.
2794 __DataDirectory__**/cached-microdescs** and **cached-microdescs.new**::
2795 These files hold downloaded microdescriptors. Lines beginning with
2796 @-signs are annotations that contain more information about a given
2797 router. The ".new" file is an append-only journal; when it gets too
2798 large, all entries are merged into a new cached-microdescs file.
2800 __DataDirectory__**/cached-routers** and **cached-routers.new**::
2801 Obsolete versions of cached-descriptors and cached-descriptors.new. When
2802 Tor can't find the newer files, it looks here instead.
2804 __DataDirectory__**/state**::
2805 A set of persistent key-value mappings. These are documented in
2806 the file. These include:
2807 - The current entry guards and their status.
2808 - The current bandwidth accounting values (unused so far; see
2810 - When the file was last written
2811 - What version of Tor generated the state file
2812 - A short history of bandwidth usage, as produced in the server
2815 __DataDirectory__**/bw_accounting**::
2816 Used to track bandwidth accounting values (when the current period starts
2817 and ends; how much has been read and written so far this period). This file
2818 is obsolete, and the data is now stored in the \'state' file as well. Only
2819 used when bandwidth accounting is enabled.
2821 __DataDirectory__**/control_auth_cookie**::
2822 Used for cookie authentication with the controller. Location can be
2823 overridden by the CookieAuthFile config option. Regenerated on startup. See
2824 control-spec.txt in https://spec.torproject.org/[torspec] for details.
2825 Only used when cookie authentication is enabled.
2827 __DataDirectory__**/lock**::
2828 This file is used to prevent two Tor instances from using same data
2829 directory. If access to this file is locked, data directory is already
2832 __DataDirectory__**/keys/***::
2833 Only used by servers. Holds identity keys and onion keys.
2835 __DataDirectory__**/keys/authority_identity_key**::
2836 A v3 directory authority's master identity key, used to authenticate its
2837 signing key. Tor doesn't use this while it's running. The tor-gencert
2838 program uses this. If you're running an authority, you should keep this
2839 key offline, and not actually put it here.
2841 __DataDirectory__**/keys/authority_certificate**::
2842 A v3 directory authority's certificate, which authenticates the authority's
2843 current vote- and consensus-signing key using its master identity key.
2844 Only directory authorities use this file.
2846 __DataDirectory__**/keys/authority_signing_key**::
2847 A v3 directory authority's signing key, used to sign votes and consensuses.
2848 Only directory authorities use this file. Corresponds to the
2849 **authority_certificate** cert.
2851 __DataDirectory__**/keys/legacy_certificate**::
2852 As authority_certificate: used only when V3AuthUseLegacyKey is set.
2853 See documentation for V3AuthUseLegacyKey.
2855 __DataDirectory__**/keys/legacy_signing_key**::
2856 As authority_signing_key: used only when V3AuthUseLegacyKey is set.
2857 See documentation for V3AuthUseLegacyKey.
2859 __DataDirectory__**/keys/secret_id_key**::
2860 A relay's RSA1024 permanent identity key, including private and public
2861 components. Used to sign router descriptors, and to sign other keys.
2863 __DataDirectory__**/keys/ed25519_master_id_public_key**::
2864 The public part of a relay's Ed25519 permanent identity key.
2866 __DataDirectory__**/keys/ed25519_master_id_secret_key**::
2867 The private part of a relay's Ed25519 permanent identity key. This key
2868 is used to sign the medium-term ed25519 signing key. This file can be
2869 kept offline, or kept encrypted. If so, Tor will not be able to generate
2870 new signing keys itself; you'll need to use tor --keygen yourself to do
2873 __DataDirectory__**/keys/ed25519_signing_secret_key**::
2874 The private and public components of a relay's medium-term Ed25519 signing
2875 key. This key is authenticated by the Ed25519 master key, in turn
2876 authenticates other keys (and router descriptors).
2878 __DataDirectory__**/keys/ed25519_signing_cert**::
2879 The certificate which authenticates "ed25519_signing_secret_key" as
2880 having been signed by the Ed25519 master key.
2882 __DataDirectory__**/keys/secret_onion_key**::
2883 A relay's RSA1024 short-term onion key. Used to decrypt old-style ("TAP")
2884 circuit extension requests.
2886 __DataDirectory__**/keys/secret_onion_key_ntor**::
2887 A relay's Curve25519 short-term onion key. Used to handle modern ("ntor")
2888 circuit extension requests.
2890 __DataDirectory__**/fingerprint**::
2891 Only used by servers. Holds the fingerprint of the server's identity key.
2893 __DataDirectory__**/hashed-fingerprint**::
2894 Only used by bridges. Holds the hashed fingerprint of the bridge's
2895 identity key. (That is, the hash of the hash of the identity key.)
2897 __DataDirectory__**/v3-status-votes**::
2898 Only for v3 authoritative directory servers. This file contains
2899 status votes from all the authoritative directory servers.
2901 __DataDirectory__**/unverified-consensus**::
2902 This file contains a network consensus document that has been downloaded,
2903 but which we didn't have the right certificates to check yet.
2905 __DataDirectory__**/unverified-microdesc-consensus**::
2906 This file contains a microdescriptor-flavored network consensus document
2907 that has been downloaded, but which we didn't have the right certificates
2910 __DataDirectory__**/unparseable-desc**::
2911 Onion server descriptors that Tor was unable to parse are dumped to this
2912 file. Only used for debugging.
2914 __DataDirectory__**/router-stability**::
2915 Only used by authoritative directory servers. Tracks measurements for
2916 router mean-time-between-failures so that authorities have a good idea of
2917 how to set their Stable flags.
2919 __DataDirectory__**/stats/dirreq-stats**::
2920 Only used by directory caches and authorities. This file is used to
2921 collect directory request statistics.
2923 __DataDirectory__**/stats/entry-stats**::
2924 Only used by servers. This file is used to collect incoming connection
2925 statistics by Tor entry nodes.
2927 __DataDirectory__**/stats/bridge-stats**::
2928 Only used by servers. This file is used to collect incoming connection
2929 statistics by Tor bridges.
2931 __DataDirectory__**/stats/exit-stats**::
2932 Only used by servers. This file is used to collect outgoing connection
2933 statistics by Tor exit routers.
2935 __DataDirectory__**/stats/buffer-stats**::
2936 Only used by servers. This file is used to collect buffer usage
2939 __DataDirectory__**/stats/conn-stats**::
2940 Only used by servers. This file is used to collect approximate connection
2941 history (number of active connections over time).
2943 __DataDirectory__**/networkstatus-bridges**::
2944 Only used by authoritative bridge directories. Contains information
2945 about bridges that have self-reported themselves to the bridge
2948 __HiddenServiceDirectory__**/hostname**::
2949 The <base32-encoded-fingerprint>.onion domain name for this hidden service.
2950 If the hidden service is restricted to authorized clients only, this file
2951 also contains authorization data for all clients.
2953 __HiddenServiceDirectory__**/private_key**::
2954 The private key for this hidden service.
2956 __HiddenServiceDirectory__**/client_keys**::
2957 Authorization data for a hidden service that is only accessible by
2960 __HiddenServiceDirectory__**/onion_service_non_anonymous**::
2961 This file is present if a hidden service key was created in
2962 **HiddenServiceNonAnonymousMode**.
2966 **torsocks**(1), **torify**(1) +
2968 **https://www.torproject.org/**
2970 **torspec: https://spec.torproject.org **
2975 Plenty, probably. Tor is still in development. Please report them at https://trac.torproject.org/.
2979 Roger Dingledine [arma at mit.edu], Nick Mathewson [nickm at alum.mit.edu].