zerotier/pylon
0
0
Fork 0
mirror of https://github.com/zerotier/pylon.git synced 2026-05-22 16:28:21 -07:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Joseph Henry
2023-07-24 15:58:45 -07:00
parent edcf5edf19
commit c7718a0383
1 changed files with 46 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+46 -2
View File
@@ -1,27 +1,71 @@
# ZeroTier Pylon
Proxy layer 5 traffic from your apps to and from your ZeroTier virtual network without installing ZeroTier and without bringing up any new network interfaces.
## Build
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
```
## Usage
Pylon can be run as one of two personalities that can work alone or together depending on your needs:
| Name | What do | Is this a ZeroTier Node? |
| ------------- | ------------- | - |
| `pylon refract` | This bridges traffic to and from your LAN | Yes |
| `pylon reflect` | This relays traffic over `TCP/443` | No |
In many cases a single `refract` instance is enough to bridge devices onto your ZeroTier network. However, if you're behind some tricky NAT you might need to set up a `reflect` instance on a machine with a static IP for your `refract` instance to use.
### Set identity
Set environment variable to hold your ZeroTier secret identity:
```
export ZT_PYLON_SECRET_KEY=$(sudo cat identity.secret)
```
### Specify an (optional) UDP port for ZeroTier to use
By default Pylon will chose a random port to send ZeroTier traffic over, but If you need it to only send traffic over a whitelisted port you can specify one like so:
```
export ZT_PYLON_WHITELISTED_PORT=4545
```
### Run `refract` instance
Run proxy service to listen for app traffic locally on `127.0.0.1:1080`:
```
pylon b84ac5c40a2339c9 127.0.0.1 1080
./pylon refract b84ac5c40a2339c9 --listen-addr 0.0.0.0 --listen-port 1080
```
You can also listen on `0.0.0.0`.
### Run `reflect` instance
If you have a tricky NAT situation and can allow `TCP/443`, you can specify a relay on a machine with a static IP like so:
```
./pylon reflect
```
Then tell your pylon instances to use that to proxy traffic:
```
./pylon refract b84ac5c40a2339c9 --listen-addr 0.0.0.0 --listen-port 1080 --relay-addr 0.0.0.0 --relay-port 443
```
## Example Test
Set up remote resource:
@@ -39,4 +83,4 @@ curl --verbose --output output.txt 172.28.128.86:8000 --proxy socks5://127.0.0.1
## 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.
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.