docs/en/documentation.wml
2a9aaa80
 ## translation metadata
40e07e2e
 # Revision: $Revision$
2a9aaa80
 # Translation-Priority: 2-medium
 
 #include "head.wmi" TITLE="Tor: Documentation" CHARSET="UTF-8"
 <div id="content" class="clearfix">
   <div id="breadcrumbs">
b289ef06
     <a href="<page index>">Home &raquo; </a>
2a9aaa80
     <a href="<page docs/documentation>">Documentation</a>
   </div>
10d51bd5
   <div id="maincol">
2a9aaa80
     <a id="RunningTor"></a>
     <a id="Support"></a>
     <a id="UpToSpeed"></a>
     <h1><a class="anchor" href="#UpToSpeed">Getting up to speed on Tor's past,
     present, and future</a></h1>
10d51bd5
 
2a9aaa80
     <ol>
     <li>
     First, read the <a href="<page about/overview>">overview page</a> to get a
     basic idea of how Tor works, what it's for, and who uses it.
     </li>
10d51bd5
 
2a9aaa80
     <li>
32700e09
     <a href="<page download/download>">Install Tor Browser</a> and try it out.
e0a1b1f1
     Be sure to read the
2a9aaa80
     <a href="<page download/download>#Warning">list of warnings</a> about ways you
f33030a4
     can screw up your anonymity. Look through the <a
     href="https://www.torproject.org/projects/torbrowser/design/">Tor
     Browser Design Document</a>.
2a9aaa80
     </li>
10d51bd5
 
2a9aaa80
     <li>
     Our <a
baa77659
     href="<page docs/faq>">FAQ</a>
2a9aaa80
     covers all sorts of topics, including questions about setting up a client
     or relay, concerns about anonymity attacks, why we didn't build Tor in
     other ways, etc.
     There's a separate <a href="<page docs/faq-abuse>">Abuse FAQ</a> to answer
     common questions from or for relay operators.
     The <a href="<page eff/tor-legal-faq>">Tor Legal FAQ</a> is written by
     EFF lawyers, and aims to give you an overview of some of the legal issues
fc652fe1
     that arise from The Tor Project in the US.
2a9aaa80
     </li>
10d51bd5
 
c2b8f902
     <li>Check out the <a href="https://tor.stackexchange.com/">Tor
     Stack Exchange Q&A Site</a>, and help us make the questions and
     answers better.</li>
 
06509a96
     <li>The <a href="<page docs/tor-manual>">manual</a>
2a9aaa80
     lists all the possible entries you can put in your <a
e57c8363
     href="<page docs/faq>#torrc">torrc
2a9aaa80
     file</a>. We also provide a <a href="<page docs/tor-manual-dev>">manual for
     the development version of Tor</a>.</li>
10d51bd5
 
2a9aaa80
     <li>If you have questions, we have an IRC channel (for users, relay
     operators, and developers)
     at <a href="irc://irc.oftc.net/tor">#tor on irc.oftc.net</a>. If
     you have a bug, especially a crash bug, read <a
da280ad7
     href="<wikifaq>#MyTorkeepscrashing.">how
2a9aaa80
     to report a Tor bug</a> first and then tell us as much information
     about it as you can in
     <a href="https://bugs.torproject.org/tor">our bugtracker</a>.
     (If your bug is
9097a38f
     with your browser or some other application, please don't put
2a9aaa80
     it in our bugtracker.) The
50d53f30
     <a href="#MailingLists">tor-talk mailing list</a> can also be useful.
2a9aaa80
     </li>
10d51bd5
 
2a9aaa80
     <li>
f07c8b2f
     <a href="<blog>">Tor has a blog</a>.
2a9aaa80
     We try to keep it updated every week or two with the latest news.
     </li>
10d51bd5
 
2a9aaa80
     <li>
7dff608c
     Download and watch Roger's Tor
     overview talk from Internet Days in Sweden (<a
     href="https://media.torproject.org/video/tor-internet-days-2010.mp4">video</a>,
     <a
     href="https://svn.torproject.org/svn/projects/presentations/slides-stanford10.pdf">slides</a>,
     <a href="http://www.youtube.com/watch?v=35l56KjTCb8">youtube</a>),
25475f57
     which provides good background on how Tor works and what it's for.
2a9aaa80
     </li>
10d51bd5
 
