tor-webwml.git

en/documentation.wml   1) ## translation metadata

en/documentation.wml   2) # Revision: $Revision$

en/documentation.wml   3) # Translation-Priority: 2-medium

documentation.html     4) 

en/documentation.wml   5) #include "head.wmi" TITLE="Tor: Documentation"

documentation.html     6) 

documentation.html     7) <div class="main-column">

documentation.html     8) 

en/documentation.wml   9) <a id="RunningTor"></a>
en/documentation.wml  10) <h2><a class="anchor" href="#RunningTor">Running Tor</a></h2>
en/documentation.wml  11) <ul>

en/documentation.wml  12) <li><a href="<page docs/tor-doc-windows>">Installing Tor

en/documentation.wml  13) on Win32</a></li>

en/documentation.wml  14) <li><a href="<page docs/tor-doc-osx>">Installing Tor on

en/documentation.wml  15) Mac OS X</a></li>

en/documentation.wml  16) <li><a href="<page docs/tor-doc-unix>">Installing Tor on

en/documentation.wml  17) Linux/BSD/Unix</a></li>

en/documentation.wml  18) <li><a href="<page torbutton/index>">Installing
en/documentation.wml  19) Torbutton for Tor</a></li>

en/documentation.wml  20) <li><a href="<page docs/tor-doc-relay>">Configuring a
en/documentation.wml  21) Tor relay</a></li>

en/documentation.wml  22) <li><a href="<page docs/tor-hidden-service>">Configuring

en/documentation.wml  23) a Tor hidden service</a></li>
en/documentation.wml  24) </ul>

documentation.html    25) 

en/documentation.wml  26) <a id="Support"></a>

en/documentation.wml  27) <a id="UpToSpeed"></a>
en/documentation.wml  28) <h2><a class="anchor" href="#UpToSpeed">Getting up to speed on Tor's past,
en/documentation.wml  29) present, and future</a></h2>
en/documentation.wml  30) 
en/documentation.wml  31) <ol>
en/documentation.wml  32) <li>
en/documentation.wml  33) First, read the <a href="<page overview>">overview page</a> to get a
en/documentation.wml  34) basic idea of how Tor works, what it's for, and who uses it.
en/documentation.wml  35) </li>
en/documentation.wml  36) 
en/documentation.wml  37) <li>
en/documentation.wml  38) <a href="<page download>">Install the Tor bundle</a> and try it out.
en/documentation.wml  39) Make sure you've got Firefox installed first, and be sure to read the
en/documentation.wml  40) <a href="<page download>#Warning">list of warnings</a> about ways you
en/documentation.wml  41) can screw up your anonymity.
en/documentation.wml  42) </li>
en/documentation.wml  43) 
en/documentation.wml  44) <li>
en/documentation.wml  45) Our <a
en/documentation.wml  46) href="https://wiki.torproject.org/noreply/TheOnionRouter/TorFAQ">FAQ</a>
en/documentation.wml  47) covers all sorts of topics, including questions about setting up a client
en/documentation.wml  48) or relay, concerns about anonymity attacks, why we didn't build Tor in

en/documentation.wml  49) other ways, etc.

en/documentation.wml  50) There's a separate <a href="<page faq-abuse>">Abuse FAQ</a> to answer
en/documentation.wml  51) common questions from or for relay operators.
en/documentation.wml  52) The <a href="<page eff/tor-legal-faq>">Tor Legal FAQ</a> is written by
en/documentation.wml  53) EFF lawyers, and aims to give you an overview of some of the legal issues
en/documentation.wml  54) that arise from the Tor project in the US.
en/documentation.wml  55) </li>
en/documentation.wml  56) 
en/documentation.wml  57) <li>The <a href="<page tor-manual>">manual</a>
en/documentation.wml  58) lists all the possible entries you can put in your <a
en/documentation.wml  59) href="https://wiki.torproject.org/noreply/TheOnionRouter/TorFAQ#torrc">torrc
en/documentation.wml  60) file</a>. We also provide a <a href="<page tor-manual-dev>">manual for
en/documentation.wml  61) the development version of Tor</a>.</li>
en/documentation.wml  62) 
en/documentation.wml  63) <li>If you have questions, we have an IRC channel (for users, relay
en/documentation.wml  64) operators, and developers)
en/documentation.wml  65) at <a href="irc://irc.oftc.net/tor">#tor on irc.oftc.net</a>. If
en/documentation.wml  66) you have a bug, especially a crash bug, read <a
en/documentation.wml  67) href="https://wiki.torproject.org/wiki/TheOnionRouter/TorFAQ#RelayCrashing">how
en/documentation.wml  68) to report a Tor bug</a> first and then tell us as much information
en/documentation.wml  69) about it as you can in
en/documentation.wml  70) <a href="https://bugs.torproject.org/tor">our bugtracker</a>.
en/documentation.wml  71) (If your bug is
en/documentation.wml  72) with Privoxy, your browser, or some other application, please don't put

