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>If you're comfortable editing text files, skip this page and
31)     go to our dedicated <a href="<page docs/tor-relay-debian>">Relay
32)     Configuration Instructions on Debian/Ubuntu</a> page. That page is
33)     the best one for relay operators on BSD, Unix, etc as well.</p>
34) 

35)     <hr>

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

39)     <br>

40) 

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

43) 

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

45)     install the "Installation Bundle" for your OS.
46)     </p>

47) 

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

50) 

51)     <hr>

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

54)     <br>

55)     <ol>

56) 

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

62) 

63)     <li><strong>Configuring Tor with the Vidalia Graphical Interface</strong>:
64)     <ol>

65) 

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

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

69)     </li>

70) 

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

72) 

73)     <li>

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

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

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

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

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

80)     </li>

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 <tt>Attempt to automatically configure port forwarding</tt> clicked.
86)     Push the <tt>Test</tt> button to see if it works.  If it does work, great.
87)     If not, see number 3 below.</li>

88) 

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

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

91)     </li>
92) 

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

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

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

99)     </li>

100) 

101)     <li>Click the <tt>Ok</tt> button.  See Step Three below for confirmation
102)     that the relay is working correctly.</li>
103)     </ol>

104) 

105)     <li>If you are using a firewall, open a hole in your firewall
106)     so incoming connections can reach the ports you configured
107)     (ORPort, plus DirPort if you enabled it). If you have a
108)     hardware firewall (Linksys box, cablemodem, etc) you might like <a
109)     href="http://portforward.com/">portforward.com</a>. Also, make sure you
110)     allow all <em>outgoing</em> connections too, so your relay can reach the
111)     other Tor relays.
112)     </li>

113) 

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

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

116)     any warnings</a>, address them.
117)     </li>

118) 

119)     <li>Subscribe to the <a

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

121)     mailing list. It is very low volume, and it will keep you informed
122)     of new stable releases. You might also consider subscribing to <a
123)     href="<page docs/documentation>#MailingLists">the higher-volume Tor lists</a>

124)     too.</li>
125)     <li><a href="https://weather.torproject.org/">Tor Weather</a> provides
126)     an email notification service to any users who want to monitor the
127)     status of a Tor node. Upon subscribing, you can specify what types of
128)     alerts you would like to receive. The main purpose of Tor Weather is
129)     to notify node operators via email if their node is down for longer
130)     than a specified period, but other notification types are available.

131)     </li>

132) 

133)     </li></ol>

134) 

135)     <hr>

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

138)     <br>

139) 

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

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

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

149) 

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

158) 

159)     <hr>

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

162)     <br>

163) 

164)     <p>Read

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

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

167)     </p>

168) 

169)     <p>

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

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

177)     </p>

178) 

179)     <p>
180)     When you change your Tor configuration, remember to verify that your

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

183)     the <a href="<page docs/documentation>#Support">Support</a> section or
184)     <a href="<page about/contact>">contact us</a> on the tor-ops list. Thanks
185)     for helping to make the Tor network grow!
186)     </p>

187) 

188)     <hr>

189) 

190)     <p>If you have suggestions for improving this document, please <a
191)     href="<page about/contact>">send them to us</a>. Thanks!</p>
192)   </div>
193)   <!-- END MAINCOL -->
194)   <div id = "sidecol">
195) #include "side.wmi"
196) #include "info.wmi"
197)   </div>
198)   <!-- END SIDECOL -->
199) </div>
200) <!-- END CONTENT -->

201) #include <foot.wmi>