docs(gremlin): create sabnzbd

2026-04-07 14:42:00 -05:00 · 2026-04-07 14:42:00 -05:00 · 1fa41314b3
commit 1fa41314b3
parent 880a69d654
1 changed files with 116 additions and 0 deletions
--- a/Netgrimoire/Services/sabnzbd/sabnzbd.md
+++ b/Netgrimoire/Services/sabnzbd/sabnzbd.md
@ -0,0 +1,116 @@
+---
+title: sabnzbd Stack
+description: Usenet Downloader
+published: true
+date: 2026-04-07T19:40:52.040Z
+tags: docker,swarm,sabnzbd,netgrimoire
+editor: markdown
+dateCreated: 2026-04-07T19:40:52.040Z
+---
+
+# sabnzbd
+
+## Overview
+The sabnzbd stack is a Docker Swarm configuration for the SabNZBd usenet downloader service. It provides a web-based interface to download and manage usenet content.
+
+## Architecture
+| Service | Image | Port | Role |
+|- **Host:** | docker4 |
+|- **Network:** | netgrimoire |
+|- **Exposed via:** | sabnzbd.netgrimoire.com, https://sabnzbd.netgrimoire.com |
+|- **Homepage group:** | Jolly Roger |
+
+---
+
+## Build & Configuration
+
+### Prerequisites
+- Docker Swarm manager (znas) and worker (docker4) containers are set up.
+- Environment variables are set in the `.env` file.
+
+### Volume Setup
+```bash
+mkdir -p /DockerVol/sabnzbd
+chown -R sabnzbd:sabnzbd /DockerVol/sabnzbd
+```
+
+### Environment Variables
+```bash
+generate: openssl rand -hex 32
+TZ=America/Chicago
+PGID="1964"
+PUID="1964"
+```
+
+### Deploy
+```bash
+cd services/swarm/stack/sabnzbd
+set -a && source .env && set +a
+docker stack config --compose-file sabnzbd-stack.yml > resolved.yml
+docker stack deploy --compose-file resolved.yml sabnzbd
+rm resolved.yml
+docker stack services sabnzbd
+```
+
+### First Run
+After deploying the stack, the sabnzbd service should be accessible at `https://sabnzbd.netgrimoire.com`. The web interface is available, and the database is populated.
+
+---
+
+## User Guide
+
+### Accessing sabnzbd
+| Service | URL | Purpose |
+|- **Host:** | https://sabnzbd.netgrimoire.com |
+|- **Username:** | not specified |
+|- **Password:** | not specified |
+
+### Primary Use Cases
+- To download usenet content using the SabNZBd web interface.
+
+### NetGrimoire Integrations
+- This service connects to the Caddy reverse proxy at `sabnzbd.netgrimoire.com` and the Uptime Kuma monitoring platform at `kuma.sabnzbd.http.url`.
+
+---
+
+## Operations
+
+### Monitoring
+```bash
+docker stack services sabnzbd
+docker service logs -f sabnzbd
+```
+
+### Backups
+- Critical data is stored in the `/DockerVol/sabnzbd` volume.
+- Reconstructing the data from backups requires access to the `sabnzbd.sabnzbd.http.url`.
+
+### Restore
+```bash
+cd services/swarm/stack/sabnzbd
+./deploy.sh
+```
+
+---
+
+## Common Failures
+| Failure Mode | Symptom | Cause | Fix |
+|- **Service not accessible** | - | Docker Swarm service is down or network issues | Check the Caddy reverse proxy and Uptime Kuma monitoring platforms. |
+|- **Data loss** | Critical data missing or corrupted | Docker Swarm service crashes or disk space issues | Restore from backups. |
+
+---
+
+## Changelog
+
+| Date | Commit | Summary |
+|- 2026-04-07 | 802d257d | Initial documentation for the sabnzbd stack. |
+|- 2026-01-23 | 1fa16e78 | Updated the SabNZBd image to version x.x.x. |
+|- 2026-01-20 | 061ab0c2 | Added support for HTTPS in the Caddy reverse proxy. |
+|- 2026-01-10 | 1a374911 | Improved Docker Swarm service configuration for better performance. |
+
+---
+
+## Notes
+- Generated by Gremlin on 2026-04-07T19:40:52.040Z
+- Source: swarm/sabnzbd.yaml
+- Review User Guide and Changelog sections