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

Merge branch 'dev' of https://github.com/fosrl/docs-v2 into dev

Browse Source
This commit is contained in:
miloschwartz
2026-08-20 16:18:03 -04:00
parent 7d27ffb36a ea88e2a1b2
commit eac78a6d87
158 changed files with 65 additions and 886 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -2,13 +2,6 @@
title: "How Pangolin Works"
description: "Learn about the fundamentals of Pangolin and how they work together to provide simple and secure remote access."
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
## Basic Steps
<Steps>

2
about/pangolin-vs-reverse-proxy-vs-vpn.mdx
View File

@@ -3,9 +3,7 @@ title: "Pangolin vs. Proxy vs. VPN"
description: "What are the similarities and differences between Pangolin and traditional reverse proxies and VPNs?"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Pangolin combines the capabilities of both a reverse proxy and a VPN into a single platform. It provides reverse proxy functionality through public resources and VPN functionality through private resources, all with zero-trust access control and distributed architecture.

7
careers/join-us.mdx
View File

@@ -1,13 +1,6 @@
---
title: "Join Us!"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
We are looking for talented engineers to join our team and help build secure remote access. If you're passionate about open-source software, networking, and security, we'd love to hear from you.
## About Pangolin

7
careers/software-engineer-full-stack.mdx
View File

@@ -1,13 +1,6 @@
---
title: "Software Engineer - Full Stack"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
- Location: `San Francisco`
- Salary: `$125k - $185k + 0.5% - 1.5% equity`
- Years of experience: `3+`

7
careers/software-engineer-go.mdx
View File

@@ -1,13 +1,6 @@
---
title: "Software Engineer - Go + Network"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
- Location: `San Francisco`
- Salary: `$125k - $185k + 0.5% - 1.5% equity`
- Years of experience: `3+`

7
changelog.mdx
View File

@@ -2,13 +2,6 @@
title: "Changelog"
description: "Updates and announcements"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Update label="March 2025" description="v0.0.10">
Added a new Wintergreen flavor.

7
development/contributing.mdx
View File

@@ -2,13 +2,6 @@
title: "Contribution Guide"
description: "Set up your local development environment for contributing to Pangolin"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
This guide describes how to set up your local development environment for contributing to Pangolin. We recommend using Docker Compose for the most consistent development experience across different environments.
## Prerequisites

7
development/feature-requests-and-bug-reports.mdx
View File

@@ -2,13 +2,6 @@
title: "Feature Requests & Bug Reports"
description: "How to submit feature requests and report bugs for Pangolin"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
We welcome contributions from the community to help improve Pangolin. To ensure your feedback is properly tracked and prioritized, use the repository that matches the component where your issue or request belongs.
## Pick the Right Repository

2
development/system-architecture.mdx
View File

@@ -3,9 +3,7 @@ title: "System Architecture"
description: "A technical overview of how Pangolin's control plane, nodes, connectors, and clients fit together"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
## Open Source

BIN
images/claude_desktop_developer.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 332 KiB

BIN
images/claude_desktop_developer_settings.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 450 KiB

BIN
images/claude_desktop_landing.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 199 KiB

BIN
images/claude_desktop_troubleshooting.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 348 KiB

7
index.mdx
View File

@@ -1,13 +1,6 @@
---
title: "Introduction to Pangolin"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Pangolin is an open-source, identity-based remote access platform built on WireGuard that enables secure, seamless connectivity to private and public resources.
<Frame caption="Screenshot of resources page from the Pangolin Dashboard.">

7
manage/access-control/approvals.mdx
View File

