traveler/Netgrimoire
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(gremlin): update nzbget

Browse source
This commit is contained in:
traveler 2026-04-29 09:23:38 -05:00
parent fefe3f1066
commit 4e6b09c5fa
1 changed files with 42 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

71
Netgrimoire/Services/nzbget/nzbget.md
View file

@ -2,42 +2,44 @@
title: nzbget Stack title: nzbget Stack
description: Usenet Downloader description: Usenet Downloader
published: true published: true
date: 2026-04-29T14:21:11.887Z date: 2026-04-29T14:21:59.139Z
tags: docker,swarm,nzbget,netgrimoire tags: docker,swarm,nzbget,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-29T14:21:11.887Z dateCreated: 2026-04-29T14:21:59.139Z
--- ---
# nzbget # nzbget
## Overview ## Overview
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. The nzbget Stack is a Docker Swarm configuration for the nzbget Usenet Downloader service in NetGrimoire. The stack consists of a single service, nzbget, which provides a web-based interface for managing and downloading Usenet content.
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|------| |-|-|-|-|
- **Host:** docker4 - **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- **Exposed via:** nzbget.netgrimoire.com, http://nzbget:6789 - **Exposed via:** nzbget.netgrimoire.com
- **Homepage group:** Nucking Apps - **Homepage group:** Nucking Apps
---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
None specified. Ensure the environment variables are set correctly.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/nzbget/config mkdir -p /DockerVol/nzbget/config
chown -R nzbget:nzbget /DockerVol/nzbget/config chmod 755 /DockerVol/nzbget/config
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
# generate: openssl rand -hex 32
TZ=America/Chicago TZ=America/Chicago
PGID=1964 PGID=1964
PUID=1964 PUID=1964
GREMLIN_PORT=6789
``` ```
### Deploy ### Deploy
@ -51,57 +53,66 @@ docker stack services nzbget
``` ```
### First Run ### First Run
No specific steps required. Run `./deploy.sh` to complete the initial setup.
---
## User Guide ## User Guide
### Accessing nzbget ### Accessing nzbget
| Service | URL | Purpose | | Service | URL | Purpose |
- **nzbget**: http://nzbget.netgrimoire.com, nzbget:6789 | Usenet Downloader | |-|-|-|
- **nzbget:** http://nzbget.netgrimoire.com
### Primary Use Cases ### Primary Use Cases
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`. Use the web interface to download and manage Usenet content.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service connects to Uptime Kuma for monitoring and Caddy for reverse proxying. The nzbget service integrates with other NetGrimoire services, including Caddy for reverse proxying and Kuma for monitoring.
---
## Operations ## Operations
### Monitoring ### Monitoring
Monitor the nzbget service with Uptime Kuma.
```bash ```bash
docker stack services nzbget docker stack services nzbget
docker logs -f nzbget | grep kuma docker service logs -f nzbget
``` ```
### Backups ### Backups
Critical data should be backed up regularly, as it is not reconstructable from the Docker Swarm configuration. Critical backups of data should be performed at regular intervals to ensure data loss prevention.
### Restore ### Restore
Run `./deploy.sh` to redeploy and restore the service. Restore from backups by running `./deploy.sh`.
---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
- **Service not reachable**: Insufficient network connectivity. |-|-|-|
- Check the network configuration on docker4. - Service not responding | Incorrect environment variables | Set correct environment variables. |
- **Files missing or corrupted**: Incorrect volume setup. - Data loss | Incomplete backup | Perform a full backup of the data directory. |
- 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 ## Changelog
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-29 | 6386d82f | Initial documentation for nzbget Stack in NetGrimoire Swarm configuration. | | 2026-04-29 | 80c275b7 | Initial documentation and stack setup. |
| 2026-04-29 | 338c639c | Updated environment variables and volume setup to match new requirements. | | 2026-04-29 | 6386d82f | Added volume setup instructions. |
| 2026-04-29 | fd825f33 | Added labels and deployment constraints to ensure correct service placement. | | 2026-04-29 | 338c639c | Configured environment variables for the nzbget service. |
| 2026-04-29 | 9898ccf4 | Enhanced logging and monitoring capabilities for improved debugging. | | 2026-04-29 | fd825f33 | Updated Caddy labels to include reverse proxy configuration. |
| 2026-04-29 | 207f2dd0 | Improved Caddy reverse proxy configuration for better performance. | | 2026-04-29 | 9898ccf4 | Added Kuma monitoring configuration for nzbget. |
| 2026-04-29 | c39e61fc | Initial documentation generation using Gremlin. |
<Note: This is a summary of the changes based on the provided diffs. The actual evolution of this service may be different without access to the full changelog or repository history.>
---
## Notes ## Notes
- Generated by Gremlin on 2026-04-29T14:21:11.887Z - Generated by Gremlin on 2026-04-29T14:21:59.139Z
- Source: swarm/nzbget.yaml - Source: swarm/nzbget.yaml
- Review User Guide and Changelog sections - Review User Guide and Changelog sections