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 250 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)     The best approach for most users is to <a href="<page
32)     docs/tor-relay-debian>">run your relay on Debian or Ubuntu</a> using

33)     the system Tor package — the deb takes care of running Tor as a

34)     separate user, making sure it has enough file descriptors available,
35)     starting it at boot, and so on. Tor relays also run nicely on other
36)     Linux flavors, and on FreeBSD and NetBSD for those who are comfortable
37)     with those operating systems.
38)     </p>

39) 

40)     <p>Windows users can use the Vidalia Bridge Bundle, the Vidalia Relay
41)     Bundle and the Vidalia Exit Bundle, which come preconfigured to run
42)     Tor as a bridge, a non-exit relay, or an exit relay. Get them from
43)     the <a href="<page download/download>">download page</a>, and use
44)     the graphical instructions below for help setting them up.

45)     </p>
46) 

47)     <p>Alas, since Vidalia (a graphical interface for Tor) is <a
48)     href="<page docs/faq>#WhereDidVidaliaGo">no longer included</a>

49)     in Tor Browser, there are currently no

50)     easy relay packages for OS X users. One option might be to run
51)     Debian in a VM, or use a different means of getting a Tor binary on
52)     your system (Homebrew, Macports). Please help make this process
53)     easier!

54)     </p>
55) 
56)     <hr>
57)     <a id="torrc"></a>

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

59)     <br />

60) 

61)     <p>

62)     You can set up a relay without using Vidalia if you wish. Tor's
63)     configuration file is named 'torrc'. In the Tor Browser folder, it's

64)     located at</p>
65)     <pre>Data\Tor\torrc</pre>
66)     <p>Open the file with a text editor and add the following lines:</p>

67) 
68)     <pre>
69)     ORPort 443
70)     Exitpolicy reject *:*

71)     Nickname ididntedittheconfig

72)     ContactInfo human@...
73)     </pre>
74) 

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

77)     href="<page projects/obfsproxy-instructions>#instructions">on

78)     this page</a>.</p>
79) 

80)     <p>Tor will use all your bandwidth if you don't set limits for it. Some
81)     options are described in <a href="<page docs/faq>#LimitTotalBandwidth">these</a>

82)     <a href="<page docs/faq>#BandwidthShaping">FAQ entries</a>.</p>
83) 

84)     <p>See the <a href="https://gitweb.torproject.org/tor.git/plain/src/config/torrc.sample.in">sample

85)     torrc file</a> and the <a

86)     href="<page docs/tor-manual>">man

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

88) 

89)     <hr>

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

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

92)     <br>

93) 

94)     <p>If you are using a firewall, open a hole in your firewall
95)     so incoming connections can reach the ports you configured
96)     (ORPort, plus DirPort if you enabled it). If you have a
97)     hardware firewall (Linksys box, cable modem, etc) you might find <a
98)     href="http://portforward.com/">portforward.com</a> useful. Also, make sure you
99)     allow all <em>outgoing</em> connections too, so your relay can reach the
100)     other Tor relays.
101)     </p>
102) 
103)     <p>Restart your relay. If it <a
104)     href="<page docs/faq>#Logs">logs
105)     any warnings</a>, address them.
106)     </p>
107) 

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

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

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

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

117) 

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

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

120)     what address, ports, keys, etc your relay is using. You can search <a

121)     href="https://atlas.torproject.org/">Atlas</a> or <a
122)     href="https://globe.torproject.org/">Globe</a> for
123)     the nickname you configured, to make sure it's there. You may need to wait

124)     up to one hour for the directories to publish the new server information.</p>

125) 

126)     <hr>

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

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

129)     <br>

130) 

131)     <p>To learn more about the proper care and feeding for your relay,
132)     see the advice on the <a href=<page docs/tor-relay-debian>#after>Tor
133)     relay on Debian/Ubuntu</a> page.

134)     </p>
135) 

136)     <hr>

137) 

138)     <p>If you have suggestions for improving this document, please <a

139)     href="<page about/contact>">send them to us</a>. Thanks
140)     for helping to make the Tor network grow!</p>

141)   </div>
142)   <!-- END MAINCOL -->
143)   <div id = "sidecol">
144) #include "side.wmi"
145) #include "info.wmi"
146)   </div>
147)   <!-- END SIDECOL -->
148) </div>
149) <!-- END CONTENT -->

150) #include <foot.wmi>