Documentation Index
Fetch the complete documentation index at: https://docs.pangolin.net/llms.txt
Use this file to discover all available pages before exploring further.
Try free on Pangolin Cloud
Fastest way to get started with Pangolin using the hosted control plane. No credit card required.
Components
| Component | Role |
|---|---|
| Pangolin | Main application for the dashboard, API, authentication, configuration, and database-backed state. |
| Gerbil | Tunnel stack component used by Pangolin for site connectivity. |
| Site (Newt) | Site connector used to connect private resources to Pangolin. |
| Traefik | Reverse proxy and router for ingress traffic. |
| PostgreSQL / SQLite | Database options for Pangolin deployments, depending on the selected chart configuration. |
| Pangolin Kube Controller | Kubernetes controller for integrating Pangolin with Kubernetes and Traefik resources. |
Depending on your deployment mode, not every component is required. Local reverse proxy deployments and tunneled site deployments can have different component requirements.
Installation paths
Choose an Installation Path
Pick the Kubernetes workflow that matches how you deploy applications.
Prerequisites
Review the required cluster, ingress, DNS, storage, and secret setup.
Helm Quick-Start
Install Pangolin or Sites (Newt) with the standard chart-based workflow.
Kustomize Quick-Start
Use overlays and patches for manifest-based deployments.
Argo CD Guide
Deploy Pangolin or Sites (Newt) with Argo CD.
Flux Guide
Deploy Pangolin or Sites (Newt) with Flux.
Helmfile Guide
Manage multiple Helm releases together.
Component guides
Pangolin with Helm
Install Pangolin with the Helm chart.
Pangolin Configuration
Configure Pangolin for your Kubernetes environment.
Pangolin Troubleshooting
Diagnose and resolve Pangolin deployment issues.
Site (Newt) Helm
Install a Site connector with the Newt Helm chart.
Site (Newt) Configuration
Configure Site connector credentials and runtime settings.
Site (Newt) Troubleshooting
Diagnose and resolve Site connector deployment issues.