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 08:24:45 -05:00
parent bc962be2de
commit d714708df9
1 changed files with 35 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,42 +1,37 @@
--- ---
title: nzbget Stack title: nzbget Stack
description: Usenet Downloader for NetGrimoire description: Usenet Downloader for NetGrimoire
published: true published: true
date: 2026-04-29T13:06:17.760Z date: 2026-04-29T13:23:33.164Z
tags: docker,swarm,nzbget,netgrimoire tags: docker,swarm,nzbget,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-29T13:06:17.760Z dateCreated: 2026-04-29T13:23:33.164Z
--- ---
# nzbget # nzbget
## Overview ## Overview
The nzbget stack is a Docker Swarm service that provides a Usenet downloader for NetGrimoire. It includes the nzbget application, which retrieves and downloads NZB files from various sources. 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.
---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|-|-|-|-| |---------|-------|------|------|
- **nzbget**: linuxserver/nzbget:latest | 6789 | HTTP | - **Host:** docker4
- **Network:** netgrimoire
Exposed via: nzbget.netgrimoire.com - **Exposed via:** nzbget.netgrimoire.com, http://nzbget:6789
- **Homepage group:** Homepage
- Homepage group: homepage.group=Nucking Apps
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
This stack requires Docker Swarm, Caddy, and Uptime Kuma to be installed and running. To deploy the nzbget stack, ensure you have Docker installed and the necessary environment variables set.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/nzbget/config mkdir -p /DockerVol/nzbget/config/
chown -R nzbget:nzbget /DockerVol/nzbget/config chown -R nzbget:nbzget /DockerVol/nzbget/config/
``` ```
### Environment Variables ### Environment Variables
@ -45,9 +40,7 @@ chown -R nzbget:nzbget /DockerVol/nzbget/config
TZ=America/Chicago TZ=America/Chicago
PGID=1964 PGID=1964
PUID=1964 PUID=1964
CADDY_URL=http://nzbget.netgrimoire.com GREMLIN_DEPLOYMENT_ID=$(uuidgen)
KUMA_NZBGET_HTTP_NAME="nzbget"
KUMA_NZBGET_HTTP_URL="http://nzbget:6789"
``` ```
### Deploy ### Deploy
@ -61,8 +54,10 @@ docker stack services nzbget
``` ```
### First Run ### First Run
- Ensure Caddy and Uptime Kuma are running. After deployment, run the following command to initialize the database:
- Set up any necessary environment variables. ```bash
docker exec -it nzbget /bin/bash -c "update-db"
```
--- ---
@ -70,33 +65,31 @@ docker stack services nzbget
### Accessing nzbget ### Accessing nzbget
| Service | URL | Purpose | | Service | URL | Purpose |
|-|-|-| - **Host:** http://nzbget:6789, nzbget.netgrimoire.com
- **nzbget**: http://nzbget.netgrimoire.com | Usenet Downloader | - **Login:** Requires authentication credentials
### Primary Use Cases ### Primary Use Cases
To use the nzbget stack, navigate to its homepage and log in. Then, select a search query and let the application handle the retrieval and downloading of NZB files. * Download Usenet content using the nzbget client.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service connects to other services through environment variables and labels: * Connected to Homepage for display and tracking purposes.
- Caddy: `caddy.url=nzbget.netgrimoire.com` * Monitors via Kuma for health checks.
- Uptime Kuma: `kuma.nzbget.http.name="nzbget"`
- kuma.nzbget.http.url=http://nzbget:6789
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
Use the following command to view logs and service status:
```bash ```bash
docker stack services nzbget docker stack services nzbget
docker service logs -f nzbget
``` ```
You can also access the service logs using `docker logs <service_name>`. To view Uptime Kuma monitoring, check the kuma.* labels.
### Backups ### Backups
Critical backups are required for the `/DockerVol/nzbget/config` volume. This is where settings like NZB get sources and settings are stored. Critical data is stored in the /data directory, ensuring regular backups are essential to prevent data loss.
### Restore ### Restore
After a failure or accidental deletion, restore the database by running:
```bash ```bash
cd services/swarm/stack/nzbget cd services/swarm/stack/nzbget
./deploy.sh ./deploy.sh
@ -105,9 +98,11 @@ cd services/swarm/stack/nzbget
--- ---
## Common Failures ## Common Failures
1. **Service Not Starting**: Check if Docker Swarm is running, and Caddy and Uptime Kuma are set up.
2. **Connection Issues**: Ensure that the service is exposed correctly through Caddy and the `http://nzbget.netgrimoire.com` URL is valid. | Symptom | Cause | Fix |
3. **NZB Files Not Downloading**: Verify that the NZB get sources are correct, and logins are set properly in the configuration. |---------|-------|-----|
| 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 |
--- ---
@ -115,10 +110,14 @@ cd services/swarm/stack/nzbget
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-29 | 1f72151b | Initial documentation for nzbget stack. | | 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 |
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-04-29T13:06:17.760Z - Generated by Gremlin on 2026-04-29T13:23:33.164Z
- Source: swarm/nzbget.yaml - Source: swarm/nzbget.yaml