mirror of
https://github.com/fosrl/docs-v2.git
synced 2026-02-08 05:56:45 +00:00
Rename to nodes
This commit is contained in:
Owen
@@ -3,7 +3,7 @@ title: "How Pangolin Works"
|
||||
description: "Learn about Pangolin's architecture and how its components work together to provide secure application access"
|
||||
---
|
||||
|
||||
Pangolin provides secure, application-specific ingress to your applications through a network of points of presence. Users connect to the closest point of presence, which authenticates them and routes their requests through secure tunnels to your applications.
|
||||
Pangolin provides secure, application-specific ingress to your applications through a network of nodes. Users connect to the closest node, which authenticates them and routes their requests through secure tunnels to your applications.
|
||||
|
||||
<Frame>
|
||||
<img src="/images/diagram.svg" width="400" centered/>
|
||||
@@ -12,12 +12,12 @@ Pangolin provides secure, application-specific ingress to your applications thro
|
||||
## How It Works
|
||||
|
||||
<Steps>
|
||||
<Step title="User enters through point of presence">
|
||||
DNS automatically routes users to the closest available regional point of presence (PoP). A PoP is always available because the control plane fails over between PoPs.
|
||||
<Step title="User enters through node">
|
||||
DNS automatically routes users to the closest available regional node. A node is always available because the control plane fails over between nodes.
|
||||
</Step>
|
||||
|
||||
<Step title="Authentication and authorization">
|
||||
The point of presence verifies the user's identity, checks access permissions, and applies context aware rules such as IP and path based filters, geoblocking, and rate limiting.
|
||||
The node verifies the user's identity, checks access permissions, and applies context aware rules such as IP and path based filters, geoblocking, and rate limiting.
|
||||
</Step>
|
||||
|
||||
<Step title="Secure tunnel routing">
|
||||
@@ -30,26 +30,26 @@ Pangolin provides secure, application-specific ingress to your applications thro
|
||||
</Steps>
|
||||
|
||||
<Info>
|
||||
Points of presence provide a mesh of high availability - if one location goes down, traffic automatically routes to the next closest location.
|
||||
nodes provide a mesh of high availability - if one location goes down, traffic automatically routes to the next closest location.
|
||||
</Info>
|
||||
|
||||
## Deployment Options
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Pangolin Cloud" icon="cloud" href="https://pangolin.fossorial.io/auth/signup">
|
||||
Large network of points of presence with automatic failover and routing to your backend services.
|
||||
Large network of nodes with automatic failover and routing to your backend services.
|
||||
</Card>
|
||||
|
||||
<Card title="Managed" icon="circle-nodes" href="/manage/managed">
|
||||
Host your own multiple points of presence with cloud coordination and automatic failover. Data always transits your servers.
|
||||
Host your own multiple nodes with cloud coordination and automatic failover. Data always transits your servers.
|
||||
</Card>
|
||||
|
||||
<Card title="Self-Hosted" icon="server" href="/self-host/quick-install">
|
||||
Fully self-hosted, self-contained Pangolin server acting as a single point of presence.
|
||||
Fully self-hosted, self-contained Pangolin server acting as a single node.
|
||||
</Card>
|
||||
|
||||
<Card title="Learn More" icon="book" href="/manage/points-of-presence">
|
||||
Detailed information about points of presence and high availability options.
|
||||
Detailed information about nodes and high availability options.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
@@ -61,7 +61,7 @@ Points of presence provide a mesh of high availability - if one location goes do
|
||||
</Card>
|
||||
|
||||
<Card title="Ingress Mesh" icon="globe">
|
||||
Users always connect to the closest available point of presence.
|
||||
Users always connect to the closest available node.
|
||||
</Card>
|
||||
|
||||
<Card title="Zero-Trust Security" icon="shield">
|
||||
@@ -69,6 +69,6 @@ Points of presence provide a mesh of high availability - if one location goes do
|
||||
</Card>
|
||||
|
||||
<Card title="High Availability" icon="check-double">
|
||||
Multiple points of presence, failover, and load balancing between tunnels ensures there is always a way for users to access your applications.
|
||||
Multiple nodes, failover, and load balancing between tunnels ensures there is always a way for users to access your applications.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
@@ -3,7 +3,7 @@ title: "Pangolin vs. Reverse Proxy"
|
||||
description: "Learn how Pangolin's distributed architecture eliminates single points of failure and provides authenticated access to your applications"
|
||||
---
|
||||
|
||||
Pangolin builds upon traditional reverse proxy principles but adds distributed architecture, tunneling, and identity-aware access control. While traditional reverse proxies are typically single-server solutions, Pangolin operates as a distributed network of points of presence that provide highly-available access to your applications.
|
||||
Pangolin builds upon traditional reverse proxy principles but adds distributed architecture, tunneling, and identity-aware access control. While traditional reverse proxies are typically single-server solutions, Pangolin operates as a distributed network of nodes that provide highly-available access to your applications.
|
||||
|
||||
## Traditional Reverse Proxy Limitations
|
||||
|
||||
@@ -33,11 +33,11 @@ Pangolin provides high availability at two critical layers: ingress points and b
|
||||
|
||||
<Steps>
|
||||
<Step title="Ingress Routing">
|
||||
Request is routed to the closest available point of presence. If one goes down, there is always another point available.
|
||||
Request is routed to the closest available node. If one goes down, there is always another point available.
|
||||
</Step>
|
||||
|
||||
<Step title="Authentication">
|
||||
User identity is verified at the point of presence before getting routed to your backend.
|
||||
User identity is verified at the node before getting routed to your backend.
|
||||
</Step>
|
||||
|
||||
<Step title="Tunnel Selection">
|
||||
@@ -54,7 +54,7 @@ Pangolin provides high availability at two critical layers: ingress points and b
|
||||
</Steps>
|
||||
|
||||
<Info>
|
||||
This dual-layer approach ensures your applications remain accessible even if individual points of presence or tunnel connections fail.
|
||||
This dual-layer approach ensures your applications remain accessible even if individual nodes or tunnel connections fail.
|
||||
</Info>
|
||||
|
||||
## Key Differences
|
||||
@@ -110,5 +110,5 @@ Unlike traditional reverse proxies, Pangolin authenticates every single request,
|
||||
| **Scalability** | Manual scaling | Automatic regional distribution |
|
||||
|
||||
<Card title="Try Pangolin Cloud" icon="rocket" href="https://pangolin.fossorial.io/auth/signup">
|
||||
Get distributed, authenticated access to your applications with Pangolin's regional network of points of presence.
|
||||
Get distributed, authenticated access to your applications with Pangolin's regional network of nodes.
|
||||
</Card>
|
||||
|
||||
@@ -65,7 +65,7 @@ Pangolin provides secure, application-specific ingress and routing without the l
|
||||
</Card>
|
||||
|
||||
<Card title="Highly Available Mesh" icon="circle-nodes" href="/manage/points-of-presence">
|
||||
Multiple points of presence ensure high availability.
|
||||
Multiple nodes ensure high availability.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
@@ -78,7 +78,7 @@ Multiple points of presence ensure high availability.
|
||||
| **Network Requirements** | Public IP, open ports | No public IP needed |
|
||||
| **Access Control** | Network-level | Zero-trust, granular |
|
||||
| **Authentication** | Basic credentials | Multi-factor, SSO, OIDC |
|
||||
| **Infrastructure** | Single server | Distributed points of presence |
|
||||
| **Infrastructure** | Single server | Distributed nodes |
|
||||
| **Security Model** | Network-based trust | Identity-based trust |
|
||||
|
||||
<Card title="Try Pangolin Cloud" icon="rocket" href="https://pangolin.fossorial.io/auth/signup">
|
||||
@@ -87,6 +87,6 @@ Multiple points of presence ensure high availability.
|
||||
|
||||
# Pangolin vs. Mesh VPN (e.g., Tailscale, Netbird)
|
||||
|
||||
Pangolin and mesh VPNs like Tailscale or Netbird both provide secure remote access, but they differ in their approach and functionality. Mesh VPNs focus on creating peer-to-peer connections between devices for full network access, while Pangolin is designed to expose specific applications or services securely through points of presence, with no need for client-side software on user devices.
|
||||
Pangolin and mesh VPNs like Tailscale or Netbird both provide secure remote access, but they differ in their approach and functionality. Mesh VPNs focus on creating peer-to-peer connections between devices for full network access, while Pangolin is designed to expose specific applications or services securely through nodes, with no need for client-side software on user devices.
|
||||
|
||||
Pangolin is a better choice for application-specific access with zero-trust security and no client-side software requirements. Mesh VPNs like Tailscale or Netbird are more suitable for full network access and peer-to-peer connectivity. For environments prioritizing granular access control and simplicity, Pangolin offers a more focused and secure solution.
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
{
|
||||
"group": "Manage Pangolin",
|
||||
"pages": [
|
||||
"manage/points-of-presence",
|
||||
"manage/nodes",
|
||||
"manage/managed",
|
||||
{
|
||||
"group": "Sites",
|
||||
|
||||
10
index.mdx
10
index.mdx
@@ -2,25 +2,25 @@
|
||||
title: "Introduction to Pangolin"
|
||||
---
|
||||
|
||||
Pangolin is an open-source and identity-aware tunneled reverse proxy server. Pangolin's distributed architecture with points of presence provide highly available ingress to ensure applications always remain accessible.
|
||||
Pangolin is an open-source and identity-aware tunneled reverse proxy server. Pangolin's distributed architecture with nodes provide highly available ingress to ensure applications always remain accessible.
|
||||
|
||||
<Frame caption="Screenshot of resources page from the Pangolin Dashboard.">
|
||||
<img src="/images/fossorial-dashboard.png" alt="Pangolin Dashboard"/>
|
||||
</Frame>
|
||||
|
||||
Pangolin establishes secure connections from edge networks to PoPs, bypassing the need for public inbound ports and complex firewall configurations. Pangolin is incredibly useful for exposing local services, IoT devices, or internal applications to the internet without direct exposure, enhancing security by reducing attack surface and simplifying network management. Additionally, Pangolin acts as an identity-aware proxy by authenticating every request against admin-defined access controls and rules.
|
||||
Pangolin establishes secure connections from edge networks to nodes, bypassing the need for public inbound ports and complex firewall configurations. Pangolin is incredibly useful for exposing local services, IoT devices, or internal applications to the internet without direct exposure, enhancing security by reducing attack surface and simplifying network management. Additionally, Pangolin acts as an identity-aware proxy by authenticating every request against admin-defined access controls and rules.
|
||||
|
||||
<Columns cols={2}>
|
||||
<Card title="How it works" icon="map" href="/about/how-pangolin-works">
|
||||
Learn how the Pangolin system works from the server to the edge network.
|
||||
</Card>
|
||||
<Card title="Points of Presence" icon="circle-nodes" href="/manage/points-of-presence">
|
||||
<Card title="nodes" icon="circle-nodes" href="/manage/points-of-presence">
|
||||
Learn about how Pangolin provides highly available ingress to your backend.
|
||||
</Card>
|
||||
</Columns>
|
||||
|
||||
<Card title="Pangolin Cloud" icon="cloud" href="https://pangolin.fossorial.io/auth/signup">
|
||||
Use Cloud for a highly available and access-controllerd ingress service with points of presence all over the world.
|
||||
Use Cloud for a highly available and access-controllerd ingress service with nodes all over the world.
|
||||
</Card>
|
||||
|
||||
<Columns cols={2}>
|
||||
@@ -29,7 +29,7 @@ Pangolin establishes secure connections from edge networks to PoPs, bypassing th
|
||||
icon="server"
|
||||
href="/self-host/quick-install"
|
||||
>
|
||||
Install and manage your own single point of presence Pangolin server on your own infrastructure.
|
||||
Install and manage your own single node Pangolin server on your own infrastructure.
|
||||
</Card>
|
||||
<Card
|
||||
title="Install Site"
|
||||
|
||||
@@ -1,35 +1,35 @@
|
||||
---
|
||||
title: "Self host a Managed PoP"
|
||||
title: "Self-host Managed Nodes"
|
||||
description: "Learn about Pangolin's managed deployment mode"
|
||||
---
|
||||
|
||||
In this deployment modality you can host your own points of presence with cloud coordination and automatic failover. Data always transits your servers and the cloud handles orchestration between all of your PoPs.
|
||||
In this deployment modality you can host your own nodes with cloud coordination and automatic failover. Data always transits your servers and the cloud handles orchestration between all of your nodes.
|
||||
|
||||
Its essentially just the normal self hosted pangolin setup, but with added benefits of cloud integration and coordinated failover.
|
||||
|
||||
<Tip>
|
||||
You can deploy a managed Pangolin PoP in seconds [using the installer](../self-host/quick-install-managed).
|
||||
You can deploy a managed Pangolin node in seconds [using the installer](../self-host/quick-install-managed).
|
||||
</Tip>
|
||||
|
||||
### How It Works
|
||||
|
||||
- **You Host the PoP**: Manage the infrastructure for your points of presence, which connect your Newt tunnels.
|
||||
- **You Host the node**: Manage the infrastructure for your nodes, which connect your Newt tunnels.
|
||||
- **We Handle the Rest**: Pangolin Cloud manages the control plane, DNS, certificate management, database, and backups.
|
||||
- **Failover Made Simple**: Host multiple PoPs with automatic failover between them. Optionally, if your PoPs are unavailable, traffic automatically fails over to our cloud PoPs.
|
||||
- **Failover Made Simple**: Host multiple nodes with automatic failover between them. Optionally, if your nodes are unavailable, traffic automatically fails over to our cloud nodes.
|
||||
|
||||
<Frame>
|
||||
<img src="/images/ha.svg" width="400" centered/>
|
||||
</Frame>
|
||||
|
||||
<Note>
|
||||
For detailed information about how points of presence work and their advantages, see our [Points of Presence](/manage/points-of-presence) documentation.
|
||||
For detailed information about how nodes work and their advantages, see our [Nodes](/manage/nodes) documentation.
|
||||
</Note>
|
||||
|
||||
### Benefits
|
||||
|
||||
- **Data Control**: Traffic flows through your servers, giving you control over data transit costs, privacy, and works with your security policies.
|
||||
- **High Availability**: Eliminates the complexity of managing high availability while still owning your own infrastructure.
|
||||
- **Less Management Overhead**: While we update the cloud with new features you don't need to touch your PoPs unless you want to.
|
||||
- **Less Management Overhead**: While we update the cloud with new features you don't need to touch your nodes unless you want to.
|
||||
|
||||
<Tip>
|
||||
Managed deployment is ideal for organizations that need high availability while maintaining control over their infrastructure and data transit.
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
---
|
||||
title: "HA & Points of Presence"
|
||||
description: "Learn about Pangolin's network of points of presence and how they provide highly available, low-latency access to your applications"
|
||||
title: "Highly Available Nodes"
|
||||
description: "Learn about Pangolin's network of nodes and how they provide highly available, low-latency access to your applications"
|
||||
---
|
||||
|
||||
Pangolin's points of presence (PoPs) are strategically located servers around the world that serve as entry points for user traffic to your applications. They form the foundation of Pangolin's distributed architecture, providing high availability and optimal performance.
|
||||
Pangolin's nodes are an ability to put strategically located servers around the world that serve as entry points for user traffic to your applications. They form the foundation of Pangolin's distributed architecture, providing high availability and optimal performance.
|
||||
|
||||
## What Are Points of Presence?
|
||||
## What Are Nodes?
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Entry Points" icon="door-open">
|
||||
@@ -26,22 +26,22 @@ Pangolin's points of presence (PoPs) are strategically located servers around th
|
||||
</CardGroup>
|
||||
|
||||
<Info>
|
||||
Think of points of presence as the "front doors" to your applications - users connect to the closest one, and it securely routes their requests to your backend services.
|
||||
Think of different nodes as the "front doors" to your applications - users connect to the closest one, and it securely routes their requests to your backend services.
|
||||
</Info>
|
||||
|
||||
## How Points of Presence Work
|
||||
## How Nodes Work
|
||||
|
||||
<Steps>
|
||||
<Step title="Ingress Routing">
|
||||
Request is routed to the closest available point of presence. If one goes down, there is always another point available.
|
||||
Request is routed to the closest available node. If one goes down, there is always another node available.
|
||||
</Step>
|
||||
|
||||
<Step title="Authentication">
|
||||
User identity is verified at the point of presence before getting routed to your backend.
|
||||
User identity is verified at the node before getting routed to your backend.
|
||||
</Step>
|
||||
|
||||
<Step title="Tunnel Selection">
|
||||
Pangolin selects the optimal tunnel route to your backend service. Site tunnel clients (Newt) connect to the optimal point of presence.
|
||||
Pangolin selects the optimal tunnel route to your backend service. Site tunnel clients (Newt) connect to the optimal node.
|
||||
</Step>
|
||||
|
||||
<Step title="Failover Handling">
|
||||
@@ -49,11 +49,11 @@ Think of points of presence as the "front doors" to your applications - users co
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
## Advantages of Points of Presence
|
||||
## Advantages of Nodes
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Low Latency" icon="bolt">
|
||||
Users connect to the geographically closest point of presence.
|
||||
Users connect to the geographically closest node.
|
||||
</Card>
|
||||
|
||||
<Card title="Optimized Routing" icon="route">
|
||||
@@ -65,13 +65,13 @@ Think of points of presence as the "front doors" to your applications - users co
|
||||
</Card>
|
||||
|
||||
<Card title="Health Monitoring" icon="heart-pulse">
|
||||
Each point of presence continuously monitors its health and connectivity to your backend.
|
||||
Each node continuously monitors its health and connectivity to your backend.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Regional Redundancy" icon="check-double">
|
||||
Multiple points of presence ensure your applications remain accessible during regional outages.
|
||||
Multiple nodes ensure your applications remain accessible during regional outages.
|
||||
</Card>
|
||||
|
||||
<Card title="Fault Tolerance" icon="shield">
|
||||
@@ -83,20 +83,20 @@ Think of points of presence as the "front doors" to your applications - users co
|
||||
|
||||
<CardGroup cols={3}>
|
||||
<Card title="Pangolin Cloud" icon="cloud" href="https://pangolin.fossorial.io/auth/signup">
|
||||
Network of points of presence with automatic failover and routing to your backend services.
|
||||
Network of nodes with automatic failover and routing to your backend services.
|
||||
</Card>
|
||||
|
||||
<Card title="Managed" icon="circle-nodes" href="/manage/managed">
|
||||
Host your own multiple points of presence with cloud coordination and automatic failover. Data always transits your servers.
|
||||
Host your own multiple nodes with cloud coordination and automatic failover. Data always transits your servers.
|
||||
</Card>
|
||||
|
||||
<Card title="Self-Hosted" icon="server" href="/self-host/quick-install">
|
||||
Fully self-hosted, self-contained Pangolin server acting as a single point of presence.
|
||||
Fully self-hosted, self-contained Pangolin server acting as a single node.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
<Warning>
|
||||
Self-hosted Pangolin provides only a single point of presence and is not highly available. Consider Pangolin Cloud or managed deployment for production environments requiring high availability.
|
||||
Self-hosted Pangolin provides only a single node and is not highly available. Consider Pangolin Cloud or managed deployment for production environments requiring high availability.
|
||||
</Warning>
|
||||
|
||||
<Tip>
|
||||
@@ -27,7 +27,7 @@ Your existing Pangolin data will stay in the database, so feel free to try manag
|
||||
</Step>
|
||||
|
||||
<Step title="Generate credentials">
|
||||
In the Pangolin Cloud dashboard, navigate to the "Self-hosted" section and generate a new ID and secret for this PoP. Make sure to copy this config, as you'll need it later.
|
||||
In the Pangolin Cloud dashboard, navigate to the "Self-hosted" section and generate a new ID and secret for this node. Make sure to copy this config, as you'll need it later.
|
||||
</Step>
|
||||
|
||||
<Step title="Prepare your instance">
|
||||
|
||||
@@ -81,7 +81,7 @@ Files marked with `(*)` must be created manually. Volumes and other files are ge
|
||||
<Step title="Update domain">
|
||||
Edit the configuration files to replace:
|
||||
|
||||
- `154.123.45.67` with your actual domain OR public IP address of the PoP
|
||||
- `154.123.45.67` with your actual domain OR public IP address of the node
|
||||
|
||||
<Warning>
|
||||
Ensure your domain DNS is properly configured to point to your server's IP address if you choose DNS.
|
||||
|
||||
@@ -53,7 +53,7 @@ Before installing Pangolin, ensure you've opened the required port on your firew
|
||||
|
||||
<Step title="Do you already have credentials from the dashboard?">
|
||||
|
||||
If you are on your game and have already generated credentials for this PoP in the dashboard enter them here.
|
||||
If you are on your game and have already generated credentials for this node in the dashboard enter them here.
|
||||
|
||||
<Tip>
|
||||
If you don't have them yet you can just select no when asked and we will create it in a later step.
|
||||
@@ -61,11 +61,11 @@ If you don't have them yet you can just select no when asked and we will create
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="The public addressable IP address for this PoP">
|
||||
<Step title="The public addressable IP address for this node">
|
||||
|
||||
Enter either the public IP address of your server or a domain name that resolves to it.
|
||||
|
||||
If you choose to use a domain keep in mind this just resolves your PoP on the internet while the actual subdomains for resources will be managed in the cloud.
|
||||
If you choose to use a domain keep in mind this just resolves your node on the internet while the actual subdomains for resources will be managed in the cloud.
|
||||
|
||||
</Step>
|
||||
|
||||
@@ -79,10 +79,10 @@ Your managed credentials have been obtained successfully.
|
||||
Secret: n7sd18twfko0q0vrb7wyclqzbvvnx1fqt7ezv8xewhdb9s7d
|
||||
```
|
||||
|
||||
Go to the [Pangolin dashboard](https://pangolin.fossorial.io/) and log in. Navigate to the "Self-hosted" section and add a new PoP. Use this ID and secret to register your PoP.
|
||||
Go to the [Pangolin dashboard](https://pangolin.fossorial.io/) and log in. Navigate to the "Self-hosted" section and add a new node. Use this ID and secret to register your node.
|
||||
|
||||
<Tip>
|
||||
More than one account can use the same PoP credentials. This is useful for teams.
|
||||
More than one account can use the same node credentials. This is useful for teams.
|
||||
</Tip>
|
||||
|
||||
</Step>
|
||||
@@ -97,6 +97,6 @@ Once installation completes successfully, you'll see:
|
||||
Installation complete!
|
||||
```
|
||||
|
||||
Navigate to the [Pangolin dashboard](https://pangolin.fossorial.io/) and create sites, resources, and targets for your managed PoP.
|
||||
Navigate to the [Pangolin dashboard](https://pangolin.fossorial.io/) and create sites, resources, and targets for your managed node.
|
||||
|
||||
{/* ## Video Walkthrough */}
|
||||
|
||||
@@ -4,7 +4,7 @@ description: "Deploy your own Pangolin reverse proxy server in under 10 minutes
|
||||
---
|
||||
|
||||
<Info>
|
||||
Fully self-hosted Pangolin provides only one point of presence and is not highly available.
|
||||
Fully self-hosted Pangolin provides only one node and is not highly available.
|
||||
</Info>
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@@ -33,7 +33,7 @@ WireGuard provides fast, secure, and reliable tunneling with minimal overhead.
|
||||
|
||||
Newt is a lightweight client that runs on your edge networks (servers, VMs, or containers):
|
||||
|
||||
- **Automatic Discovery**: Finds the optimal point of presence for best performance
|
||||
- **Automatic Discovery**: Finds the optimal node for best performance
|
||||
- **Dual Connection**: Connects to Pangolin via WebSocket and Gerbil via WireGuard
|
||||
- **Resource Proxy**: Creates TCP/UDP proxies to expose your applications securely
|
||||
|
||||
|
||||
Reference in New Issue
Block a user