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>. 

35)     <p>
36) 
37)     <p>The Vidalia Bridge Bundle, the Vidalia Relay Bundle 

38)     and the Vidalia Exit Bundle are available on the 

39)     <a href="https://www.torproject.org/download/download.html.en">download 

40)     page</a>. These bundles are only available for Windows. They come 
41)     preconfigured to run Tor as a bridge, a non-exit relay, or an exit relay. 

42)     </p>
43) 
44)     <p>
45)     Vidalia is also available as a standalone package from <a 
46)     href="https://people.torproject.org/~erinn/vidalia-standalone-bundles/">this 
47)     directory</a>. To use the Vidalia standalone, you will first need to <a 
48)     href="https://torproject.org/projects/torbrowser.html.en">download 
49)     the Tor Browser Bundle</a> or the <a href="https://www.torproject.org/download/download.html.en">Tor Expert Bundle</a>. 
50)     Unpack the Vidalia package into your Tor Browser folder. This will allow 

51)     Vidalia to control and configure the Tor Browser Bundle's Tor client. If 
52)     you use the Expert Bundle, which contains Tor only and no browser, you'll 
53)     need to inform Vidalia of your Tor's location.

54)     </p>
55) 
56)     <p>
57)     Make sure your Tor works by using Tor as a client (surf with the Tor 
58)     Browser, for example). Verify that your clock and timezone are set
59)     correctly. If possible, synchronize your clock with public <a
60)     href="http://en.wikipedia.org/wiki/Network_Time_Protocol">time
61)     servers</a>.</p>
62) 

63)     <hr>

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

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

66)     <br>

67)     <ol type=1>

68) 
69) 

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

72) 

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

74) 

75)     <li>

76)     Choose "Relay Traffic for the Tor network" if you
77) want to be a public relay (recommended), or choose "Help
78) censored users reach the Tor network" if you want to be a <a

79) href="<page docs/faq>#RelayOrBridge">non-public bridge</a>.</li><br />
80)     <img alt="Vidalia basic settings" src="$(IMGROOT)/screenshot-win32-configure-relay-1.png" />

81) 

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

84) 

85)     <li>Leave "Attempt to automatically configure port forwarding" ticked.
86)     Push the "Test" button to see if it works. If it does work, great.
87)     If not, see the section on reachability below.</li>

88) 

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

91) 

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

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

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

96)     be a non-exit relay, un-check all services.</li><br />
97)     <img alt="Vidalia exit policies" src="$(IMGROOT)/screenshot-win32-configure-relay-3.png" />

98) 

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

100) 

101)     </ol>
102) 
103)     <hr>
104)     <a id="torrc"></a>

105)     <h2><a class="anchor" href="#torrc">Configure Tor by editing the torrc file</a></h2>

106)     <br />

107) 

108)     <p>

109)     You can set up a relay without using Vidalia if you wish. Tor's 
110)     configuration file is named 'torrc'. In the Tor Browser folder, it's 
111)     located at</p>
112)     <pre>Data\Tor\torrc</pre>
113)     <p>Open the file with a text editor and add the following lines:</p>

114) 
115)     <pre>
116)     ORPort 443
117)     Exitpolicy reject *:*

118)     Nickname ididntedittheconfig

119)     ContactInfo human@...
120)     </pre>
121) 

122)     <p>If you want to be a bridge, read about the BridgeRelay and 
123)     ServerTransportPlugin values <a 

124)     href="https://www.torproject.org/projects/obfsproxy-instructions.html.en#instructions">on
125)     this page</a>.</p>
126) 
127)     <p>Tor will use all your bandwidth if you don't set limits for it. Some 
128)     options are described in <a href="<page docs/faq>#LimitTotalBandwidth">these</a> 
129)     <a href="<page docs/faq>#BandwidthShaping">FAQ entries</a>.</p>
130) 
131)     <p>See the <a href="https://gitweb.torproject.org/tor.git/blob/HEAD:/src/config/torrc.sample.in">sample 
132)     torrc file</a> and the <a 
133)     href="https://www.torproject.org/docs/tor-manual.html.en">man

134)     page</a> for other Tor options you may want to set.</p>

135) 

136)     <hr>

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

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

139)     <br>

140) 

141)     <p>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)     </p>
149) 
150)     <p>Restart your relay. If it <a
151)     href="<page docs/faq>#Logs">logs
152)     any warnings</a>, address them.
153)     </p>
154) 

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

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

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

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

164) 

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

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

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

172) 

173)     <hr>

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

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

176)     <br>

177) 

178)     <p>Subscribe to the <a
179)     href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-announce">tor-announce</a>
180)     mailing list. It is very low volume, and it will keep you informed
181)     of new stable releases.</p>
182)     
183)     <p>As a relay operator, you should consider subscribing to the 
184)     <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-relays">
185)     tor-relays mailing list</a>. You might find <a
186)     href="../docs/documentation.html.en#MailingLists">other higher-volume 

187)     Tor lists</a> of interest to you as well.

188)     </p>
189) 
190)     <p><a href="https://weather.torproject.org/">Tor Weather</a> provides
191)     an email notification service to any users who want to monitor the
192)     status of a Tor node. Upon subscribing, you can specify what types of
193)     alerts you would like to receive. The main purpose of Tor Weather is
194)     to notify node operators via email if their node is down for longer
195)     than a specified period, but other notification types are available.
196)     </p>
197) 

198)     <p>Read

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

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

201)     </p>

202) 

203)     <p>

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

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

211)     </p>

212) 

213)     <p>
214)     When you change your Tor configuration, remember to verify that your

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

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

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

219)     for helping to make the Tor network grow!
220)     </p>

221) 

222) 

223)     <hr>

224) 

225)     <p>If you have suggestions for improving this document, please <a
226)     href="<page about/contact>">send them to us</a>. Thanks!</p>
227)   </div>
228)   <!-- END MAINCOL -->
229)   <div id = "sidecol">
230) #include "side.wmi"
231) #include "info.wmi"
232)   </div>
233)   <!-- END SIDECOL -->
234) </div>
235) <!-- END CONTENT -->

236) #include <foot.wmi>