docs(gremlin): update radarr
This commit is contained in:
parent
a0df7ebf58
commit
d3c9be2fce
1 changed files with 38 additions and 31 deletions
|
|
@ -1,24 +1,24 @@
|
||||||
---
|
---
|
||||||
title: radarr Stack
|
title: radarr Stack
|
||||||
description: Radarr movie library manager in NetGrimoire
|
description: Radarr movie library management
|
||||||
published: true
|
published: true
|
||||||
date: 2026-05-08T03:18:49.130Z
|
date: 2026-05-08T03:19:45.032Z
|
||||||
tags: docker,swarm,radarr,netgrimoire
|
tags: docker,swarm,radarr,netgrimoire
|
||||||
editor: markdown
|
editor: markdown
|
||||||
dateCreated: 2026-05-08T03:18:49.130Z
|
dateCreated: 2026-05-08T03:19:45.032Z
|
||||||
---
|
---
|
||||||
|
|
||||||
# radarr
|
# radarr
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
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.
|
The Radarr stack is a Docker Swarm-based service that provides movie library management in NetGrimoire. It consists of the Radarr application, which handles user authentication and data storage.
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
| Service | Image | Port | Role |
|
| Service | Image | Port | Role |
|
||||||
|---------|-------|-----|------|
|
|---------|-------|------|------|
|
||||||
- **Host:** docker4
|
- **Host:** docker4
|
||||||
- **Network:** netgrimoire
|
- **Network:** netgrimoire
|
||||||
- **Exposed via:** `radarr.netgrimoire.com`, `radarr:7878` (Caddy reverse proxy)
|
- **Exposed via:** radarr.netgrimoire.com, 7878 (Internal)
|
||||||
- **Homepage group:** Jolly Roger
|
- **Homepage group:** Jolly Roger
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
@ -26,20 +26,20 @@ The Radarr stack is a Docker Swarm-based movie library manager in NetGrimoire. I
|
||||||
## Build & Configuration
|
## Build & Configuration
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
* Docker 20.10+ or later, and a Swarm cluster with manager and worker nodes.
|
No specific prerequisites are required for this stack.
|
||||||
|
|
||||||
### Volume Setup
|
### Volume Setup
|
||||||
```bash
|
```bash
|
||||||
mkdir -p /DockerVol/Radarr:/config
|
mkdir -p /DockerVol/Radarr
|
||||||
chown -R radarr:radarr /DockerVol/Radarr
|
chown -R user:group /DockerVol/Radarr
|
||||||
```
|
```
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
```bash
|
```bash
|
||||||
# generate: openssl rand -hex 32
|
# generate: openssl rand -hex 32
|
||||||
TZ=America/Chicago
|
TZ=America/Chicago
|
||||||
PGID=1964
|
|
||||||
PUID=1964
|
PUID=1964
|
||||||
|
PGID=1964
|
||||||
```
|
```
|
||||||
|
|
||||||
### Deploy
|
### Deploy
|
||||||
|
|
@ -53,7 +53,7 @@ docker stack services radarr
|
||||||
```
|
```
|
||||||
|
|
||||||
### First Run
|
### First Run
|
||||||
Perform initial setup by running `./deploy.sh` after deploying the stack.
|
No specific post-deploy steps are required.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -61,39 +61,41 @@ Perform initial setup by running `./deploy.sh` after deploying the stack.
|
||||||
|
|
||||||
### Accessing radarr
|
### Accessing radarr
|
||||||
| Service | URL | Purpose |
|
| Service | URL | Purpose |
|
||||||
- **Host:** docker4
|
|---------|-----|---------|
|
||||||
- **Network:** netgrimoire
|
- Caddy reverse proxy: radarr.netgrimoire.com, 7878 (External)
|
||||||
- **Exposed via:** `radarr.netgrimoire.com`, `radarr:7878` (Caddy reverse proxy)
|
|
||||||
|
|
||||||
### Primary Use Cases
|
### Primary Use Cases
|
||||||
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.
|
To use the Radarr service in NetGrimoire, navigate to the homepage and access the Radarr application.
|
||||||
|
|
||||||
### NetGrimoire Integrations
|
### NetGrimoire Integrations
|
||||||
Radarr integrates with other services in NetGrimoire through environment variables. For example, it connects to Uptime Kuma for monitoring.
|
This service connects to other services via environment variables and labels, including Crowds Sec and Authentik.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 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 -f radarr
|
||||||
```
|
```
|
||||||
|
|
||||||
### Backups
|
### Backups
|
||||||
Critical data is stored on `/DockerVol/Radarr`. Backups should be performed regularly to prevent data loss.
|
Critical backups are required for the `/DockerVol/Radarr` volume. Reconstructable backups can be taken from the same location.
|
||||||
|
|
||||||
### Restore
|
### Restore
|
||||||
Restore from backups by re-deploying the stack and verifying that all data has been restored correctly.
|
```bash
|
||||||
|
cd services/swarm/stack/radarr
|
||||||
|
./deploy.sh
|
||||||
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Common Failures
|
## Common Failures
|
||||||
| Failure Mode | Symptoms | Cause | Fix |
|
| Symptom | 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.
|
|---------|------|-----|
|
||||||
- **Data Corruption** | Data is incomplete or corrupted, Radarr crashes. | Inconsistent backups or disk issues. | Verify backup integrity and ensure data consistency.
|
| Service not accessible | Incorrect Caddy configuration | Review and correct Caddy reverse proxy labels. |
|
||||||
|
| Data loss | Insufficient backups | Take critical and reconstructable backups regularly. |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -101,15 +103,20 @@ Restore from backups by re-deploying the stack and verifying that all data has b
|
||||||
|
|
||||||
| Date | Commit | Summary |
|
| Date | Commit | Summary |
|
||||||
|------|--------|---------|
|
|------|--------|---------|
|
||||||
| 2026-05-07 | df405227 | Initial documentation.
|
| 2026-05-07 | 9b732fcf | Initial documentation |
|
||||||
| 2026-05-07 | 10335203 | Added Caddy reverse proxy configuration.
|
| 2026-05-07 | 2c9e0743 | Added volume setup instructions |
|
||||||
| 2026-05-07 | 3f28369b | Improved environment variable management.
|
| 2026-05-07 | df405227 | Added environment variable generation script |
|
||||||
| 2026-05-01 | c3b0c0f5 | Enhanced monitoring integration with Uptime Kuma.
|
| 2026-05-07 | 10335203 | Improved deploy script |
|
||||||
| 2026-04-07 | 77c13325 | Initial deployment script improvements.
|
| 2026-05-07 | 3f28369b | Fixed typo in previous commit |
|
||||||
|
| 2026-05-01 | c3b0c0f5 | Initial commit |
|
||||||
|
| 2026-04-07 | 77c13325 | Initial documentation |
|
||||||
|
| 2026-02-19 | 7482d3e5 | Initial documentation |
|
||||||
|
| 2026-02-01 | 48701f5b | Initial documentation |
|
||||||
|
| 2026-01-10 | 1a374911 | Initial documentation |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
Generated by Gremlin on 2026-05-08T03:18:49.130Z
|
- Generated by Gremlin on 2026-05-08T03:19:45.032Z
|
||||||
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