technical documentation
Documentation
Every document Marauder ships lives in the GitHub repo, in plain Markdown. The links below open the canonical source — pull requests welcome on any of them.
Project context
-
Vision
Why Marauder exists, who it's for, what it's not.
docs/VISION.md
-
Competitors
Marauder's place next to Sonarr, Radarr, Prowlarr, Jackett, and FlexGet.
docs/COMPETITORS.md
-
PRD
Full product requirements: personas, user stories, data model, API surface, security model, deployment topology.
docs/PRD.md
-
Roadmap
Milestone-by-milestone status with v1.0 ticked.
docs/ROADMAP.md
-
Changelog
Keep-a-Changelog formatted history of every release.
CHANGELOG.md
How-to guides
-
Kubernetes deployment
Deploy to your own cluster: Helm chart (source of truth) + Kustomize + plain manifests, simple or CloudNativePG + S3-backup tiers, and the uniform volume model.
docs/kubernetes.md
-
End-to-end magnet test
Step-by-step reproducer for the magnet → qBittorrent walkthrough using the dev compose overlay.
docs/test-e2e-magnet.md
-
Replace on update
Stop updated releases stacking duplicate torrents — remove the previous version (and optionally its files) per topic.
docs/replace-on-update.md
-
Keycloak / OIDC
How to enable OpenID Connect sign-in via the bundled Keycloak realm or any OIDC provider.
docs/oidc.md
-
Torznab / Newznab
Connect Jackett, Prowlarr, NZBHydra2, NZBGeek, and any indexer that speaks Torznab or Newznab.
docs/torznab-newznab.md
Developer guides
-
Contributing
Local dev with Docker, test running, PR checklist, conventions.
CONTRIBUTING.md
-
Plugin development
How to write a tracker, client, or notifier plugin in under 200 lines of Go.
docs/plugin-development.md
-
CI / CD pipeline
Per-workflow documentation: ci.yml, docker.yml, e2e.yml, release.yml, codeql.yml + Dependabot.
docs/ci.md
-
Site deploy
How marauder.cc itself is built (Astro), tested (actionlint), and deployed (GitHub Pages with custom domain).
docs/site-deploy.md
Reading the source
Most of what you'll want is in two folders. The Go backend lives at backend/ and the React frontend at frontend/. Plugins are under backend/internal/plugins/ — each tracker, client, and notifier is one self-contained Go file plus its tests.