Skip to content

[crowdsec-manager] Add Pangolin deployment guide (docker-compose.pangolin.yml undocumented) #5

@strausmann

Description

@strausmann

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:

  1. Prerequisites (existing Pangolin stack)
  2. Which compose file to use and why
  3. Environment variables specific to Pangolin deployment
  4. Tailscale sidecar option (currently only in README)
  5. How the INCLUDE_PANGOLIN/INCLUDE_GERBIL feature flags affect functionality
  6. Verification steps

Acceptance Criteria

  • Pangolin deployment workflow is documented
  • All Pangolin-specific env-vars are listed with defaults and descriptions
  • INCLUDE_PANGOLIN and INCLUDE_GERBIL feature flags are explained
  • Users can follow the guide to deploy successfully alongside an existing Pangolin stack
  • Cross-reference added from main installation.mdx

Effort Estimate

S (2–3 hours)

Metadata

Metadata

Assignees

No one assigned

    Labels

    phase:1-criticalPhase 1: Critical gapspriority:highHoch: Wichtige fehlende Features oder Guidesproject:crowdsec-managerCrowdSec Manager Docsteam:devDevelopment: Code-Analyse, API-Doku, Feature-Mappingtype:guideHow-To Guide oder Tutorial

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions