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 docs/tor-doc-relay>">Configuring a
22)     Tor relay</a></li>
23)     <li><a href="<page docs/tor-hidden-service>">Configuring
24)     a Tor hidden service</a></li>
25)     </ul>

26) 

27)     <a id="Support"></a>
28)     <a id="UpToSpeed"></a>
29)     <h1><a class="anchor" href="#UpToSpeed">Getting up to speed on Tor's past,
30)     present, and future</a></h1>

31) 

32)     <ol>
33)     <li>
34)     First, read the <a href="<page about/overview>">overview page</a> to get a
35)     basic idea of how Tor works, what it's for, and who uses it.
36)     </li>

37) 

38)     <li>

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

40)     Be sure to read the

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

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

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>Check out the <a href="https://tor.stackexchange.com/">Tor
61)     Stack Exchange Q&A Site</a>, and help us make the questions and
62)     answers better.</li>
63) 

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

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

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

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

69) 

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

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

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

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

80)     it in our bugtracker.) The

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

82)     </li>

83) 

84)     <li>

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

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

88) 

89)     <li>

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

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

97)     </li>

98) 

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

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

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

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

124)     <li>

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

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

128)     Learn about the <a

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

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

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

132)     </li>

133) 

134)     <li>

135)     Our <a

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

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

141) 

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

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

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

147)     </li>

148) 

149)     </ol>

150) 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

177)     </ul>

178) 

179)     <a id="DesignDoc"></a>
180)     <h1><a class="anchor" href="#DesignDoc">Design Documents</a></h1>
181)     <ul>
182)     <li>The <b>design document</b> (published at Usenix Security 2004)
183)     gives our justifications and security analysis for the Tor design:
184)     <a href="https://svn.torproject.org/svn/projects/design-paper/tor-design.pdf">PDF</a> and
185)     <a href="https://svn.torproject.org/svn/projects/design-paper/tor-design.html">HTML</a>
186)     versions available.</li>

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

191)     <li>Our paper at WEIS 2006 &mdash; <b>Anonymity Loves Company:
192)     Usability and the Network Effect</b> &mdash; explains why usability in
193)     anonymity systems matters for their security: <a
194)     href="http://freehaven.net/anonbib/cache/usability:weis2006.pdf">PDF</a>.</li>
195)     <li>Our preliminary design to make it harder for large firewalls to
196)     prevent access to the Tor network is described in
197)     <b>design of a blocking-resistant anonymity system</b>:
198)     <a href="https://svn.torproject.org/svn/projects/design-paper/blocking.pdf">PDF draft</a> and
199)     <a href="https://svn.torproject.org/svn/projects/design-paper/blocking.html">HTML draft</a>.
200)     Want to <a href="<page getinvolved/volunteer>#Coding">help us build it</a>?</li>
201)     <li>The <b>specifications</b> aim to give
202)     developers enough information to build a compatible version of Tor:
203)     <ul>

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

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

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

208)     specification)</li>

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

210)     specification</a></li>

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

212)     specification</a></li>

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

214)     specification</a></li>

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

216)     Tor</a></li>

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

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

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

220)     work</a></li>

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

222)     new specifications and proposed changes</a></li>
223)     </ul></li>

224) 

225)     </ul>

226) 

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

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

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

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

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

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

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

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

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

249) 

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

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

258)             <li><kbd>svn checkout https://svn.torproject.org/svn/website/trunk website</kbd></li>
259)           </ul>
260)         </li>

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

262)       </ul>
263)   </div>
264)   <!-- END MAINCOL -->
265)   <div id = "sidecol">
266) #include "side.wmi"
267) #include "info.wmi"
268)   </div>
269)   <!-- END SIDECOL -->
270) </div>
271) <!-- END CONTENT -->