README

   1
   2 'tor' is an implementation of The Onion Routing system, as
   3 described in a bit more detail at http://www.onion-router.net/. You
   4 can read list archives, and subscribe to the mailing list, at
   5 http://archives.seul.org/or/dev/.
   6
   7 Is your question in the FAQ? Should it be?
   8
   9 **************************************************************************
  10 See the INSTALL file for a quickstart. That is all you will probably need.
  11 **************************************************************************
  12
  13 **************************************************************************
  14 You only need to look beyond this point if the quickstart in the INSTALL
  15 doesn't work for you.
  16 **************************************************************************
  17
  18 Do you want to run a tor server?
  19
  20   We're looking for people with reasonably reliable Internet connections,
  21   that have at least 1Mbit each way. Currently we don't use all of that,
  22   but we want it available for burst traffic.
  23
  24   (The Tor server doesn't need to be run as root, and doesn't need any
  25   special system permissions or kernel mods. You should probably run it
  26   as its own user though, especially if you run an identd service too.)
  27
  28   First, copy torrc.sample to torrc (by default it's in
  29   /usr/local/etc/tor/), and edit the middle part. Create the
  30   DataDirectory, and make sure it's owned by the uid/gid that will be
  31   running tor. Fix your system clock so it's not too far off. Make sure
  32   name resolution works.
  33
  34   Then run tor to generate keys. One of the files generated
  35   in your DataDirectory is your 'fingerprint' file. Mail it to
  36   tor-ops@freehaven.net.
  37
  38   Please also tell us in that mail who you are, so we know whom to contact
  39   if there's any problem.  Also describe what kind of connectivity the new
  40   server will have.  If possible PGP sign your mail.
  41
  42   You may find the initscript in contrib/tor.sh useful if you
  43   want to set up Tor to start at boot.
  44
  45 Do you want to run a hidden service?
  46
  47   Copy torrc.sample to torrc (by default it's in /usr/local/etc/tor/), and
  48   edit the bottom part. Then run Tor. It will create each HiddenServiceDir
  49   you have configured, and it will create a 'hostname' file which
  50   specifies the url (xyz.onion) for that service. You can tell people
  51   the url, and they can connect to it via their Tor client.
  52
  53 Configuring tsocks:
  54
  55   If you want to use Tor for protocols that can't use Privoxy, or
  56   with applications that are not socksified, then download tsocks
  57   (tsocks.sourceforge.net) and configure it to talk to localhost:9050
  58   as a socks4 server. My /etc/tsocks.conf simply has:
  59     server_port = 9050
  60     server = 127.0.0.1
  61   (I had to "cd /usr/lib; ln -s /lib/libtsocks.so" to get the tsocks
  62    library working after install, since my libpath didn't include /lib.)
  63   Then you can do "tsocks ssh arma@moria.mit.edu". But note that if
  64   ssh is suid root, you either need to do this as root, or cp a local
  65   version of ssh that isn't suid.
  66
  67   (On Windows, you may want to look at the Hummingbird SOCKS client,
  68   or at SocksCap, instead.)