98 lines
No EOL
3.1 KiB
Markdown
98 lines
No EOL
3.1 KiB
Markdown
# sabnzbd
|
|
|
|
## Overview
|
|
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, 8082:8080
|
|
- **Homepage group:** Jolly Roger
|
|
|
|
---
|
|
|
|
## Build & Configuration
|
|
|
|
### Prerequisites
|
|
No specific prerequisites are required for this stack.
|
|
|
|
### Volume Setup
|
|
```bash
|
|
mkdir -p /DockerVol/sabnzbd
|
|
chown -R docker4:docker4 /DockerVol/sabnzbd
|
|
```
|
|
|
|
### Environment Variables
|
|
```bash
|
|
generate: openssl rand -hex 32
|
|
```
|
|
|
|
### 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 deployment, ensure the Caddy reverse proxy is configured correctly for the newly deployed service.
|
|
|
|
---
|
|
|
|
## User Guide
|
|
|
|
### Accessing sabnzbd
|
|
| Service | URL | Purpose |
|
|
|---------|-----|---------|
|
|
- **sabnzbd.netgrimoire.com** | https://sabnzbd.netgrimoire.com | Usenet Downloader
|
|
|
|
### Primary Use Cases
|
|
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: 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
|
|
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 |
|
|
|
|
---
|
|
|
|
## Changelog
|
|
|
|
| Date | Commit | Summary |
|
|
|------|--------|---------|
|
|
| 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. |
|
|
|
|
<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. |