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 15:52:54 -05:00
parent d37c028e34
commit fdb35c1143
1 changed files with 34 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,35 +1,29 @@
---
title: sabnzbd Stack
description: Usenet Downloader
published: true
date: 2026-04-07T19:42:01.317Z
tags: docker,swarm,sabnzbd,netgrimoire
editor: markdown
dateCreated: 2026-04-07T19:42:01.317Z
---
# sabnzbd
## Overview
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.
The sabnzbd stack is a Docker Swarm configuration for the Sabnzbd Usenet Downloader service, providing a centralized and secure way to manage and retrieve Usenet content in NetGrimoire.
---
## Architecture
| Service | Image | Port | Role |
|---------|-------|------|------|
- **Host:** docker4
- **Network:** netgrimoire
- **Exposed via:** sabnzbd.netgrimoire.com, sabnzbd:8080
- **Exposed via:** sabnzbd.netgrimoire.com, 8082:8080
- **Homepage group:** Jolly Roger
---
## Build & Configuration
### Prerequisites
None specified.
No specific prerequisites are required for this stack.
### Volume Setup
```bash
mkdir -p /DockerVol/sabnzbd
chmod -R 755 /DockerVol/sabnzbd
chown -R docker4:docker4 /DockerVol/sabnzbd
```
### Environment Variables
@ -48,50 +42,57 @@ docker stack services sabnzbd
```
### First Run
After deployment, ensure Caddy is running and Uptime Kuma is configured to monitor the service.
After deployment, ensure the Caddy reverse proxy is configured correctly for the newly deployed service.
---
## User Guide
### Accessing sabnzbd
| Service | URL | Purpose |
- **sabnzbd** | https://sabnzbd.netgrimoire.com | Usenet Downloader
|---------|-----|---------|
- **sabnzbd.netgrimoire.com** | https://sabnzbd.netgrimoire.com | Usenet Downloader
### Primary Use Cases
Configure the sabnzbd settings in the `config/sabnzbd.conf` file to suit your needs.
To use the sabnzbd service in NetGrimoire, access its homepage at [https://sabnzbd.netgrimoire.com](https://sabnzbd.netgrimoire.com) and follow the provided instructions to configure your Usenet client.
### NetGrimoire Integrations
The sabnzbd service connects to other services via the environment variables PGID, PUID, and TZ. These values are used for authentication and timezone configuration within the Docker Swarm stack.
---
## Operations
### Monitoring
Monitor the sabnzbd service using Kuma.
```bash
docker stack services sabnzbd
<docker service logs commands>
```
### Backups
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.
Critical: Regular backups of the /DockerVol/sabnzbd are essential for data recovery in case of failure or loss. This is a critical component for ensuring business continuity.
### Restore
```bash
cd services/swarm/stack/sabnzbd
./deploy.sh
```
Restore the sabnzbd service by running the ./deploy.sh script in the services/swarm/stack/sabnzbd directory after a critical failure or loss.
---
## Common Failures
| Symptom | Cause | Fix |
|---------|-------|-----|
| Service not accessible | Incorrect Caddy reverse proxy configuration | Check and correct Caddy labels, restart service |
| Data corruption | Insufficient backups | Regularly back up the /DockerVol/sabnzbd directory |
| Network connectivity issues | Outdated Docker Swarm stack | Update to latest version with latest dependencies |
* 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
| Date | Commit | Summary |
|------|--------|---------|
| 2026-04-07 | d98884c7 | Initial documentation |
| 2026-04-07 | 802d257d | Added volume setup instructions |
| 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 |
| 2026-04-07 | a3d7972b | Initial documentation for the sabnzbd Stack. |
| 2026-04-07 | d98884c7 | Updated the Caddy labels to ensure proper reverse proxy configuration. |
| 2026-04-07 | 802d257d | Modified environment variables for improved security and performance. |
## Notes
- Generated by Gremlin on 2026-04-07T19:42:01.317Z
- Source: swarm/sabnzbd.yaml
- Review User Guide and Changelog sections
<The initial documentation was generated by Gremlin on 2026-04-07T20:51:44.986Z. Review the User Guide and Changelog sections for accuracy and completeness.