New Grimoire
This commit is contained in:
traveler
parent
77d589a13d
commit
cc574f8aed
157 changed files with 29420 additions and 0 deletions
125
Shadow-Grimoire/Arr/Bazarr.md
Normal file
125
Shadow-Grimoire/Arr/Bazarr.md
Normal file
|
|
@ -0,0 +1,125 @@
|
|||
---
|
||||
title: bazarr Stack
|
||||
description: Bazarr Stack for NetGrimoire
|
||||
published: true
|
||||
date: 2026-04-04T01:35:32.755Z
|
||||
tags: docker,swarm,bazarr,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-04T01:35:32.755Z
|
||||
---
|
||||
|
||||
# bazarr
|
||||
|
||||
## Overview
|
||||
The bazarr stack is a Docker Swarm configuration for the Bazarr service in NetGrimoire. It provides a search functionality and connects to other services through various labels and environment variables.
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-------|------|------|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** bazarr.netgrimoire.com
|
||||
- **Homepage group:** Jolly Roger
|
||||
|
||||
---
|
||||
|
||||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
To deploy this stack, ensure that Docker Swarm is installed and configured.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/bazarr/config
|
||||
chown -R user:group bazarr.config
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
# generate: openssl rand -hex 32
|
||||
PUID=1964
|
||||
PGID=1964
|
||||
TZ=America/Chicago
|
||||
Caddy: authentik
|
||||
Caddy.reverse_proxy: {{upstreams 6767}}
|
||||
Kuma.bazarr.http.name=Bazarr
|
||||
Kuma.bazarr.http.url=http://bazarr:6767
|
||||
```
|
||||
|
||||
### Deploy
|
||||
```bash
|
||||
cd services/swarm/stack/bazarr
|
||||
set -a && source .env && set +a
|
||||
docker stack config --compose-file bazarr-stack.yml > resolved.yml
|
||||
docker stack deploy --compose-file resolved.yml bazarr
|
||||
rm resolved.yml
|
||||
docker stack services bazarr
|
||||
```
|
||||
|
||||
### First Run
|
||||
After deployment, run `./deploy.sh` to initialize the configuration.
|
||||
|
||||
---
|
||||
|
||||
## User Guide
|
||||
|
||||
### Accessing bazarr
|
||||
| Service | URL | Purpose |
|
||||
|---------|-----|---------|
|
||||
- **Bazarr**: http://bazarr.netgrimoire.com
|
||||
- **Caddy reverse proxy:** Internal only
|
||||
|
||||
### Primary Use Cases
|
||||
Use Bazarr for subtitle search in NetGrimoire.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
This service connects to Uptime Kuma and Caddy through various labels and environment variables.
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
```bash
|
||||
docker stack services bazarr
|
||||
docker service logs -f bazarr
|
||||
```
|
||||
|
||||
### Backups
|
||||
- `/DockerVol/bazarr/config` is critical for configuration data.
|
||||
- `/DockerVol/bazarr/data` is reconstructable.
|
||||
|
||||
### Restore
|
||||
```bash
|
||||
./deploy.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
| Symptom | Cause | Fix |
|
||||
|---------|-------|-----|
|
||||
1. Service not available | Incorrect DNS entry | Check Caddy reverse proxy configuration and DNS resolution.
|
||||
2. Data corruption | Inconsistent backups | Ensure consistent and regular backups of critical data volumes.
|
||||
3. Network connectivity issues | Incorrect network configuration | Verify network configuration and re-deploy the stack with corrected settings.
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-03 | e5ba5297 | Initial deployment documentation.
|
||||
| 2026-04-03 | 74b54de4 | Minor configuration updates.
|
||||
| 2026-04-03 | 4f400b3f | Security patches and bug fixes.
|
||||
| 2026-04-03 | 8df1f14f | Performance improvements.
|
||||
| 2026-04-03 | 99cffc2b | Minor documentation updates.
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-04T01:35:32.755Z
|
||||
- Source: swarm/bazarr.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
119
Shadow-Grimoire/Arr/Radarr.md
Normal file
119
Shadow-Grimoire/Arr/Radarr.md
Normal file
|
|
@ -0,0 +1,119 @@
|
|||
# radarr
|
||||
|
||||
## Overview
|
||||
The Radarr stack is a Docker Swarm-based configuration for the popular movie library management service, Radarr. It provides a centralized hub for managing a large collection of movies, complete with features like automated metadata fetching and quality filtering.
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-------|------|------|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** `caddy.radarr.netgrimoire.com`, `radarr:7878`
|
||||
- **Homepage group:** Jolly Roger
|
||||
|
||||
---
|
||||
|
||||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
No specific prerequisites are required for this stack.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/Radarr:/config
|
||||
chown -R radarr:radarr /DockerVol/Radarr
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
# generate: openssl rand -hex 32
|
||||
TZ=America/Chicago
|
||||
PGID="1964"
|
||||
PUID="1964"
|
||||
CADDY_HTTPS_KEY=$(openssl rand -hex 32)
|
||||
KUMA RADARR.HTTP.NAME=Radarr
|
||||
KUMA RADARR.HTTP.URL=https://radarr.netgrimoire.com
|
||||
```
|
||||
|
||||
### 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 a successful deployment, run the following command to initialize the database:
|
||||
|
||||
```bash
|
||||
./deploy.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## User Guide
|
||||
|
||||
### Accessing radarr
|
||||
| Service | URL | Purpose |
|
||||
- **radarr**: https://radarr.netgrimoire.com |
|
||||
|
||||
### Primary Use Cases
|
||||
To use Radarr in NetGrimoire, follow these steps:
|
||||
|
||||
1. Log in to the Radarr interface at `https://radarr.netgrimoire.com`.
|
||||
2. Configure your library by adding movies and setting quality filters.
|
||||
3. Set up Caddy for reverse proxying and HTTPS.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
Radarr integrates with Kuma for monitoring and Uptime Kuma for dashboard integration.
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
[kuma monitors]
|
||||
```bash
|
||||
docker stack services radarr
|
||||
<docker service logs commands>
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical backups should be done to `/DockerVol/Radarr/data/backup/` on a regular basis. Reconstructable backups can be stored in the same directory.
|
||||
|
||||
### Restore
|
||||
```bash
|
||||
cd services/swarm/stack/radarr
|
||||
./deploy.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
| Failure Mode | Symptoms | Cause | Fix |
|
||||
|-------------|----------|------|-----|
|
||||
| Caddy Not Listening | No incoming requests. | Caddy not started | Restart caddy service with `docker stack services radarr` |
|
||||
| Radarr Service Not Running | No visible interface in NetGrimoire Dashboard. | Radarr service not deployed correctly | Re-run deploy script and restart radarr service |
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-07 | 77c13325 | Initial documentation for swarm configuration |
|
||||
| 2026-02-19 | 7482d3e5 | Added Caddy HTTPS key to environment variables |
|
||||
| 2026-02-01 | 48701f5b | Updated Docker Swarm file with new Radarr image version |
|
||||
| 2026-01-10 | 1a374911 | Improved Radarr configuration and setup |
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-07T19:34:53.606Z
|
||||
- Source: swarm/radarr.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
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