projects/en/obfsproxy-instructions.wml (532aa57b8) - tor-webwml.git

obfsproxy-instructions.wml

## translation metadata
# Revision: $Revision$
# Translation-Priority: 4-optional

#include "head.wmi" TITLE="obfsproxy: Installation instructions" CHARSET="UTF-8"

<div id="content" class="clearfix">
 <div id="breadcrumbs">
 <a href="<page index>">Home &raquo; </a>
 <a href="<page projects/projects>">Projects &raquo; </a>
 <a href="<page projects/obfsproxy>">obfsproxy</a>
 </div>
 <div id="maincol">

<h1 id="instructions">Obfsproxy Instructions</h1>

<h3>Step 1: Install dependencies, obfsproxy, and Tor</h3>

You will need a C compiler (gcc), the Autotools
 build system, the git revision control system,
 libevent-2 and the development headers of
 OpenSSL.

On Debian testing or Ubuntu oneiric, you could do: 
 <tt># apt-get install autoconf autotools-dev gcc git pkg-config libtool libevent-2.0-5 libevent-dev libevent-openssl-2.0-5 libssl-dev</tt>

If you're on a more stable Linux, you can either <a
 href="https://trac.torproject.org/projects/tor/ticket/5009#comment:9">try
 our experimental backport debs</a> or <a href="">build libevent2 from
 source</a>.

Clone obfsproxy from its git repository: 
 <tt>$ git clone https://git.torproject.org/obfsproxy.git</tt>

The above command should create and populate a directory named
 'obfsproxy' in your current directory.

Compile obfsproxy: 
 <tt>$ cd obfsproxy</tt> 
 <tt>$ ./autogen.sh && ./configure && make</tt>

Optionally, as root install obfsproxy in your
 system: 
 <tt># make install</tt>

If you prefer not to install obfsproxy as root, you can instead
 just modify the Transport lines in your torrc file (explained below)
 to point to your obfsproxy binary.

You will need Tor 0.2.3.11-alpha or later.

<hr>

<h3 id="client_instructions">Step 2a: If you're the client...</h3>

First, you need to learn the address of a bridge that supports
 obfsproxy. If you don't know any, try asking a friend to set one
 up for you. Then the appropriate lines to your <a href="<page
 docs/faq>#torrc">tor configuration file</a>:

<tt> UseBridges 1 </tt> 
 <tt> Bridge obfs2 128.31.0.34:1051 </tt> 
 <tt> ClientTransportPlugin obfs2 exec /usr/local/bin/obfsproxy --managed </tt>

Don't forget to replace 128.31.0.34:1051 with the IP address
 and port that the bridge's obfsproxy is listening on.

<img src="$(IMGROOT)/sidenav-arrow.png">
 Congratulations! Your traffic should now be
 obfuscated by obfsproxy. You are done! You can now start using Tor.

<hr>

<h3 id="bridge_instructions">Step 2b: If you're the bridge...</h3>

Configure your Tor to <a href="<page docs/bridges>#RunningABridge">be
 a bridge</a> (e.g. by setting "ORPort 9001" and "BridgeRelay 1"). Then
 add this new line to your <a href="<page docs/faq>#torrc">tor
 configuration file</a>:

<tt> ServerTransportPlugin obfs2 exec /usr/local/bin/obfsproxy --managed </tt>

Launch Tor using this configuration file. You can do this by using
 your favorite init script, or by pointing the Tor binary to the
 torrc file:

Next, find the TCP port opened by obfsproxy. Look in your log file
 for a line similar to this one: 
 <img src="$(IMGROOT)/obfs-log_checking.png" alt="bridge torrc" width="437" height="14"></a>
 
 The last number, in this case 34545, is the TCP port
 number that your clients should point their obfsproxy to.

<img src="$(IMGROOT)/sidenav-arrow.png">
 Congratulations! Tell your clients to point their
 obfsproxy to your IP address and to port 34545.

</div>
 
 <div id = "sidecol">
#include "side.wmi"
#include "info.wmi"
 </div>
 
</div>

#include <foot.wmi>

tor-webwml.git

explain further dependencies