move some items from the tor-ctl TODO into the main TODO; mark some controller items...
[tor.git] / INSTALL
blob95a11a96c76f9ab49049d0f9369e30d40a77f09a
1 Quickstart version for users:
3 -1) If you don't have libevent, install it.  Source is at
4     http://www.monkey.org/~provos/libevent/ .
5 0) Download the absolute newest version. No, really.
6   http://tor.eff.org/dist/
7 1) tar xvf it, and then cd into the directory.
8 2) ./configure
9 3) make
10 4) make install (as root if necessary)
11 5) tor (if it doesn't work, give it the whole path or fix your path)
12   You don't need to run this as root, and you probably shouldn't.
13   (If you're having problems, try running it with "-l info" to get
14    more details.)
15 6) point your browser to socks4 or socks5 proxy at localhost port
16   9050. In mozilla, this is in edit|preferences|advanced|proxies. This
17   allows you to test to make sure tor is installed correctly.
18   (If you have a personal firewall, be sure to allow local connections
19    to port 9050.)
20   (If your firewall blocks outgoing connections, punch a hole so it
21    can connect to TCP *:9001-9004 and *:9031-9033)
22   (If you're using Safari as your browser, keep in mind that OS X before
23    10.3 claims to support socks but does not. You must do step 8.)
24 7) make sure you've set it up correctly: go to
25   http://www.junkbusters.com/cgi-bin/privacy and see what IP it says
26   you're coming from. If it works, you should probably go on to step 8,
27   to get better privacy.
29 8) Optionally, install privoxy (www.privoxy.org), and add the line
30   "forward-socks4a / localhost:9050 ." (without the quotes -- don't forget
31   the dot) to its config file. Then change your mozilla to http proxy
32   at localhost port 8118 (and no socks proxy). You should also set your
33   SSL proxy to the same thing, to hide your https traffic. Using privoxy
34   will give you good html scrubbing as well.
35   (See doc/CLIENTS for why direct socks gives you less anonymity.)
37 *****If this works for you, you can stop reading here******
39 If you got the source from cvs:
41   Run "./autogen.sh", which will run the various auto* programs and then
42   run ./configure for you. From there, start at step 3 in the quickstart
43   list above.
45 If the quickstart doesn't work for you:
47   Starting with Tor 0.1.0.0, Tor uses libevent for its asynchronous
48   networking core.  If you don't have libevent, you'll need to install it.
49   You can get it at http://www.monkey.org/~provos/libevent/.
51   If you have problems finding libraries, try
52     CPPFLAGS="-I/usr/local/include" LDFLAGS="-L/usr/local/lib" \
53     ./configure
54   rather than simply ./configure.
56   If you have mysterious autoconf failures while linking openssl,
57   consider setting your LD_LIBRARY_PATH to the openssl lib directory.
58   For example, "setenv LD_LIBRARY_PATH /usr/athena/lib".
60   Check out the list archives at http://archives.seul.org/or/dev/ and see
61   if somebody else has reported your problem. If not, please subscribe
62   and let us know what you did to fix it, or give us the details and
63   we'll see what we can do.