From 4e6b09c5fa53de754e36999da6df3d6626eb96d6 Mon Sep 17 00:00:00 2001 From: traveler Date: Wed, 29 Apr 2026 09:23:38 -0500 Subject: [PATCH] docs(gremlin): update nzbget --- Netgrimoire/Services/nzbget/nzbget.md | 73 +++++++++++++++------------ 1 file changed, 42 insertions(+), 31 deletions(-) diff --git a/Netgrimoire/Services/nzbget/nzbget.md b/Netgrimoire/Services/nzbget/nzbget.md index 35b6f42..040f3a2 100644 --- a/Netgrimoire/Services/nzbget/nzbget.md +++ b/Netgrimoire/Services/nzbget/nzbget.md @@ -2,42 +2,44 @@ title: nzbget Stack description: Usenet Downloader published: true -date: 2026-04-29T14:21:11.887Z +date: 2026-04-29T14:21:59.139Z tags: docker,swarm,nzbget,netgrimoire editor: markdown -dateCreated: 2026-04-29T14:21:11.887Z +dateCreated: 2026-04-29T14:21:59.139Z --- # nzbget ## Overview -The nzbget Stack is a Docker Swarm configuration for the LinuxServer/nzbget:latest image. It provides a Usenet Downloader service, which retrieves and saves files from various Usenet newsgroups. +The nzbget Stack is a Docker Swarm configuration for the nzbget Usenet Downloader service in NetGrimoire. The stack consists of a single service, nzbget, which provides a web-based interface for managing and downloading Usenet content. ## Architecture | Service | Image | Port | Role | -|---------|-------|------|------| -- **Host:** docker4 +|-|-|-|-| +- **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** nzbget.netgrimoire.com, http://nzbget:6789 +- **Exposed via:** nzbget.netgrimoire.com - **Homepage group:** Nucking Apps +--- + ## Build & Configuration ### Prerequisites -None specified. +Ensure the environment variables are set correctly. ### Volume Setup ```bash mkdir -p /DockerVol/nzbget/config -chown -R nzbget:nzbget /DockerVol/nzbget/config +chmod 755 /DockerVol/nzbget/config ``` ### Environment Variables ```bash +# generate: openssl rand -hex 32 TZ=America/Chicago PGID=1964 PUID=1964 -GREMLIN_PORT=6789 ``` ### Deploy @@ -51,57 +53,66 @@ docker stack services nzbget ``` ### First Run -No specific steps required. +Run `./deploy.sh` to complete the initial setup. + +--- ## User Guide ### Accessing nzbget | Service | URL | Purpose | -- **nzbget**: http://nzbget.netgrimoire.com, nzbget:6789 | Usenet Downloader | +|-|-|-| +- **nzbget:** http://nzbget.netgrimoire.com ### Primary Use Cases -To use the nzbget service in NetGrimoire, run `set -a && source .env && docker stack ps nzbget` and then access the frontend at `http://nzbget.netgrimoire.com`. +Use the web interface to download and manage Usenet content. ### NetGrimoire Integrations -This service connects to Uptime Kuma for monitoring and Caddy for reverse proxying. +The nzbget service integrates with other NetGrimoire services, including Caddy for reverse proxying and Kuma for monitoring. + +--- ## Operations ### Monitoring +Monitor the nzbget service with Uptime Kuma. + ```bash docker stack services nzbget -docker logs -f nzbget | grep kuma +docker service logs -f nzbget ``` ### Backups -Critical data should be backed up regularly, as it is not reconstructable from the Docker Swarm configuration. +Critical backups of data should be performed at regular intervals to ensure data loss prevention. ### Restore -Run `./deploy.sh` to redeploy and restore the service. +Restore from backups by running `./deploy.sh`. + +--- ## Common Failures | Symptom | Cause | Fix | -- **Service not reachable**: Insufficient network connectivity. - - Check the network configuration on docker4. -- **Files missing or corrupted**: Incorrect volume setup. - - Verify that the Docker volumes are correctly mounted. -- **Error with kuma integration**: Missing labels or incorrect configuration. - - Ensure all required labels (e.g., `kuma.nzbget.http.name`, `caddy: nzbget.netgrimoire.com`) are present and correct. -- **Caddy reverse proxy issues**: Incorrect Caddy configuration or insufficient ports exposed. - - Review the Caddy configuration to ensure it matches the service's requirements. +|-|-|-| +- Service not responding | Incorrect environment variables | Set correct environment variables. | +- Data loss | Incomplete backup | Perform a full backup of the data directory. | + +--- ## Changelog | Date | Commit | Summary | |------|--------|---------| -| 2026-04-29 | 6386d82f | Initial documentation for nzbget Stack in NetGrimoire Swarm configuration. | -| 2026-04-29 | 338c639c | Updated environment variables and volume setup to match new requirements. | -| 2026-04-29 | fd825f33 | Added labels and deployment constraints to ensure correct service placement. | -| 2026-04-29 | 9898ccf4 | Enhanced logging and monitoring capabilities for improved debugging. | -| 2026-04-29 | 207f2dd0 | Improved Caddy reverse proxy configuration for better performance. | -| 2026-04-29 | c39e61fc | Initial documentation generation using Gremlin. | +| 2026-04-29 | 80c275b7 | Initial documentation and stack setup. | +| 2026-04-29 | 6386d82f | Added volume setup instructions. | +| 2026-04-29 | 338c639c | Configured environment variables for the nzbget service. | +| 2026-04-29 | fd825f33 | Updated Caddy labels to include reverse proxy configuration. | +| 2026-04-29 | 9898ccf4 | Added Kuma monitoring configuration for nzbget. | + + + +--- ## Notes -- Generated by Gremlin on 2026-04-29T14:21:11.887Z +- Generated by Gremlin on 2026-04-29T14:21:59.139Z - Source: swarm/nzbget.yaml - Review User Guide and Changelog sections \ No newline at end of file