Skip to content

derhuerst/tcp-over-websockets

Repository files navigation

tcp-over-websockets

Tunnel TCP through WebSockets. Access anything you want, even from a crappy WiFi which only allows HTTPS.

Note: chisel is probably the same thing but better. @mdslab/wstun is similar.

npm version ISC-licensed support me via GitHub Sponsors chat with me on Twitter

tunneling client

Using npx:

npx tcp-over-websockets wss://example.org github.com:22 8022

Or by installing manually:

npm install -g tcp-over-websockets
tcp-over-websockets wss://example.org github.com:22 8022

This will expose github.com:22 on localhost:8022, tunneled through a tunneling server at example.org.

Works like ssh -N -L 8022:github.com:22 [email protected], except that it's TCP over WebSockets instead of TCP over SSH.

tunneling server

Using npx:

npx -p tcp-over-websockets tcp-over-websockets-server

Or by installing manually:

npm i -g tcp-over-websockets
tcp-over-websockets-server

Contributing

If you have a question, found a bug or want to propose a feature, have a look at the issues page.