Browse code

Edit the obfsproxy instructions to use pip.

George Kadianakis authored on15/04/2013 19:50:34
Showing1 changed files
... ...
@@ -24,18 +24,20 @@
24 24
         Python version!
25 25
       </p>
26 26
 
27
-    <h3>Step 0: Install dependencies</h3>
27
+    <h3>Step 0: Install Python</h3>
28 28
     <br>
29 29
 
30 30
     <p>
31
-      To setup obfsproxy you will need <code>git</code>, <code>Python</code>
32
-      (>= 2.7), <code>Twisted</code> and some common Python modules
33
-      (<code>setuptools</code>, <code>argparse</code> and <code>PyCrypto</code>)
34
-      . If you use Debian testing (or unstable), or a version of
35
-      Ubuntu newer than Oneiric, this is easy:
31
+      To setup obfsproxy you will need <code>Python</code> (>= 2.7),
32
+      and <code>pip</code>. If you use Debian testing (or unstable),
33
+      or a version of Ubuntu newer than Oneiric, this is easy:
36 34
     <p>
37 35
 
38
-    <tt># apt-get install git python2.7 python-setuptools python-crypto python-twisted python-argparse</tt>
36
+    <tt># apt-get install python2.7 python-pip</tt>
37
+
38
+
39
+    <h3>Step 1: Install Tor</h3>
40
+    <br>
39 41
 
40 42
     <p>
41 43
       You will also need a recent version of Tor (>= 0.2.4.1). We recommend you use
... ...
@@ -44,53 +46,32 @@
44 46
       <a href="https://gitweb.torproject.org/tor.git">install Tor from git</a>.
45 47
     </p>
46 48
 
47
-    <h3>Step 1: Install pyptlib</h3>
48
-    <br>
49
-
50
-    <p>
51
-      You will also need pyptlib, a small library developed by the Tor
52
-      Project for writing pluggable transports.
53
-    </p>
54
-
55
-    <tt>$ git clone https://git.torproject.org/pluggable-transports/pyptlib.git</tt><br>
56
-    <tt>$ cd pyptlib && python setup.py install</tt><br><br>
57
-
58 49
     <p>
59
-      You might need to run the <em>python setup.py install</em>
60
-      command as root. If you don't want to run it as root, you can
61
-      use <em>python setup.py install --user</em> which will install pyptlib
62
-      just for the current user.
50
+    You need Tor 0.2.4.x because it knows how to automatically report
51
+    your obfsproxy address to BridgeDB.
63 52
     </p>
64 53
 
65
-    <h3>Step 2: Install and test obfsproxy</h3>
54
+    <h3>Step 2: Install obfsproxy</h3>
66 55
     <br>
67 56
 
68 57
     <p>
69
-      Now it's time to fetch obfsproxy and test that it works:
58
+      If you have <code>pip</code>, installing <code>obfsproxy</code>
59
+      and its dependencies should be a matter of a single command:
70 60
     </p>
71 61
 
72
-    <tt>$ git clone https://git.torproject.org/pluggable-transports/obfsproxy.git</tt><br>
73
-    <tt>$ cd obfsproxy</tt><br>
74
-    <tt>$ python obfsproxy/test/tester.py</tt><br><br>
62
+    <tt># pip install obfsproxy</tt><br><br>
75 63
 
76 64
     <p>
77
-      If you got a message reporting that all tests finished successfully,
78
-      then obfsproxy works for you. Time to run the setup.py script so that
79
-      obfsproxy gets installed in your system:
80
-    </p>
81
-
82
-    <tt># python setup.py install</tt><br><br>
83
-
84
-    <p>
85
-    You will probably want to run the setup.py script as root so that obfsproxy gets installed in /usr/local/bin.
65
+    You will probably want to run the <em>pip install</em> command as
66
+    root so that obfsproxy gets installed to /usr/local/bin.
86 67
     </p>
87 68
 
88 69
     <h3>Step 3: Setup tor</h3>
89 70
     <br>
90 71
 
91
-      <p>
92
-        Edit your /etc/tor/torrc to add:
93
-      </p>
72
+    <p>
73
+      Now setup Tor.  Edit your /etc/tor/torrc to add:
74
+    </p>
94 75
 
95 76
       <p>
96 77
         <tt>SocksPort 0</tt><br>