6c61b4d7
     <li>
     Learn about our censorship circumvention side: watch our 28C3
     talk in December 2011 on how governments have tried to block Tor (<a
     href="https://media.torproject.org/video/28c3-4800-en-how_governments_have_tried_to_block_tor_h264.mp4">video</a>,
     <a href="http://www.youtube.com/watch?v=GwMr8Xl7JMQ">youtube</a>, <a
     href="https://svn.torproject.org/svn/projects/presentations/slides-28c3.pdf">slides</a>),
     an <a
     href="https://svn.torproject.org/svn/projects/articles/circumvention-features.html">overview
     of what to look for in a circumvention tool</a>,
     and the original "blocking-resistance and
     circumvention" talk from 23C3 in December 2006 (<a
     href="http://freehaven.net/~arma/23C3-1444-en-tor_and_china.m4v">video</a>,
     <a href="http://freehaven.net/~arma/slides-23c3.pdf">slides</a>, <a
     href="http://events.ccc.de/congress/2006/Fahrplan/events/1444.en.html">abstract</a>,
     <a href="https://svn.torproject.org/svn/projects/design-paper/blocking.html">design
     paper</a>).
     </li>
 
f64e45d8
     <li>Learn about the wide diversity of <a
316b740c
     href="<page getinvolved/volunteer>#Projects">projects in
f64e45d8
     the Tor ecosystem</a> that need your help. Watch the <a
     href="https://media.torproject.org/video/29c3-5306-en-the_tor_software_ecosystem_h264.mp4">29c3
     video on the Tor software ecosystem</a> to learn more.
     </li>
 
4b6790e7
     <li>
f64e45d8
     Look through Tor's <a href="#DesignDoc">Design
4b6790e7
     Documents</a>. Notice that we have RFC-style specs to tell you exactly
     how Tor is built.
2a9aaa80
     Learn about the <a
365df400
     href="<specblob>proposals/001-process.txt">Tor
2a9aaa80
     proposal process for changing our design</a>, and look over the <a
365df400
     href="<spectree>proposals">existing proposals</a>.
2a9aaa80
     </li>
10d51bd5
 
2a9aaa80
     <li>
d215cdb7
     Our <a
9daba816
     href="https://trac.torproject.org/projects/tor/wiki/org/sponsors">sponsor TODO list</a> starts with a
2a9aaa80
     timeline for external promises &mdash; things <a href="<page about/sponsors>">our
     sponsors</a> have paid to see done. It also lists many other tasks
     and topics we'd like to tackle next.
     </li>
10d51bd5
 
2a9aaa80
     <li>
     Once you're up to speed, things will continue to change surprisingly fast.
50d53f30
     The <a href="#MailingLists">tor-dev mailing list</a> is where the complex
4b6790e7
     discussion happens, and the #tor and #tor-dev IRC channels
     are where the rest of the discussion happens.
2a9aaa80
     </li>
10d51bd5
 
2a9aaa80
     </ol>
10d51bd5
 
2a9aaa80
     <a id="MailingLists"></a>
     <h1><a class="anchor" href="#MailingLists">Mailing List Information</a></h1>
3a747edd
 
     <p>Tor runs <a
     href="https://trac.torproject.org/projects/tor/wiki/doc/emailLists">many
58f1bac7
     mailing lists</a>. New users will be most interested in:</p>
     <ul>
     <li><a
     href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-announce/">tor-announce</a>
     is a low volume list for announcements of new releases and critical
     security updates. Everybody should be on this list. There is also
     an <a href="http://rss.gmane.org/gmane.network.tor.announce">RSS
     feed</a>.</li>
     <li><a
     href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-talk/">tor-talk</a>
     is where a lot of discussion happens, and is where we send
     notifications of prerelease versions and release candidates.</li>
     <li><a
     href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-relays/">tor-relays
     list</a> is for discussions about running, configuring, and handling
     your tor relay or bridge. If you currently run a relay or bridge,
     or are thinking about doing so, this is the list for you.</li>
     <li><a
     href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-onions/">tor-onions</a>
     is like tor-relays but for <a
     href="https://media.ccc.de/v/32c3-7322-tor_onion_services_more_useful_than_you_think">onion
     services</a>.</li>
     <li><a
     href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-dev/">tor-dev</a>
     is for posting by developers only, and is very low traffic.</li>
     </ul>
10d51bd5
 
2a9aaa80
     <a id="DesignDoc"></a>
     <h1><a class="anchor" href="#DesignDoc">Design Documents</a></h1>
     <ul>
     <li>The <b>design document</b> (published at Usenix Security 2004)
     gives our justifications and security analysis for the Tor design:
     <a href="https://svn.torproject.org/svn/projects/design-paper/tor-design.pdf">PDF</a> and
     <a href="https://svn.torproject.org/svn/projects/design-paper/tor-design.html">HTML</a>
     versions available.</li>
430612af
     <li>Eight key design changes since the original 2004 paper:
     <a href="https://blog.torproject.org/blog/top-changes-tor-2004-design-paper-part-1">part one</a>,
     <a href="https://blog.torproject.org/blog/top-changes-tor-2004-design-paper-part-2">part two</a>.
     </li>
2a9aaa80
     <li>Our preliminary design to make it harder for large firewalls to
     prevent access to the Tor network is described in
     <b>design of a blocking-resistant anonymity system</b>:
     <a href="https://svn.torproject.org/svn/projects/design-paper/blocking.pdf">PDF draft</a> and
     <a href="https://svn.torproject.org/svn/projects/design-paper/blocking.html">HTML draft</a>.
     Want to <a href="<page getinvolved/volunteer>#Coding">help us build it</a>?</li>
     <li>The <b>specifications</b> aim to give
     developers enough information to build a compatible version of Tor:
     <ul>
365df400
     <li><a href="<specblob>tor-spec.txt">Main Tor specification</a></li>
     <li><a href="<specblob>dir-spec.txt">Tor
2a9aaa80
     version 3 directory server specification</a> (and older <a
365df400
     href="<specblob>dir-spec-v2.txt">version 2</a> directory
1ec08116
     specification)</li>
365df400
     <li><a href="<specblob>control-spec.txt">Tor control protocol
2a9aaa80
     specification</a></li>
365df400
     <li><a href="<specblob>rend-spec.txt">Tor rendezvous
2a9aaa80
     specification</a></li>
365df400
     <li><a href="<specblob>path-spec.txt">Tor path selection
2a9aaa80
     specification</a></li>
365df400
     <li><a href="<specblob>address-spec.txt">Special hostnames in
2a9aaa80
     Tor</a></li>
365df400
     <li><a href="<specblob>socks-extensions.txt">Tor's SOCKS support
2a9aaa80
     and extensions</a></li>
365df400
     <li><a href="<specblob>version-spec.txt">How Tor version numbers
2a9aaa80
     work</a></li>
365df400
     <li><a href="<spectree>proposals">In-progress drafts of
2a9aaa80
     new specifications and proposed changes</a></li>
     </ul></li>
10d51bd5
 
2a9aaa80
     </ul>
10d51bd5
 
2a9aaa80
     <a id="NeatLinks"></a>
     <h1><a class="anchor" href="#NeatLinks">Neat Links</a></h1>
     <ul>
da280ad7
     <li>The <a href="<wiki>">Tor
2a9aaa80
     wiki</a> provides a plethora of helpful contributions from Tor
     users. Check it out!</li>
     <li><a
81720f6d
     href="<wiki>doc/SupportPrograms">A
2a9aaa80
     list of supporting programs you might want to use in association with
     Tor</a>.</li>
     <li><a href="https://check.torproject.org/">The
781acd41
     Tor detector</a> tries to guess if you're using Tor or not.</li>
0cb86da3
     <li>Check out one of the Tor status pages, such as the <a
bf0b1fdb
     href="https://atlas.torproject.org/">Atlas</a> and <a href="https://compass.torproject.org/">Compass</a> pages.
2a9aaa80
     Remember that these lists may not be as accurate as what your Tor
     client uses, because your client fetches its own directory information and
     examines it locally.</li>
     <li>Read <a
     href="http://freehaven.net/anonbib/topic.html#Anonymous_20communication">these
     papers</a> (especially the ones in boxes) to get up to speed on the field
     of anonymous communication systems.</li>
     </ul>
10d51bd5
 
2a9aaa80
     <a id="Developers"></a>
     <h1><a class="anchor" href="#Developers">For Developers</a></h1>
       Browse the Tor <b>source repository</b>:
       <ul>
         <li><a href="<gitrepo>">Browse the repository's source tree directly</a></li>
         <li>Git and SVN access:
           <ul>
79d93cd9
             <li><kbd>git clone https://git.torproject.org/git/tor</kbd></li>
2a9aaa80
             <li><kbd>svn checkout https://svn.torproject.org/svn/website/trunk website</kbd></li>
           </ul>
         </li>
09f22a39
         <li><a href="https://gitweb.torproject.org/githax.git?a=blob;f=doc/Howto.txt;hb=HEAD">Basic instructions for using Git to contribute to Tor software.</a></li>
2a9aaa80
       </ul>
   </div>
   <!-- END MAINCOL -->
   <div id = "sidecol">
 #include "side.wmi"
 #include "info.wmi"
   </div>
   <!-- END SIDECOL -->
 </div>
 <!-- END CONTENT -->
10d51bd5
 #include <foot.wmi>