Skip to content

Commit 5285be1

Browse files
committed
update README
1 parent 2b2b24d commit 5285be1

File tree

2 files changed

+23
-3
lines changed

2 files changed

+23
-3
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,31 @@
44

55
Peer-to-peer TCP socket proxy with WebRTC, use [centrifugo](https://centrifugal.github.io/centrifugo/) as the signal server.
66

7+
## Setup
8+
9+
* Install `webrtc-socket-proxy`
10+
11+
```
12+
$ go get -u github.com/poga/webrtc-socket-proxy
13+
```
14+
15+
* Setup [centrifugo](https://github.com/centrifugal/centrifugo/releases) with [example config](config.centrifugo.test.json)>
16+
17+
* Start proxies
18+
19+
```
20+
$ webrtc-socket-proxy -signal=<SIGNAL_SERVER_ADDR> -secret=<SIGNAL_SERVER_SECRET> -as=<PEER_ID> -upstreamAddr=localhost:8000
21+
$ webrtc-socket-proxy -signal=<SIGNAL_SERVER_ADDR> -secret=<SIGNAL_SERVER_SECRET> -to=<PEER_ID> -listen=:4444
22+
```
23+
24+
725
## Usage
826

927

1028
## Roadmap
1129

12-
- [ ] Multiplex Connections
30+
- [ ] Multiplex Connections
31+
32+
## License
33+
34+
The MIT License

main.go

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ var (
1717

1818
as = flag.String("as", "", "proxy ID")
1919
to = flag.String("to", "", "proxy target ID")
20-
21-
nodeID = flag.String("node", "", "node ID")
2220
)
2321

2422
func main() {

0 commit comments

Comments
 (0)