Skip to content

About this wiki

Plundarrpedia is the public knowledge layer above the project repositories. It connects the architecture and recurring workflows without turning every page into a stale copy of a README.

Sources of truth

  • Current Plundarr repository documentation, generator behavior, service catalog, setup notes, helper scripts, and tests.
  • Current Privateerr documentation, supervisor behavior, Compose handoff, image/release model, and validation workflow.
  • The Privateerr developer site and Maraudarr developer site for Python contracts, architecture, and contributor testing.
  • Current Plundarr preset catalog, service charts, generated output, and migration boundaries.
  • Current Docker, Material for MkDocs, Synology, and TrueNAS documentation for behavior owned by those platforms.

Visual direction

The earlier wiki used a cosmic photographic background. Plundarrpedia uses a new chart-room system: navy ink, sea-glass teal, brass, parchment, a custom compass rose, layered grids, and project accents. The styling is implemented as small Material overrides and CSS, so navigation, search, accessibility, and print behavior remain theme-native.

Material features in use

  • Instant navigation with prefetch and a progress indicator.
  • Search suggestions, highlighting, and shareable searches.
  • Navigation tabs, section indexes, breadcrumbs, and footer navigation.
  • Card grids, content tabs, code copy/select, annotations, responsive architecture maps, improved tooltips, and footnote tooltips.
  • Automatic system light/dark selection with a manual palette toggle.

Publishing model

GitHub Pages receives a static artifact built from requirements.txt. The Docker image uses the same pin in a multi-stage build and serves only the generated site from an unprivileged Nginx image. Architecture maps use native HTML and CSS, so they render under the same self-contained Content Security Policy on GitHub Pages and in the production container.

The container workflow follows the sibling project conventions: multi-platform Buildx output, Open Container Initiative (OCI) metadata, Trivy scanning, software bills of materials (SBOMs), provenance, GitHub Container Registry (GHCR) publishing, and Renovate-managed dependency updates.

Container security review

The September 2026 runtime cleanup removes unused Nginx modules for XML transformation, JavaScript, image filtering, and geolocation, including their transitive libraries. The site keeps its unprivileged user, read-only deployment, healthcheck, and Content Security Policy. Fixed nghttp2 comes from a narrow Alpine edge package exception until stable includes it.

Docker Scout reports three remaining PCRE2 alerts: CVE-2026-89157, CVE-2026-89160, and CVE-2026-89162. The runtime already contains PCRE2 10.48, whose upstream release notes include all three fixes. The findings remain visible; no scanner exclusions hide them. Recheck the exact image digest and package versions when dependencies or advisory databases change.

Privateerr's container scan review covers the related Privateerr, Buccaneerr, and Maraudarr images. Scanner counts describe a dated artifact and database snapshot, not a guarantee of security.

Contributing

Edit Markdown under docs/, update mkdocs.yml when adding navigation, and follow the writing guide. Then validate:

make site
make config
make lint

Edit this page