From 32a622e2a67c37a4ca22c306ccb94e1d7b80a2d0 Mon Sep 17 00:00:00 2001 From: Holly Stubbs Date: Fri, 19 Jan 2024 10:47:07 +0000 Subject: [PATCH] Update README.md --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 97141ff..aea6fd9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ # tcp-ws-proxy -A TCP -> WS -> TCP proxy \ No newline at end of file +A TCP -> WS -> TCP proxy + +
+ +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. \ No newline at end of file