update todo a bit
[tor.git] / doc / tor-doc-unix.html
blobadb6ead86c610008b77f6f3e0888d09a258f28ae
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5 <head>
6 <title>Tor Linux/BSD/Unix Install Instructions</title>
7 <meta name="Author" content="Roger Dingledine" />
8 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
9 <link rel="stylesheet" type="text/css" href="http://tor.eff.org/stylesheet.css" />
10 <link rel="shortcut icon" type="image/x-icon" href="/favicon.ico" />
11 </head>
13 <body>
15 <!-- TITLE BAR & NAVIGATION -->
17 <table class="banner" border="0" cellpadding="0" cellspacing="0">
18 <tr>
19 <td class="banner-left"></td>
20 <td class="banner-middle">
21 <a href="/index.html">Home</a>
22 | <a href="/howitworks.html">How It Works</a>
23 | <a href="/download.html">Download</a>
24 | <a href="/documentation.html">Docs</a>
25 | <a href="/users.html">Users</a>
26 | <a href="/faq.html">FAQs</a>
27 | <a href="/volunteer.html">Volunteer</a>
28 | <a href="/developers.html">Developers</a>
29 | <a href="/research.html">Research</a>
30 | <a href="/people.html">People</a>
31 </td>
32 <td class="banner-right"></td>
33 </tr>
34 </table>
36 <!-- END TITLE BAR & NAVIGATION -->
38 <div class="center">
40 <div class="main-column">
42 <h1>Running the <a href="http://tor.eff.org/">Tor</a> client on Linux/BSD/Unix</h1>
43 <br />
45 <p>
46 <b>Note that these are the installation instructions for running a Tor
47 client. If you want to configure it as a server (please do), read the <a
48 href="tor-doc-server.html">Configuring a server</a> guide.</b>
49 </p>
51 <hr />
52 <a id="installing"></a>
53 <h2><a class="anchor" href="#installing">Step One: Download and Install Tor</a></h2>
54 <br />
56 <p>
57 The latest release of Tor can be found on the <a
58 href="/download.html">download</a> page. We have packages for Debian,
59 Red Hat, Gentoo, *BSD, etc there too.
60 </p>
62 <p>If you're building from source, first install <a
63 href="http://www.monkey.org/~provos/libevent/">libevent</a>, and
64 make sure you have openssl and zlib (including the -devel packages if
65 applicable). Then Run <tt>tar xzf tor-0.1.0.14.tar.gz;
66 cd tor-0.1.0.14</tt>. Then <tt>./configure &amp;&amp; make</tt>. Now you
67 can run tor as <tt>src/or/tor</tt>, or you can run <tt>make install</tt>
68 (as root if necessary) to install it into /usr/local/, and then you can
69 start it just by running <tt>tor</tt>.
70 </p>
72 <p>Tor comes configured as a client by default. It uses a built-in
73 default configuration file, and most people won't need to change any of
74 the settings. Tor is now installed.
75 </p>
77 <hr />
78 <a id="privoxy"></a>
79 <h2><a class="anchor" href="#privoxy">Step Two: Install Privoxy for Web Browsing</a></h2>
80 <br />
82 <p>After installing Tor, you need to configure your applications to use it.
83 </p>
85 <p>
86 The first step is to set up web browsing. Start by installing <a
87 href="http://www.privoxy.org/">Privoxy</a>: click on 'recent releases'
88 and pick your favorite package or install from source. Privoxy is a
89 filtering web proxy that integrates well with Tor.
90 </p>
92 <p>You need to configure Privoxy to use Tor.
93 Open Privoxy's "config" file (look in /etc/privoxy/ or /usr/local/etc/)
94 and add the line <br>
95 <tt>forward-socks4a / localhost:9050 .</tt><br>
96 to the top of the config file. Don't forget to add the dot at the end.
97 </p>
99 <p>Privoxy keeps a log file of everything passed through it. In
100 order to stop this you will need to comment out two lines by inserting a
101 # before the line. The two lines are:<br>
102 <tt>logfile logfile</tt><br>
103 and the line <br>
104 <tt>jarfile jarfile</tt><br>
105 </p>
107 <p>You'll need to restart Privoxy for the changes to take effect.</p>
109 <hr />
110 <a id="using"></a>
111 <h2><a class="anchor" href="#using">Step Three: Configure your applications to use Tor</a></h2>
112 <br />
114 <p>After installing Tor and Privoxy, you need to configure your
115 applications to use them. The first step is to set up web browsing.</p>
117 <p>If you're using Firefox (we recommend it), check out our <a
118 href="tor-switchproxy.html">Tor SwitchProxy howto</a> to set up
119 a plugin that makes it easy to switch between using Tor and using a
120 direct connection.</p>
122 <p>Otherwise, you need to manually configure your browser to HTTP proxy
123 at localhost port 8118.
124 (That's where Privoxy listens.)
125 In Mozilla, this is in Edit|Preferences|Advanced|Proxies.
126 In Opera 7.5x it's Tools|Preferences|Network|Proxy servers.
127 You should click the "use the same proxy server for all protocols"
128 button; but see <a
129 href="http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#FtpProxy">this
130 note</a> about Tor and ftp proxies.
132 <p>Using privoxy is <strong>necessary</strong> because <a
133 href="http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#SOCKSAndDNS">browsers
134 leak your DNS requests when they use a SOCKS proxy directly</a>, which
135 is bad for your anonymity. Privoxy also removes certain dangerous
136 headers from your web requests, and blocks obnoxious ad sites like
137 Doubleclick.</p>
139 <p>To Torify other applications that support HTTP proxies, just
140 point them at Privoxy (that is, localhost port 8118). To use SOCKS
141 directly (for instant messaging, Jabber, IRC, etc), you can point
142 your application directly at Tor (localhost port 9050), but see <a
143 href="http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#SOCKSAndDNS">this
144 FAQ entry</a> for why this may be dangerous. For applications
145 that support neither SOCKS nor HTTP, take a look at <a
146 href="http://tsocks.sourceforge.net/">tsocks</a> or <a
147 href="http://wiki.noreply.org/noreply/TheOnionRouter/TorifyHOWTO#socat">socat</a>.
148 </p>
150 <p>For information on how to Torify other applications, check out the
151 <a href="http://wiki.noreply.org/wiki/TheOnionRouter/TorifyHOWTO">Torify
152 HOWTO</a>.
153 </p>
155 <hr />
156 <a id="verify"></a>
157 <h2><a class="anchor" href="#verify">Step Four: Make sure it's working</a></h2>
158 <br />
161 <a href="http://ipid.shat.net">ipid.shat.net</a> and
162 <a href="http://www.showmyip.com/">showmyip.com</a>
163 are sites that show what IP address and country you appear to be coming
164 from.
165 </p>
167 <p>If you don't know your current public IP address, this may not be a
168 very useful test. To learn your IP address, run "<tt>ifconfig</tt>".
169 If you are behind a NAT or firewall, though, you won't be able
170 to learn your public IP address. In this case, you should 1) configure
171 your browser to connect directly (that is, stop using Privoxy), 2) check
172 your IP address with one of the sites above, 3) point your browser back
173 to Privoxy, and 4) see whether your IP address has changed.
174 </p>
176 <p>If you have a personal firewall that limits your computer's
177 ability to connect to itself, be sure to allow connections from
178 your local applications to local port 8118 and port 9050. If
179 your firewall blocks outgoing connections, punch a hole so
180 it can connect to at least TCP ports 80 and 443, and then see <a
181 href="http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#FirewalledClient">this
182 FAQ entry</a>.
183 </p>
185 <p>If it's still not working, look at <a
186 href="http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#ItDoesntWork">this
187 FAQ entry</a> for hints.</p>
189 <hr />
190 <a id="server"></a>
191 <h2><a class="anchor" href="#server">Step Five: Configure it as a server</a></h2>
192 <br />
194 <p>The Tor network relies on volunteers to donate bandwidth. The more
195 people who run servers, the faster the Tor network will be. If you have
196 at least 20 kilobytes/s each way, please help out Tor by configuring your
197 Tor to be a server too. We have many features that make Tor servers easy
198 and convenient, including rate limiting for bandwidth, exit policies so
199 you can limit your exposure to abuse complaints, and support for dynamic
200 IP addresses.</p>
202 <p>Having servers in many different places on the Internet is what
203 makes Tor users secure. You may also get stronger anonymity yourself,
204 since remote sites can't know whether connections originated at your
205 computer or were relayed from others.</p>
207 <p>Read more at our <a href="tor-doc-server.html">Configuring a server</a>
208 guide.</p>
210 <hr />
212 <p>If you have suggestions for improving this document, please post
213 them on <a href="http://bugs.noreply.org/tor">our bugtracker</a> in the
214 website category. Thanks!</p>
216 </div><!-- #main -->
217 </div>
218 <div class="bottom" id="bottom">
219 <i><a href="mailto:tor-webmaster@freehaven.net"
220 class="smalllink">Webmaster</a></i> - $Id$
221 </div>
222 </body>
223 </html>