tor-webwml.git

1) ## translation metadata

2) # Revision: $Revision$

3) # Translation-Priority: 2-medium
4) 
5) #include "head.wmi" TITLE="Tor Project: Relay Configuration Instructions" 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 &raquo; </a>
10)     <a href="<page docs/tor-doc-relay>">Configure Tor Relay</a>

11)   </div>
12)   <div id="maincol">

13) 
14)     <h1>Configuring a Tor relay</h1>

15) 

16)     <hr>

17) 

18)     <p>
19)     The Tor network relies on volunteers to donate bandwidth. The more
20)     people who run relays, the faster the Tor network will be. If you have

21)     at least 50 kilobytes/s each way, please help out Tor by configuring your

22)     Tor to be a relay too.

23)     </p>

24) 

25)     <p>You can run a Tor relay on pretty much any operating system. Tor relays
26)     work best on Linux, OS X Tiger or later, FreeBSD 5.x+, NetBSD 5.x+, and
27)     Windows Server 2003 or later.

28)     </p>

29) 

30)     <p>
31)     An easy way to get started is with Vidalia, a graphical interface for 
32)     Tor. Vidalia is not included in the standard Tor Browser Bundle, although it 
33)     <a href="https://www.torproject.org/docs/faq.html.en#WhereDidVidaliaGo">once 
34)     was</a>. You can use Vidalia as part of the preconfigured bundles, or as a 
35)     seperate program. 
36)     <p>
37) 
38)     <p>The Vidalia Bridge Bundle, the Vidalia Relay Bundle 
39)     and the Vidalia Exit Bundle can be found on the 
40)     <a href="https://www.torproject.org/download/download.html.en">download 
41)     page</a>. These packages are already configured to run Tor as a bridge, a
42)     non-exit relay, or an exit relay. These bundles are only available for 
43)     Windows.
44)     </p>
45) 
46)     <p>
47)     If you are not the using the Bridge Bundle, Relay Bundle or Exit Bundle, 
48)     you will need to .
49)     </p>
50) 
51)     <p>
52)     Vidalia is also available as a standalone package from <a 
53)     href="https://people.torproject.org/~erinn/vidalia-standalone-bundles/">this 
54)     directory</a>. To use the Vidalia standalone, you will first need to <a 
55)     href="https://torproject.org/projects/torbrowser.html.en">download 
56)     the Tor Browser Bundle</a> or the <a href="https://www.torproject.org/download/download.html.en">Tor Expert Bundle</a>. 
57)     Unpack the Vidalia package into your Tor Browser folder. This will allow 
58)     Vidalia to control and configure the Tor Browser Bundle's Tor client. 
59)     </p>
60) 
61)     <p>
62)     If you use the Expert Bundle, which contains Tor only and no browser, 
63)     you'll need to inform Vidalia of your Tor's location. You can not run
64)     Vidalia unless Tor is running.
65)     </p>
66) 
67)     <p>
68)     Make sure your Tor works by using Tor as a client (surf with the Tor 
69)     Browser, for example). Verify that your clock and timezone are set
70)     correctly. If possible, synchronize your clock with public <a
71)     href="http://en.wikipedia.org/wiki/Network_Time_Protocol">time
72)     servers</a>.</p>
73) 
74) <!--

75)     <p>If you're comfortable editing text files, skip this page and
76)     go to our dedicated <a href="<page docs/tor-relay-debian>">Relay
77)     Configuration Instructions on Debian/Ubuntu</a> page. That page is
78)     the best one for relay operators on BSD, Unix, etc as well.</p>
79) 

80) 

81)     <hr>

82)     <a id="zero"></a>
83)     <a id="install"></a>
84)     <h2><a class="anchor" href="#install">Step One: Download and Install Tor</a></h2>

85)     <br>

86) 

87)     <p>Before you start, you need to make sure that Tor is up and running.
88)     </p>

89) 

90)     <p>Visit our <a href="<page download/download>">download page</a> and

91)     install the "Installation Bundle" for your OS.
92)     </p>

93) 

