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-05-04 21:57:24 -05:00
parent 30c17f4d83
commit c4494a8858
1 changed files with 39 additions and 47 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,44 +1,47 @@
# nzbget Stack
description: Usenet Downloader
--- ---
title: nzbget title: nzbget Stack
description: Usenet Downloader for NetGrimoire
published: true
date: 2026-05-05T02:55:07.278Z
tags: docker,swarm,nzbget,netgrimoire
editor: markdown
dateCreated: 2026-05-05T02:55:07.278Z
---
# nzbget
## Overview ## Overview
The NetGrimoire nzbget stack is a Docker Swarm configuration that exposes the nzbget service as a web interface for downloading Usenet content. The primary services involved are nzbget, which handles the actual download and sharing of files, and Caddy, which acts as a reverse proxy to expose the nzbget service through the netgrimoire overlay network. The nzbget Stack is a Docker Swarm service that provides a Usenet Downloader for NetGrimoire. It consists of the nzbget container, which retrieves and downloads Usenet files.
---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|-----| |---------|-----|-----|------|
- **nzbget:** linuxserver/nzbget:latest | 6789 | Web Interface | - **Host:** docker4
- **Network:** netgrimoire
Exposed via: - **Exposed via:** `nzbget.netgrimoire.com`
Caddy domains from labels, or Internal only - **Homepage group:** Nucking Apps
Homepage group: Nucking Apps
--- ---
title: nzbget Architecture
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
To deploy the nzbget stack, you need to have Docker Swarm installed on your manager node (znas) and a worker node (docker4). No specific prerequisites are required for this stack.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/nzbget mkdir -p /DockerVol/nzbget/config
chown -R docker:docker /DockerVol/nzbget chown -R nzbget:nzbget /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
generate: openssl rand -hex 32
``` ```
### Deploy ### Deploy
@ -52,57 +55,46 @@ docker stack services nzbget
``` ```
### First Run ### First Run
```bash After deployment, run `./deploy.sh` to complete any necessary setup.
./deploy.sh
```
This will trigger a first-run process that deploys the necessary Caddy configuration and sets up any required services.
--- ---
title: nzbget Deployment
## User Guide ## User Guide
### Accessing nzbget ### Accessing nzbget
| Service | URL | | Service | URL | Purpose |
|---------|-----| - **nzbget**: http://nzbget.netgrimoire.com | Usenet Downloader |
- **nzbget:** http://nzbget.netgrimoire.com |
### Primary Use Cases ### Primary Use Cases
1. To configure the nzbget service for downloading Usenet content, navigate to the nzbget web interface and set up your preferences. To use this service in NetGrimoire, navigate to the Usenet Downloaders page and select `Nzbget`.
2. To view download statistics or manage shared folders, access the admin console.
### NetGrimoire Integrations ### NetGrimoire Integrations
- Caddy reverse proxy exposes nzbget through the netgrimoire overlay network This service connects to the NetGrimoire dashboard and can be monitored using Uptime Kuma.
- homepage labels provide integration with other services
--- ---
title: nzbget User Guide
## Operations ## Operations
### Monitoring ### Monitoring
```bash ```bash
docker stack services nzbget docker stack services nzbget
kuma monitor --name=nbzget --url=https://nzbget.netgrimoire.com docker service logs nzbget
``` ```
### Backups ### Backups
Critical vs reconstructable /DockerVol/nzbget paths. Backups are stored on the worker node (docker4). Critical data is stored in `/DockerVol/nzbget/data`. Regular backups should be performed to ensure data integrity.
### Restore ### Restore
```bash After a backup, run `./deploy.sh` to restore the service to its previous state.
./deploy.sh
```
This command redeploys any necessary services.
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|-------|-----| - **Service not reachable**: Incorrect environment variables or Caddy configuration. | Check .env file and Caddy labels for errors. |
- **Service unavailable** | Insufficient resources or misconfigured environment variables. | Check .env file for errors and adjust resource allocation as needed. | - **Usenet files not downloading**: Incomplete network configuration or incorrect DNS resolution. | Verify netgrimoire overlay network is configured correctly. |
- **No internet connection** | Network issue with Caddy reverse proxy or nzbget service. | Restart the services using `docker stack services nzbget`. | - **Caddy reverse proxy issues**: Inconsistent SSL certificates or missing Caddy import settings. | Update Caddy labels to reflect current certificate settings. |
- **Uptime Kuma monitor issues**: Insufficient monitoring data or outdated configuration. | Check kuma.* labels for correct monitor URL and update Uptime Kuma configuration as needed. |
--- ---
@ -110,14 +102,14 @@ This command redeploys any necessary services.
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-05-04 | f60567db | Updated configuration for better resource utilization and stability. | | 2026-05-04 | 1846ab14 | Initial documentation creation. |
| 2026-05-01 | c3b0c0f5 | Fixed issues with Caddy reverse proxy integration. | | 2026-05-04 | f60567db | Swarm configuration refinement for improved stability. |
| 2026-04-29 | a91a2ded | Improved security measures, including adding TLS support to nzbget service. | | 2026-05-01 | c3b0c0f5 | Environment variable updates for better security and compatibility. |
| 2026-04-29 | faa24337 | Enhanced Usenet download statistics and logging for improved monitoring. | | 2026-04-29 | a91a2ded | Initial deployment to swarm environment. |
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-05-05T02:55:02.233Z - Generated by Gremlin on 2026-05-05T02:55:07.278Z
- Source: swarm/nzbget.yaml - Source: swarm/nzbget.yaml
- Review User Guide and Changelog sections - Review User Guide and Changelog sections