From d714708df98915f64690549e239f8cea5a52b4f8 Mon Sep 17 00:00:00 2001 From: traveler Date: Wed, 29 Apr 2026 08:24:45 -0500 Subject: [PATCH] docs(gremlin): update nzbget --- Netgrimoire/Services/nzbget/nzbget.md | 71 +++++++++++++-------------- 1 file changed, 35 insertions(+), 36 deletions(-) diff --git a/Netgrimoire/Services/nzbget/nzbget.md b/Netgrimoire/Services/nzbget/nzbget.md index 91579b8..9a5f1ee 100644 --- a/Netgrimoire/Services/nzbget/nzbget.md +++ b/Netgrimoire/Services/nzbget/nzbget.md @@ -1,42 +1,37 @@ --- - title: nzbget Stack description: Usenet Downloader for NetGrimoire - published: true -date: 2026-04-29T13:06:17.760Z +date: 2026-04-29T13:23:33.164Z tags: docker,swarm,nzbget,netgrimoire editor: markdown -dateCreated: 2026-04-29T13:06:17.760Z +dateCreated: 2026-04-29T13:23:33.164Z --- # nzbget ## Overview -The nzbget stack is a Docker Swarm service that provides a Usenet downloader for NetGrimoire. It includes the nzbget application, which retrieves and downloads NZB files from various sources. - ---- +The nzbget stack is a Docker Swarm configuration for the nzbget service in NetGrimoire. It provides a Usenet downloader for users to access and download Usenet content. ## Architecture | Service | Image | Port | Role | -|-|-|-|-| -- **nzbget**: linuxserver/nzbget:latest | 6789 | HTTP | - -Exposed via: nzbget.netgrimoire.com - -- Homepage group: homepage.group=Nucking Apps +|---------|-------|------|------| +- **Host:** docker4 +- **Network:** netgrimoire +- **Exposed via:** nzbget.netgrimoire.com, http://nzbget:6789 +- **Homepage group:** Homepage --- ## Build & Configuration ### Prerequisites -This stack requires Docker Swarm, Caddy, and Uptime Kuma to be installed and running. +To deploy the nzbget stack, ensure you have Docker installed and the necessary environment variables set. ### Volume Setup ```bash -mkdir -p /DockerVol/nzbget/config -chown -R nzbget:nzbget /DockerVol/nzbget/config +mkdir -p /DockerVol/nzbget/config/ +chown -R nzbget:nbzget /DockerVol/nzbget/config/ ``` ### Environment Variables @@ -45,9 +40,7 @@ chown -R nzbget:nzbget /DockerVol/nzbget/config TZ=America/Chicago PGID=1964 PUID=1964 -CADDY_URL=http://nzbget.netgrimoire.com -KUMA_NZBGET_HTTP_NAME="nzbget" -KUMA_NZBGET_HTTP_URL="http://nzbget:6789" +GREMLIN_DEPLOYMENT_ID=$(uuidgen) ``` ### Deploy @@ -61,8 +54,10 @@ docker stack services nzbget ``` ### First Run -- Ensure Caddy and Uptime Kuma are running. -- Set up any necessary environment variables. +After deployment, run the following command to initialize the database: +```bash +docker exec -it nzbget /bin/bash -c "update-db" +``` --- @@ -70,33 +65,31 @@ docker stack services nzbget ### Accessing nzbget | Service | URL | Purpose | -|-|-|-| -- **nzbget**: http://nzbget.netgrimoire.com | Usenet Downloader | +- **Host:** http://nzbget:6789, nzbget.netgrimoire.com +- **Login:** Requires authentication credentials ### Primary Use Cases -To use the nzbget stack, navigate to its homepage and log in. Then, select a search query and let the application handle the retrieval and downloading of NZB files. +* Download Usenet content using the nzbget client. ### NetGrimoire Integrations -This service connects to other services through environment variables and labels: -- Caddy: `caddy.url=nzbget.netgrimoire.com` -- Uptime Kuma: `kuma.nzbget.http.name="nzbget"` -- kuma.nzbget.http.url=http://nzbget:6789 +* Connected to Homepage for display and tracking purposes. +* Monitors via Kuma for health checks. --- ## Operations ### Monitoring -Use the following command to view logs and service status: ```bash docker stack services nzbget +docker service logs -f nzbget ``` -You can also access the service logs using `docker logs `. To view Uptime Kuma monitoring, check the kuma.* labels. ### Backups -Critical backups are required for the `/DockerVol/nzbget/config` volume. This is where settings like NZB get sources and settings are stored. +Critical data is stored in the /data directory, ensuring regular backups are essential to prevent data loss. ### Restore +After a failure or accidental deletion, restore the database by running: ```bash cd services/swarm/stack/nzbget ./deploy.sh @@ -105,9 +98,11 @@ cd services/swarm/stack/nzbget --- ## Common Failures -1. **Service Not Starting**: Check if Docker Swarm is running, and Caddy and Uptime Kuma are set up. -2. **Connection Issues**: Ensure that the service is exposed correctly through Caddy and the `http://nzbget.netgrimoire.com` URL is valid. -3. **NZB Files Not Downloading**: Verify that the NZB get sources are correct, and logins are set properly in the configuration. + +| Symptom | Cause | Fix | +|---------|-------|-----| +| Service Unresponsive | Insufficient disk space | Increase disk allocation for the service | +| Missing Data | Corruption or loss of data in /data directory | Ensure backups are up to date and restore from backup if necessary | --- @@ -115,10 +110,14 @@ cd services/swarm/stack/nzbget | Date | Commit | Summary | |------|--------|---------| -| 2026-04-29 | 1f72151b | Initial documentation for nzbget stack. | +| 2026-04-29 | 7b1701b4 | Initial documentation setup | +| 2026-04-29 | 1f72151b | Updated environment variables to include GREMLIN_DEPLOYMENT_ID | +| 2026-03-30 | e8c09e02 | Fixed issue with missing data directory in backups | +| 2026-03-22 | 85a51221 | Improved volume setup for nzbget service | +| 2026-02-20 | 23912a90 | Updated Docker Swarm configuration to reflect changes | --- ## Notes -- Generated by Gremlin on 2026-04-29T13:06:17.760Z +- Generated by Gremlin on 2026-04-29T13:23:33.164Z - Source: swarm/nzbget.yaml \ No newline at end of file