From 8127b63c06a408d614e90f7a761de1c9c5b327b5 Mon Sep 17 00:00:00 2001 From: WinsDominoes Date: Tue, 13 Feb 2024 19:07:56 +0700 Subject: [PATCH] initial --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..660fa4d --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Tunnel Config +## Server +Run the command +``` +cactus-tunnel server +``` + +## Client +Run the command +``` +cactus-tunnel client -v ws://[TUNNEL_SERVER]:[TUNNEL_SERVER_PORT] [HOST_SERVER]:[HOST_SERVER_PORT] -h [CLIENT_TARGET] -P [CLIENT_TARGET_PORT] +``` +### Explanation +- `ws://[TUNNEL_SERVER]:[TUNNEL_SERVER_PORT]` - The tunnel server itself +- `[HOST_SERVER]:[HOST_SERVER_PORT]` - The thing you want to access (For example: `127.0.0.1:80` is the web server on the host server) +- `-h [CLIENT_TARGET] -p [CLIENT_TARGET_PORT]` - Where you want the thing to be tunneled to + + Basically: + We are using `TUNNEL_SERVER` to tunnel connection from `HOST_SERVER` to `CLIENT_TARGET`