Funny. I could have sworn that it compiled.
[tor.git] / doc / tor-doc-osx.html
blob5ae4d607748b4cebffe6506f5fa40e576604aeda
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 Mac OS X Install Instructions</title>
7 <meta name="Author" content="Roger Dingledine" />
8 <meta name="Author" content="Thomas Hardly" />
9 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
10 <link rel="stylesheet" type="text/css" href="stylesheet.css" />
11 <link rel="shortcut icon" type="image/x-icon" href="/favicon.ico" />
12 </head>
14 <body>
16 <!-- TITLE BAR & NAVIGATION -->
18 <table class="banner" border="0" cellpadding="0" cellspacing="0">
19 <tr>
20 <td class="banner-left"></td>
21 <td class="banner-middle">
22 <a href="/index.html">Home</a>
23 | <a href="/howitworks.html">How It Works</a>
24 | <a href="/download.html">Download</a>
25 | <a href="/documentation.html">Docs</a>
26 | <a href="/users.html">Users</a>
27 | <a href="/faq.html">FAQs</a>
28 | <a href="/volunteer.html">Volunteer</a>
29 | <a href="/developers.html">Developers</a>
30 | <a href="/research.html">Research</a>
31 | <a href="/people.html">People</a>
32 </td>
33 <td class="banner-right"></td>
34 </tr>
35 </table>
37 <!-- END TITLE BAR & NAVIGATION -->
39 <div class="center">
41 <div class="main-column">
43 <h1>Running the <a href="http://tor.eff.org/">Tor</a> client on Mac OS X</h1>
44 <br />
46 <p>
47 <b>Note that these are the installation instructions for running a Tor client on
48 Mac OS X. If you want to relay traffic for others to help the network
49 grow (please do), read the <a
50 href="tor-doc-server.html">Configuring a server</a> guide.</b>
51 </p>
53 <hr />
54 <a id="installing"></a>
55 <h2><a class="anchor" href="#installing">Step One: Download and Install Tor</a></h2>
56 <br />
58 <p>
59 The latest stable release of Tor for Macintosh OS X is <a
60 href="http://tor.eff.org/dist/osx/Tor 0.1.0.15 Bundle.dmg">0.1.0.15</a>.
61 Download it by clicking the link. You may be able to find experimental versions
62 <a href="http://tor.freehaven.net/dist/osx/">here</a>, if you're looking for
63 new features and new bugs.
64 </p>
66 <p>Our Tor installer should make everything pretty simple. Below is a
67 screenshot of the setup page:
68 </p>
70 <img alt="tor installer splash page"
71 src="http://tor.eff.org/img/screenshot-osx-installer-splash.png"
72 border="1">
74 <p>
75 By default, Tor is configured to run at startup. If you do not want Tor to
76 run on startup, you can disable this by selecting "Customize" in the
77 Installer, and then un-checking the "Tor Startup Script" box. Be sure to
78 leave the other boxes checked.
79 </p>
81 <p>Once the installer is finished and your computer restarts, Tor will
82 start automatically. Tor comes configured as a client by default. It
83 uses a built-in default configuration file in <tt>/Library/Tor/torrc</tt>,
84 but most people won't need to change any of the settings. Tor is now
85 installed.</p>
87 <p>Privoxy is installed as part of the Tor bundle package
88 installer. Privoxy is a filtering web proxy that integrates well with
89 Tor. Once it's installed, it will start automatically when your computer
90 is restarted.
91 </p>
93 <p>You do not need to configure Privoxy to use Tor. A custom Privoxy
94 configuration for Tor has been installed as part of the installer package.
95 </p>
97 <hr />
98 <a id="using"></a>
99 <h2><a class="anchor" href="#using">Step Two: Configure your applications to use Tor</a></h2>
100 <br />
102 <p>After installing Tor and Privoxy, you need to configure your
103 applications to use them. The first step is to set up web browsing.</p>
105 <p>If you're using Firefox (we recommend it), check out our <a
106 href="tor-switchproxy.html">Tor SwitchProxy howto</a> to set up
107 a plugin that makes it easy to switch between using Tor and using a
108 direct connection.</p>
110 <p>Otherwise, you need to manually configure your browser to HTTP proxy
111 at localhost port 8118.
112 (That's where Privoxy listens.)
113 In Mozilla, this is in Mozilla|Preferences|Advanced|Proxies.
114 You should set both your Web Proxy (HTTP) and your Secure Web Proxy
115 (HTTPS or SSL) to localhost port 8118, to hide your SSL traffic too.
116 You should consider configuring your "FTP Proxy" too; see <a
117 href="http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#FtpProxy">this
118 note</a> about Tor and ftp proxies.
119 </p>
121 <p>If you want to use Tor with Safari, you need to change your
122 Network Settings. Select your Network Preferences from the Apple |
123 Location menu:</p>
125 <img alt="Network settings"
126 src="http://tor.eff.org/img/screenshot-osx-choose-network.png"
127 border="1">
129 <p>Select the Network Interface on which you want to enable Tor. If you use
130 more than one Interface you must change the proxy settings for each
131 individually.</p>
133 <img alt="Network preferences"
134 src="http://tor.eff.org/img/screenshot-osx-choose-interface.png"
135 border="1">
138 <p>Select and enter 127.0.0.1 and port 8118 for both
139 Web Proxy (HTTP) and your Secure Web Proxy (HTTPS).
140 You should also do this for "FTP Proxy" and "Gopher Proxy"; see <a
141 href="http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#FtpProxy">this
142 note</a> about Tor and ftp proxies. Leave your Use Passive FTP Mode
143 (PASV) setting as is.</p>
145 <img alt="Proxy settings"
146 src="http://tor.eff.org/img/screenshot-osx-proxy-settings.png"
147 border="1">
149 <p>Using privoxy is <strong>necessary</strong> because <a
150 href="http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#SOCKSAndDNS">browsers
151 leak your
152 DNS requests when they use a SOCKS proxy directly</a>, which is bad for
153 your anonymity. Privoxy also removes certain dangerous headers from your
154 web requests, and blocks obnoxious ad sites like Doubleclick.</p>
156 <p>To Torify other applications that support HTTP proxies, just
157 point them at Privoxy (that is, localhost port 8118). To use SOCKS
158 directly (for instant messaging, Jabber, IRC, etc), you can point
159 your application directly at Tor (localhost port 9050), but see <a
160 href="http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#SOCKSAndDNS">this
161 FAQ entry</a> for why this may be dangerous. For applications
162 that support neither SOCKS nor HTTP, take a look at <a
163 href="http://www.taiyo.co.jp/~gotoh/ssh/connect.html">connect</a> or
164 <a href="http://www.dest-unreach.org/socat/">socat</a>.</p>
166 <p>For information on how to Torify other applications, check out the
167 <a href="http://wiki.noreply.org/wiki/TheOnionRouter/TorifyHOWTO">Torify
168 HOWTO</a>.
169 </p>
171 <hr />
172 <a id="verify"></a>
173 <h2><a class="anchor" href="#verify">Step Three: Make sure it's working</a></h2>
174 <br />
177 <a href="http://ipid.shat.net">ipid.shat.net</a> and
178 <a href="http://www.showmyip.com/">showmyip.com</a>
179 are sites that show what IP address and country you appear to be coming
180 from.
181 </p>
183 <p>If you don't know your current public IP address, this may not be a
184 very useful test. To learn your IP address, run "<tt>ifconfig</tt>".
185 If you are behind a NAT or firewall, though, you won't be able
186 to learn your public IP address. In this case, you should 1) configure
187 your browser to connect directly (that is, stop using Privoxy), 2) check
188 your IP address with one of the sites above, 3) point your browser back
189 to Privoxy, and 4) see whether your IP address has changed.
190 </p>
192 <p>If you have a personal firewall that limits your computer's
193 ability to connect to itself, be sure to allow connections from
194 your local applications to local port 8118 and port 9050. If
195 your firewall blocks outgoing connections, punch a hole so
196 it can connect to at least TCP ports 80 and 443, and then see <a
197 href="http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#FirewalledClient">this
198 FAQ entry</a>.
199 </p>
201 <p>If it's still not working, look at <a
202 href="http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#ItDoesntWork">this
203 FAQ entry</a> for hints.</p>
205 <hr />
206 <a id="server"></a>
207 <h2><a class="anchor" href="#server">Step Four: Configure it as a server</a></h2>
208 <br />
210 <p>The Tor network relies on volunteers to donate bandwidth. The more
211 people who run servers, the faster the Tor network will be. If you have
212 at least 20 kilobytes/s each way, please help out Tor by configuring your
213 Tor to be a server too. We have many features that make Tor servers easy
214 and convenient, including rate limiting for bandwidth, exit policies so
215 you can limit your exposure to abuse complaints, and support for dynamic
216 IP addresses.</p>
218 <p>Having servers in many different places on the Internet is what
219 makes Tor users secure. You may also get stronger anonymity yourself,
220 since remote sites can't know whether connections originated at your
221 computer or were relayed from others.</p>
223 <p>Read more at our <a href="tor-doc-server.html">Configuring a server</a>
224 guide.</p>
226 <hr />
227 <a id="uninstall"></a>
228 <h2><a class="anchor" href="#uninstall">How To Uninstall Tor and Privoxy</a></h2>
229 <br />
231 <p>The Tor 0.1.0.x series does not come with an uninstaller; this feature
232 will be added in the 0.1.1.x series. If you want to remove Tor on OSX,
233 here's how:</p>
235 <p>Change your application proxy settings back to their original values.
236 If you just want to stop using Tor, you can end at this point.</p>
238 <p>To stop Tor and Privoxy from running on startup</b>, remove the
239 /Library/StartupItems/Tor and /Library/StartupItems/Privoxy directories
240 respectively. If you just want to stop Tor from running, you can end at this
241 point.</p>
243 <p>To erase all remaining Tor and Privoxy files from your computer, delete
244 the following:
245 <ul>
246 <li>/Library/Tor</li>
247 <li>/Library/Privoxy</li>
248 <li>/usr/bin/tor</li>
249 <li>/usr/bin/tor_resolve</li>
250 <li>/var/log/tor</li>
251 <li>/usr/share/man/man1/tor.1</li>
252 <li>/usr/share/man/man1/tor-resolve.1</li>
253 <li>/usr/share/man/man1/torify.1</li>
254 <li>/Library/Receipts/Privoxy.pkg/</li>
255 <li>/Library/Receipts/privoxyconf.pkg/</li>
256 <li>/Library/Receipts/Tor.pkg/</li>
257 <li>/Library/Receipts/torstartup.pkg/</li>
258 </ul>
259 </p>
261 <hr />
263 <p>If you have suggestions for improving this document, please post
264 them on <a href="http://bugs.noreply.org/tor">our bugtracker</a> in the
265 website category. Thanks!</p>
267 </div><!-- #main -->
268 </div>
269 <div class="bottom" id="bottom">
270 <i><a href="mailto:tor-webmaster@freehaven.net"
271 class="smalllink">Webmaster</a></i> - $Id$
272 </div>
273 </body>
274 </html>