Ticket #4905: patch

File patch, 8.4 KB (added by asn, 5 years ago)

minor improvements over the original patch

  • new file projects/en/obfsproxy-instructions.wml

    diff --git a/projects/en/obfsproxy-instructions.wml b/projects/en/obfsproxy-instructions.wml
    new file mode 100644
    index 0000000..ec14e2d
    - +  
     1## translation metadata
     2# Revision: $Revision$
     3# Translation-Priority: 4-optional
     4
     5#include "head.wmi" TITLE="obfsproxy: Installation instructions" CHARSET="UTF-8"
     6
     7<div id="content" class="clearfix">
     8        <div id="breadcrumbs">
     9    <a href="<page index>">Home &raquo; </a>
     10    <a href="<page projects/projects>">Projects &raquo; </a>
     11    <a href="<page projects/obfsproxy>">obfsproxy</a>
     12  </div>
     13        <div id="maincol">
     14
     15    <!-- PUT CONTENT AFTER THIS TAG -->
     16
     17    <h1 id="instructions">Instructions</h1>
     18
     19    <h3>Step One: Install necessary dependencies</h3>
     20    <br>
     21
     22    <p>
     23    You will need a C compiler (<em>gcc</em>), the <em>Autotools</em>
     24    build system, the <em>git</em> revision control system,
     25    <em>libevent-2</em> and the development headers of
     26    <em>OpenSSL</em>.
     27     </p>
     28
     29    <p>
     30    In an Linux system using the APT package manager you could do: <br>
     31    <tt># apt-get install autotools gcc git libevent-2.0-5 libevent-openssl-2.0-5 libssl-dev</tt>
     32    </p>
     33
     34    <h3>Step Two: Install obfsproxy</h3>
     35    <br>
     36
     37    <p>
     38    Clone obfsproxy from its git repository:<br>
     39    <tt>$ git clone git://git.torproject.org/obfsproxy.git</tt> <br>
     40
     41    The above command should create and populate a directory named
     42    'obfsproxy' in your current directory.  </p>
     43
     44    <p>
     45    Compile obfsproxy: <br>
     46    <tt>$ cd obfsproxy</tt> <br>
     47    <tt>$ ./autogen.sh && ./configure && make</tt> <br>
     48    </p>
     49
     50    <p>
     51    And then <strong>as root</strong> install obfsproxy in your system: <br>
     52    <tt># make install</tt>
     53    </p>
     54
     55    <h3>Step Three: Install tor</h3>
     56    <br>
     57
     58    <p>
     59    To follow this guide, you will need the current git master.
     60
     61    </p>
     62
     63    <p>
     64    <img align="left"
     65    style="margin-top:5px;margin-left:-10px;margin-right:5px"
     66    src="$(IMGROOT)/warning.png"> <strong>If you want to set up a Tor
     67    bridge with obfsproxy, click <a class="anchor"
     68    href="#bridge_instructions">here</a> for bridge instructions,
     69    otherwise continue to <a class="anchor"
     70    href="#client_instructions">step four.</a></strong>
     71    </p>
     72
     73    <h3 id="client_instructions">Step Four (client): Configure tor</h3>
     74    <br>
     75
     76    <p>
     77    Set up your tor configuration file:<br><br>
     78    <img src="$(IMGROOT)/torrc_client.png" alt="An example of a client's torrc"></a>
     79    </p>
     80
     81    <h3>Step Five (client): Launch tor</h3>
     82    <br>
     83
     84    <p>
     85    Launch tor using the configuration file you made in the previous
     86    step. You can do this by using your favorite init script, or by
     87    pointing the tor binary to the torrc:
     88    </p>
     89
     90    <img src="$(IMGROOT)/spawn_tor_client.png" alt="Screenshot of tor client launch" height="101" width="882">
     91
     92    <p> <br>
     93    <img src="$(IMGROOT)/sidenav-arrow.png">
     94    <strong>Congratulations!</strong> Your traffic should now be
     95    obfuscated by obfsproxy. You are done! You can now start using Tor.
     96    </p>
     97
     98    <br> <br> <br> <br>
     99
     100    <hr>
     101
     102    <br> <br> <br> <br>
     103
     104    <h3 id="bridge_instructions">Step Four (bridge): Configure tor</h3>
     105    <br>
     106
     107    <p>
     108    Set up your tor configuration file:<br><br>
     109    <img src="$(IMGROOT)/torrc_server.png" alt="An example of a bridge's torrc"></a>
     110    </p>
     111
     112    <h3>Step Five (bridge): Launch tor</h3>
     113    <br>
     114
     115    <p>
     116    Launch tor using the configuration file you made in the previous
     117    step. You can do this by using your favorite init script, or by
     118    pointing the tor binary to the torrc:
     119    <p>
     120
     121    <p>
     122    <img src="$(IMGROOT)/spawn_tor_server.png" alt="Screenshot of tor bridge launch" height="101" width="882"></a>
     123    </p>
     124
     125    <h3>Step Six (bridge): Find the TCP ports opened by obfsproxy</h3>
     126    <br>
     127
     128    <p>
     129    Look in your log file, for a line similar to this one: <br>
     130    <img src="$(IMGROOT)/log_checking.png" alt="obfsproxy TCP port in the logs" width="437" height="14"></a>
     131    <br>
     132    The last number, in this case <em>34545</em>, is the TCP port
     133    number that your clients should point their obfsproxy to.
     134    </p>
     135
     136    <p>
     137    <img src="$(IMGROOT)/sidenav-arrow.png">
     138    <strong>Congratulations!</strong> Tell your clients to point their
     139    obfsproxy to your IP and to port <em>34545</em>.
     140    </p>
     141
     142    <br>
     143
     144  </div>
     145  <!-- END MAINCOL -->
     146  <div id = "sidecol">
     147#include "side.wmi"
     148#include "info.wmi"
     149  </div>
     150  <!-- END SIDECOL -->
     151</div>
     152<!-- END CONTENT -->
     153#include <foot.wmi>
     154
  • new file projects/en/obfsproxy.wml

    diff --git a/projects/en/obfsproxy.wml b/projects/en/obfsproxy.wml
    new file mode 100644
    index 0000000..1666dab
    - +  
     1## translation metadata
     2# Revision: $Revision$
     3# Translation-Priority: 4-optional
     4
     5#include "head.wmi" TITLE="Tor Project: obfsproxy" CHARSET="UTF-8" ANNOUNCE_RSS="yes"
     6<div id="content" class="clearfix">
     7        <div id="breadcrumbs">
     8    <a href="<page index>">Home &raquo; </a>
     9    <a href="<page projects/projects>">Projects &raquo; </a>
     10    <a href="<page projects/obfsproxy>">obfsproxy &raquo; </a>
     11  </div>
     12        <div id="maincol">
     13    <!-- PUT CONTENT AFTER THIS TAG -->
     14
     15    <h2>obfsproxy (<a href="https://gitweb.torproject.org/obfsproxy.git/">Project Page</a>)</h2>
     16    <div class="underline"></div>
     17
     18    <!-- BEGIN SIDEBAR -->
     19    <div class="sidebar-left">
     20    </div>
     21    <!-- END SIDEBAR -->
     22
     23    <p>
     24
     25    obfsproxy is a tool that attempts to circumvent censorship, by
     26    transforming the Tor traffic between the client and the
     27    bridge. This way, censors, who usually monitor traffic between the
     28    client and the bridge, will see innocent-looking transformed
     29    traffic instead of the actual Tor traffic.
     30
     31    <img src="$(IMGROOT)/obfsproxy_diagram.png" alt="Diagram showing obfsproxy on a network"></a>
     32
     33    </p>
     34
     35    <p>
     36
     37    obfsproxy supports multiple protocols, called pluggable
     38    transports, which specify how the traffic is transformed. For
     39    example, there might be a HTTP transport which transforms Tor
     40    traffic to look like regular HTTP traffic.
     41
     42    </p>
     43
     44    <p>
     45
     46    Even though obfsproxy is a separate application, completely
     47    independent from tor, it speaks to tor using an <a
     48    href="https://gitweb.torproject.org/torspec.git/blob/HEAD:/proposals/180-pluggable-transport.txt">internal
     49    protocol</a> in an attempt minimize necessary end-user
     50    configuration.
     51
     52    </p>
     53
     54    <h2><a class="anchor" href="<page projects/obfsproxy-instructions>#instructions">Installation Instructions</a></h2>
     55
     56    <h2><a href="https://gitweb.torproject.org/obfsproxy.git">Download</a></h2>
     57
     58    <p>
     59    Please open a <a
     60    href="https://trac.torproject.org/projects/tor/query?status=accepted&status=assigned&status=needs_information&status=needs_review&status=needs_revision&status=new&status=reopened&component=Pluggable+transport&order=priority&col=id&col=summary&col=status&col=type&col=priority&col=milestone&col=component">ticket</a>
     61    on our bug tracker for any bugs you find or features you would
     62    like to see added in future releases.
     63    </p>
     64
     65  </div>
     66  <!-- END MAINCOL -->
     67  <div id = "sidecol">
     68#include "side.wmi"
     69#include "info.wmi"
     70  </div>
     71  <!-- END SIDECOL -->
     72</div>
     73<!-- END CONTENT -->
     74#include <foot.wmi>
  • projects/en/projects.wml

    diff --git a/projects/en/projects.wml b/projects/en/projects.wml
    index 3130147..c366121 100644
    a b cloud. By setting up a bridge, you donate bandwidth to the Tor network and 
    8181help improve the safety and speed at which users can access the Internet.
    8282Get started with <a href="https://cloud.torproject.org">Tor Cloud</a>.</p>
    8383</td>
     84<td>
     85<div class="name"><a href="<page projects/obfsproxy>">obfsproxy</a></div>
     86<p>obfsproxy is a pluggable transports proxy written in C; it
     87shapes Tor traffic, making it harder for censors to detect and block
     88the Tor protocol.</p>
     89</td>
    8490</tr>
    8591
    8692#<td class="beige">
  • projects/en/sidenav.wmi

    diff --git a/projects/en/sidenav.wmi b/projects/en/sidenav.wmi
    index 8fb289d..2e78a9e 100644
    a b  
    3838          {'url'  => 'projects/arm',
    3939           'txt'  => 'Arm',
    4040          },
     41          {'url'  => 'projects/obfsproxy',
     42           'txt'  => 'obfsproxy',
     43          },
    4144          {'url'  => 'https://guardianproject.info/apps/orbot/',
    4245           'txt'  => 'Orbot',
    4346          },