added standalone tcpproxy binary info

2024-10-29 11:42:45 +01:00
parent 3531f74110
commit aa26ba5da1
4 changed files with 68 additions and 1 deletions
@@ -3,3 +3,5 @@
 This module exposes the `TcpProxyClient` and the `TcpProxyServer` which can be used to proxy traffic through the Mixnet in a way that is more familiar to developers than the methods exposed by the [`Mixnet` module](./mixnet).

 Both `Client` and `Server` are intended to be initialised and then run in a background thread, exposing a configurable `localhost` socket which developers can read/write/stream to without having to worry about the [message-based](../concepts/messages) nature of sending and receiving traffic to/from the Mixnet.
+
+> Non-Rust/Go developers who want to experiment with this module can start with the [standalone binaries](../tools/standalone-tcpproxy).
@@ -3,3 +3,5 @@
 There are a few tools available to developers for chain interaction: the `nym-cli` tool, which operates as an easier-to-use wrapper around `nyxd`, to allow operators to script interactions with their infrastructure (and those who prefer CLI tools ;) ).

 There is also a basic echo server tool which app developers can use as a quick endpoint for traffic testing. This will be deployed onto a persistent public server in the future so devs dont have to run it themselves.
+
+Finally, there are a pair of standalone versions of the TcpProxy Rust SDK module for developers to begin experimenting with sending app traffic through them mixnet.
@@ -1,4 +1,5 @@
 {
  "nym-cli": "Nym-cli",
-  "echo-server": "Echo Server"
+  "echo-server": "Echo Server",
+  "standalone-tcpproxy": "TcpProxy Binaries (Standalone)"
 }
@@ -0,0 +1,62 @@
+# Standalone TcpProxy Binaries
+
+Standalone versions of the `TcpProxyClient` and `TcpProxyServer` [sdk module](../rust/tcpproxy) can be found [here](https://github.com/nymtech/standalone-tcp-proxies/tree/main).
+
+These might be an easy way for developers to start proxying their traffic throught the mixnet and understanding the sort of latency they should expect, and whether their application can currently tolerate it. They might also prove useful for server setups where several components are being run via init scripts, and the addition of a separate process is acceptable.
+
+## Build
+```shell
+cargo build --release
+```
+
+## Use
+```shell
+» ./target/release/proxy_server --help
+Usage: proxy_server [OPTIONS] --upstream-tcp-address <UPSTREAM_TCP_ADDRESS>
+
+Options:
+  -u, --upstream-tcp-address <UPSTREAM_TCP_ADDRESS>
+          Upstream address of the server process we want to proxy traffic to e.g. 127.0.0.1:9067
+  -c, --config-dir <CONFIG_DIR>
+          Config directory [default: /tmp/nym-tcp-proxy-server]
+  -e, --env-path <ENV_PATH>
+          Optional env filepath - if none is supplied then the proxy defaults to using mainnet else just use a path to one of the supplied files in envs/ e.g. ./envs/sandbox.env
+  -h, --help
+```
+
+```shell
+» ./target/release/proxy_client --help
+Usage: proxy_client [OPTIONS] --server-address <SERVER_ADDRESS>
+
+Options:
+      --close-timeout <CLOSE_TIMEOUT>
+          Send timeout in seconds [default: 30]
+  -s, --server-address <SERVER_ADDRESS>
+          Nym address of the NymProxyServer e.g. EjYsntVxxBJrcRugiX5VnbKMbg7gyBGSp9SLt7RgeVFV.EzRtVdHCHoP2ho3DJgKMisMQ3zHkqMtAFAW4pxsq7Y2a@Hs463Wh5LtWZU@NyAmt4trcCbNVsuUhry1wpEXpVnAAfn
+      --listen-address <LISTEN_ADDRESS>
+          Listen address [default: 127.0.0.1]
+      --listen-port <LISTEN_PORT>
+          Listen port [default: 8080]
+  -e, --env-path <ENV_PATH>
+          Optional env filepath - if none is supplied then the proxy defaults to using mainnet else just use a path to one of the supplied files in envs/ e.g. ./envs/sandbox.env
+  -h, --help
+          Print help
+```
+
+## Run
+```shell
+# set up the server on your remote machine, listening on the port your upstream process is expecting to communicate on (e.g. 127.0.0.1:9067).
+# this will log the Nym address of the Nym Proxy Server to pass to the proxy_client
+./target/release/proxy_server -u <UPSTREAM_TCP_ADDRESS>
+
+
+# start your proxy client with the address of the server client. by default this listens on 127.0.0.1:8080
+./target/release/proxy_client --server-address <SERVER_NYM_ADDRESS>
+
+# now start your client process, directing its traffic to the listen port of your nym proxy client process. all traffic will now be proxied through the mixnet.
+```
+
+> You can run on another network by downloading on of the [env files](https://github.com/nymtech/nym/tree/nym-binaries-v2024.12-aero/envs) and passing that to both clients with `-e <PATH_TO_ENV_FILE>`
+
+### A Note on Switching Networks
+If you are running the `proxy_server` binary on one network and then switch to another, make sure to either specify a new env-specific directory for key and surb storage, or remove the existing one, before running the binary. Since the `proxy_client` relies on ephemeral clients, then this is not a problem for this binary.