Refactor UseEntryNodes so the original configured value is preserved
[tor.git] / doc / tor.1.txt
blobf353637d670802c0f003b4b4b9a69169d993b435
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
5 :man source:   Tor
6 :man manual:   Tor Manual
7 TOR(1)
8 ======
10 NAME
11 ----
12 tor - The second-generation onion router
15 SYNOPSIS
16 --------
17 **tor** [__OPTION__ __value__]...
19 DESCRIPTION
20 -----------
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
36 Project's website.
38 COMMAND-LINE OPTIONS
39 --------------------
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
47     found)
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
119    DataDirectory.) +
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
139 debug.log'.
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
158 the defaults file.
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.
176 GENERAL OPTIONS
177 ---------------
179 [[BandwidthRate]] **BandwidthRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
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**|**KBits**|**MBits**|**GBits**::
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**|**KBits**|**MBits**|**GBits**::
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**|**KBits**|**MBits**|**GBits**::
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**|**KBits**|**MBits**|**GBits**::
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.
219     (Default: 0)
221 [[PerConnBWRate]] **PerConnBWRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
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**|**KBits**|**MBits**|**GBits**::
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)
286     any outbound
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
304     the problem. +
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 eithermethod is sufficient to authenticate to Tor.) This
325     option is required for many Tor controllers; most use the value of 9051.
326     Set it to "auto" to have Tor pick a port for you. (Default: 0) +
328     Recognized flags are...
329     **GroupWritable**;;
330         Unix domain sockets only: makes the socket get created as
331         group-writable.
332     **WorldWritable**;;
333         Unix domain sockets only: makes the socket get created as
334         world-writable.
335     **RelaxDirModeCheck**;;
336         Unix domain sockets only: Do not insist that the directory
337         that holds the socket be read-restricted.
339 [[ControlListenAddress]] **ControlListenAddress** __IP__[:__PORT__]::
340     Bind the controller listener to this address. If you specify a port, bind
341     to this port rather than the one specified in ControlPort. We strongly
342     recommend that you leave this alone unless you know what you're doing,
343     since giving attackers access to your control listener is really
344     dangerous. This directive can be specified multiple
345     times to bind to multiple addresses/ports.  (Default: 127.0.0.1)
347 [[ControlSocket]] **ControlSocket** __Path__::
348     Like ControlPort, but listens on a Unix domain socket, rather than a TCP
349     socket. '0' disables ControlSocket (Unix and Unix-like systems only.)
351 [[ControlSocketsGroupWritable]] **ControlSocketsGroupWritable** **0**|**1**::
352     If this option is set to 0, don't allow the filesystem group to read and
353     write unix sockets (e.g. ControlSocket). If the option is set to 1, make
354     the control socket readable and writable by the default GID. (Default: 0)
356 [[HashedControlPassword]] **HashedControlPassword** __hashed_password__::
357     Allow connections on the control port if they present
358     the password whose one-way hash is __hashed_password__. You
359     can compute the hash of a password by running "tor --hash-password
360     __password__". You can provide several acceptable passwords by using more
361     than one HashedControlPassword line.
363 [[CookieAuthentication]] **CookieAuthentication** **0**|**1**::
364     If this option is set to 1, allow connections on the control port
365     when the connecting process knows the contents of a file named
366     "control_auth_cookie", which Tor will create in its data directory. This
367     authentication method should only be used on systems with good filesystem
368     security. (Default: 0)
370 [[CookieAuthFile]] **CookieAuthFile** __Path__::
371     If set, this option overrides the default location and file name
372     for Tor's cookie file. (See CookieAuthentication above.)
374 [[CookieAuthFileGroupReadable]] **CookieAuthFileGroupReadable** **0**|**1**::
375     If this option is set to 0, don't allow the filesystem group to read the
376     cookie file. If the option is set to 1, make the cookie file readable by
377     the default GID. [Making the file readable by other groups is not yet
378     implemented; let us know if you need this for some reason.] (Default: 0)
380 [[ControlPortWriteToFile]] **ControlPortWriteToFile** __Path__::
381     If set, Tor writes the address and port of any control port it opens to
382     this address.  Usable by controllers to learn the actual control port
383     when ControlPort is set to "auto".
385 [[ControlPortFileGroupReadable]] **ControlPortFileGroupReadable** **0**|**1**::
386     If this option is set to 0, don't allow the filesystem group to read the
387     control port file. If the option is set to 1, make the control port
388     file readable by the default GID. (Default: 0)
390 [[DataDirectory]] **DataDirectory** __DIR__::
391     Store working data in DIR (Default: @LOCALSTATEDIR@/lib/tor)
393 [[DataDirectoryGroupReadable]] **DataDirectoryGroupReadable** **0**|**1**::
394     If this option is set to 0, don't allow the filesystem group to read the
395     DataDirectory. If the option is set to 1, make the DataDirectory readable
396     by the default GID. (Default: 0)
398 [[FallbackDir]] **FallbackDir** __address__:__port__ orport=__port__ id=__fingerprint__ [weight=__num__] [ipv6=__address__:__orport__]::
399     When we're unable to connect to any directory cache for directory info
400     (usually because we don't know about any yet) we try a directory authority.
401     Clients also simultaneously try a FallbackDir, to avoid hangs on client
402     startup if a directory authority is down. Clients retry FallbackDirs more
403     often than directory authorities, to reduce the load on the directory
404     authorities.
405     By default, the directory authorities are also FallbackDirs. Specifying a
406     FallbackDir replaces Tor's default hard-coded FallbackDirs (if any).
407     (See the **DirAuthority** entry for an explanation of each flag.)
409 [[UseDefaultFallbackDirs]] **UseDefaultFallbackDirs** **0**|**1**::
410     Use Tor's default hard-coded FallbackDirs (if any). (When a
411     FallbackDir line is present, it replaces the hard-coded FallbackDirs,
412     regardless of the value of UseDefaultFallbackDirs.) (Default: 1)
414 [[DirAuthority]] **DirAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__::
415     Use a nonstandard authoritative directory server at the provided address
416     and port, with the specified key fingerprint. This option can be repeated
417     many times, for multiple authoritative directory servers. Flags are
418     separated by spaces, and determine what kind of an authority this directory
419     is. By default, an authority is not authoritative for any directory style
420     or version unless an appropriate flag is given.
421     Tor will use this authority as a bridge authoritative directory if the
422     "bridge" flag is set. If a flag "orport=**port**" is given, Tor will use the
423     given port when opening encrypted tunnels to the dirserver. If a flag
424     "weight=**num**" is given, then the directory server is chosen randomly
425     with probability proportional to that weight (default 1.0). If a
426     flag "v3ident=**fp**" is given, the dirserver is a v3 directory authority
427     whose v3 long-term signing key has the fingerprint **fp**. Lastly,
428     if an "ipv6=__address__:__orport__" flag is present, then the directory
429     authority is listening for IPv6 connections on the indicated IPv6 address
430     and OR Port. +
432     Tor will contact the authority at __address__:__port__ (the DirPort) to
433     download directory documents. If an IPv6 address is supplied, Tor will
434     also download directory documents at the IPv6 address on the DirPort. +
436     If no **DirAuthority** line is given, Tor will use the default directory
437     authorities. NOTE: this option is intended for setting up a private Tor
438     network with its own directory authorities. If you use it, you will be
439     distinguishable from other users, because you won't believe the same
440     authorities they do.
442 [[DirAuthorityFallbackRate]] **DirAuthorityFallbackRate** __NUM__::
443     When configured to use both directory authorities and fallback
444     directories, the directory authorities also work as fallbacks. They are
445     chosen with their regular weights, multiplied by this number, which
446     should be 1.0 or less. (Default: 1.0)
448 [[AlternateDirAuthority]] **AlternateDirAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__ +
450 [[AlternateBridgeAuthority]] **AlternateBridgeAuthority** [__nickname__] [**flags**] __address__:__port__ __ fingerprint__::
451     These options behave as DirAuthority, but they replace fewer of the
452     default directory authorities. Using
453     AlternateDirAuthority replaces the default Tor directory authorities, but
454     leaves the default bridge authorities in
455     place.  Similarly,
456     AlternateBridgeAuthority replaces the default bridge authority,
457     but leaves the directory authorities alone.
459 [[DisableAllSwap]] **DisableAllSwap** **0**|**1**::
460     If set to 1, Tor will attempt to lock all current and future memory pages,
461     so that memory cannot be paged out. Windows, OS X and Solaris are currently
462     not supported. We believe that this feature works on modern Gnu/Linux
463     distributions, and that it should work on *BSD systems (untested). This
464     option requires that you start your Tor as root, and you should use the
465     **User** option to properly reduce Tor's privileges. (Default: 0)
467 [[DisableDebuggerAttachment]] **DisableDebuggerAttachment** **0**|**1**::
468    If set to 1, Tor will attempt to prevent basic debugging attachment attempts
469    by other processes. This may also keep Tor from generating core files if
470    it crashes. It has no impact for users who wish to attach if they
471    have CAP_SYS_PTRACE or if they are root.  We believe that this feature
472    works on modern Gnu/Linux distributions, and that it may also work on *BSD
473    systems (untested).  Some modern Gnu/Linux systems such as Ubuntu have the
474    kernel.yama.ptrace_scope sysctl and by default enable it as an attempt to
475    limit the PTRACE scope for all user processes by default. This feature will
476    attempt to limit the PTRACE scope for Tor specifically - it will not attempt
477    to alter the system wide ptrace scope as it may not even exist. If you wish
478    to attach to Tor with a debugger such as gdb or strace you will want to set
479    this to 0 for the duration of your debugging. Normal users should leave it
480    on. Disabling this option while Tor is running is prohibited. (Default: 1)
482 [[FetchDirInfoEarly]] **FetchDirInfoEarly** **0**|**1**::
483     If set to 1, Tor will always fetch directory information like other
484     directory caches, even if you don't meet the normal criteria for fetching
485     early. Normal users should leave it off. (Default: 0)
487 [[FetchDirInfoExtraEarly]] **FetchDirInfoExtraEarly** **0**|**1**::
488     If set to 1, Tor will fetch directory information before other directory
489     caches. It will attempt to download directory information closer to the
490     start of the consensus period. Normal users should leave it off.
491     (Default: 0)
493 [[FetchHidServDescriptors]] **FetchHidServDescriptors** **0**|**1**::
494     If set to 0, Tor will never fetch any hidden service descriptors from the
495     rendezvous directories. This option is only useful if you're using a Tor
496     controller that handles hidden service fetches for you. (Default: 1)
498 [[FetchServerDescriptors]] **FetchServerDescriptors** **0**|**1**::
499     If set to 0, Tor will never fetch any network status summaries or server
500     descriptors from the directory servers. This option is only useful if
501     you're using a Tor controller that handles directory fetches for you.
502     (Default: 1)
504 [[FetchUselessDescriptors]] **FetchUselessDescriptors** **0**|**1**::
505     If set to 1, Tor will fetch every non-obsolete descriptor from the
506     authorities that it hears about. Otherwise, it will avoid fetching useless
507     descriptors, for example for routers that are not running. This option is
508     useful if you're using the contributed "exitlist" script to enumerate Tor
509     nodes that exit to certain addresses. (Default: 0)
511 [[HTTPProxy]] **HTTPProxy** __host__[:__port__]::
512     Tor will make all its directory requests through this host:port (or host:80
513     if port is not specified), rather than connecting directly to any directory
514     servers.
516 [[HTTPProxyAuthenticator]] **HTTPProxyAuthenticator** __username:password__::
517     If defined, Tor will use this username:password for Basic HTTP proxy
518     authentication, as in RFC 2617. This is currently the only form of HTTP
519     proxy authentication that Tor supports; feel free to submit a patch if you
520     want it to support others.
522 [[HTTPSProxy]] **HTTPSProxy** __host__[:__port__]::
523     Tor will make all its OR (SSL) connections through this host:port (or
524     host:443 if port is not specified), via HTTP CONNECT rather than connecting
525     directly to servers. You may want to set **FascistFirewall** to restrict
526     the set of ports you might try to connect to, if your HTTPS proxy only
527     allows connecting to certain ports.
529 [[HTTPSProxyAuthenticator]] **HTTPSProxyAuthenticator** __username:password__::
530     If defined, Tor will use this username:password for Basic HTTPS proxy
531     authentication, as in RFC 2617. This is currently the only form of HTTPS
532     proxy authentication that Tor supports; feel free to submit a patch if you
533     want it to support others.
535 [[Sandbox]] **Sandbox** **0**|**1**::
536     If set to 1, Tor will run securely through the use of a syscall sandbox.
537     Otherwise the sandbox will be disabled. The option is currently an
538     experimental feature. (Default: 0)
540 [[Socks4Proxy]] **Socks4Proxy** __host__[:__port__]::
541     Tor will make all OR connections through the SOCKS 4 proxy at host:port
542     (or host:1080 if port is not specified).
544 [[Socks5Proxy]] **Socks5Proxy** __host__[:__port__]::
545     Tor will make all OR connections through the SOCKS 5 proxy at host:port
546     (or host:1080 if port is not specified).
548 [[Socks5ProxyUsername]] **Socks5ProxyUsername** __username__ +
550 [[Socks5ProxyPassword]] **Socks5ProxyPassword** __password__::
551     If defined, authenticate to the SOCKS 5 server using username and password
552     in accordance to RFC 1929. Both username and password must be between 1 and
553     255 characters.
555 [[SocksSocketsGroupWritable]] **SocksSocketsGroupWritable** **0**|**1**::
556     If this option is set to 0, don't allow the filesystem group to read and
557     write unix sockets (e.g. SocksSocket). If the option is set to 1, make
558     the SocksSocket socket readable and writable by the default GID. (Default: 0)
560 [[KeepalivePeriod]] **KeepalivePeriod** __NUM__::
561     To keep firewalls from expiring connections, send a padding keepalive cell
562     every NUM seconds on open connections that are in use. If the connection
563     has no open circuits, it will instead be closed after NUM seconds of
564     idleness. (Default: 5 minutes)
566 [[Log]] **Log** __minSeverity__[-__maxSeverity__] **stderr**|**stdout**|**syslog**::
567     Send all messages between __minSeverity__ and __maxSeverity__ to the standard
568     output stream, the standard error stream, or to the system log. (The
569     "syslog" value is only supported on Unix.) Recognized severity levels are
570     debug, info, notice, warn, and err. We advise using "notice" in most cases,
571     since anything more verbose may provide sensitive information to an
572     attacker who obtains the logs. If only one severity level is given, all
573     messages of that level or higher will be sent to the listed destination.
575 [[Log2]] **Log** __minSeverity__[-__maxSeverity__] **file** __FILENAME__::
576     As above, but send log messages to the listed filename. The
577     "Log" option may appear more than once in a configuration file.
578     Messages are sent to all the logs that match their severity
579     level.
581 [[Log3]] **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **file** __FILENAME__ +
583 [[Log4]] **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **stderr**|**stdout**|**syslog**::
584     As above, but select messages by range of log severity __and__ by a
585     set of "logging domains".  Each logging domain corresponds to an area of
586     functionality inside Tor.  You can specify any number of severity ranges
587     for a single log statement, each of them prefixed by a comma-separated
588     list of logging domains.  You can prefix a domain with $$~$$ to indicate
589     negation, and use * to indicate "all domains".  If you specify a severity
590     range without a list of domains, it matches all domains. +
592     This is an advanced feature which is most useful for debugging one or two
593     of Tor's subsystems at a time. +
595     The currently recognized domains are: general, crypto, net, config, fs,
596     protocol, mm, http, app, control, circ, rend, bug, dir, dirserv, or, edge,
597     acct, hist, and handshake.  Domain names are case-insensitive. +
599     For example, "`Log [handshake]debug [~net,~mm]info notice stdout`" sends
600     to stdout: all handshake messages of any severity, all info-and-higher
601     messages from domains other than networking and memory management, and all
602     messages of severity notice or higher.
604 [[LogMessageDomains]] **LogMessageDomains** **0**|**1**::
605     If 1, Tor includes message domains with each log message.  Every log
606     message currently has at least one domain; most currently have exactly
607     one.  This doesn't affect controller log messages. (Default: 0)
609 [[MaxUnparseableDescSizeToLog]] **MaxUnparseableDescSizeToLog** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**::
610     Unparseable descriptors (e.g. for votes, consensuses, routers) are logged
611     in separate files by hash, up to the specified size in total.  Note that
612     only files logged during the lifetime of this Tor process count toward the
613     total; this is intended to be used to debug problems without opening live
614     servers to resource exhaustion attacks. (Default: 10 MB)
616 [[OutboundBindAddress]] **OutboundBindAddress** __IP__::
617     Make all outbound connections originate from the IP address specified. This
618     is only useful when you have multiple network interfaces, and you want all
619     of Tor's outgoing connections to use a single one. This option may
620     be used twice, once with an IPv4 address and once with an IPv6 address.
621     This setting will be ignored for connections to the loopback addresses
622     (127.0.0.0/8 and ::1).
624 [[PidFile]] **PidFile** __FILE__::
625     On startup, write our PID to FILE. On clean shutdown, remove
626     FILE.
628 [[ProtocolWarnings]] **ProtocolWarnings** **0**|**1**::
629     If 1, Tor will log with severity \'warn' various cases of other parties not
630     following the Tor specification. Otherwise, they are logged with severity
631     \'info'. (Default: 0)
633 [[PredictedPortsRelevanceTime]] **PredictedPortsRelevanceTime** __NUM__::
634     Set how long, after the client has made an anonymized connection to a
635     given port, we will try to make sure that we build circuits to
636     exits that support that port. The maximum value for this option is 1
637     hour. (Default: 1 hour)
639 [[RunAsDaemon]] **RunAsDaemon** **0**|**1**::
640     If 1, Tor forks and daemonizes to the background. This option has no effect
641     on Windows; instead you should use the --service command-line option.
642     (Default: 0)
644 [[LogTimeGranularity]] **LogTimeGranularity** __NUM__::
645     Set the resolution of timestamps in Tor's logs to NUM milliseconds.
646     NUM must be positive and either a divisor or a multiple of 1 second.
647     Note that this option only controls the granularity written by Tor to
648     a file or console log.  Tor does not (for example) "batch up" log
649     messages to affect times logged by a controller, times attached to
650     syslog messages, or the mtime fields on log files.  (Default: 1 second)
652 [[TruncateLogFile]] **TruncateLogFile** **0**|**1**::
653     If 1, Tor will overwrite logs at startup and in response to a HUP signal,
654     instead of appending to them. (Default: 0)
656 [[SyslogIdentityTag]] **SyslogIdentityTag** __tag__::
657     When logging to syslog, adds a tag to the syslog identity such that
658     log entries are marked with "Tor-__tag__".  (Default: none)
660 [[SafeLogging]] **SafeLogging** **0**|**1**|**relay**::
661     Tor can scrub potentially sensitive strings from log messages (e.g.
662     addresses) by replacing them with the string [scrubbed]. This way logs can
663     still be useful, but they don't leave behind personally identifying
664     information about what sites a user might have visited. +
666     If this option is set to 0, Tor will not perform any scrubbing, if it is
667     set to 1, all potentially sensitive strings are replaced. If it is set to
668     relay, all log messages generated when acting as a relay are sanitized, but
669     all messages generated when acting as a client are not. (Default: 1)
671 [[User]] **User** __UID__::
672     On startup, setuid to this user and setgid to their primary group.
674 [[KeepBindCapabilities]] **KeepBindCapabilities** **0**|**1**|**auto**::
675     On Linux, when we are started as root and we switch our identity using
676     the **User** option, the **KeepBindCapabilities** option tells us whether to
677     try to retain our ability to bind to low ports.  If this value is 1, we
678     try to keep the capability; if it is 0 we do not; and if it is **auto**,
679     we keep the capability only if we are configured to listen on a low port.
680     (Default: auto.)
682 [[HardwareAccel]] **HardwareAccel** **0**|**1**::
683     If non-zero, try to use built-in (static) crypto hardware acceleration when
684     available. (Default: 0)
686 [[AccelName]] **AccelName** __NAME__::
687     When using OpenSSL hardware crypto acceleration attempt to load the dynamic
688     engine of this name. This must be used for any dynamic hardware engine.
689     Names can be verified with the openssl engine command.
691 [[AccelDir]] **AccelDir** __DIR__::
692     Specify this option if using dynamic hardware acceleration and the engine
693     implementation library resides somewhere other than the OpenSSL default.
695 [[AvoidDiskWrites]] **AvoidDiskWrites** **0**|**1**::
696     If non-zero, try to write to disk less frequently than we would otherwise.
697     This is useful when running on flash memory or other media that support
698     only a limited number of writes. (Default: 0)
700 [[CircuitPriorityHalflife]] **CircuitPriorityHalflife** __NUM1__::
701     If this value is set, we override the default algorithm for choosing which
702     circuit's cell to deliver or relay next. When the value is 0, we
703     round-robin between the active circuits on a connection, delivering one
704     cell from each in turn. When the value is positive, we prefer delivering
705     cells from whichever connection has the lowest weighted cell count, where
706     cells are weighted exponentially according to the supplied
707     CircuitPriorityHalflife value (in seconds). If this option is not set at
708     all, we use the behavior recommended in the current consensus
709     networkstatus. This is an advanced option; you generally shouldn't have
710     to mess with it. (Default: not set)
712 [[CountPrivateBandwidth]] **CountPrivateBandwidth** **0**|**1**::
713     If this option is set, then Tor's rate-limiting applies not only to
714     remote connections, but also to connections to private addresses like
715     127.0.0.1 or 10.0.0.1.  This is mostly useful for debugging
716     rate-limiting.  (Default: 0)
718 CLIENT OPTIONS
719 --------------
721 The following options are useful only for clients (that is, if
722 **SocksPort**, **TransPort**, **DNSPort**, or **NATDPort** is non-zero):
724 [[AllowInvalidNodes]] **AllowInvalidNodes** **entry**|**exit**|**middle**|**introduction**|**rendezvous**|**...**::
725     If some Tor servers are obviously not working right, the directory
726     authorities can manually mark them as invalid, meaning that it's not
727     recommended you use them for entry or exit positions in your circuits. You
728     can opt to use them in some circuit positions, though. The default is
729     "middle,rendezvous", and other choices are not advised.
731 [[ExcludeSingleHopRelays]] **ExcludeSingleHopRelays** **0**|**1**::
732     This option controls whether circuits built by Tor will include relays with
733     the AllowSingleHopExits flag set to true. If ExcludeSingleHopRelays is set
734     to 0, these relays will be included. Note that these relays might be at
735     higher risk of being seized or observed, so they are not normally
736     included.  Also note that relatively few clients turn off this option,
737     so using these relays might make your client stand out.
738     (Default: 1)
740 [[Bridge]] **Bridge** [__transport__] __IP__:__ORPort__ [__fingerprint__]::
741     When set along with UseBridges, instructs Tor to use the relay at
742     "IP:ORPort" as a "bridge" relaying into the Tor network. If "fingerprint"
743     is provided (using the same format as for DirAuthority), we will verify that
744     the relay running at that location has the right fingerprint. We also use
745     fingerprint to look up the bridge descriptor at the bridge authority, if
746     it's provided and if UpdateBridgesFromAuthority is set too.  +
748     If "transport" is provided, it must match a ClientTransportPlugin line. We
749     then use that pluggable transport's proxy to transfer data to the bridge,
750     rather than connecting to the bridge directly. Some transports use a
751     transport-specific method to work out the remote address to connect to.
752     These transports typically ignore the "IP:ORPort" specified in the bridge
753     line.
755 [[LearnCircuitBuildTimeout]] **LearnCircuitBuildTimeout** **0**|**1**::
756     If 0, CircuitBuildTimeout adaptive learning is disabled. (Default: 1)
758 [[CircuitBuildTimeout]] **CircuitBuildTimeout** __NUM__::
760     Try for at most NUM seconds when building circuits. If the circuit isn't
761     open in that time, give up on it. If LearnCircuitBuildTimeout is 1, this
762     value serves as the initial value to use before a timeout is learned. If
763     LearnCircuitBuildTimeout is 0, this value is the only value used.
764     (Default: 60 seconds)
766 [[CircuitIdleTimeout]] **CircuitIdleTimeout** __NUM__::
767     If we have kept a clean (never used) circuit around for NUM seconds, then
768     close it. This way when the Tor client is entirely idle, it can expire all
769     of its circuits, and then expire its TLS connections. Also, if we end up
770     making a circuit that is not useful for exiting any of the requests we're
771     receiving, it won't forever take up a slot in the circuit list. (Default: 1
772     hour)
774 [[CircuitStreamTimeout]] **CircuitStreamTimeout** __NUM__::
775     If non-zero, this option overrides our internal timeout schedule for how
776     many seconds until we detach a stream from a circuit and try a new circuit.
777     If your network is particularly slow, you might want to set this to a
778     number like 60. (Default: 0)
780 [[ClientOnly]] **ClientOnly** **0**|**1**::
781     If set to 1, Tor will not run as a relay or serve
782     directory requests, even if the ORPort, ExtORPort, or DirPort options are
783     set. (This config option is
784     mostly unnecessary: we added it back when we were considering having
785     Tor clients auto-promote themselves to being relays if they were stable
786     and fast enough. The current behavior is simply that Tor is a client
787     unless ORPort, ExtORPort, or DirPort are configured.) (Default: 0)
789 [[ExcludeNodes]] **ExcludeNodes** __node__,__node__,__...__::
790     A list of identity fingerprints, country codes, and address
791     patterns of nodes to avoid when building a circuit. Country codes are
792     2-letter ISO3166 codes, and must
793     be wrapped in braces; fingerprints may be preceded by a dollar sign.
794     (Example:
795     ExcludeNodes ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
797     By default, this option is treated as a preference that Tor is allowed
798     to override in order to keep working.
799     For example, if you try to connect to a hidden service,
800     but you have excluded all of the hidden service's introduction points,
801     Tor will connect to one of them anyway.  If you do not want this
802     behavior, set the StrictNodes option (documented below).  +
804     Note also that if you are a relay, this (and the other node selection
805     options below) only affects your own circuits that Tor builds for you.
806     Clients can still build circuits through you to any node.  Controllers
807     can tell Tor to build circuits through any node. +
809     Country codes are case-insensitive. The code "\{??}" refers to nodes whose
810     country can't be identified. No country code, including \{??}, works if
811     no GeoIPFile can be loaded. See also the GeoIPExcludeUnknown option below.
814 [[ExcludeExitNodes]] **ExcludeExitNodes** __node__,__node__,__...__::
815     A list of identity fingerprints, country codes, and address
816     patterns of nodes to never use when picking an exit node---that is, a
817     node that delivers traffic for you outside the Tor network.   Note that any
818     node listed in ExcludeNodes is automatically considered to be part of this
819     list too.  See
820     the **ExcludeNodes** option for more information on how to specify
821     nodes. See also the caveats on the "ExitNodes" option below.
823 [[GeoIPExcludeUnknown]] **GeoIPExcludeUnknown** **0**|**1**|**auto**::
824     If this option is set to 'auto', then whenever any country code is set in
825     ExcludeNodes or ExcludeExitNodes, all nodes with unknown country (\{??} and
826     possibly \{A1}) are treated as excluded as well. If this option is set to
827     '1', then all unknown countries are treated as excluded in ExcludeNodes
828     and ExcludeExitNodes.  This option has no effect when a GeoIP file isn't
829     configured or can't be found.  (Default: auto)
831 [[ExitNodes]] **ExitNodes** __node__,__node__,__...__::
832     A list of identity fingerprints, country codes, and address
833     patterns of nodes to use as exit node---that is, a
834     node that delivers traffic for you outside the Tor network.  See
835     the **ExcludeNodes** option for more information on how to specify nodes. +
837     Note that if you list too few nodes here, or if you exclude too many exit
838     nodes with ExcludeExitNodes, you can degrade functionality.  For example,
839     if none of the exits you list allows traffic on port 80 or 443, you won't
840     be able to browse the web. +
842     Note also that not every circuit is used to deliver traffic outside of
843     the Tor network.  It is normal to see non-exit circuits (such as those
844     used to connect to hidden services, those that do directory fetches,
845     those used for relay reachability self-tests, and so on) that end
846     at a non-exit node.  To
847     keep a node from being used entirely, see ExcludeNodes and StrictNodes. +
849     The ExcludeNodes option overrides this option: any node listed in both
850     ExitNodes and ExcludeNodes is treated as excluded. +
852     The .exit address notation, if enabled via AllowDotExit, overrides
853     this option.
855 [[EntryNodes]] **EntryNodes** __node__,__node__,__...__::
856     A list of identity fingerprints and country codes of nodes
857     to use for the first hop in your normal circuits.
858     Normal circuits include all
859     circuits except for direct connections to directory servers.  The Bridge
860     option overrides this option; if you have configured bridges and
861     UseBridges is 1, the Bridges are used as your entry nodes. +
863     The ExcludeNodes option overrides this option: any node listed in both
864     EntryNodes and ExcludeNodes is treated as excluded. See
865     the **ExcludeNodes** option for more information on how to specify nodes.
867 [[StrictNodes]] **StrictNodes** **0**|**1**::
868     If StrictNodes is set to 1, Tor will treat the ExcludeNodes option as a
869     requirement to follow for all the circuits you generate, even if doing so
870     will break functionality for you.  If StrictNodes is set to 0, Tor will
871     still try to avoid nodes in the ExcludeNodes list, but it will err on the
872     side of avoiding unexpected errors.  Specifically, StrictNodes 0 tells
873     Tor that it is okay to use an excluded node when it is *necessary* to
874     perform relay reachability self-tests, connect to
875     a hidden service, provide a hidden service to a client, fulfill a .exit
876     request, upload directory information, or download directory information.
877     (Default: 0)
879 [[FascistFirewall]] **FascistFirewall** **0**|**1**::
880     If 1, Tor will only create outgoing connections to ORs running on ports
881     that your firewall allows (defaults to 80 and 443; see **FirewallPorts**).
882     This will allow you to run Tor as a client behind a firewall with
883     restrictive policies, but will not allow you to run as a server behind such
884     a firewall. If you prefer more fine-grained control, use
885     ReachableAddresses instead.
887 [[FirewallPorts]] **FirewallPorts** __PORTS__::
888     A list of ports that your firewall allows you to connect to. Only used when
889     **FascistFirewall** is set. This option is deprecated; use ReachableAddresses
890     instead. (Default: 80, 443)
892 [[ReachableAddresses]] **ReachableAddresses** __ADDR__[/__MASK__][:__PORT__]...::
893     A comma-separated list of IP addresses and ports that your firewall allows
894     you to connect to. The format is as for the addresses in ExitPolicy, except
895     that "accept" is understood unless "reject" is explicitly provided. For
896     example, \'ReachableAddresses 99.0.0.0/8, reject 18.0.0.0/8:80, accept
897     \*:80' means that your firewall allows connections to everything inside net
898     99, rejects port 80 connections to net 18, and accepts connections to port
899     80 otherwise. (Default: \'accept \*:*'.)
901 [[ReachableDirAddresses]] **ReachableDirAddresses** __ADDR__[/__MASK__][:__PORT__]...::
902     Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
903     these restrictions when fetching directory information, using standard HTTP
904     GET requests. If not set explicitly then the value of
905     **ReachableAddresses** is used. If **HTTPProxy** is set then these
906     connections will go through that proxy.
908 [[ReachableORAddresses]] **ReachableORAddresses** __ADDR__[/__MASK__][:__PORT__]...::
909     Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
910     these restrictions when connecting to Onion Routers, using TLS/SSL. If not
911     set explicitly then the value of **ReachableAddresses** is used. If
912     **HTTPSProxy** is set then these connections will go through that proxy. +
914     The separation between **ReachableORAddresses** and
915     **ReachableDirAddresses** is only interesting when you are connecting
916     through proxies (see **HTTPProxy** and **HTTPSProxy**). Most proxies limit
917     TLS connections (which Tor uses to connect to Onion Routers) to port 443,
918     and some limit HTTP GET requests (which Tor uses for fetching directory
919     information) to port 80.
921 [[HidServAuth]] **HidServAuth** __onion-address__ __auth-cookie__ [__service-name__]::
922     Client authorization for a hidden service. Valid onion addresses contain 16
923     characters in a-z2-7 plus ".onion", and valid auth cookies contain 22
924     characters in A-Za-z0-9+/. The service name is only used for internal
925     purposes, e.g., for Tor controllers. This option may be used multiple times
926     for different hidden services. If a hidden service uses authorization and
927     this option is not set, the hidden service is not accessible. Hidden
928     services can be configured to require authorization using the
929     **HiddenServiceAuthorizeClient** option.
931 [[CloseHSClientCircuitsImmediatelyOnTimeout]] **CloseHSClientCircuitsImmediatelyOnTimeout** **0**|**1**::
932     If 1, Tor will close unfinished hidden service client circuits
933     which have not moved closer to connecting to their destination
934     hidden service when their internal state has not changed for the
935     duration of the current circuit-build timeout.  Otherwise, such
936     circuits will be left open, in the hope that they will finish
937     connecting to their destination hidden services.  In either case,
938     another set of introduction and rendezvous circuits for the same
939     destination hidden service will be launched. (Default: 0)
941 [[CloseHSServiceRendCircuitsImmediatelyOnTimeout]] **CloseHSServiceRendCircuitsImmediatelyOnTimeout** **0**|**1**::
942     If 1, Tor will close unfinished hidden-service-side rendezvous
943     circuits after the current circuit-build timeout.  Otherwise, such
944     circuits will be left open, in the hope that they will finish
945     connecting to their destinations.  In either case, another
946     rendezvous circuit for the same destination client will be
947     launched. (Default: 0)
949 [[LongLivedPorts]] **LongLivedPorts** __PORTS__::
950     A list of ports for services that tend to have long-running connections
951     (e.g. chat and interactive shells). Circuits for streams that use these
952     ports will contain only high-uptime nodes, to reduce the chance that a node
953     will go down before the stream is finished. Note that the list is also
954     honored for circuits (both client and service side) involving hidden
955     services whose virtual port is in this list. (Default: 21, 22, 706,
956     1863, 5050, 5190, 5222, 5223, 6523, 6667, 6697, 8300)
958 [[MapAddress]] **MapAddress** __address__ __newaddress__::
959     When a request for address arrives to Tor, it will transform to newaddress
960     before processing it. For example, if you always want connections to
961     www.example.com to exit via __torserver__ (where __torserver__ is the
962     fingerprint of the server), use "MapAddress www.example.com
963     www.example.com.torserver.exit". If the value is prefixed with a
964     "\*.", matches an entire domain. For example, if you
965     always want connections to example.com and any if its subdomains
966     to exit via
967     __torserver__ (where __torserver__ is the fingerprint of the server), use
968     "MapAddress \*.example.com \*.example.com.torserver.exit". (Note the
969     leading "*." in each part of the directive.) You can also redirect all
970     subdomains of a domain to a single address. For example, "MapAddress
971     *.example.com www.example.com". +
973     NOTES:
975     1. When evaluating MapAddress expressions Tor stops when it hits the most
976     recently added expression that matches the requested address. So if you
977     have the following in your torrc, www.torproject.org will map to 1.1.1.1:
979      MapAddress www.torproject.org 2.2.2.2
980      MapAddress www.torproject.org 1.1.1.1
982     2. Tor evaluates the MapAddress configuration until it finds no matches. So
983     if you have the following in your torrc, www.torproject.org will map to
984     2.2.2.2:
986       MapAddress 1.1.1.1 2.2.2.2
987       MapAddress www.torproject.org 1.1.1.1
989     3. The following MapAddress expression is invalid (and will be
990     ignored) because you cannot map from a specific address to a wildcard
991     address:
993       MapAddress www.torproject.org *.torproject.org.torserver.exit
995     4. Using a wildcard to match only part of a string (as in *ample.com) is
996     also invalid.
998 [[NewCircuitPeriod]] **NewCircuitPeriod** __NUM__::
999     Every NUM seconds consider whether to build a new circuit. (Default: 30
1000     seconds)
1002 [[MaxCircuitDirtiness]] **MaxCircuitDirtiness** __NUM__::
1003     Feel free to reuse a circuit that was first used at most NUM seconds ago,
1004     but never attach a new stream to a circuit that is too old.  For hidden
1005     services, this applies to the __last__ time a circuit was used, not the
1006     first. Circuits with streams constructed with SOCKS authentication via
1007     SocksPorts that have **KeepAliveIsolateSOCKSAuth** ignore this value.
1008     (Default: 10 minutes)
1010 [[MaxClientCircuitsPending]] **MaxClientCircuitsPending** __NUM__::
1011     Do not allow more than NUM circuits to be pending at a time for handling
1012     client streams. A circuit is pending if we have begun constructing it,
1013     but it has not yet been completely constructed.  (Default: 32)
1015 [[NodeFamily]] **NodeFamily** __node__,__node__,__...__::
1016     The Tor servers, defined by their identity fingerprints,
1017     constitute a "family" of similar or co-administered servers, so never use
1018     any two of them in the same circuit. Defining a NodeFamily is only needed
1019     when a server doesn't list the family itself (with MyFamily). This option
1020     can be used multiple times; each instance defines a separate family.  In
1021     addition to nodes, you can also list IP address and ranges and country
1022     codes in {curly braces}. See the **ExcludeNodes** option for more
1023     information on how to specify nodes.
1025 [[EnforceDistinctSubnets]] **EnforceDistinctSubnets** **0**|**1**::
1026     If 1, Tor will not put two servers whose IP addresses are "too close" on
1027     the same circuit. Currently, two addresses are "too close" if they lie in
1028     the same /16 range. (Default: 1)
1030 [[SocksPort]] **SocksPort** \['address':]__port__|**unix:**__path__|**auto** [_flags_] [_isolation flags_]::
1031     Open this port to listen for connections from SOCKS-speaking
1032     applications. Set this to 0 if you don't want to allow application
1033     connections via SOCKS. Set it to "auto" to have Tor pick a port for
1034     you. This directive can be specified multiple times to bind
1035     to multiple addresses/ports. (Default: 9050) +
1037         NOTE: Although this option allows you to specify an IP address
1038         other than localhost, you should do so only with extreme caution.
1039         The SOCKS protocol is unencrypted and (as we use it)
1040         unauthenticated, so exposing it in this way could leak your
1041         information to anybody watching your network, and allow anybody
1042         to use your computer as an open proxy. +
1044     The _isolation flags_ arguments give Tor rules for which streams
1045     received on this SocksPort are allowed to share circuits with one
1046     another.  Recognized isolation flags are:
1047     **IsolateClientAddr**;;
1048         Don't share circuits with streams from a different
1049         client address.  (On by default and strongly recommended;
1050         you can disable it with **NoIsolateClientAddr**.)
1051     **IsolateSOCKSAuth**;;
1052         Don't share circuits with streams for which different
1053         SOCKS authentication was provided. (On by default;
1054         you can disable it with **NoIsolateSOCKSAuth**.)
1055     **IsolateClientProtocol**;;
1056         Don't share circuits with streams using a different protocol.
1057         (SOCKS 4, SOCKS 5, TransPort connections, NATDPort connections,
1058         and DNSPort requests are all considered to be different protocols.)
1059     **IsolateDestPort**;;
1060         Don't share circuits with streams targeting a different
1061         destination port.
1062     **IsolateDestAddr**;;
1063         Don't share circuits with streams targeting a different
1064         destination address.
1065     **KeepAliveIsolateSOCKSAuth**;;
1066         If **IsolateSOCKSAuth** is enabled, keep alive circuits that have
1067         streams with SOCKS authentication set indefinitely.
1068     **SessionGroup=**__INT__;;
1069         If no other isolation rules would prevent it, allow streams
1070         on this port to share circuits with streams from every other
1071         port with the same session group.  (By default, streams received
1072         on different SocksPorts, TransPorts, etc are always isolated from one
1073         another. This option overrides that behavior.)
1075 [[OtherSocksPortFlags]]::
1076     Other recognized __flags__ for a SocksPort are:
1077     **NoIPv4Traffic**;;
1078         Tell exits to not connect to IPv4 addresses in response to SOCKS
1079         requests on this connection.
1080     **IPv6Traffic**;;
1081         Tell exits to allow IPv6 addresses in response to SOCKS requests on
1082         this connection, so long as SOCKS5 is in use.  (SOCKS4 can't handle
1083         IPv6.)
1084     **PreferIPv6**;;
1085         Tells exits that, if a host has both an IPv4 and an IPv6 address,
1086         we would prefer to connect to it via IPv6. (IPv4 is the default.) +
1087     **CacheIPv4DNS**;;
1088         Tells the client to remember IPv4 DNS answers we receive from exit
1089         nodes via this connection. (On by default.)
1090     **CacheIPv6DNS**;;
1091         Tells the client to remember IPv6 DNS answers we receive from exit
1092         nodes via this connection.
1093     **GroupWritable**;;
1094         Unix domain sockets only: makes the socket get created as
1095         group-writable.
1096     **WorldWritable**;;
1097         Unix domain sockets only: makes the socket get created as
1098         world-writable.
1099     **CacheDNS**;;
1100         Tells the client to remember all DNS answers we receive from exit
1101         nodes via this connection.
1102     **UseIPv4Cache**;;
1103         Tells the client to use any cached IPv4 DNS answers we have when making
1104         requests via this connection. (NOTE: This option, along UseIPv6Cache
1105         and UseDNSCache, can harm your anonymity, and probably
1106         won't help performance as much as you might expect. Use with care!)
1107     **UseIPv6Cache**;;
1108         Tells the client to use any cached IPv6 DNS answers we have when making
1109         requests via this connection.
1110     **UseDNSCache**;;
1111         Tells the client to use any cached DNS answers we have when making
1112         requests via this connection.
1113     **PreferIPv6Automap**;;
1114         When serving a hostname lookup request on this port that
1115         should get automapped (according to AutomapHostsOnResolve),
1116         if we could return either an IPv4 or an IPv6 answer, prefer
1117         an IPv6 answer. (On by default.)
1118     **PreferSOCKSNoAuth**;;
1119         Ordinarily, when an application offers both "username/password
1120         authentication" and "no authentication" to Tor via SOCKS5, Tor
1121         selects username/password authentication so that IsolateSOCKSAuth can
1122         work.  This can confuse some applications, if they offer a
1123         username/password combination then get confused when asked for
1124         one. You can disable this behavior, so that Tor will select "No
1125         authentication" when IsolateSOCKSAuth is disabled, or when this
1126         option is set.
1128 [[SocksListenAddress]] **SocksListenAddress** __IP__[:__PORT__]::
1129     Bind to this address to listen for connections from Socks-speaking
1130     applications. (Default: 127.0.0.1) You can also specify a port (e.g.
1131     192.168.0.1:9100). This directive can be specified multiple times to bind
1132     to multiple addresses/ports.  (DEPRECATED: As of 0.2.3.x-alpha, you can
1133     now use multiple SocksPort entries, and provide addresses for SocksPort
1134     entries, so SocksListenAddress no longer has a purpose.  For backward
1135     compatibility, SocksListenAddress is only allowed when SocksPort is just
1136     a port number.)
1138 [[SocksPolicy]] **SocksPolicy** __policy__,__policy__,__...__::
1139     Set an entrance policy for this server, to limit who can connect to the
1140     SocksPort and DNSPort ports. The policies have the same form as exit
1141     policies below, except that port specifiers are ignored. Any address
1142     not matched by some entry in the policy is accepted.
1144 [[SocksTimeout]] **SocksTimeout** __NUM__::
1145     Let a socks connection wait NUM seconds handshaking, and NUM seconds
1146     unattached waiting for an appropriate circuit, before we fail it. (Default:
1147     2 minutes)
1149 [[TokenBucketRefillInterval]] **TokenBucketRefillInterval** __NUM__ [**msec**|**second**]::
1150     Set the refill interval of Tor's token bucket to NUM milliseconds.
1151     NUM must be between 1 and 1000, inclusive.  Note that the configured
1152     bandwidth limits are still expressed in bytes per second: this
1153     option only affects the frequency with which Tor checks to see whether
1154     previously exhausted connections may read again. (Default: 100 msec)
1156 [[TrackHostExits]] **TrackHostExits** __host__,__.domain__,__...__::
1157     For each value in the comma separated list, Tor will track recent
1158     connections to hosts that match this value and attempt to reuse the same
1159     exit node for each. If the value is prepended with a \'.\', it is treated as
1160     matching an entire domain. If one of the values is just a \'.', it means
1161     match everything. This option is useful if you frequently connect to sites
1162     that will expire all your authentication cookies (i.e. log you out) if
1163     your IP address changes. Note that this option does have the disadvantage
1164     of making it more clear that a given history is associated with a single
1165     user. However, most people who would wish to observe this will observe it
1166     through cookies or other protocol-specific means anyhow.
1168 [[TrackHostExitsExpire]] **TrackHostExitsExpire** __NUM__::
1169     Since exit servers go up and down, it is desirable to expire the
1170     association between host and exit server after NUM seconds. The default is
1171     1800 seconds (30 minutes).
1173 [[UpdateBridgesFromAuthority]] **UpdateBridgesFromAuthority** **0**|**1**::
1174     When set (along with UseBridges), Tor will try to fetch bridge descriptors
1175     from the configured bridge authorities when feasible. It will fall back to
1176     a direct request if the authority responds with a 404. (Default: 0)
1178 [[UseBridges]] **UseBridges** **0**|**1**::
1179     When set, Tor will fetch descriptors for each bridge listed in the "Bridge"
1180     config lines, and use these relays as both entry guards and directory
1181     guards. (Default: 0)
1183 [[UseEntryGuards]] **UseEntryGuards** **0**|**1**::
1184     If this option is set to 1, we pick a few long-term entry servers, and try
1185     to stick with them. This is desirable because constantly changing servers
1186     increases the odds that an adversary who owns some servers will observe a
1187     fraction of your paths. Entry Guards can not be used by Directory
1188     Authorities, Single Onion Services, and Tor2web clients. In these cases,
1189     the this option is ignored. (Default: 1)
1191 [[UseEntryGuardsAsDirGuards]] **UseEntryGuardsAsDirGuards** **0**|**1**::
1192     If this option is set to 1, and UseEntryGuards is also set to 1,
1193     we try to use our entry guards as directory
1194     guards, and failing that, pick more nodes to act as our directory guards.
1195     This helps prevent an adversary from enumerating clients. It's only
1196     available for clients (non-relay, non-bridge) that aren't configured to
1197     download any non-default directory material.  It doesn't currently
1198     do anything when we lack a live consensus. (Default: 1)
1200 [[GuardfractionFile]] **GuardfractionFile** __FILENAME__::
1201     V3 authoritative directories only. Configures the location of the
1202     guardfraction file which contains information about how long relays
1203     have been guards. (Default: unset)
1205 [[UseGuardFraction]] **UseGuardFraction** **0**|**1**|**auto**::
1206     This torrc option specifies whether clients should use the
1207     guardfraction information found in the consensus during path
1208     selection. If it's set to 'auto', clients will do what the
1209     UseGuardFraction consensus parameter tells them to do. (Default: auto)
1211 [[NumEntryGuards]] **NumEntryGuards** __NUM__::
1212     If UseEntryGuards is set to 1, we will try to pick a total of NUM routers
1213     as long-term entries for our circuits. If NUM is 0, we try to learn
1214     the number from the NumEntryGuards consensus parameter, and default
1215     to 3 if the consensus parameter isn't set. (Default: 0)
1217 [[NumDirectoryGuards]] **NumDirectoryGuards** __NUM__::
1218     If UseEntryGuardsAsDirectoryGuards is enabled, we try to make sure we
1219     have at least NUM routers to use as directory guards. If this option
1220     is set to 0, use the value from the NumDirectoryGuards consensus
1221     parameter, falling back to the value from NumEntryGuards if the
1222     consensus parameter is 0 or isn't set. (Default: 0)
1224 [[GuardLifetime]] **GuardLifetime**  __N__ **days**|**weeks**|**months**::
1225     If nonzero, and UseEntryGuards is set, minimum time to keep a guard before
1226     picking a new one. If zero, we use the GuardLifetime parameter from the
1227     consensus directory.  No value here may  be less than 1 month or greater
1228     than 5 years; out-of-range values are clamped. (Default: 0)
1230 [[SafeSocks]] **SafeSocks** **0**|**1**::
1231     When this option is enabled, Tor will reject application connections that
1232     use unsafe variants of the socks protocol -- ones that only provide an IP
1233     address, meaning the application is doing a DNS resolve first.
1234     Specifically, these are socks4 and socks5 when not doing remote DNS.
1235     (Default: 0)
1237 [[TestSocks]] **TestSocks** **0**|**1**::
1238     When this option is enabled, Tor will make a notice-level log entry for
1239     each connection to the Socks port indicating whether the request used a
1240     safe socks protocol or an unsafe one (see above entry on SafeSocks). This
1241     helps to determine whether an application using Tor is possibly leaking
1242     DNS requests. (Default: 0)
1244 [[WarnUnsafeSocks]] **WarnUnsafeSocks** **0**|**1**::
1245     When this option is enabled, Tor will warn whenever a request is
1246     received that only contains an IP address instead of a hostname. Allowing
1247     applications to do DNS resolves themselves is usually a bad idea and
1248     can leak your location to attackers. (Default: 1)
1250 [[VirtualAddrNetworkIPv4]] **VirtualAddrNetworkIPv4** __Address__/__bits__ +
1252 [[VirtualAddrNetworkIPv6]] **VirtualAddrNetworkIPv6** [__Address__]/__bits__::
1253     When Tor needs to assign a virtual (unused) address because of a MAPADDRESS
1254     command from the controller or the AutomapHostsOnResolve feature, Tor
1255     picks an unassigned address from this range. (Defaults:
1256     127.192.0.0/10 and [FE80::]/10 respectively.) +
1258     When providing proxy server service to a network of computers using a tool
1259     like dns-proxy-tor, change the IPv4 network to "10.192.0.0/10" or
1260     "172.16.0.0/12" and change the IPv6 network to "[FC00::]/7".
1261     The default **VirtualAddrNetwork** address ranges on a
1262     properly configured machine will route to the loopback or link-local
1263     interface. For
1264     local use, no change to the default VirtualAddrNetwork setting is needed.
1266 [[AllowNonRFC953Hostnames]] **AllowNonRFC953Hostnames** **0**|**1**::
1267     When this option is disabled, Tor blocks hostnames containing illegal
1268     characters (like @ and :) rather than sending them to an exit node to be
1269     resolved. This helps trap accidental attempts to resolve URLs and so on.
1270     (Default: 0)
1272 [[AllowDotExit]] **AllowDotExit** **0**|**1**::
1273     If enabled, we convert "www.google.com.foo.exit" addresses on the
1274     SocksPort/TransPort/NATDPort into "www.google.com" addresses that exit from
1275     the node "foo". Disabled by default since attacking websites and exit
1276     relays can use it to manipulate your path selection. (Default: 0)
1278 [[FastFirstHopPK]] **FastFirstHopPK** **0**|**1**|**auto**::
1279     When this option is disabled, Tor uses the public key step for the first
1280     hop of creating circuits. Skipping it is generally safe since we have
1281     already used TLS to authenticate the relay and to establish forward-secure
1282     keys. Turning this option off makes circuit building a little
1283     slower. Setting this option to "auto" takes advice from the authorities
1284     in the latest consensus about whether to use this feature.  +
1286     Note that Tor will always use the public key step for the first hop if it's
1287     operating as a relay, and it will never use the public key step if it
1288     doesn't yet know the onion key of the first hop. (Default: auto)
1290 [[TransPort]] **TransPort**  \['address':]__port__|**auto** [_isolation flags_]::
1291     Open this port to listen for transparent proxy connections.  Set this to
1292     0 if you don't want to allow transparent proxy connections.  Set the port
1293     to "auto" to have Tor pick a port for you. This directive can be
1294     specified multiple times to bind to multiple addresses/ports.  See
1295     SOCKSPort for an explanation of isolation flags. +
1297     TransPort requires OS support for transparent proxies, such as BSDs' pf or
1298     Linux's IPTables. If you're planning to use Tor as a transparent proxy for
1299     a network, you'll want to examine and change VirtualAddrNetwork from the
1300     default setting. You'll also want to set the TransListenAddress option for
1301     the network you'd like to proxy. (Default: 0)
1303 [[TransListenAddress]] **TransListenAddress** __IP__[:__PORT__]::
1304     Bind to this address to listen for transparent proxy connections. (Default:
1305     127.0.0.1). This is useful for exporting a transparent proxy server to an
1306     entire network. (DEPRECATED: As of 0.2.3.x-alpha, you can
1307     now use multiple TransPort entries, and provide addresses for TransPort
1308     entries, so TransListenAddress no longer has a purpose.  For backward
1309     compatibility, TransListenAddress is only allowed when TransPort is just
1310     a port number.)
1312 [[TransProxyType]] **TransProxyType** **default**|**TPROXY**|**ipfw**|**pf-divert**::
1313     TransProxyType may only be enabled when there is transparent proxy listener
1314     enabled.
1316     Set this to "TPROXY" if you wish to be able to use the TPROXY Linux module
1317     to transparently proxy connections that are configured using the TransPort
1318     option. This setting lets the listener on the TransPort accept connections
1319     for all addresses, even when the TransListenAddress is configured for an
1320     internal address. Detailed information on how to configure the TPROXY
1321     feature can be found in the Linux kernel source tree in the file
1322     Documentation/networking/tproxy.txt.
1324     Set this option to "ipfw" to use the FreeBSD ipfw interface.
1326     On *BSD operating systems when using pf, set this to "pf-divert" to take
1327     advantage of +divert-to+ rules, which do not modify the packets like
1328     +rdr-to+ rules do. Detailed information on how to configure pf to use
1329     +divert-to+ rules can be found in the pf.conf(5) manual page. On OpenBSD,
1330     +divert-to+ is available to use on versions greater than or equal to
1331     OpenBSD 4.4.
1333     Set this to "default", or leave it unconfigured, to use regular IPTables
1334     on Linux, or to use pf +rdr-to+ rules on *BSD systems.
1336     (Default: "default".)
1338 [[NATDPort]] **NATDPort** \['address':]__port__|**auto** [_isolation flags_]::
1339     Open this port to listen for connections from old versions of ipfw (as
1340     included in old versions of FreeBSD, etc) using the NATD protocol.
1341     Use 0 if you don't want to allow NATD connections.  Set the port
1342     to "auto" to have Tor pick a port for you. This directive can be
1343     specified multiple times to bind to multiple addresses/ports.  See
1344     SocksPort for an explanation of isolation flags. +
1346     This option is only for people who cannot use TransPort. (Default: 0)
1348 [[NATDListenAddress]] **NATDListenAddress** __IP__[:__PORT__]::
1349     Bind to this address to listen for NATD connections. (DEPRECATED: As of
1350     0.2.3.x-alpha, you can now use multiple NATDPort entries, and provide
1351     addresses for NATDPort entries, so NATDListenAddress no longer has a
1352     purpose.  For backward compatibility, NATDListenAddress is only allowed
1353     when NATDPort is just a port number.)
1355 [[AutomapHostsOnResolve]] **AutomapHostsOnResolve** **0**|**1**::
1356     When this option is enabled, and we get a request to resolve an address
1357     that ends with one of the suffixes in **AutomapHostsSuffixes**, we map an
1358     unused virtual address to that address, and return the new virtual address.
1359     This is handy for making ".onion" addresses work with applications that
1360     resolve an address and then connect to it. (Default: 0)
1362 [[AutomapHostsSuffixes]] **AutomapHostsSuffixes** __SUFFIX__,__SUFFIX__,__...__::
1363     A comma-separated list of suffixes to use with **AutomapHostsOnResolve**.
1364     The "." suffix is equivalent to "all addresses." (Default: .exit,.onion).
1366 [[DNSPort]] **DNSPort** \['address':]__port__|**auto** [_isolation flags_]::
1367     If non-zero, open this port to listen for UDP DNS requests, and resolve
1368     them anonymously.  This port only handles A, AAAA, and PTR requests---it
1369     doesn't handle arbitrary DNS request types. Set the port to "auto" to
1370     have Tor pick a port for
1371     you. This directive can be specified multiple times to bind to multiple
1372     addresses/ports. See SocksPort for an explanation of isolation
1373     flags. (Default: 0)
1375 [[DNSListenAddress]] **DNSListenAddress** __IP__[:__PORT__]::
1376     Bind to this address to listen for DNS connections. (DEPRECATED: As of
1377     0.2.3.x-alpha, you can now use multiple DNSPort entries, and provide
1378     addresses for DNSPort entries, so DNSListenAddress no longer has a
1379     purpose.  For backward compatibility, DNSListenAddress is only allowed
1380     when DNSPort is just a port number.)
1382 [[ClientDNSRejectInternalAddresses]] **ClientDNSRejectInternalAddresses** **0**|**1**::
1383     If true, Tor does not believe any anonymously retrieved DNS answer that
1384     tells it that an address resolves to an internal address (like 127.0.0.1 or
1385     192.168.0.1). This option prevents certain browser-based attacks; don't
1386     turn it off unless you know what you're doing. (Default: 1)
1388 [[ClientRejectInternalAddresses]] **ClientRejectInternalAddresses** **0**|**1**::
1389     If true, Tor does not try to fulfill requests to connect to an internal
1390     address (like 127.0.0.1 or 192.168.0.1) __unless a exit node is
1391     specifically requested__ (for example, via a .exit hostname, or a
1392     controller request).  (Default: 1)
1394 [[DownloadExtraInfo]] **DownloadExtraInfo** **0**|**1**::
1395     If true, Tor downloads and caches "extra-info" documents. These documents
1396     contain information about servers other than the information in their
1397     regular server descriptors. Tor does not use this information for anything
1398     itself; to save bandwidth, leave this option turned off. (Default: 0)
1400 [[WarnPlaintextPorts]] **WarnPlaintextPorts** __port__,__port__,__...__::
1401     Tells Tor to issue a warnings whenever the user tries to make an anonymous
1402     connection to one of these ports. This option is designed to alert users
1403     to services that risk sending passwords in the clear. (Default:
1404     23,109,110,143)
1406 [[RejectPlaintextPorts]] **RejectPlaintextPorts** __port__,__port__,__...__::
1407     Like WarnPlaintextPorts, but instead of warning about risky port uses, Tor
1408     will instead refuse to make the connection. (Default: None)
1410 [[AllowSingleHopCircuits]] **AllowSingleHopCircuits** **0**|**1**::
1411     When this option is set, the attached Tor controller can use relays
1412     that have the **AllowSingleHopExits** option turned on to build
1413     one-hop Tor connections.  (Default: 0)
1415 [[OptimisticData]] **OptimisticData** **0**|**1**|**auto**::
1416     When this option is set, and Tor is using an exit node that supports
1417     the feature, it will try optimistically to send data to the exit node
1418     without waiting for the exit node to report whether the connection
1419     succeeded.  This can save a round-trip time for protocols like HTTP
1420     where the client talks first.  If OptimisticData is set to **auto**,
1421     Tor will look at the UseOptimisticData parameter in the networkstatus.
1422     (Default: auto)
1424 [[Tor2webMode]] **Tor2webMode** **0**|**1**::
1425     When this option is set, Tor connects to hidden services
1426     **non-anonymously**.  This option also disables client connections to
1427     non-hidden-service hostnames through Tor. It **must only** be used when
1428     running a tor2web Hidden Service web proxy.
1429     To enable this option the compile time flag --enable-tor2web-mode must be
1430     specified. Since Tor2webMode is non-anonymous, you can not run an
1431     anonymous Hidden Service on a tor version compiled with Tor2webMode.
1432     (Default: 0)
1434 [[Tor2webRendezvousPoints]] **Tor2webRendezvousPoints** __node__,__node__,__...__::
1435     A list of identity fingerprints, nicknames, country codes and
1436     address patterns of nodes that are allowed to be used as RPs
1437     in HS circuits; any other nodes will not be used as RPs.
1438     (Example:
1439     Tor2webRendezvousPoints Fastyfasty, ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
1441     This feature can only be used if Tor2webMode is also enabled.
1443     ExcludeNodes have higher priority than Tor2webRendezvousPoints,
1444     which means that nodes specified in ExcludeNodes will not be
1445     picked as RPs.
1447     If no nodes in Tor2webRendezvousPoints are currently available for
1448     use, Tor will choose a random node when building HS circuits.
1450 [[UseMicrodescriptors]] **UseMicrodescriptors** **0**|**1**|**auto**::
1451     Microdescriptors are a smaller version of the information that Tor needs
1452     in order to build its circuits.  Using microdescriptors makes Tor clients
1453     download less directory information, thus saving bandwidth.  Directory
1454     caches need to fetch regular descriptors and microdescriptors, so this
1455     option doesn't save any bandwidth for them.  If this option is set to
1456     "auto" (recommended) then it is on for all clients that do not set
1457     FetchUselessDescriptors. (Default: auto)
1459 [[PathBiasCircThreshold]] **PathBiasCircThreshold** __NUM__ +
1461 [[PathBiasNoticeRate]] **PathBiasNoticeRate** __NUM__ +
1463 [[PathBiasWarnRate]] **PathBiasWarnRate** __NUM__ +
1465 [[PathBiasExtremeRate]] **PathBiasExtremeRate** __NUM__ +
1467 [[PathBiasDropGuards]] **PathBiasDropGuards** __NUM__ +
1469 [[PathBiasScaleThreshold]] **PathBiasScaleThreshold** __NUM__::
1470     These options override the default behavior of Tor's (**currently
1471     experimental**) path bias detection algorithm. To try to find broken or
1472     misbehaving guard nodes, Tor looks for nodes where more than a certain
1473     fraction of circuits through that guard fail to get built.
1475     The PathBiasCircThreshold option controls how many circuits we need to build
1476     through a guard before we make these checks.  The PathBiasNoticeRate,
1477     PathBiasWarnRate and PathBiasExtremeRate options control what fraction of
1478     circuits must succeed through a guard so we won't write log messages.
1479     If less than PathBiasExtremeRate circuits succeed *and* PathBiasDropGuards
1480     is set to 1, we disable use of that guard. +
1482     When we have seen more than PathBiasScaleThreshold
1483     circuits through a guard, we scale our observations by 0.5 (governed by
1484     the consensus) so that new observations don't get swamped by old ones. +
1486     By default, or if a negative value is provided for one of these options,
1487     Tor uses reasonable defaults from the networkstatus consensus document.
1488     If no defaults are available there, these options default to 150, .70,
1489     .50, .30, 0, and 300 respectively.
1491 [[PathBiasUseThreshold]] **PathBiasUseThreshold** __NUM__ +
1493 [[PathBiasNoticeUseRate]] **PathBiasNoticeUseRate** __NUM__ +
1495 [[PathBiasExtremeUseRate]] **PathBiasExtremeUseRate** __NUM__ +
1497 [[PathBiasScaleUseThreshold]] **PathBiasScaleUseThreshold** __NUM__::
1498     Similar to the above options, these options override the default behavior
1499     of Tor's (**currently experimental**) path use bias detection algorithm.
1501     Where as the path bias parameters govern thresholds for successfully
1502     building circuits, these four path use bias parameters govern thresholds
1503     only for circuit usage. Circuits which receive no stream usage
1504     are not counted by this detection algorithm. A used circuit is considered
1505     successful if it is capable of carrying streams or otherwise receiving
1506     well-formed responses to RELAY cells.
1508     By default, or if a negative value is provided for one of these options,
1509     Tor uses reasonable defaults from the networkstatus consensus document.
1510     If no defaults are available there, these options default to 20, .80,
1511     .60, and 100, respectively.
1513 [[ClientUseIPv4]] **ClientUseIPv4** **0**|**1**::
1514     If this option is set to 0, Tor will avoid connecting to directory servers
1515     and entry nodes over IPv4. Note that clients with an IPv4
1516     address in a **Bridge**, proxy, or pluggable transport line will try
1517     connecting over IPv4 even if **ClientUseIPv4** is set to 0. (Default: 1)
1519 [[ClientUseIPv6]] **ClientUseIPv6** **0**|**1**::
1520     If this option is set to 1, Tor might connect to directory servers or
1521     entry nodes over IPv6. Note that clients configured with an IPv6 address
1522     in a **Bridge**, proxy, or pluggable transport line will try connecting
1523     over IPv6 even if **ClientUseIPv6** is set to 0. (Default: 0)
1525 [[ClientPreferIPv6DirPort]] **ClientPreferIPv6DirPort** **0**|**1**|**auto**::
1526     If this option is set to 1, Tor prefers a directory port with an IPv6
1527     address over one with IPv4, for direct connections, if a given directory
1528     server has both. (Tor also prefers an IPv6 DirPort if IPv4Client is set to
1529     0.) If this option is set to auto, clients prefer IPv4. Other things may
1530     influence the choice. This option breaks a tie to the favor of IPv6.
1531     (Default: auto)
1533 [[ClientPreferIPv6ORPort]] **ClientPreferIPv6ORPort** **0**|**1**|**auto**::
1534     If this option is set to 1, Tor prefers an OR port with an IPv6
1535     address over one with IPv4 if a given entry node has both. (Tor also
1536     prefers an IPv6 ORPort if IPv4Client is set to 0.) If this option is set
1537     to auto, Tor bridge clients prefer the configured bridge address, and
1538     other clients prefer IPv4. Other things may influence the choice. This
1539     option breaks a tie to the favor of IPv6. (Default: auto)
1541 [[PathsNeededToBuildCircuits]] **PathsNeededToBuildCircuits** __NUM__::
1542     Tor clients don't build circuits for user traffic until they know
1543     about enough of the network so that they could potentially construct
1544     enough of the possible paths through the network. If this option
1545     is set to a fraction between 0.25 and 0.95, Tor won't build circuits
1546     until it has enough descriptors or microdescriptors to construct
1547     that fraction of possible paths. Note that setting this option too low
1548     can make your Tor client less anonymous, and setting it too high can
1549     prevent your Tor client from bootstrapping.  If this option is negative,
1550     Tor will use a default value chosen by the directory
1551     authorities. (Default: -1.)
1553 [[ClientBootstrapConsensusAuthorityDownloadSchedule]] **ClientBootstrapConsensusAuthorityDownloadSchedule** __N__,__N__,__...__::
1554     Schedule for when clients should download consensuses from authorities
1555     if they are bootstrapping (that is, they don't have a usable, reasonably
1556     live consensus). Only used by clients fetching from a list of fallback
1557     directory mirrors. This schedule is advanced by (potentially concurrent)
1558     connection attempts, unlike other schedules, which are advanced by
1559     connection failures. (Default: 10, 11, 3600, 10800, 25200, 54000,
1560     111600, 262800)
1562 [[ClientBootstrapConsensusFallbackDownloadSchedule]] **ClientBootstrapConsensusFallbackDownloadSchedule** __N__,__N__,__...__::
1563     Schedule for when clients should download consensuses from fallback
1564     directory mirrors if they are bootstrapping (that is, they don't have a
1565     usable, reasonably live consensus). Only used by clients fetching from a
1566     list of fallback directory mirrors. This schedule is advanced by
1567     (potentially concurrent) connection attempts, unlike other schedules,
1568     which are advanced by connection failures. (Default: 0, 1, 4, 11, 3600,
1569     10800, 25200, 54000, 111600, 262800)
1571 [[ClientBootstrapConsensusAuthorityOnlyDownloadSchedule]] **ClientBootstrapConsensusAuthorityOnlyDownloadSchedule** __N__,__N__,__...__::
1572     Schedule for when clients should download consensuses from authorities
1573     if they are bootstrapping (that is, they don't have a usable, reasonably
1574     live consensus). Only used by clients which don't have or won't fetch
1575     from a list of fallback directory mirrors. This schedule is advanced by
1576     (potentially concurrent) connection attempts, unlike other schedules,
1577     which are advanced by connection failures. (Default: 0, 3, 7, 3600,
1578     10800, 25200, 54000, 111600, 262800)
1580 [[ClientBootstrapConsensusMaxDownloadTries]] **ClientBootstrapConsensusMaxDownloadTries** __NUM__::
1581     Try this many times to download a consensus while bootstrapping using
1582     fallback directory mirrors before giving up. (Default: 7)
1584 [[ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries]] **ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries** __NUM__::
1585     Try this many times to download a consensus while bootstrapping using
1586     authorities before giving up. (Default: 4)
1588 [[ClientBootstrapConsensusMaxInProgressTries]] **ClientBootstrapConsensusMaxInProgressTries** __NUM__::
1589     Try this many simultaneous connections to download a consensus before
1590     waiting for one to complete, timeout, or error out. (Default: 4)
1592 SERVER OPTIONS
1593 --------------
1595 The following options are useful only for servers (that is, if ORPort
1596 is non-zero):
1598 [[Address]] **Address** __address__::
1599     The IP address or fully qualified domain name of this server (e.g.
1600     moria.mit.edu). You can leave this unset, and Tor will guess your IP
1601     address.  This IP address is the one used to tell clients and other
1602     servers where to find your Tor server; it doesn't affect the IP that your
1603     Tor client binds to.  To bind to a different address, use the
1604     *ListenAddress and OutboundBindAddress options.
1606 [[AllowSingleHopExits]] **AllowSingleHopExits** **0**|**1**::
1607     This option controls whether clients can use this server as a single hop
1608     proxy. If set to 1, clients can use this server as an exit even if it is
1609     the only hop in the circuit.  Note that most clients will refuse to use
1610     servers that set this option, since most clients have
1611     ExcludeSingleHopRelays set.  (Default: 0)
1613 [[AssumeReachable]] **AssumeReachable** **0**|**1**::
1614     This option is used when bootstrapping a new Tor network. If set to 1,
1615     don't do self-reachability testing; just upload your server descriptor
1616     immediately. If **AuthoritativeDirectory** is also set, this option
1617     instructs the dirserver to bypass remote reachability testing too and list
1618     all connected servers as running.
1620 [[BridgeRelay]] **BridgeRelay** **0**|**1**::
1621     Sets the relay to act as a "bridge" with respect to relaying connections
1622     from bridge users to the Tor network. It mainly causes Tor to publish a
1623     server descriptor to the bridge database, rather than
1624     to the public directory authorities.
1626 [[ContactInfo]] **ContactInfo** __email_address__::
1627     Administrative contact information for this relay or bridge. This line
1628     can be used to contact you if your relay or bridge is misconfigured or
1629     something else goes wrong. Note that we archive and publish all
1630     descriptors containing these lines and that Google indexes them, so
1631     spammers might also collect them. You may want to obscure the fact
1632     that it's an email address and/or generate a new address for this
1633     purpose.
1635 [[ExitRelay]] **ExitRelay** **0**|**1**|**auto**::
1636     Tells Tor whether to run as an exit relay.  If Tor is running as a
1637     non-bridge server, and ExitRelay is set to 1, then Tor allows traffic to
1638     exit according to the ExitPolicy option (or the default ExitPolicy if
1639     none is specified).
1641     If ExitRelay is set to 0, no traffic is allowed to
1642     exit, and the ExitPolicy option is ignored. +
1644     If ExitRelay is set to "auto", then Tor behaves as if it were set to 1, but
1645     warns the user if this would cause traffic to exit.  In a future version,
1646     the default value will be 0. (Default: auto)
1648 [[ExitPolicy]] **ExitPolicy** __policy__,__policy__,__...__::
1649     Set an exit policy for this server. Each policy is of the form
1650     "**accept[6]**|**reject[6]**  __ADDR__[/__MASK__][:__PORT__]". If /__MASK__ is
1651     omitted then this policy just applies to the host given. Instead of giving
1652     a host or network you can also use "\*" to denote the universe (0.0.0.0/0
1653     and ::/128), or \*4 to denote all IPv4 addresses, and \*6 to denote all
1654     IPv6 addresses.
1655     __PORT__ can be a single port number, an interval of ports
1656     "__FROM_PORT__-__TO_PORT__", or "\*". If __PORT__ is omitted, that means
1657     "\*". +
1659     For example, "accept 18.7.22.69:\*,reject 18.0.0.0/8:\*,accept \*:\*" would
1660     reject any IPv4 traffic destined for MIT except for web.mit.edu, and accept
1661     any other IPv4 or IPv6 traffic. +
1663     Tor also allows IPv6 exit policy entries. For instance, "reject6 [FC00::]/7:\*"
1664     rejects all destinations that share 7 most significant bit prefix with
1665     address FC00::. Respectively, "accept6 [C000::]/3:\*" accepts all destinations
1666     that share 3 most significant bit prefix with address C000::. +
1668     accept6 and reject6 only produce IPv6 exit policy entries. Using an IPv4
1669     address with accept6 or reject6 is ignored and generates a warning.
1670     accept/reject allows either IPv4 or IPv6 addresses. Use \*4 as an IPv4
1671     wildcard address, and \*6 as an IPv6 wildcard address. accept/reject *
1672     expands to matching IPv4 and IPv6 wildcard address rules. +
1674     To specify all IPv4 and IPv6 internal and link-local networks (including
1675     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,
1676     172.16.0.0/12, [::]/8, [FC00::]/7, [FE80::]/10, [FEC0::]/10, [FF00::]/8,
1677     and [::]/127), you can use the "private" alias instead of an address.
1678     ("private" always produces rules for IPv4 and IPv6 addresses, even when
1679     used with accept6/reject6.) +
1681     Private addresses are rejected by default (at the beginning of your exit
1682     policy), along with any configured primary public IPv4 and IPv6 addresses.
1683     These private addresses are rejected unless you set the
1684     ExitPolicyRejectPrivate config option to 0. For example, once you've done
1685     that, you could allow HTTP to 127.0.0.1 and block all other connections to
1686     internal networks with "accept 127.0.0.1:80,reject private:\*", though that
1687     may also allow connections to your own computer that are addressed to its
1688     public (external) IP address. See RFC 1918 and RFC 3330 for more details
1689     about internal and reserved IP address space. See
1690     ExitPolicyRejectLocalInterfaces if you want to block every address on the
1691     relay, even those that aren't advertised in the descriptor. +
1693     This directive can be specified multiple times so you don't have to put it
1694     all on one line. +
1696     Policies are considered first to last, and the first match wins. If you
1697     want to allow the same ports on IPv4 and IPv6, write your rules using
1698     accept/reject \*. If you want to allow different ports on IPv4 and IPv6,
1699     write your IPv6 rules using accept6/reject6 \*6, and your IPv4 rules using
1700     accept/reject \*4. If you want to \_replace_ the default exit policy, end
1701     your exit policy with either a reject \*:* or an accept \*:*. Otherwise,
1702     you're \_augmenting_ (prepending to) the default exit policy. The default
1703     exit policy is: +
1705        reject *:25
1706        reject *:119
1707        reject *:135-139
1708        reject *:445
1709        reject *:563
1710        reject *:1214
1711        reject *:4661-4666
1712        reject *:6346-6429
1713        reject *:6699
1714        reject *:6881-6999
1715        accept *:*
1717     Since the default exit policy uses accept/reject *, it applies to both
1718     IPv4 and IPv6 addresses.
1720 [[ExitPolicyRejectPrivate]] **ExitPolicyRejectPrivate** **0**|**1**::
1721     Reject all private (local) networks, along with the relay's advertised
1722     public IPv4 and IPv6 addresses, at the beginning of your exit policy.
1723     See above entry on ExitPolicy.
1724     (Default: 1)
1726 [[ExitPolicyRejectLocalInterfaces]] **ExitPolicyRejectLocalInterfaces** **0**|**1**::
1727     Reject all IPv4 and IPv6 addresses that the relay knows about, at the
1728     beginning of your exit policy. This includes any OutboundBindAddress, the
1729     bind addresses of any port options, such as ControlPort or DNSPort, and any
1730     public IPv4 and IPv6 addresses on any interface on the relay. (If IPv6Exit
1731     is not set, all IPv6 addresses will be rejected anyway.)
1732     See above entry on ExitPolicy.
1733     This option is off by default, because it lists all public relay IP
1734     addresses in the ExitPolicy, even those relay operators might prefer not
1735     to disclose.
1736     (Default: 0)
1738 [[IPv6Exit]] **IPv6Exit** **0**|**1**::
1739     If set, and we are an exit node, allow clients to use us for IPv6
1740     traffic. (Default: 0)
1742 [[MaxOnionQueueDelay]] **MaxOnionQueueDelay** __NUM__ [**msec**|**second**]::
1743     If we have more onionskins queued for processing than we can process in
1744     this amount of time, reject new ones. (Default: 1750 msec)
1746 [[MyFamily]] **MyFamily** __node__,__node__,__...__::
1747     Declare that this Tor server is controlled or administered by a group or
1748     organization identical or similar to that of the other servers, defined by
1749     their identity fingerprints. When two servers both declare
1750     that they are in the same \'family', Tor clients will not use them in the
1751     same circuit. (Each server only needs to list the other servers in its
1752     family; it doesn't need to list itself, but it won't hurt.) Do not list
1753     any bridge relay as it would compromise its concealment.
1755     When listing a node, it's better to list it by fingerprint than by
1756     nickname: fingerprints are more reliable.
1758 [[Nickname]] **Nickname** __name__::
1759     Set the server's nickname to \'name'. Nicknames must be between 1 and 19
1760     characters inclusive, and must contain only the characters [a-zA-Z0-9].
1762 [[NumCPUs]] **NumCPUs** __num__::
1763     How many processes to use at once for decrypting onionskins and other
1764     parallelizable operations.  If this is set to 0, Tor will try to detect
1765     how many CPUs you have, defaulting to 1 if it can't tell.  (Default: 0)
1767 [[ORPort]] **ORPort** \['address':]__PORT__|**auto** [_flags_]::
1768     Advertise this port to listen for connections from Tor clients and
1769     servers.  This option is required to be a Tor server.
1770     Set it to "auto" to have Tor pick a port for you. Set it to 0 to not
1771     run an ORPort at all. This option can occur more than once. (Default: 0)
1773     Tor recognizes these flags on each ORPort:
1774     **NoAdvertise**::
1775         By default, we bind to a port and tell our users about it. If
1776         NoAdvertise is specified, we don't advertise, but listen anyway.  This
1777         can be useful if the port everybody will be connecting to (for
1778         example, one that's opened on our firewall) is somewhere else.
1779     **NoListen**::
1780         By default, we bind to a port and tell our users about it. If
1781         NoListen is specified, we don't bind, but advertise anyway.  This
1782         can be useful if something else  (for example, a firewall's port
1783         forwarding configuration) is causing connections to reach us.
1784     **IPv4Only**::
1785         If the address is absent, or resolves to both an IPv4 and an IPv6
1786         address, only listen to the IPv4 address.
1787     **IPv6Only**::
1788         If the address is absent, or resolves to both an IPv4 and an IPv6
1789         address, only listen to the IPv6 address.
1791     For obvious reasons, NoAdvertise and NoListen are mutually exclusive, and
1792     IPv4Only and IPv6Only are mutually exclusive.
1794 [[ORListenAddress]] **ORListenAddress** __IP__[:__PORT__]::
1795     Bind to this IP address to listen for connections from Tor clients and
1796     servers. If you specify a port, bind to this port rather than the one
1797     specified in ORPort. (Default: 0.0.0.0) This directive can be specified
1798     multiple times to bind to multiple addresses/ports.
1800     This option is deprecated; you can get the same behavior with ORPort now
1801     that it supports NoAdvertise and explicit addresses.
1803 [[PortForwarding]] **PortForwarding** **0**|**1**::
1804     Attempt to automatically forward the DirPort and ORPort on a NAT router
1805     connecting this Tor server to the Internet. If set, Tor will try both
1806     NAT-PMP (common on Apple routers) and UPnP (common on routers from other
1807     manufacturers). (Default: 0)
1809 [[PortForwardingHelper]] **PortForwardingHelper** __filename__|__pathname__::
1810     If PortForwarding is set, use this executable to configure the forwarding.
1811     If set to a filename, the system path will be searched for the executable.
1812     If set to a path, only the specified path will be executed.
1813     (Default: tor-fw-helper)
1815 [[PublishServerDescriptor]] **PublishServerDescriptor** **0**|**1**|**v3**|**bridge**,**...**::
1816     This option specifies which descriptors Tor will publish when acting as
1817     a relay. You can
1818     choose multiple arguments, separated by commas.
1820     If this option is set to 0, Tor will not publish its
1821     descriptors to any directories. (This is useful if you're testing
1822     out your server, or if you're using a Tor controller that handles directory
1823     publishing for you.) Otherwise, Tor will publish its descriptors of all
1824     type(s) specified. The default is "1",
1825     which means "if running as a server, publish the
1826     appropriate descriptors to the authorities".
1828 [[ShutdownWaitLength]] **ShutdownWaitLength** __NUM__::
1829     When we get a SIGINT and we're a server, we begin shutting down:
1830     we close listeners and start refusing new circuits. After **NUM**
1831     seconds, we exit. If we get a second SIGINT, we exit immediately.
1832     (Default: 30 seconds)
1834 [[SSLKeyLifetime]] **SSLKeyLifetime** __N__ **minutes**|**hours**|**days**|**weeks**::
1835     When creating a link certificate for our outermost SSL handshake,
1836     set its lifetime to this amount of time. If set to 0, Tor will choose
1837     some reasonable random defaults. (Default: 0)
1839 [[HeartbeatPeriod]] **HeartbeatPeriod**  __N__ **minutes**|**hours**|**days**|**weeks**::
1840     Log a heartbeat message every **HeartbeatPeriod** seconds. This is
1841     a log level __notice__ message, designed to let you know your Tor
1842     server is still alive and doing useful things. Settings this
1843     to 0 will disable the heartbeat. Otherwise, it must be at least 30
1844     minutes. (Default: 6 hours)
1846 [[AccountingMax]] **AccountingMax** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**|**TBytes**::
1847     Limits the max number of bytes sent and received within a set time period
1848     using a given calculation rule (see: AccountingStart, AccountingRule).
1849     Useful if you need to stay under a specific bandwidth. By default, the
1850     number used for calculation is the max of either the bytes sent or
1851     received. For example, with AccountingMax set to 1 GByte, a server
1852     could send 900 MBytes and receive 800 MBytes and continue running.
1853     It will only hibernate once one of the two reaches 1 GByte. This can
1854     be changed to use the sum of the both bytes received and sent by setting
1855     the AccountingRule option to "sum" (total bandwidth in/out). When the
1856     number of bytes remaining gets low, Tor will stop accepting new connections
1857     and circuits. When the number of bytes is exhausted, Tor will hibernate
1858     until some time in the next accounting period. To prevent all servers
1859     from waking at the same time, Tor will also wait until a random point
1860     in each period before waking up. If you have bandwidth cost issues,
1861     enabling hibernation is preferable to setting a low bandwidth, since
1862     it provides users with a collection of fast servers that are up some
1863     of the time, which is more useful than a set of slow servers that are
1864     always "available".
1866 [[AccountingRule]] **AccountingRule** **sum**|**max**|**in**|**out**::
1867     How we determine when our AccountingMax has been reached (when we
1868     should hibernate) during a time interval. Set to "max" to calculate
1869     using the higher of either the sent or received bytes (this is the
1870     default functionality). Set to "sum" to calculate using the sent
1871     plus received bytes. Set to "in" to calculate using only the
1872     received bytes. Set to "out" to calculate using only the sent bytes.
1873     (Default: max)
1875 [[AccountingStart]] **AccountingStart** **day**|**week**|**month** [__day__] __HH:MM__::
1876     Specify how long accounting periods last. If **month** is given, each
1877     accounting period runs from the time __HH:MM__ on the __dayth__ day of one
1878     month to the same day and time of the next. (The day must be between 1 and
1879     28.) If **week** is given, each accounting period runs from the time __HH:MM__
1880     of the __dayth__ day of one week to the same day and time of the next week,
1881     with Monday as day 1 and Sunday as day 7. If **day** is given, each
1882     accounting period runs from the time __HH:MM__ each day to the same time on
1883     the next day. All times are local, and given in 24-hour time. (Default:
1884     "month 1 0:00")
1886 [[RefuseUnknownExits]] **RefuseUnknownExits** **0**|**1**|**auto**::
1887     Prevent nodes that don't appear in the consensus from exiting using this
1888     relay.  If the option is 1, we always block exit attempts from such
1889     nodes; if it's 0, we never do, and if the option is "auto", then we do
1890     whatever the authorities suggest in the consensus (and block if the consensus
1891     is quiet on the issue). (Default: auto)
1893 [[ServerDNSResolvConfFile]] **ServerDNSResolvConfFile** __filename__::
1894     Overrides the default DNS configuration with the configuration in
1895     __filename__. The file format is the same as the standard Unix
1896     "**resolv.conf**" file (7). This option, like all other ServerDNS options,
1897     only affects name lookups that your server does on behalf of clients.
1898     (Defaults to use the system DNS configuration.)
1900 [[ServerDNSAllowBrokenConfig]] **ServerDNSAllowBrokenConfig** **0**|**1**::
1901     If this option is false, Tor exits immediately if there are problems
1902     parsing the system DNS configuration or connecting to nameservers.
1903     Otherwise, Tor continues to periodically retry the system nameservers until
1904     it eventually succeeds. (Default: 1)
1906 [[ServerDNSSearchDomains]] **ServerDNSSearchDomains** **0**|**1**::
1907     If set to 1, then we will search for addresses in the local search domain.
1908     For example, if this system is configured to believe it is in
1909     "example.com", and a client tries to connect to "www", the client will be
1910     connected to "www.example.com". This option only affects name lookups that
1911     your server does on behalf of clients. (Default: 0)
1913 [[ServerDNSDetectHijacking]] **ServerDNSDetectHijacking** **0**|**1**::
1914     When this option is set to 1, we will test periodically to determine
1915     whether our local nameservers have been configured to hijack failing DNS
1916     requests (usually to an advertising site). If they are, we will attempt to
1917     correct this. This option only affects name lookups that your server does
1918     on behalf of clients. (Default: 1)
1920 [[ServerDNSTestAddresses]] **ServerDNSTestAddresses** __address__,__address__,__...__::
1921     When we're detecting DNS hijacking, make sure that these __valid__ addresses
1922     aren't getting redirected. If they are, then our DNS is completely useless,
1923     and we'll reset our exit policy to "reject \*:*". This option only affects
1924     name lookups that your server does on behalf of clients. (Default:
1925     "www.google.com, www.mit.edu, www.yahoo.com, www.slashdot.org")
1927 [[ServerDNSAllowNonRFC953Hostnames]] **ServerDNSAllowNonRFC953Hostnames** **0**|**1**::
1928     When this option is disabled, Tor does not try to resolve hostnames
1929     containing illegal characters (like @ and :) rather than sending them to an
1930     exit node to be resolved. This helps trap accidental attempts to resolve
1931     URLs and so on. This option only affects name lookups that your server does
1932     on behalf of clients. (Default: 0)
1934 [[BridgeRecordUsageByCountry]] **BridgeRecordUsageByCountry** **0**|**1**::
1935     When this option is enabled and BridgeRelay is also enabled, and we have
1936     GeoIP data, Tor keeps a per-country count of how many client
1937     addresses have contacted it so that it can help the bridge authority guess
1938     which countries have blocked access to it. (Default: 1)
1940 [[ServerDNSRandomizeCase]] **ServerDNSRandomizeCase** **0**|**1**::
1941     When this option is set, Tor sets the case of each character randomly in
1942     outgoing DNS requests, and makes sure that the case matches in DNS replies.
1943     This so-called "0x20 hack" helps resist some types of DNS poisoning attack.
1944     For more information, see "Increased DNS Forgery Resistance through
1945     0x20-Bit Encoding". This option only affects name lookups that your server
1946     does on behalf of clients. (Default: 1)
1948 [[GeoIPFile]] **GeoIPFile** __filename__::
1949     A filename containing IPv4 GeoIP data, for use with by-country statistics.
1951 [[GeoIPv6File]] **GeoIPv6File** __filename__::
1952     A filename containing IPv6 GeoIP data, for use with by-country statistics.
1954 [[TLSECGroup]] **TLSECGroup** **P224**|**P256**::
1955     What EC group should we try to use for incoming TLS connections?
1956     P224 is faster, but makes us stand out more. Has no effect if
1957     we're a client, or if our OpenSSL version lacks support for ECDHE.
1958     (Default: P256)
1960 [[CellStatistics]] **CellStatistics** **0**|**1**::
1961     Relays only.
1962     When this option is enabled, Tor collects statistics about cell
1963     processing (i.e. mean time a cell is spending in a queue, mean
1964     number of cells in a queue and mean number of processed cells per
1965     circuit) and writes them into disk every 24 hours. Onion router
1966     operators may use the statistics for performance monitoring.
1967     If ExtraInfoStatistics is enabled, it will published as part of
1968     extra-info document. (Default: 0)
1970 [[DirReqStatistics]] **DirReqStatistics** **0**|**1**::
1971     Relays and bridges only.
1972     When this option is enabled, a Tor directory writes statistics on the
1973     number and response time of network status requests to disk every 24
1974     hours. Enables relay and bridge operators to monitor how much their
1975     server is being used by clients to learn about Tor network.
1976     If ExtraInfoStatistics is enabled, it will published as part of
1977     extra-info document. (Default: 1)
1979 [[EntryStatistics]] **EntryStatistics** **0**|**1**::
1980     Relays only.
1981     When this option is enabled, Tor writes statistics on the number of
1982     directly connecting clients to disk every 24 hours. Enables relay
1983     operators to monitor how much inbound traffic that originates from
1984     Tor clients passes through their server to go further down the
1985     Tor network. If ExtraInfoStatistics is enabled, it will be published
1986     as part of extra-info document. (Default: 0)
1988 [[ExitPortStatistics]] **ExitPortStatistics** **0**|**1**::
1989     Exit relays only.
1990     When this option is enabled, Tor writes statistics on the number of
1991     relayed bytes and opened stream per exit port to disk every 24 hours.
1992     Enables exit relay operators to measure and monitor amounts of traffic
1993     that leaves Tor network through their exit node. If ExtraInfoStatistics
1994     is enabled, it will be published as part of extra-info document.
1995     (Default: 0)
1997 [[ConnDirectionStatistics]] **ConnDirectionStatistics** **0**|**1**::
1998     Relays only.
1999     When this option is enabled, Tor writes statistics on the amounts of
2000     traffic it passes between itself and other relays to disk every 24
2001     hours. Enables relay operators to monitor how much their relay is
2002     being used as middle node in the circuit. If ExtraInfoStatistics is
2003     enabled, it will be published as part of extra-info document.
2004     (Default: 0)
2006 [[HiddenServiceStatistics]] **HiddenServiceStatistics** **0**|**1**::
2007     Relays only.
2008     When this option is enabled, a Tor relay writes obfuscated
2009     statistics on its role as hidden-service directory, introduction
2010     point, or rendezvous point to disk every 24 hours. If
2011     ExtraInfoStatistics is also enabled, these statistics are further
2012     published to the directory authorities. (Default: 1)
2014 [[ExtraInfoStatistics]] **ExtraInfoStatistics** **0**|**1**::
2015     When this option is enabled, Tor includes previously gathered statistics in
2016     its extra-info documents that it uploads to the directory authorities.
2017     (Default: 1)
2019 [[ExtendAllowPrivateAddresses]] **ExtendAllowPrivateAddresses** **0**|**1**::
2020     When this option is enabled, Tor will connect to relays on localhost,
2021     RFC1918 addresses, and so on. In particular, Tor will make direct OR
2022     connections, and Tor routers allow EXTEND requests, to these private
2023     addresses. (Tor will always allow connections to bridges, proxies, and
2024     pluggable transports configured on private addresses.) Enabling this
2025     option can create security issues; you should probably leave it off.
2026     (Default: 0)
2028 [[MaxMemInQueues]] **MaxMemInQueues**  __N__ **bytes**|**KB**|**MB**|**GB**::
2029     This option configures a threshold above which Tor will assume that it
2030     needs to stop queueing or buffering data because it's about to run out of
2031     memory.  If it hits this threshold, it will begin killing circuits until
2032     it has recovered at least 10% of this memory.  Do not set this option too
2033     low, or your relay may be unreliable under load.  This option only
2034     affects some queues, so the actual process size will be larger than
2035     this.  If this option is set to 0, Tor will try to pick a reasonable
2036     default based on your system's physical memory.  (Default: 0)
2038 [[DisableOOSCheck]] **DisableOOSCheck** **0**|**1**::
2039     This option disables the code that closes connections when Tor notices
2040     that it is running low on sockets. Right now, it is on by default,
2041     since the existing out-of-sockets mechanism tends to kill OR connections
2042     more than it should. (Default: 1)
2044 [[SigningKeyLifetime]] **SigningKeyLifetime** __N__ **days**|**weeks**|**months**::
2045     For how long should each Ed25519 signing key be valid?  Tor uses a
2046     permanent master identity key that can be kept offline, and periodically
2047     generates new "signing" keys that it uses online.  This option
2048     configures their lifetime.
2049     (Default: 30 days)
2051 [[OfflineMasterKey]] **OfflineMasterKey** **0**|**1**::
2052     If non-zero, the Tor relay will never generate or load its master secret
2053     key.  Instead, you'll have to use "tor --keygen" to manage the permanent
2054     ed25519 master identity key, as well as the corresponding temporary
2055     signing keys and certificates. (Default: 0)
2057 DIRECTORY SERVER OPTIONS
2058 ------------------------
2060 The following options are useful only for directory servers (that is,
2061 if DirPort is non-zero):
2063 [[DirPortFrontPage]] **DirPortFrontPage** __FILENAME__::
2064     When this option is set, it takes an HTML file and publishes it as "/" on
2065     the DirPort. Now relay operators can provide a disclaimer without needing
2066     to set up a separate webserver. There's a sample disclaimer in
2067     contrib/operator-tools/tor-exit-notice.html.
2069 [[DirPort]] **DirPort** \['address':]__PORT__|**auto** [_flags_]::
2070     If this option is nonzero, advertise the directory service on this port.
2071     Set it to "auto" to have Tor pick a port for you.  This option can occur
2072     more than once, but only one advertised DirPort is supported: all
2073     but one DirPort must have the **NoAdvertise** flag set. (Default: 0)
2075     The same flags are supported here as are supported by ORPort.
2077 [[DirListenAddress]] **DirListenAddress** __IP__[:__PORT__]::
2078     Bind the directory service to this address. If you specify a port, bind to
2079     this port rather than the one specified in DirPort.  (Default: 0.0.0.0)
2080     This directive can be specified multiple times  to bind to multiple
2081     addresses/ports.
2083     This option is deprecated; you can get the same behavior with DirPort now
2084     that it supports NoAdvertise and explicit addresses.
2086 [[DirPolicy]] **DirPolicy** __policy__,__policy__,__...__::
2087     Set an entrance policy for this server, to limit who can connect to the
2088     directory ports. The policies have the same form as exit policies above,
2089     except that port specifiers are ignored. Any address not matched by
2090     some entry in the policy is accepted.
2092 [[DirCache]] **DirCache** **0**|**1**::
2093     When this option is set, Tor caches all current directory documents and
2094     accepts client requests for them. Setting DirPort is not required for this,
2095     because clients connect via the ORPort by default. Setting either DirPort
2096     or BridgeRelay and setting DirCache to 0 is not supported.  (Default: 1)
2099 DIRECTORY AUTHORITY SERVER OPTIONS
2100 ----------------------------------
2102 The following options enable operation as a directory authority, and
2103 control how Tor behaves as a directory authority.  You should not need
2104 to adjust any of them if you're running a regular relay or exit server
2105 on the public Tor network.
2107 [[AuthoritativeDirectory]] **AuthoritativeDirectory** **0**|**1**::
2108     When this option is set to 1, Tor operates as an authoritative directory
2109     server. Instead of caching the directory, it generates its own list of
2110     good servers, signs it, and sends that to the clients. Unless the clients
2111     already have you listed as a trusted directory, you probably do not want
2112     to set this option.
2114 [[V3AuthoritativeDirectory]] **V3AuthoritativeDirectory** **0**|**1**::
2115     When this option is set in addition to **AuthoritativeDirectory**, Tor
2116     generates version 3 network statuses and serves descriptors, etc as
2117     described in dir-spec.txt file of https://spec.torproject.org/[torspec]
2118     (for Tor clients and servers running atleast 0.2.0.x).
2120 [[VersioningAuthoritativeDirectory]] **VersioningAuthoritativeDirectory** **0**|**1**::
2121     When this option is set to 1, Tor adds information on which versions of
2122     Tor are still believed safe for use to the published directory. Each
2123     version 1 authority is automatically a versioning authority; version 2
2124     authorities provide this service optionally. See **RecommendedVersions**,
2125     **RecommendedClientVersions**, and **RecommendedServerVersions**.
2127 [[RecommendedVersions]] **RecommendedVersions** __STRING__::
2128     STRING is a comma-separated list of Tor versions currently believed to be
2129     safe. The list is included in each directory, and nodes which pull down the
2130     directory learn whether they need to upgrade. This option can appear
2131     multiple times: the values from multiple lines are spliced together. When
2132     this is set then **VersioningAuthoritativeDirectory** should be set too.
2134 [[RecommendedPackages]] **RecommendedPackages** __PACKAGENAME__ __VERSION__ __URL__ __DIGESTTYPE__**=**__DIGEST__ ::
2135     Adds "package" line to the directory authority's vote.  This information
2136     is used to vote on the correct URL and digest for the released versions
2137     of different Tor-related packages, so that the consensus can certify
2138     them.  This line may appear any number of times.
2140 [[RecommendedClientVersions]] **RecommendedClientVersions** __STRING__::
2141     STRING is a comma-separated list of Tor versions currently believed to be
2142     safe for clients to use. This information is included in version 2
2143     directories. If this is not set then the value of **RecommendedVersions**
2144     is used. When this is set then **VersioningAuthoritativeDirectory** should
2145     be set too.
2147 [[BridgeAuthoritativeDir]] **BridgeAuthoritativeDir** **0**|**1**::
2148     When this option is set in addition to **AuthoritativeDirectory**, Tor
2149     accepts and serves server descriptors, but it caches and serves the main
2150     networkstatus documents rather than generating its own. (Default: 0)
2152 [[MinUptimeHidServDirectoryV2]] **MinUptimeHidServDirectoryV2** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2153     Minimum uptime of a v2 hidden service directory to be accepted as such by
2154     authoritative directories. (Default: 25 hours)
2156 [[RecommendedServerVersions]] **RecommendedServerVersions** __STRING__::
2157     STRING is a comma-separated list of Tor versions currently believed to be
2158     safe for servers to use. This information is included in version 2
2159     directories. If this is not set then the value of **RecommendedVersions**
2160     is used. When this is set then **VersioningAuthoritativeDirectory** should
2161     be set too.
2163 [[ConsensusParams]] **ConsensusParams** __STRING__::
2164     STRING is a space-separated list of key=value pairs that Tor will include
2165     in the "params" line of its networkstatus vote.
2167 [[DirAllowPrivateAddresses]] **DirAllowPrivateAddresses** **0**|**1**::
2168     If set to 1, Tor will accept server descriptors with arbitrary "Address"
2169     elements. Otherwise, if the address is not an IP address or is a private IP
2170     address, it will reject the server descriptor. (Default: 0)
2172 [[AuthDirBadExit]] **AuthDirBadExit** __AddressPattern...__::
2173     Authoritative directories only. A set of address patterns for servers that
2174     will be listed as bad exits in any network status document this authority
2175     publishes, if **AuthDirListBadExits** is set.
2177     (The address pattern syntax here and in the options below
2178     is the same as for exit policies, except that you don't need to say
2179     "accept" or "reject", and ports are not needed.)
2181 [[AuthDirInvalid]] **AuthDirInvalid** __AddressPattern...__::
2182     Authoritative directories only. A set of address patterns for servers that
2183     will never be listed as "valid" in any network status document that this
2184     authority publishes.
2186 [[AuthDirReject]] **AuthDirReject** __AddressPattern__...::
2187     Authoritative directories only. A set of address patterns for servers that
2188     will never be listed at all in any network status document that this
2189     authority publishes, or accepted as an OR address in any descriptor
2190     submitted for publication by this authority.
2192 [[AuthDirBadExitCCs]] **AuthDirBadExitCCs** __CC__,... +
2194 [[AuthDirInvalidCCs]] **AuthDirInvalidCCs** __CC__,... +
2196 [[AuthDirRejectCCs]] **AuthDirRejectCCs** __CC__,...::
2197     Authoritative directories only. These options contain a comma-separated
2198     list of country codes such that any server in one of those country codes
2199     will be marked as a bad exit/invalid for use, or rejected
2200     entirely.
2202 [[AuthDirListBadExits]] **AuthDirListBadExits** **0**|**1**::
2203     Authoritative directories only. If set to 1, this directory has some
2204     opinion about which nodes are unsuitable as exit nodes. (Do not set this to
2205     1 unless you plan to list non-functioning exits as bad; otherwise, you are
2206     effectively voting in favor of every declared exit as an exit.)
2208 [[AuthDirMaxServersPerAddr]] **AuthDirMaxServersPerAddr** __NUM__::
2209     Authoritative directories only. The maximum number of servers that we will
2210     list as acceptable on a single IP address. Set this to "0" for "no limit".
2211     (Default: 2)
2213 [[AuthDirMaxServersPerAuthAddr]] **AuthDirMaxServersPerAuthAddr** __NUM__::
2214     Authoritative directories only. Like AuthDirMaxServersPerAddr, but applies
2215     to addresses shared with directory authorities. (Default: 5)
2217 [[AuthDirFastGuarantee]] **AuthDirFastGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
2218     Authoritative directories only. If non-zero, always vote the
2219     Fast flag for any relay advertising this amount of capacity or
2220     more. (Default: 100 KBytes)
2222 [[AuthDirGuardBWGuarantee]] **AuthDirGuardBWGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
2223     Authoritative directories only. If non-zero, this advertised capacity
2224     or more is always sufficient to satisfy the bandwidth requirement
2225     for the Guard flag. (Default: 250 KBytes)
2227 [[AuthDirPinKeys]] **AuthDirPinKeys** **0**|**1**::
2228     Authoritative directories only. If non-zero, do not allow any relay to
2229     publish a descriptor if any other relay has reserved its <Ed25519,RSA>
2230     identity keypair. In all cases, Tor records every keypair it accepts
2231     in a journal if it is new, or if it differs from the most recently
2232     accepted pinning for one of the keys it contains. (Default: 0)
2234 [[AuthDirSharedRandomness]] **AuthDirSharedRandomness** **0**|**1**::
2235     Authoritative directories only. Switch for the shared random protocol.
2236     If zero, the authority won't participate in the protocol. If non-zero
2237     (default), the flag "shared-rand-participate" is added to the authority
2238     vote indicating participation in the protocol. (Default: 1)
2240 [[BridgePassword]] **BridgePassword** __Password__::
2241     If set, contains an HTTP authenticator that tells a bridge authority to
2242     serve all requested bridge information. Used by the (only partially
2243     implemented) "bridge community" design, where a community of bridge
2244     relay operators all use an alternate bridge directory authority,
2245     and their target user audience can periodically fetch the list of
2246     available community bridges to stay up-to-date. (Default: not set)
2248 [[V3AuthVotingInterval]] **V3AuthVotingInterval** __N__ **minutes**|**hours**::
2249     V3 authoritative directories only. Configures the server's preferred voting
2250     interval. Note that voting will __actually__ happen at an interval chosen
2251     by consensus from all the authorities' preferred intervals. This time
2252     SHOULD divide evenly into a day. (Default: 1 hour)
2254 [[V3AuthVoteDelay]] **V3AuthVoteDelay** __N__ **minutes**|**hours**::
2255     V3 authoritative directories only. Configures the server's preferred delay
2256     between publishing its vote and assuming it has all the votes from all the
2257     other authorities. Note that the actual time used is not the server's
2258     preferred time, but the consensus of all preferences. (Default: 5 minutes)
2260 [[V3AuthDistDelay]] **V3AuthDistDelay** __N__ **minutes**|**hours**::
2261     V3 authoritative directories only. Configures the server's preferred  delay
2262     between publishing its consensus and signature and assuming  it has all the
2263     signatures from all the other authorities. Note that the actual time used
2264     is not the server's preferred time,  but the consensus of all preferences.
2265     (Default: 5 minutes)
2267 [[V3AuthNIntervalsValid]] **V3AuthNIntervalsValid** __NUM__::
2268     V3 authoritative directories only. Configures the number of VotingIntervals
2269     for which each consensus should be valid for. Choosing high numbers
2270     increases network partitioning risks; choosing low numbers increases
2271     directory traffic. Note that the actual number of intervals used is not the
2272     server's preferred number, but the consensus of all preferences. Must be at
2273     least 2. (Default: 3)
2275 [[V3BandwidthsFile]] **V3BandwidthsFile** __FILENAME__::
2276     V3 authoritative directories only. Configures the location of the
2277     bandwidth-authority generated file storing information on relays' measured
2278     bandwidth capacities. (Default: unset)
2280 [[V3AuthUseLegacyKey]] **V3AuthUseLegacyKey** **0**|**1**::
2281     If set, the directory authority will sign consensuses not only with its
2282     own signing key, but also with a "legacy" key and certificate with a
2283     different identity.  This feature is used to migrate directory authority
2284     keys in the event of a compromise.  (Default: 0)
2286 [[RephistTrackTime]] **RephistTrackTime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2287     Tells an authority, or other node tracking node reliability and history,
2288     that fine-grained information about nodes can be discarded when it hasn't
2289     changed for a given amount of time.  (Default: 24 hours)
2291 [[AuthDirHasIPv6Connectivity]] **AuthDirHasIPv6Connectivity** **0**|**1**::
2292     Authoritative directories only. When set to 0, OR ports with an
2293     IPv6 address are being accepted without reachability testing.
2294     When set to 1, IPv6 OR ports are being tested just like IPv4 OR
2295     ports. (Default: 0)
2297 [[MinMeasuredBWsForAuthToIgnoreAdvertised]] **MinMeasuredBWsForAuthToIgnoreAdvertised** __N__::
2298     A total value, in abstract bandwidth units, describing how much
2299     measured total bandwidth an authority should have observed on the network
2300     before it will treat advertised bandwidths as wholly
2301     unreliable. (Default: 500)
2303 HIDDEN SERVICE OPTIONS
2304 ----------------------
2306 The following options are used to configure a hidden service.
2308 [[HiddenServiceDir]] **HiddenServiceDir** __DIRECTORY__::
2309     Store data files for a hidden service in DIRECTORY. Every hidden service
2310     must have a separate directory. You may use this option  multiple times to
2311     specify multiple services. DIRECTORY must be an existing directory.
2312     (Note: in current versions of Tor, if DIRECTORY is a relative path,
2313     it will be relative to current
2314     working directory of Tor instance, not to its DataDirectory.  Do not
2315     rely on this behavior; it is not guaranteed to remain the same in future
2316     versions.)
2318 [[HiddenServicePort]] **HiddenServicePort** __VIRTPORT__ [__TARGET__]::
2319     Configure a virtual port VIRTPORT for a hidden service. You may use this
2320     option multiple times; each time applies to the service using the most
2321     recent HiddenServiceDir. By default, this option maps the virtual port to
2322     the same port on 127.0.0.1 over TCP. You may override the target port,
2323     address, or both by specifying a target of addr, port, addr:port, or
2324     **unix:**__path__.  (You can specify an IPv6 target as [addr]:port.)
2325     You may also have multiple lines with  the same VIRTPORT: when a user
2326     connects to that VIRTPORT, one of the TARGETs from those lines will be
2327     chosen at random.
2329 [[PublishHidServDescriptors]] **PublishHidServDescriptors** **0**|**1**::
2330     If set to 0, Tor will run any hidden services you configure, but it won't
2331     advertise them to the rendezvous directory. This option is only useful if
2332     you're using a Tor controller that handles hidserv publishing for you.
2333     (Default: 1)
2335 [[HiddenServiceVersion]] **HiddenServiceVersion** __version__,__version__,__...__::
2336     A list of rendezvous service descriptor versions to publish for the hidden
2337     service. Currently, only version 2 is supported. (Default: 2)
2339 [[HiddenServiceAuthorizeClient]] **HiddenServiceAuthorizeClient** __auth-type__ __client-name__,__client-name__,__...__::
2340     If configured, the hidden service is accessible for authorized clients
2341     only. The auth-type can either be \'basic' for a general-purpose
2342     authorization protocol or \'stealth' for a less scalable protocol that also
2343     hides service activity from unauthorized clients. Only clients that are
2344     listed here are authorized to access the hidden service. Valid client names
2345     are 1 to 16 characters long and only use characters in A-Za-z0-9+-_ (no
2346     spaces). If this option is set, the hidden service is not accessible for
2347     clients without authorization any more. Generated authorization data can be
2348     found in the hostname file. Clients need to put this authorization data in
2349     their configuration file using **HidServAuth**.
2351 [[HiddenServiceAllowUnknownPorts]] **HiddenServiceAllowUnknownPorts** **0**|**1**::
2352    If set to 1, then connections to unrecognized ports do not cause the
2353    current hidden service to close rendezvous circuits. (Setting this to 0 is
2354    not an authorization mechanism; it is instead meant to be a mild
2355    inconvenience to port-scanners.) (Default: 0)
2357 [[HiddenServiceMaxStreams]] **HiddenServiceMaxStreams** __N__::
2358    The maximum number of simultaneous streams (connections) per rendezvous
2359    circuit. (Setting this to 0 will allow an unlimited number of simultanous
2360    streams.) (Default: 0)
2362 [[HiddenServiceMaxStreamsCloseCircuit]] **HiddenServiceMaxStreamsCloseCircuit** **0**|**1**::
2363    If set to 1, then exceeding **HiddenServiceMaxStreams** will cause the
2364    offending rendezvous circuit to be torn down, as opposed to stream creation
2365    requests that exceed the limit being silently ignored. (Default: 0)
2367 [[RendPostPeriod]] **RendPostPeriod** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2368     Every time the specified period elapses, Tor uploads any rendezvous
2369     service descriptors to the directory servers. This information  is also
2370     uploaded whenever it changes. (Default: 1 hour)
2372 [[HiddenServiceDirGroupReadable]] **HiddenServiceDirGroupReadable** **0**|**1**::
2373     If this option is set to 1, allow the filesystem group to read the
2374     hidden service directory and hostname file. If the option is set to 0,
2375     only owner is able to read the hidden service directory. (Default: 0)
2376     Has no effect on Windows.
2378 [[HiddenServiceNumIntroductionPoints]] **HiddenServiceNumIntroductionPoints** __NUM__::
2379     Number of introduction points the hidden service will have. You can't
2380     have more than 10. (Default: 3)
2382 [[OnionServiceSingleHopMode]] **OnionServiceSingleHopMode** **0**|**1**::
2383     **Experimental - Non Anonymous** Hidden Services on a tor instance in
2384     OnionServiceSingleHopMode make one-hop (direct) circuits between the onion
2385     service server, and the introduction and rendezvous points. (Onion service
2386     descriptors are still posted using 3-hop paths, to avoid onion service
2387     directories blocking the service.)
2388     This option makes every hidden service instance hosted by a tor instance a
2389     Single Onion Service. One-hop circuits make Single Onion servers easily
2390     locatable, but clients remain location-anonymous. However, the fact that a
2391     client is accessing a Single Onion rather than a Hidden Service may be
2392     statistically distinguishable.
2394     **WARNING:** Once a hidden service directory has been used by a tor
2395     instance in OnionServiceSingleHopMode, it can **NEVER** be used again for
2396     a hidden service. It is best practice to create a new hidden service
2397     directory, key, and address for each new Single Onion Service and Hidden
2398     Service. It is not possible to run Single Onion Services and Hidden
2399     Services from the same tor instance: they should be run on different
2400     servers with different IP addresses.
2402     OnionServiceSingleHopMode requires OnionServiceNonAnonymousMode to be set
2403     to 1. Since a Single Onion is non-anonymous, you can not to run an
2404     anonymous SOCKSPort on the same tor instance as a Single Onion service.
2405     (Default: 0)
2407 [[OnionServiceNonAnonymousMode]] **OnionServiceNonAnonymousMode** **0**|**1**::
2408     Makes hidden services non-anonymous on this tor instance. Allows the
2409     non-anonymous OnionServiceSingleHopMode. Enables direct connections in the
2410     server-side hidden service protocol.
2411     (Default: 0)
2413 TESTING NETWORK OPTIONS
2414 -----------------------
2416 The following options are used for running a testing Tor network.
2418 [[TestingTorNetwork]] **TestingTorNetwork** **0**|**1**::
2419     If set to 1, Tor adjusts default values of the configuration options below,
2420     so that it is easier to set up a testing Tor network. May only be set if
2421     non-default set of DirAuthorities is set. Cannot be unset while Tor is
2422     running.
2423     (Default: 0) +
2425        ServerDNSAllowBrokenConfig 1
2426        DirAllowPrivateAddresses 1
2427        EnforceDistinctSubnets 0
2428        AssumeReachable 1
2429        AuthDirMaxServersPerAddr 0
2430        AuthDirMaxServersPerAuthAddr 0
2431        ClientBootstrapConsensusAuthorityDownloadSchedule 0, 2,
2432           4 (for 40 seconds), 8, 16, 32, 60
2433        ClientBootstrapConsensusFallbackDownloadSchedule 0, 1,
2434           4 (for 40 seconds), 8, 16, 32, 60
2435        ClientBootstrapConsensusAuthorityOnlyDownloadSchedule 0, 1,
2436           4 (for 40 seconds), 8, 16, 32, 60
2437        ClientBootstrapConsensusMaxDownloadTries 80
2438        ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries 80
2439        ClientDNSRejectInternalAddresses 0
2440        ClientRejectInternalAddresses 0
2441        CountPrivateBandwidth 1
2442        ExitPolicyRejectPrivate 0
2443        ExtendAllowPrivateAddresses 1
2444        V3AuthVotingInterval 5 minutes
2445        V3AuthVoteDelay 20 seconds
2446        V3AuthDistDelay 20 seconds
2447        MinUptimeHidServDirectoryV2 0 seconds
2448        TestingV3AuthInitialVotingInterval 5 minutes
2449        TestingV3AuthInitialVoteDelay 20 seconds
2450        TestingV3AuthInitialDistDelay 20 seconds
2451        TestingAuthDirTimeToLearnReachability 0 minutes
2452        TestingEstimatedDescriptorPropagationTime 0 minutes
2453        TestingServerDownloadSchedule 0, 0, 0, 5, 10, 15, 20, 30, 60
2454        TestingClientDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2455        TestingServerConsensusDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2456        TestingClientConsensusDownloadSchedule 0, 0, 5, 10, 15, 20, 30, 60
2457        TestingBridgeDownloadSchedule 60, 30, 30, 60
2458        TestingClientMaxIntervalWithoutRequest 5 seconds
2459        TestingDirConnectionMaxStall 30 seconds
2460        TestingConsensusMaxDownloadTries 80
2461        TestingDescriptorMaxDownloadTries 80
2462        TestingMicrodescMaxDownloadTries 80
2463        TestingCertMaxDownloadTries 80
2464        TestingEnableConnBwEvent 1
2465        TestingEnableCellStatsEvent 1
2466        TestingEnableTbEmptyEvent 1
2468 [[TestingV3AuthInitialVotingInterval]] **TestingV3AuthInitialVotingInterval** __N__ **minutes**|**hours**::
2469     Like V3AuthVotingInterval, but for initial voting interval before the first
2470     consensus has been created. Changing this requires that
2471     **TestingTorNetwork** is set. (Default: 30 minutes)
2473 [[TestingV3AuthInitialVoteDelay]] **TestingV3AuthInitialVoteDelay** __N__ **minutes**|**hours**::
2474     Like V3AuthVoteDelay, but for initial voting interval before
2475     the first consensus has been created. Changing this requires that
2476     **TestingTorNetwork** is set. (Default: 5 minutes)
2478 [[TestingV3AuthInitialDistDelay]] **TestingV3AuthInitialDistDelay** __N__ **minutes**|**hours**::
2479     Like V3AuthDistDelay, but for initial voting interval before
2480     the first consensus has been created. Changing this requires that
2481     **TestingTorNetwork** is set. (Default: 5 minutes)
2483 [[TestingV3AuthVotingStartOffset]] **TestingV3AuthVotingStartOffset** __N__ **seconds**|**minutes**|**hours**::
2484     Directory authorities offset voting start time by this much.
2485     Changing this requires that **TestingTorNetwork** is set. (Default: 0)
2487 [[TestingAuthDirTimeToLearnReachability]] **TestingAuthDirTimeToLearnReachability** __N__ **minutes**|**hours**::
2488     After starting as an authority, do not make claims about whether routers
2489     are Running until this much time has passed. Changing this requires
2490     that **TestingTorNetwork** is set.  (Default: 30 minutes)
2492 [[TestingEstimatedDescriptorPropagationTime]] **TestingEstimatedDescriptorPropagationTime** __N__ **minutes**|**hours**::
2493     Clients try downloading server descriptors from directory caches after this
2494     time. Changing this requires that **TestingTorNetwork** is set. (Default:
2495     10 minutes)
2497 [[TestingMinFastFlagThreshold]] **TestingMinFastFlagThreshold** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
2498     Minimum value for the Fast flag.  Overrides the ordinary minimum taken
2499     from the consensus when TestingTorNetwork is set. (Default: 0.)
2501 [[TestingServerDownloadSchedule]] **TestingServerDownloadSchedule** __N__,__N__,__...__::
2502     Schedule for when servers should download things in general. Changing this
2503     requires that **TestingTorNetwork** is set. (Default: 0, 0, 0, 60, 60, 120,
2504     300, 900, 2147483647)
2506 [[TestingClientDownloadSchedule]] **TestingClientDownloadSchedule** __N__,__N__,__...__::
2507     Schedule for when clients should download things in general. Changing this
2508     requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2509     2147483647)
2511 [[TestingServerConsensusDownloadSchedule]] **TestingServerConsensusDownloadSchedule** __N__,__N__,__...__::
2512     Schedule for when servers should download consensuses. Changing this
2513     requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2514     1800, 1800, 1800, 1800, 1800, 3600, 7200)
2516 [[TestingClientConsensusDownloadSchedule]] **TestingClientConsensusDownloadSchedule** __N__,__N__,__...__::
2517     Schedule for when clients should download consensuses. Changing this
2518     requires that **TestingTorNetwork** is set. (Default: 0, 0, 60, 300, 600,
2519     1800, 3600, 3600, 3600, 10800, 21600, 43200)
2521 [[TestingBridgeDownloadSchedule]] **TestingBridgeDownloadSchedule** __N__,__N__,__...__::
2522     Schedule for when clients should download bridge descriptors. Changing this
2523     requires that **TestingTorNetwork** is set. (Default: 3600, 900, 900, 3600)
2525 [[TestingClientMaxIntervalWithoutRequest]] **TestingClientMaxIntervalWithoutRequest** __N__ **seconds**|**minutes**::
2526     When directory clients have only a few descriptors to request, they batch
2527     them until they have more, or until this amount of time has passed.
2528     Changing this requires that **TestingTorNetwork** is set. (Default: 10
2529     minutes)
2531 [[TestingDirConnectionMaxStall]] **TestingDirConnectionMaxStall** __N__ **seconds**|**minutes**::
2532     Let a directory connection stall this long before expiring it.
2533     Changing this requires that **TestingTorNetwork** is set. (Default:
2534     5 minutes)
2536 [[TestingConsensusMaxDownloadTries]] **TestingConsensusMaxDownloadTries** __NUM__::
2537     Try this many times to download a consensus before giving up. Changing
2538     this requires that **TestingTorNetwork** is set. (Default: 8)
2540 [[TestingDescriptorMaxDownloadTries]] **TestingDescriptorMaxDownloadTries** __NUM__::
2541     Try this often to download a server descriptor before giving up.
2542     Changing this requires that **TestingTorNetwork** is set. (Default: 8)
2544 [[TestingMicrodescMaxDownloadTries]] **TestingMicrodescMaxDownloadTries** __NUM__::
2545     Try this often to download a microdesc descriptor before giving up.
2546     Changing this requires that **TestingTorNetwork** is set. (Default: 8)
2548 [[TestingCertMaxDownloadTries]] **TestingCertMaxDownloadTries** __NUM__::
2549     Try this often to download a v3 authority certificate before giving up.
2550     Changing this requires that **TestingTorNetwork** is set. (Default: 8)
2552 [[TestingDirAuthVoteExit]] **TestingDirAuthVoteExit** __node__,__node__,__...__::
2553     A list of identity fingerprints, country codes, and
2554     address patterns of nodes to vote Exit for regardless of their
2555     uptime, bandwidth, or exit policy. See the **ExcludeNodes**
2556     option for more information on how to specify nodes.
2558     In order for this option to have any effect, **TestingTorNetwork**
2559     has to be set. See the **ExcludeNodes** option for more
2560     information on how to specify nodes.
2562 [[TestingDirAuthVoteExitIsStrict]] **TestingDirAuthVoteExitIsStrict** **0**|**1** ::
2563     If True (1), a node will never receive the Exit flag unless it is specified
2564     in the **TestingDirAuthVoteExit** list, regardless of its uptime, bandwidth,
2565     or exit policy.
2567     In order for this option to have any effect, **TestingTorNetwork**
2568     has to be set.
2570 [[TestingDirAuthVoteGuard]] **TestingDirAuthVoteGuard** __node__,__node__,__...__::
2571     A list of identity fingerprints and country codes and
2572     address patterns of nodes to vote Guard for regardless of their
2573     uptime and bandwidth. See the **ExcludeNodes** option for more
2574     information on how to specify nodes.
2576     In order for this option to have any effect, **TestingTorNetwork**
2577     has to be set.
2579 [[TestingDirAuthVoteGuardIsStrict]] **TestingDirAuthVoteGuardIsStrict** **0**|**1** ::
2580     If True (1), a node will never receive the Guard flag unless it is specified
2581     in the **TestingDirAuthVoteGuard** list, regardless of its uptime and bandwidth.
2583     In order for this option to have any effect, **TestingTorNetwork**
2584     has to be set.
2586 [[TestingDirAuthVoteHSDir]] **TestingDirAuthVoteHSDir** __node__,__node__,__...__::
2587     A list of identity fingerprints and country codes and
2588     address patterns of nodes to vote HSDir for regardless of their
2589     uptime and DirPort. See the **ExcludeNodes** option for more
2590     information on how to specify nodes.
2592     In order for this option to have any effect, **TestingTorNetwork**
2593     must be set.
2595 [[TestingDirAuthVoteHSDirIsStrict]] **TestingDirAuthVoteHSDirIsStrict** **0**|**1** ::
2596     If True (1), a node will never receive the HSDir flag unless it is specified
2597     in the **TestingDirAuthVoteHSDir** list, regardless of its uptime and DirPort.
2599     In order for this option to have any effect, **TestingTorNetwork**
2600     has to be set.
2602 [[TestingEnableConnBwEvent]] **TestingEnableConnBwEvent** **0**|**1**::
2603     If this option is set, then Tor controllers may register for CONN_BW
2604     events.  Changing this requires that **TestingTorNetwork** is set.
2605     (Default: 0)
2607 [[TestingEnableCellStatsEvent]] **TestingEnableCellStatsEvent** **0**|**1**::
2608     If this option is set, then Tor controllers may register for CELL_STATS
2609     events.  Changing this requires that **TestingTorNetwork** is set.
2610     (Default: 0)
2612 [[TestingEnableTbEmptyEvent]] **TestingEnableTbEmptyEvent** **0**|**1**::
2613     If this option is set, then Tor controllers may register for TB_EMPTY
2614     events.  Changing this requires that **TestingTorNetwork** is set.
2615     (Default: 0)
2617 [[TestingMinExitFlagThreshold]] **TestingMinExitFlagThreshold**  __N__ **KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
2618     Sets a lower-bound for assigning an exit flag when running as an
2619     authority on a testing network. Overrides the usual default lower bound
2620     of 4 KB. (Default: 0)
2622 [[TestingLinkCertLifetime]] **TestingLinkCertLifetime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**|**months**::
2623     Overrides the default lifetime for the certificates used to authenticate
2624     our X509 link cert with our ed25519 signing key.
2625     (Default: 2 days)
2627 [[TestingAuthKeyLifetime]] **TestingAuthKeyLifetime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**|**months**::
2628     Overrides the default lifetime for a signing Ed25519 TLS Link authentication
2629     key.
2630     (Default: 2 days)
2632 [[TestingLinkKeySlop]] **TestingLinkKeySlop** __N__ **seconds**|**minutes**|**hours** +
2634 [[TestingAuthKeySlop]] **TestingAuthKeySlop** __N__ **seconds**|**minutes**|**hours** +
2636 [[TestingSigningKeySlop]] **TestingSigningKeySlop** __N__ **seconds**|**minutes**|**hours**::
2637     How early before the official expiration of a an Ed25519 signing key do
2638     we replace it and issue a new key?
2639     (Default: 3 hours for link and auth; 1 day for signing.)
2641 SIGNALS
2642 -------
2644 Tor catches the following signals:
2646 [[SIGTERM]] **SIGTERM**::
2647     Tor will catch this, clean up and sync to disk if necessary, and exit.
2649 [[SIGINT]] **SIGINT**::
2650     Tor clients behave as with SIGTERM; but Tor servers will do a controlled
2651     slow shutdown, closing listeners and waiting 30 seconds before exiting.
2652     (The delay can be configured with the ShutdownWaitLength config option.)
2654 [[SIGHUP]] **SIGHUP**::
2655     The signal instructs Tor to reload its configuration (including closing and
2656     reopening logs), and kill and restart its helper processes if applicable.
2658 [[SIGUSR1]] **SIGUSR1**::
2659     Log statistics about current connections, past connections, and throughput.
2661 [[SIGUSR2]] **SIGUSR2**::
2662     Switch all logs to loglevel debug. You can go back to the old loglevels by
2663     sending a SIGHUP.
2665 [[SIGCHLD]] **SIGCHLD**::
2666     Tor receives this signal when one of its helper processes has exited, so it
2667     can clean up.
2669 [[SIGPIPE]] **SIGPIPE**::
2670     Tor catches this signal and ignores it.
2672 [[SIGXFSZ]] **SIGXFSZ**::
2673     If this signal exists on your platform, Tor catches and ignores it.
2675 FILES
2676 -----
2678 **@CONFDIR@/torrc**::
2679     The configuration file, which contains "option value" pairs.
2681 **$HOME/.torrc**::
2682     Fallback location for torrc, if @CONFDIR@/torrc is not found.
2684 **@LOCALSTATEDIR@/lib/tor/**::
2685     The tor process stores keys and other data here.
2687 __DataDirectory__**/cached-status/**::
2688     The most recently downloaded network status document for each authority.
2689     Each file holds one such document; the filenames are the hexadecimal
2690     identity key fingerprints of the directory authorities.  Mostly obsolete.
2692 __DataDirectory__**/cached-certs**::
2693     This file holds downloaded directory key certificates that are used to
2694     verify authenticity of documents generated by Tor directory authorities.
2696 __DataDirectory__**/cached-consensus** and/or **cached-microdesc-consensus**::
2697     The most recent consensus network status document we've downloaded.
2699 __DataDirectory__**/cached-descriptors** and **cached-descriptors.new**::
2700     These files hold downloaded router statuses. Some routers may appear more
2701     than once; if so, the most recently published descriptor is used. Lines
2702     beginning with @-signs are annotations that contain more information about
2703     a given router. The ".new" file is an append-only journal; when it gets
2704     too large, all entries are merged into a new cached-descriptors file.
2706 __DataDirectory__**/cached-microdescs** and **cached-microdescs.new**::
2707     These files hold downloaded microdescriptors.  Lines beginning with
2708     @-signs are annotations that contain more information about a given
2709     router. The ".new" file is an append-only journal; when it gets too
2710     large, all entries are merged into a new cached-microdescs file.
2712 __DataDirectory__**/cached-routers** and **cached-routers.new**::
2713     Obsolete versions of cached-descriptors and cached-descriptors.new. When
2714     Tor can't find the newer files, it looks here instead.
2716 __DataDirectory__**/state**::
2717     A set of persistent key-value mappings. These are documented in
2718     the file. These include:
2719             - The current entry guards and their status.
2720             - The current bandwidth accounting values (unused so far; see
2721             below).
2722             - When the file was last written
2723             - What version of Tor generated the state file
2724             - A short history of bandwidth usage, as produced in the server
2725             descriptors.
2727 __DataDirectory__**/bw_accounting**::
2728     Used to track bandwidth accounting values (when the current period starts
2729     and ends; how much has been read and written so far this period). This file
2730     is obsolete, and the data is now stored in the \'state' file as well. Only
2731     used when bandwidth accounting is enabled.
2733 __DataDirectory__**/control_auth_cookie**::
2734     Used for cookie authentication with the controller. Location can be
2735     overridden by the CookieAuthFile config option. Regenerated on startup. See
2736     control-spec.txt in https://spec.torproject.org/[torspec] for details.
2737     Only used when cookie authentication is enabled.
2739 __DataDirectory__**/lock**::
2740     This file is used to prevent two Tor instances from using same data
2741     directory. If access to this file is locked, data directory is already
2742     in use by Tor.
2744 __DataDirectory__**/keys/***::
2745     Only used by servers. Holds identity keys and onion keys.
2747 __DataDirectory__**/keys/authority_identity_key**::
2748     A v3 directory authority's master identity key, used to authenticate its
2749     signing key. Tor doesn't use this while it's running. The tor-gencert
2750     program uses this. If you're running an authority, you should keep this
2751     key offline, and not actually put it here.
2753 __DataDirectory__**/keys/authority_certificate**::
2754     A v3 directory authority's certificate, which authenticates the authority's
2755     current vote- and consensus-signing key using its master identity key.
2756     Only directory authorities use this file.
2758 __DataDirectory__**/keys/authority_signing_key**::
2759     A v3 directory authority's signing key, used to sign votes and consensuses.
2760     Only directory authorities use this file.  Corresponds to the
2761     **authority_certificate** cert.
2763 __DataDirectory__**/keys/legacy_certificate**::
2764     As authority_certificate: used only when V3AuthUseLegacyKey is set.
2765     See documentation for V3AuthUseLegacyKey.
2767 __DataDirectory__**/keys/legacy_signing_key**::
2768     As authority_signing_key: used only when V3AuthUseLegacyKey is set.
2769     See documentation for V3AuthUseLegacyKey.
2771 __DataDirectory__**/keys/secret_id_key**::
2772     A relay's RSA1024 permanent identity key, including private and public
2773     components.  Used to sign router descriptors, and to sign other keys.
2775 __DataDirectory__**/keys/ed25519_master_id_public_key**::
2776     The public part of a relay's Ed25519 permanent identity key.
2778 __DataDirectory__**/keys/ed25519_master_id_secret_key**::
2779     The private part of a relay's Ed25519 permanent identity key.  This key
2780     is used to sign the medium-term ed25519 signing key.  This file can be
2781     kept offline, or kept encrypted. If so, Tor will not be able to generate
2782     new signing keys itself; you'll need to use tor --keygen yourself to do
2783     so.
2785 __DataDirectory__**/keys/ed25519_signing_secret_key**::
2786     The private and public components of a relay's medium-term Ed25519 signing
2787     key. This key is authenticated by the Ed25519 master key, in turn
2788     authenticates other keys (and router descriptors).
2790 __DataDirectory__**/keys/ed25519_signing_cert**::
2791     The certificate which authenticates "ed25519_signing_secret_key" as
2792     having been signed by the Ed25519 master key.
2794 __DataDirectory__**/keys/secret_onion_key**::
2795     A relay's RSA1024 short-term onion key. Used to decrypt old-style ("TAP")
2796     circuit extension requests.
2798 __DataDirectory__**/keys/secret_onion_key_ntor**::
2799     A relay's Curve25519 short-term onion key. Used to handle modern ("ntor")
2800     circuit extension requests.
2802 __DataDirectory__**/fingerprint**::
2803     Only used by servers. Holds the fingerprint of the server's identity key.
2805 __DataDirectory__**/hashed-fingerprint**::
2806     Only used by bridges. Holds the hashed fingerprint of the bridge's
2807     identity key. (That is, the hash of the hash of the identity key.)
2809 __DataDirectory__**/v3-status-votes**::
2810     Only for v3 authoritative directory servers. This file contains
2811     status votes from all the authoritative directory servers.
2813 __DataDirectory__**/unverified-consensus**::
2814     This file contains a network consensus document that has been downloaded,
2815     but which we didn't have the right certificates to check yet.
2817 __DataDirectory__**/unverified-microdesc-consensus**::
2818     This file contains a microdescriptor-flavored network consensus document
2819     that has been downloaded, but which we didn't have the right certificates
2820     to check yet.
2822 __DataDirectory__**/unparseable-desc**::
2823     Onion server descriptors that Tor was unable to parse are dumped to this
2824     file. Only used for debugging.
2826 __DataDirectory__**/router-stability**::
2827     Only used by authoritative directory servers. Tracks measurements for
2828     router mean-time-between-failures so that authorities have a good idea of
2829     how to set their Stable flags.
2831 __DataDirectory__**/stats/dirreq-stats**::
2832     Only used by directory caches and authorities. This file is used to
2833     collect directory request statistics.
2835 __DataDirectory__**/stats/entry-stats**::
2836     Only used by servers. This file is used to collect incoming connection
2837     statistics by Tor entry nodes.
2839 __DataDirectory__**/stats/bridge-stats**::
2840     Only used by servers. This file is used to collect incoming connection
2841     statistics by Tor bridges.
2843 __DataDirectory__**/stats/exit-stats**::
2844     Only used by servers. This file is used to collect outgoing connection
2845     statistics by Tor exit routers.
2847 __DataDirectory__**/stats/buffer-stats**::
2848     Only used by servers. This file is used to collect buffer usage
2849     history.
2851 __DataDirectory__**/stats/conn-stats**::
2852     Only used by servers. This file is used to collect approximate connection
2853     history (number of active connections over time).
2855 __DataDirectory__**/networkstatus-bridges**::
2856     Only used by authoritative bridge directories. Contains information
2857     about bridges that have self-reported themselves to the bridge
2858     authority.
2860 __HiddenServiceDirectory__**/hostname**::
2861     The <base32-encoded-fingerprint>.onion domain name for this hidden service.
2862     If the hidden service is restricted to authorized clients only, this file
2863     also contains authorization data for all clients.
2865 __HiddenServiceDirectory__**/private_key**::
2866     The private key for this hidden service.
2868 __HiddenServiceDirectory__**/client_keys**::
2869     Authorization data for a hidden service that is only accessible by
2870     authorized clients.
2872 SEE ALSO
2873 --------
2874 **torsocks**(1), **torify**(1) +
2876 **https://www.torproject.org/**
2878 **torspec: https://spec.torproject.org **
2880 BUGS
2881 ----
2883 Plenty, probably. Tor is still in development. Please report them at https://trac.torproject.org/.
2885 AUTHORS
2886 -------
2887 Roger Dingledine [arma at mit.edu], Nick Mathewson [nickm at alum.mit.edu].