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.
45)     </li>
46)     
47)     <li>
48)     Our <a

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

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

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

58)     </li>
59)     

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

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

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

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

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

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

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

76)     it in our bugtracker.) The

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

78)     </li>
79)     
80)     <li>

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

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

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

89)     on how Tor works and what it's for.
90)     </li>
91)     
92)     <li>
93)     Look through our <a href="#DesignDoc">Design
94)     Documents</a>. Notice that we have RFC-style specs to tell you exactly
95)     how Tor is built.
96)     </li>
97)     
98)     <li>
99)     There's a skeletal <a
100)     href="https://svn.torproject.org/svn/projects/roadmaps/2008-12-19-roadmap-full.pdf">list
101)     of items we'd like to tackle in the future</a>. Alas, many of those
102)     items need to be fleshed out more before they'll make sense to people
103)     who aren't Tor developers, but you can still get a general sense of
104)     what issues need to be resolved next.
105)     </li>
106)     
107)     <li>
108)     Download and watch Nick's "Technical changes since 2004" talk from
109)     Defcon in July 2007 (<a
110)     href="http://freehaven.net/~arma/Defcon15-Mathewson-Technical_Changes_since_you_Last_Heard_about_Tor.mp4">video</a>, <a
111)     href="http://freehaven.net/~nickm/slides/Defcon07/TorChanges.pdf">slides</a>),
112)     Roger's "blocking-resistance
113)     and circumvention" talk from 23C3 in December 2006 (<a
114)     href="http://freehaven.net/~arma/23C3-1444-en-tor_and_china.m4v">video</a>,
115)     <a href="http://freehaven.net/~arma/slides-23c3.pdf">slides</a>,
116)     <a href="http://events.ccc.de/congress/2006/Fahrplan/events/1444.en.html">abstract</a>,
117)     <a href="https://svn.torproject.org/svn/projects/design-paper/blocking.html">design paper</a>),

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

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

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

127)     </li>
128)     
129)     <li>
130)     See Mike's "Securing the Tor network" talk from Defcon in July 2007
131)     (<a href="http://freehaven.net/~arma/Defcon15-Mike_Perry-Securing_the_Tor_Network.mp4">video</a>,
132)      <a href="http://freehaven.net/~arma/SecuringTheTorNetwork.pdf">slides</a>).
133)     It describes common ways to attack networks like Tor and how we try
134)     to defend against them, and it introduces the <a
135)     href="https://svn.torproject.org/svn/torflow/trunk/README">Torflow</a>
136)     script collection.
137)     </li>
138)     
139)     <li>
140)     Learn about the <a

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

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

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

144)     </li>
145)     
146)     <li>

147)     Our <a

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

149)     timeline for external promises &mdash; things <a href="<page about/sponsors>">our
150)     sponsors</a> have paid to see done. It also lists many other tasks
151)     and topics we'd like to tackle next.
152)     </li>
153)     
154)     <li>
155)     Once you're up to speed, things will continue to change surprisingly fast.

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

157)     discussion happens, and the #tor IRC channel
158)     is where the less complex discussion happens.
159)     </li>
160)     
161)     </ol>
162)     
163)     <a id="MailingLists"></a>
164)     <h1><a class="anchor" href="#MailingLists">Mailing List Information</a></h1>
165)     <ul>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

220)     specifications)</li>

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

222)     specification</a></li>

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

224)     specification</a></li>

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

226)     specification</a></li>

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

228)     Tor</a></li>

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

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

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

232)     work</a></li>

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

234)     new specifications and proposed changes</a></li>
235)     </ul></li>
236)     
237)     </ul>
238)     
239)     <a id="NeatLinks"></a>
240)     <h1><a class="anchor" href="#NeatLinks">Neat Links</a></h1>
241)     <ul>

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

243)     wiki</a> provides a plethora of helpful contributions from Tor
244)     users. Check it out!</li>
245)     <li><a

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

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

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

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

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

253)     Remember that these lists may not be as accurate as what your Tor
254)     client uses, because your client fetches its own directory information and
255)     examines it locally.</li>
256)     <li>Read <a
257)     href="http://freehaven.net/anonbib/topic.html#Anonymous_20communication">these
258)     papers</a> (especially the ones in boxes) to get up to speed on the field
259)     of anonymous communication systems.</li>
260)     </ul>
261)     
262)     <a id="Developers"></a>
263)     <h1><a class="anchor" href="#Developers">For Developers</a></h1>
264)       Browse the Tor <b>source repository</b>:
265)       <ul>
266)         <li><a href="<gitrepo>">Browse the repository's source tree directly</a></li>
267)         <li>Git and SVN access:
268)           <ul>

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

270)             <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>