clean up client install/configure and add sidebar cta

This commit is contained in:
miloschwartz
2026-02-12 16:43:19 -08:00
parent 39429997d5
commit 202e25b9f6
103 changed files with 736 additions and 2 deletions

View File

@@ -2,6 +2,12 @@
title: "Cloudflare Proxy"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Pangolin works with Cloudflare proxy (orange cloud) enabled, but requires specific configuration:
<Warning>

View File

@@ -2,6 +2,12 @@
title: "Clustering for High Availability"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
Clustering is only available in [Enterprise Edition](/self-host/enterprise-edition). [Please reach out to us to deploy](https://pangolin.net/talk-to-us).
</Note>

View File

@@ -3,6 +3,12 @@ title: "Configuration File"
description: "Configure Pangolin using the config.yml file with detailed settings for all components"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
The `config.yml` file controls all aspects of your Pangolin deployment, including server settings, domain configuration, email setup, and security options. This file is mounted at `config/config.yml` in your Docker container.
## Setting up your `config.yml`

View File

@@ -3,6 +3,12 @@ title: "Internal CLI (pangctl)"
description: "Command-line tool for managing your Pangolin instance"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
The Pangolin container includes a CLI tool called `pangctl` that provides commands to help you manage your Pangolin instance.
## Accessing the CLI

View File

@@ -3,6 +3,12 @@ title: "Database Options"
description: "Configure SQLite or PostgreSQL database for Pangolin"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Pangolin supports two database options: SQLite for simplicity and PostgreSQL for production deployments.
<CardGroup cols={2}>

View File

@@ -3,6 +3,12 @@ title: "Enable ASN Blocking"
description: "Configuration requirements to enable ASN blocking in Pangolin"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
To enable ASN blocking in Pangolin Community you must download and place the Maxmind ASN database into the `config/` directory and update the config file. This can be done for free.
<Tip>

View File

@@ -3,6 +3,12 @@ title: "Enable Geo-blocking"
description: "Configuration requirements to enable geoblocking in Pangolin"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
To enable geoblocking in Pangolin Community you must download and place the Maxmind geoip database into the `config/` directory and update the config file. This can be done for free.
<Tip>

View File

@@ -3,6 +3,12 @@ title: "Enable Integration API"
description: "Enable and configure the Integration API for external access"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
The Integration API provides programmatic access to Pangolin functionality. It includes OpenAPI documentation via Swagger UI.
## Enable Integration API

View File

@@ -1,7 +1,13 @@
---
title: "Metrics"
description: "Enable and consume OpenTelemetry & vendor specific metrics"
---
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
We provide metrics in the **OpenTelemetry** (OTel) format and additionally support the following vendor backends:

View File

@@ -3,6 +3,12 @@ title: "Database Options"
description: "Configure SQLite or PostgreSQL database for Pangolin"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
## Overview
> Choose between SQLite (default) or PostgreSQL for your database

View File

@@ -3,6 +3,12 @@ title: "Private Configuration File"
description: "Configure advanced Pangolin settings using the privateConfig.yml file for enterprise features"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
The `privateConfig.yml` file provides advanced configuration options for enterprise deployments. This file is mounted at `config/privateConfig.yml` in your Docker container.
<Note>

View File

@@ -3,6 +3,12 @@ title: "Container Timezone"
description: "Configure the timezone for Pangolin, Gerbil, and Traefik containers to match your local time."
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
By default, Docker containers report logs and timestamps in **UTC**. If you want the containers and their log output to use your local timezone, you need to set the timezone in both the container environment and mount the host timezone files.
## Updating your `docker-compose.yml`

View File

@@ -3,6 +3,12 @@ title: "Wildcard Domains"
description: "Configure wildcard SSL certificates for automatic subdomain security with DNS-01 challenge"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Wildcard certificates allow you to secure unlimited subdomains with a single SSL certificate, eliminating the need to generate individual certificates for each subdomain. Pangolin uses Traefik's built-in Let's Encrypt integration to automatically manage these certificates.
<Warning>

View File

@@ -3,6 +3,12 @@ title: "Without Tunneling"
description: "Use Pangolin as a local reverse proxy without Gerbil tunneling"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Use Pangolin as a local reverse proxy and authentication manager
You can use Pangolin without Gerbil and tunneling. In this configuration, Pangolin acts as a normal reverse proxy and authentication manager that can be deployed on your local network to provide access to resources.

View File

@@ -3,6 +3,12 @@ title: "Choosing a VPS"
description: "Compare hosting options and find the best VPS for your Pangolin deployment"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Pangolin generally requires minimal resources to run effectively. A basic VPS with **1 vCPU, 1GB RAM, and 8GB SSD** is sufficient for most deployments.
<CardGroup cols={2}>

View File

@@ -2,6 +2,12 @@
title: "CrowdSec"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
This is a community guide and is not officially supported. If you have any issues, please reach out to the [author](https://github.com/Lokowitz).
</Note>

View File

@@ -2,6 +2,12 @@
title: "GeoBlock"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
This is a community guide and is not officially supported. If you have any issues, please reach out to the [author](https://github.com/Lokowitz).
</Note>

View File

@@ -3,6 +3,12 @@ title: "GeoLite2 Automation"
description: "A simple automation to download & update your GeoLite2 databases with geoipupdate"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
This is a community guide and is not officially supported. If you have any issues, please reach out to the [author](https://github.com/txwgnd).
</Note>

View File

@@ -2,6 +2,12 @@
title: "Home Assistant Add-on"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
This is a community add-on and is not officially supported. If you have any issues, please reach out to the [author](https://github.com/Ferdinand99/home-assistant-newt-addon).
</Note>

View File

@@ -2,6 +2,12 @@
title: "Metrics"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
This is a community guide and is not officially supported. If you have any issues, please reach out to the [author](https://github.com/Lokowitz).
</Note>

View File

@@ -2,6 +2,12 @@
title: "Middleware Manager"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
This is a community guide and not officially supported. For issues, contributions, or bug reports, please use the [official GitHub repository](https://github.com/hhftechnology/middleware-manager).
</Note>

View File

@@ -2,6 +2,12 @@
title: "Overview"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
These are community written guides and are not officially supported. If you have any issues, please reach out to the authors or the community on [Discord](https://pangolin.net/discord) or [Github discussions](https://github.com/orgs/fosrl/discussions).
</Note>

View File

@@ -2,6 +2,12 @@
title: "Remove GeoBlock Plugin"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
This is a community guide and is not officially supported. If you have any issues, please reach out to the community on [Discord](https://pangolin.net/discord) or [Github discussions](https://github.com/orgs/fosrl/discussions).
</Note>

View File

@@ -2,6 +2,12 @@
title: "Traefik Log Dashboard (v2 Agent Architecture)"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Note>
This is a community guide and is not officially supported. For issues or advanced configuration, please visit the [official repository](https://github.com/hhftechnology/traefik-log-dashboard).
</Note>

View File

@@ -3,6 +3,12 @@ title: "DNS & Networking"
description: "Configure your domain, DNS records, and network settings for Pangolin deployment"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Pangolin requires proper DNS configuration and network setup to function correctly. This guide covers domain setup, DNS records, port configuration, and networking considerations.
## DNS Configuration

View File

@@ -3,6 +3,12 @@ title: "Enterprise Edition"
description: "Learn about Enterprise Edition features, licensing, and how to get started"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
When self-hosting Pangolin, you can choose to run the **Community Edition** or the **Enterprise Edition**. Both editions provide the same core functionality, but the Enterprise Edition unlocks additional features for qualifying users.
## Edition Comparison

View File

@@ -3,6 +3,12 @@ title: "How to Update"
description: "Keep your Pangolin deployment up to date with the latest features and security patches"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Updating Pangolin is straightforward since it's a collection of Docker images. Simply pull the latest images and restart the stack. Migration scripts run automatically to update your database and configuration files when needed.
## Before You Update

View File

@@ -3,6 +3,12 @@ title: "Docker Compose"
description: "Deploy Pangolin manually using Docker Compose without the automated installer"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
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.
This guide assumes you already have a Linux server with Docker and Docker Compose installed. If you don't, please refer to the [official Docker documentation](https://docs.docker.com/get-docker/) for installation instructions. You must also have root access to the server.

View File

@@ -3,6 +3,12 @@ title: "Docker Compose"
description: "Deploy managed Pangolin manually using Docker Compose without the automated installer"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<Tip>
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>

View File

@@ -3,6 +3,12 @@ title: "Unraid Deployment"
description: "Deploy Pangolin on Unraid for local reverse proxy and tunneling"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
## Overview
This guide explains how to use Pangolin and Traefik as a local reverse proxy without Gerbil and its tunneling features. The second (optional) part will expand on this and show how to enable tunneling by setting up Gerbil.

View File

@@ -3,6 +3,12 @@ title: "Purchase a License Key"
description: "How to buy an Enterprise license key for Pangolin from the dashboard"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Buy an Enterprise license key directly from the Pangolin dashboard. You choose your tier, complete checkout, and get your key right away — in the dashboard and by email.
## How to buy a license key

View File

@@ -4,6 +4,12 @@ description: "Deploy your own fully self-hosted instance of Pangolin Community E
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
<iframe
className="w-full aspect-video rounded-xl"
src="https://www.youtube.com/embed/0upWrqkJPy8?si=q0D-uR1IHuddaqeT"

View File

@@ -3,6 +3,12 @@ title: "Supporter Program"
description: "Support Pangolin development and remove UI elements with a supporter key"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Pangolin self-hosted will always be free and open source, but maintaining the project takes time and resources. The supporter program helps fund ongoing development — including bug fixes, new features, and community support.
<Note>

View File

@@ -3,6 +3,12 @@ title: "Telemetry"
description: "Understanding Pangolin's anonymous usage data collection"
---
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta />
Pangolin collects anonymous usage telemetry to help us understand how the software is used and guide future improvements and feature development.
## What We Collect