Plundarr script hold 🏴☠️¶
These documented AWK programs and host helpers support generated Compose projects, Linux hosts, and Synology DiskStations. Pick the smallest tool for the job and review its header before running it with elevated privileges.
Find a script 🧭¶
| Hold | Script | Purpose |
|---|---|---|
| 🧮 AWK | awk/collect-dockerfile-base-images.awk |
Resolve declared external Dockerfile base-image references |
| 🧮 AWK | awk/format-compose-status.awk |
Align Compose status rows and stack distinct published ports |
| 🧮 AWK | awk/order-environment.awk |
Order resolved values like the selected preset environment file |
| 🧮 AWK | awk/strip-comments.awk |
Remove comments and blank lines from raw configuration output |
| 🐳 Compose | compose/backup.sh |
Archive one preset's config without replacing an existing backup |
| 🐳 Compose | compose/check-pia-credentials.sh |
Report missing or example PIA credentials before Privateerr starts |
| 🐳 Compose | compose/nuke.sh |
Remove resources owned by one selected Compose project |
| 🐳 Compose | compose/ps.sh |
Print a compact status table for one generated project |
| 🐳 Compose | compose/restart.sh |
Wait for Docker, stop a project safely, and start it again |
| 📚 Docs | docs/prepare-python.sh |
Prepare the exact Python environment used to build documentation |
| 🐧 Linux | linux/set-inotify-limits.sh |
Raise inotify limits for large Plex libraries |
| ⚓ Synology | synology/docker-socket.sh |
Restore trusted docker group access to the Docker socket |
| ⚓ Synology | synology/entware.sh |
Mount and start Entware during boot |
| ⚓ Synology | synology/tun.sh |
Ensure /dev/net/tun exists for VPN containers |
Important
Scripts under scripts/synology/ run directly on a Synology NAS. They are maintained against DSM 7.4; review paths and privileges before using them on another DSM release or Linux host.
AWK programs 🧮¶
awk/collect-dockerfile-base-images.awk¶
Records global Dockerfile ARG defaults, resolves ${NAME} and $NAME in FROM, ignores internal stages and scratch, and resets state between input files. Unresolved references are skipped. The nuke helper uses the output for best-effort cleanup without force-removing shared or in-use base images.
awk/format-compose-status.awk¶
Formats tab-separated docker compose ps data into aligned terminal columns, collapses equivalent IPv4 and IPv6 wildcard bindings, and places each distinct published port on its own continuation row. scripts/compose/ps.sh resolves and invokes this program automatically.
awk/order-environment.awk¶
Records resolved Docker Compose environment assignments, then prints only variables present in the selected preset .env file and preserves that file's order. make env PRESET=<preset> supplies both inputs through the centralized AWK command and option variables in the Makefile.
awk/strip-comments.awk¶
Removes comments, trailing whitespace, and empty lines from configuration output. make print-config and make print-env share this program so both raw views follow one filtering contract.
Compose helpers 🐳¶
compose/backup.sh¶
Archives one generated preset's complete config directory with a timestamped name. An incrementing suffix prevents a same-second backup from replacing an existing archive. make backup PRESET=<preset> is the normal entry point. This archives host config files only; export Tracearr backups first so named-volume database state is included.
compose/check-pia-credentials.sh¶
Reads resolved Compose environment values from standard input and fails when a Privateerr deployment would start without real PIA_USER and PIA_PASS values. Invalid credentials produce a color-aware diagnostic with a corrective action; redirected output remains plain text and NO_COLOR disables terminal color. make up, make test-e2e, and make test-stack call it automatically.
compose/nuke.sh¶
Validates one selected Compose model before deleting anything, captures its service images, runs project-scoped teardown of containers, networks, and service images while preserving application volumes, then removes explicitly supplied local image references and one named Buildx builder. Plundarr calls the same helper separately for the generated project and the explicitly named maraudarr Compose project that runs Maraudarr.
Repeated --dockerfile and --additional-image arguments avoid shell command evaluation. Missing resources are harmless; unexpected Compose, Docker, or builder failures stop the helper. Repository files, .env, bind-mounted config, and host backups remain Make's protected responsibility. All application volumes and internal backups are preserved. The explicitly supplied Buildx builder owns disposable build cache only. Make fixes deployment teardown flags; customize its timeout with COMPOSE_DOWN_TIMEOUT.
compose/ps.sh¶
Resolves the selected Compose project and prints only its containers in a terminal-friendly status table. Equivalent IPv4 and IPv6 wildcard bindings are collapsed, and each distinct published port receives an aligned continuation line. make ps PRESET=<preset> is the normal entry point.
compose/restart.sh¶
Waits for Docker, stops a Compose project while preserving named volumes, and starts the project again in detached mode.
Documentation helpers 📚¶
docs/prepare-python.sh¶
Validates the exact supported Python patch release, safely replaces an absent or incompatible documentation virtual environment, and writes the versioned stamp consumed by Make. make docs is the normal entry point and passes every path through explicit long options.
Linux helpers 🐧¶
linux/set-inotify-limits.sh¶
Raises Linux inotify limits so Plex can monitor large media libraries without running out of watches.
Synology helpers ⚓¶
synology/tun.sh¶
Ensures /dev/net/tun exists for Gluetun and other VPN containers.
synology/entware.sh¶
Mounts and starts Entware at boot, adds its profile to /etc/profile, and updates the package list.
synology/docker-socket.sh¶
Waits for Container Manager to create /var/run/docker.sock, then grants the docker group read/write access. Membership in this group grants root-level control of the NAS through Docker.
Create a docker group in DSM → Control Panel → User & Group → Group, add only trusted Docker users, and run the boot task as root: