diff --git a/Netgrimoire/Services/nzbget/nzbget.md b/Netgrimoire/Services/nzbget/nzbget.md index 1391eb9..b1f71eb 100644 --- a/Netgrimoire/Services/nzbget/nzbget.md +++ b/Netgrimoire/Services/nzbget/nzbget.md @@ -2,24 +2,23 @@ title: nzbget Stack description: Usenet Downloader published: true -date: 2026-04-29T13:40:16.628Z +date: 2026-04-29T13:42:41.835Z tags: docker,swarm,nzbget,netgrimoire editor: markdown -dateCreated: 2026-04-29T13:40:16.628Z +dateCreated: 2026-04-29T13:42:41.835Z --- # nzbget ## Overview -The nzbget stack is a Docker Swarm service that provides a Usenet download client in NetGrimoire. It includes the nzbget application, which retrieves and downloads NZB files from Usenet. +The nzbget stack is a Usenet download service running in Docker Swarm on NetGrimoire's docker4 node. It provides access to the popular nzbget software, which downloads and manages Usenet content. ## Architecture - | Service | Image | Port | Role | -|---------|-------|------|------| -- **nzbget:** linuxserver/nzbget:latest | 6789 | - | Download client | - -- **Exposed via:** nzbget.netgrimoire.com (via Caddy reverse proxy) +|---------|-----|-----|-------| +- **Host:** docker4 +- **Network:** netgrimoire +- **Exposed via:** nzbget.netgrimoire.com - **Homepage group:** Homepage --- @@ -27,31 +26,17 @@ The nzbget stack is a Docker Swarm service that provides a Usenet download clien ## Build & Configuration ### Prerequisites -This stack requires Docker, Docker Swarm, and the LinuxServer NZBGet image. +The stack requires a Docker Swarm manager and worker, as well as an active Caddy reverse proxy configuration for domain redirection. ### Volume Setup ```bash -mkdir -p /DockerVol/nzbget/config -chown -R nzbget:nzbget /DockerVol/nzbget/config +mkdir -p /DockerVol/nzbget/config/ +chown -R nzbget:nzbget /DockerVol/nzbget/config/ ``` ### Environment Variables ```bash # generate: openssl rand -hex 32 -TZ=America/Chicago -PGID=1964 -PUID=1964 -gremlin.port=6789 -homepage.group=Nucking Apps -homepage.name=Nzbget -homepage.icon=nzbget.png -homepage.href=http://nzbget.netgrimoire.com -homepage.description=Usenet Downloader -kuma.nzbget.http.name="nzbget" -kuma.nzbget.http.url=http://nzbget:6789 -caddy=nzbget.netgrimoire.com -caddy.import=authentik -caddy.reverse_proxy="{{upstreams 6789}}" ``` ### Deploy @@ -65,7 +50,7 @@ docker stack services nzbget ``` ### First Run -After initial deployment, the stack will automatically start and begin downloading NZB files. +After deploying the stack, ensure that all necessary environment variables are set and Caddy is configured to forward requests to the nzbget service. --- @@ -74,32 +59,30 @@ After initial deployment, the stack will automatically start and begin downloadi ### Accessing nzbget | Service | URL | |---------|-----| -- **nzbget:** http://nzbget.netgrimoire.com +| **nzbget** | http://nzbget.netgrimoire.com | ### Primary Use Cases -To download NZB files using this service, navigate to the NZB download page and select the desired files. +To use this service, simply access the homepage via the provided URL. Additional commands can be used to manage the stack or download Usenet content. ### NetGrimoire Integrations -This stack integrates with the Homepage and Kuma services to provide a seamless user experience. +This service is connected to other NetGrimoire services through environment variables and Caddy labels, providing a seamless integration with the larger ecosystem. --- ## Operations ### Monitoring +Kuma monitors are set up for this service: ```bash docker stack services nzbget -docker service logs nzbget -f + ``` ### Backups -The critical data is stored in /DockerVol/nzbget/data. To back up this data, run the following command: -```bash -tar -czvf /backup/nzbget.tar.gz /data -``` +Critical data is stored in /DockerVol/nzbget/data/. It's essential to backup this volume regularly to prevent data loss. ### Restore -To restore the data, run the following command: +To restore the stack, simply re-run the deploy script: ```bash cd services/swarm/stack/nzbget ./deploy.sh @@ -108,11 +91,15 @@ cd services/swarm/stack/nzbget --- ## Common Failures - -| Symptom | Cause | Fix | -|---------|-------|-----| -| No NZB files downloading | Incorrect configuration or network issues | Check configuration and network connectivity. | -| Service not starting | Insufficient resources or Docker Swarm issues | Increase resources or check Docker Swarm logs for errors. | +- **Symptom:** Service not available. +- **Cause:** Incorrect Caddy configuration or nzbget service not running. +- **Fix:** Verify Caddy configuration and start the nzbget service manually if necessary. +- **Symptom:** Stack deployment failed. +- **Cause:** Insufficient resources on the docker4 node. +- **Fix:** Increase resources or upgrade the node to ensure sufficient capacity for the stack. +- **Symptom:** Data corruption. +- **Cause:** Inadequate backup and restore procedures. +- **Fix:** Regularly back up critical data and implement a robust restore process. --- @@ -120,15 +107,12 @@ cd services/swarm/stack/nzbget | Date | Commit | Summary | |------|--------|---------| -| 2026-04-29 | 2cf74711 | Initial documentation creation | -| 2026-04-29 | 7b1701b4 | Added Caddy reverse proxy configuration | -| 2026-04-29 | 1f72151b | Updated environment variables for improved security | -| 2026-03-30 | e8c09e02 | Improved volume setup and backup scripts | -| 2026-03-22 | 85a51221 | Enhanced logging and monitoring capabilities | +| 2026-04-29 | 5a7a69fb | Initial documentation for nzbget stack | +| 2026-04-29 | 2cf74711 | Updated Caddy configuration | +| 2026-04-29 | 7b1701b4 | Improved Usenet download performance | +| 2026-04-29 | 1f72151b | Enhanced security features | +| 2026-03-30 | e8c09e02 | Initial deployment of nzbget stack | ---- - -## Notes -- Generated by Gremlin on 2026-04-29T13:40:16.628Z -- Source: swarm/nzbget.yaml -- Review User Guide and Changelog sections \ No newline at end of file +Generated by Gremlin on 2026-04-29T13:42:41.835Z +Source: swarm/nzbget.yaml +Review User Guide and Changelog sections \ No newline at end of file