docs(gremlin): create radarr
This commit is contained in:
parent
f895e12bec
commit
adbd7c09fe
1 changed files with 100 additions and 0 deletions
100
Netgrimoire/Services/radarr/radarr.md
Normal file
100
Netgrimoire/Services/radarr/radarr.md
Normal file
|
|
@ -0,0 +1,100 @@
|
|||
# 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.
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-------|-----|------|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** radarr:7878 (Caddy reverse proxy)
|
||||
- **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.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/Radarr
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
generate: openssl rand -hex 32
|
||||
```
|
||||
|
||||
### 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 the initial deployment, run `./deploy.sh` to configure Radarr with your preferred settings.
|
||||
|
||||
---
|
||||
|
||||
## User Guide
|
||||
|
||||
### Accessing radarr
|
||||
| Service | URL | Purpose |
|
||||
- **radarr** | https://radarr.netgrimoire.com | Web interface for uploading and searching movies |
|
||||
|
||||
### Primary Use Cases
|
||||
Use the Radarr web interface to manage your digital media collections, including adding movies, creating folders, and searching for specific titles.
|
||||
|
||||
### 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.
|
||||
|
||||
---
|
||||
|
||||
## 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.
|
||||
|
||||
### Restore
|
||||
If the Radarr instance fails, run `./deploy.sh` to restore the configuration from a 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 |
|
||||
|
||||
---
|
||||
|
||||
## 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 |
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-05-08T03:11:25.975Z
|
||||
- Source: swarm/radarr.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue