tor-webwml.git

1) ## translation metadata

2) # Revision: $Revision$

3) # Translation-Priority: 2-medium
4) 
5) #include "head.wmi" TITLE="Tor: Documentation" CHARSET="UTF-8"
6) <div id="content" class="clearfix">
7)   <div id="breadcrumbs">

8)     <a href="<page index>">Home &raquo; </a>

9)     <a href="<page docs/documentation>">Documentation</a>
10)   </div>
11)   <div id="maincol"> 
12)     <a id="RunningTor"></a>
13)     <h1><a class="anchor" href="#RunningTor">Running Tor</a></h1>
14)     <ul>
15)     <li><a href="<page docs/tor-doc-windows>">Installing Tor
16)     on Win32</a></li>
17)     <li><a href="<page docs/tor-doc-osx>">Installing Tor on
18)     Mac OS X</a></li>
19)     <li><a href="<page docs/tor-doc-unix>">Installing Tor on
20)     Linux/BSD/Unix</a></li>

21)     <li><a href="<page torbutton/index>">Installing

22)     Torbutton for Tor</a></li>
23)     <li><a href="<page docs/tor-doc-relay>">Configuring a
24)     Tor relay</a></li>
25)     <li><a href="<page docs/tor-hidden-service>">Configuring
26)     a Tor hidden service</a></li>
27)     </ul>
28)     
29)     <a id="Support"></a>
30)     <a id="UpToSpeed"></a>
31)     <h1><a class="anchor" href="#UpToSpeed">Getting up to speed on Tor's past,
32)     present, and future</a></h1>
33)     
34)     <ol>
35)     <li>
36)     First, read the <a href="<page about/overview>">overview page</a> to get a
37)     basic idea of how Tor works, what it's for, and who uses it.
38)     </li>
39)     
40)     <li>
41)     <a href="<page download/download>">Install the Tor bundle</a> and try it out.
42)     Make sure you've got Firefox installed first, and be sure to read the
43)     <a href="<page download/download>#Warning">list of warnings</a> about ways you

44)     can screw up your anonymity. Look through the <a
45)     href="https://www.torproject.org/projects/torbrowser/design/">Tor
46)     Browser Design Document</a>.

47)     </li>
48)     
49)     <li>
50)     Our <a

51)     href="<page docs/faq>">FAQ</a>

52)     covers all sorts of topics, including questions about setting up a client
53)     or relay, concerns about anonymity attacks, why we didn't build Tor in
54)     other ways, etc.
55)     There's a separate <a href="<page docs/faq-abuse>">Abuse FAQ</a> to answer
56)     common questions from or for relay operators.
57)     The <a href="<page eff/tor-legal-faq>">Tor Legal FAQ</a> is written by
58)     EFF lawyers, and aims to give you an overview of some of the legal issues

59)     that arise from The Tor Project in the US.

60)     </li>
61)     

62)     <li>The <a href="<page docs/tor-manual>">manual</a>

63)     lists all the possible entries you can put in your <a

64)     href="<page docs/faq>#torrc">torrc

65)     file</a>. We also provide a <a href="<page docs/tor-manual-dev>">manual for
66)     the development version of Tor</a>.</li>
67)     
68)     <li>If you have questions, we have an IRC channel (for users, relay
69)     operators, and developers)
70)     at <a href="irc://irc.oftc.net/tor">#tor on irc.oftc.net</a>. If
71)     you have a bug, especially a crash bug, read <a

72)     href="<wikifaq>#MyTorkeepscrashing.">how

73)     to report a Tor bug</a> first and then tell us as much information
74)     about it as you can in
75)     <a href="https://bugs.torproject.org/tor">our bugtracker</a>.
76)     (If your bug is

77)     with your browser or some other application, please don't put

78)     it in our bugtracker.) The

79)     <a href="#MailingLists">tor-talk mailing list</a> can also be useful.

80)     </li>
81)     
82)     <li>

83)     <a href="<blog>">Tor has a blog</a>.

84)     We try to keep it updated every week or two with the latest news.
85)     </li>
86)     
87)     <li>

88)     Download and watch Roger's <a
89)     href="https://media.torproject.org/video/tor-internet-days-2010.mp4">overview
90)     talk from Internet Days in Sweden</a>, which provides good background

91)     on how Tor works and what it's for.
92)     </li>
93)     

94)     <li>
95)     Learn about our censorship circumvention side: watch our 28C3
96)     talk in December 2011 on how governments have tried to block Tor (<a
97)     href="https://media.torproject.org/video/28c3-4800-en-how_governments_have_tried_to_block_tor_h264.mp4">video</a>,
98)     <a href="http://www.youtube.com/watch?v=GwMr8Xl7JMQ">youtube</a>, <a
99)     href="https://svn.torproject.org/svn/projects/presentations/slides-28c3.pdf">slides</a>),
100)     an <a
101)     href="https://svn.torproject.org/svn/projects/articles/circumvention-features.html">overview
102)     of what to look for in a circumvention tool</a>,
103)     and the original "blocking-resistance and
104)     circumvention" talk from 23C3 in December 2006 (<a
105)     href="http://freehaven.net/~arma/23C3-1444-en-tor_and_china.m4v">video</a>,
106)     <a href="http://freehaven.net/~arma/slides-23c3.pdf">slides</a>, <a
107)     href="http://events.ccc.de/congress/2006/Fahrplan/events/1444.en.html">abstract</a>,
108)     <a href="https://svn.torproject.org/svn/projects/design-paper/blocking.html">design
109)     paper</a>).
110)     </li>
111) 

112)     <li>
113)     Look through our <a href="#DesignDoc">Design
114)     Documents</a>. Notice that we have RFC-style specs to tell you exactly
115)     how Tor is built.
116)     </li>
117) 

118)     <li>
119)     There's a skeletal <a
120)     href="https://svn.torproject.org/svn/projects/roadmaps/2008-12-19-roadmap-full.pdf">list
121)     of items we'd like to tackle in the future</a>. Alas, many of those
122)     items need to be fleshed out more before they'll make sense to people
123)     who aren't Tor developers, but you can still get a general sense of
124)     what issues need to be resolved next.
125)     </li>
126)     
127)     <li>
128)     Download and watch Nick's "Technical changes since 2004" talk from
129)     Defcon in July 2007 (<a
130)     href="http://freehaven.net/~arma/Defcon15-Mathewson-Technical_Changes_since_you_Last_Heard_about_Tor.mp4">video</a>, <a
131)     href="http://freehaven.net/~nickm/slides/Defcon07/TorChanges.pdf">slides</a>),

132)     Roger's "Current events in 2007" talk from 24C3 in December

133)     2007 (<a
134)     href="http://freehaven.net/~arma/24c3-2325-en-current_events_in_tor_development.mp4">video</a>,
135)     <a href="http://freehaven.net/~arma/slides-24c3.pdf">slides</a>,

136)     <a href="http://events.ccc.de/congress/2007/Fahrplan/events/2325.en.html">abstract</a>), and
137)     Roger's "Vulnerabilities in Tor" talk from 25C3 in December
138)     2008 (<a
139)     href="https://media.torproject.org/video/25c3-2977-en-security_and_anonymity_vulnerabilities_in_tor.mp4">video</a>,
140)     <a href="http://freehaven.net/~arma/slides-25c3.pdf">slides</a>).

141)     </li>
142)     
143)     <li>
144)     See Mike's "Securing the Tor network" talk from Defcon in July 2007
145)     (<a href="http://freehaven.net/~arma/Defcon15-Mike_Perry-Securing_the_Tor_Network.mp4">video</a>,
146)      <a href="http://freehaven.net/~arma/SecuringTheTorNetwork.pdf">slides</a>).
147)     It describes common ways to attack networks like Tor and how we try
148)     to defend against them, and it introduces the <a
149)     href="https://svn.torproject.org/svn/torflow/trunk/README">Torflow</a>
150)     script collection.
151)     </li>
152)     
153)     <li>
154)     Learn about the <a

155)     href="<specblob>proposals/001-process.txt">Tor

156)     proposal process for changing our design</a>, and look over the <a

157)     href="<spectree>proposals">existing proposals</a>.

158)     </li>
159)     
160)     <li>

161)     Our <a

162)     href="https://trac.torproject.org/projects/tor/wiki/org/sponsors">sponsor TODO list</a> starts with a

163)     timeline for external promises &mdash; things <a href="<page about/sponsors>">our
164)     sponsors</a> have paid to see done. It also lists many other tasks
165)     and topics we'd like to tackle next.
166)     </li>
167)     
168)     <li>
169)     Once you're up to speed, things will continue to change surprisingly fast.

170)     The <a href="#MailingLists">tor-dev mailing list</a> is where the complex

171)     discussion happens, and the #tor and #tor-dev IRC channels
172)     are where the rest of the discussion happens.

173)     </li>
174)     
175)     </ol>
176)     
177)     <a id="MailingLists"></a>
178)     <h1><a class="anchor" href="#MailingLists">Mailing List Information</a></h1>
179)     <ul>

180)     <li>The <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-announce/">tor-announce

181)     mailing list</a> is a low volume list for announcements of new releases
182)     and critical security updates. Everybody should be on this list.
183)     There is also an
184)     <a href="http://rss.gmane.org/gmane.network.onion-routing.announce">RSS

185)     feed</a> of tor-announce at <a href="http://gmane.org">gmane.org</a>.</li>
186)     <li>The <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-talk/">tor-talk list</a>

187)     is where a lot of discussion happens, and is where we send notifications
188)     of prerelease versions and release candidates.</li>

189)     <li>The <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-relays/">tor-relays list</a>

190)     is where discussions about running, configuring, and handling your tor
191)     relay happen.  If you currently run a relay, or are thinking about doing
192)     so, this is the list for you.</li>

193)     <li>The <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-dev/">tor-dev list</a>

194)     is for posting by developers only, and is very low traffic.</li>

195)     <li>A list for <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-mirrors">mirror

196)     operators</a> for new website mirrors, and supporting <a href="<page
197)     getinvolved/mirrors>">current website mirrors</a>.</li>

198)     <li>A list for <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits/">svn and git

199)     commits</a> may be interesting for developers.</li>

200)     <li>An automated list for <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs/">bug

201)     reports from trac</a> may be interesting for users and developers.</li>
202)     </ul>
203)     
204)     <a id="DesignDoc"></a>
205)     <h1><a class="anchor" href="#DesignDoc">Design Documents</a></h1>
206)     <ul>
207)     <li>The <b>design document</b> (published at Usenix Security 2004)
208)     gives our justifications and security analysis for the Tor design:
209)     <a href="https://svn.torproject.org/svn/projects/design-paper/tor-design.pdf">PDF</a> and
210)     <a href="https://svn.torproject.org/svn/projects/design-paper/tor-design.html">HTML</a>
211)     versions available.</li>
212)     <li>Our follow-up paper on <b>challenges in low-latency anonymity</b>
213)     (still in draft form) details more recent experiences and directions:
214)     <a href="https://svn.torproject.org/svn/projects/design-paper/challenges.pdf">PDF
215)     draft</a>.</li>
216)     <li>Our paper at WEIS 2006 &mdash; <b>Anonymity Loves Company:
217)     Usability and the Network Effect</b> &mdash; explains why usability in
218)     anonymity systems matters for their security: <a
219)     href="http://freehaven.net/anonbib/cache/usability:weis2006.pdf">PDF</a>.</li>
220)     <li>Our preliminary design to make it harder for large firewalls to
221)     prevent access to the Tor network is described in
222)     <b>design of a blocking-resistant anonymity system</b>:
223)     <a href="https://svn.torproject.org/svn/projects/design-paper/blocking.pdf">PDF draft</a> and
224)     <a href="https://svn.torproject.org/svn/projects/design-paper/blocking.html">HTML draft</a>.
225)     Want to <a href="<page getinvolved/volunteer>#Coding">help us build it</a>?</li>
226)     <li>The <b>specifications</b> aim to give
227)     developers enough information to build a compatible version of Tor:
228)     <ul>

229)     <li><a href="<specblob>tor-spec.txt">Main Tor specification</a></li>
230)     <li><a href="<specblob>dir-spec.txt">Tor

231)     version 3 directory server specification</a> (and older <a

232)     href="<specblob>dir-spec-v1.txt">version 1</a> and <a
233)     href="<specblob>dir-spec-v2.txt">version 2</a> directory

234)     specifications)</li>

235)     <li><a href="<specblob>control-spec.txt">Tor control protocol

236)     specification</a></li>

237)     <li><a href="<specblob>rend-spec.txt">Tor rendezvous

238)     specification</a></li>

239)     <li><a href="<specblob>path-spec.txt">Tor path selection

240)     specification</a></li>

241)     <li><a href="<specblob>address-spec.txt">Special hostnames in

242)     Tor</a></li>

243)     <li><a href="<specblob>socks-extensions.txt">Tor's SOCKS support

244)     and extensions</a></li>

245)     <li><a href="<specblob>version-spec.txt">How Tor version numbers

246)     work</a></li>

247)     <li><a href="<spectree>proposals">In-progress drafts of

248)     new specifications and proposed changes</a></li>
249)     </ul></li>
250)     
251)     </ul>
252)     
253)     <a id="NeatLinks"></a>
254)     <h1><a class="anchor" href="#NeatLinks">Neat Links</a></h1>
255)     <ul>

256)     <li>The <a href="<wiki>">Tor

257)     wiki</a> provides a plethora of helpful contributions from Tor
258)     users. Check it out!</li>
259)     <li><a

260)     href="<wiki>doc/SupportPrograms">A

261)     list of supporting programs you might want to use in association with
262)     Tor</a>.</li>
263)     <li><a href="https://check.torproject.org/">The

264)     Tor detector</a> tries to guess if you're using Tor or not.</li>

265)     <li>Check out one of the Tor status pages, such as the <a

266)     href="https://atlas.torproject.org/">Atlas</a> page.

267)     Remember that these lists may not be as accurate as what your Tor
268)     client uses, because your client fetches its own directory information and
269)     examines it locally.</li>
270)     <li>Read <a
271)     href="http://freehaven.net/anonbib/topic.html#Anonymous_20communication">these
272)     papers</a> (especially the ones in boxes) to get up to speed on the field
273)     of anonymous communication systems.</li>
274)     </ul>
275)     
276)     <a id="Developers"></a>
277)     <h1><a class="anchor" href="#Developers">For Developers</a></h1>
278)       Browse the Tor <b>source repository</b>:
279)       <ul>
280)         <li><a href="<gitrepo>">Browse the repository's source tree directly</a></li>
281)         <li>Git and SVN access:
282)           <ul>

283)             <li><kbd>git clone https://git.torproject.org/git/tor</kbd></li>

284)             <li>The development branch is <kbd>master</kbd>.  The active maintenance branches are <kbd>maint-0.2.1</kbd> and <kbd>maint-0.2.2</kbd>.</li>