docs/en/tor-doc-relay.wml
2a9aaa80
 ## translation metadata
40e07e2e
 # Revision: $Revision$
2a9aaa80
 # Translation-Priority: 2-medium
 
 #include "head.wmi" TITLE="Tor Project: Relay Configuration Instructions" CHARSET="UTF-8"
 <div id="content" class="clearfix">
   <div id="breadcrumbs">
b289ef06
     <a href="<page index>">Home &raquo; </a>
2a9aaa80
     <a href="<page docs/documentation>">Documentation &raquo; </a>
     <a href="<page docs/tor-doc-relay>">Configure Tor Relay</a>
bbff1b34
   </div>
   <div id="maincol">
2a9aaa80
 
     <h1>Configuring a Tor relay</h1>
bbff1b34
 
ed5ac546
     <hr>
bbff1b34
 
2a9aaa80
     <p>
     The Tor network relies on volunteers to donate bandwidth. The more
     people who run relays, the faster the Tor network will be. If you have
35be4c37
     at least 2 megabits/s for both upload and download, please help out
     Tor by configuring your Tor to be a relay too.
2a9aaa80
     </p>
bbff1b34
 
db82b71b
     <p>You can run a Tor relay on pretty much any operating system. Tor relays
dd256341
     work best on current distributions of Linux, FreeBSD, NetBSD, and
6ee5018f
     Windows Server.
2a9aaa80
     </p>
bbff1b34
 
d70a4182
     <p>
a4ba8bc8
     The best approach for most users is to <a href="<page
     docs/tor-relay-debian>">run your relay on Debian or Ubuntu</a> using
b6b23af6
     the system Tor package &mdash; the deb takes care of running Tor as a
a4ba8bc8
     separate user, making sure it has enough file descriptors available,
     starting it at boot, and so on. Tor relays also run nicely on other
     Linux flavors, and on FreeBSD and NetBSD for those who are comfortable
     with those operating systems.
     </p>
d70a4182
 
     <hr>
     <a id="torrc"></a>
6f634d3c
     <h2><a class="anchor" href="#torrc">Configure Tor by editing the torrc file</a></h2>
18f2784f
     <br />
bbff1b34
 
d70a4182
     <p>
c261c7ec
     Tor's
dd256341
     configuration file is named 'torrc'.</p>
     <p>Locate the file on your system, open it with a text editor and add the
     following lines:</p>
d70a4182
 
     <pre>
     ORPort 443
     Exitpolicy reject *:*
18f2784f
     Nickname ididntedittheconfig
d70a4182
     ContactInfo human@...
     </pre>
 
c21cddf4
 # TODO: Update link to PT setup docs
233ae29c
     <p>If you want to be a bridge, read about the BridgeRelay and
     ServerTransportPlugin values <a
c21cddf4
     href="<page docs/pluggable-transports>">on
d70a4182
     this page</a>.</p>
 
233ae29c
     <p>Tor will use all your bandwidth if you don't set limits for it. Some
     options are described in <a href="<page docs/faq>#LimitTotalBandwidth">these</a>
d70a4182
     <a href="<page docs/faq>#BandwidthShaping">FAQ entries</a>.</p>
 
1700644e
     <p>See the <a href="https://gitweb.torproject.org/tor.git/plain/src/config/torrc.sample.in">sample
233ae29c
     torrc file</a> and the <a
e3eea58d
     href="<page docs/tor-manual>">man
18f2784f
     page</a> for other Tor options you may want to set.</p>
bbff1b34
 
ed5ac546
     <hr>
2a9aaa80
     <a id="check"></a>
18f2784f
     <h2><a class="anchor" href="#check">Make sure your relay is reachable</a></h2>
ed5ac546
     <br>
bbff1b34
 
18f2784f
     <p>If you are using a firewall, open a hole in your firewall
     so incoming connections can reach the ports you configured
     (ORPort, plus DirPort if you enabled it). If you have a
     hardware firewall (Linksys box, cable modem, etc) you might find <a
     href="http://portforward.com/">portforward.com</a> useful. Also, make sure you
     allow all <em>outgoing</em> connections too, so your relay can reach the
     other Tor relays.
     </p>
 
     <p>Restart your relay. If it <a
     href="<page docs/faq>#Logs">logs
     any warnings</a>, address them.
     </p>
 
2a9aaa80
     <p>As soon as your relay manages to connect to the network, it will
     try to determine whether the ports you configured are reachable from
     the outside. This step is usually fast, but may take up to 20
3a045675
     minutes. Look for a <a href="<page docs/faq>#Logs">log entry</a> like
d70a4182
     <pre>Self-testing indicates your ORPort is reachable from the outside. Excellent.</pre>
2a9aaa80
     If you don't see this message, it means that your relay is not reachable
     from the outside &mdash; you should re-check your firewalls, check that it's
     testing the IP and port you think it should be testing, etc.
     </p>
bbff1b34
 
d70a4182
     <p>When your relay has decided that it's reachable, it will upload a "server
2a9aaa80
     descriptor" to the directories, to let clients know
d70a4182
     what address, ports, keys, etc your relay is using. You can search <a
233ae29c
     href="https://atlas.torproject.org/">Atlas</a> or <a
     href="https://globe.torproject.org/">Globe</a> for
     the nickname you configured, to make sure it's there. You may need to wait
d70a4182
     up to one hour for the directories to publish the new server information.</p>
bbff1b34
 
ed5ac546
     <hr>
2a9aaa80
     <a id="after"></a>
d70a4182
     <h2><a class="anchor" href="#after">Once your relay is working</a></h2>
ed5ac546
     <br>
bbff1b34
 
c1786e7e
     <p>To learn more about the proper care and feeding for your relay,
     see the advice on the <a href=<page docs/tor-relay-debian>#after>Tor
     relay on Debian/Ubuntu</a> page.
d70a4182
     </p>
 
ed5ac546
     <hr>
bbff1b34
 
2a9aaa80
     <p>If you have suggestions for improving this document, please <a
c1786e7e
     href="<page about/contact>">send them to us</a>. Thanks
     for helping to make the Tor network grow!</p>
2a9aaa80
   </div>
   <!-- END MAINCOL -->
   <div id = "sidecol">
 #include "side.wmi"
 #include "info.wmi"
   </div>
   <!-- END SIDECOL -->
 </div>
 <!-- END CONTENT -->
bbff1b34
 #include <foot.wmi>
8cacb915