mirror of
https://github.com/nickyeoman/docker-compose-cookbooks.git
synced 2026-09-04 10:56:23 +00:00
feat: add lidarr_dev stack, rewrite prowlarr_dev, align template conventions
- Add lidarr_dev stack with compose.yaml, sample.env, and README - Rewrite prowlarr_dev to match template conventions (compose.yaml, defaults on all vars, proxy network, README sections) - Set default VOL_PATH to /data (absolute, never ./data) - Reorder README sections: Overview → Project Details → Getting Started → Env Vars → Volume Notes → Network Notes → Docker Run - Update template-readme.md and AGENTS.md with new conventions
This commit is contained in:
+68
-6
@@ -1,9 +1,71 @@
|
||||
# Prowlarr
|
||||
# Prowlarr
|
||||
|
||||
Official Site: https://prowlarr.com/
|
||||
docker docs: https://hotio.dev/containers/prowlarr/ (VPN setup here)
|
||||
Proxy port: 9696
|
||||
## Overview
|
||||
|
||||
Prowlarr is an indexer manager and proxy developed by the *arr team to integrate with and support applications like Sonarr, Radarr, Lidarr, and Readarr. Its primary function is to centralize the management of your various torrent tracker and Usenet indexer configurations. Instead of manually adding and configuring each indexer in every single one of your *arr applications, you simply add them once to Prowlarr. Prowlarr then automatically syncs these indexers and their settings to all of your connected apps, drastically simplifying setup and maintenance while also providing a single dashboard to monitor the status and statistics of all your indexer sources.
|
||||
Prowlarr is an indexer manager and proxy for the *arr ecosystem. It centralizes your torrent tracker and Usenet indexer configuration — add them once in Prowlarr and they sync automatically to Sonarr, Radarr, Lidarr, and Readarr. It's a modern replacement for Jackett with a unified API and built-in sync.
|
||||
|
||||
I'm using this as a replacement for https://github.com/Jackett/Jackett
|
||||
## Project Details
|
||||
|
||||
- **Project Repository:** [https://prowlarr.com/](https://prowlarr.com/)
|
||||
- **Container Image:** [ghcr.io/hotio/prowlarr](https://hotio.dev/containers/prowlarr/)
|
||||
- **Reverse Proxy Port:** `9696`
|
||||
|
||||
## Getting Started
|
||||
|
||||
Open http://localhost:9696 in your browser and complete the initial setup wizard:
|
||||
|
||||
1. **Choose your UI language**
|
||||
2. **Add an indexer** — search or manually configure your preferred trackers/usenet providers
|
||||
3. **Connect your *arr apps** — go to **Settings → Apps** and add Sonarr, Radarr, Lidarr, etc. Prowlarr will automatically sync all configured indexers to them
|
||||
4. If you're migrating from Jackett, Prowlarr can import your existing indexer configs during setup
|
||||
|
||||
### Download flow
|
||||
|
||||
Prowlarr does not handle downloads. It only provides indexer search results to your *arr apps — they in turn send downloads to qBittorrent, SABnzbd, etc.
|
||||
|
||||
## Environment Variable Notes
|
||||
|
||||
| Variable | Description |
|
||||
|---|---|
|
||||
| `PROWLARR_IMAGE` | Container image (default: `ghcr.io/hotio/prowlarr:release`) |
|
||||
| `PROWLARR_RESTART` | Restart policy (default: `unless-stopped`) |
|
||||
| `PROWLARR_PORT` | Published port for the web UI (default: `9696`) |
|
||||
| `VOL_PATH` | Base path for persistent data volumes (default: `/data`) |
|
||||
|
||||
## Volume Notes
|
||||
|
||||
| Volume | Purpose |
|
||||
|---|---|
|
||||
| `${VOL_PATH}/prowlarr/config` | Indexer configurations, app sync settings, database |
|
||||
|
||||
## Network Notes
|
||||
|
||||
Requires an external `proxy` network. Create it once with:
|
||||
|
||||
```bash
|
||||
docker network create proxy
|
||||
```
|
||||
|
||||
## Docker Run
|
||||
|
||||
```bash
|
||||
docker run -d \
|
||||
--name=prowlarr \
|
||||
-e PUID=1000 \
|
||||
-e PGID=1000 \
|
||||
-e UMASK=002 \
|
||||
-p 9696:9696 \
|
||||
-v ${VOL_PATH:-/data}/prowlarr/config:/config \
|
||||
--network proxy \
|
||||
--restart unless-stopped \
|
||||
ghcr.io/hotio/prowlarr:release
|
||||
```
|
||||
|
||||
## Dockhand Stack, Deploy from Git
|
||||
|
||||
- **Cookbooks Repository**
|
||||
- **stackname:** prowlarr_dev
|
||||
- **Compose file path:** prowlarr_dev/compose.yaml
|
||||
- **Additional env file (optional):** prowlarr_dev/sample.env
|
||||
|
||||
Load `prowlarr_dev/sample.env` into the Environment variables in Dockhand, then create the Stack.
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
services:
|
||||
prowlarr:
|
||||
image: ${PROWLARR_IMAGE:-ghcr.io/hotio/prowlarr:release}
|
||||
restart: ${PROWLARR_RESTART:-unless-stopped}
|
||||
volumes:
|
||||
- ${VOL_PATH:-/data}/prowlarr/config:/config
|
||||
environment:
|
||||
- PUID=1000
|
||||
- PGID=1000
|
||||
- UMASK=002
|
||||
ports:
|
||||
- "${PROWLARR_PORT:-9696}:9696"
|
||||
networks:
|
||||
- proxy
|
||||
|
||||
networks:
|
||||
proxy:
|
||||
external: true
|
||||
@@ -1,13 +0,0 @@
|
||||
services:
|
||||
prowlarr:
|
||||
image: ${PROWLARR_IMAGE}
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
- PUID=1000
|
||||
- PGID=1000
|
||||
- UMASK=002
|
||||
- TZ=${TZ}
|
||||
volumes:
|
||||
- "${VOL_CONFIG_PATH:-./data/prowlarr/config}:/config"
|
||||
ports:
|
||||
- 9696:9696
|
||||
@@ -1,4 +1,3 @@
|
||||
# Prowlarr
|
||||
VOL_PATH=./data/prowlarr/config
|
||||
VOL_PATH=/data
|
||||
PROWLARR_IMAGE=ghcr.io/hotio/prowlarr:release
|
||||
TZ="America/Vancouver"
|
||||
Reference in New Issue
Block a user