94)     <p>If it's convenient, you might also want to use it as a client for a
95)     while to make sure it's actually working.</p>

96) -->

97) 

98)     <hr>

99)     <a id="setup"></a>

100)     <h2><a class="anchor" href="#setup">Configure Tor with the Vidalia Graphical Interface</a></h2>

101)     <br>

102)     <ol type=1>

103) 
104) 

105)     <li>

106)     	Right click on the Vidalia icon in your task bar.  Choose Control Panel.
107)     	<img alt="vidalia right click menu" src="$(IMGROOT)/screenshot-win32-vidalia.png" />

108)     </li>

109) 

110)     <li>Click "Setup Relaying".</li>

111) 

112)     <li>

113)     Choose "Relay Traffic for the Tor network" if you
114) want to be a public relay (recommended), or choose "Help
115) censored users reach the Tor network" if you want to be a <a
116) href="<page docs/faq>#RelayOrBridge">non-public bridge</a>.
117)     <img alt="vidalia basic settings" src="$(IMGROOT)/screenshot-win32-configure-relay-1.png" />

118)     </li>

119) 

120)     <li>Enter a nickname for your relay, and enter contact information in
121)     case we need to contact you about problems.</li>

122) 

123)     <li>Leave "Attempt to automatically configure port forwarding" clicked.
124)     Push the "Test" button to see if it works.  If it does work, great.

125)     If not, see number 3 below.</li>

126) 

127)     <li>Choose the "Bandwidth Limits" tab.  Select how much bandwidth you want to provide for Tor users like yourself.
128)     <img alt="vidalia bandwidth limits" src="$(IMGROOT)/screenshot-win32-configure-relay-2.png" />

129)     </li>
130) 

131)     <li>Select the "Exit Policies" tab.  If you want to allow others

132)     to use your relay for these services, don't change anything.  Un-check

133)     the services you don't want to allow people to <a href="<page
134)     docs/faq>#ExitPolicies">reach from your relay</a>.  If you want to

135)     be a non-exit relay, un-check all services.
136)     <img alt="vidalia exit policies" src="$(IMGROOT)/screenshot-win32-configure-relay-3.png" />

137)     </li>

138) 

139)     <li>Click "Ok".</li>

140) 

141)     <li>If you are using a firewall, open a hole in your firewall
142)     so incoming connections can reach the ports you configured
143)     (ORPort, plus DirPort if you enabled it). If you have a

144)     hardware firewall (Linksys box, cable modem, etc) you might find <a
145)     href="http://portforward.com/">portforward.com</a> useful. Also, make sure you

146)     allow all <em>outgoing</em> connections too, so your relay can reach the
147)     other Tor relays.
148)     </li>

149) 

150)     <li>Restart your relay. If it <a

151)     href="<page docs/faq>#Logs">logs

152)     any warnings</a>, address them.
153)     </li>

154) 

155)     </ol>
156) 
157)     <hr>
158)     <a id="torrc"></a>
159)     <h2><a class="anchor" href="#torrc">Configuring Tor by editing the torrc file</a></h2>

160) 

161)     <p>
162)     You can also set up a relay without Vidalia. Tor's configuration file is named 'torrc'.
163)     In the Tor Browser folder, it's located at <pre>Data\Tor\torrc<pre>. 
164)     Open the file with a text editor and add the following lines:
165)     </p>
166) 
167)     <pre>
168)     ORPort 443
169)     Exitpolicy reject *:*
170)     Nickname mycleverrelayname
171)     ContactInfo human@...
172)     </pre>
173) 
174)     <p>If you want to be a bridge, you can read how to set the BridgeRelay 
175)     and ServerTransportPlugin values <a 
176)     href="https://www.torproject.org/projects/obfsproxy-instructions.html.en#instructions">on
177)     this page</a>.</p>
178) 
179)     <p>Tor will use all your bandwidth if you don't set limits for it. Some 
180)     options are described in <a href="<page docs/faq>#LimitTotalBandwidth">these</a> 
181)     <a href="<page docs/faq>#BandwidthShaping">FAQ entries</a>.</p>
182) 
183)     <p>See the <a href="https://gitweb.torproject.org/tor.git/blob/HEAD:/src/config/torrc.sample.in">sample 
184)     torrc file</a> and the <a 
185)     href="https://www.torproject.org/docs/tor-manual.html.en">man
186)     page</a> for other available Tor options.</p>

