diff --git a/book/src/udp_over_tcp.md b/book/src/udp_over_tcp.md index 9b4d6ef..5cb7b39 100644 --- a/book/src/udp_over_tcp.md +++ b/book/src/udp_over_tcp.md @@ -11,6 +11,13 @@ python3 udp_over_tcp.py --udp-port 12345 --tcp-port 6789 This will create a TCP server listening on port 6789 which proxies UDP-over-TCP data to port 12345. +Alternatively, for better performance, a Rust version can be installed and run with: + +```bash +cargo install --locked sandhole_udp_over_tcp +sandhole_udp_over_tcp --udp-port 12345 --tcp-port 6789 +``` + In order to create an UDP socket on port 9999 of Sandhole, use the reserved `udp.sandhole` remote host: ```bash @@ -25,6 +32,8 @@ You can also local-forward with the same script by passing the `--local-forwardi ```bash python3 udp_over_tcp.py --udp-port 33333 --tcp-port 4000 --local-forwarding +# -- or -- +sandhole_udp_over_tcp --udp-port 33333 --tcp-port 4000 --local-forwarding ``` ```bash diff --git a/udp_over_tcp/Cargo.toml b/udp_over_tcp/Cargo.toml index 18f93ff..096bbf8 100644 --- a/udp_over_tcp/Cargo.toml +++ b/udp_over_tcp/Cargo.toml @@ -8,7 +8,7 @@ repository = "https://github.com/EpicEric/sandhole" homepage = "https://sandhole.com.br/" license = "MIT" authors = ["Eric Rodrigues Pires "] -readme = "README.md" +readme = "../README.md" keywords = ["ssh", "proxy", "reverse-proxy", "tcp", "udp"] categories = ["network-programming"]