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)     <a id="Support"></a>
14)     <a id="UpToSpeed"></a>
15)     <h1><a class="anchor" href="#UpToSpeed">Getting up to speed on Tor's past,
16)     present, and future</a></h1>

17) 

18)     <ol>
19)     <li>
20)     First, read the <a href="<page about/overview>">overview page</a> to get a
21)     basic idea of how Tor works, what it's for, and who uses it.
22)     </li>

23) 

24)     <li>

25)     <a href="<page download/download>">Install Tor Browser</a> and try it out.

26)     Be sure to read the

27)     <a href="<page download/download>#Warning">list of warnings</a> about ways you

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

31)     </li>

32) 

33)     <li>
34)     Our <a

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

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

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

44)     </li>

45) 

46)     <li>Check out the <a href="https://tor.stackexchange.com/">Tor
47)     Stack Exchange Q&A Site</a>, and help us make the questions and
48)     answers better.</li>
49) 

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

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

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

53)     file</a>. We also provide a <a href="<page docs/tor-manual-dev>">manual for
54)     the development version of Tor</a>.</li>

55) 

56)     <li>If you have questions, we have an IRC channel (for users, relay
57)     operators, and developers)
58)     at <a href="irc://irc.oftc.net/tor">#tor on irc.oftc.net</a>. If
59)     you have a bug, especially a crash bug, read <a

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

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

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

66)     it in our bugtracker.) The

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

68)     </li>

69) 

70)     <li>

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

72)     We try to keep it updated every week or two with the latest news.
73)     </li>

74) 

75)     <li>

76)     Download and watch Roger's Tor
77)     overview talk from Internet Days in Sweden (<a
78)     href="https://media.torproject.org/video/tor-internet-days-2010.mp4">video</a>,
79)     <a
80)     href="https://svn.torproject.org/svn/projects/presentations/slides-stanford10.pdf">slides</a>,
81)     <a href="http://www.youtube.com/watch?v=35l56KjTCb8">youtube</a>),

82)     which provides good background on how Tor works and what it's for.

83)     </li>

84) 

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

103)     <li>Learn about the wide diversity of <a

104)     href="<page getinvolved/volunteer>#Projects">projects in

105)     the Tor ecosystem</a> that need your help. Watch the <a
106)     href="https://media.torproject.org/video/29c3-5306-en-the_tor_software_ecosystem_h264.mp4">29c3
107)     video on the Tor software ecosystem</a> to learn more.
108)     </li>
109) 

110)     <li>

111)     Look through Tor's <a href="#DesignDoc">Design

112)     Documents</a>. Notice that we have RFC-style specs to tell you exactly
113)     how Tor is built.

114)     Learn about the <a

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

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

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

118)     </li>

119) 

120)     <li>

121)     Our <a

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

123)     timeline for external promises &mdash; things <a href="<page about/sponsors>">our
124)     sponsors</a> have paid to see done. It also lists many other tasks
125)     and topics we'd like to tackle next.
126)     </li>

127) 

128)     <li>
129)     Once you're up to speed, things will continue to change surprisingly fast.

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

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

133)     </li>

134) 

135)     </ol>

136) 

137)     <a id="MailingLists"></a>
138)     <h1><a class="anchor" href="#MailingLists">Mailing List Information</a></h1>

139) 
140)     <p>Tor runs <a
141)     href="https://trac.torproject.org/projects/tor/wiki/doc/emailLists">many

142)     mailing lists</a>. New users will be most interested in:</p>
143)     <ul>
144)     <li><a
145)     href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-announce/">tor-announce</a>
146)     is a low volume list for announcements of new releases and critical
147)     security updates. Everybody should be on this list. There is also
148)     an <a href="http://rss.gmane.org/gmane.network.tor.announce">RSS
149)     feed</a>.</li>
150)     <li><a
151)     href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-talk/">tor-talk</a>
152)     is where a lot of discussion happens, and is where we send
153)     notifications of prerelease versions and release candidates.</li>
154)     <li><a
155)     href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-relays/">tor-relays
156)     list</a> is for discussions about running, configuring, and handling
157)     your tor relay or bridge. If you currently run a relay or bridge,
158)     or are thinking about doing so, this is the list for you.</li>
159)     <li><a
160)     href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-onions/">tor-onions</a>
161)     is like tor-relays but for <a
162)     href="https://media.ccc.de/v/32c3-7322-tor_onion_services_more_useful_than_you_think">onion
163)     services</a>.</li>
164)     <li><a
165)     href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-dev/">tor-dev</a>
166)     is for posting by developers only, and is very low traffic.</li>
167)     </ul>

168) 

169)     <a id="DesignDoc"></a>
170)     <h1><a class="anchor" href="#DesignDoc">Design Documents</a></h1>
171)     <ul>
172)     <li>The <b>design document</b> (published at Usenix Security 2004)
173)     gives our justifications and security analysis for the Tor design:
174)     <a href="https://svn.torproject.org/svn/projects/design-paper/tor-design.pdf">PDF</a> and
175)     <a href="https://svn.torproject.org/svn/projects/design-paper/tor-design.html">HTML</a>
176)     versions available.</li>

177)     <li>Eight key design changes since the original 2004 paper:
178)     <a href="https://blog.torproject.org/blog/top-changes-tor-2004-design-paper-part-1">part one</a>,
179)     <a href="https://blog.torproject.org/blog/top-changes-tor-2004-design-paper-part-2">part two</a>.
180)     </li>

181)     <li>Our preliminary design to make it harder for large firewalls to
182)     prevent access to the Tor network is described in
183)     <b>design of a blocking-resistant anonymity system</b>:
184)     <a href="https://svn.torproject.org/svn/projects/design-paper/blocking.pdf">PDF draft</a> and
185)     <a href="https://svn.torproject.org/svn/projects/design-paper/blocking.html">HTML draft</a>.
186)     Want to <a href="<page getinvolved/volunteer>#Coding">help us build it</a>?</li>
187)     <li>The <b>specifications</b> aim to give
188)     developers enough information to build a compatible version of Tor:
189)     <ul>

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

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

193)     href="<specblob>dir-spec-v2.txt">version 2</a> directory

194)     specification)</li>

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

196)     specification</a></li>

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

198)     specification</a></li>

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

200)     specification</a></li>

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

202)     Tor</a></li>

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

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

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

206)     work</a></li>

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

208)     new specifications and proposed changes</a></li>
209)     </ul></li>

210) 

211)     </ul>

212) 

213)     <a id="NeatLinks"></a>
214)     <h1><a class="anchor" href="#NeatLinks">Neat Links</a></h1>
215)     <ul>

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

217)     wiki</a> provides a plethora of helpful contributions from Tor
218)     users. Check it out!</li>
219)     <li><a

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

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

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

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

226)     href="https://atlas.torproject.org/">Atlas</a> and <a href="https://compass.torproject.org/">Compass</a> pages.

227)     Remember that these lists may not be as accurate as what your Tor
228)     client uses, because your client fetches its own directory information and
229)     examines it locally.</li>
230)     <li>Read <a
231)     href="http://freehaven.net/anonbib/topic.html#Anonymous_20communication">these
232)     papers</a> (especially the ones in boxes) to get up to speed on the field
233)     of anonymous communication systems.</li>
234)     </ul>

235) 

236)     <a id="Developers"></a>
237)     <h1><a class="anchor" href="#Developers">For Developers</a></h1>
238)       Browse the Tor <b>source repository</b>:
239)       <ul>
240)         <li><a href="<gitrepo>">Browse the repository's source tree directly</a></li>
241)         <li>Git and SVN access:
242)           <ul>

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

244)             <li><kbd>svn checkout https://svn.torproject.org/svn/website/trunk website</kbd></li>
245)           </ul>
246)         </li>

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

248)       </ul>
249)   </div>
250)   <!-- END MAINCOL -->
251)   <div id = "sidecol">
252) #include "side.wmi"
253) #include "info.wmi"
254)   </div>
255)   <!-- END SIDECOL -->
256) </div>
257) <!-- END CONTENT -->