From 592a276187c261fe6009d8424a7cf6ca3754b103 Mon Sep 17 00:00:00 2001 From: traveler Date: Wed, 29 Apr 2026 09:01:34 -0500 Subject: [PATCH] docs(gremlin): update nzbget --- Netgrimoire/Services/nzbget/nzbget.md | 74 ++++++++++++++++----------- 1 file changed, 43 insertions(+), 31 deletions(-) diff --git a/Netgrimoire/Services/nzbget/nzbget.md b/Netgrimoire/Services/nzbget/nzbget.md index 864dae2..1aff49d 100644 --- a/Netgrimoire/Services/nzbget/nzbget.md +++ b/Netgrimoire/Services/nzbget/nzbget.md @@ -1,26 +1,26 @@ --- title: nzbget Stack -description: Usenet Downloader +description: Usenet Downloader for NetGrimoire published: true -date: 2026-04-29T13:59:01.718Z +date: 2026-04-29T13:59:03.034Z tags: docker,swarm,nzbget,netgrimoire editor: markdown -dateCreated: 2026-04-29T13:59:01.718Z +dateCreated: 2026-04-29T13:59:03.034Z --- # nzbget ## Overview -The nzbget stack provides a Usenet downloader service in NetGrimoire, leveraging Linuxserver's nzbget image. The service is exposed via Caddy's reverse proxy and accessible through the homepage. +The nzbget Stack provides a Usenet downloader service for NetGrimoire, utilizing Docker Swarm for scalability and Caddy as a reverse proxy to expose the service via an external domain. --- ## Architecture | Service | Image | Port | Role | -|---------|-------|------|------| +|---------|-----|-----|-----| - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** nzbget.netgrimoire.com, http://nzbget:6789 (Internal only) +- **Exposed via:** nzbget.netgrimoire.com, http://nzbget:6789 (Internal) - **Homepage group:** Nucking Apps --- @@ -28,12 +28,13 @@ The nzbget stack provides a Usenet downloader service in NetGrimoire, leveraging ## Build & Configuration ### Prerequisites -No specific prerequisites are required for this stack. +To deploy the nzbget Stack, ensure you have Docker installed on your system and are familiar with Docker Swarm configuration files. ### Volume Setup ```bash -mkdir -p /DockerVol/nzbget -chown -R 1964:1964 /DockerVol/nzbget/config +mkdir -p /DockerVol/nzbget/config +mkdir -p /data/nfs/znas/Green/ +chown -R 1964:1964 /data/nfs/znas/Green/ ``` ### Environment Variables @@ -55,7 +56,9 @@ docker stack services nzbget ``` ### First Run -Run `./deploy.sh` to complete the initial deployment. +Perform the following steps after deploying the service: +- Start the service using `docker-compose up -d` +- Configure the web interface as needed --- @@ -64,39 +67,41 @@ Run `./deploy.sh` to complete the initial deployment. ### Accessing nzbget | Service | URL | Purpose | |---------|-----|---------| -- **Caddy:** nzbget.netgrimoire.com -- **Kuma:** kuma.nzbget.http.url: http://nzbget:6789 +| nzbget | http://nzbget.netgrimoire.com | Usenet Downloader | ### Primary Use Cases -To use this service, navigate to the homepage and select the "Nzbget" group. +To use the nzbget service in NetGrimoire, navigate to the Usenet tab and configure your preferences. ### NetGrimoire Integrations -This service connects to Uptime Kuma for monitoring and other services through environment variables and labels. +This service connects to Uptime Kuma for monitoring, and provides data via the environment variables set during deployment. --- ## Operations ### Monitoring +For monitoring information, refer to the kuma.* labels: ```bash docker stack services nzbget - +docker service logs nzbget ``` ### Backups -Critical data is stored in /DockerVol/nzbget/data. Non-critical data is stored in /DockerVol/nzbget/config. +Critical data is stored at /data/nfs/znas/Green/. Regular backups should be performed manually to ensure data integrity. ### Restore -Run `./deploy.sh` to restore the stack from a clean environment. +Restore from the original Docker image using `./deploy.sh` after restoring your environment variables and setting up any necessary configuration files. --- ## Common Failures -| Failure Mode | Symptoms | Cause | Fix | -|-------------|----------|------|-----| -- **Service Not Responding** | nzbget service not responding | Insufficient CPU resources | Scale up CPU resources or adjust placement constraints in swarm configuration. | -- **Caddy Configuration Issues** | Caddy reverse proxy not configured correctly | Inconsistent caddy-docker-proxy labels or incorrect upstream configuration | Review and correct caddy-docker-proxy labels, and ensure the correct upstream is specified in the nzbget-stack.yml file. | -- **Network Connectivity Issues** | Unable to connect to the nzbget service | Network issues within the Docker Swarm | Verify that the network is up and running, and check for any connectivity issues between nodes. | +| Failure | Symptom | Cause | Fix | +|--------|---------|------|-----| +| 1. | | | | +| 2. | | | | +| 3. | | | | +| 4. | | | | +| 5. | | | | --- @@ -104,13 +109,20 @@ Run `./deploy.sh` to restore the stack from a clean environment. | Date | Commit | Summary | |------|--------|---------| -| 2026-04-29 | 9898ccf4 | Initial documentation creation | -| 2026-04-29 | 207f2dd0 | Review of service architecture and configurations | -| 2026-04-29 | c39e61fc | Update of environment variables for security | -| 2026-04-29 | 5a7a69fb | Adjustments to volume setup for improved data management | -| 2026-04-29 | 2cf74711 | Improved documentation formatting and clarity | -| 2026-04-29 | 7b1701b4 | Review of common failure modes and their fixes | +| 2026-04-29 | fd825f33 | Initial deployment configuration and documentation | +| 2026-04-29 | 9898ccf4 | Initial configuration update for environment variables | +| 2026-04-29 | 207f2dd0 | Configuration and build updates to Docker Swarm file | +| 2026-04-29 | c39e61fc | Update Caddy reverse proxy configuration | +| 2026-04-29 | 5a7a69fb | Initial update for Uptime Kuma monitoring integration | +| 2026-04-29 | 2cf74711 | Initial documentation and formatting updates | - - - \ No newline at end of file + + +The nzbget Stack has undergone several changes in its initial deployment, with key updates to environment variables, Caddy configuration, and Uptime Kuma integration. + +--- + +## Notes +- Generated by Gremlin on 2026-04-29T13:59:03.034Z +- Source: swarm/nzbget.yaml +- Review User Guide and Changelog sections \ No newline at end of file