Skip to content

Commit 3156691

Browse files
committed
Better documentation
1 parent db25205 commit 3156691

File tree

2 files changed

+37
-1
lines changed

2 files changed

+37
-1
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,39 @@ into your existing Go webserver to provide WebSocket reverse proxy.
1010
go get github.com/koding/websocketproxy
1111
```
1212

13+
## Usage
14+
15+
Below is a simple app that runs on a server and proxies to the given backend url
16+
17+
```bash
18+
go run proxy.go -backend ws://example.com -port 80
19+
```
20+
21+
```go
22+
package main
23+
24+
import (
25+
"flag"
26+
"net/http"
27+
"net/url"
28+
29+
"github.com/koding/websocketproxy"
30+
)
31+
32+
var (
33+
flagPort = flag.String("port", "3000", "Port of the reverse proxy")
34+
flagBackend = flag.String("backend", "", "Backend URL for proxying")
35+
)
36+
37+
func main() {
38+
u, err := url.Parse(*flagBackend)
39+
if err != nil {
40+
log.Fataln(err)
41+
}
42+
43+
err := http.ListenAndServe(":"+*flagPort, websocketproxy.NewProxy(u))
44+
if err != nil {
45+
log.Fataln(err)
46+
}
47+
}
48+
```

websocketproxy.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Package websocketproxy is a reverse websocket proxy handler
1+
// Package websocketproxy is a reverse proxy for WebSocket connections.
22
package websocketproxy
33

44
import (

0 commit comments

Comments
 (0)