doc/tor.1.txt

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