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 on Debian/Ubuntu" 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 on Debian/Ubuntu</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)     <hr>
26)     <a id="zero"></a>
27)     <a id="install"></a>
28)     <h2><a class="anchor" href="#install">Step One: Download and Install Tor</a></h2>
29)     <br>
30) 

31)     <p>If you're on Debian, start with "apt-get install tor".</p>

32) 
33)     <p><b>Do not use the packages in Ubuntu's universe.</b> If you're
34)     on Ubuntu or if you want to track newer Tor packages, follow the
35)     <a href="<page docs/debian>#ubuntu">Tor on Ubuntu or Debian</a>
36)     instructions to use our repository.
37)     </p>
38) 

39)     <p>For other Unix/Linux users, you can download Tor from one of our

40)     <a href="<page download/download-unix>">repositories</a>.</p>
41) 

42)     <hr>
43)     <a id="setup"></a>
44)     <h2><a class="anchor" href="#setup">Step Two: Set it up as a relay</a></h2>
45) 
46)     <p>
47)     1. Make sure your clock, date, and timezone are set correctly. Install
48)     the ntp or openntpd (or similar) package to keep it that way.
49)     </p>
50) 
51)     <p>
52)     2. Edit the bottom part of <a href="<page

53)     docs/faq>#torrc">/etc/tor/torrc</a>. Define an ORPort. <b>Note

54)     that public relays default to being <a href="<page

55)     docs/faq>#ExitPolicies">exit relays</a></b> &mdash; either change your

56)     ExitPolicy line or read our <a

57) href="<wiki>/doc/TorExitGuidelines">guidelines

58)     for exit relay operators</a>. Be sure to set your ContactInfo line
59)     so we can contact you if you need to upgrade or something goes wrong.
60)     </p>
61) 
62)     <p>
63)     3. If you are using a firewall, open a hole in your firewall
64)     so incoming connections can reach the ports you configured
65)     (ORPort, plus DirPort if you enabled it). If you have a
66)     hardware firewall (Linksys box, cablemodem, etc) you might like <a
67)     href="http://portforward.com/">portforward.com</a>. Also, make sure you
68)     allow all <em>outgoing</em> connections too, so your relay can reach the
69)     other Tor relays.
70)     </p>
71) 
72)     <p>
73)     4. Restart your relay: "service tor reload" (as root).
74)     </p>
75) 
76)     <hr>
77)     <a id="check"></a>
78)     <h2><a class="anchor" href="#check">Step Three: Make sure it is working</a></h2>
79)     <br>
80) 
81)     <p>Once your relay connects to the network, it will
82)     try to determine whether the ports you configured are reachable from
83)     the outside. This step is usually fast, but it may take a few minutes.
84)     Look for a <a href="<page docs/faq>#Logs">log entry</a> in your
85)     /var/log/tor/log like
86)     <tt>Self-testing indicates your ORPort is reachable from the outside. Excellent.</tt>
87)     If you don't see this message, it means that your relay is not reachable
88)     from the outside &mdash; you should re-check your firewalls, check that it's
89)     testing the IP and port you think it should be testing, etc.
90)     </p>
91) 
92)     <p>When it decides that it's reachable, it will upload a "server

93)     descriptor" to the directory authorities, to let clients know
94)     what address, ports, keys, etc your relay is using. After a few

95)     hours (to give it enough time to propagate), you can query
96)     <a href="https://atlas.torproject.org/">Atlas</a> or
97)     <a href="https://globe.torproject.org/">Globe</a> to see whether your
98)     relay has successfully registered in the network.</p>

99) 
100)     <hr>
101)     <a id="after"></a>
102)     <h2><a class="anchor" href="#after">Step Four: Once it is working</a></h2>
103)     <br>
104) 
105)     <p>
106)     5. Read
107)     <a href="<wiki>doc/OperationalSecurity">about operational security</a>
108)     to get ideas how you can increase the security of your computer.
109)     </p>
110) 
111)     <p>
112)     6. Decide about rate limiting. Cable modem, DSL, and other users
113)     who have asymmetric bandwidth (e.g. more down than up) should
114)     rate limit to their slower bandwidth, to avoid congestion. See the <a

115)     href="<page docs/faq>#BandwidthShaping">rate

116)     limiting FAQ entry</a> for details.
117)     </p>
118) 
119)     <p>

120)     7. If your computer isn't running a webserver, and you haven't set
121)     AccountingMax, please consider

122)     changing your ORPort to 443 and/or your DirPort to 80. Many Tor users
123)     are stuck behind firewalls that only let them browse the web, and
124)     this change will let them reach your Tor relay. If you are already
125)     using ports 80 and 443, other useful ports are 22, 110, and 143.
126)     </p>
127) 
128)     <p>

129)     8. Consider backing up your Tor relay's private keys
130)     ("/var/lib/tor/keys/secret_id_key" and
131)     "/var/lib/tor/keys/ed25519_master_id_secret_key").
132)     You'll need these identity keys to

133)     <a href="<page docs/faq>#UpgradeOrMove">move or restore your Tor relay</a>.

134)     </p>
135) 
136)     <p>

137)     9. If you run an exit relay (great!), don't miss out on our <a
138)     href="<wiki>doc/TorExitGuidelines">Exit Guidelines</a>, including
139)     setting your reverse DNS hostname to make it obvious that you're
140)     a Tor exit relay, and serving the <a
141)     href="<gitblob>contrib/operator-tools/tor-exit-notice.html">Tor
142)     exit notice</a> page on your DirPort.

143)     </p>
144) 
145)     <p>
146)     10. Subscribe to the <a
147)     href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-announce">tor-announce</a>
148)     mailing list. It is very low volume, and it will keep you informed

149)     of new stable releases.
150)     As a relay operator, you should consider subscribing to the
151)     <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-relays">
152)     tor-relays mailing list</a> too.
153)     We have more <a href="<page docs/documentation>#MailingLists">mailing
154)     lists</a> as well.

155)     </p>
156) 
157)     <p>

158)     11. Read the <a 
159)     href="https://blog.torproject.org/blog/lifecycle-of-a-new-relay">"Lifecycle 
160)     of a New Relay"</a> document to learn what sort of activity and usage 
161)     patterns you can expect during your relay's first weeks of operation.
162)     </p>
163) 
164)     <p>

165)     12. If you want to run more than one relay that's great, but please set <a

166)     href="<page docs/faq>#MultipleRelays">the
167)     MyFamily option</a> in all your relays' configuration files.
168)     </p>
169) 

170)     <p>

171)     13. You might like to use the <a

172)     href="https://www.atagar.com/arm/">arm</a> relay monitor to watch
173)     your relay's activities from the command line. First, "sudo apt-get
174)     install tor-arm". Second, as the user that will be running arm, run
175)     "sudo adduser $USER debian-tor" to add your user to the debian-tor
176)     group so it can reach Tor's controlsocket. Then log out and log back
177)     in (so your user is actually in the group), and run "arm".
178)     </p>
179) 

180)     <p>

181)     14. When you change your Tor configuration, remember to verify that

182)     your relay still works correctly after the change.
183)     </p>
184)