tor-webwml.git

docs/en/tor-doc-server.wml   1) ## translation metadata
docs/en/tor-doc-server.wml   2) # Revision: $Revision$

docs/en/tor-doc-relay.wml    3) # Translation-Priority: 2-medium

docs/en/tor-doc-server.wml   4) 

docs/en/tor-doc-relay.wml    5) #include "head.wmi" TITLE="Tor: Relay Configuration Instructions" CHARSET="UTF-8"

docs/en/tor-doc-server.wml   6) 
docs/en/tor-doc-server.wml   7) <div class="center">
docs/en/tor-doc-server.wml   8) 
docs/en/tor-doc-server.wml   9) <div class="main-column">
docs/en/tor-doc-server.wml  10) 

docs/en/tor-doc-relay.wml   11) <h1>Configuring a Tor relay</h1>
docs/en/tor-doc-relay.wml   12) 
docs/en/tor-doc-relay.wml   13) <!-- BEGIN SIDEBAR -->
docs/en/tor-doc-relay.wml   14) <div class="sidebar-left">
docs/en/tor-doc-relay.wml   15) <h3>Config Steps</h3>
docs/en/tor-doc-relay.wml   16) <ol>

docs/en/tor-doc-relay.wml   17) <li><a href="<page docs/tor-doc-relay>#install">Download &amp; Install</a></li>

docs/en/tor-doc-relay.wml   18) <li><a href="<page docs/tor-doc-relay>#setup">Configuration</a></li>

docs/en/tor-doc-relay.wml   19) <li><a href="<page docs/tor-doc-relay>#check">Check &amp; Confirm</a></li>

docs/en/tor-doc-relay.wml   20) <li><a href="<page docs/tor-doc-relay>#after">Final Steps</a></li>
docs/en/tor-doc-relay.wml   21) </ol>
docs/en/tor-doc-relay.wml   22) </div>
docs/en/tor-doc-relay.wml   23) <!-- END SIDEBAR -->
docs/en/tor-doc-relay.wml   24) 
docs/en/tor-doc-relay.wml   25) <hr />

docs/en/tor-doc-server.wml  26) 
docs/en/tor-doc-server.wml  27) <p>
docs/en/tor-doc-server.wml  28) The Tor network relies on volunteers to donate bandwidth. The more

docs/en/tor-doc-relay.wml   29) people who run relays, the faster the Tor network will be. If you have

docs/en/tor-doc-server.wml  30) at least 20 kilobytes/s each way, please help out Tor by configuring your

docs/en/tor-doc-relay.wml   31) Tor to be a relay too. We have many features that make Tor relays easy

docs/en/tor-doc-relay.wml   32) and convenient, including <a href="<page faq>#RelayFlexible">rate limiting
docs/en/tor-doc-relay.wml   33) for bandwidth, exit policies so you can limit your exposure to abuse
docs/en/tor-doc-relay.wml   34) complaints, and support for dynamic IP addresses</a>.
docs/en/tor-doc-relay.wml   35) </p>

docs/en/tor-doc-server.wml  36) 

docs/en/tor-doc-relay.wml   37) <p>You can run a Tor relay on <a href="<wiki>/TorFAQ#WhydoesntmyWindowsorotherOSTorrelayrunwell">pretty

docs/en/tor-doc-relay.wml   38) much any</a> operating system. Tor relays work best on Linux, OS X Tiger
docs/en/tor-doc-relay.wml   39) or later, FreeBSD 5.x+, NetBSD 5.x+, and Windows Server 2003 or later.

docs/en/tor-doc-relay.wml   40) </p>

docs/en/tor-doc-server.wml  41) 
docs/en/tor-doc-server.wml  42) <hr />

docs/en/tor-doc-relay.wml   43) <a id="zero"></a>

docs/en/tor-doc-relay.wml   44) <a id="install"></a>
docs/en/tor-doc-relay.wml   45) <h2><a class="anchor" href="#install">Step One: Download and Install Tor</a></h2>

docs/en/tor-doc-server.wml  46) <br />
docs/en/tor-doc-server.wml  47) 
docs/en/tor-doc-server.wml  48) <p>Before you start, you need to make sure that Tor is up and running.
docs/en/tor-doc-server.wml  49) </p>
docs/en/tor-doc-server.wml  50) 

docs/en/tor-doc-relay.wml   51) <p>Visit our <a href="<page easy-download>">download page</a> and
docs/en/tor-doc-relay.wml   52) install the "Installation Bundle" for your OS.

docs/en/tor-doc-server.wml  53) </p>

docs/en/tor-doc-relay.wml   54) 

docs/en/tor-doc-server.wml  55) <p>If it's convenient, you might also want to use it as a client for a
docs/en/tor-doc-server.wml  56) while to make sure it's actually working.</p>
docs/en/tor-doc-server.wml  57) 
docs/en/tor-doc-server.wml  58) <hr />

docs/en/tor-doc-server.wml  59) <a id="setup"></a>

docs/en/tor-doc-relay.wml   60) <h2><a class="anchor" href="#setup">Step Two: Set it up as a relay</a></h2>

docs/en/tor-doc-server.wml  61) <br />

docs/en/tor-doc-relay.wml   62) <ol>

docs/en/tor-doc-relay.wml   63) <li>Verify that your clock and timezone are set
docs/en/tor-doc-relay.wml   64) correctly. If possible, synchronize your clock with public <a
docs/en/tor-doc-relay.wml   65) href="http://en.wikipedia.org/wiki/Network_Time_Protocol">time
docs/en/tor-doc-relay.wml   66) servers</a>.

docs/en/tor-doc-relay.wml   67) </li>

docs/en/tor-doc-server.wml  68) 

docs/en/tor-doc-relay.wml   69) <li><strong>Configuring Tor with the Vidalia Graphical Interface</strong>:

docs/en/tor-doc-relay.wml   70) <ol>

docs/en/tor-doc-relay.wml   71) 
docs/en/tor-doc-relay.wml   72) <li>
docs/en/tor-doc-relay.wml   73) 	<dt>Right click on the Vidalia icon in your task bar.  Choose <tt>Control Panel</tt>.</dt>

docs/en/tor-doc-relay.wml   74) 	<dd><img alt="vidalia right click menu" src="../img/screenshot-win32-vidalia.png"></dd>

docs/en/tor-doc-relay.wml   75) </li>
docs/en/tor-doc-relay.wml   76) 

docs/en/tor-doc-relay.wml   77) <li>Click <tt>Setup Relaying</tt>.</li>

docs/en/tor-doc-relay.wml   78) 
docs/en/tor-doc-relay.wml   79) <li>
docs/en/tor-doc-relay.wml   80) 	<dt>Choose <tt>Relay Traffic for the Tor network</tt> if you want to be a public relay (recommended), or choose 		<tt>Help censored users reach the Tor network</tt> if you want to be a <a href="<page faq>#RelayOrBridge">bridge</a> for users in countries that censor their Internet.</dt>

docs/en/tor-doc-relay.wml   81) <dd><img alt="vidalia basic settings" src="../img/screenshot-win32-configure-relay-1.png"></dd>

docs/en/tor-doc-relay.wml   82) </li>
docs/en/tor-doc-relay.wml   83) 

docs/en/tor-doc-relay.wml   84) <li>Enter a nickname for your relay, and enter contact information in
docs/en/tor-doc-relay.wml   85) case we need to contact you about problems.</li>

docs/en/tor-doc-relay.wml   86) 

docs/en/tor-doc-relay.wml   87) <li>Leave <tt>Attempt to automatically configure port forwarding</tt> clicked.

docs/en/tor-doc-relay.wml   88) Push the <tt>Test</tt> button to see if it works.  If it does work, great.

docs/en/tor-doc-relay.wml   89) If not, see number 3 below.</li>

docs/en/tor-doc-relay.wml   90) 
docs/en/tor-doc-relay.wml   91) <li><dt>Choose the <tt>Bandwidth Limits</tt> tab.  Select how much bandwidth you want to provide for Tor users like yourself.</dt>

docs/en/tor-doc-relay.wml   92) <dd><img alt="vidalia bandwidth limits" src="../img/screenshot-win32-configure-relay-2.png"></dd>

