1 // Copyright (c) The Tor Project, Inc.
2 // See LICENSE for licensing information
3 // This is an asciidoc file used to generate the manpage/html reference.
4 // Learn asciidoc on http://www.methods.co.nz/asciidoc/userguide.html
6 :man manual: Tor Manual
12 tor - The second-generation onion router
17 **tor** [__OPTION__ __value__]...
21 __tor__ is a connection-oriented anonymizing communication
22 service. Users choose a source-routed path through a set of nodes, and
23 negotiate a "virtual circuit" through the network, in which each node
24 knows its predecessor and successor, but no others. Traffic flowing down
25 the circuit is unwrapped by a symmetric key at each node, which reveals
26 the downstream node. +
28 Basically __tor__ provides a distributed network of servers ("onion routers").
29 Users bounce their TCP streams -- web traffic, ftp, ssh, etc -- around the
30 routers, and recipients, observers, and even the routers themselves have
31 difficulty tracking the source of the stream.
35 [[opt-h]] **-h**, **-help**::
36 Display a short help message and exit.
38 [[opt-f]] **-f** __FILE__::
39 Specify a new configuration file to contain further Tor configuration
40 options. (Default: @CONFDIR@/torrc, or $HOME/.torrc if that file is not
43 [[opt-defaults-torrc]] **--defaults-torrc** __FILE__::
44 Specify a file in which to find default values for Tor options. The
45 contents of this file are overridden by those in the regular
46 configuration file, and by those on the command line. (Default:
47 @CONFDIR@/torrc-defaults.)
49 [[opt-hash-password]] **--hash-password**::
50 Generates a hashed password for control port access.
52 [[opt-list-fingerprint]] **--list-fingerprint**::
53 Generate your keys and output your nickname and fingerprint.
55 [[opt-verify-config]] **--verify-config**::
56 Verify the configuration file is valid.
58 [[opt-serviceinstall]] **--service install** [**--options** __command-line options__]::
59 Install an instance of Tor as a Windows service, with the provided
60 command-line options. Current instructions can be found at
61 https://trac.torproject.org/projects/tor/wiki/doc/TorFAQ#HowdoIrunmyTorrelayasanNTservice
63 [[opt-service]] **--service** **remove**|**start**|**stop**::
64 Remove, start, or stop a configured Tor Windows service.
66 [[opt-nt-service]] **--nt-service**::
67 Used internally to implement a Windows service.
69 [[opt-list-torrc-options]] **--list-torrc-options**::
70 List all valid options.
72 [[opt-version]] **--version**::
73 Display Tor version and exit.
75 [[opt-quiet]] **--quiet**|**--hush**::
76 Override the default console log. By default, Tor starts out logging
77 messages at level "notice" and higher to the console. It stops doing so
78 after it parses its configuration, if the configuration tells it to log
79 anywhere else. You can override this behavior with the **--hush** option,
80 which tells Tor to only send warnings and errors to the console, or with
81 the **--quiet** option, which tells Tor not to log to the console at all.
83 Other options can be specified on the command-line in the format "--option
84 value", in the format "option value", or in a configuration file. For
85 instance, you can tell Tor to start listening for SOCKS connections on port
86 9999 by passing --SOCKSPort 9999 or SOCKSPort 9999 to it on the command line,
87 or by putting "SOCKSPort 9999" in the configuration file. You will need to
88 quote options with spaces in them: if you want Tor to log all debugging
89 messages to debug.log, you will probably need to say --Log 'debug file
92 Options on the command line override those in configuration files. See the
93 next section for more information.
95 THE CONFIGURATION FILE FORMAT
96 -----------------------------
98 All configuration options in a configuration are written on a single line by
99 default. They take the form of an option name and a value, or an option name
100 and a quoted value (option value or option "value"). Anything after a #
101 character is treated as a comment. Options are
102 case-insensitive. C-style escaped characters are allowed inside quoted
103 values. To split one configuration entry into multiple lines, use a single
104 backslash character (\) before the end of the line. Comments can be used in
105 such multiline entries, but they must start at the beginning of a line.
107 By default, an option on the command line overrides an option found in the
108 configuration file, and an option in a configuration file overrides one in
111 This rule is simple for options that take a single value, but it can become
112 complicated for options that are allowed to occur more than once: if you
113 specify four SOCKSPorts in your configuration file, and one more SOCKSPort on
114 the command line, the option on the command line will replace __all__ of the
115 SOCKSPorts in the configuration file. If this isn't what you want, prefix
116 the option name with a plus sign, and it will be appended to the previous set
119 Alternatively, you might want to remove every instance of an option in the
120 configuration file, and not replace it at all: you might want to say on the
121 command line that you want no SOCKSPorts at all. To do that, prefix the
122 option name with a forward slash.
127 [[BandwidthRate]] **BandwidthRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**::
128 A token bucket limits the average incoming bandwidth usage on this node to
129 the specified number of bytes per second, and the average outgoing
130 bandwidth usage to that same value. If you want to run a relay in the
131 public network, this needs to be _at the very least_ 30 KBytes (that is,
132 30720 bytes). (Default: 1 GByte)
134 [[BandwidthBurst]] **BandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**::
135 Limit the maximum token bucket size (also known as the burst) to the given
136 number of bytes in each direction. (Default: 1 GByte)
138 [[MaxAdvertisedBandwidth]] **MaxAdvertisedBandwidth** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**::
139 If set, we will not advertise more than this amount of bandwidth for our
140 BandwidthRate. Server operators who want to reduce the number of clients
141 who ask to build circuits through them (since this is proportional to
142 advertised bandwidth rate) can thus reduce the CPU demands on their server
143 without impacting network performance.
145 [[RelayBandwidthRate]] **RelayBandwidthRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**::
146 If not 0, a separate token bucket limits the average incoming bandwidth
147 usage for \_relayed traffic_ on this node to the specified number of bytes
148 per second, and the average outgoing bandwidth usage to that same value.
149 Relayed traffic currently is calculated to include answers to directory
150 requests, but that may change in future versions. (Default: 0)
152 [[RelayBandwidthBurst]] **RelayBandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**::
153 If not 0, limit the maximum token bucket size (also known as the burst) for
154 \_relayed traffic_ to the given number of bytes in each direction.
157 [[PerConnBWRate]] **PerConnBWRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**::
158 If set, do separate rate limiting for each connection from a non-relay.
159 You should never need to change this value, since a network-wide value is
160 published in the consensus and your relay will use that value. (Default: 0)
162 [[PerConnBWBurst]] **PerConnBWBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**::
163 If set, do separate rate limiting for each connection from a non-relay.
164 You should never need to change this value, since a network-wide value is
165 published in the consensus and your relay will use that value. (Default: 0)
167 [[ClientTransportPlugin]] **ClientTransportPlugin** __transport__ socks4|socks5 __IP__:__PORT__::
168 **ClientTransportPlugin** __transport__ exec __path-to-binary__ [options]::
169 In its first form, when set along with a corresponding Bridge line, the Tor
170 client forwards its traffic to a SOCKS-speaking proxy on "IP:PORT". It's the
171 duty of that proxy to properly forward the traffic to the bridge. +
173 In its second form, when set along with a corresponding Bridge line, the Tor
174 client launches the pluggable transport proxy executable in
175 __path-to-binary__ using __options__ as its command-line options, and
176 forwards its traffic to it. It's the duty of that proxy to properly forward
177 the traffic to the bridge.
179 [[ServerTransportPlugin]] **ServerTransportPlugin** __transport__ exec __path-to-binary__ [options]::
180 The Tor relay launches the pluggable transport proxy in __path-to-binary__
181 using __options__ as its command-line options, and expects to receive
182 proxied client traffic from it.
184 [[ServerTransportListenAddr]] **ServerTransportListenAddr** __transport__ __IP__:__PORT__::
185 When this option is set, Tor will suggest __IP__:__PORT__ as the
186 listening address of any pluggable transport proxy that tries to
187 launch __transport__.
189 [[ConnLimit]] **ConnLimit** __NUM__::
190 The minimum number of file descriptors that must be available to the Tor
191 process before it will start. Tor will ask the OS for as many file
192 descriptors as the OS will allow (you can find this by "ulimit -H -n").
193 If this number is less than ConnLimit, then Tor will refuse to start. +
195 You probably don't need to adjust this. It has no effect on Windows
196 since that platform lacks getrlimit(). (Default: 1000)
198 [[DisableNetwork]] **DisableNetwork** **0**|**1**::
199 When this option is set, we don't listen for or accept any connections
200 other than controller connections, and we don't make any outbound
201 connections. Controllers sometimes use this option to avoid using
202 the network until Tor is fully configured. (Default: 0)
204 [[ConstrainedSockets]] **ConstrainedSockets** **0**|**1**::
205 If set, Tor will tell the kernel to attempt to shrink the buffers for all
206 sockets to the size specified in **ConstrainedSockSize**. This is useful for
207 virtual servers and other environments where system level TCP buffers may
208 be limited. If you're on a virtual server, and you encounter the "Error
209 creating network socket: No buffer space available" message, you are
210 likely experiencing this problem. +
212 The preferred solution is to have the admin increase the buffer pool for
213 the host itself via /proc/sys/net/ipv4/tcp_mem or equivalent facility;
214 this configuration option is a second-resort. +
216 The DirPort option should also not be used if TCP buffers are scarce. The
217 cached directory requests consume additional sockets which exacerbates
220 You should **not** enable this feature unless you encounter the "no buffer
221 space available" issue. Reducing the TCP buffers affects window size for
222 the TCP stream and will reduce throughput in proportion to round trip
223 time on long paths. (Default: 0)
225 [[ConstrainedSockSize]] **ConstrainedSockSize** __N__ **bytes**|**KBytes**::
226 When **ConstrainedSockets** is enabled the receive and transmit buffers for
227 all sockets will be set to this limit. Must be a value between 2048 and
228 262144, in 1024 byte increments. Default of 8192 is recommended.
230 [[ControlPort]] **ControlPort** __PORT__|**auto**::
231 If set, Tor will accept connections on this port and allow those
232 connections to control the Tor process using the Tor Control Protocol
233 (described in control-spec.txt). Note: unless you also specify one or
234 more of **HashedControlPassword** or **CookieAuthentication**,
235 setting this option will cause Tor to allow any process on the local
236 host to control it. (Setting both authentication methods means either
237 method is sufficient to authenticate to Tor.) This
238 option is required for many Tor controllers; most use the value of 9051.
239 Set it to "auto" to have Tor pick a port for you. (Default: 0)
241 [[ControlListenAddress]] **ControlListenAddress** __IP__[:__PORT__]::
242 Bind the controller listener to this address. If you specify a port, bind
243 to this port rather than the one specified in ControlPort. We strongly
244 recommend that you leave this alone unless you know what you're doing,
245 since giving attackers access to your control listener is really
246 dangerous. This directive can be specified multiple
247 times to bind to multiple addresses/ports. (Default: 127.0.0.1)
249 [[ControlSocket]] **ControlSocket** __Path__::
250 Like ControlPort, but listens on a Unix domain socket, rather than a TCP
251 socket. (Unix and Unix-like systems only.)
253 [[ControlSocketsGroupWritable]] **ControlSocketsGroupWritable** **0**|**1**::
254 If this option is set to 0, don't allow the filesystem group to read and
255 write unix sockets (e.g. ControlSocket). If the option is set to 1, make
256 the control socket readable and writable by the default GID. (Default: 0)
258 [[HashedControlPassword]] **HashedControlPassword** __hashed_password__::
259 Allow connections on the control port if they present
260 the password whose one-way hash is __hashed_password__. You
261 can compute the hash of a password by running "tor --hash-password
262 __password__". You can provide several acceptable passwords by using more
263 than one HashedControlPassword line.
265 [[CookieAuthentication]] **CookieAuthentication** **0**|**1**::
266 If this option is set to 1, allow connections on the control port
267 when the connecting process knows the contents of a file named
268 "control_auth_cookie", which Tor will create in its data directory. This
269 authentication method should only be used on systems with good filesystem
270 security. (Default: 0)
272 [[CookieAuthFile]] **CookieAuthFile** __Path__::
273 If set, this option overrides the default location and file name
274 for Tor's cookie file. (See CookieAuthentication above.)
276 [[CookieAuthFileGroupReadable]] **CookieAuthFileGroupReadable** **0**|**1**|__Groupname__::
277 If this option is set to 0, don't allow the filesystem group to read the
278 cookie file. If the option is set to 1, make the cookie file readable by
279 the default GID. [Making the file readable by other groups is not yet
280 implemented; let us know if you need this for some reason.] (Default: 0)
282 [[ControlPortWriteToFile]] **ControlPortWriteToFile** __Path__::
283 If set, Tor writes the address and port of any control port it opens to
284 this address. Usable by controllers to learn the actual control port
285 when ControlPort is set to "auto".
287 [[ControlPortFileGroupReadable]] **ControlPortFileGroupReadable** **0**|**1**::
288 If this option is set to 0, don't allow the filesystem group to read the
289 control port file. If the option is set to 1, make the control port
290 file readable by the default GID. (Default: 0)
292 [[DataDirectory]] **DataDirectory** __DIR__::
293 Store working data in DIR (Default: @LOCALSTATEDIR@/lib/tor)
295 [[FallbackDir]] **FallbackDir** __address__:__port__ orport=__port__ id=__fingerprint__ [weight=__num__]::
296 When we're unable to connect to any directory cache for directory info
297 (usually because we don't know about any yet) we try a FallbackDir.
298 By default, the directory authorities are also FallbackDirs.
300 [[DirAuthority]] **DirAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__::
301 Use a nonstandard authoritative directory server at the provided address
302 and port, with the specified key fingerprint. This option can be repeated
303 many times, for multiple authoritative directory servers. Flags are
304 separated by spaces, and determine what kind of an authority this directory
305 is. By default, every authority is authoritative for current ("v2")-style
306 directories, unless the "no-v2" flag is given. If the "v1" flags is
307 provided, Tor will use this server as an authority for old-style (v1)
308 directories as well. (Only directory mirrors care about this.) Tor will
309 use this server as an authority for hidden service information if the "hs"
310 flag is set, or if the "v1" flag is set and the "no-hs" flag is **not** set.
311 Tor will use this authority as a bridge authoritative directory if the
312 "bridge" flag is set. If a flag "orport=**port**" is given, Tor will use the
313 given port when opening encrypted tunnels to the dirserver. If a flag
314 "weight=**num**" is given, then the directory server is chosen randomly
315 with probability proportional to that weight (default 1.0). Lastly, if a
316 flag "v3ident=**fp**" is given, the dirserver is a v3 directory authority
317 whose v3 long-term signing key has the fingerprint **fp**. +
319 If no **DirAuthority** line is given, Tor will use the default directory
320 authorities. NOTE: this option is intended for setting up a private Tor
321 network with its own directory authorities. If you use it, you will be
322 distinguishable from other users, because you won't believe the same
325 [[DirAuthorityFallbackRate]] **DirAuthorityFallbackRate** __NUM__::
326 When configured to use both directory authorities and fallback
327 directories, the directory authorities also work as fallbacks. They are
328 chosen with their regular weights, multiplied by this number, which
329 should be 1.0 or less. (Default: 1.0)
331 [[DynamicDHGroups]] **DynamicDHGroups** **0**|**1**::
332 If this option is set to 1, when running as a server, generate our
333 own Diffie-Hellman group instead of using the one from Apache's mod_ssl.
334 This option may help circumvent censorship based on static
335 Diffie-Hellman parameters. (Default: 0)
337 [[AlternateDirAuthority]] **AlternateDirAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__ +
339 [[AlternateHSAuthority]] **AlternateHSAuthority** [__nickname__] [**flags**] __address__:__port__ __fingerprint__ +
341 [[AlternateBridgeAuthority]] **AlternateBridgeAuthority** [__nickname__] [**flags**] __address__:__port__ __ fingerprint__::
342 These options behave as DirAuthority, but they replace fewer of the
343 default directory authorities. Using
344 AlternateDirAuthority replaces the default Tor directory authorities, but
345 leaves the default hidden service authorities and bridge authorities in
346 place. Similarly, AlternateHSAuthority replaces the default hidden
347 service authorities, but not the directory or bridge authorities; and
348 AlternateBridgeAuthority replaces the default bridge authority,
349 but leaves the directory and hidden service authorities alone.
351 [[DisableAllSwap]] **DisableAllSwap** **0**|**1**::
352 If set to 1, Tor will attempt to lock all current and future memory pages,
353 so that memory cannot be paged out. Windows, OS X and Solaris are currently
354 not supported. We believe that this feature works on modern Gnu/Linux
355 distributions, and that it should work on *BSD systems (untested). This
356 option requires that you start your Tor as root, and you should use the
357 **User** option to properly reduce Tor's privileges. (Default: 0)
359 [[DisableDebuggerAttachment]] **DisableDebuggerAttachment** **0**|**1**::
360 If set to 1, Tor will attempt to prevent basic debugging attachment attempts
361 by other processes. This may also keep Tor from generating core files if
362 it crashes. It has no impact for users who wish to attach if they
363 have CAP_SYS_PTRACE or if they are root. We believe that this feature
364 works on modern Gnu/Linux distributions, and that it may also work on *BSD
365 systems (untested). Some modern Gnu/Linux systems such as Ubuntu have the
366 kernel.yama.ptrace_scope sysctl and by default enable it as an attempt to
367 limit the PTRACE scope for all user processes by default. This feature will
368 attempt to limit the PTRACE scope for Tor specifically - it will not attempt
369 to alter the system wide ptrace scope as it may not even exist. If you wish
370 to attach to Tor with a debugger such as gdb or strace you will want to set
371 this to 0 for the duration of your debugging. Normal users should leave it
372 on. Disabling this option while Tor is running is prohibited. (Default: 1)
374 [[FetchDirInfoEarly]] **FetchDirInfoEarly** **0**|**1**::
375 If set to 1, Tor will always fetch directory information like other
376 directory caches, even if you don't meet the normal criteria for fetching
377 early. Normal users should leave it off. (Default: 0)
379 [[FetchDirInfoExtraEarly]] **FetchDirInfoExtraEarly** **0**|**1**::
380 If set to 1, Tor will fetch directory information before other directory
381 caches. It will attempt to download directory information closer to the
382 start of the consensus period. Normal users should leave it off.
385 [[FetchHidServDescriptors]] **FetchHidServDescriptors** **0**|**1**::
386 If set to 0, Tor will never fetch any hidden service descriptors from the
387 rendezvous directories. This option is only useful if you're using a Tor
388 controller that handles hidden service fetches for you. (Default: 1)
390 [[FetchServerDescriptors]] **FetchServerDescriptors** **0**|**1**::
391 If set to 0, Tor will never fetch any network status summaries or server
392 descriptors from the directory servers. This option is only useful if
393 you're using a Tor controller that handles directory fetches for you.
396 [[FetchUselessDescriptors]] **FetchUselessDescriptors** **0**|**1**::
397 If set to 1, Tor will fetch every non-obsolete descriptor from the
398 authorities that it hears about. Otherwise, it will avoid fetching useless
399 descriptors, for example for routers that are not running. This option is
400 useful if you're using the contributed "exitlist" script to enumerate Tor
401 nodes that exit to certain addresses. (Default: 0)
403 [[HTTPProxy]] **HTTPProxy** __host__[:__port__]::
404 Tor will make all its directory requests through this host:port (or host:80
405 if port is not specified), rather than connecting directly to any directory
408 [[HTTPProxyAuthenticator]] **HTTPProxyAuthenticator** __username:password__::
409 If defined, Tor will use this username:password for Basic HTTP proxy
410 authentication, as in RFC 2617. This is currently the only form of HTTP
411 proxy authentication that Tor supports; feel free to submit a patch if you
412 want it to support others.
414 [[HTTPSProxy]] **HTTPSProxy** __host__[:__port__]::
415 Tor will make all its OR (SSL) connections through this host:port (or
416 host:443 if port is not specified), via HTTP CONNECT rather than connecting
417 directly to servers. You may want to set **FascistFirewall** to restrict
418 the set of ports you might try to connect to, if your HTTPS proxy only
419 allows connecting to certain ports.
421 [[HTTPSProxyAuthenticator]] **HTTPSProxyAuthenticator** __username:password__::
422 If defined, Tor will use this username:password for Basic HTTPS proxy
423 authentication, as in RFC 2617. This is currently the only form of HTTPS
424 proxy authentication that Tor supports; feel free to submit a patch if you
425 want it to support others.
427 [[Socks4Proxy]] **Socks4Proxy** __host__[:__port__]::
428 Tor will make all OR connections through the SOCKS 4 proxy at host:port
429 (or host:1080 if port is not specified).
431 [[Socks5Proxy]] **Socks5Proxy** __host__[:__port__]::
432 Tor will make all OR connections through the SOCKS 5 proxy at host:port
433 (or host:1080 if port is not specified).
435 [[Socks5ProxyUsername]] **Socks5ProxyUsername** __username__ +
437 [[Socks5ProxyPassword]] **Socks5ProxyPassword** __password__::
438 If defined, authenticate to the SOCKS 5 server using username and password
439 in accordance to RFC 1929. Both username and password must be between 1 and
442 [[KeepalivePeriod]] **KeepalivePeriod** __NUM__::
443 To keep firewalls from expiring connections, send a padding keepalive cell
444 every NUM seconds on open connections that are in use. If the connection
445 has no open circuits, it will instead be closed after NUM seconds of
446 idleness. (Default: 5 minutes)
448 [[Log]] **Log** __minSeverity__[-__maxSeverity__] **stderr**|**stdout**|**syslog**::
449 Send all messages between __minSeverity__ and __maxSeverity__ to the standard
450 output stream, the standard error stream, or to the system log. (The
451 "syslog" value is only supported on Unix.) Recognized severity levels are
452 debug, info, notice, warn, and err. We advise using "notice" in most cases,
453 since anything more verbose may provide sensitive information to an
454 attacker who obtains the logs. If only one severity level is given, all
455 messages of that level or higher will be sent to the listed destination.
457 **Log** __minSeverity__[-__maxSeverity__] **file** __FILENAME__::
458 As above, but send log messages to the listed filename. The
459 "Log" option may appear more than once in a configuration file.
460 Messages are sent to all the logs that match their severity
463 **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **file** __FILENAME__ +
465 **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **stderr**|**stdout**|**syslog**::
466 As above, but select messages by range of log severity __and__ by a
467 set of "logging domains". Each logging domain corresponds to an area of
468 functionality inside Tor. You can specify any number of severity ranges
469 for a single log statement, each of them prefixed by a comma-separated
470 list of logging domains. You can prefix a domain with $$~$$ to indicate
471 negation, and use * to indicate "all domains". If you specify a severity
472 range without a list of domains, it matches all domains. +
474 This is an advanced feature which is most useful for debugging one or two
475 of Tor's subsystems at a time. +
477 The currently recognized domains are: general, crypto, net, config, fs,
478 protocol, mm, http, app, control, circ, rend, bug, dir, dirserv, or, edge,
479 acct, hist, and handshake. Domain names are case-insensitive. +
481 For example, "`Log [handshake]debug [~net,~mm]info notice stdout`" sends
482 to stdout: all handshake messages of any severity, all info-and-higher
483 messages from domains other than networking and memory management, and all
484 messages of severity notice or higher.
486 [[LogMessageDomains]] **LogMessageDomains** **0**|**1**::
487 If 1, Tor includes message domains with each log message. Every log
488 message currently has at least one domain; most currently have exactly
489 one. This doesn't affect controller log messages. (Default: 0)
491 [[OutboundBindAddress]] **OutboundBindAddress** __IP__::
492 Make all outbound connections originate from the IP address specified. This
493 is only useful when you have multiple network interfaces, and you want all
494 of Tor's outgoing connections to use a single one. This option may
495 be used twice, once with an IPv4 address and once with an IPv6 address.
496 This setting will be ignored for connections to the loopback addresses
497 (127.0.0.0/8 and ::1).
499 [[PidFile]] **PidFile** __FILE__::
500 On startup, write our PID to FILE. On clean shutdown, remove
503 [[ProtocolWarnings]] **ProtocolWarnings** **0**|**1**::
504 If 1, Tor will log with severity \'warn' various cases of other parties not
505 following the Tor specification. Otherwise, they are logged with severity
506 \'info'. (Default: 0)
508 [[RunAsDaemon]] **RunAsDaemon** **0**|**1**::
509 If 1, Tor forks and daemonizes to the background. This option has no effect
510 on Windows; instead you should use the --service command-line option.
513 [[LogTimeGranularity]] **LogTimeGranularity** __NUM__::
514 Set the resolution of timestamps in Tor's logs to NUM milliseconds.
515 NUM must be positive and either a divisor or a multiple of 1 second.
516 Note that this option only controls the granularity written by Tor to
517 a file or console log. Tor does not (for example) "batch up" log
518 messages to affect times logged by a controller, times attached to
519 syslog messages, or the mtime fields on log files. (Default: 1 second)
521 [[SafeLogging]] **SafeLogging** **0**|**1**|**relay**::
522 Tor can scrub potentially sensitive strings from log messages (e.g.
523 addresses) by replacing them with the string [scrubbed]. This way logs can
524 still be useful, but they don't leave behind personally identifying
525 information about what sites a user might have visited. +
527 If this option is set to 0, Tor will not perform any scrubbing, if it is
528 set to 1, all potentially sensitive strings are replaced. If it is set to
529 relay, all log messages generated when acting as a relay are sanitized, but
530 all messages generated when acting as a client are not. (Default: 1)
532 [[User]] **User** __UID__::
533 On startup, setuid to this user and setgid to their primary group.
535 [[HardwareAccel]] **HardwareAccel** **0**|**1**::
536 If non-zero, try to use built-in (static) crypto hardware acceleration when
537 available. (Default: 0)
539 [[AccelName]] **AccelName** __NAME__::
540 When using OpenSSL hardware crypto acceleration attempt to load the dynamic
541 engine of this name. This must be used for any dynamic hardware engine.
542 Names can be verified with the openssl engine command.
544 [[AccelDir]] **AccelDir** __DIR__::
545 Specify this option if using dynamic hardware acceleration and the engine
546 implementation library resides somewhere other than the OpenSSL default.
548 [[AvoidDiskWrites]] **AvoidDiskWrites** **0**|**1**::
549 If non-zero, try to write to disk less frequently than we would otherwise.
550 This is useful when running on flash memory or other media that support
551 only a limited number of writes. (Default: 0)
553 [[TunnelDirConns]] **TunnelDirConns** **0**|**1**::
554 If non-zero, when a directory server we contact supports it, we will build
555 a one-hop circuit and make an encrypted connection via its ORPort.
558 [[PreferTunneledDirConns]] **PreferTunneledDirConns** **0**|**1**::
559 If non-zero, we will avoid directory servers that don't support tunneled
560 directory connections, when possible. (Default: 1)
562 [[CircuitPriorityHalflife]] **CircuitPriorityHalflife** __NUM1__::
563 If this value is set, we override the default algorithm for choosing which
564 circuit's cell to deliver or relay next. When the value is 0, we
565 round-robin between the active circuits on a connection, delivering one
566 cell from each in turn. When the value is positive, we prefer delivering
567 cells from whichever connection has the lowest weighted cell count, where
568 cells are weighted exponentially according to the supplied
569 CircuitPriorityHalflife value (in seconds). If this option is not set at
570 all, we use the behavior recommended in the current consensus
571 networkstatus. This is an advanced option; you generally shouldn't have
572 to mess with it. (Default: not set)
574 [[DisableIOCP]] **DisableIOCP** **0**|**1**::
575 If Tor was built to use the Libevent's "bufferevents" networking code
576 and you're running on Windows, setting this option to 1 will tell Libevent
577 not to use the Windows IOCP networking API. (Default: 1)
579 [[UserspaceIOCPBuffers]] **UserspaceIOCPBuffers** **0**|**1**::
580 If IOCP is enabled (see DisableIOCP above), setting this option to 1
581 will tell Tor to disable kernel-space TCP buffers, in order to avoid
582 needless copy operations and try not to run out of non-paged RAM.
583 This feature is experimental; don't use it yet unless you're eager to
584 help tracking down bugs. (Default: 0)
586 [[_UseFilteringSSLBufferevents]] **_UseFilteringSSLBufferevents** **0**|**1**::
587 Tells Tor to do its SSL communication using a chain of
588 bufferevents: one for SSL and one for networking. This option has no
589 effect if bufferevents are disabled (in which case it can't turn on), or
590 if IOCP bufferevents are enabled (in which case it can't turn off). This
591 option is useful for debugging only; most users shouldn't touch it.
594 [[CountPrivateBandwidth]] **CountPrivateBandwidth** **0**|**1**::
595 If this option is set, then Tor's rate-limiting applies not only to
596 remote connections, but also to connections to private addresses like
597 127.0.0.1 or 10.0.0.1. This is mostly useful for debugging
598 rate-limiting. (Default: 0)
603 The following options are useful only for clients (that is, if
604 [[SocksPort]] **SocksPort**, **TransPort**, **DNSPort**, or **NATDPort** is non-zero):
606 [[AllowInvalidNodes]] **AllowInvalidNodes** **entry**|**exit**|**middle**|**introduction**|**rendezvous**|**...**::
607 If some Tor servers are obviously not working right, the directory
608 authorities can manually mark them as invalid, meaning that it's not
609 recommended you use them for entry or exit positions in your circuits. You
610 can opt to use them in some circuit positions, though. The default is
611 "middle,rendezvous", and other choices are not advised.
613 [[ExcludeSingleHopRelays]] **ExcludeSingleHopRelays** **0**|**1**::
614 This option controls whether circuits built by Tor will include relays with
615 the AllowSingleHopExits flag set to true. If ExcludeSingleHopRelays is set
616 to 0, these relays will be included. Note that these relays might be at
617 higher risk of being seized or observed, so they are not normally
618 included. Also note that relatively few clients turn off this option,
619 so using these relays might make your client stand out.
622 [[Bridge]] **Bridge** [__transport__] __IP__:__ORPort__ [__fingerprint__]::
623 When set along with UseBridges, instructs Tor to use the relay at
624 "IP:ORPort" as a "bridge" relaying into the Tor network. If "fingerprint"
625 is provided (using the same format as for DirAuthority), we will verify that
626 the relay running at that location has the right fingerprint. We also use
627 fingerprint to look up the bridge descriptor at the bridge authority, if
628 it's provided and if UpdateBridgesFromAuthority is set too. +
630 If "transport" is provided, and matches to a ClientTransportPlugin
631 line, we use that pluggable transports proxy to transfer data to
634 [[LearnCircuitBuildTimeout]] **LearnCircuitBuildTimeout** **0**|**1**::
635 If 0, CircuitBuildTimeout adaptive learning is disabled. (Default: 1)
637 [[CircuitBuildTimeout]] **CircuitBuildTimeout** __NUM__::
639 Try for at most NUM seconds when building circuits. If the circuit isn't
640 open in that time, give up on it. If LearnCircuitBuildTimeout is 1, this
641 value serves as the initial value to use before a timeout is learned. If
642 LearnCircuitBuildTimeout is 0, this value is the only value used.
643 (Default: 60 seconds)
645 [[CircuitIdleTimeout]] **CircuitIdleTimeout** __NUM__::
646 If we have kept a clean (never used) circuit around for NUM seconds, then
647 close it. This way when the Tor client is entirely idle, it can expire all
648 of its circuits, and then expire its TLS connections. Also, if we end up
649 making a circuit that is not useful for exiting any of the requests we're
650 receiving, it won't forever take up a slot in the circuit list. (Default: 1
653 [[CircuitStreamTimeout]] **CircuitStreamTimeout** __NUM__::
654 If non-zero, this option overrides our internal timeout schedule for how
655 many seconds until we detach a stream from a circuit and try a new circuit.
656 If your network is particularly slow, you might want to set this to a
657 number like 60. (Default: 0)
659 [[ClientOnly]] **ClientOnly** **0**|**1**::
660 If set to 1, Tor will under no circumstances run as a relay or serve
661 directory requests. This config option is mostly meaningless: we
662 added it back when we were considering having Tor clients auto-promote
663 themselves to being relays if they were stable and fast enough. The
664 current behavior is simply that Tor is a client unless ORPort or
665 DirPort are configured. (Default: 0)
667 [[ExcludeNodes]] **ExcludeNodes** __node__,__node__,__...__::
668 A list of identity fingerprints, nicknames, country codes and address
669 patterns of nodes to avoid when building a circuit.
671 ExcludeNodes SlowServer, ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) +
673 By default, this option is treated as a preference that Tor is allowed
674 to override in order to keep working.
675 For example, if you try to connect to a hidden service,
676 but you have excluded all of the hidden service's introduction points,
677 Tor will connect to one of them anyway. If you do not want this
678 behavior, set the StrictNodes option (documented below). +
680 Note also that if you are a relay, this (and the other node selection
681 options below) only affects your own circuits that Tor builds for you.
682 Clients can still build circuits through you to any node. Controllers
683 can tell Tor to build circuits through any node. +
685 Country codes are case-insensitive. The code "\{??}" refers to nodes whose
686 country can't be identified. No country code, including \{??}, works if
687 no GeoIPFile can be loaded. See also the GeoIPExcludeUnknown option below.
690 [[ExcludeExitNodes]] **ExcludeExitNodes** __node__,__node__,__...__::
691 A list of identity fingerprints, nicknames, country codes and address
692 patterns of nodes to never use when picking an exit node---that is, a
693 node that delivers traffic for you outside the Tor network. Note that any
694 node listed in ExcludeNodes is automatically considered to be part of this
695 list too. See also the caveats on the "ExitNodes" option below.
697 [[GeoIPExcludeUnknown]] **GeoIPExcludeUnknown** **0**|**1**|**auto**::
698 If this option is set to 'auto', then whenever any country code is set in
699 ExcludeNodes or ExcludeExitNodes, all nodes with unknown country (\{??} and
700 possibly \{A1}) are treated as excluded as well. If this option is set to
701 '1', then all unknown countries are treated as excluded in ExcludeNodes
702 and ExcludeExitNodes. This option has no effect when a GeoIP file isn't
703 configured or can't be found. (Default: auto)
705 [[ExitNodes]] **ExitNodes** __node__,__node__,__...__::
706 A list of identity fingerprints, nicknames, country codes and address
707 patterns of nodes to use as exit node---that is, a
708 node that delivers traffic for you outside the Tor network. +
710 Note that if you list too few nodes here, or if you exclude too many exit
711 nodes with ExcludeExitNodes, you can degrade functionality. For example,
712 if none of the exits you list allows traffic on port 80 or 443, you won't
713 be able to browse the web. +
715 Note also that not every circuit is used to deliver traffic outside of
716 the Tor network. It is normal to see non-exit circuits (such as those
717 used to connect to hidden services, those that do directory fetches,
718 those used for relay reachability self-tests, and so on) that end
719 at a non-exit node. To
720 keep a node from being used entirely, see ExcludeNodes and StrictNodes. +
722 The ExcludeNodes option overrides this option: any node listed in both
723 ExitNodes and ExcludeNodes is treated as excluded. +
725 The .exit address notation, if enabled via AllowDotExit, overrides
728 [[EntryNodes]] **EntryNodes** __node__,__node__,__...__::
729 A list of identity fingerprints, nicknames, and country codes of nodes
730 to use for the first hop in your normal circuits.
731 Normal circuits include all
732 circuits except for direct connections to directory servers. The Bridge
733 option overrides this option; if you have configured bridges and
734 UseBridges is 1, the Bridges are used as your entry nodes. +
736 The ExcludeNodes option overrides this option: any node listed in both
737 EntryNodes and ExcludeNodes is treated as excluded.
739 [[StrictNodes]] **StrictNodes** **0**|**1**::
740 If StrictNodes is set to 1, Tor will treat the ExcludeNodes option as a
741 requirement to follow for all the circuits you generate, even if doing so
742 will break functionality for you. If StrictNodes is set to 0, Tor will
743 still try to avoid nodes in the ExcludeNodes list, but it will err on the
744 side of avoiding unexpected errors. Specifically, StrictNodes 0 tells
745 Tor that it is okay to use an excluded node when it is *necessary* to
746 perform relay reachability self-tests, connect to
747 a hidden service, provide a hidden service to a client, fulfill a .exit
748 request, upload directory information, or download directory information.
751 [[FascistFirewall]] **FascistFirewall** **0**|**1**::
752 If 1, Tor will only create outgoing connections to ORs running on ports
753 that your firewall allows (defaults to 80 and 443; see **FirewallPorts**).
754 This will allow you to run Tor as a client behind a firewall with
755 restrictive policies, but will not allow you to run as a server behind such
756 a firewall. If you prefer more fine-grained control, use
757 ReachableAddresses instead.
759 [[FirewallPorts]] **FirewallPorts** __PORTS__::
760 A list of ports that your firewall allows you to connect to. Only used when
761 **FascistFirewall** is set. This option is deprecated; use ReachableAddresses
762 instead. (Default: 80, 443)
764 [[ReachableAddresses]] **ReachableAddresses** __ADDR__[/__MASK__][:__PORT__]...::
765 A comma-separated list of IP addresses and ports that your firewall allows
766 you to connect to. The format is as for the addresses in ExitPolicy, except
767 that "accept" is understood unless "reject" is explicitly provided. For
768 example, \'ReachableAddresses 99.0.0.0/8, reject 18.0.0.0/8:80, accept
769 \*:80' means that your firewall allows connections to everything inside net
770 99, rejects port 80 connections to net 18, and accepts connections to port
771 80 otherwise. (Default: \'accept \*:*'.)
773 [[ReachableDirAddresses]] **ReachableDirAddresses** __ADDR__[/__MASK__][:__PORT__]...::
774 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
775 these restrictions when fetching directory information, using standard HTTP
776 GET requests. If not set explicitly then the value of
777 **ReachableAddresses** is used. If **HTTPProxy** is set then these
778 connections will go through that proxy.
780 [[ReachableORAddresses]] **ReachableORAddresses** __ADDR__[/__MASK__][:__PORT__]...::
781 Like **ReachableAddresses**, a list of addresses and ports. Tor will obey
782 these restrictions when connecting to Onion Routers, using TLS/SSL. If not
783 set explicitly then the value of **ReachableAddresses** is used. If
784 **HTTPSProxy** is set then these connections will go through that proxy. +
786 The separation between **ReachableORAddresses** and
787 **ReachableDirAddresses** is only interesting when you are connecting
788 through proxies (see **HTTPProxy** and **HTTPSProxy**). Most proxies limit
789 TLS connections (which Tor uses to connect to Onion Routers) to port 443,
790 and some limit HTTP GET requests (which Tor uses for fetching directory
791 information) to port 80.
793 [[HidServAuth]] **HidServAuth** __onion-address__ __auth-cookie__ [__service-name__]::
794 Client authorization for a hidden service. Valid onion addresses contain 16
795 characters in a-z2-7 plus ".onion", and valid auth cookies contain 22
796 characters in A-Za-z0-9+/. The service name is only used for internal
797 purposes, e.g., for Tor controllers. This option may be used multiple times
798 for different hidden services. If a hidden service uses authorization and
799 this option is not set, the hidden service is not accessible. Hidden
800 services can be configured to require authorization using the
801 **HiddenServiceAuthorizeClient** option.
803 [[CloseHSClientCircuitsImmediatelyOnTimeout]] **CloseHSClientCircuitsImmediatelyOnTimeout** **0**|**1**::
804 If 1, Tor will close unfinished hidden service client circuits
805 which have not moved closer to connecting to their destination
806 hidden service when their internal state has not changed for the
807 duration of the current circuit-build timeout. Otherwise, such
808 circuits will be left open, in the hope that they will finish
809 connecting to their destination hidden services. In either case,
810 another set of introduction and rendezvous circuits for the same
811 destination hidden service will be launched. (Default: 0)
813 [[CloseHSServiceRendCircuitsImmediatelyOnTimeout]] **CloseHSServiceRendCircuitsImmediatelyOnTimeout** **0**|**1**::
814 If 1, Tor will close unfinished hidden-service-side rendezvous
815 circuits after the current circuit-build timeout. Otherwise, such
816 circuits will be left open, in the hope that they will finish
817 connecting to their destinations. In either case, another
818 rendezvous circuit for the same destination client will be
819 launched. (Default: 0)
821 [[LongLivedPorts]] **LongLivedPorts** __PORTS__::
822 A list of ports for services that tend to have long-running connections
823 (e.g. chat and interactive shells). Circuits for streams that use these
824 ports will contain only high-uptime nodes, to reduce the chance that a node
825 will go down before the stream is finished. Note that the list is also
826 honored for circuits (both client and service side) involving hidden
827 services whose virtual port is in this list. (Default: 21, 22, 706,
828 1863, 5050, 5190, 5222, 5223, 6523, 6667, 6697, 8300)
830 [[MapAddress]] **MapAddress** __address__ __newaddress__::
831 When a request for address arrives to Tor, it will transform to newaddress
832 before processing it. For example, if you always want connections to
833 www.example.com to exit via __torserver__ (where __torserver__ is the
834 nickname of the server), use "MapAddress www.example.com
835 www.example.com.torserver.exit". If the value is prefixed with a
836 "\*.", matches an entire domain. For example, if you
837 always want connections to example.com and any if its subdomains
839 __torserver__ (where __torserver__ is the nickname of the server), use
840 "MapAddress \*.example.com \*.example.com.torserver.exit". (Note the
841 leading "*." in each part of the directive.) You can also redirect all
842 subdomains of a domain to a single address. For example, "MapAddress
843 *.example.com www.example.com". +
847 1. When evaluating MapAddress expressions Tor stops when it hits the most
848 recently added expression that matches the requested address. So if you
849 have the following in your torrc, www.torproject.org will map to 1.1.1.1:
851 MapAddress www.torproject.org 2.2.2.2
852 MapAddress www.torproject.org 1.1.1.1
854 2. Tor evaluates the MapAddress configuration until it finds no matches. So
855 if you have the following in your torrc, www.torproject.org will map to
858 MapAddress 1.1.1.1 2.2.2.2
859 MapAddress www.torproject.org 1.1.1.1
861 3. The following MapAddress expression is invalid (and will be
862 ignored) because you cannot map from a specific address to a wildcard
865 MapAddress www.torproject.org *.torproject.org.torserver.exit
867 4. Using a wildcard to match only part of a string (as in *ample.com) is
870 [[NewCircuitPeriod]] **NewCircuitPeriod** __NUM__::
871 Every NUM seconds consider whether to build a new circuit. (Default: 30
874 [[MaxCircuitDirtiness]] **MaxCircuitDirtiness** __NUM__::
875 Feel free to reuse a circuit that was first used at most NUM seconds ago,
876 but never attach a new stream to a circuit that is too old. For hidden
877 services, this applies to the __last__ time a circuit was used, not the
878 first. (Default: 10 minutes)
880 [[MaxClientCircuitsPending]] **MaxClientCircuitsPending** __NUM__::
881 Do not allow more than NUM circuits to be pending at a time for handling
882 client streams. A circuit is pending if we have begun constructing it,
883 but it has not yet been completely constructed. (Default: 32)
885 [[NodeFamily]] **NodeFamily** __node__,__node__,__...__::
886 The Tor servers, defined by their identity fingerprints or nicknames,
887 constitute a "family" of similar or co-administered servers, so never use
888 any two of them in the same circuit. Defining a NodeFamily is only needed
889 when a server doesn't list the family itself (with MyFamily). This option
890 can be used multiple times. In addition to nodes, you can also list
891 IP address and ranges and country codes in {curly braces}.
893 [[EnforceDistinctSubnets]] **EnforceDistinctSubnets** **0**|**1**::
894 If 1, Tor will not put two servers whose IP addresses are "too close" on
895 the same circuit. Currently, two addresses are "too close" if they lie in
896 the same /16 range. (Default: 1)
898 [[SOCKSPort]] **SOCKSPort** \['address':]__port__|**auto** [_flags_] [_isolation flags_]::
899 Open this port to listen for connections from SOCKS-speaking
900 applications. Set this to 0 if you don't want to allow application
901 connections via SOCKS. Set it to "auto" to have Tor pick a port for
902 you. This directive can be specified multiple times to bind
903 to multiple addresses/ports. (Default: 9050) +
905 The _isolation flags_ arguments give Tor rules for which streams
906 received on this SOCKSPort are allowed to share circuits with one
907 another. Recognized isolation flags are:
908 **IsolateClientAddr**;;
909 Don't share circuits with streams from a different
910 client address. (On by default and strongly recommended;
911 you can disable it with **NoIsolateClientAddr**.)
912 **IsolateSOCKSAuth**;;
913 Don't share circuits with streams for which different
914 SOCKS authentication was provided. (On by default;
915 you can disable it with **NoIsolateSOCKSAuth**.)
916 **IsolateClientProtocol**;;
917 Don't share circuits with streams using a different protocol.
918 (SOCKS 4, SOCKS 5, TransPort connections, NATDPort connections,
919 and DNSPort requests are all considered to be different protocols.)
920 **IsolateDestPort**;;
921 Don't share circuits with streams targetting a different
923 **IsolateDestAddr**;;
924 Don't share circuits with streams targetting a different
926 **SessionGroup=**__INT__;;
927 If no other isolation rules would prevent it, allow streams
928 on this port to share circuits with streams from every other
929 port with the same session group. (By default, streams received
930 on different SOCKSPorts, TransPorts, etc are always isolated from one
931 another. This option overrides that behavior.) +
933 Other recognized _flags_ for a SOCKSPort are:
935 Tell exits to not connect to IPv4 addresses in response to SOCKS
936 requests on this connection.
938 Tell exits to allow IPv6 addresses in response to SOCKS requests on
939 this connection, so long as SOCKS5 is in use. (SOCKS4 can't handle
942 Tells exits that, if a host has both an IPv4 and an IPv6 address,
943 we would prefer to connect to it via IPv6. (IPv4 is the default.) +
945 NOTE: Although this option allows you to specify an IP address
946 other than localhost, you should do so only with extreme caution.
947 The SOCKS protocol is unencrypted and (as we use it)
948 unauthenticated, so exposing it in this way could leak your
949 information to anybody watching your network, and allow anybody
950 to use your computer as an open proxy.
952 Tells the client to remember IPv4 DNS answers we receive from exit
953 nodes via this connection. (On by default.)
955 Tells the client to remember IPv6 DNS answers we receive from exit
956 nodes via this connection.
958 Tells the client to remember all DNS answers we receive from exit
959 nodes via this connection.
961 Tells the client to use any cached IPv4 DNS answers we have when making
962 requests via this connection. (NOTE: This option, along UseIPv6Cache
963 and UseDNSCache, can harm your anonymity, and probably
964 won't help performance as much as you might expect. Use with care!)
966 Tells the client to use any cached IPv6 DNS answers we have when making
967 requests via this connection.
969 Tells the client to use any cached DNS answers we have when making
970 requests via this connection.
971 **PreferIPv6Automap**;;
972 When serving a hostname lookup request on this port that
973 should get automapped (according to AutomapHostsOnResove),
974 if we could return either an IPv4 or an IPv6 answer, prefer
975 an IPv6 answer. (On by default.)
976 **PreferSOCKSNoAuth**;;
977 Ordinarily, when an application offers both "username/password
978 authentication" and "no authentication" to Tor via SOCKS5, Tor
979 selects username/password authentication so that IsolateSOCKSAuth can
980 work. This can confuse some applications, if they offer a
981 username/password combination then get confused when asked for
982 one. You can disable this behavior, so that Tor will select "No
983 authentication" when IsolateSOCKSAuth is disabled, or when this
986 [[SOCKSListenAddress]] **SOCKSListenAddress** __IP__[:__PORT__]::
987 Bind to this address to listen for connections from Socks-speaking
988 applications. (Default: 127.0.0.1) You can also specify a port (e.g.
989 192.168.0.1:9100). This directive can be specified multiple times to bind
990 to multiple addresses/ports. (DEPRECATED: As of 0.2.3.x-alpha, you can
991 now use multiple SOCKSPort entries, and provide addresses for SOCKSPort
992 entries, so SOCKSListenAddress no longer has a purpose. For backward
993 compatibility, SOCKSListenAddress is only allowed when SOCKSPort is just
996 [[SocksPolicy]] **SocksPolicy** __policy__,__policy__,__...__::
997 Set an entrance policy for this server, to limit who can connect to the
998 SocksPort and DNSPort ports. The policies have the same form as exit
1001 [[SocksTimeout]] **SocksTimeout** __NUM__::
1002 Let a socks connection wait NUM seconds handshaking, and NUM seconds
1003 unattached waiting for an appropriate circuit, before we fail it. (Default:
1006 [[TokenBucketRefillInterval]] **TokenBucketRefillInterval** __NUM__ [**msec**|**second**]::
1007 Set the refill interval of Tor's token bucket to NUM milliseconds.
1008 NUM must be between 1 and 1000, inclusive. Note that the configured
1009 bandwidth limits are still expressed in bytes per second: this
1010 option only affects the frequency with which Tor checks to see whether
1011 previously exhausted connections may read again. (Default: 100 msec)
1013 [[TrackHostExits]] **TrackHostExits** __host__,__.domain__,__...__::
1014 For each value in the comma separated list, Tor will track recent
1015 connections to hosts that match this value and attempt to reuse the same
1016 exit node for each. If the value is prepended with a \'.\', it is treated as
1017 matching an entire domain. If one of the values is just a \'.', it means
1018 match everything. This option is useful if you frequently connect to sites
1019 that will expire all your authentication cookies (i.e. log you out) if
1020 your IP address changes. Note that this option does have the disadvantage
1021 of making it more clear that a given history is associated with a single
1022 user. However, most people who would wish to observe this will observe it
1023 through cookies or other protocol-specific means anyhow.
1025 [[TrackHostExitsExpire]] **TrackHostExitsExpire** __NUM__::
1026 Since exit servers go up and down, it is desirable to expire the
1027 association between host and exit server after NUM seconds. The default is
1028 1800 seconds (30 minutes).
1030 [[UpdateBridgesFromAuthority]] **UpdateBridgesFromAuthority** **0**|**1**::
1031 When set (along with UseBridges), Tor will try to fetch bridge descriptors
1032 from the configured bridge authorities when feasible. It will fall back to
1033 a direct request if the authority responds with a 404. (Default: 0)
1035 [[UseBridges]] **UseBridges** **0**|**1**::
1036 When set, Tor will fetch descriptors for each bridge listed in the "Bridge"
1037 config lines, and use these relays as both entry guards and directory
1038 guards. (Default: 0)
1040 [[UseEntryGuards]] **UseEntryGuards** **0**|**1**::
1041 If this option is set to 1, we pick a few long-term entry servers, and try
1042 to stick with them. This is desirable because constantly changing servers
1043 increases the odds that an adversary who owns some servers will observe a
1044 fraction of your paths. (Default: 1)
1046 [[UseEntryGuardsAsDirectoryGuards]] **UseEntryGuardsAsDirectoryGuards** **0**|**1**::
1047 If this option is set to 1, and UseEntryGuards is also set to 1,
1048 we try to use our entry guards as directory
1049 guards, and failing that, pick more nodes to act as our directory guards.
1050 This helps prevent an adversary from enumerating clients. It's only
1051 available for clients (non-relay, non-bridge) that aren't configured to
1052 download any non-default directory material. It doesn't currently
1053 do anything when we lack a live consensus. (Default: 1)
1055 [[NumEntryGuards]] **NumEntryGuards** __NUM__::
1056 If UseEntryGuards is set to 1, we will try to pick a total of NUM routers
1057 as long-term entries for our circuits. If NUM is 0, we try to learn
1058 the number from the NumEntryGuards consensus parameter, and default
1059 to 3 if the consensus parameter isn't set. (Default: 0)
1061 [[NumDirectoryGuards]] **NumDirectoryGuards** __NUM__::
1062 If UseEntryGuardsAsDirectoryGuards is enabled, we try to make sure we
1063 have at least NUM routers to use as directory guards. If this option
1064 is set to 0, use the value from the NumDirectoryGuards consensus
1065 parameter, falling back to the value from NumEntryGuards if the
1066 consensus parameter is 0 or isn't set. (Default: 0)
1068 [[GuardLifetime]] **GuardLifetime** __N__ **days**|**weeks**|**months**::
1069 If nonzero, and UseEntryGuards is set, minimum time to keep a guard before
1070 picking a new one. If zero, we use the GuardLifetime parameter from the
1071 consensus directory. No value here may be less than 1 month or greater
1072 than 5 years; out-of-range values are clamped. (Default: 0)
1074 [[SafeSocks]] **SafeSocks** **0**|**1**::
1075 When this option is enabled, Tor will reject application connections that
1076 use unsafe variants of the socks protocol -- ones that only provide an IP
1077 address, meaning the application is doing a DNS resolve first.
1078 Specifically, these are socks4 and socks5 when not doing remote DNS.
1081 [[TestSocks]] **TestSocks** **0**|**1**::
1082 When this option is enabled, Tor will make a notice-level log entry for
1083 each connection to the Socks port indicating whether the request used a
1084 safe socks protocol or an unsafe one (see above entry on SafeSocks). This
1085 helps to determine whether an application using Tor is possibly leaking
1086 DNS requests. (Default: 0)
1088 [[WarnUnsafeSocks]] **WarnUnsafeSocks** **0**|**1**::
1089 When this option is enabled, Tor will warn whenever a request is
1090 received that only contains an IP address instead of a hostname. Allowing
1091 applications to do DNS resolves themselves is usually a bad idea and
1092 can leak your location to attackers. (Default: 1)
1094 [[VirtualAddrNetworkIPv4]] **VirtualAddrNetworkIPv4** __Address__/__bits__ +
1096 [[VirtualAddrNetworkIPv6]] **VirtualAddrNetworkIPv6** [__Address__]/__bits__::
1097 When Tor needs to assign a virtual (unused) address because of a MAPADDRESS
1098 command from the controller or the AutomapHostsOnResolve feature, Tor
1099 picks an unassigned address from this range. (Defaults:
1100 127.192.0.0/10 and [FE80::]/10 respectively.) +
1102 When providing proxy server service to a network of computers using a tool
1103 like dns-proxy-tor, change the IPv4 network to "10.192.0.0/10" or
1104 "172.16.0.0/12" and change the IPv6 network to "[FC00]/7".
1105 The default **VirtualAddrNetwork** address ranges on a
1106 properly configured machine will route to the loopback or link-local
1108 local use, no change to the default VirtualAddrNetwork setting is needed.
1110 [[AllowNonRFC953Hostnames]] **AllowNonRFC953Hostnames** **0**|**1**::
1111 When this option is disabled, Tor blocks hostnames containing illegal
1112 characters (like @ and :) rather than sending them to an exit node to be
1113 resolved. This helps trap accidental attempts to resolve URLs and so on.
1116 [[AllowDotExit]] **AllowDotExit** **0**|**1**::
1117 If enabled, we convert "www.google.com.foo.exit" addresses on the
1118 SocksPort/TransPort/NATDPort into "www.google.com" addresses that exit from
1119 the node "foo". Disabled by default since attacking websites and exit
1120 relays can use it to manipulate your path selection. (Default: 0)
1122 [[FastFirstHopPK]] **FastFirstHopPK** **0**|**1**|**auto**::
1123 When this option is disabled, Tor uses the public key step for the first
1124 hop of creating circuits. Skipping it is generally safe since we have
1125 already used TLS to authenticate the relay and to establish forward-secure
1126 keys. Turning this option off makes circuit building a little
1127 slower. Setting this option to "auto" takes advice from the authorities
1128 in the latest consensus about whether to use this feature. +
1130 Note that Tor will always use the public key step for the first hop if it's
1131 operating as a relay, and it will never use the public key step if it
1132 doesn't yet know the onion key of the first hop. (Default: auto)
1134 [[TransPort]] **TransPort** \['address':]__port__|**auto** [_isolation flags_]::
1135 Open this port to listen for transparent proxy connections. Set this to
1136 0 if you don't want to allow transparent proxy connections. Set the port
1137 to "auto" to have Tor pick a port for you. This directive can be
1138 specified multiple times to bind to multiple addresses/ports. See
1139 SOCKSPort for an explanation of isolation flags. +
1141 TransPort requires OS support for transparent proxies, such as BSDs' pf or
1142 Linux's IPTables. If you're planning to use Tor as a transparent proxy for
1143 a network, you'll want to examine and change VirtualAddrNetwork from the
1144 default setting. You'll also want to set the TransListenAddress option for
1145 the network you'd like to proxy. (Default: 0)
1147 [[TransListenAddress]] **TransListenAddress** __IP__[:__PORT__]::
1148 Bind to this address to listen for transparent proxy connections. (Default:
1149 127.0.0.1). This is useful for exporting a transparent proxy server to an
1150 entire network. (DEPRECATED: As of 0.2.3.x-alpha, you can
1151 now use multiple TransPort entries, and provide addresses for TransPort
1152 entries, so TransListenAddress no longer has a purpose. For backward
1153 compatibility, TransListenAddress is only allowed when TransPort is just
1156 [[NATDPort]] **NATDPort** \['address':]__port__|**auto** [_isolation flags_]::
1157 Open this port to listen for connections from old versions of ipfw (as
1158 included in old versions of FreeBSD, etc) using the NATD protocol.
1159 Use 0 if you don't want to allow NATD connections. Set the port
1160 to "auto" to have Tor pick a port for you. This directive can be
1161 specified multiple times to bind to multiple addresses/ports. See
1162 SOCKSPort for an explanation of isolation flags. +
1164 This option is only for people who cannot use TransPort. (Default: 0)
1166 [[NATDListenAddress]] **NATDListenAddress** __IP__[:__PORT__]::
1167 Bind to this address to listen for NATD connections. (DEPRECATED: As of
1168 0.2.3.x-alpha, you can now use multiple NATDPort entries, and provide
1169 addresses for NATDPort entries, so NATDListenAddress no longer has a
1170 purpose. For backward compatibility, NATDListenAddress is only allowed
1171 when NATDPort is just a port number.)
1173 [[AutomapHostsOnResolve]] **AutomapHostsOnResolve** **0**|**1**::
1174 When this option is enabled, and we get a request to resolve an address
1175 that ends with one of the suffixes in **AutomapHostsSuffixes**, we map an
1176 unused virtual address to that address, and return the new virtual address.
1177 This is handy for making ".onion" addresses work with applications that
1178 resolve an address and then connect to it. (Default: 0)
1180 [[AutomapHostsSuffixes]] **AutomapHostsSuffixes** __SUFFIX__,__SUFFIX__,__...__::
1181 A comma-separated list of suffixes to use with **AutomapHostsOnResolve**.
1182 The "." suffix is equivalent to "all addresses." (Default: .exit,.onion).
1184 [[DNSPort]] **DNSPort** \['address':]__port__|**auto** [_isolation flags_]::
1185 If non-zero, open this port to listen for UDP DNS requests, and resolve
1186 them anonymously. This port only handles A, AAAA, and PTR requests---it
1187 doesn't handle arbitrary DNS request types. Set the port to "auto" to
1188 have Tor pick a port for
1189 you. This directive can be specified multiple times to bind to multiple
1190 addresses/ports. See SOCKSPort for an explanation of isolation
1193 [[DNSListenAddress]] **DNSListenAddress** __IP__[:__PORT__]::
1194 Bind to this address to listen for DNS connections. (DEPRECATED: As of
1195 0.2.3.x-alpha, you can now use multiple DNSPort entries, and provide
1196 addresses for DNSPort entries, so DNSListenAddress no longer has a
1197 purpose. For backward compatibility, DNSListenAddress is only allowed
1198 when DNSPort is just a port number.)
1200 [[ClientDNSRejectInternalAddresses]] **ClientDNSRejectInternalAddresses** **0**|**1**::
1201 If true, Tor does not believe any anonymously retrieved DNS answer that
1202 tells it that an address resolves to an internal address (like 127.0.0.1 or
1203 192.168.0.1). This option prevents certain browser-based attacks; don't
1204 turn it off unless you know what you're doing. (Default: 1)
1206 [[ClientRejectInternalAddresses]] **ClientRejectInternalAddresses** **0**|**1**::
1207 If true, Tor does not try to fulfill requests to connect to an internal
1208 address (like 127.0.0.1 or 192.168.0.1) __unless a exit node is
1209 specifically requested__ (for example, via a .exit hostname, or a
1210 controller request). (Default: 1)
1212 [[DownloadExtraInfo]] **DownloadExtraInfo** **0**|**1**::
1213 If true, Tor downloads and caches "extra-info" documents. These documents
1214 contain information about servers other than the information in their
1215 regular router descriptors. Tor does not use this information for anything
1216 itself; to save bandwidth, leave this option turned off. (Default: 0)
1218 [[WarnPlaintextPorts]] **WarnPlaintextPorts** __port__,__port__,__...__::
1219 Tells Tor to issue a warnings whenever the user tries to make an anonymous
1220 connection to one of these ports. This option is designed to alert users
1221 to services that risk sending passwords in the clear. (Default:
1224 [[RejectPlaintextPorts]] **RejectPlaintextPorts** __port__,__port__,__...__::
1225 Like WarnPlaintextPorts, but instead of warning about risky port uses, Tor
1226 will instead refuse to make the connection. (Default: None)
1228 [[AllowSingleHopCircuits]] **AllowSingleHopCircuits** **0**|**1**::
1229 When this option is set, the attached Tor controller can use relays
1230 that have the **AllowSingleHopExits** option turned on to build
1231 one-hop Tor connections. (Default: 0)
1233 [[OptimisticData]] **OptimisticData** **0**|**1**|**auto**::
1234 When this option is set, and Tor is using an exit node that supports
1235 the feature, it will try optimistically to send data to the exit node
1236 without waiting for the exit node to report whether the connection
1237 succeeded. This can save a round-trip time for protocols like HTTP
1238 where the client talks first. If OptimisticData is set to **auto**,
1239 Tor will look at the UseOptimisticData parameter in the networkstatus.
1242 [[Tor2webMode]] **Tor2webMode** **0**|**1**::
1243 When this option is set, Tor connects to hidden services
1244 **non-anonymously**. This option also disables client connections to
1245 non-hidden-service hostnames through Tor. It **must only** be used when
1246 running a tor2web Hidden Service web proxy.
1247 To enable this option the compile time flag --enable-tor2webmode must be
1248 specified. (Default: 0)
1250 [[UseMicrodescriptors]] **UseMicrodescriptors** **0**|**1**|**auto**::
1251 Microdescriptors are a smaller version of the information that Tor needs
1252 in order to build its circuits. Using microdescriptors makes Tor clients
1253 download less directory information, thus saving bandwidth. Directory
1254 caches need to fetch regular descriptors and microdescriptors, so this
1255 option doesn't save any bandwidth for them. If this option is set to
1256 "auto" (recommended) then it is on for all clients that do not set
1257 FetchUselessDescriptors. (Default: auto)
1259 [[UseNTorHandshake]] **UseNTorHandshake** **0**|**1**|**auto**::
1260 The "ntor" circuit-creation handshake is faster and (we think) more
1261 secure than the original ("TAP") circuit handshake, but starting to use
1262 it too early might make your client stand out. If this option is 0, your
1263 Tor client won't use the ntor handshake. If it's 1, your Tor client
1264 will use the ntor handshake to extend circuits through servers that
1265 support it. If this option is "auto" (recommended), then your client
1266 will use the ntor handshake once enough directory authorities recommend
1269 [[PathBiasCircThreshold]] **PathBiasCircThreshold** __NUM__ +
1271 [[PathBiasNoticeRate]] **PathBiasNoticeRate** __NUM__ +
1273 [[PathBiasWarnRate]] **PathBiasWarnRate** __NUM__ +
1275 [[PathBiasExtremeRate]] **PathBiasExtremeRate** __NUM__ +
1277 [[PathBiasDropGuards]] **PathBiasDropGuards** __NUM__ +
1279 [[PathBiasScaleThreshold]] **PathBiasScaleThreshold** __NUM__::
1280 These options override the default behavior of Tor's (**currently
1281 experimental**) path bias detection algorithm. To try to find broken or
1282 misbehaving guard nodes, Tor looks for nodes where more than a certain
1283 fraction of circuits through that guard fail to get built.
1285 The PathBiasCircThreshold option controls how many circuits we need to build
1286 through a guard before we make these checks. The PathBiasNoticeRate,
1287 PathBiasWarnRate and PathBiasExtremeRate options control what fraction of
1288 circuits must succeed through a guard so we won't write log messages.
1289 If less than PathBiasExtremeRate circuits succeed *and* PathBiasDropGuards
1290 is set to 1, we disable use of that guard. +
1292 When we have seen more than PathBiasScaleThreshold
1293 circuits through a guard, we scale our observations by 0.5 (governed by
1294 the consensus) so that new observations don't get swamped by old ones. +
1296 By default, or if a negative value is provided for one of these options,
1297 Tor uses reasonable defaults from the networkstatus consensus document.
1298 If no defaults are available there, these options default to 150, .70,
1299 .50, .30, 0, and 300 respectively.
1301 [[PathBiasUseThreshold]] **PathBiasUseThreshold** __NUM__ +
1303 [[PathBiasNoticeUseRate]] **PathBiasNoticeUseRate** __NUM__ +
1305 [[PathBiasExtremeUseRate]] **PathBiasExtremeUseRate** __NUM__ +
1307 [[PathBiasScaleUseThreshold]] **PathBiasScaleUseThreshold** __NUM__::
1308 Similar to the above options, these options override the default behavior
1309 of Tor's (**currently experimental**) path use bias detection algorithm.
1311 Where as the path bias parameters govern thresholds for successfully
1312 building circuits, these four path use bias parameters govern thresholds
1313 only for circuit usage. Circuits which receive no stream usage
1314 are not counted by this detection algorithm. A used circuit is considered
1315 successful if it is capable of carrying streams or otherwise receiving
1316 well-formed responses to RELAY cells.
1318 By default, or if a negative value is provided for one of these options,
1319 Tor uses reasonable defaults from the networkstatus consensus document.
1320 If no defaults are available there, these options default to 20, .80,
1321 .60, and 100, respectively.
1323 [[ClientUseIPv6]] **ClientUseIPv6** **0**|**1**::
1324 If this option is set to 1, Tor might connect to entry nodes over
1325 IPv6. Note that clients configured with an IPv6 address in a
1326 **Bridge** line will try connecting over IPv6 even if
1327 **ClientUseIPv6** is set to 0. (Default: 0)
1329 [[ClientPreferIPv6ORPort]] **ClientPreferIPv6ORPort** **0**|**1**::
1330 If this option is set to 1, Tor prefers an OR port with an IPv6
1331 address over one with IPv4 if a given entry node has both. Other
1332 things may influence the choice. This option breaks a tie to the
1333 favor of IPv6. (Default: 0)
1335 [[PathsNeededToBuildCircuits]] **PathsNeededToBuildCircuits** __NUM__::
1336 Tor clients don't build circuits for user traffic until they know
1337 about enough of the network so that they could potentially construct
1338 enough of the possible paths through the network. If this option
1339 is set to a fraction between 0.25 and 0.95, Tor won't build circuits
1340 until it has enough descriptors or microdescriptors to construct
1341 that fraction of possible paths. Note that setting this option too low
1342 can make your Tor client less anonymous, and setting it too high can
1343 prevent your Tor client from bootstrapping. If this option is negative,
1344 Tor will use a default value chosen by the directory
1345 authorities. (Default: -1.)
1347 [[Support022HiddenServices]] **Support022HiddenServices** **0**|**1**|**auto**::
1348 Tor hidden services running versions before 0.2.3.x required clients to
1349 send timestamps, which can potentially be used to distinguish clients
1350 whose view of the current time is skewed. If this option is set to 0, we
1351 do not send this timestamp, and hidden services on obsolete Tor versions
1352 will not work. If this option is set to 1, we send the timestamp. If
1353 this optoin is "auto", we take a recommendation from the latest consensus
1354 document. (Default: auto)
1360 The following options are useful only for servers (that is, if ORPort
1363 [[Address]] **Address** __address__::
1364 The IP address or fully qualified domain name of this server (e.g.
1365 moria.mit.edu). You can leave this unset, and Tor will guess your IP
1366 address. This IP address is the one used to tell clients and other
1367 servers where to find your Tor server; it doesn't affect the IP that your
1368 Tor client binds to. To bind to a different address, use the
1369 *ListenAddress and OutboundBindAddress options.
1371 [[AllowSingleHopExits]] **AllowSingleHopExits** **0**|**1**::
1372 This option controls whether clients can use this server as a single hop
1373 proxy. If set to 1, clients can use this server as an exit even if it is
1374 the only hop in the circuit. Note that most clients will refuse to use
1375 servers that set this option, since most clients have
1376 ExcludeSingleHopRelays set. (Default: 0)
1378 [[AssumeReachable]] **AssumeReachable** **0**|**1**::
1379 This option is used when bootstrapping a new Tor network. If set to 1,
1380 don't do self-reachability testing; just upload your server descriptor
1381 immediately. If **AuthoritativeDirectory** is also set, this option
1382 instructs the dirserver to bypass remote reachability testing too and list
1383 all connected servers as running.
1385 [[BridgeRelay]] **BridgeRelay** **0**|**1**::
1386 Sets the relay to act as a "bridge" with respect to relaying connections
1387 from bridge users to the Tor network. It mainly causes Tor to publish a
1388 server descriptor to the bridge database, rather than publishing a relay
1389 descriptor to the public directory authorities.
1391 [[ContactInfo]] **ContactInfo** __email_address__::
1392 Administrative contact information for this relay or bridge. This line
1393 can be used to contact you if your relay or bridge is misconfigured or
1394 something else goes wrong. Note that we archive and publish all
1395 descriptors containing these lines and that Google indexes them, so
1396 spammers might also collect them. You may want to obscure the fact
1397 that it's an email address and/or generate a new address for this
1400 [[ExitPolicy]] **ExitPolicy** __policy__,__policy__,__...__::
1401 Set an exit policy for this server. Each policy is of the form
1402 "**accept**|**reject** __ADDR__[/__MASK__][:__PORT__]". If /__MASK__ is
1403 omitted then this policy just applies to the host given. Instead of giving
1404 a host or network you can also use "\*" to denote the universe (0.0.0.0/0).
1405 __PORT__ can be a single port number, an interval of ports
1406 "__FROM_PORT__-__TO_PORT__", or "\*". If __PORT__ is omitted, that means
1409 For example, "accept 18.7.22.69:\*,reject 18.0.0.0/8:\*,accept \*:\*" would
1410 reject any traffic destined for MIT except for web.mit.edu, and accept
1413 To specify all internal and link-local networks (including 0.0.0.0/8,
1414 169.254.0.0/16, 127.0.0.0/8, 192.168.0.0/16, 10.0.0.0/8, and
1415 172.16.0.0/12), you can use the "private" alias instead of an address.
1416 These addresses are rejected by default (at the beginning of your exit
1417 policy), along with your public IP address, unless you set the
1418 ExitPolicyRejectPrivate config option to 0. For example, once you've done
1419 that, you could allow HTTP to 127.0.0.1 and block all other connections to
1420 internal networks with "accept 127.0.0.1:80,reject private:\*", though that
1421 may also allow connections to your own computer that are addressed to its
1422 public (external) IP address. See RFC 1918 and RFC 3330 for more details
1423 about internal and reserved IP address space. +
1425 This directive can be specified multiple times so you don't have to put it
1428 Policies are considered first to last, and the first match wins. If you
1429 want to \_replace_ the default exit policy, end your exit policy with
1430 either a reject \*:* or an accept \*:*. Otherwise, you're \_augmenting_
1431 (prepending to) the default exit policy. The default exit policy is: +
1445 [[ExitPolicyRejectPrivate]] **ExitPolicyRejectPrivate** **0**|**1**::
1446 Reject all private (local) networks, along with your own public IP address,
1447 at the beginning of your exit policy. See above entry on ExitPolicy.
1450 [[IPv6Exit]] **IPv6Exit** **0**|**1**::
1451 If set, and we are an exit node, allow clients to use us for IPv6
1452 traffic. (Default: 0)
1454 [[MaxOnionQueueDelay]] **MaxOnionQueueDelay** __NUM__ [**msec**|**second**]::
1455 If we have more onionskins queued for processing than we can process in
1456 this amount of time, reject new ones. (Default: 1750 msec)
1458 [[MyFamily]] **MyFamily** __node__,__node__,__...__::
1459 Declare that this Tor server is controlled or administered by a group or
1460 organization identical or similar to that of the other servers, defined by
1461 their identity fingerprints or nicknames. When two servers both declare
1462 that they are in the same \'family', Tor clients will not use them in the
1463 same circuit. (Each server only needs to list the other servers in its
1464 family; it doesn't need to list itself, but it won't hurt.) Do not list
1465 any bridge relay as it would compromise its concealment.
1467 When listing a node, it's better to list it by fingerprint than by
1468 nickname: fingerprints are more reliable.
1470 [[Nickname]] **Nickname** __name__::
1471 Set the server's nickname to \'name'. Nicknames must be between 1 and 19
1472 characters inclusive, and must contain only the characters [a-zA-Z0-9].
1474 [[NumCPUs]] **NumCPUs** __num__::
1475 How many processes to use at once for decrypting onionskins and other
1476 parallelizable operations. If this is set to 0, Tor will try to detect
1477 how many CPUs you have, defaulting to 1 if it can't tell. (Default: 0)
1479 [[ORPort]] **ORPort** \['address':]__PORT__|**auto** [_flags_]::
1480 Advertise this port to listen for connections from Tor clients and
1481 servers. This option is required to be a Tor server.
1482 Set it to "auto" to have Tor pick a port for you. Set it to 0 to not
1483 run an ORPort at all. This option can occur more than once. (Default: 0)
1485 Tor recognizes these flags on each ORPort:
1487 By default, we bind to a port and tell our users about it. If
1488 NoAdvertise is specified, we don't advertise, but listen anyway. This
1489 can be useful if the port everybody will be connecting to (for
1490 example, one that's opened on our firewall) is somewhere else.
1492 By default, we bind to a port and tell our users about it. If
1493 NoListen is specified, we don't bind, but advertise anyway. This
1494 can be useful if something else (for example, a firewall's port
1495 forwarding configuration) is causing connections to reach us.
1497 If the address is absent, or resolves to both an IPv4 and an IPv6
1498 address, only listen to the IPv4 address.
1500 If the address is absent, or resolves to both an IPv4 and an IPv6
1501 address, only listen to the IPv6 address.
1503 For obvious reasons, NoAdvertise and NoListen are mutually exclusive, and
1504 IPv4Only and IPv6Only are mutually exclusive.
1506 [[ORListenAddress]] **ORListenAddress** __IP__[:__PORT__]::
1507 Bind to this IP address to listen for connections from Tor clients and
1508 servers. If you specify a port, bind to this port rather than the one
1509 specified in ORPort. (Default: 0.0.0.0) This directive can be specified
1510 multiple times to bind to multiple addresses/ports.
1512 This option is deprecated; you can get the same behavior with ORPort now
1513 that it supports NoAdvertise and explicit addresses.
1515 [[PortForwarding]] **PortForwarding** **0**|**1**::
1516 Attempt to automatically forward the DirPort and ORPort on a NAT router
1517 connecting this Tor server to the Internet. If set, Tor will try both
1518 NAT-PMP (common on Apple routers) and UPnP (common on routers from other
1519 manufacturers). (Default: 0)
1521 [[PortForwardingHelper]] **PortForwardingHelper** __filename__|__pathname__::
1522 If PortForwarding is set, use this executable to configure the forwarding.
1523 If set to a filename, the system path will be searched for the executable.
1524 If set to a path, only the specified path will be executed.
1525 (Default: tor-fw-helper)
1527 [[PublishServerDescriptor]] **PublishServerDescriptor** **0**|**1**|**v1**|**v2**|**v3**|**bridge**,**...**::
1528 This option specifies which descriptors Tor will publish when acting as
1530 choose multiple arguments, separated by commas.
1532 If this option is set to 0, Tor will not publish its
1533 descriptors to any directories. (This is useful if you're testing
1534 out your server, or if you're using a Tor controller that handles directory
1535 publishing for you.) Otherwise, Tor will publish its descriptors of all
1536 type(s) specified. The default is "1",
1537 which means "if running as a server, publish the
1538 appropriate descriptors to the authorities".
1540 [[ShutdownWaitLength]] **ShutdownWaitLength** __NUM__::
1541 When we get a SIGINT and we're a server, we begin shutting down:
1542 we close listeners and start refusing new circuits. After **NUM**
1543 seconds, we exit. If we get a second SIGINT, we exit immediately.
1544 (Default: 30 seconds)
1546 [[SSLKeyLifetime]] **SSLKeyLifetime** __N__ **minutes**|**hours**|**days**|**weeks**::
1547 When creating a link certificate for our outermost SSL handshake,
1548 set its lifetime to this amount of time. If set to 0, Tor will choose
1549 some reasonable random defaults. (Default: 0)
1551 [[HeartbeatPeriod]] **HeartbeatPeriod** __N__ **minutes**|**hours**|**days**|**weeks**::
1552 Log a heartbeat message every **HeartbeatPeriod** seconds. This is
1553 a log level __notice__ message, designed to let you know your Tor
1554 server is still alive and doing useful things. Settings this
1555 to 0 will disable the heartbeat. (Default: 6 hours)
1557 [[AccountingMax]] **AccountingMax** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**::
1558 Never send more than the specified number of bytes in a given accounting
1559 period, or receive more than that number in the period. For example, with
1560 AccountingMax set to 1 GByte, a server could send 900 MBytes and
1561 receive 800 MBytes and continue running. It will only hibernate once
1562 one of the two reaches 1 GByte. When the number of bytes gets low,
1563 Tor will stop accepting new connections and circuits. When the
1564 number of bytes is exhausted, Tor will hibernate until some
1565 time in the next accounting period. To prevent all servers from waking at
1566 the same time, Tor will also wait until a random point in each period
1567 before waking up. If you have bandwidth cost issues, enabling hibernation
1568 is preferable to setting a low bandwidth, since it provides users with a
1569 collection of fast servers that are up some of the time, which is more
1570 useful than a set of slow servers that are always "available".
1572 [[AccountingStart]] **AccountingStart** **day**|**week**|**month** [__day__] __HH:MM__::
1573 Specify how long accounting periods last. If **month** is given, each
1574 accounting period runs from the time __HH:MM__ on the __dayth__ day of one
1575 month to the same day and time of the next. (The day must be between 1 and
1576 28.) If **week** is given, each accounting period runs from the time __HH:MM__
1577 of the __dayth__ day of one week to the same day and time of the next week,
1578 with Monday as day 1 and Sunday as day 7. If **day** is given, each
1579 accounting period runs from the time __HH:MM__ each day to the same time on
1580 the next day. All times are local, and given in 24-hour time. (Default:
1583 [[RefuseUnknownExits]] **RefuseUnknownExits** **0**|**1**|**auto**::
1584 Prevent nodes that don't appear in the consensus from exiting using this
1585 relay. If the option is 1, we always block exit attempts from such
1586 nodes; if it's 0, we never do, and if the option is "auto", then we do
1587 whatever the authorities suggest in the consensus (and block if the consensus
1588 is quiet on the issue). (Default: auto)
1590 [[ServerDNSResolvConfFile]] **ServerDNSResolvConfFile** __filename__::
1591 Overrides the default DNS configuration with the configuration in
1592 __filename__. The file format is the same as the standard Unix
1593 "**resolv.conf**" file (7). This option, like all other ServerDNS options,
1594 only affects name lookups that your server does on behalf of clients.
1595 (Defaults to use the system DNS configuration.)
1597 [[ServerDNSAllowBrokenConfig]] **ServerDNSAllowBrokenConfig** **0**|**1**::
1598 If this option is false, Tor exits immediately if there are problems
1599 parsing the system DNS configuration or connecting to nameservers.
1600 Otherwise, Tor continues to periodically retry the system nameservers until
1601 it eventually succeeds. (Default: 1)
1603 [[ServerDNSSearchDomains]] **ServerDNSSearchDomains** **0**|**1**::
1604 If set to 1, then we will search for addresses in the local search domain.
1605 For example, if this system is configured to believe it is in
1606 "example.com", and a client tries to connect to "www", the client will be
1607 connected to "www.example.com". This option only affects name lookups that
1608 your server does on behalf of clients. (Default: 0)
1610 [[ServerDNSDetectHijacking]] **ServerDNSDetectHijacking** **0**|**1**::
1611 When this option is set to 1, we will test periodically to determine
1612 whether our local nameservers have been configured to hijack failing DNS
1613 requests (usually to an advertising site). If they are, we will attempt to
1614 correct this. This option only affects name lookups that your server does
1615 on behalf of clients. (Default: 1)
1617 [[ServerDNSTestAddresses]] **ServerDNSTestAddresses** __address__,__address__,__...__::
1618 When we're detecting DNS hijacking, make sure that these __valid__ addresses
1619 aren't getting redirected. If they are, then our DNS is completely useless,
1620 and we'll reset our exit policy to "reject *:*". This option only affects
1621 name lookups that your server does on behalf of clients. (Default:
1622 "www.google.com, www.mit.edu, www.yahoo.com, www.slashdot.org")
1624 [[ServerDNSAllowNonRFC953Hostnames]] **ServerDNSAllowNonRFC953Hostnames** **0**|**1**::
1625 When this option is disabled, Tor does not try to resolve hostnames
1626 containing illegal characters (like @ and :) rather than sending them to an
1627 exit node to be resolved. This helps trap accidental attempts to resolve
1628 URLs and so on. This option only affects name lookups that your server does
1629 on behalf of clients. (Default: 0)
1631 [[BridgeRecordUsageByCountry]] **BridgeRecordUsageByCountry** **0**|**1**::
1632 When this option is enabled and BridgeRelay is also enabled, and we have
1633 GeoIP data, Tor keeps a keep a per-country count of how many client
1634 addresses have contacted it so that it can help the bridge authority guess
1635 which countries have blocked access to it. (Default: 1)
1637 [[ServerDNSRandomizeCase]] **ServerDNSRandomizeCase** **0**|**1**::
1638 When this option is set, Tor sets the case of each character randomly in
1639 outgoing DNS requests, and makes sure that the case matches in DNS replies.
1640 This so-called "0x20 hack" helps resist some types of DNS poisoning attack.
1641 For more information, see "Increased DNS Forgery Resistance through
1642 0x20-Bit Encoding". This option only affects name lookups that your server
1643 does on behalf of clients. (Default: 1)
1645 [[GeoIPFile]] **GeoIPFile** __filename__::
1646 A filename containing IPv4 GeoIP data, for use with by-country statistics.
1648 [[GeoIPv6File]] **GeoIPv6File** __filename__::
1649 A filename containing IPv6 GeoIP data, for use with by-country statistics.
1651 [[TLSECGroup]] **TLSECGroup** **P224**|**P256**::
1652 What EC group should we try to use for incoming TLS connections?
1653 P224 is faster, but makes us stand out more. Has no effect if
1654 we're a client, or if our OpenSSL version lacks support for ECDHE.
1657 [[CellStatistics]] **CellStatistics** **0**|**1**::
1658 When this option is enabled, Tor writes statistics on the mean time that
1659 cells spend in circuit queues to disk every 24 hours. (Default: 0)
1661 [[DirReqStatistics]] **DirReqStatistics** **0**|**1**::
1662 When this option is enabled, a Tor directory writes statistics on the
1663 number and response time of network status requests to disk every 24
1666 [[EntryStatistics]] **EntryStatistics** **0**|**1**::
1667 When this option is enabled, Tor writes statistics on the number of
1668 directly connecting clients to disk every 24 hours. (Default: 0)
1670 [[ExitPortStatistics]] **ExitPortStatistics** **0**|**1**::
1671 When this option is enabled, Tor writes statistics on the number of relayed
1672 bytes and opened stream per exit port to disk every 24 hours. (Default: 0)
1674 [[ConnDirectionStatistics]] **ConnDirectionStatistics** **0**|**1**::
1675 When this option is enabled, Tor writes statistics on the bidirectional use
1676 of connections to disk every 24 hours. (Default: 0)
1678 [[ExtraInfoStatistics]] **ExtraInfoStatistics** **0**|**1**::
1679 When this option is enabled, Tor includes previously gathered statistics in
1680 its extra-info documents that it uploads to the directory authorities.
1683 [[ExtendAllowPrivateAddresses]] **ExtendAllowPrivateAddresses** **0**|**1**::
1684 When this option is enabled, Tor routers allow EXTEND request to
1685 localhost, RFC1918 addresses, and so on. This can create security issues;
1686 you should probably leave it off. (Default: 0)
1688 [[MaxMemInCellQueues]] **MaxMemInCellQueues** __N__ **bytes**|**KB**|**MB**|**GB**::
1689 This option configures a threshold above which Tor will assume that it
1690 needs to stop queueing cells because it's about to run out of memory.
1691 If it hits this threshold, it will begin killing circuits until it
1692 has recovered at least 10% of this memory. Do not set this option too
1693 low, or your relay may be unreliable under load. This option only
1694 affects circuit queues, so the actual process size will be larger than
1695 this. (Default: 8GB)
1697 DIRECTORY SERVER OPTIONS
1698 ------------------------
1700 The following options are useful only for directory servers (that is,
1701 if DirPort is non-zero):
1703 [[AuthoritativeDirectory]] **AuthoritativeDirectory** **0**|**1**::
1704 When this option is set to 1, Tor operates as an authoritative directory
1705 server. Instead of caching the directory, it generates its own list of
1706 good servers, signs it, and sends that to the clients. Unless the clients
1707 already have you listed as a trusted directory, you probably do not want
1708 to set this option. Please coordinate with the other admins at
1709 tor-ops@torproject.org if you think you should be a directory.
1711 [[DirPortFrontPage]] **DirPortFrontPage** __FILENAME__::
1712 When this option is set, it takes an HTML file and publishes it as "/" on
1713 the DirPort. Now relay operators can provide a disclaimer without needing
1714 to set up a separate webserver. There's a sample disclaimer in
1715 contrib/tor-exit-notice.html.
1717 [[V1AuthoritativeDirectory]] **V1AuthoritativeDirectory** **0**|**1**::
1718 When this option is set in addition to **AuthoritativeDirectory**, Tor
1719 generates version 1 directory and running-routers documents (for legacy
1720 Tor clients up to 0.1.0.x).
1722 [[V2AuthoritativeDirectory]] **V2AuthoritativeDirectory** **0**|**1**::
1723 When this option is set in addition to **AuthoritativeDirectory**, Tor
1724 generates version 2 network statuses and serves descriptors, etc as
1725 described in doc/spec/dir-spec-v2.txt (for Tor clients and servers running
1726 0.1.1.x and 0.1.2.x).
1728 [[V3AuthoritativeDirectory]] **V3AuthoritativeDirectory** **0**|**1**::
1729 When this option is set in addition to **AuthoritativeDirectory**, Tor
1730 generates version 3 network statuses and serves descriptors, etc as
1731 described in doc/spec/dir-spec.txt (for Tor clients and servers running at
1734 [[VersioningAuthoritativeDirectory]] **VersioningAuthoritativeDirectory** **0**|**1**::
1735 When this option is set to 1, Tor adds information on which versions of
1736 Tor are still believed safe for use to the published directory. Each
1737 version 1 authority is automatically a versioning authority; version 2
1738 authorities provide this service optionally. See **RecommendedVersions**,
1739 **RecommendedClientVersions**, and **RecommendedServerVersions**.
1741 [[NamingAuthoritativeDirectory]] **NamingAuthoritativeDirectory** **0**|**1**::
1742 When this option is set to 1, then the server advertises that it has
1743 opinions about nickname-to-fingerprint bindings. It will include these
1744 opinions in its published network-status pages, by listing servers with
1745 the flag "Named" if a correct binding between that nickname and fingerprint
1746 has been registered with the dirserver. Naming dirservers will refuse to
1747 accept or publish descriptors that contradict a registered binding. See
1748 **approved-routers** in the **FILES** section below.
1750 [[HSAuthoritativeDir]] **HSAuthoritativeDir** **0**|**1**::
1751 When this option is set in addition to **AuthoritativeDirectory**, Tor also
1752 accepts and serves v0 hidden service descriptors,
1753 which are produced and used by Tor 0.2.1.x and older. (Default: 0)
1755 [[HidServDirectoryV2]] **HidServDirectoryV2** **0**|**1**::
1756 When this option is set, Tor accepts and serves v2 hidden service
1757 descriptors. Setting DirPort is not required for this, because clients
1758 connect via the ORPort by default. (Default: 1)
1760 [[BridgeAuthoritativeDir]] **BridgeAuthoritativeDir** **0**|**1**::
1761 When this option is set in addition to **AuthoritativeDirectory**, Tor
1762 accepts and serves router descriptors, but it caches and serves the main
1763 networkstatus documents rather than generating its own. (Default: 0)
1765 [[MinUptimeHidServDirectoryV2]] **MinUptimeHidServDirectoryV2** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
1766 Minimum uptime of a v2 hidden service directory to be accepted as such by
1767 authoritative directories. (Default: 25 hours)
1769 [[DirPort]] **DirPort** \['address':]__PORT__|**auto** [_flags_]::
1770 If this option is nonzero, advertise the directory service on this port.
1771 Set it to "auto" to have Tor pick a port for you. This option can occur
1772 more than once, but only one advertised DirPort is supported: all
1773 but one DirPort must have the **NoAdvertise** flag set. (Default: 0)
1775 The same flags are supported here as are supported by ORPort.
1777 [[DirListenAddress]] **DirListenAddress** __IP__[:__PORT__]::
1778 Bind the directory service to this address. If you specify a port, bind to
1779 this port rather than the one specified in DirPort. (Default: 0.0.0.0)
1780 This directive can be specified multiple times to bind to multiple
1783 This option is deprecated; you can get the same behavior with DirPort now
1784 that it supports NoAdvertise and explicit addresses.
1786 [[DirPolicy]] **DirPolicy** __policy__,__policy__,__...__::
1787 Set an entrance policy for this server, to limit who can connect to the
1788 directory ports. The policies have the same form as exit policies above.
1790 [[FetchV2Networkstatus]] **FetchV2Networkstatus** **0**|**1**::
1791 If set, we try to fetch the (obsolete, unused) version 2 network status
1792 consensus documents from the directory authorities. No currently
1793 supported Tor version uses them. (Default: 0)
1796 DIRECTORY AUTHORITY SERVER OPTIONS
1797 ----------------------------------
1799 [[RecommendedVersions]] **RecommendedVersions** __STRING__::
1800 STRING is a comma-separated list of Tor versions currently believed to be
1801 safe. The list is included in each directory, and nodes which pull down the
1802 directory learn whether they need to upgrade. This option can appear
1803 multiple times: the values from multiple lines are spliced together. When
1804 this is set then **VersioningAuthoritativeDirectory** should be set too.
1806 [[RecommendedClientVersions]] **RecommendedClientVersions** __STRING__::
1807 STRING is a comma-separated list of Tor versions currently believed to be
1808 safe for clients to use. This information is included in version 2
1809 directories. If this is not set then the value of **RecommendedVersions**
1810 is used. When this is set then **VersioningAuthoritativeDirectory** should
1813 [[RecommendedServerVersions]] **RecommendedServerVersions** __STRING__::
1814 STRING is a comma-separated list of Tor versions currently believed to be
1815 safe for servers to use. This information is included in version 2
1816 directories. If this is not set then the value of **RecommendedVersions**
1817 is used. When this is set then **VersioningAuthoritativeDirectory** should
1820 [[ConsensusParams]] **ConsensusParams** __STRING__::
1821 STRING is a space-separated list of key=value pairs that Tor will include
1822 in the "params" line of its networkstatus vote.
1824 [[DirAllowPrivateAddresses]] **DirAllowPrivateAddresses** **0**|**1**::
1825 If set to 1, Tor will accept router descriptors with arbitrary "Address"
1826 elements. Otherwise, if the address is not an IP address or is a private IP
1827 address, it will reject the router descriptor. (Default: 0)
1829 [[AuthDirBadDir]] **AuthDirBadDir** __AddressPattern...__::
1830 Authoritative directories only. A set of address patterns for servers that
1831 will be listed as bad directories in any network status document this
1832 authority publishes, if **AuthDirListBadDirs** is set.
1834 [[AuthDirBadExit]] **AuthDirBadExit** __AddressPattern...__::
1835 Authoritative directories only. A set of address patterns for servers that
1836 will be listed as bad exits in any network status document this authority
1837 publishes, if **AuthDirListBadExits** is set.
1839 [[AuthDirInvalid]] **AuthDirInvalid** __AddressPattern...__::
1840 Authoritative directories only. A set of address patterns for servers that
1841 will never be listed as "valid" in any network status document that this
1842 authority publishes.
1844 [[AuthDirReject]] **AuthDirReject** __AddressPattern__...::
1845 Authoritative directories only. A set of address patterns for servers that
1846 will never be listed at all in any network status document that this
1847 authority publishes, or accepted as an OR address in any descriptor
1848 submitted for publication by this authority.
1850 [[AuthDirBadDirCCs]] **AuthDirBadDirCCs** __CC__,... +
1852 [[AuthDirBadExitCCs]] **AuthDirBadExitCCs** __CC__,... +
1854 [[AuthDirInvalidCCs]] **AuthDirInvalidCCs** __CC__,... +
1856 [[AuthDirRejectCCs]] **AuthDirRejectCCs** __CC__,...::
1857 Authoritative directories only. These options contain a comma-separated
1858 list of country codes such that any server in one of those country codes
1859 will be marked as a bad directory/bad exit/invalid for use, or rejected
1862 [[AuthDirListBadDirs]] **AuthDirListBadDirs** **0**|**1**::
1863 Authoritative directories only. If set to 1, this directory has some
1864 opinion about which nodes are unsuitable as directory caches. (Do not set
1865 this to 1 unless you plan to list non-functioning directories as bad;
1866 otherwise, you are effectively voting in favor of every declared
1869 [[AuthDirListBadExits]] **AuthDirListBadExits** **0**|**1**::
1870 Authoritative directories only. If set to 1, this directory has some
1871 opinion about which nodes are unsuitable as exit nodes. (Do not set this to
1872 1 unless you plan to list non-functioning exits as bad; otherwise, you are
1873 effectively voting in favor of every declared exit as an exit.)
1875 [[AuthDirRejectUnlisted]] **AuthDirRejectUnlisted** **0**|**1**::
1876 Authoritative directories only. If set to 1, the directory server rejects
1877 all uploaded server descriptors that aren't explicitly listed in the
1878 fingerprints file. This acts as a "panic button" if we get hit with a Sybil
1879 attack. (Default: 0)
1881 [[AuthDirMaxServersPerAddr]] **AuthDirMaxServersPerAddr** __NUM__::
1882 Authoritative directories only. The maximum number of servers that we will
1883 list as acceptable on a single IP address. Set this to "0" for "no limit".
1886 [[AuthDirMaxServersPerAuthAddr]] **AuthDirMaxServersPerAuthAddr** __NUM__::
1887 Authoritative directories only. Like AuthDirMaxServersPerAddr, but applies
1888 to addresses shared with directory authorities. (Default: 5)
1890 [[AuthDirFastGuarantee]] **AuthDirFastGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**::
1891 Authoritative directories only. If non-zero, always vote the
1892 Fast flag for any relay advertising this amount of capacity or
1893 more. (Default: 100 KBytes)
1895 [[AuthDirGuardBWGuarantee]] **AuthDirGuardBWGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**::
1896 Authoritative directories only. If non-zero, this advertised capacity
1897 or more is always sufficient to satisfy the bandwidth requirement
1898 for the Guard flag. (Default: 250 KBytes)
1900 [[BridgePassword]] **BridgePassword** __Password__::
1901 If set, contains an HTTP authenticator that tells a bridge authority to
1902 serve all requested bridge information. Used by the (only partially
1903 implemented) "bridge community" design, where a community of bridge
1904 relay operators all use an alternate bridge directory authority,
1905 and their target user audience can periodically fetch the list of
1906 available community bridges to stay up-to-date. (Default: not set)
1908 [[V3AuthVotingInterval]] **V3AuthVotingInterval** __N__ **minutes**|**hours**::
1909 V3 authoritative directories only. Configures the server's preferred voting
1910 interval. Note that voting will __actually__ happen at an interval chosen
1911 by consensus from all the authorities' preferred intervals. This time
1912 SHOULD divide evenly into a day. (Default: 1 hour)
1914 [[V3AuthVoteDelay]] **V3AuthVoteDelay** __N__ **minutes**|**hours**::
1915 V3 authoritative directories only. Configures the server's preferred delay
1916 between publishing its vote and assuming it has all the votes from all the
1917 other authorities. Note that the actual time used is not the server's
1918 preferred time, but the consensus of all preferences. (Default: 5 minutes)
1920 [[V3AuthDistDelay]] **V3AuthDistDelay** __N__ **minutes**|**hours**::
1921 V3 authoritative directories only. Configures the server's preferred delay
1922 between publishing its consensus and signature and assuming it has all the
1923 signatures from all the other authorities. Note that the actual time used
1924 is not the server's preferred time, but the consensus of all preferences.
1925 (Default: 5 minutes)
1927 [[V3AuthNIntervalsValid]] **V3AuthNIntervalsValid** __NUM__::
1928 V3 authoritative directories only. Configures the number of VotingIntervals
1929 for which each consensus should be valid for. Choosing high numbers
1930 increases network partitioning risks; choosing low numbers increases
1931 directory traffic. Note that the actual number of intervals used is not the
1932 server's preferred number, but the consensus of all preferences. Must be at
1933 least 2. (Default: 3)
1935 [[V3BandwidthsFile]] **V3BandwidthsFile** __FILENAME__::
1936 V3 authoritative directories only. Configures the location of the
1937 bandwidth-authority generated file storing information on relays' measured
1938 bandwidth capacities. (Default: unset)
1940 [[V3AuthUseLegacyKey]] **V3AuthUseLegacyKey** **0**|**1**::
1941 If set, the directory authority will sign consensuses not only with its
1942 own signing key, but also with a "legacy" key and certificate with a
1943 different identity. This feature is used to migrate directory authority
1944 keys in the event of a compromise. (Default: 0)
1946 [[RephistTrackTime]] **RephistTrackTime** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
1947 Tells an authority, or other node tracking node reliability and history,
1948 that fine-grained information about nodes can be discarded when it hasn't
1949 changed for a given amount of time. (Default: 24 hours)
1951 [[VoteOnHidServDirectoriesV2]] **VoteOnHidServDirectoriesV2** **0**|**1**::
1952 When this option is set in addition to **AuthoritativeDirectory**, Tor
1953 votes on whether to accept relays as hidden service directories.
1956 [[AuthDirHasIPv6Connectivity]] **AuthDirHasIPv6Connectivity** **0**|**1**::
1957 Authoritative directories only. When set to 0, OR ports with an
1958 IPv6 address are being accepted without reachability testing.
1959 When set to 1, IPv6 OR ports are being tested just like IPv4 OR
1962 HIDDEN SERVICE OPTIONS
1963 ----------------------
1965 The following options are used to configure a hidden service.
1967 [[HiddenServiceDir]] **HiddenServiceDir** __DIRECTORY__::
1968 Store data files for a hidden service in DIRECTORY. Every hidden service
1969 must have a separate directory. You may use this option multiple times to
1970 specify multiple services. DIRECTORY must be an existing directory.
1972 [[HiddenServicePort]] **HiddenServicePort** __VIRTPORT__ [__TARGET__]::
1973 Configure a virtual port VIRTPORT for a hidden service. You may use this
1974 option multiple times; each time applies to the service using the most
1975 recent hiddenservicedir. By default, this option maps the virtual port to
1976 the same port on 127.0.0.1 over TCP. You may override the target port,
1977 address, or both by specifying a target of addr, port, or addr:port.
1978 You may also have multiple lines with the same VIRTPORT: when a user
1979 connects to that VIRTPORT, one of the TARGETs from those lines will be
1982 [[PublishHidServDescriptors]] **PublishHidServDescriptors** **0**|**1**::
1983 If set to 0, Tor will run any hidden services you configure, but it won't
1984 advertise them to the rendezvous directory. This option is only useful if
1985 you're using a Tor controller that handles hidserv publishing for you.
1988 [[HiddenServiceVersion]] **HiddenServiceVersion** __version__,__version__,__...__::
1989 A list of rendezvous service descriptor versions to publish for the hidden
1990 service. Currently, only version 2 is supported. (Default: 2)
1992 [[HiddenServiceAuthorizeClient]] **HiddenServiceAuthorizeClient** __auth-type__ __client-name__,__client-name__,__...__::
1993 If configured, the hidden service is accessible for authorized clients
1994 only. The auth-type can either be \'basic' for a general-purpose
1995 authorization protocol or \'stealth' for a less scalable protocol that also
1996 hides service activity from unauthorized clients. Only clients that are
1997 listed here are authorized to access the hidden service. Valid client names
1998 are 1 to 19 characters long and only use characters in A-Za-z0-9+-_ (no
1999 spaces). If this option is set, the hidden service is not accessible for
2000 clients without authorization any more. Generated authorization data can be
2001 found in the hostname file. Clients need to put this authorization data in
2002 their configuration file using **HidServAuth**.
2004 [[RendPostPeriod]] **RendPostPeriod** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
2005 Every time the specified period elapses, Tor uploads any rendezvous
2006 service descriptors to the directory servers. This information is also
2007 uploaded whenever it changes. (Default: 1 hour)
2009 TESTING NETWORK OPTIONS
2010 -----------------------
2012 The following options are used for running a testing Tor network.
2014 [[TestingTorNetwork]] **TestingTorNetwork** **0**|**1**::
2015 If set to 1, Tor adjusts default values of the configuration options below,
2016 so that it is easier to set up a testing Tor network. May only be set if
2017 non-default set of DirAuthorities is set. Cannot be unset while Tor is
2021 ServerDNSAllowBrokenConfig 1
2022 DirAllowPrivateAddresses 1
2023 EnforceDistinctSubnets 0
2025 AuthDirMaxServersPerAddr 0
2026 AuthDirMaxServersPerAuthAddr 0
2027 ClientDNSRejectInternalAddresses 0
2028 ClientRejectInternalAddresses 0
2029 CountPrivateBandwidth 1
2030 ExitPolicyRejectPrivate 0
2031 ExtendAllowPrivateAddresses 1
2032 V3AuthVotingInterval 5 minutes
2033 V3AuthVoteDelay 20 seconds
2034 V3AuthDistDelay 20 seconds
2035 MinUptimeHidServDirectoryV2 0 seconds
2036 TestingV3AuthInitialVotingInterval 5 minutes
2037 TestingV3AuthInitialVoteDelay 20 seconds
2038 TestingV3AuthInitialDistDelay 20 seconds
2039 TestingAuthDirTimeToLearnReachability 0 minutes
2040 TestingEstimatedDescriptorPropagationTime 0 minutes
2042 [[TestingV3AuthInitialVotingInterval]] **TestingV3AuthInitialVotingInterval** __N__ **minutes**|**hours**::
2043 Like V3AuthVotingInterval, but for initial voting interval before the first
2044 consensus has been created. Changing this requires that
2045 **TestingTorNetwork** is set. (Default: 30 minutes)
2047 [[TestingV3AuthInitialVoteDelay]] **TestingV3AuthInitialVoteDelay** __N__ **minutes**|**hours**::
2048 Like V3AuthVoteDelay, but for initial voting interval before
2049 the first consensus has been created. Changing this requires that
2050 **TestingTorNetwork** is set. (Default: 5 minutes)
2052 [[TestingV3AuthInitialDistDelay]] **TestingV3AuthInitialDistDelay** __N__ **minutes**|**hours**::
2053 Like V3AuthDistDelay, but for initial voting interval before
2054 the first consensus has been created. Changing this requires that
2055 **TestingTorNetwork** is set. (Default: 5 minutes)
2057 [[TestingAuthDirTimeToLearnReachability]] **TestingAuthDirTimeToLearnReachability** __N__ **minutes**|**hours**::
2058 After starting as an authority, do not make claims about whether routers
2059 are Running until this much time has passed. Changing this requires
2060 that **TestingTorNetwork** is set. (Default: 30 minutes)
2062 [[TestingEstimatedDescriptorPropagationTime]] **TestingEstimatedDescriptorPropagationTime** __N__ **minutes**|**hours**::
2063 Clients try downloading router descriptors from directory caches after this
2064 time. Changing this requires that **TestingTorNetwork** is set. (Default:
2067 [[TestingMinFastFlagThreshold]] **TestingMinFastFlagThreshold** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**::
2068 Minimum value for the Fast flag. Overrides the ordinary minimum taken
2069 from the consensus when TestingTorNetwork is set. (Default: 0.)
2075 Tor catches the following signals:
2077 [[SIGTERM]] **SIGTERM**::
2078 Tor will catch this, clean up and sync to disk if necessary, and exit.
2080 [[SIGINT]] **SIGINT**::
2081 Tor clients behave as with SIGTERM; but Tor servers will do a controlled
2082 slow shutdown, closing listeners and waiting 30 seconds before exiting.
2083 (The delay can be configured with the ShutdownWaitLength config option.)
2085 [[SIGHUP]] **SIGHUP**::
2086 The signal instructs Tor to reload its configuration (including closing and
2087 reopening logs), and kill and restart its helper processes if applicable.
2089 [[SIGUSR1]] **SIGUSR1**::
2090 Log statistics about current connections, past connections, and throughput.
2092 [[SIGUSR2]] **SIGUSR2**::
2093 Switch all logs to loglevel debug. You can go back to the old loglevels by
2096 [[SIGCHLD]] **SIGCHLD**::
2097 Tor receives this signal when one of its helper processes has exited, so it
2100 [[SIGPIPE]] **SIGPIPE**::
2101 Tor catches this signal and ignores it.
2103 [[SIGXFSZ]] **SIGXFSZ**::
2104 If this signal exists on your platform, Tor catches and ignores it.
2109 **@CONFDIR@/torrc**::
2110 The configuration file, which contains "option value" pairs.
2113 Fallback location for torrc, if @CONFDIR@/torrc is not found.
2115 **@LOCALSTATEDIR@/lib/tor/**::
2116 The tor process stores keys and other data here.
2118 __DataDirectory__**/cached-status/**::
2119 The most recently downloaded network status document for each authority.
2120 Each file holds one such document; the filenames are the hexadecimal
2121 identity key fingerprints of the directory authorities. Mostly obsolete.
2123 __DataDirectory__**/cached-consensus** and/or **cached-microdesc-consensus**::
2124 The most recent consensus network status document we've downloaded.
2126 __DataDirectory__**/cached-descriptors** and **cached-descriptors.new**::
2127 These files hold downloaded router statuses. Some routers may appear more
2128 than once; if so, the most recently published descriptor is used. Lines
2129 beginning with @-signs are annotations that contain more information about
2130 a given router. The ".new" file is an append-only journal; when it gets
2131 too large, all entries are merged into a new cached-descriptors file.
2133 __DataDirectory__**/cached-microdescs** and **cached-microdescs.new**::
2134 These files hold downloaded microdescriptors. Lines beginning with
2135 @-signs are annotations that contain more information about a given
2136 router. The ".new" file is an append-only journal; when it gets too
2137 large, all entries are merged into a new cached-microdescs file.
2139 __DataDirectory__**/cached-routers** and **cached-routers.new**::
2140 Obsolete versions of cached-descriptors and cached-descriptors.new. When
2141 Tor can't find the newer files, it looks here instead.
2143 __DataDirectory__**/state**::
2144 A set of persistent key-value mappings. These are documented in
2145 the file. These include:
2146 - The current entry guards and their status.
2147 - The current bandwidth accounting values (unused so far; see
2149 - When the file was last written
2150 - What version of Tor generated the state file
2151 - A short history of bandwidth usage, as produced in the router
2154 __DataDirectory__**/bw_accounting**::
2155 Used to track bandwidth accounting values (when the current period starts
2156 and ends; how much has been read and written so far this period). This file
2157 is obsolete, and the data is now stored in the \'state' file as well. Only
2158 used when bandwidth accounting is enabled.
2160 __DataDirectory__**/control_auth_cookie**::
2161 Used for cookie authentication with the controller. Location can be
2162 overridden by the CookieAuthFile config option. Regenerated on startup. See
2163 control-spec.txt for details. Only used when cookie authentication is
2166 __DataDirectory__**/keys/***::
2167 Only used by servers. Holds identity keys and onion keys.
2169 __DataDirectory__**/fingerprint**::
2170 Only used by servers. Holds the fingerprint of the server's identity key.
2172 __DataDirectory__**/approved-routers**::
2173 Only for naming authoritative directory servers (see
2174 **NamingAuthoritativeDirectory**). This file lists nickname to identity
2175 bindings. Each line lists a nickname and a fingerprint separated by
2176 whitespace. See your **fingerprint** file in the __DataDirectory__ for an
2177 example line. If the nickname is **!reject** then descriptors from the
2178 given identity (fingerprint) are rejected by this server. If it is
2179 **!invalid** then descriptors are accepted but marked in the directory as
2180 not valid, that is, not recommended.
2182 __DataDirectory__**/router-stability**::
2183 Only used by authoritative directory servers. Tracks measurements for
2184 router mean-time-between-failures so that authorities have a good idea of
2185 how to set their Stable flags.
2187 __HiddenServiceDirectory__**/hostname**::
2188 The <base32-encoded-fingerprint>.onion domain name for this hidden service.
2189 If the hidden service is restricted to authorized clients only, this file
2190 also contains authorization data for all clients.
2192 __HiddenServiceDirectory__**/private_key**::
2193 The private key for this hidden service.
2195 __HiddenServiceDirectory__**/client_keys**::
2196 Authorization data for a hidden service that is only accessible by
2201 **privoxy**(1), **torsocks**(1), **torify**(1) +
2203 **https://www.torproject.org/**
2209 Plenty, probably. Tor is still in development. Please report them.
2213 Roger Dingledine [arma at mit.edu], Nick Mathewson [nickm at alum.mit.edu].