README

   1
   2 shim -- wedge this HTTP proxy between your browser and Tor
   3
   4 Dependencies
   5 -------------
   6
   7 You'll need Libevent 2 or greater!
   8
   9
  10 How to Build and Install
  11 -------------------------
  12
  13 1. Install Libevent 2 somewhere if it hasn't been already.
  14 2. ./configure
  15 3. make
  16 4. make install
  17
  18 Notes:
  19 * If you installed Libevent somewhere non-standard, you might need to export
  20 PKG_CONFIG_PATH or LIBEVENT_CFLAGS and LIBEVENT_LIBS environment variables, and
  21 then run ./configure again.
  22
  23 * If you're concerned about the proxy making direct connections (including
  24 connections to HTTP servers and DNS servers), you can add the
  25 --disable-direct-connections switch to configure. This will force you to
  26 run shim with a SOCKS 4a server, returning an error message if one isn't
  27 configured.
  28
  29 * If you're trying to debug a problem, and you're using GNU GCC, GDB etc,
  30 you can:
  31
  32         make clean
  33         make CFLAGS='-g -Wall'
  34
  35 ... to prevent optimization that might interfere with your GDB sessions.
  36
  37
  38 Command Line Arguments
  39 -----------------------
  40
  41 shim [-l host] [-p port] [-qVv] [socks proxy]
  42
  43 -l
  44         The address to listen on, or "any" to listen on all available
  45         interfaces. The default listen address is 127.0.0.1
  46
  47 -p
  48         The port to listen on. Default is 8123.
  49
  50 -q
  51         Decrease verbosity. You can specify this option more than once.
  52
  53 -v
  54         Increase verbosity. You can specify this option more than once.
  55
  56 -V
  57         Print the version and exit.
  58
  59 socks proxy
  60         This is an optional argument specifying the SOCKS server to make
  61         connections through. SOCKS proxies are specified like this:
  62
  63                 socks_version://address[:port]
  64
  65         Recognized SOCKS versions are socks4 and socks4a. With socks4, all
  66         host names are resolved through your name server, while with socks4a,
  67         host names are passed to your SOCKS server. The port is optional. By
  68         default it is set to 1080.
  69
  70         To use shim with a typically-configured Tor:
  71
  72                 socks4a://127.0.0.1:9050
  73
  74         If you built shim with --disable-direct-connections, you'll want
  75         socks4a!
  76
  77
  78 Where to Report Bugs
  79 -------------------
  80
  81 Christopher Davis <chrisd@torproject.org>