From fffc51bb380cf7643afaa5af9f9a2a21058dff82 Mon Sep 17 00:00:00 2001 From: Owen Date: Thu, 3 Sep 2026 10:12:42 -0400 Subject: [PATCH] Fix formatting --- self-host/choosing-a-vps.mdx | 1 + self-host/community-guides/crowdsec.mdx | 2 -- self-host/community-guides/geoblock.mdx | 1 + self-host/community-guides/geolite2automation.mdx | 1 + self-host/community-guides/homeassistant.mdx | 1 + self-host/community-guides/metrics.mdx | 1 + self-host/community-guides/middlewaremanager.mdx | 1 + self-host/community-guides/overview.mdx | 1 + self-host/community-guides/remove-geoblock-plugin.mdx | 1 + self-host/community-guides/rules.mdx | 2 -- self-host/community-guides/traefiklogsdashboard.mdx | 1 + self-host/dns-and-networking.mdx | 1 + self-host/enterprise-edition.mdx | 2 -- self-host/how-to-update.mdx | 1 + self-host/manual/docker-compose.mdx | 2 -- self-host/manual/kubernetes/choose-method.mdx | 2 -- self-host/manual/kubernetes/gitops/argocd.mdx | 4 +++- self-host/manual/kubernetes/helmfile.mdx | 4 +++- self-host/manual/kubernetes/kustomize.mdx | 4 +++- self-host/manual/kubernetes/overview.mdx | 2 -- self-host/manual/kubernetes/pangolin/configuration.mdx | 4 +++- self-host/manual/kubernetes/pangolin/kustomize.mdx | 4 +++- self-host/manual/kubernetes/pangolin/troubleshooting.mdx | 4 +++- self-host/manual/kubernetes/prerequisites.mdx | 2 -- self-host/manual/manual-install.mdx | 1 + self-host/manual/podman-quadlets.mdx | 2 -- self-host/manual/unraid.mdx | 1 + self-host/purchase-license-key.mdx | 1 + self-host/quick-install.mdx | 3 --- self-host/supporter-program.mdx | 1 + self-host/telemetry.mdx | 1 + 31 files changed, 34 insertions(+), 25 deletions(-) diff --git a/self-host/choosing-a-vps.mdx b/self-host/choosing-a-vps.mdx index 315f6aa..82621b2 100644 --- a/self-host/choosing-a-vps.mdx +++ b/self-host/choosing-a-vps.mdx @@ -2,6 +2,7 @@ title: "Choosing a VPS" description: "Compare hosting options and find the best VPS for your Pangolin deployment" --- + Pangolin generally requires minimal resources to run effectively. A basic VPS with **1 vCPU, 2GB RAM, and 8GB SSD** is sufficient for most deployments. diff --git a/self-host/community-guides/crowdsec.mdx b/self-host/community-guides/crowdsec.mdx index b7f1dee..f00ffc5 100644 --- a/self-host/community-guides/crowdsec.mdx +++ b/self-host/community-guides/crowdsec.mdx @@ -2,8 +2,6 @@ title: "CrowdSec" --- - - To install Crowdsec with the offical installer, start it with the `--crowdsec` flag. This will prompt for a Crowdsec install at the end of the process. diff --git a/self-host/community-guides/geoblock.mdx b/self-host/community-guides/geoblock.mdx index 2c15d0e..5d1991d 100644 --- a/self-host/community-guides/geoblock.mdx +++ b/self-host/community-guides/geoblock.mdx @@ -1,6 +1,7 @@ --- title: "GeoBlock" --- + 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). diff --git a/self-host/community-guides/geolite2automation.mdx b/self-host/community-guides/geolite2automation.mdx index 14ad8c1..42d79c9 100644 --- a/self-host/community-guides/geolite2automation.mdx +++ b/self-host/community-guides/geolite2automation.mdx @@ -2,6 +2,7 @@ title: "GeoLite2 Automation" description: "A simple automation to download & update your GeoLite2 databases with geoipupdate" --- + 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). diff --git a/self-host/community-guides/homeassistant.mdx b/self-host/community-guides/homeassistant.mdx index fb257b6..d788fc5 100644 --- a/self-host/community-guides/homeassistant.mdx +++ b/self-host/community-guides/homeassistant.mdx @@ -1,6 +1,7 @@ --- title: "Home Assistant Add-on" --- + 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). diff --git a/self-host/community-guides/metrics.mdx b/self-host/community-guides/metrics.mdx index 54e537d..6d1732a 100644 --- a/self-host/community-guides/metrics.mdx +++ b/self-host/community-guides/metrics.mdx @@ -1,6 +1,7 @@ --- title: "Metrics" --- + 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). diff --git a/self-host/community-guides/middlewaremanager.mdx b/self-host/community-guides/middlewaremanager.mdx index ce8aa12..2eab0f1 100644 --- a/self-host/community-guides/middlewaremanager.mdx +++ b/self-host/community-guides/middlewaremanager.mdx @@ -1,6 +1,7 @@ --- title: "Middleware Manager" --- + 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). diff --git a/self-host/community-guides/overview.mdx b/self-host/community-guides/overview.mdx index e716387..1492321 100644 --- a/self-host/community-guides/overview.mdx +++ b/self-host/community-guides/overview.mdx @@ -1,6 +1,7 @@ --- title: "Overview" --- + 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). diff --git a/self-host/community-guides/remove-geoblock-plugin.mdx b/self-host/community-guides/remove-geoblock-plugin.mdx index f9b0b1f..84cd0cd 100644 --- a/self-host/community-guides/remove-geoblock-plugin.mdx +++ b/self-host/community-guides/remove-geoblock-plugin.mdx @@ -1,6 +1,7 @@ --- title: "Remove GeoBlock Plugin" --- + 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). diff --git a/self-host/community-guides/rules.mdx b/self-host/community-guides/rules.mdx index 6b7c498..8a0c961 100644 --- a/self-host/community-guides/rules.mdx +++ b/self-host/community-guides/rules.mdx @@ -3,8 +3,6 @@ title: "Bypass Rules" description: "Community bypass rules for common self hosted apps" --- - - This table compiles paths that need to be allowed for various apps to work with Pangolin authentication. | App | Required Bypass Rules | diff --git a/self-host/community-guides/traefiklogsdashboard.mdx b/self-host/community-guides/traefiklogsdashboard.mdx index c4603d5..17cd212 100644 --- a/self-host/community-guides/traefiklogsdashboard.mdx +++ b/self-host/community-guides/traefiklogsdashboard.mdx @@ -1,6 +1,7 @@ --- title: "Traefik Log Dashboard (v2 – Agent Architecture)" --- + 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). diff --git a/self-host/dns-and-networking.mdx b/self-host/dns-and-networking.mdx index 8149e81..3e36569 100644 --- a/self-host/dns-and-networking.mdx +++ b/self-host/dns-and-networking.mdx @@ -2,6 +2,7 @@ title: "DNS & Networking" description: "Configure your domain, DNS records, and network settings for Pangolin deployment" --- + 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 diff --git a/self-host/enterprise-edition.mdx b/self-host/enterprise-edition.mdx index 1ea7fd1..1249e80 100644 --- a/self-host/enterprise-edition.mdx +++ b/self-host/enterprise-edition.mdx @@ -3,8 +3,6 @@ title: "Enterprise Edition" description: "Learn about Enterprise Edition licensing, plans, and how to get started" --- - - When self-hosting Pangolin, you can run the **Community Edition** or the **Enterprise Edition**. Both editions provide the same core functionality. Enterprise Edition unlocks additional features with a license key on the `ee` Docker image. diff --git a/self-host/how-to-update.mdx b/self-host/how-to-update.mdx index 9497933..adf2f76 100644 --- a/self-host/how-to-update.mdx +++ b/self-host/how-to-update.mdx @@ -2,6 +2,7 @@ title: "How to Update" description: "Keep your Pangolin deployment up to date with the latest features and security patches" --- + 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 diff --git a/self-host/manual/docker-compose.mdx b/self-host/manual/docker-compose.mdx index d4d231b..aac7de0 100644 --- a/self-host/manual/docker-compose.mdx +++ b/self-host/manual/docker-compose.mdx @@ -3,8 +3,6 @@ title: "Docker Compose" description: "Deploy Pangolin manually using Docker Compose without the automated installer" --- - - This guide walks through a manual deployment using the same file layout the installer generates from `install/config/*` in the Pangolin source tree. Use it if you want the installer's defaults, but you want to create and maintain the files yourself. This guide assumes you already have a Linux server with Docker and Docker Compose installed, plus root or sudo access. diff --git a/self-host/manual/kubernetes/choose-method.mdx b/self-host/manual/kubernetes/choose-method.mdx index ceb5b3a..6d333fb 100644 --- a/self-host/manual/kubernetes/choose-method.mdx +++ b/self-host/manual/kubernetes/choose-method.mdx @@ -3,8 +3,6 @@ title: "Choose an Installation Path" description: "Choose the Kubernetes deployment workflow for Pangolin and Sites (Newt)." --- - - Use this page to pick the right Kubernetes guide for your deployment workflow. These guides assume you are already familiar with Kubernetes and the deployment tools listed below. diff --git a/self-host/manual/kubernetes/gitops/argocd.mdx b/self-host/manual/kubernetes/gitops/argocd.mdx index 6aff606..6749570 100644 --- a/self-host/manual/kubernetes/gitops/argocd.mdx +++ b/self-host/manual/kubernetes/gitops/argocd.mdx @@ -1,7 +1,9 @@ --- title: "Argo CD" description: "Deploy Pangolin and Newt using Argo CD for Git-driven GitOps reconciliation." ----Argo CD is a declarative GitOps tool that continuously syncs your cluster state to your Git repository. This guide covers installing Pangolin and Newt using Argo CD. +--- + +Argo CD is a declarative GitOps tool that continuously syncs your cluster state to your Git repository. This guide covers installing Pangolin and Newt using Argo CD. ## Install Pangolin with Argo CD using Helm diff --git a/self-host/manual/kubernetes/helmfile.mdx b/self-host/manual/kubernetes/helmfile.mdx index b823f38..7e67c09 100644 --- a/self-host/manual/kubernetes/helmfile.mdx +++ b/self-host/manual/kubernetes/helmfile.mdx @@ -1,7 +1,9 @@ --- title: "Helmfile" description: "Advanced Kubernetes installation using Helmfile for multi-release orchestration." ----Helmfile is a declarative way to manage multiple Helm releases in a single workflow. Use Helmfile when you need to install Pangolin and/or Newt alongside other Kubernetes components or manage multiple releases together. +--- + +Helmfile is a declarative way to manage multiple Helm releases in a single workflow. Use Helmfile when you need to install Pangolin and/or Newt alongside other Kubernetes components or manage multiple releases together. ## When to use Helmfile diff --git a/self-host/manual/kubernetes/kustomize.mdx b/self-host/manual/kubernetes/kustomize.mdx index 742a68c..9e4a3d7 100644 --- a/self-host/manual/kubernetes/kustomize.mdx +++ b/self-host/manual/kubernetes/kustomize.mdx @@ -1,7 +1,9 @@ --- title: "Kustomize" description: "Customize Helm-rendered Kubernetes manifests with Kustomize overlays." ----Kustomize can be used to customize Kubernetes manifests with bases, overlays, and patches. +--- + +Kustomize can be used to customize Kubernetes manifests with bases, overlays, and patches. For Pangolin and Newt, the supported Kustomize workflow is to render the Helm charts into manifests and use those rendered manifests as the Kustomize base. diff --git a/self-host/manual/kubernetes/overview.mdx b/self-host/manual/kubernetes/overview.mdx index 7b8bd28..6680149 100644 --- a/self-host/manual/kubernetes/overview.mdx +++ b/self-host/manual/kubernetes/overview.mdx @@ -3,8 +3,6 @@ title: "Overview" description: "Deploy Pangolin, Sites (Newt), and related components on Kubernetes." --- - - ## Components | Component | Role | diff --git a/self-host/manual/kubernetes/pangolin/configuration.mdx b/self-host/manual/kubernetes/pangolin/configuration.mdx index 4be0274..8602670 100644 --- a/self-host/manual/kubernetes/pangolin/configuration.mdx +++ b/self-host/manual/kubernetes/pangolin/configuration.mdx @@ -1,7 +1,9 @@ --- title: "Configuration" description: "Configuration reference for Pangolin Kubernetes deployments." ----This page covers the main Pangolin Kubernetes configuration options for Helm and Kustomize workflows. +--- + +This page covers the main Pangolin Kubernetes configuration options for Helm and Kustomize workflows. For exhaustive option coverage, refer to the chart resources: diff --git a/self-host/manual/kubernetes/pangolin/kustomize.mdx b/self-host/manual/kubernetes/pangolin/kustomize.mdx index 7574640..89ea484 100644 --- a/self-host/manual/kubernetes/pangolin/kustomize.mdx +++ b/self-host/manual/kubernetes/pangolin/kustomize.mdx @@ -1,7 +1,9 @@ --- title: "Kustomize" description: "Deploy Pangolin on Kubernetes using Helm-rendered manifests and Kustomize overlays." ----Use Kustomize when you want to manage Pangolin with rendered manifests, environment-specific overlays, and explicit patches in Git. +--- + +Use Kustomize when you want to manage Pangolin with rendered manifests, environment-specific overlays, and explicit patches in Git. For Pangolin, the supported Kustomize workflow is: diff --git a/self-host/manual/kubernetes/pangolin/troubleshooting.mdx b/self-host/manual/kubernetes/pangolin/troubleshooting.mdx index f795b4a..dd74484 100644 --- a/self-host/manual/kubernetes/pangolin/troubleshooting.mdx +++ b/self-host/manual/kubernetes/pangolin/troubleshooting.mdx @@ -1,7 +1,9 @@ --- title: "Troubleshooting" description: "Diagnose and resolve Pangolin Kubernetes deployment issues." ----This page covers troubleshooting Pangolin Kubernetes deployments across Helm, Kustomize, Argo CD, and Flux workflows. +--- + +This page covers troubleshooting Pangolin Kubernetes deployments across Helm, Kustomize, Argo CD, and Flux workflows. Start with the core checks, then use the section that matches the symptom. diff --git a/self-host/manual/kubernetes/prerequisites.mdx b/self-host/manual/kubernetes/prerequisites.mdx index 3dfcadb..40e2ac9 100644 --- a/self-host/manual/kubernetes/prerequisites.mdx +++ b/self-host/manual/kubernetes/prerequisites.mdx @@ -3,8 +3,6 @@ title: "Prerequisites" description: "Cluster, tooling, networking, and storage requirements for deploying Pangolin and Sites (Newt) on Kubernetes." --- - - Before installing Pangolin or Sites (Newt) on Kubernetes, check that your cluster, tools, networking, and storage setup match the deployment path you want to use. ## Kubernetes cluster diff --git a/self-host/manual/manual-install.mdx b/self-host/manual/manual-install.mdx index 410c4e2..cf41974 100644 --- a/self-host/manual/manual-install.mdx +++ b/self-host/manual/manual-install.mdx @@ -2,6 +2,7 @@ title: "Docker Compose" description: "Deploy managed Pangolin manually using Docker Compose without the automated installer" --- + 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. diff --git a/self-host/manual/podman-quadlets.mdx b/self-host/manual/podman-quadlets.mdx index 6e3cbfd..2a5762a 100644 --- a/self-host/manual/podman-quadlets.mdx +++ b/self-host/manual/podman-quadlets.mdx @@ -3,8 +3,6 @@ title: "Podman Quadlets (Rootless)" description: "Deploy Pangolin manually using Podman Quadlets (rootless) without the automated installer" --- - - This guide walks through a manual deployment using the same file layout the installer generates from `install/config/*` in the Pangolin source tree. Use it if you want the installer's defaults, but you want to create and maintain the files yourself. This guide assumes you already have a Linux server with Podman installed and has been tested on Debian 13.5 with Podman version 5.4.2. diff --git a/self-host/manual/unraid.mdx b/self-host/manual/unraid.mdx index ba4103d..526bf63 100644 --- a/self-host/manual/unraid.mdx +++ b/self-host/manual/unraid.mdx @@ -2,6 +2,7 @@ title: "Unraid Deployment" description: "Deploy Pangolin on Unraid for local reverse proxy and tunneling" --- + ## 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. diff --git a/self-host/purchase-license-key.mdx b/self-host/purchase-license-key.mdx index 1d32251..24b7165 100644 --- a/self-host/purchase-license-key.mdx +++ b/self-host/purchase-license-key.mdx @@ -2,6 +2,7 @@ title: "Purchase a License Key" description: "How to buy an Enterprise license key for Pangolin from the dashboard" --- + 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. ## License tiers diff --git a/self-host/quick-install.mdx b/self-host/quick-install.mdx index 39192ca..0ceb36e 100644 --- a/self-host/quick-install.mdx +++ b/self-host/quick-install.mdx @@ -1,11 +1,8 @@ --- title: "Quick Install Guide" description: "Deploy your own fully self-hosted instance of Pangolin Community Edition" - --- - - ## Prerequisites Before you begin, ensure you have: diff --git a/self-host/supporter-program.mdx b/self-host/supporter-program.mdx index 4e7ec40..7732af2 100644 --- a/self-host/supporter-program.mdx +++ b/self-host/supporter-program.mdx @@ -2,6 +2,7 @@ title: "Supporter Program" description: "Support Pangolin development and remove UI elements with a supporter key" --- + 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. diff --git a/self-host/telemetry.mdx b/self-host/telemetry.mdx index 7099f8a..2720640 100644 --- a/self-host/telemetry.mdx +++ b/self-host/telemetry.mdx @@ -2,6 +2,7 @@ title: "Telemetry" description: "Understanding Pangolin's anonymous usage data collection" --- + Pangolin collects anonymous usage telemetry to help us understand how the software is used and guide future improvements and feature development. ## What We Collect