docs/en/tor-doc-relay.wml   93) </li> 
docs/en/tor-doc-relay.wml   94) 
docs/en/tor-doc-relay.wml   95) <li><dt>Choose the <tt>Exit Policies</tt> tab.  If you want to allow others

docs/en/tor-doc-relay.wml   96) to use your relay for these services, don't change anything.  Un-check

docs/en/tor-doc-relay.wml   97) the services you don't want to allow people to <a href="<page

docs/en/tor-doc-relay.wml   98) faq>#ExitPolicies">reach from your relay</a>.  If you want to be a non-exit relay, un-check all services.</dt>

docs/en/tor-doc-relay.wml   99) <dd><img alt="vidalia exit policies" src="../img/screenshot-win32-configure-relay-3.png"></dd>

docs/en/tor-doc-relay.wml  100) </li>
docs/en/tor-doc-relay.wml  101) 

docs/en/tor-doc-relay.wml  102) <li>Click the <tt>Ok</tt> button.  See Step Three below for confirmation

docs/en/tor-doc-relay.wml  103) that the relay is working correctly.</li>

docs/en/tor-doc-relay.wml  104) </ol>

docs/en/tor-doc-server.wml 105) 

docs/en/tor-doc-relay.wml  106) <br />

docs/en/tor-doc-relay.wml  107) <strong>Manual Configuration</strong>:

docs/en/tor-doc-relay.wml  108) <ul>

docs/en/tor-doc-relay.wml  109) <li>Edit the bottom part of <a

docs/en/tor-doc-relay.wml  110) href="<wiki>/TorFAQ#Imsupposedtoeditmytorrc.Whatdoesthatmean">your

docs/en/tor-doc-relay.wml  111) torrc file</a>. If you want to be a public relay (recommended),
docs/en/tor-doc-relay.wml  112) make sure to define ORPort and <a href="<page
docs/en/tor-doc-relay.wml  113) faq>#ExitPolicies">look at ExitPolicy</a>; otherwise
docs/en/tor-doc-relay.wml  114) if you want to be a <a href="<page faq>#RelayOrBridge">bridge</a>
docs/en/tor-doc-relay.wml  115) for users in countries that censor their Internet,
docs/en/tor-doc-relay.wml  116) just use <a href="<page bridges>#RunningABridge">these lines</a>.

docs/en/tor-doc-relay.wml  117) </li>

docs/en/tor-doc-server.wml 118) 

docs/en/tor-doc-relay.wml  119) </ul></li>

docs/en/tor-doc-relay.wml  120) 

docs/en/tor-doc-relay.wml  121) <li>If you are using a firewall, open a hole in your firewall
docs/en/tor-doc-relay.wml  122) so incoming connections can reach the ports you configured
docs/en/tor-doc-relay.wml  123) (ORPort, plus DirPort if you enabled it). If you have a
docs/en/tor-doc-relay.wml  124) hardware firewall (Linksys box, cablemodem, etc) you might like <a
docs/en/tor-doc-relay.wml  125) href="http://portforward.com/">portforward.com</a>. Also, make sure you

docs/en/tor-doc-relay.wml  126) allow all <em>outgoing</em> connections too, so your relay can reach the

docs/en/tor-doc-relay.wml  127) other Tor relays.

docs/en/tor-doc-relay.wml  128) </li>

docs/en/tor-doc-server.wml 129) 

docs/en/tor-doc-relay.wml  130) <li>Restart your relay. If it <a

docs/en/tor-doc-relay.wml  131) href="<wiki>/TorFAQ#WhatloglevelshouldIuse">logs

docs/en/tor-doc-server.wml 132) any warnings</a>, address them.

docs/en/tor-doc-relay.wml  133) </li>

docs/en/tor-doc-server.wml 134) 

docs/en/tor-doc-relay.wml  135) <li>Subscribe to the <a

docs/en/tor-doc-server.wml 136) href="http://archives.seul.org/or/announce/">or-announce</a>
docs/en/tor-doc-server.wml 137) mailing list. It is very low volume, and it will keep you informed
docs/en/tor-doc-server.wml 138) of new stable releases. You might also consider subscribing to <a

