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

reorg

Browse Source
This commit is contained in:
miloschwartz
2025-09-06 22:28:52 -07:00
parent c30340684f
commit d0d56c2a61
15 changed files with 79 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
about/how-pangolin-works.mdx
View File

@@ -30,21 +30,21 @@ Pangolin provides secure, application-specific ingress to your applications thro
</Steps>
<Info>
nodes 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 nodes with automatic failover and routing to your backend services.
Large network of nodes with automatic failover and routing to your backend services. We host the Pangolin server for you.
</Card>
<Card title="Managed" icon="circle-nodes" href="/manage/managed">
Host your own multiple nodes with cloud coordination and automatic failover. Data always transits your servers.
<Card title="Managed Self-hosted" icon="circle-nodes" href="/manage/managed">
Self-host your own Pangolin node with cloud coordination for high availability and automatic failover. Data always transits your servers.
</Card>
<Card title="Self-Hosted" icon="server" href="/self-host/quick-install">
<Card title="Community Edition" icon="server" href="/self-host/quick-install">
Fully self-hosted, self-contained Pangolin server acting as a single node.
</Card>

42
docs.json
View File

@@ -79,20 +79,28 @@
{
"group": "Self-host Pangolin",
"pages": [
"self-host/quick-install",
"self-host/quick-install-managed",
{
"group": "Manual Installation",
"pages": ["self-host/manual/managed"]
},
"self-host/choosing-a-vps",
"self-host/how-to-update"
]
},
{
"group": "Community Edition",
"pages": [
"self-host/quick-install",
{
"group": "Manual Installation",
"pages": [
"self-host/manual/docker-compose",
"self-host/manual/unraid",
"self-host/manual/managed"
"self-host/manual/unraid"
]
},
"self-host/choosing-a-vps",
"self-host/dns-and-networking",
"self-host/convert-managed",
"self-host/how-to-update",
"self-host/supporter-program",
"self-host/system-architecture",
{
@@ -128,25 +136,14 @@
]
}
]
},
{
"tab": "Blog",
"href": "https://digpangolin.com/blog"
}
],
"global": {
"anchors": [
{
"anchor": "Website",
"href": "https://digpangolin.com",
"icon": "globe"
},
{
"anchor": "Blog",
"href": "https://digpangolin.com/blog",
"icon": "book"
},
{
"anchor": "Support Plans",
"href": "https://digpangolin.com/support",
"icon": "life-ring"
},
{
"anchor": "GitHub",
"href": "https://github.com/fosrl/pangolin",
@@ -156,6 +153,11 @@
"anchor": "Discord",
"href": "https://discord.gg/HCJR8Xhme4",
"icon": "discord"
},
{
"anchor": "Support Plans",
"href": "https://digpangolin.com/support",
"icon": "life-ring"
}
]
}

24
index.mdx
View File

@@ -11,32 +11,20 @@ Pangolin is an open-source and identity-aware tunneled reverse proxy server. Pan
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">
<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="Nodes" icon="circle-nodes" href="/manage/nodes">
<Card title="Self-hosted Nodes" icon="circle-nodes" href="/manage/nodes">
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 nodes all over the world.
</Card>
<Columns cols={2}>
<Card
title="Self-host Pangolin"
icon="server"
href="/self-host/quick-install"
>
Install and manage your own single node Pangolin server on your own infrastructure.
<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 nodes all over the world.
</Card>
<Card
title="Install Site"
icon="sitemap"
href="/manage/sites/install-site"
>
Install Newt, the edge client, almost anywhere.
<Card title="Quick Install Guide" icon="server" href="/self-host/quick-install-managed">
Learn the fastest way to install a managed self-hosted Pangolin node.
</Card>
</Columns>

2
manage/access-control/rules.mdx
View File

@@ -60,7 +60,7 @@ Path match rules allow URL patterns defined with plain text and wildcards (`*`)
### Country
<Note>
Geo blocking is only available for targets created with managed nodes or in the cloud because we need to host services to resolve IP addresses and evolve it quickly as network change.
Geo blocking is only available for targets created with managed self-hosted nodes or in the cloud because we need to host services to resolve IP addresses and evolve it quickly as network change.
Fully self hosted users can install a [Traefik plugin](/self-host/community-guides/geoblock) for geo blocking support.
</Note>

4
manage/clients/add-client.mdx
View File

