tor-webwml.git

en/documentation.wml   1) ## translation metadata

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

documentation.html     3) 

en/documentation.wml   4) #include "head.wmi" TITLE="Documentation"

documentation.html     5) 

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

documentation.html     7) 

en/documentation.wml   8) <a id="RunningTor"></a>
en/documentation.wml   9) <h2><a class="anchor" href="#RunningTor">Running Tor</a></h2>
en/documentation.wml  10) <ul>
en/documentation.wml  11) <li><a href="<cvssandbox>tor/doc/tor-doc-win32.html">Installing Tor
en/documentation.wml  12) on Win32</a></li>
en/documentation.wml  13) <li><a href="<cvssandbox>tor/doc/tor-doc-osx.html">Installing Tor on
en/documentation.wml  14) Mac OS X</a></li>
en/documentation.wml  15) <li><a href="<cvssandbox>tor/doc/tor-doc-unix.html">Installing Tor on
en/documentation.wml  16) Linux/BSD/Unix</a></li>
en/documentation.wml  17) <li><a href="<cvssandbox>tor/doc/tor-switchproxy.html">Installing
en/documentation.wml  18) SwitchProxy for Tor</a></li>
en/documentation.wml  19) <li><a href="<cvssandbox>tor/doc/tor-doc-server.html">Configuring a
en/documentation.wml  20) Tor server</a></li>
en/documentation.wml  21) <li><a href="<cvssandbox>tor/doc/tor-hidden-service.html">Configuring
en/documentation.wml  22) a Tor hidden service</a></li>
en/documentation.wml  23) </ul>

documentation.html    24) 

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

en/documentation.wml  26) <h2><a class="anchor" href="#Support">Getting Support</a></h2>

documentation.html    27) <ul>

en/documentation.wml  28) <li>The <a href="http://wiki.noreply.org/wiki/TheOnionRouter/TorFAQ">Tor
en/documentation.wml  29) Technical FAQ Wiki</a> should be the first place you look. (While we
en/documentation.wml  30) monitor the Wiki page to help ensure accuracy, the Tor developers are
en/documentation.wml  31) not responsible for the content.)</li>
en/documentation.wml  32) <li>The <a href="<page faq-abuse>">Abuse FAQ</a> is a collection of
en/documentation.wml  33) common questions and issues discussed when running a Tor server.</li>
en/documentation.wml  34) <li>The <a href="<page eff/tor-legal-faq>">Tor Legal FAQ</a> is written by
en/documentation.wml  35) EFF lawyers. It aims to give you an overview of some of the legal issues
en/documentation.wml  36) that arise from the Tor project in the US.</li>
en/documentation.wml  37) <li>The <a href="<page tor-manual>">manual</a>
en/documentation.wml  38) lists all the possible entries you can put in your <a
en/documentation.wml  39) href="http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#torrc">torrc
en/documentation.wml  40) file</a>. We also provide a <a href="<page tor-manual-cvs>">manual for
en/documentation.wml  41) the development version of Tor</a>.</li>
en/documentation.wml  42) <li>The <a href="http://wiki.noreply.org/noreply/TheOnionRouter">Tor
en/documentation.wml  43) wiki</a> provides a plethora of helpful contributions from Tor
en/documentation.wml  44) users. Check it out!</li>
en/documentation.wml  45) <li>The Tor IRC channel (for users, server operators, and developers)
en/documentation.wml  46) is <a href="irc://irc.oftc.net/tor">#tor on irc.oftc.net</a>.</li>
en/documentation.wml  47) <li>We have a <a
en/documentation.wml  48) href="http://bugs.noreply.org/tor">bugtracker</a>.
en/documentation.wml  49) If you have a bug, especially a crash bug, read <a
en/documentation.wml  50) href="http://wiki.noreply.org/wiki/TheOnionRouter/TorFAQ#ServerCrashing">how
en/documentation.wml  51) to report a Tor bug</a> first and then tell us as much information
en/documentation.wml  52) about it as you can in the bugtracker. (If your bug is
en/documentation.wml  53) with Privoxy, your browser, or some other application, please don't put
en/documentation.wml  54) it in our bugtracker.)</li>
en/documentation.wml  55) <li>Try the or-talk mailing list <a href="#MailingLists">below</a>.
en/documentation.wml  56) <li>As a last resort, look through <a href="<page contact>">the Tor
en/documentation.wml  57) contact page</a>.</li>

documentation.html    58) </ul>
documentation.html    59) 

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

documentation.html    62) <ul>

en/documentation.wml  63) <li>The <a href="http://archives.seul.org/or/announce/">or-announce
en/documentation.wml  64) mailing list</a> is a low volume list for announcements of new releases
en/documentation.wml  65) and critical security updates. Everybody should be on this list.</li>
en/documentation.wml  66) <li>The <a href="http://archives.seul.org/or/talk/">or-talk list</a>
en/documentation.wml  67) is where a lot of discussion happens, and is where we send notifications
en/documentation.wml  68) of prerelease versions and release candidates.</li>
en/documentation.wml  69) <li>The <a href="http://archives.seul.org/or/dev/">or-dev list</a>
en/documentation.wml  70) is for posting by developers only, and is very low traffic.</li>
en/documentation.wml  71) <li>A list for <a href="http://archives.seul.org/or/cvs/">cvs commits</a>
en/documentation.wml  72) may be interesting for developers.</li>

documentation.html    73) </ul>
documentation.html    74) 

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

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

documentation.html    77) <ul>

en/documentation.wml  78) <li>The <b>design document</b> (published at Usenix Security 2004)
en/documentation.wml  79) gives our justifications and security analysis for the Tor design:
en/documentation.wml  80) <a href="<cvssandbox>tor/doc/design-paper/tor-design.pdf">PDF</a> and
en/documentation.wml  81) <a href="<cvssandbox>tor/doc/design-paper/tor-design.html">HTML</a>
en/documentation.wml  82) versions available.</li>
en/documentation.wml  83) <li>Our follow-up paper on <b>challenges in low-latency anonymity</b>

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

en/documentation.wml  85) <a href="<cvssandbox>tor/doc/design-paper/challenges.pdf">PDF
en/documentation.wml  86) version</a>.</li>
en/documentation.wml  87) <li>The <b>specifications</b> aim to give
en/documentation.wml  88) developers enough information to build a compatible version of Tor:

documentation.html    89) <ul>

en/documentation.wml  90) <li><a href="<cvssandbox>tor/doc/tor-spec.txt">Main Tor specification</a></li>
en/documentation.wml  91) <li><a href="<cvssandbox>tor/doc/rend-spec.txt">Tor rendezvous specification</a></li>
en/documentation.wml  92) <li><a href="<cvssandbox>tor/doc/dir-spec.txt">Tor directory server specification</a></li>
en/documentation.wml  93) <li><a href="<cvssandbox>tor/doc/control-spec.txt">Tor UI control specification</a></li>

en/documentation.wml  94) </ul></li>
en/documentation.wml  95) <li>Look at the <a href="http://freehaven.net/~arma/wth1.pdf">slides
en/documentation.wml  96) (PDF)</a> and <a
en/documentation.wml  97) href="http://rehash.waag.org/WTH/wth-anonymous-communication-58.mp4.torrent">video
en/documentation.wml  98) (torrent)</a> from the Tor talk Roger gave at <a
en/documentation.wml  99) href="http://whatthehack.org/">What the Hack (WTH)</a>. We also have <a

documentation.html   100) href="http://freehaven.net/~arma/wth3.pdf">slides</a> and <a
documentation.html   101) href="http://rehash.waag.org/WTH/wth_tor_hidden_services.mp4.torrent">video</a>

en/documentation.wml 102) of the WTH talk on hidden services.</li>
en/documentation.wml 103) </ul>

documentation.html   104) 

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

documentation.html   107) <ul>

en/documentation.wml 108) <li>The <a href="http://wiki.noreply.org/noreply/TheOnionRouter">Tor
en/documentation.wml 109) wiki</a> provides a plethora of helpful contributions from Tor
en/documentation.wml 110) users. Check it out!</li>
en/documentation.wml 111) <li>The <a href="http://6sxoyfb3h2nvok2d.onion/">hidden wiki</a> is a
en/documentation.wml 112) portal for all things about hidden services.</li>
en/documentation.wml 113) <li>The <a
en/documentation.wml 114) href="http://wiki.noreply.org/wiki/TheOnionRouter/TorifyHOWTO">Guide
en/documentation.wml 115) to Tor-ifying various applications.</a></li>

documentation.html   116) <li><a

en/documentation.wml 117) href="http://wiki.noreply.org/noreply/TheOnionRouter/SupportPrograms">A
en/documentation.wml 118) list of supporting programs you might want to use in association with
en/documentation.wml 119) Tor</a>.</li>
en/documentation.wml 120) <li><a href="http://www.noreply.org/tor-running-routers/">Weasel's graph
en/documentation.wml 121) of the number of Tor servers over time</a>.</li>
en/documentation.wml 122) <li>To learn more details of the current Tor nodes, look at Geoff
en/documentation.wml 123) Goodell's <a href="http://serifos.eecs.harvard.edu/cgi-bin/exit.pl">list
en/documentation.wml 124) of Tor exit nodes by country</a>.</li>

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

documentation.html   129) </ul>

documentation.html   130) 

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

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

en/documentation.wml 133) Browse the Tor <b>CVS repository</b>: (which may not
en/documentation.wml 134) necessarily work or even compile)</p>
en/documentation.wml 135) <ul>
en/documentation.wml 136) <li><a href="<cvssandbox>">Regularly updated CVS sandbox</a></li>
en/documentation.wml 137) <li><a
en/documentation.wml 138) href="http://cvs.seul.org/viewcvs/viewcvs.cgi/?root=tor">ViewCVS</a></li>
en/documentation.wml 139) <li><a href="http://archives.seul.org/or/cvs/">Mailing list for cvs
en/documentation.wml 140) commits</a></li>
en/documentation.wml 141) <li>anonymous pserver access (password is guest):

documentation.html   142) <ul>

en/documentation.wml 143) <li>Make a new empty directory and cd into it.</li>

en/documentation.wml 144) <li><kbd>cvs -d :pserver:guest@cvs.seul.org:/home/or/cvsroot login</kbd></li>
en/documentation.wml 145) <li><kbd>cvs -d :pserver:guest@cvs.seul.org:/home/or/cvsroot co tor</kbd></li>
en/documentation.wml 146) <li><kbd>cd tor; ./autogen.sh; make</kbd> and <kbd>make install</kbd> if you like.</li>
en/documentation.wml 147) <li>(use <kbd>co -r <var>tor-0_1_1_4_alpha</var> tor</kbd> or similar to fetch a particular version.)</li>
en/documentation.wml 148) <li>(To check out the maintenance branch, use <kbd>-r <var>tor-0_1_0-patches</var></kbd>)</li>

en/documentation.wml 149) </ul>

documentation.html   150) </li>

documentation.html   151) </ul>

en/documentation.wml 152) 

documentation.html   153)   </div><!-- #main -->
documentation.html   154)