docs/en/tor-doc-relay.wml  139) href="<page documentation>#MailingLists">the higher-volume Tor lists</a>
docs/en/tor-doc-relay.wml  140) too.

docs/en/tor-doc-relay.wml  141) </li>

docs/en/tor-doc-server.wml 142) 

docs/en/tor-doc-relay.wml  143) </ol>

docs/en/tor-doc-server.wml 144) 
docs/en/tor-doc-server.wml 145) <hr />

docs/en/tor-doc-server.wml 146) <a id="check"></a>

docs/en/tor-doc-relay.wml  147) <h2><a class="anchor" href="#check">Step Three: Make sure it is working</a></h2>

docs/en/tor-doc-server.wml 148) <br />
docs/en/tor-doc-server.wml 149) 

docs/en/tor-doc-relay.wml  150) <p>As soon as your relay manages to connect to the network, it will

docs/en/tor-doc-server.wml 151) try to determine whether the ports you configured are reachable from

docs/en/tor-doc-relay.wml  152) the outside. This step is usually fast, but may take up to 20
docs/en/tor-doc-relay.wml  153) minutes. Look for a

docs/en/tor-doc-relay.wml  154) <a href="<wiki>/TorFAQ#WhatloglevelshouldIuse">log

docs/en/tor-doc-server.wml 155) entry</a> like

docs/en/tor-doc-server.wml 156) <tt>Self-testing indicates your ORPort is reachable from the outside. Excellent.</tt>

docs/en/tor-doc-relay.wml  157) If you don't see this message, it means that your relay is not reachable

docs/en/tor-doc-server.wml 158) from the outside — you should re-check your firewalls, check that it's
docs/en/tor-doc-server.wml 159) testing the IP and port you think it should be testing, etc.
docs/en/tor-doc-server.wml 160) </p>
docs/en/tor-doc-server.wml 161) 
docs/en/tor-doc-server.wml 162) <p>When it decides that it's reachable, it will upload a "server

docs/en/tor-doc-relay.wml  163) descriptor" to the directories, to let clients know

docs/en/tor-doc-relay.wml  164) what address, ports, keys, etc your relay is using.  You can look in
docs/en/tor-doc-relay.wml  165) your data directory for a cached-consensus file to see if your relay is
docs/en/tor-doc-relay.wml  166) online in the Tor Network.  You may need to wait up to one hour to give
docs/en/tor-doc-relay.wml  167) enough time for it to make a fresh directory.</p>

docs/en/tor-doc-server.wml 168) 
docs/en/tor-doc-server.wml 169) <hr />

docs/en/tor-doc-server.wml 170) <a id="after"></a>

docs/en/tor-doc-relay.wml  171) <h2><a class="anchor" href="#after">Step Four: Once it is working</a></h2>

docs/en/tor-doc-server.wml 172) <br />
docs/en/tor-doc-server.wml 173) 
docs/en/tor-doc-server.wml 174) <p>

docs/en/tor-doc-server.wml 175) We recommend the following steps as well:

docs/en/tor-doc-server.wml 176) </p>
docs/en/tor-doc-server.wml 177) 
docs/en/tor-doc-server.wml 178) <p>

docs/en/tor-doc-relay.wml  179) 6. Read

docs/en/tor-doc-relay.wml  180) <a href="<wiki>/OperationalSecurity">about operational security</a>

docs/en/tor-doc-relay.wml  181) to get ideas how you can increase the security of your relay.

docs/en/tor-doc-server.wml 182) </p>
docs/en/tor-doc-server.wml 183) 
docs/en/tor-doc-server.wml 184) <p>

docs/en/tor-doc-relay.wml  185) 7. If you want to run more than one relay that's great, but please set <a

docs/en/tor-doc-relay.wml  186) href="<wiki>/TorFAQ#MultipleRelays">the

docs/en/tor-doc-relay.wml  187) MyFamily option</a> in all your relays' configuration files.

docs/en/tor-doc-server.wml 188) </p>
docs/en/tor-doc-server.wml 189) 
docs/en/tor-doc-server.wml 190) <p>

docs/en/tor-doc-relay.wml  191) 8. Decide about rate limiting. Cable modem, DSL, and other users

