[tor-commits] [ooni-probe/master] Update the README.md with bridge instructions.

[art@xxxxxxxxxxxxxx]

commit 67af973e168b9796dd31f1bbccb0333d46c8171e
Author: aagbsn <aagbsn@xxxxxxxx>
Date:   Thu Jul 4 14:57:04 2013 +0200

    Update the README.md with bridge instructions.
---
 README.md |   22 ++++++++++++++++++++--
 1 file changed, 20 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 6da4680..11cf5af 100644
--- a/README.md
+++ b/README.md
@@ -105,14 +105,14 @@ Basic system requirements:
 On Debian or Ubuntu GNU/Linux based systems these can be installed with:
 
 ```
-sudo apt-get install git-core python python-pip python-dev build-essential tor tor-geoipdb tcpdump
+sudo apt-get install git-core python python-pip python-dev build-essential tor tor-geoipdb obfsproxy tcpdump
 ```
 
 Other packages that may be of interest:
 
 ```
 libdumbnet1 python-dumbnet python-libpcap python-pypcap python-pcapy python-dnspython
-python-virtualenv virtualenvwrapper tor tor-geoipdb
+python-virtualenv virtualenvwrapper tor tor-geoipdb obfsproxy
 ```
 
 The Python dependencies required for running ooniprobe are:
@@ -132,6 +132,12 @@ Install the latest version of Tor for your platform:
 
 [Download Tor](https://www.torproject.org/download/download.html)
 
+## (Optional) Install obfsproxy
+
+Install the latest version of obfsproxy for your platform.
+
+[Download Obfsproxy](https://www.torproject.org/projects/obfsproxy.html.en)
+
 ## Configurating a virtual environment
 
 You are highly recommended to install python packages from inside of a virtual
@@ -281,6 +287,18 @@ By default ooniprobe will not include personal identifying information in the
 test result, nor create a pcap file. This behavior can be personalized by
 editing your ooniprobe.conf configuration file.
 
+## Bridges and obfsproxy bridges
+
+ooniprobe submits reports to oonib report collectors through Tor to a hidden
+service endpoint. By default, ooniprobe uses the installed system Tor, but can
+also be configured to launch Tor (see the advanced.start_tor option in
+ooniprobe.conf), and ooniprobe supports bridges (and obfsproxy bridges, if
+obfsproxy is installed). The tor.bridges option in ooniprobe.conf sets the path
+to a file that should contain a set of "bridge" lines (of the same format as
+used in torrc, and as returned by https://bridges.torproject.org). If obfsproxy
+bridges are to be used, the path to the obfsproxy binary must be configured.
+See option advanced.obfsproxy_binary, in ooniprobe.conf.
+
 ## Setting capabilities on your virtualenv python binary
 
 If your distributation supports capabilities you can avoid needing to run OONI as root:



_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits