projects/en/obfsproxy-instructions.wml (6a9fb8215) - 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.

In a Linux system using the APT package manager you could do: 
 <tt># apt-get install autotools-dev gcc git libevent-2.0-5 libevent-openssl-2.0-5 libssl-dev</tt>

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>

And then as root install obfsproxy in your system: 
 <tt># make install</tt>

You will need Tor 0.2.3.11-alpha or later.

<hr>

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

Set up your Tor configuration file: 
 User tor 
 PIDFile /usr/local/var/run/tor/tor.pid 
 SocksPort 1999 # what port to open for local application connections 
 Log notice file /usr/local/var/log/tor/tor.log 
 DataDirectory /usr/local/var/lib/tor/data 
 UseBridges 1 
 Bridge obfs2 192.0.2.34:34545 
 ClientTransportPlugin obfs2 exec /usr/local/bin/obfsproxy --managed

Replace 192.0.2.34 with the bridge supporting obfsproxy you
 wish to use and 34545 with the port number the bridge uses.

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:

<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>

Set up your Tor configuration file: 
 User tor 
 PIDFile /usr/local/var/run/tor/tor.pid 
 ORPort 4367 
 Log notice file /usr/local/var/log/tor/tor.log 
 DataDirectory /usr/local/var/lib/tor/data 
 BridgeRelay 1 
 ServerTransportPlugin obfs2 exec /usr/local/bin/obfsproxy --managed

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

Update obfsproxy instructions per armadev and asn's comments