Commit c4cfc7f8 authored by David Fifield's avatar David Fifield
Browse files

Move server to server-webrtc. 

To make room for the WebSocket server we're actually going to use as a
primary server. Move server-webrtc docs to server-webrtc/README.md.
parent 2d871a1a

.gitignore

+1 −1
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ 
.DS_Store

datadir/

client/client

server/server

server-webrtc/server-webrtc

snowflake.log

proxy/test

proxy/build

Makefile

+1 −1
Original line number Diff line number Diff line
@@ -2,4 +2,4 @@ 
.PHONY: check

check:

	! gofmt -l . 2>&1 | read

	go vet ./broker ./client ./server
 
 No newline at end of file
 
	go vet ./broker ./client ./server-webrtc

README.md

+5 −32
Original line number Diff line number Diff line
@@ -70,9 +70,6 @@ method (see `torrc-manual`): 
ClientTransportPlugin snowflake exec ./client --meek

```



Also, it is possible to connect directly to the go-webrtc server plugin

(skipping all the browser snowflake / broker stuff - see appendix)





#### Building a Snowflake
@@ -134,35 +131,6 @@ abundance of ephemeral and short-lived (and special!) volunteer proxies... 


### Appendix



##### -- Testing directly via WebRTC Server --



Ordinarily, the WebRTC client plugin speaks with a Broker which helps

match and signal with a browser proxy, which ultimately speaks with a default

websocket server.





However, there is a WebRTC server plugin which uses an HTTP server that

simulates the interaction that a client would have with the broker, for

direct testing.



Edit server/torrc and add "-http 127.0.0.1:8080" to the end of the

ServerTransportPlugin line:

```

ServerTransportPlugin snowflake exec ./server -http 127.0.0.1:8080

```



```

cd server/

go build

tor -f torrc

```



Edit client/torrc and add "-url http://127.0.0.1:8080" to the end of the

ClientTransportPlugin line:

```

ClientTransportPlugin snowflake exec ./client -url http://127.0.0.1:8080/

```



##### -- Testing Copy-Paste Via Browser Proxy --



Open a browser proxy, passing the `manual` parameter; e.g.
@@ -183,6 +151,11 @@ Then, in the browser proxy: 
- Once WebRTC successfully connects, the browser terminal should turn green.

  Shortly after, the tor client should bootstrap to 100%.



##### -- Testing directly via WebRTC Server --



See server-webrtc/README.md for information on connecting directly to a

WebRTC server transport plugin, bypassing the Broker and browser proxy.



More documentation on the way.



Also available at:

server-webrtc/README.md

0 → 100644
+26 −0
Original line number Diff line number Diff line 
Ordinarily, the WebRTC client plugin speaks with a Broker which helps

match and signal with a browser proxy, which ultimately speaks with a default

websocket server.





However, this directory contains a WebRTC server plugin which uses an

HTTP server that simulates the interaction that a client would have with

the broker, for direct testing.



Edit server-webrtc/torrc and add "-http 127.0.0.1:8080" to the end of the

ServerTransportPlugin line:

```

ServerTransportPlugin snowflake exec ./server-webrtc -http 127.0.0.1:8080

```



```

cd server-webrtc/

go build

tor -f torrc

```



Edit client/torrc and add "-url http://127.0.0.1:8080" to the end of the

ClientTransportPlugin line:

```

ClientTransportPlugin snowflake exec ./client -url http://127.0.0.1:8080/

```

server/http.go→server-webrtc/http.go

+0 −0

File moved.

View file