mirror of
https://github.com/fosrl/docs-v2.git
synced 2026-09-05 21:51:29 +02:00
Fix formatting
This commit is contained in:
Owen
@@ -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.
|
||||
|
||||
<Note>
|
||||
|
||||
@@ -2,8 +2,6 @@
|
||||
title: "CrowdSec"
|
||||
---
|
||||
|
||||
|
||||
|
||||
<Note>
|
||||
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.
|
||||
</Note>
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: "GeoBlock"
|
||||
---
|
||||
|
||||
<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>
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: "GeoLite2 Automation"
|
||||
description: "A simple automation to download & update your GeoLite2 databases with geoipupdate"
|
||||
---
|
||||
|
||||
<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>
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: "Home Assistant Add-on"
|
||||
---
|
||||
|
||||
<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>
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: "Metrics"
|
||||
---
|
||||
|
||||
<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>
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: "Middleware Manager"
|
||||
---
|
||||
|
||||
<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>
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: "Overview"
|
||||
---
|
||||
|
||||
<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>
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: "Remove GeoBlock Plugin"
|
||||
---
|
||||
|
||||
<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>
|
||||
|
||||
@@ -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 |
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: "Traefik Log Dashboard (v2 – Agent Architecture)"
|
||||
---
|
||||
|
||||
<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>
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
<Check>
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -3,8 +3,6 @@ title: "Overview"
|
||||
description: "Deploy Pangolin, Sites (Newt), and related components on Kubernetes."
|
||||
---
|
||||
|
||||
|
||||
|
||||
## Components
|
||||
|
||||
| Component | Role |
|
||||
|
||||
@@ -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:
|
||||
|
||||
|
||||
@@ -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:
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: "Docker Compose"
|
||||
description: "Deploy managed Pangolin manually using Docker Compose without the automated installer"
|
||||
---
|
||||
|
||||
<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>
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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.
|
||||
|
||||
<Note>
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user