tor.1.txt 128 KB

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