@@ -3,10 +3,6 @@ title: "Add Client"
description: "Create a client to connect to your Pangolin network from a remote computer"
---
<Note>
This feature is only available in self-hosted Pangolin instances.
</Note>
A client in Pangolin is a way to create a traditional VPN tunnel from your remote computer to your Newt site on your private network. Clients allow you to tunnel your computer back into your whole network and remotely access non-HTTP resources like file shares or use it as a bastion host to manage servers.
<Note>

2
manage/domains.mdx
View File

@@ -69,7 +69,7 @@ Domains can be added to an organization via the domains section of the organizat
</Steps>
<Warning>
Domain delegation and CNAME domains are only available in Pangolin Cloud. Self-hosted Pangolin uses different domain configuration methods.
Domain delegation and CNAME domains are only available in Pangolin Cloud. Community Edition Pangolin uses different domain configuration methods.
</Warning>
### Self-Hosted Pangolin

4
manage/healthchecks-failover.mdx
View File

@@ -4,7 +4,7 @@ description: "Configure automated health monitoring and failover for high availa
---
<Note>
Health checks are only available for targets created with managed nodes or in the cloud.
Health checks are only available for targets created with managed self-hosted nodes or in the cloud.
</Note>
<iframe
@@ -222,4 +222,4 @@ Resource: api-service
└── api-02.backup:8443 - Healthy ✅
All targets receive traffic via load balancing
```
```

2
manage/identity-providers/add-an-idp.mdx
View File

@@ -4,7 +4,7 @@ description: "Configure external identity providers for user authentication"
---
<Note>
Identity providers are only available in self-hosted Pangolin instances.
Identity providers are only available in Community Edition Pangolin instances.
</Note>
Identity providers let you authenticate Pangolin users using external identity providers. This is useful for organizations that want to use their existing identity provider infrastructure to manage user authentication.

2
manage/integration-api.mdx
View File

@@ -45,7 +45,7 @@ Organization API keys are created by organization admins and have limited scope
### Root API Keys
Root API keys have some extra permissions and can execute operations across orgs. They are only available in self-hosted Pangolin:
Root API keys have some extra permissions and can execute operations across orgs. They are only available in the Community Edition of Pangolin:
<Warning>
Root API keys have elevated permissions and should be used carefully. Only create them when you need server-wide access.

2
manage/integration-api/using-the-integration-api.mdx
View File

@@ -45,7 +45,7 @@ Organization API keys are created by organization admins and have limited scope
### Root API Keys
Root API keys have some extra permissions and can execute operations across orgs. They are only available in self-hosted Pangolin:
Root API keys have some extra permissions and can execute operations across orgs. They are only available in the Community Edition Pangolin:
<Warning>
Root API keys have elevated permissions and should be used carefully. Only create them when you need server-wide access.

14
manage/managed.mdx
View File

@@ -37,22 +37,22 @@ The managed self-hosted approach gives you the best of both worlds:
## Key Benefits
### ✅ Simpler Operations
### Simpler Operations
No need to run your own mail server or set up complex alerting. You'll get health checks and downtime alerts out of the box, making it much easier to monitor your infrastructure without additional complexity.
### 🔄 Automatic Updates
### Automatic Updates
The cloud dashboard evolves quickly, so you get new features and bug fixes without having to manually pull new containers every time. Your self-hosted node stays current automatically.
### 🔧 Less Maintenance
### Less Maintenance
No database migrations, backups, or extra infrastructure to manage. We handle that in the cloud, so you can focus on what matters most to your business.
### 📊 Cloud Failover
### Cloud Failover
If your node goes down, your tunnels can temporarily fail over to our cloud points of presence until you bring it back online. This ensures continuous availability even during maintenance windows.
### 🛡️ High Availability (PoPs)
### High Availability (PoPs)
You can also attach multiple nodes to your account for redundancy and better performance. Deploy nodes across different regions or providers for maximum reliability.
### ⚡ Future Enhancements
### Future Enhancements
We're planning to add more analytics, alerting, and management tools to make your deployment even more robust. You'll automatically benefit from these improvements as they're released.
## Getting Started
@@ -69,4 +69,4 @@ Ready to convert your existing self-hosted node to managed? Learn how in our [co
<Tip>
Managed deployment is ideal for organizations that need high availability and reduced operational overhead while maintaining complete control over their infrastructure and data transit.
</Tip>
</Tip>

2
self-host/convert-managed.mdx
View File

@@ -1,6 +1,6 @@
---
title: "Convert to Managed"
description: "Learn how to convert your self-hosted Pangolin instance to a managed deployment"
description: "Learn how to convert your Community Edition Pangolin instance to a managed self-hosted node for free"
---
<Info>

6
self-host/manual/managed.mdx
View File

@@ -1,10 +1,10 @@
---
title: "Docker Compose Managed"
title: "Docker Compose"
description: "Deploy managed Pangolin manually using Docker Compose without the automated installer"
---
<Tip>
This guide is for managed Pangolin. If you are looking for self-hosted Pangolin please see the [Docker Compose](/self-host/manual/docker-compose) guide.
This guide is for managed self-hosted Pangolin. If you are looking for self-hosted Community Edition Pangolin please see this [Docker Compose](/self-host/manual/docker-compose) guide.
</Tip>
This guide walks you through setting up Pangolin manually using Docker Compose without the automated installer. This approach gives you full control over the configuration and deployment process.
@@ -235,4 +235,4 @@ gerbil:
managed:
id: "he4g78wevj25msf"
secret: "n7sd18twfko0q0vrb7wyclqzbvvnx1fqt7ezv8xewhdb9s7d"
```
```

28
self-host/quick-install-managed.mdx
View File

@@ -1,11 +1,14 @@
---
title: "Quick Install Managed"
description: "Deploy your own managed Pangolin reverse proxy server in under 10 minutes with our automated installer"
title: "Quick Install Guide"
description: "Deploy your own managed Pangolin instance in under 10 minutes with our automated installer"
---
<Note>
[Why would I want to deploy a managed Pangolin instance?](../manage/managed.mdx)
Self-host your own Pangolin node using the cloud control plane for out of the box high availability and a number of other benefits.
**It's free and all traffic stays on your infrastructure.**
[Why would I want to deploy a managed Pangolin instance?](/manage/managed)
</Note>
@@ -22,8 +25,9 @@ description: "Deploy your own managed Pangolin reverse proxy server in under 10
Before you begin, ensure you have:
- **Linux server** with root access and public IP address
- **Open ports on firewall** for 80 (TCP), 443 (TCP), 51820 (UDP), and 21820 (UDP for clients)
- **Pangolin Cloud** account. You can [create a free account here](https://pangolin.fossorial.io/auth/signup). No subscription required.
- **Linux server** with root access and public IP address.
- **Open ports on firewall** for 80 (TCP), 443 (TCP), 51820 (UDP), and 21820 (UDP for clients).
<Tip>
**Recommended**: Ubuntu 20.04+ or Debian 11+ for best compatibility and performance.
@@ -33,9 +37,9 @@ Before you begin, ensure you have:
Need help choosing? See our [complete VPS guide](/self-host/choosing-a-vps) for suggestions.
## DNS & Networking
## Networking
Before installing Pangolin, ensure you've opened the required port on your firewall. See our guide on [DNS & networking](/self-host/dns-and-networking) for more information.
Before installing Pangolin, ensure you've opened the required port on your firewall. See our guide on [networking](/self-host/dns-and-networking#port-configuration) for more information.
## Installation Process
@@ -74,7 +78,13 @@ If you don't have them yet you can just select no when asked and we will create
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 node on the internet while the actual subdomains for resources will be managed in the cloud.
<Note>
The installer will attempt resolve and prefill your public IP address. Verify this is correct before preceding.
</Note>
<Warning>
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.
</Warning>
</Step>
@@ -88,7 +98,7 @@ 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 node. Use this ID and secret to register your node.
Go to the [Pangolin dashboard](https://pangolin.fossorial.io/) and log in. Navigate to the "Self-hosted" section and add a new node. Select the adopt method. Use this ID and secret to register your node.
<Tip>
More than one account can use the same node credentials. This is useful for teams.

12
self-host/quick-install.mdx
View File

@@ -1,10 +1,16 @@
---
title: "Quick Install Guide"
description: "Deploy your own Pangolin reverse proxy server in under 10 minutes with our automated installer"
title: "Installation Guide"
description: "Deploy your own fully self-hosted instance of Pangolin Community Edition"
---
<Note>
This guide is for the Community Edition self-hosted Pangolin. For self-hosting a highly available managed node, check out [this quick install guide](/self-host/quick-install-managed).
What does this mean? Learn about Managed Self-hosted Nodes [here](/manage/managed).
</Note>
<Info>
Fully self-hosted Pangolin provides only one node and is not highly available.
Community Edition Pangolin provides only one node and is not highly available.
</Info>
## Prerequisites