Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
HobaiRiku committed Jun 7, 2020
1 parent e4c4ec5 commit 118d2ed
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,19 @@ wsl2-auto-portProxy(wslpp) is a simple tool for proxying port of linux running i
- [ ] web interface
- [ ] UDP port support

## Install
## Build and install

####build wslpp.exe from source
```bash
make build
```
the bin file will be store in dist/wslpp.exe

#### or install with `go get`
```bash
go get https://github.com/HobaiRiku/wsl2-auto-portproxy
```
and use `wsl2-auto-portproxy.exe` to start proxy

## How it works
wslpp start an interval to get IP address of the nat interface and scan all ports listening at all network in the subsystem, then use golang's `net` to start proxy direct to ports.
Expand All @@ -36,10 +47,6 @@ Example:
* predefined: Define the custom port to proxy, "666:22" means `windows(666)->linux(22)`, if undefined, port in windows will follow the same of linux. Must be a string array in the sub field name `tcp`.
* ignore: If defined, will ignore the port in linux. Must be a number array in the sub field name `tcp`.

## Build
```bash
make build
```

## License
MIT
Expand Down

0 comments on commit 118d2ed

Please sign in to comment.