New Grimoire
This commit is contained in:
parent
77d589a13d
commit
cc574f8aed
157 changed files with 29420 additions and 0 deletions
127
Shadow-Grimoire/Arr/Sonarr.md
Normal file
127
Shadow-Grimoire/Arr/Sonarr.md
Normal file
|
|
@ -0,0 +1,127 @@
|
|||
# sonarr
|
||||
|
||||
## Overview
|
||||
This stack provides a Docker Swarm configuration for Sonarr, a media library and download client. The stack includes Caddy as a reverse proxy, Uptime Kuma for monitoring, and serves Sonarr's web interface.
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-------|-----|------|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** sonarr.netgrimoire.com
|
||||
- **Homepage group:** Jolly Roger
|
||||
|
||||
---
|
||||
|
||||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
No specific prerequisites are required.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/Sonarr:/config
|
||||
chown -R sonarr:sonarr /DockerVol/Sonarr
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
# generate: openssl rand -hex 32
|
||||
TZ=America/Chicago
|
||||
PUID=1964
|
||||
PGID=1964
|
||||
CADDY_CERT=$(openssl rand -hex 32)
|
||||
CADDY_KEY=$(openssl rand -hex 32)
|
||||
```
|
||||
|
||||
### Deploy
|
||||
```bash
|
||||
cd services/swarm/stack/sonarr
|
||||
set -a && source .env && set +a
|
||||
docker stack config --compose-file sonarr-stack.yml > resolved.yml
|
||||
docker stack deploy --compose-file resolved.yml sonarr
|
||||
rm resolved.yml
|
||||
docker stack services sonarr
|
||||
```
|
||||
|
||||
### First Run
|
||||
No specific post-deploy steps are required.
|
||||
|
||||
---
|
||||
|
||||
## User Guide
|
||||
|
||||
### Accessing sonarr
|
||||
| Service | URL | Purpose |
|
||||
|---------|-----|---------|
|
||||
- **Sonarr**: https://sonarr.netgrimoire.com (Caddy reverse proxy)
|
||||
|
||||
### Primary Use Cases
|
||||
Access Sonarr's web interface to manage your media library and download clients.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
This stack connects to other services through environment variables:
|
||||
- `HOME PAGE GROUP`: Jolly Roger
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
[kuma.sonarr.http.name: Sonarr, kuma.sonarr.http.url: https://sonarr.netgrimoire.com]
|
||||
|
||||
```bash
|
||||
docker stack services sonarr
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical backups should be performed regularly. For reconstructing a full backup:
|
||||
- `/DockerVol/Sonarr:/config` and other critical volumes are the target
|
||||
|
||||
### Restore
|
||||
```bash
|
||||
cd services/swarm/stack/sonarr
|
||||
./deploy.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
| Symptom | Cause | Fix |
|
||||
|---------|-------|-----|
|
||||
1. **Failed to connect**: Insufficient Caddy reverse proxy configuration.
|
||||
- Check `CADDY_CERT` and `CADDY_KEY` environment variables for correct formatting.
|
||||
- Update Caddy configuration if necessary.
|
||||
|
||||
2. **Uptime Kuma failed to connect**: Incorrect HTTP URL or port.
|
||||
- Ensure the URL and port are correctly set in Uptime Kuma's configuration.
|
||||
- Restart services with `docker stack restart sonarr`
|
||||
|
||||
3. **Sonarr not starting**: Incompatible Docker image or missing environment variables.
|
||||
- Check the Sonarr Docker image version for compatibility.
|
||||
- Verify all required environment variables are present and correct.
|
||||
|
||||
4. **Caddy reverse proxy not working**: Incorrect Caddy configuration.
|
||||
- Review Caddy configuration files (`sonarr-stack.yml`) for errors.
|
||||
- Restart services with `docker stack restart sonarr`
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-07 | fb75c66d | Initial documentation creation. |
|
||||
|
||||
<Write a paragraph summarizing the evolution of this service based on the diffs above.>
|
||||
|
||||
This stack was created with Docker Swarm configuration in mind, marking a migration from earlier swarm configurations.
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-07T19:37:34.802Z
|
||||
- Source: swarm/sonarr.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue