add readme
continuous-integration/drone/push Build is passing Details

This commit is contained in:
Jay 2020-02-05 02:00:32 +00:00
parent ffb19f42c4
commit f890970f84
1 changed files with 46 additions and 0 deletions

46
README.md Normal file
View File

@ -0,0 +1,46 @@
# TCP Proxy
----
[![Build Status](https://ci.trj.tw/api/badges/golang/tcp-proxy/status.svg)](https://ci.trj.tw/golang/tcp-proxy)
## Build
### Bin
```sh
$ make
```
### Docker
```sh
$ docker build -t tcp-proxy .
```
## Usage
### Config
```yaml
# verbose level 0=info, 1=verbose, 2=very verbose
verbose: 0
listen:
# connect target host and port
- target_host: 192.168.1.1
target_port: 22
# local listen port
listen_port: 22000
# connect target host ip range and port
- target_host: 192.168.1.2-5
target_port: 22
# local listen port start number (with connect to ip range)
listen_port: 22010
# connect target host with domain name and port
- target_host: domain.name
target_port: 80
listen_port: 22100
```
### Run
```sh
$ tcp-proxy -f /path/to/config.yml
```