en/documentation.wml  73) it in our bugtracker.) The
en/documentation.wml  74) <a href="#MailingLists">or-talk mailing list</a> can also be useful.

en/documentation.wml  75) </li>
en/documentation.wml  76) 
en/documentation.wml  77) <li>
en/documentation.wml  78) <a href="https://blog.torproject.org/">Tor has a blog now</a>.
en/documentation.wml  79) We try to keep it updated every week or two with the latest news.
en/documentation.wml  80) </li>
en/documentation.wml  81) 

en/documentation.wml  82) <li>
en/documentation.wml  83) Download and watch Roger's overview talk from What The Hack (<a
en/documentation.wml  84) href="http://freehaven.net/~arma/wth-anonymous-communication-58.mp4">video</a>,
en/documentation.wml  85) <a href="http://freehaven.net/~arma/wth1.pdf">slides</a>, <a
en/documentation.wml  86) href="http://wiki.whatthehack.org/index.php/Anonymous_communication_for_the_United_States_Department_of_Defense...and_you">abstract</a>).
en/documentation.wml  87) This talk was given in July 2005, back when we were funded by EFF and back
en/documentation.wml  88) when the network was quite small, but it still provides good background
en/documentation.wml  89) on how Tor works and what it's for.
en/documentation.wml  90) </li>
en/documentation.wml  91) 

en/documentation.wml  92) <li>
en/documentation.wml  93) Look through our <a href="#DesignDoc">Design
en/documentation.wml  94) Documents</a>. Notice that we have RFC-style specs to tell you exactly
en/documentation.wml  95) how Tor is built.
en/documentation.wml  96) </li>
en/documentation.wml  97) 
en/documentation.wml  98) <li>
en/documentation.wml  99) There's a skeletal <a

en/documentation.wml 100) href="<svnsandbox>doc/roadmaps/2008-12-19-roadmap-full.pdf">list of items

en/documentation.wml 101) we'd like to tackle in the future</a>. Alas, many of those items need
en/documentation.wml 102) to be fleshed out more before they'll make sense to people who aren't
en/documentation.wml 103) Tor developers, but you can still get a general sense of what issues
en/documentation.wml 104) need to be resolved next.
en/documentation.wml 105) </li>
en/documentation.wml 106) 
en/documentation.wml 107) <li>

en/documentation.wml 108) Download and watch Nick's "Technical changes since 2004" talk from
en/documentation.wml 109) Defcon in July 2007 (<a
en/documentation.wml 110) href="http://freehaven.net/~arma/Defcon15-Mathewson-Technical_Changes_since_you_Last_Heard_about_Tor.mp4">video</a>, <a
en/documentation.wml 111) href="http://freehaven.net/~nickm/slides/Defcon07/TorChanges.pdf">slides</a>),
en/documentation.wml 112) Roger's "blocking-resistance

en/documentation.wml 113) and circumvention" talk from 23C3 in December 2006 (<a
en/documentation.wml 114) href="http://freehaven.net/~arma/23C3-1444-en-tor_and_china.m4v">video</a>,
en/documentation.wml 115) <a href="http://freehaven.net/~arma/slides-23c3.pdf">slides</a>,
en/documentation.wml 116) <a href="http://events.ccc.de/congress/2006/Fahrplan/events/1444.en.html">abstract</a>,
en/documentation.wml 117) <a href="<svnsandbox>doc/design-paper/blocking.html">design paper</a>),

en/documentation.wml 118) and Roger's "Current events in 2007" talk from 24C3 in December

