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 20 kilobytes/s each way, please help out Tor by configuring your
22)     Tor to be a relay too. We have many features that make Tor relays easy

23)     and convenient, including <a href="<page docs/faq>#ExitPolicies">rate limiting

24)     for bandwidth, exit policies so you can limit your exposure to abuse
25)     complaints, and support for dynamic IP addresses</a>.
26)     </p>

27) 

28)     <p>You can run a Tor relay on <a href="<wikifaq>#RelayOS">pretty

29)     much any</a> operating system. Tor relays work best on Linux, OS X Tiger
30)     or later, FreeBSD 5.x+, NetBSD 5.x+, and Windows Server 2003 or later.
31)     </p>

32) 

33)     <hr>

34)     <a id="zero"></a>
35)     <a id="install"></a>
36)     <h2><a class="anchor" href="#install">Step One: Download and Install Tor</a></h2>

37)     <br>

38) 

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

41) 

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

43)     install the "Installation Bundle" for your OS.
44)     </p>

45) 

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

48) 

49)     <hr>

50)     <a id="setup"></a>
51)     <h2><a class="anchor" href="#setup">Step Two: Set it up as a relay</a></h2>

52)     <br>

53)     <ol>
54)     <li>Verify that your clock and timezone are set
55)     correctly. If possible, synchronize your clock with public <a
56)     href="http://en.wikipedia.org/wiki/Network_Time_Protocol">time
57)     servers</a>.
58)     </li>

59) 

60)     <li><strong>Manual Configuration</strong>:

61)     <ul>

62)     <li>Edit the bottom part of <a href="<page docs/faq>#torrc">your
63)     torrc file</a>. If you want to be a public relay (recommended),
64)     make sure to define ORPort and <a href="<page
65)     docs/faq>#ExitPolicies">look at ExitPolicy</a>; otherwise

66)     if you want to be a <a href="<page docs/faq>#RelayOrBridge">bridge</a>

67)     for users in countries that censor their Internet,
68)     just use <a href="<page docs/bridges>#RunningABridge">these lines</a>.
69)     </li>

70)     </ul></li>

71) 

72)     <li><strong>Configuring Tor with the Vidalia Graphical Interface</strong>:
73)     <ol>

74) 

75)     <li>
76)     	<dt>Right click on the Vidalia icon in your task bar.  Choose <tt>Control Panel</tt>.</dt>

77)     	<dd><img alt="vidalia right click menu" src="$(IMGROOT)/screenshot-win32-vidalia.png" /></dd>

78)     </li>

79) 

80)     <li>Click <tt>Setup Relaying</tt>.</li>

81) 

82)     <li>

83)     	<dt>Choose <tt>Relay Traffic for the Tor network</tt> if you

84) want to be a public relay (recommended), or choose <tt>Help

85) censored users reach the Tor network</tt> if you want to be a <a

86) href="<page docs/faq>#RelayOrBridge">bridge</a> for users in countries
87) that censor their Internet.</dt>

88)     <dd><img alt="vidalia basic settings" src="$(IMGROOT)/screenshot-win32-configure-relay-1.png" /></dd>

89)     </li>

90) 

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

93) 

94)     <li>Leave <tt>Attempt to automatically configure port forwarding</tt> clicked.
95)     Push the <tt>Test</tt> button to see if it works.  If it does work, great.
96)     If not, see number 3 below.</li>

97) 

98)     <li><dt>Choose the <tt>Bandwidth Limits</tt> tab.  Select how much bandwidth you want to provide for Tor users like yourself.</dt>

99)     <dd><img alt="vidalia bandwidth limits" src="$(IMGROOT)/screenshot-win32-configure-relay-2.png" /></dd>

100)     </li>
101) 

102)     <li><dt>Choose the <tt>Exit Policies</tt> tab.  If you want to allow others
103)     to use your relay for these services, don't change anything.  Un-check

