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.