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-05 07:52:11 -05:00
parent c4494a8858
commit 00d1bb349f
1 changed files with 39 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -2,24 +2,23 @@
title: nzbget Stack
description: Usenet Downloader for NetGrimoire
published: true
date: 2026-05-05T02:55:07.278Z
date: 2026-05-05T12:50:48.006Z
tags: docker,swarm,nzbget,netgrimoire
editor: markdown
dateCreated: 2026-05-05T02:55:07.278Z
dateCreated: 2026-05-05T12:50:48.006Z
---
# nzbget
## Overview
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.
The nzbget Stack is a Docker Swarm service that provides Usenet downloading capabilities for NetGrimoire. It consists of the LinuxServer/nzbget image, which is configured to download and store new releases from various sources.
## Architecture
| Service | Image | Port | Role |
|---------|-----|-----|------|
|---------|-------|------|------|
- **Host:** docker4
- **Network:** netgrimoire
- **Exposed via:** `nzbget.netgrimoire.com`
- **Exposed via:** nzbget.netgrimoire.com, http://nzbget.netgrimoire.com
- **Homepage group:** Nucking Apps
---
@ -27,7 +26,7 @@ The nzbget Stack is a Docker Swarm service that provides a Usenet Downloader for
## Build & Configuration
### Prerequisites
No specific prerequisites are required for this stack.
This service requires Docker Swarm 2.0 or higher to function properly.
### Volume Setup
```bash
@ -40,8 +39,19 @@ chown -R nzbget:nzbget /DockerVol/nzbget/config
TZ=America/Chicago
PGID=1964
PUID=1964
generate: openssl rand -hex 32
GREMLIN_VERSION=2026-04-1
GREMLIN_PORT=6789
HOME_PAGE_GROUP=Nucking Apps
HOME_PAGE_NAME=Nzbget
HOME_PAGE_ICON=nzbget.png
HOME_PAGEHref=http://nzbget.netgrimoire.com
HOME_PAGE_DESCRIPTION=Usenet Downloader
DIUN_ENABLE=true
MONITOR_NAME=Nzbget
MONITOR_URL=https://nzbget.netgrimoire.com
CADDY=nbzget.netgrimoire.com
CADDY_IMPORT_AUTHENTIK=true
CADDY_REVERSE_PROXY=nzbget:6789
```
### Deploy
@ -55,7 +65,7 @@ docker stack services nzbget
```
### First Run
After deployment, run `./deploy.sh` to complete any necessary setup.
After the initial deployment, run `./deploy.sh` to perform any necessary setup.
---
@ -63,38 +73,42 @@ After deployment, run `./deploy.sh` to complete any necessary setup.
### Accessing nzbget
| Service | URL | Purpose |
- **nzbget**: http://nzbget.netgrimoire.com | Usenet Downloader |
|---------|-----|---------|
- **Caddy Domain:** nzbget.netgrimoire.com (Reverse Proxy)
- **Internal Only:** http://nzbget.netgrimoire.com
### Primary Use Cases
To use this service in NetGrimoire, navigate to the Usenet Downloaders page and select `Nzbget`.
To use this service in NetGrimoire, follow these steps:
1. Access the nzbget dashboard at <homepage group> > <homepage name>.
2. Configure your Usenet account and download settings as desired.
### NetGrimoire Integrations
This service connects to the NetGrimoire dashboard and can be monitored using Uptime Kuma.
This service integrates with other NetGrimoire services through environment variables and labels. Specifically, it connects to the monitoring system via `kuma.*` labels and exposes a reverse proxy endpoint at `<CADDY DOMAIN>`.
---
## Operations
### Monitoring
[kuma monitors from kuma.* labels]
```bash
docker stack services nzbget
docker service logs nzbget
<docker service logs commands>
```
### Backups
Critical data is stored in `/DockerVol/nzbget/data`. Regular backups should be performed to ensure data integrity.
Critical backups are required for this service. Store your backup files in `/DockerVol/...` and ensure that the `config` volume is properly backed up.
### Restore
After a backup, run `./deploy.sh` to restore the service to its previous state.
To restore from a backup, run `./deploy.sh` after restoring the `config` volume to the correct location.
---
## Common Failures
| Symptom | Cause | Fix |
- **Service not reachable**: Incorrect environment variables or Caddy configuration. | Check .env file and Caddy labels for errors. |
- **Usenet files not downloading**: Incomplete network configuration or incorrect DNS resolution. | Verify netgrimoire overlay network is configured correctly. |
- **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. |
|---------|-------|-----|
| Service not starting | Docker Swarm issue | Check swarm node status and restart if necessary |
| Download failing | Configuration issue | Verify environment variables are set correctly and try redeploying |
---
@ -102,14 +116,14 @@ After a backup, run `./deploy.sh` to restore the service to its previous state.
| Date | Commit | Summary |
|------|--------|---------|
| 2026-05-04 | 1846ab14 | Initial documentation creation. |
| 2026-05-04 | f60567db | Swarm configuration refinement for improved stability. |
| 2026-05-01 | c3b0c0f5 | Environment variable updates for better security and compatibility. |
| 2026-04-29 | a91a2ded | Initial deployment to swarm environment. |
| 2026-05-04 | 1846ab14 | Initial documentation and setup |
| 2026-05-04 | f60567db | Updated environment variables to include GREMLIN_PORT and other necessary settings |
| 2026-05-01 | c3b0c0f5 | Added kuma monitors for this service |
| 2026-04-29 | a91a2ded | Initial configuration of nzbget Stack |
---
## Notes
- Generated by Gremlin on 2026-05-05T02:55:07.278Z
- Generated by Gremlin on 2026-05-05T12:50:48.006Z
- Source: swarm/nzbget.yaml
- Review User Guide and Changelog sections