diff --git a/Netgrimoire/Services/nzbget/nzbget.md b/Netgrimoire/Services/nzbget/nzbget.md index 9a5f1ee..1391eb9 100644 --- a/Netgrimoire/Services/nzbget/nzbget.md +++ b/Netgrimoire/Services/nzbget/nzbget.md @@ -1,24 +1,25 @@ --- title: nzbget Stack -description: Usenet Downloader for NetGrimoire +description: Usenet Downloader published: true -date: 2026-04-29T13:23:33.164Z +date: 2026-04-29T13:40:16.628Z tags: docker,swarm,nzbget,netgrimoire editor: markdown -dateCreated: 2026-04-29T13:23:33.164Z +dateCreated: 2026-04-29T13:40:16.628Z --- # nzbget ## Overview -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. +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. ## Architecture + | Service | Image | Port | Role | |---------|-------|------|------| -- **Host:** docker4 -- **Network:** netgrimoire -- **Exposed via:** nzbget.netgrimoire.com, http://nzbget:6789 +- **nzbget:** linuxserver/nzbget:latest | 6789 | - | Download client | + +- **Exposed via:** nzbget.netgrimoire.com (via Caddy reverse proxy) - **Homepage group:** Homepage --- @@ -26,12 +27,12 @@ The nzbget stack is a Docker Swarm configuration for the nzbget service in NetGr ## Build & Configuration ### Prerequisites -To deploy the nzbget stack, ensure you have Docker installed and the necessary environment variables set. +This stack requires Docker, Docker Swarm, and the LinuxServer NZBGet image. ### Volume Setup ```bash -mkdir -p /DockerVol/nzbget/config/ -chown -R nzbget:nbzget /DockerVol/nzbget/config/ +mkdir -p /DockerVol/nzbget/config +chown -R nzbget:nzbget /DockerVol/nzbget/config ``` ### Environment Variables @@ -40,7 +41,17 @@ chown -R nzbget:nbzget /DockerVol/nzbget/config/ TZ=America/Chicago PGID=1964 PUID=1964 -GREMLIN_DEPLOYMENT_ID=$(uuidgen) +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 @@ -54,26 +65,22 @@ docker stack services nzbget ``` ### First Run -After deployment, run the following command to initialize the database: -```bash -docker exec -it nzbget /bin/bash -c "update-db" -``` +After initial deployment, the stack will automatically start and begin downloading NZB files. --- ## User Guide ### Accessing nzbget -| Service | URL | Purpose | -- **Host:** http://nzbget:6789, nzbget.netgrimoire.com -- **Login:** Requires authentication credentials +| Service | URL | +|---------|-----| +- **nzbget:** http://nzbget.netgrimoire.com ### Primary Use Cases -* Download Usenet content using the nzbget client. +To download NZB files using this service, navigate to the NZB download page and select the desired files. ### NetGrimoire Integrations -* Connected to Homepage for display and tracking purposes. -* Monitors via Kuma for health checks. +This stack integrates with the Homepage and Kuma services to provide a seamless user experience. --- @@ -82,14 +89,17 @@ docker exec -it nzbget /bin/bash -c "update-db" ### Monitoring ```bash docker stack services nzbget -docker service logs -f nzbget +docker service logs nzbget -f ``` ### Backups -Critical data is stored in the /data directory, ensuring regular backups are essential to prevent data loss. +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 +``` ### Restore -After a failure or accidental deletion, restore the database by running: +To restore the data, run the following command: ```bash cd services/swarm/stack/nzbget ./deploy.sh @@ -101,8 +111,8 @@ cd services/swarm/stack/nzbget | 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 | +| 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. | --- @@ -110,14 +120,15 @@ cd services/swarm/stack/nzbget | Date | Commit | Summary | |------|--------|---------| -| 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 | +| 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 | --- ## Notes -- Generated by Gremlin on 2026-04-29T13:23:33.164Z -- Source: swarm/nzbget.yaml \ No newline at end of file +- 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