Summary
A dedicated docker-compose.pangolin.yml file exists in the repository for deploying CrowdSec Manager alongside the Pangolin stack. This deployment option has zero documentation — users won't even know it exists.
Source
Gap analysis: docs/upstream-contributions/crowdsec-manager/docs-analyse.md (Section 3.1)
What Needs to Be Documented
The Pangolin deployment differs from the standard deployment in that it integrates with:
- Pangolin (tunnel management)
- Gerbil (Pangolin's WireGuard component)
- Traefik (as configured by Pangolin)
Relevant container name env-vars (also currently undocumented):
PANGOLIN_CONTAINER_NAME (default: pangolin)
GERBIL_CONTAINER_NAME (default: gerbil)
INCLUDE_PANGOLIN (default: true) — feature flag
INCLUDE_GERBIL (default: true) — feature flag
PANGOLIN_DIR — Pangolin root directory path
Proposed Structure
Either:
- New file:
content/docs/installation-pangolin.mdx
- Or: Add a dedicated section to the existing
installation.mdx
Content should cover:
- Prerequisites (existing Pangolin stack)
- Which compose file to use and why
- Environment variables specific to Pangolin deployment
- Tailscale sidecar option (currently only in README)
- How the
INCLUDE_PANGOLIN/INCLUDE_GERBIL feature flags affect functionality
- Verification steps
Acceptance Criteria
Effort Estimate
S (2–3 hours)
Summary
A dedicated
docker-compose.pangolin.ymlfile exists in the repository for deploying CrowdSec Manager alongside the Pangolin stack. This deployment option has zero documentation — users won't even know it exists.Source
Gap analysis:
docs/upstream-contributions/crowdsec-manager/docs-analyse.md(Section 3.1)What Needs to Be Documented
The Pangolin deployment differs from the standard deployment in that it integrates with:
Relevant container name env-vars (also currently undocumented):
PANGOLIN_CONTAINER_NAME(default:pangolin)GERBIL_CONTAINER_NAME(default:gerbil)INCLUDE_PANGOLIN(default:true) — feature flagINCLUDE_GERBIL(default:true) — feature flagPANGOLIN_DIR— Pangolin root directory pathProposed Structure
Either:
content/docs/installation-pangolin.mdxinstallation.mdxContent should cover:
INCLUDE_PANGOLIN/INCLUDE_GERBILfeature flags affect functionalityAcceptance Criteria
INCLUDE_PANGOLINandINCLUDE_GERBILfeature flags are explainedinstallation.mdxEffort Estimate
S (2–3 hours)