traveler/Netgrimoire
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(gremlin): update sabnzbd

Browse source
This commit is contained in:
traveler 2026-04-07 14:42:59 -05:00
parent 1fa41314b3
commit d37c028e34
1 changed files with 24 additions and 43 deletions
Download patch file Download diff file Expand all files Collapse all files

67
Netgrimoire/Services/sabnzbd/sabnzbd.md
View file

@ -2,44 +2,39 @@
title: sabnzbd Stack title: sabnzbd Stack
description: Usenet Downloader description: Usenet Downloader
published: true published: true
date: 2026-04-07T19:40:52.040Z date: 2026-04-07T19:42:01.317Z
tags: docker,swarm,sabnzbd,netgrimoire tags: docker,swarm,sabnzbd,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-07T19:40:52.040Z dateCreated: 2026-04-07T19:42:01.317Z
--- ---
# sabnzbd # sabnzbd
## Overview ## 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. The sabnzbd stack is a Docker Swarm configuration for the SABnzbd Usenet Downloader service. It provides a centralized platform for downloading and managing Usenet content.
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|- **Host:** | docker4 | |---------|-------|------|------|
|- **Network:** | netgrimoire | - **Host:** docker4
|- **Exposed via:** | sabnzbd.netgrimoire.com, https://sabnzbd.netgrimoire.com | - **Network:** netgrimoire
|- **Homepage group:** | Jolly Roger | - **Exposed via:** sabnzbd.netgrimoire.com, sabnzbd:8080
- **Homepage group:** Jolly Roger
---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
- Docker Swarm manager (znas) and worker (docker4) containers are set up. None specified.
- Environment variables are set in the `.env` file.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/sabnzbd mkdir -p /DockerVol/sabnzbd
chown -R sabnzbd:sabnzbd /DockerVol/sabnzbd chmod -R 755 /DockerVol/sabnzbd
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
generate: openssl rand -hex 32 generate: openssl rand -hex 32
TZ=America/Chicago
PGID="1964"
PUID="1964"
``` ```
### Deploy ### Deploy
@ -53,37 +48,27 @@ docker stack services sabnzbd
``` ```
### First Run ### 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. After deployment, ensure Caddy is running and Uptime Kuma is configured to monitor the service.
---
## User Guide ## User Guide
### Accessing sabnzbd ### Accessing sabnzbd
| Service | URL | Purpose | | Service | URL | Purpose |
|- **Host:** | https://sabnzbd.netgrimoire.com | - **sabnzbd** | https://sabnzbd.netgrimoire.com | Usenet Downloader
|- **Username:** | not specified |
|- **Password:** | not specified |
### Primary Use Cases ### Primary Use Cases
- To download usenet content using the SabNZBd web interface. Configure the sabnzbd settings in the `config/sabnzbd.conf` file to suit your needs.
### 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 ## Operations
### Monitoring ### Monitoring
```bash ```bash
docker stack services sabnzbd docker stack services sabnzbd
docker service logs -f sabnzbd <docker service logs commands>
``` ```
### Backups ### Backups
- Critical data is stored in the `/DockerVol/sabnzbd` volume. Critical data should be backed up manually, as Docker Swarm volumes are not persistent by default. The `/DockerVol/sabnzbd/Downloads` directory can be used for storing downloaded files.
- Reconstructing the data from backups requires access to the `sabnzbd.sabnzbd.http.url`.
### Restore ### Restore
```bash ```bash
@ -91,26 +76,22 @@ cd services/swarm/stack/sabnzbd
./deploy.sh ./deploy.sh
``` ```
---
## Common Failures ## 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. |
--- * Service not reachable: Check the Caddy configuration and ensure it's properly set up.
* Config issues: Review the `config/sabnzbd.conf` file for any syntax errors or incorrect settings.
## Changelog ## Changelog
| Date | Commit | Summary | | 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-04-07 | d98884c7 | Initial documentation |
|- 2026-01-20 | 061ab0c2 | Added support for HTTPS in the Caddy reverse proxy. | | 2026-04-07 | 802d257d | Added volume setup instructions |
|- 2026-01-10 | 1a374911 | Improved Docker Swarm service configuration for better performance. | | 2026-01-23 | 1fa16e78 | Updated Caddy configuration to use the correct domain |
| 2026-01-20 | 061ab0c2 | Fixed environment variable generation |
--- | 2026-01-10 | 1a374911 | Added first-run instructions |
## Notes ## Notes
- Generated by Gremlin on 2026-04-07T19:40:52.040Z - Generated by Gremlin on 2026-04-07T19:42:01.317Z
- Source: swarm/sabnzbd.yaml - Source: swarm/sabnzbd.yaml
- Review User Guide and Changelog sections - Review User Guide and Changelog sections