[tor-commits] [websocket/master] Copy and adapt some README from /flashproxy.git.

dcf at torproject.org dcf at torproject.org
Thu Oct 3 16:36:10 UTC 2013


commit ed14dd74f19094a8d94a07fa71011b8602557844
Author: David Fifield <david at bamsoftware.com>
Date:   Thu Oct 3 08:13:43 2013 -0700

    Copy and adapt some README from /flashproxy.git.
---
 README |   26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/README b/README
new file mode 100644
index 0000000..65d76a4
--- /dev/null
+++ b/README
@@ -0,0 +1,26 @@
+This is a server transport plugin for the websocket pluggable transport
+for Tor.
+
+
+== How to build and install
+
+In order to build, you need development tools for the Go programming
+language ("apt-get install golang" on Debian).
+
+        $ cd websocket-transport
+        $ make
+        # make install
+
+
+== How to run a relay
+
+You will need a version of Tor supporting the extended OR port protocol.
+Git master as of 15 August, 2013 works.
+
+        $ git clone https://git.torproject.org/tor.git
+
+Add configuration like the following to the relay's torrc. You can
+change the --port option; make sure that port is open in the firewall.
+
+        ExtORPort 5555
+        ServerTransportPlugin websocket exec /usr/local/bin/websocket-server --port 9901





More information about the tor-commits mailing list