@@ -2,13 +2,6 @@
title: "Device Approvals"
description: "Only allow trusted devices to connect to an organization"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
Only available in [Pangolin Cloud](https://app.pangolin.net/auth/signup) and [Enterprise Edition](/self-host/enterprise-edition).
</Note>

7
manage/access-control/change-password.mdx
View File

@@ -2,13 +2,6 @@
title: "Change Password"
description: "Change or reset your Pangolin account password"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
### Change Password
If you're already logged in, you can change your password by clicking your profile menu (top right) and selecting Change Password. You will be required to confirm your old password and enter a new password.

2
manage/access-control/create-user.mdx
View File

@@ -3,9 +3,7 @@ title: "Users and Roles"
description: "Add internal or external users to your organization and manage roles"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
## Users in Organizations

7
manage/access-control/forwarded-headers.mdx
View File

@@ -2,13 +2,6 @@
title: "Forwarded Headers"
description: "Learn how Pangolin forwards user identity information to your backend applications through HTTP headers"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Pangolin can forward user identity information to your backend applications through custom HTTP headers. This allows your applications to receive user details directly from the request headers, enabling integration with Pangolin's authentication system.
<Info>

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

@@ -3,9 +3,7 @@ title: "Shareable Links"
description: "Create Links and use access tokens for browser or programmatic access."
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Links are special URLs that grant access to one resource without requiring the recipient to sign in as a Pangolin user. Anyone with a web browser on the internet can access the resource if they have a valid Link.

7
manage/access-control/login-page.mdx
View File

@@ -2,13 +2,6 @@
title: "Custom Login Page"
description: "Configure a custom authentication page URL for your organization"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
Custom auth pages are only available in [Pangolin Cloud](https://app.pangolin.net/auth/signup).
</Note>

7
manage/access-control/mfa.mdx
View File

@@ -2,13 +2,6 @@
title: "Multi-Factor Authentication"
description: "Enable and manage two-factor authentication and enforcement for your organization"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Pangolin supports two‑factor authentication (2FA) for Pangolin user accounts.
### Enable or Disable 2FA

7
manage/access-control/password-rotation.mdx
View File

@@ -2,13 +2,6 @@
title: "Password Rotation"
description: "Configure password expiration and rotation requirements for your organization"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
By default, Pangolin does not require passwords to be rotated on a regular basis. However, password rotation can be required on a per‑organization basis.
### Configuration

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

@@ -2,13 +2,6 @@
title: "Rules"
description: "Configure rules to allow or deny access to resources without authentication"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Rules allow you to either "allow" and bypass the Pangolin auth system (no pin, login, password), or "deny" and fully reject the request. After you create a resource you can select the "Rules" tab on the sidebar and enable rules. On public resources, you can also define rules in a [resource policy](/manage/resources/public/resource-policies) and share them across multiple resources.
<CardGroup cols={3}>

7
manage/access-control/security-keys.mdx
View File

@@ -2,13 +2,6 @@
title: "Security Keys"
description: "Use security keys for passwordless login to your Pangolin account"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
You can log in with security keys, also known as passwordless login. On the login page, there is an option below the login button to Log in with security key.
### Add a Security Key

7
manage/access-control/session-length.mdx
View File

@@ -2,13 +2,6 @@
title: "Session Length"
description: "Configure maximum session length and expiration policies for your organization"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
By default, Pangolin keeps extending a session indefinitely if a user is actively using it. If a user is not actively using the session, it will expire after 30 days.
However, you can require users to log in at regular intervals by enforcing maximum session lengths on a per‑organization basis.

43
manage/ai/configure-ai-clients/claude-desktop.mdx
View File

@@ -3,8 +3,18 @@ title: "Claude Desktop"
description: "Connect Claude Desktop's third-party inference to a Pangolin AI Gateway resource"
---
Claude Desktop can route its requests through a third-party inference gateway instead of Anthropic directly. Point it at an AI Gateway resource that has an Anthropic-compatible provider attached — Anthropic itself, Bedrock, Vertex AI, or a custom Anthropic-compatible endpoint. See [AI Gateway Overview](/manage/ai/overview) if you haven't set that up yet.
<Frame>
<img
src="
/images/claude_desktop_landing.png"
alt="Claude Desktop third-party inference settings"
/>
</Frame>
import AiGatewayKey from "/snippets/ai-gateway-key.mdx";
You'll need the resource's URL (its `<endpoint>`) and its API key (`<key>`). Both are on the resource's Keys page.
@@ -14,21 +24,34 @@ You'll need the resource's URL (its `<endpoint>`) and its API key (`<key>`). Bot
## Steps
1. Open Claude Desktop, go to the menu in the top left and select **Help > Troubleshooting**, and turn on **Developer Mode**.
<Frame>
<img
src="
/images/claude_desktop_troubleshooting.png"
alt="Claude Desktop third-party inference settings"
/>
</Frame>
2. From the menu bar, open **Developer**, then **Configure Third-Party Inference…**.
<Frame>
<img
src="
/images/claude_desktop_developer.png"
alt="Claude Desktop third-party inference settings"
/>
</Frame>
3. Select **Gateway**
4. Select **Credential kind** > **Static API Key**.
3. Fill in:
- **Gateway base URL:** `<endpoint>`
- **Gateway API Key:** `<key>`
4. Restart Claude Desktop.
{/*
Screenshot: `/images/ai/claude-desktop-inference-dialog.png`
The "Configure Third-Party Inference" dialog with the Gateway URL and API Key fields filled in.
5. Fill in:
- **Gateway base URL:** `<endpoint>`
- **Gateway API Key:** `<key>`
<Frame>
<img src="/images/ai/claude-desktop-inference-dialog.png" alt="Claude Desktop third-party inference settings" />
<img
src="
/images/claude_desktop_developer_settings.png"
alt="Claude Desktop third-party inference settings"
/>
</Frame>
*/}
6. Restart Claude Desktop.
Send a message to confirm it's working — check the resource's activity in Pangolin's logs if you want to verify traffic is actually flowing through the gateway rather than straight to Anthropic.

20
manage/ai/configure-ai-clients/claude.mdx
View File

@@ -3,6 +3,8 @@ title: "Claude Code"
description: "Connect Claude Code to a Pangolin AI Gateway resource"
---
Claude Code talks the Anthropic Messages API, so the resource you point it at needs an Anthropic-compatible provider attached - Anthropic itself, Bedrock, Vertex AI, or a custom Anthropic-compatible endpoint like Kimi K2. See [AI Gateway Overview](/manage/ai/overview) if you haven't set that up yet.
import AiGatewayKey from "/snippets/ai-gateway-key.mdx";
@@ -37,14 +39,6 @@ To undo it:
pangolin configure claude --reset
```
{/*
Screenshot: `/images/ai/claude-cli-tab.png`
The Claude Code card on a resource's Keys page, expanded, with the CLI tab selected showing the `pangolin configure claude` command.
<Frame>
<img src="/images/ai/claude-cli-tab.png" alt="Claude Code CLI setup" />
</Frame>
*/}
## Manual setup
Pick the preset that matches your provider.
@@ -122,12 +116,4 @@ Use this when the resource has a custom provider pointed at Moonshot AI's Anthro
"ENABLE_TOOL_SEARCH": "false"
}
}
```
{/*
Screenshot: `/images/ai/claude-manual-tab.png`
The same card with the Manual tab selected and the preset dropdown open, showing Default/Bedrock/Vertex/Kimi options.
<Frame>
<img src="/images/ai/claude-manual-tab.png" alt="Claude Code manual setup presets" />
</Frame>
*/}
```

20
manage/ai/configure-ai-clients/codex.mdx
View File

@@ -3,6 +3,8 @@ title: "Codex"
description: "Connect Codex to a Pangolin AI Gateway resource"
---
Codex talks the OpenAI API, so the resource you point it at needs an OpenAI-compatible provider attached — OpenAI, OpenRouter, Vercel AI Gateway, Microsoft Foundry, or a custom OpenAI-compatible endpoint. See [AI Gateway Overview](/manage/ai/overview) if you haven't set that up yet.
import AiGatewayKey from "/snippets/ai-gateway-key.mdx";
@@ -37,14 +39,6 @@ To undo it:
pangolin configure codex --reset
```
{/*
Screenshot: `/images/ai/codex-cli-tab.png`
The Codex card on a resource's Keys page, expanded, with the CLI tab selected showing the `pangolin configure codex` command.
<Frame>
<img src="/images/ai/codex-cli-tab.png" alt="Codex CLI setup" />
</Frame>
*/}
## Manual setup
Merge this into `~/.codex/config.toml` (honors `$CODEX_HOME` if you've set it):
@@ -65,12 +59,4 @@ Codex reads the key from the environment variable named in `env_key`, not from t
export PANGOLIN_API_KEY=<key>
```
Codex is the one client here that also tolerates no key at all: for a private resource you can drop the `env_key` line and skip the export entirely. Exporting `PANGOLIN_API_KEY=none` works too, so use whichever you find clearer.
{/*
Screenshot: `/images/ai/codex-manual-tab.png`
The same card with the Manual tab selected, showing the config.toml snippet.
<Frame>
<img src="/images/ai/codex-manual-tab.png" alt="Codex manual setup" />
</Frame>
*/}
Codex is the one client here that also tolerates no key at all: for a private resource you can drop the `env_key` line and skip the export entirely. Exporting `PANGOLIN_API_KEY=none` works too, so use whichever you find clearer.

18
manage/ai/configure-ai-clients/gemini.mdx
View File

@@ -3,6 +3,8 @@ title: "Gemini CLI"
description: "Connect Gemini CLI to a Pangolin AI Gateway resource"
---
Gemini CLI talks Google's native `generateContent` API, so the resource you point it at needs a Google Gemini (or Vertex AI) provider attached. See [AI Gateway Overview](/manage/ai/overview) if you haven't set that up yet.
import AiGatewayKey from "/snippets/ai-gateway-key.mdx";
@@ -37,14 +39,6 @@ To undo it:
pangolin configure gemini --reset
```
{/*
Screenshot: `/images/ai/gemini-cli-tab.png`
The Gemini CLI card on a resource's Keys page, expanded, with the CLI tab selected showing the `pangolin configure gemini` command.
<Frame>
<img src="/images/ai/gemini-cli-tab.png" alt="Gemini CLI setup" />
</Frame>
*/}
## Manual setup
Write `~/.gemini/.env`:
@@ -64,12 +58,4 @@ export GEMINI_API_KEY=<key>
gemini
```
{/*
Screenshot: `/images/ai/gemini-manual-tab.png`
The same card with the Manual tab selected, showing the .env file and shell snippets.
<Frame>
<img src="/images/ai/gemini-manual-tab.png" alt="Gemini CLI manual setup" />
</Frame>
*/}
For a private resource, keep `GEMINI_API_KEY` in place and set it to `none`. Gemini CLI won't start without it set to something.

2
manage/ai/configure-ai-clients/open-webui.mdx
View File

@@ -3,6 +3,8 @@ title: "Open WebUI"
description: "Connect Open WebUI to a Pangolin AI Gateway resource"
---
Open WebUI is a self-hosted chat interface. It talks the OpenAI API, so point it at an AI Gateway resource that has an OpenAI-compatible provider attached (OpenAI, OpenRouter, Vercel AI Gateway, Microsoft Foundry, or custom). See [AI Gateway Overview](/manage/ai/overview) if you haven't set that up yet.
import AiGatewayKey from "/snippets/ai-gateway-key.mdx";

10
manage/ai/configure-ai-clients/openclaw.mdx
View File

@@ -3,6 +3,8 @@ title: "OpenClaw"
description: "Connect OpenClaw to a Pangolin AI Gateway resource"
---
[OpenClaw](https://openclaw.ai) is an open-source agent gateway that can run against any OpenAI- or Anthropic-compatible endpoint. Point it at an AI Gateway resource with a matching provider attached - OpenAI-compatible (OpenAI, OpenRouter, Vercel AI Gateway, Microsoft Foundry, custom) or Anthropic-compatible (Anthropic, Bedrock, Vertex AI, custom). See [AI Gateway Overview](/manage/ai/overview) if you haven't set that up yet.
import AiGatewayKey from "/snippets/ai-gateway-key.mdx";
@@ -43,14 +45,6 @@ openclaw onboard --install-daemon
When prompted, choose **QuickStart or Manual mode**, select the custom/OpenAI-compatible provider option, and enter the base URL and key.
{/*
Screenshot: `/images/ai/openclaw-onboard.png`
The `openclaw onboard` interactive wizard at the provider selection step.
<Frame>
<img src="/images/ai/openclaw-onboard.png" alt="OpenClaw onboarding wizard" />
</Frame>
*/}
## Manual setup
Onboarding writes `~/.openclaw/openclaw.json`. You can edit it directly instead - changes reload automatically:

20
manage/ai/configure-ai-clients/opencode.mdx
View File

@@ -3,6 +3,8 @@ title: "OpenCode"
description: "Connect OpenCode to a Pangolin AI Gateway resource"
---
OpenCode configures each model provider separately, so it can talk to whichever API formats your resource supports — Anthropic Messages, OpenAI Chat/Responses, or both, depending on which providers are attached. See [AI Gateway Overview](/manage/ai/overview) if you haven't set that up yet.
import AiGatewayKey from "/snippets/ai-gateway-key.mdx";
@@ -37,14 +39,6 @@ To undo it:
pangolin configure opencode --reset
```
{/*
Screenshot: `/images/ai/opencode-cli-tab.png`
The OpenCode card on a resource's Keys page, expanded, with the CLI tab selected showing the `pangolin configure opencode` command.
<Frame>
<img src="/images/ai/opencode-cli-tab.png" alt="OpenCode CLI setup" />
</Frame>
*/}
## Manual setup
Merge this into your global `opencode.json` (`~/.config/opencode/opencode.json`, or `$XDG_CONFIG_HOME/opencode/opencode.json` if set):
@@ -86,12 +80,4 @@ Then merge your key into `auth.json` (`~/.local/share/opencode/auth.json`, or `$
`auth.json` is required even for a private resource. OpenCode refuses to start a provider with no key at all and fails with `OpenAI API key is missing. Pass it using the 'apiKey' parameter or the OPENAI_API_KEY environment variable.` Set the key to `none` rather than leaving the entry out.
</Warning>
Only add entries for the providers your resource actually supports. To point a different OpenCode provider (`openrouter`, `google`, `groq`, etc.) at this gateway, add a matching block under `provider` in `opencode.json` and a matching key in `auth.json`.
{/*
Screenshot: `/images/ai/opencode-manual-tab.png`
The same card with the Manual tab selected, showing the opencode.json/auth.json snippets.
<Frame>
<img src="/images/ai/opencode-manual-tab.png" alt="OpenCode manual setup" />
</Frame>
*/}
Only add entries for the providers your resource actually supports. To point a different OpenCode provider (`openrouter`, `google`, `groq`, etc.) at this gateway, add a matching block under `provider` in `opencode.json` and a matching key in `auth.json`.

26
manage/ai/overview.mdx
View File

@@ -3,6 +3,8 @@ title: "AI Gateway Overview"
description: "Route coding agents and AI clients through Pangolin with centralized providers and keys"
---
An AI Gateway resource is a normal Pangolin resource that proxies requests to one or more upstream AI providers (OpenAI, Anthropic, Google Gemini, Bedrock, Vertex AI, or a custom endpoint). Point a client at the resource's URL instead of the provider's, and Pangolin handles auth, access control, and logging in front of it.
## How it fits together
@@ -17,26 +19,10 @@ A resource only understands the API format(s) its attached providers support. An
Create an org-level provider so the gateway has an upstream to call. Sidebar → **AI Gateway** → **Providers** → **Create**, or follow the [AI Providers](/manage/ai/providers/overview) guide. Pick a type, paste in its API key, and save. You can add as many as you need.
{/*
Screenshot: `/images/ai/create-provider.png`
The AI Gateway → Providers → Create form, showing the provider type dropdown and API key field filled in for OpenAI or Anthropic.
<Frame>
<img src="/images/ai/create-provider.png" alt="Creating an AI provider" />
</Frame>
*/}
## 2. Create a resource
Resources → **Create** → set **Type** to **AI Gateway**, pick a domain, and attach the provider(s) from step 1. You can also attach providers to an existing resource later from its **AI Gateway** settings tab.
{/*
Screenshot: `/images/ai/create-resource.png`
The new resource dialog with Type set to "AI Gateway" and a provider selected in the AI Providers section.
<Frame>
<img src="/images/ai/create-resource.png" alt="Creating an AI Gateway resource" />
</Frame>
*/}
## 3. Get a key
How a client authenticates depends on whether the resource is public or private.
@@ -56,14 +42,6 @@ Only reachable from devices connected to your Pangolin network, so no key is che
You still have to put *something* in the client's key field. Most AI clients refuse to start with no key set at all, so use the literal string `none`. Deleting the field usually breaks things - Claude Code, for instance, silently falls back to your regular Anthropic account if `apiKeyHelper` is missing, and OpenCode errors out with `OpenAI API key is missing`.
{/*
Screenshot: `/images/ai/api-keys-panel.png`
The resource launcher's API Keys panel, showing the Identity Key section and the "Configure Coding Agents" cards below it.
<Frame>
<img src="/images/ai/api-keys-panel.png" alt="Resource API Keys panel" />
</Frame>
*/}
## 4. Connect a client
Every resource's Keys page has ready-to-copy setup for common clients, and `pangolin configure <client>` can write the config for you. Full instructions per client:

2
manage/alerting/alert-rules.mdx
View File

@@ -3,9 +3,7 @@ title: "Alert Rules"
description: "Subscribe to Pangolin events on sites, resources, and health checks and deliver email, webhooks, or integrations"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
Only available in [Pangolin Cloud](https://app.pangolin.net/auth/signup) and [Enterprise Edition](/self-host/enterprise-edition).

2
manage/alerting/health-checks.mdx
View File

@@ -3,9 +3,7 @@ title: "Health Checks"
description: "Monitor reachability and response for public resource targets and arbitrary endpoints from your sites"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
A health check is a periodic probe that decides whether something on your network is up and responding the way you expect. Pangolin runs these checks from your sites so they reflect reachability from the connector’s perspective, not only from wherever an administrator happens to be.

7
manage/analytics/access.mdx
View File

@@ -2,13 +2,6 @@
title: "Authentication Logs"
description: "Authentication logs are a record of each authenticated access attempt to a resource"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Authentication logs provide detailed information about each access attempt made to your Pangolin resources. These logs help you monitor and analyze user activity each time they attempt to authenticate.
<Note>

7
manage/analytics/action.mdx
View File

@@ -2,13 +2,6 @@
title: "Admin Action Logs"
description: "Admin Action logs are a record of each event taken by users in the organization"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Admin Action logs provide an audit trail of administrative actions and configuration changes made within your Pangolin organization. These logs help you track who made what changes and when.
<Note>

2
manage/analytics/connection.mdx
View File

@@ -3,9 +3,7 @@ title: "Network Logs"
description: "Network logs are a record of TCP and UDP sessions between clients and private resources on sites"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Network logs record each TCP and UDP session that traverses the tunnel between Pangolin clients and resources on your sites. They apply to private resources reached through the Pangolin client (and related tunnel traffic), not to public resources served only through the reverse proxy. You can see which clients and users opened sessions to which private resources, the source and destination addresses and protocols (TCP and UDP), the start and end times of the sessions, and more.

7
manage/analytics/request.mdx
View File

@@ -2,13 +2,6 @@
title: "HTTPS Request Logs"
description: "Request logs are a record of each HTTP request to a resource"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
HTTPS Request logs provide detailed information about every HTTP request made to your Pangolin resources. These logs capture both successful and denied requests along with comprehensive request metadata.
## What are HTTPS Request Logs?

2
manage/analytics/streaming.mdx
View File

@@ -3,9 +3,7 @@ title: "Event Streaming"
description: "Stream Pangolin log events to external collectors and SIEM tools"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Log streaming forwards your organization's audit logs to external data collectors such as Datadog, Splunk, Microsoft Sentinel, Elastic, or any HTTP endpoint you operate. You add a **destination** (how events are delivered), choose which **log types** to include, and Pangolin pushes new events as they are recorded.

2
manage/analytics/streaming/http.mdx
View File

@@ -3,9 +3,7 @@ title: "HTTP webhook"
description: "Forward audit logs to any HTTP endpoint with optional custom body templates"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
HTTP destinations POST your organization’s audit logs to a URL you control. Use them for generic webhooks, Splunk HEC, Elastic or OpenSearch ingest, Grafana Loki push endpoints, or any receiver that accepts JSON over HTTP.

2
manage/analytics/streaming/s3.mdx
View File

@@ -3,9 +3,7 @@ title: "Amazon S3"
description: "Archive audit logs to S3 or S3-compatible object storage"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
S3 destinations upload batches of your organization's audit logs as objects in a bucket you control. Use them for long-term archival, data lakes (Athena, Glue, BigQuery), or S3-compatible stores such as MinIO and Cloudflare R2.

7
manage/asnblocking.mdx
View File

@@ -2,13 +2,6 @@
title: "ASN Blocking"
description: "Configure ASN blocking to restrict access based on Autonomous System Numbers"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
ASN blocking is available in Pangolin Community Edition. It depends on Pangolin's ASN lookup database. Follow [Enable ASN Lookup](/self-host/advanced/enable-asn-lookup) before creating ASN rules.
</Note>

2
manage/blueprints.mdx
View File

@@ -3,9 +3,7 @@ title: "Blueprints"
description: "Define Pangolin resources and site settings declaratively with YAML or container labels"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Blueprints let you define Pangolin resources as code. Instead of configuring every site, target, and access rule manually in the dashboard, you describe the desired state in YAML or container labels and let Pangolin apply it consistently.

7
manage/branding.mdx
View File

@@ -3,13 +3,6 @@ title: "Branding"
icon: "brush"
description: "Learn how to customize the look your Pangolin dashboard and login pages with custom branding"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
Branding is only available in [Enterprise Edition](/self-host/enterprise-edition).
</Note>

7
manage/clients/archiving-blocking.mdx
View File

@@ -2,13 +2,6 @@
title: "Archiving & Blocking"
description: "Manage clients and block unwanted connections"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
## Blocking Devices
To block a device that has been compromised or lost:

7
manage/clients/client-logs.mdx
View File

@@ -2,13 +2,6 @@
title: "Client Logs"
description: "View Pangolin client logs on Windows, Mac, Linux, Android, and iOS"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
How you access client logs depends on the platform. Use the section for your client type below.
## Windows

7
manage/clients/configure-client.mdx
View File

@@ -2,13 +2,6 @@
title: "Configure Clients"
description: "Configure Olm for connecting to Pangolin clients"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
## GUI Clients (Mac, Windows, Android, iOS/iPadOS)
Each respective client has a preferences window with all currently available configuration parameters. In your desktop client, click the menu bar or system tray icon, select "More" in the menu, and click "Preferences". In the mobile apps, navigate to the "Settings" screen.

7
manage/clients/credentials.mdx
View File

@@ -2,13 +2,6 @@
title: "Client Credentials"
description: "Understanding how client credentials work and how they can be rotated & regenerated"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
## Understanding Credentials
Every machine client is provisioned with a unique identifier (ID), secret, and endpoint. The client uses the combination of these three to establish a secure, encrypted connection to the server.

7
manage/clients/fingerprinting.mdx
View File

@@ -3,13 +3,6 @@ title: 'Client Fingerprinting'
description:
'A summary of device information that is collected during the connection'
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
## Device Fingerprinting
Pangolin clients collect device fingerprinting information and can perform

2
manage/clients/firewalls.mdx
View File

@@ -3,9 +3,7 @@ title: "Firewall Quirks"
description: "Improve Pangolin direct-connect success behind restrictive firewalls"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Most of the time, Pangolin works with existing firewall policies without any special tuning. Newt and Pangolin clients attempt NAT traversal first so traffic can flow directly between client and site. When direct connectivity cannot be established, traffic falls back to relaying through Gerbil. You can [learn more about how holepunching works here](https://pangolin.net/news/nat-holepunching).

7
manage/clients/install-client.mdx
View File

@@ -2,13 +2,6 @@
title: "Install Clients"
description: "Install native clients for Mac, Windows, and Linux"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
## Windows
- [Pangolin for Windows Installer](https://pangolin.net/downloads/windows) - This is the official page to download the latest installer file for Windows.

7
manage/clients/nat-traversal.mdx
View File

@@ -2,13 +2,6 @@
title: "NAT Traversal"
description: "How clients connect on the same network, hole punch through NAT, or relay through Pangolin"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
When a client connects to a site, Pangolin tries to establish the most direct path possible. If the client and site are on the same local network, they form a direct peer-to-peer connection on that network. Otherwise, the client attempts NAT hole punching before falling back to relaying.
## Same Network Detection

7
manage/clients/understanding-clients.mdx
View File

@@ -2,13 +2,6 @@
title: "Understanding Clients"
description: "Create a client to connect to your Pangolin network from a remote computer"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
A client is a way to access resources on sites remotely and privately via a virtual private network. Clients are used with private resources to faciliate zero-trust network access.
By default a client does not have access to any hosts on the local network of the site. Admins must explicitly define resources on the site and give specific users and roles access to the resources.

7
manage/clients/update-client.mdx
View File

@@ -2,13 +2,6 @@
title: "Update Clients"
description: "Update your installed client to the latest version"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
## Mac and Windows
### Automatic Updates (Recommended)

2
manage/community-blueprints-repo.mdx
View File

@@ -3,9 +3,7 @@ title: "Community Blueprints"
description: "Community-maintained library of ready-to-use Pangolin Blueprints for self-hosted applications"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
The Pangolin Community Blueprints repository is a shared library of ready-to-use Docker Compose templates for common self-hosted services, already wired to expose those services through Pangolin.

2
manage/dns-cache.mdx
View File

@@ -3,9 +3,7 @@ title: "DNS Cache"
description: "What is a DNS cache and how to manage it with private resources"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
## What is a DNS Cache?
A DNS cache is a temporary storage of DNS records that allows for faster resolution of domain names to IP addresses. When a user visits a website, their device queries the DNS server to resolve the domain name to an IP address. The DNS cache stores this information so that subsequent requests for the same domain can be resolved more quickly without needing to query the DNS server again.

7
manage/domains.mdx
View File

@@ -3,13 +3,6 @@ title: "Domains"
icon: "globe"
description: "Learn how to configure domains for your Pangolin resources and understand the different domain types available"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Domains allow you to access your Pangolin resources through custom URLs. Pangolin supports different domain types depending on your deployment model and requirements.
## Getting Started

2
manage/endpoints-and-pops.mdx
View File

@@ -4,9 +4,7 @@ icon: "network-wired"
description: "Pangolin Cloud hostnames for firewall allowlists and network whitelisting"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
This page applies to [Pangolin Cloud](https://app.pangolin.net/auth/signup) only. If you self-host Pangolin, see [DNS & Networking](/self-host/dns-and-networking) for the hostnames and ports on your own deployment.

7
manage/geoblocking.mdx
View File

@@ -2,13 +2,6 @@
title: "Geo-blocking"
description: "Configure geo-blocking to restrict access based on geographic location"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
Geo-blocking is available in Pangolin Community Edition. It depends on Pangolin's geo-location database, which is also used by other location-aware features such as analytics. Follow [Enable Geo-location](/self-host/advanced/enable-geolocation) before creating country or region rules.
</Note>

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

@@ -3,9 +3,7 @@ title: "Add Identity Providers"
description: "Configure external identity providers for user authentication to resources and the organization"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Identity providers allow your users to log into Pangolin and Pangolin resources using their existing accounts from external identity systems like Google, Microsoft Azure, or Okta. Instead of creating separate Pangolin accounts, users can authenticate with their familiar work or personal credentials.

2
manage/identity-providers/auto-provisioning.mdx
View File

@@ -3,9 +3,7 @@ title: "Auto Provisioning"
description: "Automatically create and manage user accounts from external identity providers"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Auto provisioning is a feature that allows you to automatically create and manage user accounts in Pangolin when they log in using an external identity provider rather than pre-provisioning (manually creating) a user with a role and organization. This is useful for organizations that want to streamline the onboarding process for new users and ensure that their user accounts are always up-to-date.

7
manage/identity-providers/azure.mdx
View File

@@ -2,13 +2,6 @@
title: "Azure Entra ID"
description: "Configure Azure Entra ID Single Sign-On"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
Azure SSO is only available on [Pangolin Cloud](https://app.pangolin.net/auth/signup) and [Enterprise Edition](/self-host/enterprise-edition) deployments. In [Enterprise Edition](/self-host/enterprise-edition), you must set `app.identity_provider_mode: "org"` in your [private config file](/self-host/advanced/private-config-file) `privateConfig.yml`.
</Note>

7
manage/identity-providers/google.mdx
View File

@@ -2,13 +2,6 @@
title: "Google"
description: "Configure Google Single Sign-On"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
Google SSO is only available on [Pangolin Cloud](https://app.pangolin.net/auth/signup) and [Enterprise Edition](/self-host/enterprise-edition) deployments. In [Enterprise Edition](/self-host/enterprise-edition), you must set `app.identity_provider_mode: "org"` in your [private config file](/self-host/advanced/private-config-file#param-use-org-only-idp) `privateConfig.yml`.
</Note>

7
manage/identity-providers/openid-connect.mdx
View File

@@ -2,13 +2,6 @@
title: "OAuth2/OIDC"
description: "Configure OpenID Connect identity provider for external authentication"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
This identity provider follows the OpenID Connect protocol. This means that it can be used to connect to any external identity provider that supports the OpenID Connect protocol such as Authentik, Keycloak, Okta, etc.
## Creating a Generic OAuth2/OIDC IdP in Pangolin

7
manage/identity-providers/pocket-id.mdx
View File

@@ -2,13 +2,6 @@
title: "Pocket ID"
description: "Configure Pocket ID Single Sign-On using OpenID Connect"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
The following steps will integrate Pocket ID with Pangolin SSO using OpenID Connect (OIDC).
## Prerequisites

7
manage/identity-providers/zitadel.mdx
View File

@@ -2,13 +2,6 @@
title: "Zitadel"
description: "Configure Zitadel Single Sign-On using OpenID Connect"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
The following steps will integrate Zitadel with Pangolin SSO using OpenID Connect (OIDC).
## Prerequisites

9
manage/integration-api.mdx
View File

@@ -2,14 +2,7 @@
title: "Integration API"
icon: "cube"
description: "Learn how to use Pangolin's REST API to automate and script operations with fine-grained permissions"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Warning>
---<Warning>
Pangolin is in heavy development. The REST API routes and behavior may include breaking changes between updates. We will do our best to document large changes.
</Warning>

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

@@ -2,13 +2,6 @@
title: "Integration API"
description: "Learn how to use Pangolin's REST API to automate and script operations with fine-grained permissions"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
The API is REST-based and supports many operations available through the web interface. Authentication uses Bearer tokens, and you can create multiple API keys with specific permissions for different use cases.
<Info>

2
manage/labels.mdx
View File

@@ -3,9 +3,7 @@ title: "Labels"
description: "Attach reusable string labels to sites, clients, and resources for metadata, search, and filtering"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
Only available in [Pangolin Cloud](https://app.pangolin.net/auth/signup) and [Enterprise Edition](/self-host/enterprise-edition).

7
manage/organizations/org-id.mdx
View File

@@ -2,13 +2,6 @@
title: "Organization ID"
description: "Understand organization IDs and how to locate yours in the dashboard"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Pangolin is multi-tenant. All sites, resources, clients, and other items belong to an organization, and a server can host more than one organization.
Each organization has a unique ID that Pangolin generates when you create the organization. You cannot change the ID after creation, and it is separate from the display name.

7
manage/remote-node/backhaul.mdx
View File

@@ -2,13 +2,6 @@
title: "Site to Cloud"
description: "Turn a remote node into a network concentrator that routes traffic between a cloud VPC and your Pangolin sites"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
Site to cloud is an advanced [remote node](/manage/remote-node/understanding-nodes) configuration available in [Pangolin Cloud](https://app.pangolin.net/auth/signup).
</Note>

7
manage/remote-node/config-file.mdx
View File

@@ -2,13 +2,6 @@
title: "Configuration File"
description: "Configure your remote node using the config.yml file"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
The `config.yml` file includes basic config variable for your remote node. This file is mounted at `config/config.yml` in your Docker container.
Minimal configuration file:

7
manage/remote-node/quick-install-remote.mdx
View File

@@ -2,13 +2,6 @@
title: "Quick Install Guide"
description: "Deploy your own remote Pangolin node in under 10 minutes with our automated installer"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
## Prerequisites
Before you begin, ensure you have:

7
manage/remote-node/understanding-nodes.mdx
View File

@@ -2,13 +2,6 @@
title: "Remote Nodes"
description: "Control your own Pangolin node with cloud management"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
Remote Nodes are available in [Pangolin Cloud](https://app.pangolin.net/auth/signup).
</Note>

7
manage/resources/private/alias.mdx
View File

@@ -2,13 +2,6 @@
title: "Aliases"
description: "Friendly names for resources, overlaps, loopback on the site host, and DNS behavior"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Aliases provide a secondary, user-friendly address for any of your resources, allowing users to access the resource using this alternate name in addition to the original address.
For instance, a router with the address `10.0.0.1` could be assigned the alias `router.internal`, and users could connect using either. Aliases are accessible to anyone who has access to the resource, and they are exclusively accessible when connected with a Pangolin client, meaning they function without requiring any external DNS record setup. Furthermore, aliases are protocol agnostic, which means they will work with any network protocol, essentially acting as a pseudo-A record for an address that is only functional within the Pangolin environment.

7
manage/resources/private/authentication.mdx
View File

@@ -2,13 +2,6 @@
title: "Authentication"
description: "Only allow access to resources to specific users, roles, and machines"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
When a client connects into an organization they will NOT have access to any resources by default. Access must be explicitly granted to users, roles, or machines for a tunnel to be established to the site(s) hosting the resource. The client will show no sites or resources unless access is granted.
Access can be granted in several ways:

2
manage/resources/private/cidr.mdx
View File

@@ -3,9 +3,7 @@ title: "CIDR"
description: "Route client traffic to an entire IP range on the remote network"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
A CIDR private resource exposes an entire IP range on your remote network to connected Pangolin clients. When a user connects with the Pangolin client and has access to the resource, the client installs a route for that prefix and all traffic to addresses within the range is carried over the tunnel.

2
manage/resources/private/destinations.mdx
View File

@@ -3,9 +3,7 @@ title: "Destinations"
description: "What a private resource destination is and how to define it (FQDN, IP, or CIDR)"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
## What is a destination?

2
manage/resources/private/host.mdx
View File

@@ -3,9 +3,7 @@ title: "Host"
description: "Route client traffic to a single IP address or FQDN on the remote network"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
A host private resource exposes a single machine on your remote network to connected Pangolin clients. When a user connects with the Pangolin client and has access to the resource, traffic destined for that host is carried over the tunnel to the site, which delivers it on the remote network.

7
manage/resources/private/multi-site-routing.mdx
View File

@@ -2,13 +2,6 @@
title: "Multi-site Routing and High Availability"
description: "Use multiple sites on a private resource for resilient routing and failover"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
When you configure a private resource, you can attach more than one site. Pangolin then chooses how to reach the resource’s destination through those sites, similar in spirit to running multiple connectors into the same network: traffic is steered toward whichever path is most suitable at the time.
### How Routing Works

2
manage/resources/private/port-restrictions.mdx
View File

@@ -3,9 +3,7 @@ title: "Ports and ICMP"
description: "Configure TCP and UDP port modes and ICMP (ping) for private resources"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
For each private resource, TCP and UDP are configured separately. Each protocol uses one of three modes: All, Blocked, or Custom. ICMP (ping) is controlled on its own and does not follow those TCP/UDP modes.

2
manage/resources/private/private-http.mdx
View File

@@ -3,9 +3,7 @@ title: "HTTP / HTTPS"
description: "Private reverse proxy with optional TLS termination at the site edge over the Pangolin tunnel"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
Only available in [Pangolin Cloud](https://app.pangolin.net/auth/signup) and [Enterprise Edition](/self-host/enterprise-edition).

2
manage/resources/private/ssh.mdx
View File

@@ -3,9 +3,7 @@ title: "SSH"
description: "Connect to remote hosts over the Pangolin tunnel using the Pangolin CLI"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
Only available in [Pangolin Cloud](https://app.pangolin.net/auth/signup) and [Enterprise Edition](/self-host/enterprise-edition).

7
manage/resources/public/authentication.mdx
View File

@@ -2,13 +2,6 @@
title: "Authentication"
description: "Create identity and context aware rules to allow access"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Though public resources are public and accessible to via a web browser, admins can create rules to enable a layer of authenticated protection in front of public resources. By default, all public resources have Pangolin auth (Platform SSO) enabled, but a number of other authentication methods are available.
You can configure these settings directly on each resource or share them across multiple resources with a [resource policy](/manage/resources/public/resource-policies). A resource either uses an inline policy (no shared policy attached) or inherits a shared policy and can add resource-specific overrides on top.

2
manage/resources/public/healthchecks-failover.mdx
View File

@@ -3,9 +3,7 @@ title: "Health Checks and Failover"
description: "Monitor public resource targets and automatically remove unhealthy targets from routing"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Health checks for public resources monitor each target and keep bad targets out of traffic automatically. When a target fails its check, Pangolin marks it unhealthy and removes it from load balancing. When it recovers and passes again, Pangolin adds it back.

2
manage/resources/public/http-https.mdx
View File

@@ -3,9 +3,7 @@ title: "HTTP / HTTPS"
description: "Publish websites, APIs, and dashboards as authenticated public reverse proxies"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
HTTP and HTTPS public resources are the most common public resource type. They expose a web application or API on a fully qualified domain name with a valid TLS certificate, fronted by Pangolin's authenticated reverse proxy.

7
manage/resources/public/maintenance.mdx
View File

@@ -2,13 +2,6 @@
title: "Maintenance Page"
description: "Show a maintenance page to users when a resources is down for maintenance or targets are unhealthy"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
Maintenance pages are only available in [Enterprise Edition](/self-host/enterprise-edition).
</Note>

2
manage/resources/public/raw-resources.mdx
View File

@@ -3,9 +3,7 @@ title: "TCP / UDP"
description: "Expose raw TCP and UDP services on a Pangolin server port without authentication"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
TCP and UDP public resources are protocol-agnostic proxies. Unlike HTTP/HTTPS, SSH, RDP, and VNC, they do **not** receive a fully qualified domain name or TLS certificate. Instead, each resource binds to a port on the Pangolin server host. Clients connect to `<pangolin-server>:<port>` and traffic is forwarded to the downstream service through a site connector.

2
manage/resources/public/rdp.mdx
View File

@@ -3,9 +3,7 @@ title: "RDP"
description: "Control a Windows computer remotely through a full RDP client rendered in the browser"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
Only available in [Pangolin Cloud](https://app.pangolin.net/auth/signup) and [Enterprise Edition](/self-host/enterprise-edition).

2
manage/resources/public/resource-policies.mdx
View File

@@ -3,9 +3,7 @@ title: "Resource Policies"
description: "Share authentication and access rule settings across multiple public resources"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
Only available in [Pangolin Cloud](https://app.pangolin.net/auth/signup) and [Enterprise Edition](/self-host/enterprise-edition).

2
manage/resources/public/ssh.mdx
View File

@@ -3,9 +3,7 @@ title: "SSH"
description: "Access a remote shell in the browser with password, key, or Pangolin identity authentication"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
Only available in [Pangolin Cloud](https://app.pangolin.net/auth/signup) and [Enterprise Edition](/self-host/enterprise-edition).

7
manage/resources/public/targets.mdx
View File

@@ -2,13 +2,6 @@
title: "Targets"
description: "Configure destination endpoints for resource routing and load balancing"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
When you create a resource in Pangolin, you define different targets that specify where traffic should be routed within your network. Each target represents a specific destination that the resource can proxy to when handling incoming requests.
## How Targets Work

2
manage/resources/public/vnc.mdx
View File

@@ -3,9 +3,7 @@ title: "VNC"
description: "View and control a remote display through a VNC client rendered in the browser"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
Only available in [Pangolin Cloud](https://app.pangolin.net/auth/signup) and [Enterprise Edition](/self-host/enterprise-edition).

2
manage/resources/public/wildcard-resources.mdx
View File

@@ -3,9 +3,7 @@ title: "Wildcard Resources"
description: "Pangolin Cloud and Enterprise: route every hostname at a subdomain level through one public resource"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
Only available in [Pangolin Cloud](https://app.pangolin.net/auth/signup) and [Enterprise Edition](/self-host/enterprise-edition).

2
manage/resources/understanding-resources.mdx
View File

@@ -3,9 +3,7 @@ title: "Understanding Resources"
description: "Resources are any network address you want to make available to users"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Resources represent the applications, hosts, or ranges you make available for remote access to users. Resources exist on the remote networks of your sites. Users only ever think about connecting to resources and not specific sites.

2
manage/sites/auto-update.mdx
View File

@@ -3,9 +3,7 @@ title: "Automatic Site Updates"
description: "Let Newt sites check for and install updates on their own"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
Only available in [Pangolin Cloud](https://app.pangolin.net/auth/signup) and [Enterprise Edition](/self-host/enterprise-edition).

2
manage/sites/configure-site.mdx
View File

@@ -3,9 +3,7 @@ title: "Configure Sites"
description: "Configure Newt for connecting to Pangolin sites"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
## Flags

7
manage/sites/credentials.mdx
View File

@@ -2,13 +2,6 @@
title: "Site Credentials"
description: "Understanding how site credentials work and how they can be rotated & regenerated"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
## Understanding Credentials
Every site is provisioned with a unique identifier (ID), secret, and endpoint. The site uses the combination of these three to establish a secure, encrypted connection to the server.

7
manage/sites/install-site.mdx
View File

@@ -2,13 +2,6 @@
title: "Install Sites"
description: "Install Newt as a binary or Docker container"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Newt can be installed as either a static binary executable or a Docker container. You must first create a site and copy the Newt config in Pangolin before running Newt.
## Binary Installation

Some files were not shown because too many files have changed in this diff Show More