Update install docs

This commit is contained in:
Owen
2026-05-14 21:57:08 -07:00
parent bc93358add
commit 4cefdb7458
3 changed files with 5 additions and 18 deletions
+2 -2
View File
@@ -12,7 +12,7 @@ Pangolin exposes observability signals across multiple components, but not every
**Newt** provides the broadest native observability support with Prometheus metrics, OTLP metrics, OTLP traces, health checks, and optional `pprof`. **Gerbil** supports metrics through either a Prometheus backend or an OTLP backend. The **Pangolin Kubernetes Controller** exposes a Prometheus-compatible scrape endpoint and includes additional OTel-backed metric instruments on that endpoint. **Newt** provides the broadest native observability support with Prometheus metrics, OTLP metrics, OTLP traces, health checks, and optional `pprof`. **Gerbil** supports metrics through either a Prometheus backend or an OTLP backend. The **Pangolin Kubernetes Controller** exposes a Prometheus-compatible scrape endpoint and includes additional OTel-backed metric instruments on that endpoint.
<Note> <Note>
This page focuses on Pangolin-native observability. For a community walkthrough that collects Traefik and CrowdSec metrics with Prometheus and Grafana, see the [community metrics guide](/self-host/community-guides/metrics). This page focuses on Pangolin-native observability. For a community walkthrough that collects Traefik metrics with Prometheus and Grafana, see the [community metrics guide](/self-host/community-guides/metrics).
All currently documented component metrics are listed in the [Full Metric Reference](#full-metric-reference). All currently documented component metrics are listed in the [Full Metric Reference](#full-metric-reference).
</Note> </Note>
@@ -520,7 +520,7 @@ increase(pangolin_kube_controller_reconcile_errors_total[10m]) > 5
<CardGroup cols={2}> <CardGroup cols={2}>
<Card title="Community Metrics Guide" icon="chart-simple" href="/self-host/community-guides/metrics"> <Card title="Community Metrics Guide" icon="chart-simple" href="/self-host/community-guides/metrics">
Traefik and CrowdSec metrics collection with Prometheus and Grafana. Traefik and metrics collection with Prometheus and Grafana.
</Card> </Card>
<Card title="Newt Kubernetes Monitoring" icon="cubes" href="/self-host/manual/kubernetes/newt/configuration"> <Card title="Newt Kubernetes Monitoring" icon="cubes" href="/self-host/manual/kubernetes/newt/configuration">
Verified Newt chart values for metrics, Services, and ServiceMonitor resources. Verified Newt chart values for metrics, Services, and ServiceMonitor resources.
+3 -1
View File
@@ -6,7 +6,9 @@ import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
<PangolinCloudTocCta /> <PangolinCloudTocCta />
<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>
<Note> <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). 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).
-15
View File
@@ -83,21 +83,6 @@ Before installing Pangolin, ensure you've set up DNS for your domain(s) and open
You'll see progress indicators as each container is pulled and started. You'll see progress indicators as each container is pulled and started.
</Step> </Step>
<Step title="Install CrowdSec (optional)">
The installer will ask if you want to install CrowdSec for additional security:
- **Default**: No (recommended for initial setup)
- **If enabled**: You'll need to confirm you're willing to manage CrowdSec configuration
<Warning>
CrowdSec adds complexity and requires manual configuration for optimal security. Only enable if you're comfortable managing it.
</Warning>
<Info>
CrowdSec can be installed later if needed. The basic installation provides sufficient security for most use cases.
</Info>
</Step>
</Steps> </Steps>
## Post-Installation Setup ## Post-Installation Setup