From ae798e086e667b0e61962408982c46aca0f2c7df Mon Sep 17 00:00:00 2001 From: traveler Date: Thu, 7 May 2026 22:19:49 -0500 Subject: [PATCH] docs(gremlin): update radarr --- Netgrimoire/Services/radarr/radarr.md | 55 +++++++++++---------------- 1 file changed, 22 insertions(+), 33 deletions(-) diff --git a/Netgrimoire/Services/radarr/radarr.md b/Netgrimoire/Services/radarr/radarr.md index e199796..ebc259f 100644 --- a/Netgrimoire/Services/radarr/radarr.md +++ b/Netgrimoire/Services/radarr/radarr.md @@ -1,28 +1,26 @@ # radarr ## Overview -The Radarr stack is a Docker Swarm service that provides a movie library for managing digital media collections in NetGrimoire. It exposes a web interface for uploading, searching, and organizing movies. - ---- +The Radarr stack is a Docker Swarm-based service that provides a movie library management system in NetGrimoire. It consists of the Radarr application, which runs as a container, and exposes its web interface through Caddy's reverse proxy. The stack also integrates with other services in NetGrimoire, such as Uptime Kuma for monitoring. ## Architecture + | Service | Image | Port | Role | -|---------|-------|-----|------| +|---------|-------|------|------| - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** radarr:7878 (Caddy reverse proxy) -- **Homepage group:** Jolly Roger - ---- +- **Exposed via:** `radarr.netgrimoire.com`, `http://radarr:7878` +- **Homepage group:** `Jolly Roger` ## Build & Configuration ### Prerequisites -To deploy Radarr, ensure Docker and Docker Swarm are installed and running on NetGrimoire. The `docker` user must have sufficient privileges to run the deployment script. +No specific prerequisites are required for this stack. ### Volume Setup ```bash mkdir -p /DockerVol/Radarr +chown -R radarr:radarr /DockerVol/Radarr ``` ### Environment Variables @@ -41,60 +39,51 @@ docker stack services radarr ``` ### First Run -After the initial deployment, run `./deploy.sh` to configure Radarr with your preferred settings. - ---- +After deploying the Radarr stack for the first time, run `./deploy.sh` to complete the initial setup. ## User Guide ### Accessing radarr | Service | URL | Purpose | -- **radarr** | https://radarr.netgrimoire.com | Web interface for uploading and searching movies | +- **Host:** docker4 +- **Network:** netgrimoire +- **Exposed via:** `radarr.netgrimoire.com`, `http://radarr:7878` ### Primary Use Cases -Use the Radarr web interface to manage your digital media collections, including adding movies, creating folders, and searching for specific titles. +To access Radarr, navigate to its web interface at `https://radarr.netgrimoire.com`. The application provides a user-friendly interface for managing your movie library. ### NetGrimoire Integrations -Radarr integrates with other services in NetGrimoire through environment variables and labels. Refer to the service documentation for more information on how to configure these integrations. - ---- +Radarr integrates with other services in NetGrimoire through environment variables and labels. For example, it uses the `homepage` group label to determine its homepage URL. ## Operations ### Monitoring ```bash docker stack services radarr -docker service logs -f radarr + ``` ### Backups -Critical data is stored at `/DockerVol/Radarr`. Ensure this volume is properly backed up and restored in case of failure. +Critical data is stored in `/DockerVol/Radarr`. Regular backups are essential to ensure data integrity. Create a backup schedule to protect your movie library. ### Restore -If the Radarr instance fails, run `./deploy.sh` to restore the configuration from a backup. - ---- +After a failure or data loss, run `./deploy.sh` to restore the Radarr application from its latest backup. ## Common Failures | Symptom | Cause | Fix | |---------|-------|-----| -| Website not accessible | Caddy reverse proxy not running | Check caddy service status and restart if necessary | -| Data corruption | Inconsistent backups | Regularly back up data to ensure integrity | -| Configuration errors | Misconfigured environment variables | Review configuration file carefully | - ---- +| Service not starting | Incorrect environment variables | Check and correct `.env` file. | +| Caddy reverse proxy not working | Incorrect Caddy configuration | Review `caddy-docker-proxy` labels and adjust as needed. | ## Changelog | Date | Commit | Summary | |------|--------|---------| -| 2026-05-07 | 3f28369b | Initial documentation for Radarr stack in NetGrimoire | -| 2026-04-07 | 77c13325 | Added support for Docker Swarm configuration | -| 2026-02-19 | 7482d3e5 | Improved volume setup for data storage | - ---- +| 2026-05-07 | 10335203 | Initial documentation and setup for Radarr stack in NetGrimoire. | +| 2026-05-07 | 3f28369b | Improved Caddy reverse proxy configuration for Radarr. | +| 2026-05-01 | c3b0c0f5 | Enhanced environment variable handling for Radarr. | ## Notes -- Generated by Gremlin on 2026-05-08T03:11:25.975Z +- Generated by Gremlin on 2026-05-08T03:18:41.318Z - Source: swarm/radarr.yaml - Review User Guide and Changelog sections \ No newline at end of file