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 at
57)     <a href="irc://irc.oftc.net/tor">#tor on irc.oftc.net</a> (you can
58)     <a href="https://www.oftc.net/Tor/">join via Tor</a> as well). Developers work
59)     in <a href="irc://irc.oftc.net/tor-dev">#tor-dev</a> and relay operators
60)     help each other in <a href="irc://irc.oftc.net/tor-relays">#tor-relays</a>,
61)     read this fine article by
62)     <a href="https://blog.torproject.org/get-help-running-your-relay-our-new-advocate">
63)     Tor's Relay Advocate</a>. If you have a bug, especially a crash bug, read
64)     <a href="<wikifaq>#MyTorkeepscrashing.">how to report a Tor bug</a>
65)     first and then tell us as much information about it as you can in

66)     <a href="https://bugs.torproject.org/tor">our bugtracker</a>.
67)     (If your bug is

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

69)     it in our bugtracker.) The

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

71)     </li>

72) 

73)     <li>

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

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

77) 

78)     <li>

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

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

86)     </li>

87) 

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

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

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

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

113)     <li>

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

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

117)     Learn about the <a

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

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

120)     href="<specblob>proposals">existing proposals</a>.

121)     </li>

122) 

123)     <li>

124)     Our <a

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

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

130) 

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

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

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

136)     </li>

137) 

138)     </ol>

139) 

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

142) 
143)     <p>Tor runs <a
144)     href="https://trac.torproject.org/projects/tor/wiki/doc/emailLists">many

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

171) 

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

180)     <li>Thirteen key design changes since the original 2004 paper:

181)     <a href="https://blog.torproject.org/blog/top-changes-tor-2004-design-paper-part-1">part one</a>,

182)     <a href="https://blog.torproject.org/blog/top-changes-tor-2004-design-paper-part-2">part two</a>,
183)     <a href="https://blog.torproject.org/blog/top-changes-tor-2004-design-paper-part-3">part three</a>.

184)     </li>

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

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

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

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

198)     specification)</li>

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

200)     specification</a></li>

201)     <li>Tor rendezvous specification: <a
202)     href="<specblob>rend-spec-v2.txt">version 2</a> and <a
203)     href="<specblob>rend-spec-v3.txt">version 3</a></li>

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

205)     specification</a></li>

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

207)     Tor</a></li>

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

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

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

211)     work</a></li>

212)     <li><a href="<specblob>proposals">In-progress drafts of

213)     new specifications and proposed changes</a></li>
214)     </ul></li>

215) 

216)     </ul>

217) 

218)     <a id="NeatLinks"></a>
219)     <h1><a class="anchor" href="#NeatLinks">Neat Links</a></h1>
220)     <ul>

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

222)     wiki</a> provides a plethora of helpful contributions from Tor
223)     users. Check it out!</li>
224)     <li><a

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

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

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

230)     <li>Check out Tor network status information using <a

231)     href="https://metrics.torproject.org/rs.html">Relay Search</a>.

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

240) 

241)     <a id="Developers"></a>
242)     <h1><a class="anchor" href="#Developers">For Developers</a></h1>
243)       Browse the Tor <b>source repository</b>:
244)       <ul>
245)         <li><a href="<gitrepo>">Browse the repository's source tree directly</a></li>
246)         <li>Git and SVN access:
247)           <ul>

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

249)             <li><kbd>svn checkout https://svn.torproject.org/svn/website/trunk website</kbd></li>
250)           </ul>
251)         </li>

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

253)       </ul>
254)   </div>
255)   <!-- END MAINCOL -->
256)   <div id = "sidecol">
257) #include "side.wmi"
258) #include "info.wmi"
259)   </div>
260)   <!-- END SIDECOL -->
261) </div>
262) <!-- END CONTENT -->