# Pangolin Docs

> Zero trust access to all your infrastructure, self-hosted applications, and SaaS tools. Easy to deploy and scale. Better than your existing VPN.

## Docs

- [How Pangolin Works](https://docs.pangolin.net/about/how-pangolin-works.md): Learn about the fundamentals of Pangolin and how they work together to provide simple and secure remote access.
- [Pangolin vs. Proxy vs. VPN](https://docs.pangolin.net/about/pangolin-vs-reverse-proxy-vs-vpn.md): What are the similarities and differences between Pangolin and traditional reverse proxies and VPNs?
- [Contribution Guide](https://docs.pangolin.net/development/contributing.md): Set up your local development environment for contributing to Pangolin
- [Feature Requests & Bug Reports](https://docs.pangolin.net/development/feature-requests-and-bug-reports.md): How to submit feature requests and report bugs for Pangolin
- [System Architecture](https://docs.pangolin.net/development/system-architecture.md): A technical overview of how Pangolin's control plane, nodes, connectors, and clients fit together
- [Device Approvals](https://docs.pangolin.net/manage/access-control/approvals.md): Only allow trusted devices to connect to an organization
- [Change Password](https://docs.pangolin.net/manage/access-control/change-password.md): Change or reset your Pangolin account password
- [Users and Roles](https://docs.pangolin.net/manage/access-control/create-user.md): Add internal or external users to your organization and manage roles
- [Forwarded Headers](https://docs.pangolin.net/manage/access-control/forwarded-headers.md): Learn how Pangolin forwards user identity information to your backend applications through HTTP headers
- [Shareable Links](https://docs.pangolin.net/manage/access-control/links.md): Create Links and use access tokens for browser or programmatic access.
- [Custom Login Page](https://docs.pangolin.net/manage/access-control/login-page.md): Configure a custom authentication page URL for your organization
- [Multi-Factor Authentication](https://docs.pangolin.net/manage/access-control/mfa.md): Enable and manage two-factor authentication and enforcement for your organization
- [Password Rotation](https://docs.pangolin.net/manage/access-control/password-rotation.md): Configure password expiration and rotation requirements for your organization
- [Rules](https://docs.pangolin.net/manage/access-control/rules.md): Configure rules to allow or deny access to resources without authentication
- [Security Keys](https://docs.pangolin.net/manage/access-control/security-keys.md): Use security keys for passwordless login to your Pangolin account
- [Session Length](https://docs.pangolin.net/manage/access-control/session-length.md): Configure maximum session length and expiration policies for your organization
- [Alert Rules](https://docs.pangolin.net/manage/alerting/alert-rules.md): Subscribe to Pangolin events on sites, resources, and health checks and deliver email, webhooks, or integrations
- [Health Checks](https://docs.pangolin.net/manage/alerting/health-checks.md): Monitor reachability and response for public resource targets and arbitrary endpoints from your sites
- [Authentication Logs](https://docs.pangolin.net/manage/analytics/access.md): Authentication logs are a record of each authenticated access attempt to a resource
- [Admin Action Logs](https://docs.pangolin.net/manage/analytics/action.md): Admin Action logs are a record of each event taken by users in the organization
- [Network Logs](https://docs.pangolin.net/manage/analytics/connection.md): Network logs are a record of TCP and UDP sessions between clients and private resources on sites
- [HTTPS Request Logs](https://docs.pangolin.net/manage/analytics/request.md): Request logs are a record of each HTTP request to a resource
- [Event Streaming](https://docs.pangolin.net/manage/analytics/streaming.md): Stream Pangolin log events to external collectors and SIEM tools
- [HTTP webhook](https://docs.pangolin.net/manage/analytics/streaming/http.md): Forward audit logs to any HTTP endpoint with optional custom body templates
- [Amazon S3](https://docs.pangolin.net/manage/analytics/streaming/s3.md): Archive audit logs to S3 or S3-compatible object storage
- [ASN Blocking](https://docs.pangolin.net/manage/asnblocking.md): Configure ASN blocking to restrict access based on Autonomous System Numbers
- [Blueprints](https://docs.pangolin.net/manage/blueprints.md): Define Pangolin resources and site settings declaratively with YAML or container labels
- [Branding](https://docs.pangolin.net/manage/branding.md): Learn how to customize the look your Pangolin dashboard and login pages with custom branding
- [Archiving & Blocking](https://docs.pangolin.net/manage/clients/archiving-blocking.md): Manage clients and block unwanted connections
- [Client Logs](https://docs.pangolin.net/manage/clients/client-logs.md): View Pangolin client logs on Windows, Mac, Linux, Android, and iOS
- [Configure Clients](https://docs.pangolin.net/manage/clients/configure-client.md): Configure Olm for connecting to Pangolin clients
- [Client Credentials](https://docs.pangolin.net/manage/clients/credentials.md): Understanding how client credentials work and how they can be rotated & regenerated
- [Client Fingerprinting](https://docs.pangolin.net/manage/clients/fingerprinting.md): A summary of device information that is collected during the connection
- [Firewall Quirks](https://docs.pangolin.net/manage/clients/firewalls.md): Improve Pangolin direct-connect success behind restrictive firewalls
- [Install Clients](https://docs.pangolin.net/manage/clients/install-client.md): Install native clients for Mac, Windows, and Linux
- [NAT Traversal](https://docs.pangolin.net/manage/clients/nat-traversal.md): How clients connect directly to sites or relay through Pangolin, and how to improve reliability
- [Understanding Clients](https://docs.pangolin.net/manage/clients/understanding-clients.md): Create a client to connect to your Pangolin network from a remote computer
- [Update Clients](https://docs.pangolin.net/manage/clients/update-client.md): Update your installed client to the latest version
- [Common API Routes](https://docs.pangolin.net/manage/common-api-routes.md): API routes and patterns for the most common actions and flows
- [Community Blueprints](https://docs.pangolin.net/manage/community-blueprints-repo.md): Community-maintained library of ready-to-use Pangolin Blueprints for self-hosted applications
- [Domains](https://docs.pangolin.net/manage/domains.md): Learn how to configure domains for your Pangolin resources and understand the different domain types available
- [Endpoints & Relays](https://docs.pangolin.net/manage/endpoints-and-pops.md): Pangolin Cloud hostnames for firewall allowlists and network whitelisting
- [Geo-blocking](https://docs.pangolin.net/manage/geoblocking.md): Configure geo-blocking to restrict access based on geographic location
- [Add Identity Providers](https://docs.pangolin.net/manage/identity-providers/add-an-idp.md): Configure external identity providers for user authentication to resources and the organization
- [Auto Provisioning](https://docs.pangolin.net/manage/identity-providers/auto-provisioning.md): Automatically create and manage user accounts from external identity providers
- [Azure Entra ID](https://docs.pangolin.net/manage/identity-providers/azure.md): Configure Azure Entra ID Single Sign-On
- [Google](https://docs.pangolin.net/manage/identity-providers/google.md): Configure Google Single Sign-On
- [OAuth2/OIDC](https://docs.pangolin.net/manage/identity-providers/openid-connect.md): Configure OpenID Connect identity provider for external authentication
- [Integration API](https://docs.pangolin.net/manage/integration-api.md): Learn how to use Pangolin's REST API to automate and script operations with fine-grained permissions
- [Labels](https://docs.pangolin.net/manage/labels.md): Attach reusable string labels to sites, clients, and resources for metadata, search, and filtering
- [Organization ID](https://docs.pangolin.net/manage/organizations/org-id.md): Understand organization IDs and how to locate yours in the dashboard
- [Site to Cloud](https://docs.pangolin.net/manage/remote-node/backhaul.md): Turn a remote node into a network concentrator that routes traffic between a cloud VPC and your Pangolin sites
- [Configuration File](https://docs.pangolin.net/manage/remote-node/config-file.md): Configure your remote node using the config.yml file
- [Quick Install Guide](https://docs.pangolin.net/manage/remote-node/quick-install-remote.md): Deploy your own remote Pangolin node in under 10 minutes with our automated installer
- [Remote Nodes](https://docs.pangolin.net/manage/remote-node/understanding-nodes.md): Control your own Pangolin node with cloud management
- [Aliases](https://docs.pangolin.net/manage/resources/private/alias.md): Friendly names for resources, overlaps, loopback on the site host, and DNS behavior
- [Authentication](https://docs.pangolin.net/manage/resources/private/authentication.md): Only allow access to resources to specific users, roles, and machines
- [CIDR](https://docs.pangolin.net/manage/resources/private/cidr.md): Route client traffic to an entire IP range on the remote network
- [Destinations](https://docs.pangolin.net/manage/resources/private/destinations.md): What a private resource destination is and how to define it (FQDN, IP, or CIDR)
- [Host](https://docs.pangolin.net/manage/resources/private/host.md): Route client traffic to a single IP address or FQDN on the remote network
- [Multi-site Routing and High Availability](https://docs.pangolin.net/manage/resources/private/multi-site-routing.md): Use multiple sites on a private resource for resilient routing and failover
- [Ports and ICMP](https://docs.pangolin.net/manage/resources/private/port-restrictions.md): Configure TCP and UDP port modes and ICMP (ping) for private resources
- [HTTP / HTTPS](https://docs.pangolin.net/manage/resources/private/private-http.md): Private reverse proxy with optional TLS termination at the site edge over the Pangolin tunnel
- [SSH](https://docs.pangolin.net/manage/resources/private/ssh.md): Connect to remote hosts over the Pangolin tunnel using the Pangolin CLI
- [Authentication](https://docs.pangolin.net/manage/resources/public/authentication.md): Create identity and context aware rules to allow access
- [Health Checks and Failover](https://docs.pangolin.net/manage/resources/public/healthchecks-failover.md): Monitor public resource targets and automatically remove unhealthy targets from routing
- [HTTP / HTTPS](https://docs.pangolin.net/manage/resources/public/http-https.md): Publish websites, APIs, and dashboards as authenticated public reverse proxies
- [Maintenance Page](https://docs.pangolin.net/manage/resources/public/maintenance.md): Show a maintenance page to users when a resources is down for maintenance or targets are unhealthy
- [TCP / UDP](https://docs.pangolin.net/manage/resources/public/raw-resources.md): Expose raw TCP and UDP services on a Pangolin server port without authentication
- [RDP](https://docs.pangolin.net/manage/resources/public/rdp.md): Control a Windows computer remotely through a full RDP client rendered in the browser
- [Resource Policies](https://docs.pangolin.net/manage/resources/public/resource-policies.md): Share authentication and access rule settings across multiple public resources
- [SSH](https://docs.pangolin.net/manage/resources/public/ssh.md): Access a remote shell in the browser with password, key, or Pangolin identity authentication
- [Targets](https://docs.pangolin.net/manage/resources/public/targets.md): Configure destination endpoints for resource routing and load balancing
- [VNC](https://docs.pangolin.net/manage/resources/public/vnc.md): View and control a remote display through a VNC client rendered in the browser
- [Wildcard Resources](https://docs.pangolin.net/manage/resources/public/wildcard-resources.md): Pangolin Cloud and Enterprise: route every hostname at a subdomain level through one public resource
- [Understanding Resources](https://docs.pangolin.net/manage/resources/understanding-resources.md): Resources are any network address you want to make available to users
- [Automatic Site Updates](https://docs.pangolin.net/manage/sites/auto-update.md): Let Newt sites check for and install updates on their own
- [Configure Sites](https://docs.pangolin.net/manage/sites/configure-site.md): Configure Newt for connecting to Pangolin sites
- [Site Credentials](https://docs.pangolin.net/manage/sites/credentials.md): Understanding how site credentials work and how they can be rotated & regenerated
- [Install Sites](https://docs.pangolin.net/manage/sites/install-site.md): Install Newt as a binary or Docker container
- [Site Provisioning Keys](https://docs.pangolin.net/manage/sites/site-provisioning.md): Use long-lived provisioning tokens to bootstrap Pangolin sites at scale without pre-creating ID-secret pairs for every host
- [Understanding Sites](https://docs.pangolin.net/manage/sites/understanding-sites.md): Create a site to connect to a remote network and expose resources
- [Update Sites](https://docs.pangolin.net/manage/sites/update-site.md): Update Newt to the latest version
- [SSH Access](https://docs.pangolin.net/manage/ssh.md): SSH configuration, setup, and examples for public and private resources
- [Cloudflare Proxy](https://docs.pangolin.net/self-host/advanced/cloudflare-proxy.md)
- [Clustering for High Availability](https://docs.pangolin.net/self-host/advanced/clustering.md)
- [Configuration File](https://docs.pangolin.net/self-host/advanced/config-file.md): Configure Pangolin using the config.yml file with detailed settings for all components
- [Internal CLI (pangctl)](https://docs.pangolin.net/self-host/advanced/container-cli-tool.md): Command-line tool for managing your Pangolin instance
- [Database Options](https://docs.pangolin.net/self-host/advanced/database-options.md): Configure SQLite or PostgreSQL database for Pangolin
- [Enable ASN Lookup](https://docs.pangolin.net/self-host/advanced/enable-asn-lookup.md): Configuration requirements to enable ASN lookup features in Pangolin
- [Enable Geo-location](https://docs.pangolin.net/self-host/advanced/enable-geolocation.md): Configuration requirements to enable geolocation features in Pangolin
- [Enable Integration API](https://docs.pangolin.net/self-host/advanced/integration-api.md): Enable and configure the Integration API for external access
- [Metrics and Observability](https://docs.pangolin.net/self-host/advanced/observability.md): Understand metrics, traces, logs, and profiling support across Pangolin components
- [Private Configuration File](https://docs.pangolin.net/self-host/advanced/private-config-file.md): Configure advanced Pangolin settings using the privateConfig.yml file for enterprise features
- [Traefik Access Log Rotation](https://docs.pangolin.net/self-host/advanced/traefik-log-rotation.md): How to manage and rotate Traefik access logs when CrowdSec is installed
- [Wildcard Domains](https://docs.pangolin.net/self-host/advanced/wild-card-domains.md): Configure wildcard TLS certificates with Traefik DNS-01 challenges
- [Without Tunneling](https://docs.pangolin.net/self-host/advanced/without-tunneling.md): Use Pangolin as a local reverse proxy without Gerbil tunneling
- [Choosing a VPS](https://docs.pangolin.net/self-host/choosing-a-vps.md): Compare hosting options and find the best VPS for your Pangolin deployment
- [CrowdSec](https://docs.pangolin.net/self-host/community-guides/crowdsec.md)
- [GeoLite2 Automation](https://docs.pangolin.net/self-host/community-guides/geolite2automation.md): A simple automation to download & update your GeoLite2 databases with geoipupdate
- [Home Assistant Add-on](https://docs.pangolin.net/self-host/community-guides/homeassistant.md)
- [Metrics](https://docs.pangolin.net/self-host/community-guides/metrics.md)
- [Middleware Manager](https://docs.pangolin.net/self-host/community-guides/middlewaremanager.md)
- [Overview](https://docs.pangolin.net/self-host/community-guides/overview.md)
- [Remove GeoBlock Plugin](https://docs.pangolin.net/self-host/community-guides/remove-geoblock-plugin.md)
- [Bypass Rules](https://docs.pangolin.net/self-host/community-guides/rules.md): Community bypass rules for common self hosted apps
- [Traefik Log Dashboard (v2 – Agent Architecture)](https://docs.pangolin.net/self-host/community-guides/traefiklogsdashboard.md)
- [DNS & Networking](https://docs.pangolin.net/self-host/dns-and-networking.md): Configure your domain, DNS records, and network settings for Pangolin deployment
- [Enterprise Edition](https://docs.pangolin.net/self-host/enterprise-edition.md): Learn about Enterprise Edition licensing, plans, and how to get started
- [How to Update](https://docs.pangolin.net/self-host/how-to-update.md): Keep your Pangolin deployment up to date with the latest features and security patches
- [Docker Compose](https://docs.pangolin.net/self-host/manual/docker-compose.md): Deploy Pangolin manually using Docker Compose without the automated installer
- [Choose an Installation Path](https://docs.pangolin.net/self-host/manual/kubernetes/choose-method.md): Choose the Kubernetes deployment workflow for Pangolin and Sites (Newt).
- [Argo CD](https://docs.pangolin.net/self-host/manual/kubernetes/gitops/argocd.md): Deploy Pangolin and Newt using Argo CD for Git-driven GitOps reconciliation.
- [Flux](https://docs.pangolin.net/self-host/manual/kubernetes/gitops/flux.md): Deploy Pangolin and Newt using Flux for Git-driven GitOps reconciliation.
- [GitOps Overview](https://docs.pangolin.net/self-host/manual/kubernetes/gitops/overview.md): Deploy Pangolin and Sites (Newt) with GitOps workflows such as Argo CD or Flux.
- [Helm](https://docs.pangolin.net/self-host/manual/kubernetes/helm.md): Kubernetes installation using Helm charts for Pangolin and Newt.
- [Helmfile](https://docs.pangolin.net/self-host/manual/kubernetes/helmfile.md): Advanced Kubernetes installation using Helmfile for multi-release orchestration.
- [Kustomize](https://docs.pangolin.net/self-host/manual/kubernetes/kustomize.md): Customize Helm-rendered Kubernetes manifests with Kustomize overlays.
- [Configuration](https://docs.pangolin.net/self-host/manual/kubernetes/newt/configuration.md): Configuration reference for Newt Kubernetes deployments.
- [Helm](https://docs.pangolin.net/self-host/manual/kubernetes/newt/helm.md): Quick-start guide for installing Site (newt) on Kubernetes using Helm.
- [Kustomize](https://docs.pangolin.net/self-host/manual/kubernetes/newt/kustomize.md): Deploy Newt on Kubernetes using Helm-rendered manifests and Kustomize overlays.
- [Troubleshooting](https://docs.pangolin.net/self-host/manual/kubernetes/newt/troubleshooting.md): Diagnose and resolve common Newt Kubernetes deployment issues.
- [Overview](https://docs.pangolin.net/self-host/manual/kubernetes/overview.md): Deploy Pangolin, Sites (Newt), and related components on Kubernetes.
- [Configuration](https://docs.pangolin.net/self-host/manual/kubernetes/pangolin/configuration.md): Configuration reference for Pangolin Kubernetes deployments.
- [Helm](https://docs.pangolin.net/self-host/manual/kubernetes/pangolin/helm.md): Quick-start guide for installing Pangolin on Kubernetes using Helm.
- [Kustomize](https://docs.pangolin.net/self-host/manual/kubernetes/pangolin/kustomize.md): Deploy Pangolin on Kubernetes using Helm-rendered manifests and Kustomize overlays.
- [Troubleshooting](https://docs.pangolin.net/self-host/manual/kubernetes/pangolin/troubleshooting.md): Diagnose and resolve Pangolin Kubernetes deployment issues.
- [Prerequisites](https://docs.pangolin.net/self-host/manual/kubernetes/prerequisites.md): Cluster, tooling, networking, and storage requirements for deploying Pangolin and Sites (Newt) on Kubernetes.
- [Podman Quadlets (Rootless)](https://docs.pangolin.net/self-host/manual/podman-quadlets.md): Deploy Pangolin manually using Podman Quadlets (rootless) without the automated installer
- [Unraid Deployment](https://docs.pangolin.net/self-host/manual/unraid.md): Deploy Pangolin on Unraid for local reverse proxy and tunneling
- [Quick Install Guide](https://docs.pangolin.net/self-host/quick-install.md): Deploy your own fully self-hosted instance of Pangolin Community Edition
- [Telemetry](https://docs.pangolin.net/self-host/telemetry.md): Understanding Pangolin's anonymous usage data collection

## Optional

- [Slack](https://pangolin.net/slack)
- [Discord](https://pangolin.net/discord)
- [Downloads](https://pangolin.net/downloads)
- [Website](https://pangolin.net/)
- [GitHub](https://github.com/fosrl/pangolin)
- [Trust Center](https://trust.pangolin.net/)