Update readme

This commit is contained in:
Joseph Henry
2023-07-26 12:09:48 -07:00
parent 6a9b91c47a
commit 0312a13700
+13 -8
View File
@@ -6,14 +6,7 @@ Proxy layer 5 traffic from your apps to and from your ZeroTier virtual network w
Currently the build process will pull a submodule (which itself pulls submodules), build libzt there, and then link pylon against the resultant `libzt.a` static library. Requires `clang`, and `cmake` to build.
```
make release|debug|clean
```
You'll get:
```
pylon
pylon-debug
make
```
## Usage
@@ -81,6 +74,18 @@ Attempt a proxied HTTP GET:
curl --verbose --output output.txt 172.28.128.86:8000 --proxy socks5://127.0.0.1:1080
```
## Debugging
```
make debug|clean
```
You'll get:
```
pylon-debug
```
## Limitations
While a single Pylon instance will work for multiple networks and multiple applications simultaneously it will perform better if a new instance is started for each proxied network. The underlying [libzt]() isn't multithreaded so it is recommended that you also split your proxied traffic across multiple instances if you notice performance bottlecks. Finally, Pylon only supports IPv4 TCP but IPv6 and UDP support can be added if there is sufficient interest.