Skip to content

Commit a6d027e

Browse files
committed
updated README with useful information around usage
1 parent 42e60b4 commit a6d027e

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

+26
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,28 @@
11
# flowproxy
22
Intelligent Flow Proxy
3+
4+
## Usage
5+
6+
```shell
7+
Tproxy is used to accept flows and relay them transparently to multiple targets
8+
9+
-device string
10+
the device the proxy should use (default "eth0")
11+
-outfile string
12+
file to write statistics and information to.
13+
-port int
14+
the udp port the proxy should use (default 9995)
15+
-rate int
16+
sample rate to be used for sending flows along.If 0 all flows will be sent.
17+
-target value
18+
Can be passed multiple times in IP:PORT format
19+
-verbose
20+
Whether to log every flow received. Warning can be a lot
21+
```
22+
23+
## Examples
24+
```shell
25+
# run flowproxy using transparent proxy listening for udp packets on device en8 and port 9995.
26+
# Target upstream collector 10.1.1.200 on port 9997 with a sample rate of 4096
27+
flowproxy tproxy -device en8 -port 9995 -target 10.1.1.200:9997 -rate 4096
28+
```

0 commit comments

Comments
 (0)