104)     the services you don't want to allow people to <a href="<page
105)     docs/faq>#ExitPolicies">reach from your relay</a>.  If you want to
106)     be a non-exit relay, un-check all services.</dt>

107)     <dd><img alt="vidalia exit policies" src="$(IMGROOT)/screenshot-win32-configure-relay-3.png" /></dd>

108)     </li>

109) 

110)     <li>Click the <tt>Ok</tt> button.  See Step Three below for confirmation
111)     that the relay is working correctly.</li>
112)     </ol>

113) 

114)     <li>If you are using a firewall, open a hole in your firewall
115)     so incoming connections can reach the ports you configured
116)     (ORPort, plus DirPort if you enabled it). If you have a
117)     hardware firewall (Linksys box, cablemodem, etc) you might like <a
118)     href="http://portforward.com/">portforward.com</a>. Also, make sure you
119)     allow all <em>outgoing</em> connections too, so your relay can reach the
120)     other Tor relays.
121)     </li>

122) 

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

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

125)     any warnings</a>, address them.
126)     </li>

127) 

128)     <li>Subscribe to the <a
129)     href="http://archives.seul.org/or/announce/">or-announce</a>
130)     mailing list. It is very low volume, and it will keep you informed
131)     of new stable releases. You might also consider subscribing to <a
132)     href="<page docs/documentation>#MailingLists">the higher-volume Tor lists</a>
133)     too.
134)     </li>

135) 

136)     </li></ol>

137) 

138)     <hr>

139)     <a id="check"></a>
140)     <h2><a class="anchor" href="#check">Step Three: Make sure it is working</a></h2>

141)     <br>

142) 

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

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

147)     <tt>Self-testing indicates your ORPort is reachable from the outside. Excellent.</tt>
148)     If you don't see this message, it means that your relay is not reachable
149)     from the outside &mdash; you should re-check your firewalls, check that it's
150)     testing the IP and port you think it should be testing, etc.
151)     </p>

152) 

153)     <p>When it decides that it's reachable, it will upload a "server
154)     descriptor" to the directories, to let clients know
155)     what address, ports, keys, etc your relay is using. You can <a
156)     href="http://194.109.206.212/tor/status-vote/current/consensus">load one of
157)     the network statuses manually</a> and
158)     look through it to find the nickname you configured, to make sure it's
159)     there. You may need to wait up to one hour to give enough time for it to
160)     make a fresh directory.</p>

161) 

162)     <hr>

163)     <a id="after"></a>
164)     <h2><a class="anchor" href="#after">Step Four: Once it is working</a></h2>

165)     <br>

166) 

167)     <p>
168)     We recommend the following steps as well:
169)     </p>

170) 

171)     <p>
172)     6. Read

173)     <a href="<wiki>TheOnionRouter/OperationalSecurity">about operational security</a>

174)     to get ideas how you can increase the security of your relay.
175)     </p>

176) 

177)     <p>
178)     7. If you want to run more than one relay that's great, but please set <a

179)     href="<page docs/faq>#MultipleRelays">the

180)     MyFamily option</a> in all your relays' configuration files.
181)     </p>

182) 

183)     <p>
184)     8. Decide about rate limiting. Cable modem, DSL, and other users
185)     who have asymmetric bandwidth (e.g. more down than up) should
186)     rate limit to their slower bandwidth, to avoid congestion. See the <a

187)     href="<wikifaq>#LimitBandwidth">rate

188)     limiting FAQ entry</a> for details.
189)     </p>

190) 

191)     <p>
192)     9. Back up your Tor relay's private key (stored in "keys/secret_id_key"
193)     in your DataDirectory). This is your relay's "identity," and
194)     you need to keep it safe so nobody can read the traffic that goes
195)     through your relay. This is the critical file to keep if you need to <a

196)     href="<wikifaq>#UpgradeRelay">move

197)     or restore your Tor relay</a> if something goes wrong.
198)     </p>

199) 

200)     <p>

201) 

