tor-webwml.git

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 Instructions</h1>

18) 

19)     <h3>Step 1: Install dependencies, obfsproxy, and Tor</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 a Linux system using the APT package manager you could do: <br>

31)     <tt># apt-get install autotools-dev gcc git libevent-2.0-5 libevent-openssl-2.0-5 libssl-dev</tt>

32)     </p>
33) 
34)     <p>
35)     Clone obfsproxy from its git repository:<br>

36)     <tt>$ git clone https://git.torproject.org/obfsproxy.git</tt> <br>

37) 
38)     The above command should create and populate a directory named
39)     'obfsproxy' in your current directory.  </p>
40) 
41)     <p>
42)     Compile obfsproxy: <br>
43)     <tt>$ cd obfsproxy</tt> <br>
44)     <tt>$ ./autogen.sh && ./configure && make</tt> <br>
45)     </p>
46) 
47)     <p>
48)     And then <strong>as root</strong> install obfsproxy in your system: <br>
49)     <tt># make install</tt>
50)     </p>
51) 
52)     <p>

53)     You will need Tor 0.2.3.11-alpha or later.

54)     </p>
55) 

56)     <hr>

57) 

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

59)     <br>
60) 
61)     <p>

62)     Set up your Tor configuration file:<br><br>

63)     User tor<br>
64)     PIDFile /usr/local/var/run/tor/tor.pid<br>
65)     SocksPort 1999 # what port to open for local application connections<br>
66)     Log notice file /usr/local/var/log/tor/tor.log<br>
67)     DataDirectory /usr/local/var/lib/tor/data<br>
68)     UseBridges 1<br>
69)     Bridge obfs2 192.0.2.34:34545<br>
70)     ClientTransportPlugin obfs2 exec /usr/local/bin/obfsproxy --managed
71)     </p>
72) 
73)     <p>Replace <em>192.0.2.34</em> with the bridge supporting obfsproxy you
74)     wish to use and <em>34545</em> with the port number the bridge uses.

75)     </p>
76) 
77)     <p>

78)     Launch Tor using this configuration file. You can do this by using
79)     your favorite init script, or by pointing the Tor binary to the
80)     torrc file:

81)     </p>
82) 
83)     <img src="$(IMGROOT)/obfs-spawn_tor_client.png" alt="spawn tor" height="101" width="882">
84) 
85)     <p> <br>
86)     <img src="$(IMGROOT)/sidenav-arrow.png">
87)     <strong>Congratulations!</strong> Your traffic should now be
88)     obfuscated by obfsproxy. You are done! You can now start using Tor.
89)     </p>
90) 
91)     <br> <br> <br> <br>
92) 
93)     <hr>
94) 
95)     <br> <br> <br> <br>
96) 

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

98)     <br>
99) 
100)     <p>

101)     Set up your Tor configuration file:<br><br>

102)     User tor<br>
103)     PIDFile /usr/local/var/run/tor/tor.pid<br>
104)     ORPort 4367<br>
105)     Log notice file /usr/local/var/log/tor/tor.log<br>
106)     DataDirectory /usr/local/var/lib/tor/data<br>
107)     BridgeRelay 1<br>
108)     ServerTransportPlugin obfs2 exec /usr/local/bin/obfsproxy --managed

109)     </p>
110) 
111)     <p>

112)     Launch Tor using this configuration file. You can do this by using
113)     your favorite init script, or by pointing the Tor binary to the
114)     torrc file:

115)     <p>
116) 
117)     <p>
118)     <img src="$(IMGROOT)/obfs-spawn_tor_bridge.png" alt="spawn tor" height="101" width="882"></a>
119)     </p>
120) 
121)     <p>

122)     Next, Find the TCP port opened by obfsproxy. Look in your log file
123)     for a line similar to this one: <br>

124)     <img src="$(IMGROOT)/obfs-log_checking.png" alt="bridge torrc" width="437" height="14"></a>
125)     <br>
126)     The last number, in this case <em>34545</em>, is the TCP port
127)     number that your clients should point their obfsproxy to.
128)     </p>
129) 
130)     <p>
131)     <img src="$(IMGROOT)/sidenav-arrow.png">
132)     <strong>Congratulations!</strong> Tell your clients to point their

133)     obfsproxy to your IP address and to port <em>34545</em>.