mirror of
https://github.com/nickyeoman/docker-compose-cookbooks.git
synced 2026-11-12 11:08:49 +00:00
codeandClaude Opus 5.5
7ed139d134
- Promote sonarr, radarr, jellyfin, jellyseerr from _dev - qBittorrent, Sonarr, Radarr, Lidarr, Readarr, Whisparr mount /data/media at /media so paths match across containers (no remote path mappings, hardlinks work); downloads go to /media/downloads/prowlarr - Jellyfin: drop photos (use Immich) and unused internal network, rewrite README - Jellyseerr: add TZ, document container hostnames and root folders Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
88 lines
3.5 KiB
Markdown
88 lines
3.5 KiB
Markdown
# Whisparr
|
|
|
|
## Overview
|
|
|
|
Whisparr is an automated adult content collection manager for Usenet and BitTorrent users. It monitors your watchlist, scans configured indexers for releases, and sends matches to your download client. After download, it renames and organizes files into your media library and can notify your media server.
|
|
|
|
## Project Details
|
|
|
|
- **Project Repository:** [https://whisparr.com/](https://whisparr.com/)
|
|
- **Container Image:** [ghcr.io/hotio/whisparr](https://hotio.dev/containers/whisparr/)
|
|
- **Reverse Proxy Port:** `6969`
|
|
|
|
## Getting Started
|
|
|
|
Open http://localhost:6969 in your browser and complete the initial setup wizard:
|
|
|
|
1. **Choose your UI language**
|
|
2. **Add a download client** — select qBittorrent, enter its host/port/credentials
|
|
3. **Add an indexer** — or connect to Prowlarr for automatic indexer sync
|
|
|
|
Once the wizard finishes, you'll see an empty library. To populate it:
|
|
|
|
- Go to **Settings → Media Management** and add a **Root Folder** (e.g., `/media/adult`) — this is where your organized library will live
|
|
- Click **Add Movie** and search by title — Whisparr fetches metadata and available releases
|
|
- Optionally connect a **List** to auto-import from your watchlists
|
|
|
|
### Download flow
|
|
|
|
qBittorrent downloads to `/media/downloads/prowlarr` → Whisparr picks it up, renames the file, and moves it into `<Root Folder>/Title (Year)/`
|
|
|
|
## Environment Variable Notes
|
|
|
|
| Variable | Description |
|
|
|---|---|
|
|
| `WHISPARR_IMAGE` | Container image (default: `ghcr.io/hotio/whisparr:release`) |
|
|
| `WHISPARR_RESTART` | Restart policy (default: `unless-stopped`) |
|
|
| `WHISPARR_PORT` | Published port for the web UI (default: `6969`) |
|
|
| `VOL_PATH` | Base path for persistent data volumes (default: `/data`) |
|
|
| `WHISPARR_MEDIA` | Shared media root on the host (default: `/data/media`), mounted at `/media`. Must be the same folder qBittorrent, Sonarr, Radarr and Jellyfin use |
|
|
| `TZ` | Container timezone (default: `America/Vancouver`) |
|
|
|
|
## Volume Notes
|
|
|
|
| Volume | Purpose |
|
|
|---|---|
|
|
| `${VOL_PATH:-/data}/whisparr/config` | Application configuration and database |
|
|
| `${WHISPARR_MEDIA:-/data/media}` → `/media` | Shared media root: downloads in `/media/downloads`, library in `/media/adult` |
|
|
|
|
## Network Notes
|
|
|
|
Requires an external `proxy` network. Create it once with:
|
|
|
|
```bash
|
|
docker network create proxy
|
|
```
|
|
|
|
## Docker Run
|
|
|
|
```bash
|
|
docker run -d \
|
|
--name=whisparr \
|
|
-e PUID=1000 \
|
|
-e PGID=1000 \
|
|
-e UMASK=002 \
|
|
-e TZ=America/Vancouver \
|
|
-p 6969:6969 \
|
|
-v ${VOL_PATH:-/data}/whisparr/config:/config \
|
|
-v ${WHISPARR_MEDIA:-/data/media}:/media \
|
|
--network proxy \
|
|
--restart unless-stopped \
|
|
ghcr.io/hotio/whisparr:release
|
|
```
|
|
|
|
## Additional Notes / Gotchas
|
|
|
|
- **One shared media folder.** qBittorrent, Sonarr, Radarr, Whisparr and Jellyfin all use `/data/media` on the host, mounted at `/media`, so a download has the same path in every container: no Remote Path Mapping needed, and imports can use hardlinks. Enable **Settings → Media Management → Use Hardlinks instead of Copy**.
|
|
- **Layout:** `/data/media/downloads/prowlarr` (qBittorrent category `prowlarr`), `/data/media/adult` (Whisparr root, not mounted by Jellyfin by default).
|
|
- In the qBittorrent download client settings, set **Category** to `prowlarr`.
|
|
|
|
## Dockhand Stack, Deploy from Git
|
|
|
|
- **Cookbooks Repository**
|
|
- **stackname:** whisparr_dev
|
|
- **Compose file path:** whisparr_dev/compose.yaml
|
|
- **Additional env file (optional):** whisparr_dev/sample.env
|
|
|
|
Load `whisparr_dev/sample.env` into the Environment variables in Dockhand, then create the Stack.
|