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 docs/tor-switchproxy>">Installing

en/documentation.wml  19) SwitchProxy 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) <h2><a class="anchor" href="#Support">Getting Support</a></h2>

documentation.html    28) <ul>

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

en/documentation.wml  30) Technical FAQ Wiki</a> should be the first place you look. The

en/documentation.wml  31) <a href="https://wiki.torproject.org/wiki/TheOnionRouter/TorifyHOWTO">Guide

en/documentation.wml  32) to Torifying various applications</a> is also popular. (While we

en/documentation.wml  33) monitor the Wiki page to help ensure accuracy, the Tor developers are
en/documentation.wml  34) not responsible for the content.)</li>
en/documentation.wml  35) <li>The <a href="<page faq-abuse>">Abuse FAQ</a> is a collection of

en/documentation.wml  36) common questions and issues discussed when running a Tor relay.</li>

en/documentation.wml  37) <li>The <a href="<page eff/tor-legal-faq>">Tor Legal FAQ</a> is written by
en/documentation.wml  38) EFF lawyers. It aims to give you an overview of some of the legal issues
en/documentation.wml  39) that arise from the Tor project in the US.</li>
en/documentation.wml  40) <li>The <a href="<page tor-manual>">manual</a>
en/documentation.wml  41) lists all the possible entries you can put in your <a

en/documentation.wml  42) href="https://wiki.torproject.org/noreply/TheOnionRouter/TorFAQ#torrc">torrc

en/documentation.wml  43) file</a>. We also provide a <a href="<page tor-manual-dev>">manual for

en/documentation.wml  44) the development version of Tor</a>.</li>

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

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

en/documentation.wml  48) <li>The Tor IRC channel (for users, relay operators, and developers)

en/documentation.wml  49) is <a href="irc://irc.oftc.net/tor">#tor on irc.oftc.net</a>.</li>
en/documentation.wml  50) <li>We have a <a

en/documentation.wml  51) href="https://bugs.torproject.org/tor">bugtracker</a>.

en/documentation.wml  52) If you have a bug, especially a crash bug, read <a

en/documentation.wml  53) href="https://wiki.torproject.org/wiki/TheOnionRouter/TorFAQ#RelayCrashing">how

en/documentation.wml  54) to report a Tor bug</a> first and then tell us as much information
en/documentation.wml  55) about it as you can in the bugtracker. (If your bug is
en/documentation.wml  56) with Privoxy, your browser, or some other application, please don't put
en/documentation.wml  57) it in our bugtracker.)</li>
en/documentation.wml  58) <li>Try the or-talk mailing list <a href="#MailingLists">below</a>.
en/documentation.wml  59) <li>As a last resort, look through <a href="<page contact>">the Tor
en/documentation.wml  60) contact page</a>.</li>

documentation.html    61) </ul>
documentation.html    62) 

en/documentation.wml  63) <a id="MailingLists"></a>
en/documentation.wml  64) <h2><a class="anchor" href="#MailingLists">Mailing List Information</a></h2>

documentation.html    65) <ul>

en/documentation.wml  66) <li>The <a href="http://archives.seul.org/or/announce/">or-announce
en/documentation.wml  67) mailing list</a> is a low volume list for announcements of new releases

en/documentation.wml  68) and critical security updates. Everybody should be on this list.
en/documentation.wml  69) There is also an
en/documentation.wml  70) <a href="http://rss.gmane.org/gmane.network.onion-routing.announce">RSS
en/documentation.wml  71) feed</a> of or-announce at <a href="http://gmane.org">gmane.org</a>.</li>

en/documentation.wml  72) <li>The <a href="http://archives.seul.org/or/talk/">or-talk list</a>
en/documentation.wml  73) is where a lot of discussion happens, and is where we send notifications
en/documentation.wml  74) of prerelease versions and release candidates.</li>
en/documentation.wml  75) <li>The <a href="http://archives.seul.org/or/dev/">or-dev list</a>
en/documentation.wml  76) is for posting by developers only, and is very low traffic.</li>

en/documentation.wml  77) <li>A list for <a href="http://archives.seul.org/or/cvs/">svn commits</a>

en/documentation.wml  78) may be interesting for developers.</li>

documentation.html    79) </ul>
documentation.html    80) 

en/documentation.wml  81) <a id="UpToSpeed"></a>
en/documentation.wml  82) <h2><a class="anchor" href="#UpToSpeed">Getting up to speed on Tor's past,
en/documentation.wml  83) present, and future</a></h2>
en/documentation.wml  84) 
en/documentation.wml  85) <ol>
en/documentation.wml  86) <li>
en/documentation.wml  87) First, read the <a href="<page overview>">overview page</a> to get a
en/documentation.wml  88) basic idea of how Tor works, what it's for, and who uses it.
en/documentation.wml  89) </li>
en/documentation.wml  90) 
en/documentation.wml  91) <li>
en/documentation.wml  92) <a href="<page download>">Install the Tor bundle</a> and try it out.
en/documentation.wml  93) Make sure you've got Firefox installed first, and be sure to read the
en/documentation.wml  94) <a href="<page download>#Warning">list of warnings</a> about ways you
en/documentation.wml  95) can screw up your anonymity.
en/documentation.wml  96) </li>
en/documentation.wml  97) 
en/documentation.wml  98) <li>
en/documentation.wml  99) Download and watch Roger's overview talk from What The Hack (<a
en/documentation.wml 100) href="http://freehaven.net/~arma/wth-anonymous-communication-58.mp4">video</a>,
en/documentation.wml 101) <a href="http://freehaven.net/~arma/wth1.pdf">slides</a>, <a
en/documentation.wml 102) href="http://wiki.whatthehack.org/index.php/Anonymous_communication_for_the_United_States_Department_of_Defense...and_you">abstract</a>).
en/documentation.wml 103) This talk was given in July 2005, back when we were funded by EFF and back
en/documentation.wml 104) when the network was quite small, but it still provides good background
en/documentation.wml 105) on how Tor works and what it's for.
en/documentation.wml 106) </li>
en/documentation.wml 107) 
en/documentation.wml 108) <li>
en/documentation.wml 109) Our <a
en/documentation.wml 110) href="https://wiki.torproject.org/noreply/TheOnionRouter/TorFAQ">FAQ</a>
en/documentation.wml 111) covers all sorts of topics, including questions about setting up a client
en/documentation.wml 112) or relay, concerns about anonymity attacks, why we didn't build Tor in
en/documentation.wml 113) other ways, and discussion of Tor users and abuse.
en/documentation.wml 114) </li>
en/documentation.wml 115) 
en/documentation.wml 116) <li>
en/documentation.wml 117) <a href="https://blog.torproject.org/">Tor has a blog now</a>.
en/documentation.wml 118) We try to keep it updated every week or two with the latest news.
en/documentation.wml 119) </li>
en/documentation.wml 120) 
en/documentation.wml 121) <li>
en/documentation.wml 122) Look through our <a href="#DesignDoc">Design
en/documentation.wml 123) Documents</a>. Notice that we have RFC-style specs to tell you exactly
en/documentation.wml 124) how Tor is built.
en/documentation.wml 125) </li>
en/documentation.wml 126) 
en/documentation.wml 127) <li>
en/documentation.wml 128) There's a skeletal <a
en/documentation.wml 129) href="<svnsandbox>doc/design-paper/roadmap-future.pdf">list of items
en/documentation.wml 130) we'd like to tackle in the future</a>. Alas, many of those items need
en/documentation.wml 131) to be fleshed out more before they'll make sense to people who aren't
en/documentation.wml 132) Tor developers, but you can still get a general sense of what issues
en/documentation.wml 133) need to be resolved next.
en/documentation.wml 134) </li>
en/documentation.wml 135) 
en/documentation.wml 136) <li>
en/documentation.wml 137) Download and watch Roger's "blocking-resistance
en/documentation.wml 138) and circumvention" talk from 23C3 in December 2006 (<a
en/documentation.wml 139) href="http://freehaven.net/~arma/23C3-1444-en-tor_and_china.m4v">video</a>,
en/documentation.wml 140) <a href="http://freehaven.net/~arma/slides-23c3.pdf">slides</a>,
en/documentation.wml 141) <a href="http://events.ccc.de/congress/2006/Fahrplan/events/1444.en.html">abstract</a>,
en/documentation.wml 142) <a href="<svnsandbox>doc/design-paper/blocking.html">design paper</a>),
en/documentation.wml 143) or Roger's "Current events in Tor development" talk from 24C3 in December
en/documentation.wml 144) 2007 (<a
en/documentation.wml 145) href="http://freehaven.net/~arma/24c3-2325-en-current_events_in_tor_development.mp4">video</a>,
en/documentation.wml 146) <a href="http://freehaven.net/~arma/slides-24c3.pdf">slides</a>,
en/documentation.wml 147) <a href="http://events.ccc.de/congress/2007/Fahrplan/events/2325.en.html">abstract</a>).
en/documentation.wml 148) We also have the What The Hack tutorial on hidden services (<a
en/documentation.wml 149) href="http://freehaven.net/~arma/wth_tor_hidden_services.mp4">video</a>,
en/documentation.wml 150) <a href="http://freehaven.net/~arma/wth3.pdf">slides</a>).
en/documentation.wml 151) </li>
en/documentation.wml 152) 
en/documentation.wml 153) <li>
en/documentation.wml 154) Learn about the <a
en/documentation.wml 155) href="<svnsandbox>doc/spec/proposals/001-process.txt">Tor
en/documentation.wml 156) proposal process for changing our design</a>, and look over the <a
en/documentation.wml 157) href="<svnsandbox>doc/spec/proposals/">existing proposals</a>.
en/documentation.wml 158) </li>
en/documentation.wml 159) 
en/documentation.wml 160) <li>
en/documentation.wml 161) Our <a href="<svnsandbox>doc/TODO">developer TODO file</a> starts with a
en/documentation.wml 162) timeline for external promises &mdash; things <a href="<page sponsors>">our
en/documentation.wml 163) sponsors</a> have paid to see done. It also lists many other tasks
en/documentation.wml 164) and topics we'd like to tackle next.
en/documentation.wml 165) </li>
en/documentation.wml 166) 
en/documentation.wml 167) <li>
en/documentation.wml 168) Once you're up to speed, things will continue to change surprisingly fast.
en/documentation.wml 169) The <a href="#MailingLists">or-dev mailing list</a> is where the complex
en/documentation.wml 170) discussion happens, and the <a href="#Support">#tor IRC channel</a>
en/documentation.wml 171) is where the less complex discussion happens.
en/documentation.wml 172) </li>
en/documentation.wml 173) 
en/documentation.wml 174) </ol>
en/documentation.wml 175) 

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

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

