mirror of https://github.com/neosmart/tcpproxy.git
Update project README
This commit is contained in:
parent
707df1ef99
commit
939bb98914
17
README.md
17
README.md
|
@ -3,24 +3,23 @@ _a simple, cross-platform, multi-client TCP proxy_
|
|||
|
||||
`tcpproxy` is a cross-platform, multi-client TCP proxy written in rust, that is designed for those "one-time" tasks where you usually end up spending more time installing a proxy server and setting up the myriad configuration files and options than you do actually using it.
|
||||
|
||||
`tcpproxy` is completely asynchronous and built on top of the `tokio` async runtime. It was written to serve as an example of how bi-directional async networking code using rust futures and an async framework would look and is intentionally kept easy to understand. The code is updated regularly to take advantage of new tokio features and best practices (if/when they change).
|
||||
|
||||
## Usage
|
||||
|
||||
`tcpproxy` is a command-line application. One instance of `tcpproxy` should be started for each remote endpoint you wish to proxy data to/from. All configuration is done via command-line arguments, in keeping with the spirit of this project.
|
||||
|
||||
```
|
||||
tcpproxy [-b BIND_ADDR] -l LOCAL_PORT -h REMOTE_ADDR -r REMOTE_PORT
|
||||
tcpproxy REMOTE_HOST:PORT [-b BIND_ADDR] [-l LOCAL_PORT]
|
||||
|
||||
Options:
|
||||
-b, --bind BIND_ADDR
|
||||
The address on which to listen for incoming requests,
|
||||
defaulting to localhost.
|
||||
-l, --local-port LOCAL_PORT
|
||||
The local port to which tcpproxy should bind to
|
||||
-r, --remote-port REMOTE_PORT
|
||||
The remote port to which TCP packets should be
|
||||
forwarded
|
||||
-h, --host REMOTE_ADDR
|
||||
The remote address to which packets will be forwarded
|
||||
-b, --bind BIND_ADDR
|
||||
The address on which to listen for incoming requests
|
||||
-d, --debug Enable debug mode
|
||||
listening for requests, randomly chosen otherwise.
|
||||
-d, --debug Enables debug mode w/ connection logging.
|
||||
```
|
||||
|
||||
Where possible, sane defaults for arguments are provided automatically.
|
||||
|
|
Loading…
Reference in New Issue