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 Browser Bundle</a> and try it out.
42)     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 Tor
89)     overview talk from Internet Days in Sweden (<a
90)     href="https://media.torproject.org/video/tor-internet-days-2010.mp4">video</a>,
91)     <a
92)     href="https://svn.torproject.org/svn/projects/presentations/slides-stanford10.pdf">slides</a>,
93)     <a href="http://www.youtube.com/watch?v=35l56KjTCb8">youtube</a>),

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

95)     </li>

96) 

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

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

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

117)     the Tor ecosystem</a> that need your help. Watch the <a
118)     href="https://media.torproject.org/video/29c3-5306-en-the_tor_software_ecosystem_h264.mp4">29c3
119)     video on the Tor software ecosystem</a> to learn more.
120)     </li>
121) 

122)     <li>

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

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

126)     Learn about the <a

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

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

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

130)     </li>

131) 

132)     <li>

133)     Our <a

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

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

139) 

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

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

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

145)     </li>

146) 

147)     </ol>

148) 

149)     <a id="MailingLists"></a>
150)     <h1><a class="anchor" href="#MailingLists">Mailing List Information</a></h1>
151)     <ul>

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

153)     mailing list</a> is a low volume list for announcements of new releases
154)     and critical security updates. Everybody should be on this list.
155)     There is also an

156)     <a href="http://rss.gmane.org/gmane.network.tor.announce">RSS

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

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

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

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

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

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

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

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

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

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

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

173)     reports from trac</a> may be interesting for users and developers.</li>

174)     <li>A list for <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-reports/">Tor status reports.</li>

175)     </ul>

176) 

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

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

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

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

206)     specification)</li>

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

208)     specification</a></li>

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

210)     specification</a></li>

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

212)     specification</a></li>

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

214)     Tor</a></li>

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

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

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

218)     work</a></li>

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

220)     new specifications and proposed changes</a></li>
221)     </ul></li>

222) 

223)     </ul>

224) 

225)     <a id="NeatLinks"></a>
226)     <h1><a class="anchor" href="#NeatLinks">Neat Links</a></h1>
227)     <ul>

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

229)     wiki</a> provides a plethora of helpful contributions from Tor
230)     users. Check it out!</li>
231)     <li><a

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

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

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

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

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

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

247) 

248)     <a id="Developers"></a>
249)     <h1><a class="anchor" href="#Developers">For Developers</a></h1>
250)       Browse the Tor <b>source repository</b>:
251)       <ul>
252)         <li><a href="<gitrepo>">Browse the repository's source tree directly</a></li>
253)         <li>Git and SVN access:
254)           <ul>

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

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

257)             <li><kbd>svn checkout https://svn.torproject.org/svn/website/trunk website</kbd></li>
258)           </ul>
259)         </li>
260)         <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>
261)       </ul>
262)   </div>
263)   <!-- END MAINCOL -->
264)   <div id = "sidecol">
265) #include "side.wmi"
266) #include "info.wmi"
267)   </div>
268)   <!-- END SIDECOL -->
269) </div>
270) <!-- END CONTENT -->