docs/en/tor-doc-server.wml 192) who have asymmetric bandwidth (e.g. more down than up) should
docs/en/tor-doc-server.wml 193) rate limit to their slower bandwidth, to avoid congestion. See the <a

docs/en/tor-doc-relay.wml  194) href="<wiki>/TorFAQ#HowcanIlimitthetotalamountofbandwidthusedbymyTorrelay">rate

docs/en/tor-doc-server.wml 195) limiting FAQ entry</a> for details.
docs/en/tor-doc-server.wml 196) </p>
docs/en/tor-doc-server.wml 197) 
docs/en/tor-doc-server.wml 198) <p>

docs/en/tor-doc-relay.wml  199) 9. Back up your Tor relay's private key (stored in "keys/secret_id_key"

docs/en/tor-doc-relay.wml  200) in your DataDirectory). This is your relay's "identity," and

docs/en/tor-doc-server.wml 201) you need to keep it safe so nobody can read the traffic that goes

docs/en/tor-doc-relay.wml  202) through your relay. This is the critical file to keep if you need to <a

docs/en/tor-doc-relay.wml  203) href="<wiki>/TorFAQ#Iwanttoupgrademovemyrelay.HowdoIkeepthesamekey">move

docs/en/tor-doc-relay.wml  204) or restore your Tor relay</a> if something goes wrong.

docs/en/tor-doc-server.wml 205) </p>
docs/en/tor-doc-server.wml 206) 
docs/en/tor-doc-server.wml 207) <p>

docs/en/tor-doc-relay.wml  208) 

docs/en/tor-doc-relay.wml  209) 10. If you control the name servers for your domain, consider setting your

docs/en/tor-doc-relay.wml  210) reverse DNS hostname to 'anonymous-relay', 'proxy' or 'tor-proxy', so when
docs/en/tor-doc-relay.wml  211) other people see the address in their web logs, they will more quickly
docs/en/tor-doc-relay.wml  212) understand what's going on. Adding the <a

docs/en/tor-doc-relay.wml  213) href="<gitblob>contrib/tor-exit-notice.html">Tor

docs/en/tor-doc-relay.wml  214) exit notice</a> on a vhost for this name can go a long way to deterring abuse
docs/en/tor-doc-relay.wml  215) complaints to you and your ISP if you are running an exit node.
docs/en/tor-doc-relay.wml  216) 

docs/en/tor-doc-server.wml 217) </p>
docs/en/tor-doc-server.wml 218) 
docs/en/tor-doc-server.wml 219) <p>

docs/en/tor-doc-relay.wml  220) 11. If your computer isn't running a webserver, please consider

docs/en/tor-doc-server.wml 221) changing your ORPort to 443 and your DirPort to 80. Many Tor
docs/en/tor-doc-server.wml 222) users are stuck behind firewalls that only let them browse the

docs/en/tor-doc-relay.wml  223) web, and this change will let them reach your Tor relay. Win32
docs/en/tor-doc-relay.wml  224) relays can simply change their ORPort and DirPort directly
docs/en/tor-doc-relay.wml  225) in their torrc and restart Tor. OS X or Unix relays can't bind

docs/en/tor-doc-server.wml 226) directly to these ports (since they don't run as root), so they will
docs/en/tor-doc-server.wml 227) need to set up some sort of <a

docs/en/tor-doc-relay.wml  228) href="<wiki>/TorFAQ#HowcanImakemyrelayaccessibletopeoplestuckbehindrestrictivefirewalls">

docs/en/tor-doc-relay.wml  229) port forwarding</a> so connections can reach their Tor relay. If you are

docs/en/tor-doc-server.wml 230) using ports 80 and 443 already but still want to help out, other useful
docs/en/tor-doc-server.wml 231) ports are 22, 110, and 143.
docs/en/tor-doc-server.wml 232) </p>
docs/en/tor-doc-server.wml 233) 
docs/en/tor-doc-server.wml 234) <p>

docs/en/tor-doc-relay.wml  235) 12. If your Tor relay provides other services on the same IP address

docs/en/tor-doc-server.wml 236) — such as a public webserver — make sure that connections to the
docs/en/tor-doc-server.wml 237) webserver are allowed from the local host too. You need to allow these

docs/en/tor-doc-relay.wml  238) connections because Tor clients will detect that your Tor relay is the <a

docs/en/tor-doc-relay.wml  239) href="<wiki>/TorFAQ#WhatisExitEnclaving">safest way to reach that
docs/en/tor-doc-relay.wml  240) webserver</a>, and always build a circuit that ends at your relay. If
docs/en/tor-doc-relay.wml  241) you don't want to allow the connections, you must explicitly reject them
docs/en/tor-doc-relay.wml  242) in your exit policy.

docs/en/tor-doc-server.wml 243) </p>
docs/en/tor-doc-server.wml 244) 
docs/en/tor-doc-server.wml 245) <p>

docs/en/tor-doc-relay.wml  246) 13. (Unix only). Make a separate user to run the relay. If you

docs/en/tor-doc-server.wml 247) installed the OS X package or the deb or the rpm, this is already

docs/en/tor-doc-relay.wml  248) done. Otherwise, you can do it by hand. (The Tor relay doesn't need to

docs/en/tor-doc-server.wml 249) be run as root, so it's good practice to not run it as root. Running
docs/en/tor-doc-server.wml 250) as a 'tor' user avoids issues with identd and other services that
docs/en/tor-doc-server.wml 251) detect user name. If you're the paranoid sort, feel free to <a

docs/en/tor-doc-relay.wml  252) href="<wiki>/TorInChroot">put Tor

docs/en/tor-doc-server.wml 253) into a chroot jail</a>.)
docs/en/tor-doc-server.wml 254) </p>
docs/en/tor-doc-server.wml 255) 
docs/en/tor-doc-server.wml 256) <p>

docs/en/tor-doc-relay.wml  257) 14. (Unix only.) Your operating system probably limits the number

docs/en/tor-doc-server.wml 258) of open file descriptors per process to 1024 (or even less). If you
docs/en/tor-doc-server.wml 259) plan to be running a fast exit node, this is probably not enough. On
docs/en/tor-doc-server.wml 260) Linux, you should add a line like "toruser hard nofile 8192" to your
docs/en/tor-doc-server.wml 261) /etc/security/limits.conf file (where toruser is the user that runs the
docs/en/tor-doc-server.wml 262) Tor process), and then restart Tor if it's installed as a package (or log

docs/en/tor-doc-relay.wml  263) out and log back in if you run it yourself).

docs/en/tor-doc-server.wml 264) </p>
docs/en/tor-doc-server.wml 265) 
docs/en/tor-doc-server.wml 266) <p>

docs/en/tor-doc-relay.wml  267) 15. If you installed Tor via some package or installer, it probably starts

docs/en/tor-doc-server.wml 268) Tor for you automatically on boot. But if you installed from source,
docs/en/tor-doc-server.wml 269) you may find the initscripts in contrib/tor.sh or contrib/torctl useful.
docs/en/tor-doc-server.wml 270) </p>
docs/en/tor-doc-server.wml 271) 

docs/en/tor-doc-server.wml 272) <p>

docs/en/tor-doc-server.wml 273) When you change your Tor configuration, remember to verify that your

docs/en/tor-doc-relay.wml  274) relay still works correctly after the change. Be sure to set your

docs/en/tor-doc-server.wml 275) "ContactInfo" line in the torrc so we can contact you if you need to
docs/en/tor-doc-server.wml 276) upgrade or something goes wrong. If you have problems or questions, see
docs/en/tor-doc-server.wml 277) the <a href="<page documentation>#Support">Support</a> section or
docs/en/tor-doc-server.wml 278) <a href="<page contact>">contact us</a> on the tor-ops list. Thanks
docs/en/tor-doc-server.wml 279) for helping to make the Tor network grow!

docs/en/tor-doc-server.wml 280) </p>
docs/en/tor-doc-server.wml 281) 

docs/en/tor-doc-server.wml 282) <hr />
docs/en/tor-doc-server.wml 283) 

docs/en/tor-doc-server.wml 284) <p>If you have suggestions for improving this document, please <a
docs/en/tor-doc-server.wml 285) href="<page contact>">send them to us</a>. Thanks!</p>