documentation.html   178) <ul>

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

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

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

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

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

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

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

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

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

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

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

documentation.html   200) <ul>

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

en/documentation.wml 202) <li><a href="<svnsandbox>doc/spec/dir-spec.txt">Tor
en/documentation.wml 203) version 3 directory server specification</a> (and older <a
en/documentation.wml 204) href="<svnsandbox>doc/spec/dir-spec-v1.txt">version 1</a> and <a
en/documentation.wml 205) href="<svnsandbox>doc/spec/dir-spec-v2.txt">version 2</a> directory
en/documentation.wml 206) specifications)</li>

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

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

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

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

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

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

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

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

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

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

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

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

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

en/documentation.wml 222) 

en/documentation.wml 223) </ul>

documentation.html   224) 

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

documentation.html   227) <ul>

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

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

documentation.html   231) <li><a

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

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

en/documentation.wml 235) <li><a href="http://check.torproject.org/">The
en/documentation.wml 236) Tor detector</a> or <a href="http://torcheck.xenobite.eu/">the other
en/documentation.wml 237) Tor detector</a> try to guess if you're using Tor or not.</li>

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

en/documentation.wml 239) <a href="http://torstatus.kgprog.com/">Tor Status</a> page, the other

en/documentation.wml 240) <a href="http://torstatus.blutmagie.de/">Tor Status</a> page, or

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

en/documentation.wml 243) client uses, because your client fetches all the authoritative directories
en/documentation.wml 244) and combines them locally.</li>

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

documentation.html   249) </ul>

documentation.html   250) 

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

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

en/documentation.wml 253)   Browse the Tor <b>source repository</b>: (which may not necessarily work or even compile)

en/documentation.wml 254)   <ul>

en/documentation.wml 255)     <li><a href="<svnsandbox>">Regularly updated SVN sandbox</a></li>

en/documentation.wml 256)     <li><a href="https://tor-svn.freehaven.net/svn/tor/trunk">Browse the repository's source tree directly</a></li>

en/documentation.wml 257)     <li><a href="http://cvs.seul.org/viewcvs/viewcvs.cgi/tor/?root=Tor">ViewCVS</a></li>

en/documentation.wml 258)     <li>anonymous <a href="http://subversion.tigris.org/">subversion</a> access:
en/documentation.wml 259)       <ul>
en/documentation.wml 260)         <li>Make a new empty directory and cd into it.</li>

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

en/documentation.wml 263)         <li>To check out the maintenance branch, use<br /><kbd>svn checkout https://tor-svn.freehaven.net/svn/tor/branches/tor-0_1_2-patches</kbd></li>

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

en/documentation.wml 266)     </li>
en/documentation.wml 267)   </ul>
en/documentation.wml 268) 

documentation.html   269)   </div><!-- #main -->
documentation.html   270)