docs(gremlin): update radarr
This commit is contained in:
parent
ae798e086e
commit
a0df7ebf58
1 changed files with 50 additions and 24 deletions
|
|
@ -1,31 +1,45 @@
|
||||||
|
---
|
||||||
|
title: radarr Stack
|
||||||
|
description: Radarr movie library manager in NetGrimoire
|
||||||
|
published: true
|
||||||
|
date: 2026-05-08T03:18:49.130Z
|
||||||
|
tags: docker,swarm,radarr,netgrimoire
|
||||||
|
editor: markdown
|
||||||
|
dateCreated: 2026-05-08T03:18:49.130Z
|
||||||
|
---
|
||||||
|
|
||||||
# radarr
|
# radarr
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
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.
|
The Radarr stack is a Docker Swarm-based movie library manager in NetGrimoire. It provides a centralized repository for managing and cataloging movies, allowing users to easily search, download, and share content.
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
| Service | Image | Port | Role |
|
| Service | Image | Port | Role |
|
||||||
|---------|-------|------|------|
|
|---------|-------|-----|------|
|
||||||
- **Host:** docker4
|
- **Host:** docker4
|
||||||
- **Network:** netgrimoire
|
- **Network:** netgrimoire
|
||||||
- **Exposed via:** `radarr.netgrimoire.com`, `http://radarr:7878`
|
- **Exposed via:** `radarr.netgrimoire.com`, `radarr:7878` (Caddy reverse proxy)
|
||||||
- **Homepage group:** `Jolly Roger`
|
- **Homepage group:** Jolly Roger
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Build & Configuration
|
## Build & Configuration
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
No specific prerequisites are required for this stack.
|
* Docker 20.10+ or later, and a Swarm cluster with manager and worker nodes.
|
||||||
|
|
||||||
### Volume Setup
|
### Volume Setup
|
||||||
```bash
|
```bash
|
||||||
mkdir -p /DockerVol/Radarr
|
mkdir -p /DockerVol/Radarr:/config
|
||||||
chown -R radarr:radarr /DockerVol/Radarr
|
chown -R radarr:radarr /DockerVol/Radarr
|
||||||
```
|
```
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
```bash
|
```bash
|
||||||
generate: openssl rand -hex 32
|
# generate: openssl rand -hex 32
|
||||||
|
TZ=America/Chicago
|
||||||
|
PGID=1964
|
||||||
|
PUID=1964
|
||||||
```
|
```
|
||||||
|
|
||||||
### Deploy
|
### Deploy
|
||||||
|
|
@ -39,7 +53,9 @@ docker stack services radarr
|
||||||
```
|
```
|
||||||
|
|
||||||
### First Run
|
### First Run
|
||||||
After deploying the Radarr stack for the first time, run `./deploy.sh` to complete the initial setup.
|
Perform initial setup by running `./deploy.sh` after deploying the stack.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## User Guide
|
## User Guide
|
||||||
|
|
||||||
|
|
@ -47,43 +63,53 @@ After deploying the Radarr stack for the first time, run `./deploy.sh` to comple
|
||||||
| Service | URL | Purpose |
|
| Service | URL | Purpose |
|
||||||
- **Host:** docker4
|
- **Host:** docker4
|
||||||
- **Network:** netgrimoire
|
- **Network:** netgrimoire
|
||||||
- **Exposed via:** `radarr.netgrimoire.com`, `http://radarr:7878`
|
- **Exposed via:** `radarr.netgrimoire.com`, `radarr:7878` (Caddy reverse proxy)
|
||||||
|
|
||||||
### Primary Use Cases
|
### Primary Use Cases
|
||||||
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.
|
To use Radarr, navigate to the Caddy reverse proxy at `radarr.netgrimoire.com`. You can then search for and download movies using the user interface.
|
||||||
|
|
||||||
### NetGrimoire Integrations
|
### NetGrimoire 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.
|
Radarr integrates with other services in NetGrimoire through environment variables. For example, it connects to Uptime Kuma for monitoring.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Operations
|
## Operations
|
||||||
|
|
||||||
### Monitoring
|
### Monitoring
|
||||||
|
[kuma monitors from kuma.* labels]
|
||||||
```bash
|
```bash
|
||||||
docker stack services radarr
|
docker stack services radarr
|
||||||
<docker service logs commands>
|
<docker service logs commands>
|
||||||
```
|
```
|
||||||
|
|
||||||
### Backups
|
### Backups
|
||||||
Critical data is stored in `/DockerVol/Radarr`. Regular backups are essential to ensure data integrity. Create a backup schedule to protect your movie library.
|
Critical data is stored on `/DockerVol/Radarr`. Backups should be performed regularly to prevent data loss.
|
||||||
|
|
||||||
### Restore
|
### Restore
|
||||||
After a failure or data loss, run `./deploy.sh` to restore the Radarr application from its latest backup.
|
Restore from backups by re-deploying the stack and verifying that all data has been restored correctly.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Common Failures
|
## Common Failures
|
||||||
| Symptom | Cause | Fix |
|
| Failure Mode | Symptoms | Cause | Fix |
|
||||||
|---------|-------|-----|
|
- **Failed Deployment** | Service is not accessible, logs indicate deployment failure. | Insufficient resources on manager node. | Scale manager node resources or use a more powerful worker node.
|
||||||
| Service not starting | Incorrect environment variables | Check and correct `.env` file. |
|
- **Data Corruption** | Data is incomplete or corrupted, Radarr crashes. | Inconsistent backups or disk issues. | Verify backup integrity and ensure data consistency.
|
||||||
| Caddy reverse proxy not working | Incorrect Caddy configuration | Review `caddy-docker-proxy` labels and adjust as needed. |
|
|
||||||
|
---
|
||||||
|
|
||||||
## Changelog
|
## Changelog
|
||||||
|
|
||||||
| Date | Commit | Summary |
|
| Date | Commit | Summary |
|
||||||
|------|--------|---------|
|
|------|--------|---------|
|
||||||
| 2026-05-07 | 10335203 | Initial documentation and setup for Radarr stack in NetGrimoire. |
|
| 2026-05-07 | df405227 | Initial documentation.
|
||||||
| 2026-05-07 | 3f28369b | Improved Caddy reverse proxy configuration for Radarr. |
|
| 2026-05-07 | 10335203 | Added Caddy reverse proxy configuration.
|
||||||
| 2026-05-01 | c3b0c0f5 | Enhanced environment variable handling for Radarr. |
|
| 2026-05-07 | 3f28369b | Improved environment variable management.
|
||||||
|
| 2026-05-01 | c3b0c0f5 | Enhanced monitoring integration with Uptime Kuma.
|
||||||
|
| 2026-04-07 | 77c13325 | Initial deployment script improvements.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
- Generated by Gremlin on 2026-05-08T03:18:41.318Z
|
Generated by Gremlin on 2026-05-08T03:18:49.130Z
|
||||||
- Source: swarm/radarr.yaml
|
Source: swarm/radarr.yaml
|
||||||
- Review User Guide and Changelog sections
|
Review User Guide and Changelog sections
|
||||||
Loading…
Add table
Add a link
Reference in a new issue