diff --git a/Netgrimoire/Services/radarr/radarr.md b/Netgrimoire/Services/radarr/radarr.md new file mode 100644 index 0000000..87e7aa4 --- /dev/null +++ b/Netgrimoire/Services/radarr/radarr.md @@ -0,0 +1,119 @@ +# radarr + +## Overview +The Radarr stack is a Docker Swarm-based configuration for the popular movie library management service, Radarr. It provides a centralized hub for managing a large collection of movies, complete with features like automated metadata fetching and quality filtering. + +--- + +## Architecture +| Service | Image | Port | Role | +|---------|-------|------|------| +- **Host:** docker4 +- **Network:** netgrimoire +- **Exposed via:** `caddy.radarr.netgrimoire.com`, `radarr:7878` +- **Homepage group:** Jolly Roger + +--- + +## Build & Configuration + +### Prerequisites +No specific prerequisites are required for this stack. + +### Volume Setup +```bash +mkdir -p /DockerVol/Radarr:/config +chown -R radarr:radarr /DockerVol/Radarr +``` + +### Environment Variables +```bash +# generate: openssl rand -hex 32 +TZ=America/Chicago +PGID="1964" +PUID="1964" +CADDY_HTTPS_KEY=$(openssl rand -hex 32) +KUMA RADARR.HTTP.NAME=Radarr +KUMA RADARR.HTTP.URL=https://radarr.netgrimoire.com +``` + +### Deploy +```bash +cd services/swarm/stack/radarr +set -a && source .env && set +a +docker stack config --compose-file radarr-stack.yml > resolved.yml +docker stack deploy --compose-file resolved.yml radarr +rm resolved.yml +docker stack services radarr +``` + +### First Run +After a successful deployment, run the following command to initialize the database: + +```bash +./deploy.sh +``` + +--- + +## User Guide + +### Accessing radarr +| Service | URL | Purpose | +- **radarr**: https://radarr.netgrimoire.com | + +### Primary Use Cases +To use Radarr in NetGrimoire, follow these steps: + +1. Log in to the Radarr interface at `https://radarr.netgrimoire.com`. +2. Configure your library by adding movies and setting quality filters. +3. Set up Caddy for reverse proxying and HTTPS. + +### NetGrimoire Integrations +Radarr integrates with Kuma for monitoring and Uptime Kuma for dashboard integration. + +--- + +## Operations + +### Monitoring +[kuma monitors] +```bash +docker stack services radarr + +``` + +### Backups +Critical backups should be done to `/DockerVol/Radarr/data/backup/` on a regular basis. Reconstructable backups can be stored in the same directory. + +### Restore +```bash +cd services/swarm/stack/radarr +./deploy.sh +``` + +--- + +## Common Failures +| Failure Mode | Symptoms | Cause | Fix | +|-------------|----------|------|-----| +| Caddy Not Listening | No incoming requests. | Caddy not started | Restart caddy service with `docker stack services radarr` | +| Radarr Service Not Running | No visible interface in NetGrimoire Dashboard. | Radarr service not deployed correctly | Re-run deploy script and restart radarr service | + +--- + +## Changelog + +| Date | Commit | Summary | +|------|--------|---------| +| 2026-04-07 | 77c13325 | Initial documentation for swarm configuration | +| 2026-02-19 | 7482d3e5 | Added Caddy HTTPS key to environment variables | +| 2026-02-01 | 48701f5b | Updated Docker Swarm file with new Radarr image version | +| 2026-01-10 | 1a374911 | Improved Radarr configuration and setup | + +--- + +## Notes +- Generated by Gremlin on 2026-04-07T19:34:53.606Z +- Source: swarm/radarr.yaml +- Review User Guide and Changelog sections \ No newline at end of file