en/documentation.wml 119) 2007 (<a
en/documentation.wml 120) href="http://freehaven.net/~arma/24c3-2325-en-current_events_in_tor_development.mp4">video</a>,
en/documentation.wml 121) <a href="http://freehaven.net/~arma/slides-24c3.pdf">slides</a>,
en/documentation.wml 122) <a href="http://events.ccc.de/congress/2007/Fahrplan/events/2325.en.html">abstract</a>).
en/documentation.wml 123) We also have the What The Hack tutorial on hidden services (<a
en/documentation.wml 124) href="http://freehaven.net/~arma/wth_tor_hidden_services.mp4">video</a>,
en/documentation.wml 125) <a href="http://freehaven.net/~arma/wth3.pdf">slides</a>).
en/documentation.wml 126) </li>
en/documentation.wml 127) 

en/documentation.wml 128) <li>

en/documentation.wml 129) See Mike's "Securing the Tor network" talk from Defcon in July 2007
en/documentation.wml 130) (<a href="http://freehaven.net/~arma/Defcon15-Mike_Perry-Securing_the_Tor_Network.mp4">video</a>,
en/documentation.wml 131)  <a href="http://freehaven.net/~arma/SecuringTheTorNetwork.pdf">slides</a>).

en/documentation.wml 132) It describes common ways to attack networks like Tor and how we try
en/documentation.wml 133) to defend against them, and it introduces the <a

en/documentation.wml 134) href="https://svn.torproject.org/svn/torflow/trunk/README">Torflow</a>
en/documentation.wml 135) script collection.

en/documentation.wml 136) </li>
en/documentation.wml 137) 

en/documentation.wml 138) <li>
en/documentation.wml 139) Learn about the <a
en/documentation.wml 140) href="<svnsandbox>doc/spec/proposals/001-process.txt">Tor
en/documentation.wml 141) proposal process for changing our design</a>, and look over the <a
en/documentation.wml 142) href="<svnsandbox>doc/spec/proposals/">existing proposals</a>.
en/documentation.wml 143) </li>
en/documentation.wml 144) 
en/documentation.wml 145) <li>
en/documentation.wml 146) Our <a href="<svnsandbox>doc/TODO">developer TODO file</a> starts with a
en/documentation.wml 147) timeline for external promises &mdash; things <a href="<page sponsors>">our
en/documentation.wml 148) sponsors</a> have paid to see done. It also lists many other tasks
en/documentation.wml 149) and topics we'd like to tackle next.
en/documentation.wml 150) </li>
en/documentation.wml 151) 
en/documentation.wml 152) <li>
en/documentation.wml 153) Once you're up to speed, things will continue to change surprisingly fast.
en/documentation.wml 154) The <a href="#MailingLists">or-dev mailing list</a> is where the complex

en/documentation.wml 155) discussion happens, and the #tor IRC channel

en/documentation.wml 156) is where the less complex discussion happens.
en/documentation.wml 157) </li>
en/documentation.wml 158) 
en/documentation.wml 159) </ol>
en/documentation.wml 160) 

en/documentation.wml 161) <a id="MailingLists"></a>
en/documentation.wml 162) <h2><a class="anchor" href="#MailingLists">Mailing List Information</a></h2>
en/documentation.wml 163) <ul>
en/documentation.wml 164) <li>The <a href="http://archives.seul.org/or/announce/">or-announce
en/documentation.wml 165) mailing list</a> is a low volume list for announcements of new releases
en/documentation.wml 166) and critical security updates. Everybody should be on this list.
en/documentation.wml 167) There is also an
en/documentation.wml 168) <a href="http://rss.gmane.org/gmane.network.onion-routing.announce">RSS
en/documentation.wml 169) feed</a> of or-announce at <a href="http://gmane.org">gmane.org</a>.</li>
en/documentation.wml 170) <li>The <a href="http://archives.seul.org/or/talk/">or-talk list</a>
en/documentation.wml 171) is where a lot of discussion happens, and is where we send notifications
en/documentation.wml 172) of prerelease versions and release candidates.</li>
en/documentation.wml 173) <li>The <a href="http://archives.seul.org/or/dev/">or-dev list</a>
en/documentation.wml 174) is for posting by developers only, and is very low traffic.</li>

en/documentation.wml 175) <li>A list for <a href="http://archives.seul.org/tor/mirrors/">mirror
en/documentation.wml 176) operators</a> for new website mirrors, and supporting <a href="<page
en/documentation.wml 177) mirrors>">current website mirrors</a>.</li>
en/documentation.wml 178) <li>A list for <a href="http://archives.seul.org/or/cvs/">svn and git
en/documentation.wml 179) commits</a> may be interesting for developers.</li>

en/documentation.wml 180) <li>The <a href="http://archives.seul.org/tor/relays/">tor-relays list</a> is where discussions about running, configuring, and handling your tor relay happen.  If you currently run a relay, or are thinking about doing so, this is the list for you.</li>

en/documentation.wml 181) </ul>
en/documentation.wml 182) 

documentation.html   183) <a id="DesignDoc"></a>

documentation.html   184) <h2><a class="anchor" href="#DesignDoc">Design Documents</a></h2>

documentation.html   185) <ul>

en/documentation.wml 186) <li>The <b>design document</b> (published at Usenix Security 2004)
en/documentation.wml 187) gives our justifications and security analysis for the Tor design:

en/documentation.wml 188) <a href="<svnsandbox>doc/design-paper/tor-design.pdf">PDF</a> and
en/documentation.wml 189) <a href="<svnsandbox>doc/design-paper/tor-design.html">HTML</a>

en/documentation.wml 190) versions available.</li>
en/documentation.wml 191) <li>Our follow-up paper on <b>challenges in low-latency anonymity</b>

documentation.html   192) (still in draft form) details more recent experiences and directions:

en/documentation.wml 193) <a href="<svnsandbox>doc/design-paper/challenges.pdf">PDF

en/documentation.wml 194) draft</a>.</li>

en/documentation.wml 195) <li>Our paper at WEIS 2006 &mdash; <b>Anonymity Loves Company:
en/documentation.wml 196) Usability and the Network Effect</b> &mdash; explains why usability in
en/documentation.wml 197) anonymity systems matters for their security: <a
en/documentation.wml 198) href="http://freehaven.net/anonbib/cache/usability:weis2006.pdf">PDF</a>.</li>

en/documentation.wml 199) <li>Our preliminary design to make it harder for large firewalls to
en/documentation.wml 200) prevent access to the Tor network is described in
en/documentation.wml 201) <b>design of a blocking-resistant anonymity system</b>:

en/documentation.wml 202) <a href="<svnsandbox>doc/design-paper/blocking.pdf">PDF draft</a> and
en/documentation.wml 203) <a href="<svnsandbox>doc/design-paper/blocking.html">HTML draft</a>.

en/documentation.wml 204) Want to <a href="<page volunteer>#Coding">help us build it</a>?</li>

en/documentation.wml 205) <li>The <b>specifications</b> aim to give
en/documentation.wml 206) developers enough information to build a compatible version of Tor:

documentation.html   207) <ul>

en/documentation.wml 208) <li><a href="<svnsandbox>doc/spec/tor-spec.txt">Main Tor specification</a></li>

en/documentation.wml 209) <li><a href="<svnsandbox>doc/spec/dir-spec.txt">Tor
en/documentation.wml 210) version 3 directory server specification</a> (and older <a
en/documentation.wml 211) href="<svnsandbox>doc/spec/dir-spec-v1.txt">version 1</a> and <a
en/documentation.wml 212) href="<svnsandbox>doc/spec/dir-spec-v2.txt">version 2</a> directory
en/documentation.wml 213) specifications)</li>

en/documentation.wml 214) <li><a href="<svnsandbox>doc/spec/control-spec.txt">Tor control protocol

en/documentation.wml 215) specification</a></li>

en/documentation.wml 216) <li><a href="<svnsandbox>doc/spec/rend-spec.txt">Tor rendezvous
en/documentation.wml 217) specification</a></li>

en/documentation.wml 218) <li><a href="<svnsandbox>doc/spec/path-spec.txt">Tor path selection

en/documentation.wml 219) specification</a></li>

en/documentation.wml 220) <li><a href="<svnsandbox>doc/spec/address-spec.txt">Special hostnames in

en/documentation.wml 221) Tor</a></li>

en/documentation.wml 222) <li><a href="<svnsandbox>doc/spec/socks-extensions.txt">Tor's SOCKS support
en/documentation.wml 223) and extensions</a></li>

en/documentation.wml 224) <li><a href="<svnsandbox>doc/spec/version-spec.txt">How Tor version numbers

en/documentation.wml 225) work</a></li>

