mirror of
https://gitlab.torproject.org/tpo/anti-censorship/pluggable-transports/snowflake.git
synced 2025-10-13 20:11:19 -04:00
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.
This commit is contained in:
parent
2d871a1a4f
commit
c4cfc7f8ba
7 changed files with 33 additions and 34 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
@ -5,7 +5,7 @@
|
||||||
.DS_Store
|
.DS_Store
|
||||||
datadir/
|
datadir/
|
||||||
client/client
|
client/client
|
||||||
server/server
|
server-webrtc/server-webrtc
|
||||||
snowflake.log
|
snowflake.log
|
||||||
proxy/test
|
proxy/test
|
||||||
proxy/build
|
proxy/build
|
||||||
|
|
2
Makefile
2
Makefile
|
@ -2,4 +2,4 @@
|
||||||
.PHONY: check
|
.PHONY: check
|
||||||
check:
|
check:
|
||||||
! gofmt -l . 2>&1 | read
|
! gofmt -l . 2>&1 | read
|
||||||
go vet ./broker ./client ./server
|
go vet ./broker ./client ./server-webrtc
|
||||||
|
|
37
README.md
37
README.md
|
@ -70,9 +70,6 @@ method (see `torrc-manual`):
|
||||||
ClientTransportPlugin snowflake exec ./client --meek
|
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
|
#### Building a Snowflake
|
||||||
|
|
||||||
|
@ -134,35 +131,6 @@ abundance of ephemeral and short-lived (and special!) volunteer proxies...
|
||||||
|
|
||||||
### Appendix
|
### 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 --
|
##### -- Testing Copy-Paste Via Browser Proxy --
|
||||||
|
|
||||||
Open a browser proxy, passing the `manual` parameter; e.g.
|
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.
|
- Once WebRTC successfully connects, the browser terminal should turn green.
|
||||||
Shortly after, the tor client should bootstrap to 100%.
|
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.
|
More documentation on the way.
|
||||||
|
|
||||||
Also available at:
|
Also available at:
|
||||||
|
|
26
server-webrtc/README.md
Normal file
26
server-webrtc/README.md
Normal file
|
@ -0,0 +1,26 @@
|
||||||
|
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/
|
||||||
|
```
|
Loading…
Add table
Add a link
Reference in a new issue