pangolin_mirror/docs-v2
1
0
Fork 0
mirror of https://github.com/fosrl/docs-v2.git synced 2026-10-10 22:59:08 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' into dev

Browse Source
This commit is contained in:
miloschwartz
2026-07-27 12:51:33 -04:00
parent ce0004d005 5693ba0407
commit 9cccaa4677
3 changed files with 18 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
manage/clients/nat-traversal.mdx
+12 -5
View File
@@ -17,6 +17,8 @@ When a client and site share the same local network, they detect this and connec
Same-network connections typically offer the lowest latency because traffic never leaves the LAN. Same-network connections typically offer the lowest latency because traffic never leaves the LAN.
Newt collects IP addresses from the host's network interfaces and uses them to send UDP test packets to the client. If Newt runs inside a Docker container, it only sees the container's internal network, so run it on the host itself to ensure it can detect the host's real IP addresses. This detection also works across VLANs—if a client and site are on different VLANs but routing between them is configured correctly, the connection should still succeed.
## NAT Hole Punching ## NAT Hole Punching
NAT hole punching establishes a direct peer-to-peer connection between the client and site, bypassing the need to route traffic through the Pangolin server. The server coordinates the initial connection by helping both peers discover each other's network addresses, allowing them to establish a direct tunnel through their respective NATs and firewalls. NAT hole punching establishes a direct peer-to-peer connection between the client and site, bypassing the need to route traffic through the Pangolin server. The server coordinates the initial connection by helping both peers discover each other's network addresses, allowing them to establish a direct tunnel through their respective NATs and firewalls.
@@ -46,10 +48,12 @@ You can confirm whether a connection is direct or relayed from the client.
### GUI clients ### GUI clients
In a GUI client (Mac, Windows, Android, or iOS/iPadOS), open **Preferences**, go to the **Status** tab, and switch to the **JSON** view. Under each connected site in the `peers` object, check `isRelay`: In a GUI client (Mac, Windows, Android, or iOS/iPadOS), open **Preferences**, go to the **Status** tab, and switch to the **JSON** view. Under each connected site in the `peers` object, check `isRelay` and `isLocal`:
- `isRelay: false` — direct hole-punched connection to the site - `isRelay: false` — direct hole-punched connection to the site
- `isRelay: true` — traffic is relayed through your Pangolin server - `isRelay: true` — traffic is relayed through your Pangolin server
- `isLocal: true` — the site is on the same local network as the client
- `isLocal: false` — the site is on a different network
Example (values obfuscated): Example (values obfuscated):
@@ -63,6 +67,7 @@ Example (values obfuscated):
"connected": true, "connected": true,
"endpoint": "203.0.113.10:51820", "endpoint": "203.0.113.10:51820",
"isRelay": false, "isRelay": false,
"isLocal": true,
"name": "Office Network", "name": "Office Network",
"siteId": 1001 "siteId": 1001
}, },
@@ -70,6 +75,7 @@ Example (values obfuscated):
"connected": true, "connected": true,
"endpoint": "198.51.100.5:21820", "endpoint": "198.51.100.5:21820",
"isRelay": true, "isRelay": true,
"isLocal": false,
"name": "Remote Lab", "name": "Remote Lab",
"siteId": 1002 "siteId": 1002
} }
@@ -83,16 +89,17 @@ In this example, **Office Network** is connected directly (`isRelay: false`) and
### CLI ### CLI
On Linux or when using [Pangolin CLI](/manage/clients/install-client), run `pangolin status`. The **RELAY** column shows whether each site is relayed (`true`) or directly connected (`false`): On Linux or when using [Pangolin CLI](/manage/clients/install-client), run `pangolin status`. The **CONNECTION** column shows whether each site is connected directly (`Direct`) or via relay (`Relay`):
```bash ```bash
pangolin status pangolin status
AGENT VERSION STATUS ORG AGENT VERSION STATUS ORG
Pangolin CLI 0.10.1 Connected org_example123 Pangolin CLI 0.10.1 Connected org_example123
SITE ENDPOINT STATUS LAST SEEN RELAY SITE ENDPOINT STATUS LAST SEEN CONNECTION
Office Network 203.0.113.10:51820 Connected 1s ago false Office Network 203.0.113.10:51820 Connected 1s ago Direct
Remote Lab 198.51.100.5:21820 Connected 1s ago true Remote Lab 198.51.100.5:21820 Connected 1s ago Relay
Worklab Lab 192.168.1.33:23423 Connected 1s ago Local
``` ```
Use either view when troubleshooting hole punching or verifying that configuration changes took effect. Use either view when troubleshooting hole punching or verifying that configuration changes took effect.
manage/remote-node/backhaul.mdx
+4
View File
@@ -248,6 +248,10 @@ On Windows, set `nativeMain` in the Newt client's `config.json` instead:
} }
``` ```
<Warning>
If you are using Newt on Windows `wintun.dll` is required to run in native mode. If not already provided by the installer, you can download from https://www.wintun.net/
</Warning>
<Warning> <Warning>
Windows doesn't respond to ICMP echo requests (ping) over the tunnel interface by default. If you need to ping a Windows site, enable the built-in firewall rule for it: Windows doesn't respond to ICMP echo requests (ping) over the tunnel interface by default. If you need to ping a Windows site, enable the built-in firewall rule for it:
manage/sites/install-site.mdx
+2 -2
View File
@@ -25,9 +25,9 @@ curl -fsSL https://static.pangolin.net/get-newt.sh | bash
To run Newt on Windows, use the latest installer from [GitHub releases](https://github.com/fosrl/newt/releases/latest). To run Newt on Windows, use the latest installer from [GitHub releases](https://github.com/fosrl/newt/releases/latest).
<Warning> {/* <Warning>
If you are using Newt on Windows as a service or with clients, `wintun.dll` may be required. If you are using Newt on Windows as a service or with clients, `wintun.dll` may be required.
</Warning> </Warning> */}
### Manual Download ### Manual Download