en/documentation.wml 226) <li><a href="<svnsandbox>doc/spec/proposals/">In-progress drafts of

en/documentation.wml 227) new specifications and proposed changes</a></li>

en/documentation.wml 228) </ul></li>

en/documentation.wml 229) 

en/documentation.wml 230) </ul>

documentation.html   231) 

en/documentation.wml 232) <a id="NeatLinks"></a>
en/documentation.wml 233) <h2><a class="anchor" href="#NeatLinks">Neat Links</a></h2>

documentation.html   234) <ul>

en/documentation.wml 235) <li>The <a href="https://wiki.torproject.org/noreply/TheOnionRouter">Tor

en/documentation.wml 236) wiki</a> provides a plethora of helpful contributions from Tor
en/documentation.wml 237) users. Check it out!</li>

documentation.html   238) <li><a

en/documentation.wml 239) href="https://wiki.torproject.org/noreply/TheOnionRouter/SupportPrograms">A

en/documentation.wml 240) list of supporting programs you might want to use in association with
en/documentation.wml 241) Tor</a>.</li>

en/documentation.wml 242) <li><a href="https://check.torproject.org/">The

en/documentation.wml 243) Tor detector</a> or <a href="http://torcheck.xenobite.eu/">the other
en/documentation.wml 244) Tor detector</a> try to guess if you're using Tor or not.</li>

en/documentation.wml 245) <li>Check out the

en/documentation.wml 246) <a href="http://trunk.torstatus.kgprog.com/index.php">Tor Status</a> page, or

en/documentation.wml 247) Xenobite's <a href="https://torstat.xenobite.eu/">Tor node status</a> page.
en/documentation.wml 248) Remember that these lists may not be as accurate as what your Tor

en/documentation.wml 249) client uses, because your client fetches its own directory information and
en/documentation.wml 250) examines it locally.</li>

en/documentation.wml 251) <li>Read <a
en/documentation.wml 252) href="http://freehaven.net/anonbib/topic.html#Anonymous_20communication">these
en/documentation.wml 253) papers</a> (especially the ones in boxes) to get up to speed on the field
en/documentation.wml 254) of anonymous communication systems.</li>

documentation.html   255) </ul>

documentation.html   256) 

en/documentation.wml 257) <a id="Developers"></a>

en/documentation.wml 258) <h2><a class="anchor" href="#Developers">For Developers</a></h2>

en/documentation.wml 259)   Browse the Tor <b>source repository</b>:

en/documentation.wml 260)   <ul>

en/documentation.wml 261)     <li><a href="<svnsandbox>">Browse the repository's source tree directly</a></li>
en/documentation.wml 262)     <li>Read-only access:
en/documentation.wml 263)       <ul>

en/documentation.wml 264)         <li><kbd>git clone git://git.torproject.org/git/tor</kbd></li>

en/documentation.wml 265)         <li>The development branch is <kbd>master</kbd>.  The active maintenance branches are <kbd>maint-0.2.0</kbd> and <kbd>maint-0.2.1</kbd>.</li>

en/documentation.wml 266)         <li><b>Git HTTPS certificate fingerprint:</b> 8D:58:41:85:9C:2B:82:84:7C:84:0E:B9:BB:58:16:AC</li>
en/documentation.wml 267)         <li><kbd>svn checkout https://svn.torproject.org/svn/website/trunk website</kbd></li>

en/documentation.wml 268)       </ul>
en/documentation.wml 269)     </li>

en/documentation.wml 270)     <li>Read-Write access (website only):

en/documentation.wml 271)       <ul>

en/documentation.wml 272)         <li><kbd>svn checkout https://tor-svn.freehaven.net/svn/website/trunk website</kbd></li>

en/documentation.wml 273)         <li><b>SVN HTTPS certificate fingerprint:</b> 11:34:5c:b1:c4:12:76:10:86:ce:df:69:3d:06:a9:57:fa:dc:c9:29</li>

en/documentation.wml 274)       </ul>

en/documentation.wml 275)     </li>

en/documentation.wml 276)     <li><a href="https://git.torproject.org/checkout/githax/master/doc/Howto.txt">Basic instructions for using Git to contribute to Tor software.</a></li>

en/documentation.wml 277)   </ul>
en/documentation.wml 278) 

documentation.html   279)   </div><!-- #main -->
documentation.html   280)