187) 

188)     <hr>

189)     <a id="check"></a>

190)     <h2><a class="anchor" href="#check">Make sure your relay is working</a></h2>

191)     <br>

192) 

193)     <p>As soon as your relay manages to connect to the network, it will
194)     try to determine whether the ports you configured are reachable from
195)     the outside. This step is usually fast, but may take up to 20

196)     minutes. Look for a <a href="<page docs/faq>#Logs">log entry</a> like

197)     <pre>Self-testing indicates your ORPort is reachable from the outside. Excellent.</pre>

198)     If you don't see this message, it means that your relay is not reachable
199)     from the outside — you should re-check your firewalls, check that it's
200)     testing the IP and port you think it should be testing, etc.
201)     </p>

202) 

203)     <p>When your relay has decided that it's reachable, it will upload a "server

204)     descriptor" to the directories, to let clients know

205)     what address, ports, keys, etc your relay is using. You can search <a
206)     href="https://atlas.torproject.org/">Atlas</a> or <a 
207)     href="https://globe.torproject.org/">Globe</a> for 
208)     the nickname you configured, to make sure it's there. You may need to wait 
209)     up to one hour for the directories to publish the new server information.</p>

210) 

211)     <hr>

212)     <a id="after"></a>

213)     <h2><a class="anchor" href="#after">Once your relay is working</a></h2>

214)     <br>

215) 

216)     <p>Subscribe to the <a
217)     href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-announce">tor-announce</a>
218)     mailing list. It is very low volume, and it will keep you informed
219)     of new stable releases.</p>
220)     
221)     <p>As a relay operator, you should consider subscribing to the 
222)     <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-relays">
223)     tor-relays mailing list</a>. You might find <a
224)     href="../docs/documentation.html.en#MailingLists">other higher-volume 
225)     Tor lists</a> of interest as well.
226)     </p>
227) 
228)     <p><a href="https://weather.torproject.org/">Tor Weather</a> provides
229)     an email notification service to any users who want to monitor the
230)     status of a Tor node. Upon subscribing, you can specify what types of
231)     alerts you would like to receive. The main purpose of Tor Weather is
232)     to notify node operators via email if their node is down for longer
233)     than a specified period, but other notification types are available.
234)     </p>
235) 

236)     <p>Read

237)     <a href="<wiki>doc/OperationalSecurity">about operational security</a>

238)     to get ideas how you can increase the security of your relay.

239)     </p>

240) 

241)     <p>

242)     If you control the name servers for your domain, consider setting your

243)     reverse DNS hostname to 'anonymous-relay', 'proxy' or 'tor-proxy', so when
244)     other people see the address in their web logs, they will more quickly
245)     understand what's going on. Adding the <a
246)     href="<gitblob>contrib/tor-exit-notice.html">Tor
247)     exit notice</a> on a vhost for this name can go a long way to deterring abuse
248)     complaints to you and your ISP if you are running an exit node.

249)     </p>

250) 

251)     <p>
252)     When you change your Tor configuration, remember to verify that your

253)     relay still works correctly after the change.
254)     If you have problems or questions, see

255)     the <a href="<page docs/documentation>#Support">Support</a> section or

256)     <a href="<page about/contact>">contact us</a>. Thanks

257)     for helping to make the Tor network grow!
258)     </p>

259) 

260) 

261)     <hr>

262) 

263)     <p>If you have suggestions for improving this document, please <a
264)     href="<page about/contact>">send them to us</a>. Thanks!</p>
265)   </div>
266)   <!-- END MAINCOL -->
267)   <div id = "sidecol">
268) #include "side.wmi"
269) #include "info.wmi"
270)   </div>
271)   <!-- END SIDECOL -->
272) </div>
273) <!-- END CONTENT -->

274) #include <foot.wmi>