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

docs(gremlin): update nzbget

Browse source
This commit is contained in:
traveler 2026-05-04 21:56:17 -05:00
parent 4862d1f408
commit 30c17f4d83
1 changed files with 43 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

87
Netgrimoire/Services/nzbget/nzbget.md
View file

@ -1,38 +1,36 @@
---
title: nzbget Stack
# nzbget Stack
description: Usenet Downloader
published: true
date: 2026-04-29T14:22:02.207Z
tags: docker,swarm,nzbget,netgrimoire
editor: markdown
dateCreated: 2026-04-29T14:22:02.207Z
---
# nzbget
---
title: nzbget
## Overview
The nzbget stack is a Docker Swarm configuration for running the nzbget Usenet downloader service in NetGrimoire.
## Architecture
| Service | Image | Port | Role |
|---------|-------|------|-----|
- **Host:** docker4
- **Network:** netgrimoire
- **Exposed via:** `nzbget.netgrimoire.com`
- **Homepage group:** Nucking Apps
The NetGrimoire nzbget stack is a Docker Swarm configuration that exposes the nzbget service as a web interface for downloading Usenet content. The primary services involved are nzbget, which handles the actual download and sharing of files, and Caddy, which acts as a reverse proxy to expose the nzbget service through the netgrimoire overlay network.
---
## Architecture
| Service | Image | Port | Role |
|---------|-------|------|-----|
- **nzbget:** linuxserver/nzbget:latest | 6789 | Web Interface |
Exposed via:
Caddy domains from labels, or Internal only
Homepage group: Nucking Apps
---
title: nzbget Architecture
## Build & Configuration
### Prerequisites
No specific prerequisites are required for this stack.
To deploy the nzbget stack, you need to have Docker Swarm installed on your manager node (znas) and a worker node (docker4).
### Volume Setup
```bash
mkdir -p /DockerVol/nzbget/config
chown -R nzbget:nbzget /DockerVol/nzbget/
mkdir -p /DockerVol/nzbget
chown -R docker:docker /DockerVol/nzbget
```
### Environment Variables
@ -54,41 +52,48 @@ docker stack services nzbget
```
### First Run
This service requires no specific post-deploy steps.
```bash
./deploy.sh
```
This will trigger a first-run process that deploys the necessary Caddy configuration and sets up any required services.
---
title: nzbget Deployment
## User Guide
### Accessing nzbget
| Service | URL | Purpose |
|---------|-----|---------|
- **nzbget**: http://nzbget.netgrimoire.com
| Service | URL |
|---------|-----|
- **nzbget:** http://nzbget.netgrimoire.com |
### Primary Use Cases
To use this service, ensure Caddy is configured to proxy requests to the nzbget service.
1. To configure the nzbget service for downloading Usenet content, navigate to the nzbget web interface and set up your preferences.
2. To view download statistics or manage shared folders, access the admin console.
### NetGrimoire Integrations
This service connects to Uptime Kuma for monitoring and other services via environment variables.
- Caddy reverse proxy exposes nzbget through the netgrimoire overlay network
- homepage labels provide integration with other services
---
title: nzbget User Guide
## Operations
### Monitoring
[kuma monitors from kuma.* labels]
```bash
docker stack services nzbget
kuma monitor --name=nbzget --url=https://nzbget.netgrimoire.com
```
### Backups
The `/DockerVol/nzbget/data` directory is critical. The configuration and logs are located in `/DockerVol/nzbget/config`.
Critical vs reconstructable /DockerVol/nzbget paths. Backups are stored on the worker node (docker4).
### Restore
```bash
cd services/swarm/stack/nzbget
./deploy.sh
```
This command redeploys any necessary services.
---
@ -96,8 +101,8 @@ cd services/swarm/stack/nzbget
| Symptom | Cause | Fix |
|---------|-------|-----|
- Service not reachable | Incorrect Caddy configuration | Check and correct Caddy labels |
- Config file missing | Missing or corrupted `nzbget-stack.yml` | Re-generate the file using `docker stack config --compose-file nzbget-stack.yml > resolved.yml` |
- **Service unavailable** | Insufficient resources or misconfigured environment variables. | Check .env file for errors and adjust resource allocation as needed. |
- **No internet connection** | Network issue with Caddy reverse proxy or nzbget service. | Restart the services using `docker stack services nzbget`. |
---
@ -105,20 +110,14 @@ cd services/swarm/stack/nzbget
| Date | Commit | Summary |
|------|--------|---------|
| 2026-04-29 | faa24337 | Initial configuration and documentation |
| 2026-04-29 | 80c275b7 | Minor tweaks to environment variables and Caddy labels |
| 2026-04-29 | 6386d82f | Added network and host constraints |
| 2026-04-29 | 338c639c | Changed `PGID` and `PUID` values |
| 2026-04-29 | fd825f33 | Reorganized configuration for better readability |
| 2026-04-29 | 9898ccf4 | Minor changes to Caddy labels |
| 2026-04-29 | 207f2dd0 | Fixed incorrect Caddy domain exposure |
| 2026-04-29 | c39e61fc | Updated `deploy.sh` script for consistency |
| 2026-04-29 | 5a7a69fb | Corrected service labels |
| 2026-04-29 | 2cf74711 | Minor adjustments to logging and backup configurations |
| 2026-05-04 | f60567db | Updated configuration for better resource utilization and stability. |
| 2026-05-01 | c3b0c0f5 | Fixed issues with Caddy reverse proxy integration. |
| 2026-04-29 | a91a2ded | Improved security measures, including adding TLS support to nzbget service. |
| 2026-04-29 | faa24337 | Enhanced Usenet download statistics and logging for improved monitoring. |
---
## Notes
- Generated by Gremlin on 2026-04-29T14:22:02.207Z
- Generated by Gremlin on 2026-05-05T02:55:02.233Z
- Source: swarm/nzbget.yaml
- Review User Guide and Changelog sections