diff --git a/Netgrimoire/Services/nzbget/nzbget.md b/Netgrimoire/Services/nzbget/nzbget.md index 5394a3c..35b6f42 100644 --- a/Netgrimoire/Services/nzbget/nzbget.md +++ b/Netgrimoire/Services/nzbget/nzbget.md @@ -1,45 +1,43 @@ --- title: nzbget Stack -description: Usenet Downloader for NetGrimoire +description: Usenet Downloader published: true -date: 2026-04-29T14:18:02.662Z +date: 2026-04-29T14:21:11.887Z tags: docker,swarm,nzbget,netgrimoire editor: markdown -dateCreated: 2026-04-29T14:18:02.662Z +dateCreated: 2026-04-29T14:21:11.887Z --- # nzbget ## Overview -The `nzbget` stack is a Docker Swarm configuration for running the nzbget Usenet downloader service in NetGrimoire. +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. ## Architecture | Service | Image | Port | Role | -|---------|-------|-----|------| +|---------|-------|------|------| - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** `nzbget.netgrimoire.com` (Caddy reverse proxy) +- **Exposed via:** nzbget.netgrimoire.com, http://nzbget:6789 - **Homepage group:** Nucking Apps ---- - ## Build & Configuration ### Prerequisites -Ensure Docker, Swarm, and Caddy are installed and configured. +None specified. ### Volume Setup ```bash mkdir -p /DockerVol/nzbget/config -chmod 755 /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 ``` ### Deploy @@ -53,62 +51,57 @@ docker stack services nzbget ``` ### First Run -After deployment, ensure the service is running and configure any required settings. - ---- +No specific steps required. ## User Guide ### Accessing nzbget | Service | URL | Purpose | -|---------|-----|---------| -- **nzbget**: `http://nzbget.netgrimoire.com` (Caddy reverse proxy) +- **nzbget**: http://nzbget.netgrimoire.com, nzbget:6789 | Usenet Downloader | ### Primary Use Cases -Use `nzbget` to download and manage Usenet content. +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`. ### NetGrimoire Integrations -This service integrates with the NetGrimoire dashboard, monitoring, and other services through environment variables and labels. - ---- +This service connects to Uptime Kuma for monitoring and Caddy for reverse proxying. ## Operations ### Monitoring ```bash docker stack services nzbget -docker service logs nzbget +docker logs -f nzbget | grep kuma ``` ### Backups -Critical data is stored in `/DockerVol/nzbget/data`. Regular backups are recommended for data integrity. +Critical data should be backed up regularly, as it is not reconstructable from the Docker Swarm configuration. ### Restore -Restore from the latest backup or re-run the deployment script to restore from a snapshot. - ---- +Run `./deploy.sh` to redeploy and restore the service. ## Common Failures | Symptom | Cause | Fix | -|---------|------|-----| -| Service not running | Insufficient resources, incorrect configuration | Check resources and configuration; restart service | -| Download failures | Network issues, incomplete configuration | Check network status and ensure correct configuration | - ---- +- **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. ## Changelog | Date | Commit | Summary | |------|--------|---------| -| 2026-04-29 | 338c639c | Initial documentation and configuration. | -| 2026-04-29 | fd825f33 | Minor bug fixes and performance improvements. | -| 2026-04-29 | 9898ccf4 | Updated configuration for improved resource utilization. | -| 2026-04-29 | 207f2dd0 | Enhanced monitoring and logging capabilities. | -| 2026-04-29 | c39e61fc | Security updates and patches applied to the service. | - ---- +| 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. | ## Notes -- Generated by Gremlin on 2026-04-29T14:18:02.662Z +- Generated by Gremlin on 2026-04-29T14:21:11.887Z - Source: swarm/nzbget.yaml - Review User Guide and Changelog sections \ No newline at end of file