Start an HTTP server that accepts incoming WebSocket connections and bidirectionally forwards data between the established connection and a TCP destination reachable from the server. Define the destination address at runtime with an elegant protocol:
ws://<server-addr>/tunnels/${base64('<remote-host>:<remote-port>')}'
The primary goal of this project is to provide a handy library.
The wsmux binary was added for demonstration purposes (but can potentially be used as a standalone tool as well).
Usage:
# Server - listen for incoming WebSocket connections and tunnel ports
wsmux serve [-addr [host]:<port>]
# Client - forward local port to remote destination via wsmux server
wsmux proxy -server <addr> -local-port <port> [-local-host <host>] -remote-port <port> [-remote-host <host>]Example:
# On the server, prepare the targets (e.g., nginx & httpbin)
$ docker run --rm -p 127.0.0.1:3000:80 nginx:alpine
$ docker run --rm -p 127.0.0.1:5000:80 kennethreitz/httpbin
# On the server again, start the wsmux server
$ wsmux serve -addr 0.0.0.0:8080
Starting wsmux server on 0.0.0.0:8080
# On the client, start the wsmux clients to forward local ports to the targets
$ wsmux proxy -server ws://0.0.0.0:8080 -local-port 3001 -remote-port 3000
Starting wsmux client on localhost:3001 -> localhost:3000 via ws://0.0.0.0:8080
$ wsmux proxy -server ws://0.0.0.0:8080 -local-port 5001 -remote-port 5000
Starting wsmux client on localhost:5001 -> localhost:5000 via ws://0.0.0.0:8080
# Now, you can access the nginx server on http://localhost:3001
$ curl http://localhost:3001
<!DOCTYPE html>
<html>
<head>
<title>Welcome to nginx!</title>
...
# ...and httpbin on http://localhost:5001
$ curl localhost:5001
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>httpbin.org</title>
...