---

🦜 Parrot says: Found the right chart? Drop a ⭐ an' help another crew find it.

─── ⛧ ───

💀 Questions or cursed media-stack tips? Step forward… enter 🔥HADES🔥.

---

Plundarrpedia 🏴‍☠️

Plundarrpedia is the public field guide for Plundarr, Privateerr, and the self-hosted media presets they power. It brings setup, architecture, storage, networking, and troubleshooting into one searchable wiki for Docker and NAS operators.

Read the wiki or start here to choose the smallest project that solves your job. No installation is needed to read the published guides.

The project repositories remain the source of truth for code and exact configuration. Plundarrpedia connects those pieces with task-oriented guides and examples. Privateerr generates PIA WireGuard configuration; Gluetun runs the VPN tunnel.

Pick a reading route 🧭

Guide	What you'll find
Plundarr	Generate and operate a media automation stack.
Privateerr	Generate PIA settings and recover stale Gluetun connections.
Presets	Choose Boudoirr, Jellyfin, Plex, Calibre-Web Automated, Duplex, Watchtower, Portainer, or a custom stack.
Platform guides	Deploy on Linux Docker, Synology, or TrueNAS.

Run the wiki locally ⚡

You need Git, Make, and Docker with Docker Compose. The repository includes one Compose file for serving the production site and running the authoring tools.

Clone the repository and create your local environment file:

git clone https://github.com/scottgigawatt/plundarrpedia.git
cd plundarrpedia
cp example.env .env

Review .env for your host, especially PLUNDARRPEDIA_HOST_PORT if port 8000 is already in use. Then build and start the production site from your checkout:

make run

Open http://localhost:8000, using your chosen port if you changed it. This command builds the checked-out source; changing PLUNDARRPEDIA_TAG changes its image tag, not the source revision it builds.

Use make logs to follow the container logs and make down to stop and remove the local Compose containers. See advanced usage for build, deployment, and maintenance details.

Write and preview the wiki ✍️

Pages live in docs/, navigation lives in mkdocs.yml, and theme customizations live in overrides/ and docs/assets/. Follow the contribution guide for front matter, sentence-case headings, relative links, and accessible Markdown.

From the cloned repository, start the live-reload preview:

make serve

Open http://localhost:8000. The preview uses the pinned Material for MkDocs toolchain in Docker, so you do not need to install Python or MkDocs locally. If the production site is already using port 8000, stop it with make down first or use make serve MKDOCS_AUTHOR_PORT=8001 and open http://localhost:8001.

Before opening a pull request, run the strict site build, Compose validation, and repository checks. These commands assume you created .env above; make lint also needs pre-commit installed:

make site
make config
make lint

The strict build catches navigation and configuration warnings, while the lint checks validate source formatting and other repository rules. Review the rendered result as well: successful checks cannot tell you whether a guide makes sense to its reader.

When adding new behavior, add or extend automated checks for it. New documentation is covered by the full-site build and lint checks. Keep examples public-safe: replace credentials, tunnel keys, private hostnames, and other deployment details before committing.

Use make help for the complete command list. Generated HTML goes in site/; edit its sources and use make clean when you want to remove that generated output.

Published images and releases 🐳

The GHCR package supports linux/amd64, linux/arm64, and linux/arm/v7. A pinned Material for MkDocs build renders the site, and an unprivileged Nginx image serves the static files. The supplied Compose configuration uses a read-only runtime and drops all Linux capabilities.

Image tag	Use
ghcr.io/scottgigawatt/plundarrpedia:latest	Latest stable release.
ghcr.io/scottgigawatt/plundarrpedia:edge	Preview from a successful build of main.
ghcr.io/scottgigawatt/plundarrpedia:<version>	A specific published version; choose its tag from the releases.

To run a published image instead of building your checkout, set PLUNDARRPEDIA_TAG in .env, then pull and start the service without building:

docker compose pull plundarrpedia
docker compose up --detach --no-build plundarrpedia

latest and edge move as new builds are published. Choose a release tag for a specific version, or an image digest when you need immutable image selection.

Changes merged to main publish the wiki to GitHub Pages and trigger the container workflow. The image workflow scans with Trivy and publishes multi-platform images with a software bill of materials (SBOM) and provenance. See the publishing guide for release details.

Help, security, and contributions 🤝

For a broken guide or a feature request, open an issue. For setup questions, join the HADES Discord community with any secrets removed from your logs.

Report vulnerabilities privately using the security policy. It also explains supported releases and the boundary between this documentation project and the tools it describes.

Corrections, clearer examples, and new guides are welcome. Read the contribution guide and code of conduct before sending a pull request. Plundarrpedia is maintained by Scott Gigawatt and released under the Apache 2.0 license.

Every fleet needs good charts. Help keep these ones seaworthy. 🏴‍☠️