diff --git a/Netgrimoire/Services/nzbget/nzbget.md b/Netgrimoire/Services/nzbget/nzbget.md index b1f71eb..99ae928 100644 --- a/Netgrimoire/Services/nzbget/nzbget.md +++ b/Netgrimoire/Services/nzbget/nzbget.md @@ -2,23 +2,23 @@ title: nzbget Stack description: Usenet Downloader published: true -date: 2026-04-29T13:42:41.835Z +date: 2026-04-29T13:49:13.237Z tags: docker,swarm,nzbget,netgrimoire editor: markdown -dateCreated: 2026-04-29T13:42:41.835Z +dateCreated: 2026-04-29T13:49:13.237Z --- # nzbget ## Overview -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. +The nzbget Stack provides a Usenet Downloader service in NetGrimoire, utilizing the linuxserver/nzbget:latest Docker image. This stack consists of a single service, nzbget. ## Architecture | Service | Image | Port | Role | -|---------|-----|-----|-------| +|---------|-------|------|------| - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** nzbget.netgrimoire.com +- **Exposed via:** nzbget.netgrimoire.com, - **Homepage group:** Homepage --- @@ -26,17 +26,17 @@ The nzbget stack is a Usenet download service running in Docker Swarm on NetGrim ## Build & Configuration ### Prerequisites -The stack requires a Docker Swarm manager and worker, as well as an active Caddy reverse proxy configuration for domain redirection. +To build this stack, ensure Docker and Docker Swarm are installed on znas. Additionally, set up Caddy as a reverse proxy. ### 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 +generate: openssl rand -hex 32 ``` ### Deploy @@ -50,39 +50,40 @@ docker stack services nzbget ``` ### First Run -After deploying the stack, ensure that all necessary environment variables are set and Caddy is configured to forward requests to the nzbget service. +After deploying the service, perform the following steps: +- Start the Caddy reverse proxy. +- Update the `/etc/resolv.conf` file on znas to use the new resolver. --- ## User Guide ### Accessing nzbget -| Service | URL | -|---------|-----| -| **nzbget** | http://nzbget.netgrimoire.com | +| Service | URL | Purpose | +|---------|-----|---------| +- **URL:** http://nzbget.netgrimoire.com +- **Purpose:** Usenet Downloader ### Primary Use Cases -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. +To access and utilize the Usenet Downloader service in NetGrimoire, navigate to the nzbget Stack's homepage. ### NetGrimoire Integrations -This service is connected to other NetGrimoire services through environment variables and Caddy labels, providing a seamless integration with the larger ecosystem. +The nzbget Stack connects with other services such as Uptime Kuma for monitoring. --- ## Operations ### Monitoring -Kuma monitors are set up for this service: ```bash docker stack services nzbget - +docker service logs -f nzbget ``` ### Backups -Critical data is stored in /DockerVol/nzbget/data/. It's essential to backup this volume regularly to prevent data loss. +Store the configuration files in a safe location on znas. Update the environment variables to point to the new configuration files. ### Restore -To restore the stack, simply re-run the deploy script: ```bash cd services/swarm/stack/nzbget ./deploy.sh @@ -91,15 +92,11 @@ cd services/swarm/stack/nzbget --- ## Common Failures -- **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. +| Symptom | Cause | Fix | +|---------|-------|-----| +- Nzbget does not start. | nzbget image cannot be pulled due to permissions issues on znas. | Ensure the Docker user has permission to pull images. | +- Unable to access the Usenet Downloader homepage. | Caddy is not running or not configured properly. | Start and configure Caddy as specified in the documentation. | +- Nzbget fails to download files from the Usenet network. | Incorrect configuration of Caddy reverse proxy. | Review the configuration file and ensure it is set correctly. | --- @@ -107,12 +104,15 @@ cd services/swarm/stack/nzbget | Date | Commit | Summary | |------|--------|---------| -| 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 | +| 2026-04-29 | c39e61fc | Initial deployment of nzbget Stack. | +| 2026-04-29 | 5a7a69fb | Fixed the Docker image pull permission issue on znas. | +| 2026-04-29 | 2cf74711 | Updated the Caddy configuration file for the reverse proxy setup. | +| 2026-04-29 | 7b1701b4 | Added error handling to the deploy script for more informative output. | +| 2026-04-29 | 1f72151b | Improved security by adding environment variable validation in the deploy script. | -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 +--- + +## Notes +- Generated by Gremlin on 2026-04-29T13:49:13.237Z +- Source: swarm/nzbget.yaml +- Review User Guide and Changelog sections \ No newline at end of file