202)     10. If you control the name servers for your domain, consider setting your
203)     reverse DNS hostname to 'anonymous-relay', 'proxy' or 'tor-proxy', so when
204)     other people see the address in their web logs, they will more quickly
205)     understand what's going on. Adding the <a
206)     href="<gitblob>contrib/tor-exit-notice.html">Tor
207)     exit notice</a> on a vhost for this name can go a long way to deterring abuse
208)     complaints to you and your ISP if you are running an exit node.

209) 

210)     </p>

211) 

212)     <p>
213)     11. If your computer isn't running a webserver, please consider
214)     changing your ORPort to 443 and your DirPort to 80. Many Tor
215)     users are stuck behind firewalls that only let them browse the
216)     web, and this change will let them reach your Tor relay. Win32
217)     relays can simply change their ORPort and DirPort directly
218)     in their torrc and restart Tor. OS X or Unix relays can't bind
219)     directly to these ports (since they don't run as root), so they will
220)     need to set up some sort of <a

221)     href="<wikifaq>#ServerForFirewalledClients">

222)     port forwarding</a> so connections can reach their Tor relay. If you are
223)     using ports 80 and 443 already but still want to help out, other useful
224)     ports are 22, 110, and 143.
225)     </p>

226) 

227)     <p>
228)     12. If your Tor relay provides other services on the same IP address
229)     &mdash; such as a public webserver &mdash; make sure that connections to the
230)     webserver are allowed from the local host too. You need to allow these
231)     connections because Tor clients will detect that your Tor relay is the <a

232)     href="<wikifaq>#ExitEavesdroppers">safest

233)     way to reach that webserver</a>, and always build a circuit that ends
234)     at your relay. If you don't want to allow the connections, you must
235)     explicitly reject them in your exit policy.
236)     </p>

237) 

238)     <p>
239)     13. (Unix only). Make a separate user to run the relay. If you
240)     installed the OS X package or the deb or the rpm, this is already
241)     done. Otherwise, you can do it by hand. (The Tor relay doesn't need to
242)     be run as root, so it's good practice to not run it as root. Running
243)     as a 'tor' user avoids issues with identd and other services that
244)     detect user name. If you're the paranoid sort, feel free to <a

245)     href="<wiki>TheOnionRouter/TorInChroot">put Tor

246)     into a chroot jail</a>.)
247)     </p>

248) 

249)     <p>
250)     14. (Unix only.) Your operating system probably limits the number
251)     of open file descriptors per process to 1024 (or even less). If you
252)     plan to be running a fast exit node, this is probably not enough. On
253)     Linux, you should add a line like "toruser hard nofile 8192" to your
254)     /etc/security/limits.conf file (where toruser is the user that runs the
255)     Tor process), and then restart Tor if it's installed as a package (or log
256)     out and log back in if you run it yourself).
257)     </p>

258) 

259)     <p>
260)     15. If you installed Tor via some package or installer, it probably starts
261)     Tor for you automatically on boot. But if you installed from source,
262)     you may find the initscripts in contrib/tor.sh or contrib/torctl useful.
263)     </p>

264) 

265)     <p>
266)     When you change your Tor configuration, remember to verify that your
267)     relay still works correctly after the change. Be sure to set your
268)     "ContactInfo" line in the torrc so we can contact you if you need to
269)     upgrade or something goes wrong. If you have problems or questions, see
270)     the <a href="<page docs/documentation>#Support">Support</a> section or
271)     <a href="<page about/contact>">contact us</a> on the tor-ops list. Thanks
272)     for helping to make the Tor network grow!
273)     </p>

274) 

275)     <hr>

276) 

277)     <p>If you have suggestions for improving this document, please <a
278)     href="<page about/contact>">send them to us</a>. Thanks!</p>
279)   </div>
280)   <!-- END MAINCOL -->
281)   <div id = "sidecol">
282) #include "side.wmi"
283) #include "info.wmi"
284)   </div>
285)   <!-- END SIDECOL -->
286) </div>
287) <!-- END CONTENT -->