Update README.md

This commit is contained in:
Holly Stubbs 2024-01-19 10:47:07 +00:00
parent 4d9a359aa5
commit 32a622e2a6

View file

@ -1,3 +1,13 @@
# tcp-ws-proxy # tcp-ws-proxy
A TCP -> WS -> TCP proxy A TCP -> WS -> TCP proxy
<hr>
This was originally made for accessing MariaDB databases over a websocket on a site proxied by Cloudflare.
It seems to work pretty well in my testing so i've made the repo for it public.
# Known issues
- When using it over Cloudflare it *is* possible to create too many websocket connections. See [#2](https://git.eusv.net/tgpholly/tcp-ws-proxy/issues/2).
- The console spam can get pretty bad on the client with multiple connections. This should be resolved once all local client connections share the same pooled websockets.
- There is no handling for if the websocket drops but the sockets on both sides do not. It will not re-establish a connection it will just terminate the TCP connections on both sides. This should be improved.