projects/en/obfsproxy-instructions.wml (1b2b60be4) - 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>
    <br>

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

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

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

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

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

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

<p>
    You will need Tor 0.2.3.11-alpha or later.
    </p>

<hr>

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

<p>
    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>:
    </p>

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

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

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

<hr>

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

<p>
    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>:
    </p>

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

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

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

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

<br>

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

#include <foot.wmi>

tor-webwml.git

point people at the 'running a tor bridge' section