Browse code

Add instructions for setting up obfsbridges on Debianoids.

George Kadianakis authored on06/11/2012 23:39:22
Showing3 changed files
... ...
@@ -67,6 +67,7 @@ press/inthemedia.html.en
67 67
 press/press.html.en
68 68
 projects/arm.html.en
69 69
 projects/gettor.html.en
70
+projects/obfsproxy-debian-instructions.html.en
70 71
 projects/obfsproxy-instructions.html.en
71 72
 projects/obfsproxy.html.en
72 73
 projects/projects.html.en
73 74
new file mode 100644
... ...
@@ -0,0 +1,149 @@
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">Obfsproxy Bridge Instructions on Debian/Ubuntu</h1>
18
+
19
+    <img src="$(IMGROOT)/obfsproxy_diagram.png" alt="obfsproxy diagram"></a>
20
+
21
+    <p>
22
+    This guide will help you setup an obfuscated bridge on a Debian/Ubuntu system.
23
+    </p>
24
+
25
+    <h3>Step 0: Add Tor repositories to APT</h3>
26
+    <br>
27
+
28
+    <p>
29
+    You need
30
+    to <a href="https://www.torproject.org/docs/debian#development">install
31
+    the experimental official Tor Project APT repositories</a>,
32
+    because a fresh version of Tor (0.2.4.x) is required (Older
33
+    versions of Tor don't report their bridge addresses to BridgeDB).
34
+    </p>
35
+
36
+    <h3>Step 1: Install Tor and obfsproxy</h3>
37
+    <br>
38
+
39
+    <p>
40
+    Now install tor and obfsproxy:
41
+    </p>
42
+
43
+    <pre style="margin: 1.5em 0 1.5em 2em">
44
+\# apt-get update
45
+\# apt-get install obfsproxy tor
46
+    </pre>
47
+
48
+    <p>
49
+      Note that obfsproxy requires
50
+    libevent2 and your distribution (e.g. Debian stable) might not
51
+    have it in its repos.  You can
52
+    <a href="https://trac.torproject.org/projects/tor/ticket/5009#comment:9">try
53
+    our experimental backport libevent2 debs</a>,
54
+    or <a href="https://trac.torproject.org/projects/tor/ticket/5009#comment:17">build
55
+    libevent2 from source</a>.
56
+    </p>
57
+
58
+    <h3>Step 2: Set up Tor</h3>
59
+    <br>
60
+
61
+    <p>
62
+    You will need an appropriate
63
+    Tor <a href="<page docs/faq>#torrc">configuration file</a>
64
+    (usually at <i>/etc/tor/torrc</i>):
65
+    </p>
66
+
67
+    <pre style="margin: 1.5em 0 1.5em 2em">
68
+SocksPort 0
69
+ORPort auto
70
+BridgeRelay 1
71
+Exitpolicy reject *:*
72
+
73
+\## CHANGEME_1 -> provide a nickname for your bridge, can be anything you like.
74
+Nickname CHANGEME_1
75
+\## CHANGEME_2 -> If you want others to be able to contact you uncomment this line and put your GPG fingerprint for example.
76
+\#ContactInfo CHANGEME_2
77
+
78
+ServerTransportPlugin obfs2 exec /usr/bin/obfsproxy --managed
79
+    </pre>
80
+
81
+    <p>
82
+    Don't forget to edit the <i>CHANGEME</i> fields!
83
+    </p>
84
+
85
+    <h3>Step 3: Launch Tor and verify that it works</h3>
86
+    <br>
87
+
88
+    <p>
89
+    Restart Tor for the the new configuration file to be in effect:
90
+    </p>
91
+
92
+    <pre style="margin: 1.5em 0 1.5em 2em">
93
+service tor restart
94
+    </pre>
95
+
96
+    <p>
97
+    Now check <i>/var/log/tor/log</i> and you should see something
98
+    like this:
99
+    </p>
100
+
101
+    <pre style="margin: 1.5em 0 1.5em 2em">
102
+Nov 05 16:40:45.000 [notice] We now have enough directory information to build circuits.
103
+Nov 05 16:40:45.000 [notice] Bootstrapped 80%: Connecting to the Tor network.
104
+Nov 05 16:40:46.000 [notice] Bootstrapped 85%: Finishing handshake with first hop.
105
+Nov 05 16:40:46.000 [notice] Bootstrapped 90%: Establishing a Tor circuit.
106
+Nov 05 16:40:48.000 [notice] Tor has successfully opened a circuit. Looks like client functionality is working.
107
+Nov 05 16:40:48.000 [notice] Bootstrapped 100%: Done.
108
+    </pre>
109
+
110
+    <p>
111
+    If Tor is earlier in the bootstrapping phase, wait till it gets to
112
+    100%.
113
+    </p>
114
+
115
+    <p>
116
+    Now you need to find the address on which obfsproxy is
117
+    listening. To do this, check your Tor logs for a line similar to
118
+    this one:
119
+
120
+    <pre style="margin: 1.5em 0 1.5em 2em">
121
+Oct 05 20:00:41.000 [notice] Registered server transport 'obfs2' at '0.0.0.0:26821
122
+    </pre>
123
+
124
+    <p>
125
+    The last number, in this case <i>26821</i>, is the TCP port number
126
+    that your clients should point their obfsproxy to. So for example,
127
+    if your public IP is 1.2.3.4, your clients should put <i>Bridge
128
+    obfs2 1.2.3.4:26821</i> in their configuration file.
129
+    </pre>
130
+    </p>
131
+
132
+    <p>
133
+    <img width="7%" height="7%" style="float: left;" src="$(IMGROOT)/icon-Obfsproxy.jpg">
134
+    <b>Don't forget!</b> If you are behind a NAT, you should <b>port
135
+    forward</b> the port that obfsproxy is listening on. In the
136
+    example above you would have to forward port <i>26821</i>.
137
+    </p>
138
+
139
+  </div>
140
+  <!-- END MAINCOL -->
141
+  <div id = "sidecol">
142
+#include "side.wmi"
143
+#include "info.wmi"
144
+  </div>
145
+  <!-- END SIDECOL -->
146
+</div>
147
+<!-- END CONTENT -->
148
+#include <foot.wmi>
149
+
... ...
@@ -18,6 +18,16 @@
18 18
 
19 19
     <img src="$(IMGROOT)/obfsproxy_diagram.png" alt="client torrc"></a>
20 20
 
21
+    <p>
22
+    <img width="7%" height="7%" style="float: left;" src="$(IMGROOT)/icon-Obfsproxy.jpg">
23
+    <b> Hey! </b>
24
+    Are you looking for the guide on how to set up an obfuscated
25
+    bridge on a Debian system?
26
+    <a href="../projects/obfsproxy-debian-instructions.html.en">Check
27
+    this out</a>.
28
+    </p>
29
+    <br><br>
30
+
21 31
     <h3>Step 1: Install dependencies, obfsproxy, and Tor</h3>
22 32
     <br>
23 33