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 2 megabits/s for both upload and download, please help out
22)     Tor by configuring your 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 current distributions of Linux, FreeBSD, NetBSD, and

27)     Windows Server.

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)     <hr>
41)     <a id="torrc"></a>

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

43)     <br />

44) 

45)     <p>

46)     Tor's

47)     configuration file is named 'torrc'.</p>
48)     <p>Locate the file on your system, open it with a text editor and add the
49)     following lines:</p>

50) 
51)     <pre>
52)     ORPort 443
53)     Exitpolicy reject *:*

54)     Nickname ididntedittheconfig

55)     ContactInfo human@...
56)     </pre>
57) 

58) # TODO: Update link to PT setup docs

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

61)     href="<page docs/pluggable-transports>">on

62)     this page</a>.</p>
63) 

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

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

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

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

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

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

72) 

73)     <hr>

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

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

76)     <br>

77) 

78)     <p>If you are using a firewall, open a hole in your firewall
79)     so incoming connections can reach the ports you configured
80)     (ORPort, plus DirPort if you enabled it). If you have a
81)     hardware firewall (Linksys box, cable modem, etc) you might find <a
82)     href="http://portforward.com/">portforward.com</a> useful. Also, make sure you
83)     allow all <em>outgoing</em> connections too, so your relay can reach the
84)     other Tor relays.
85)     </p>
86) 
87)     <p>Restart your relay. If it <a
88)     href="<page docs/faq>#Logs">logs
89)     any warnings</a>, address them.
90)     </p>
91) 

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

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

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

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

101) 

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

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

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

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

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

109) 

110)     <hr>

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

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

113)     <br>

114) 

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

118)     </p>
119) 

120)     <hr>

121) 

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

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

125)   </div>
126)   <!-- END MAINCOL -->
127)   <div id = "sidecol">
128) #include "side.wmi"
129) #include "info.wmi"
130)   </div>
131)   <!-- END SIDECOL -->
132) </div>
133) <!-- END CONTENT -->

134) #include <foot.wmi>