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:19:11 -05:00
parent 592a276187
commit 008e01bb08
1 changed files with 23 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -2,25 +2,23 @@
title: nzbget Stack title: nzbget Stack
description: Usenet Downloader for NetGrimoire description: Usenet Downloader for NetGrimoire
published: true published: true
date: 2026-04-29T13:59:03.034Z date: 2026-04-29T14:18:02.662Z
tags: docker,swarm,nzbget,netgrimoire tags: docker,swarm,nzbget,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-29T13:59:03.034Z dateCreated: 2026-04-29T14:18:02.662Z
--- ---
# nzbget # nzbget
## Overview ## Overview
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. The `nzbget` stack is a Docker Swarm configuration for running the nzbget Usenet downloader service in NetGrimoire.
---
## 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 (Internal) - **Exposed via:** `nzbget.netgrimoire.com` (Caddy reverse proxy)
- **Homepage group:** Nucking Apps - **Homepage group:** Nucking Apps
--- ---
@ -28,13 +26,12 @@ The nzbget Stack provides a Usenet downloader service for NetGrimoire, utilizing
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
To deploy the nzbget Stack, ensure you have Docker installed on your system and are familiar with Docker Swarm configuration files. Ensure Docker, Swarm, and Caddy are installed and configured.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/nzbget/config mkdir -p /DockerVol/nzbget/config
mkdir -p /data/nfs/znas/Green/ chmod 755 /DockerVol/nzbget/config
chown -R 1964:1964 /data/nfs/znas/Green/
``` ```
### Environment Variables ### Environment Variables
@ -56,9 +53,7 @@ docker stack services nzbget
``` ```
### First Run ### First Run
Perform the following steps after deploying the service: After deployment, ensure the service is running and configure any required settings.
- Start the service using `docker-compose up -d`
- Configure the web interface as needed
--- ---
@ -67,41 +62,37 @@ Perform the following steps after deploying the service:
### Accessing nzbget ### Accessing nzbget
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |---------|-----|---------|
| nzbget | http://nzbget.netgrimoire.com | Usenet Downloader | - **nzbget**: `http://nzbget.netgrimoire.com` (Caddy reverse proxy)
### Primary Use Cases ### Primary Use Cases
To use the nzbget service in NetGrimoire, navigate to the Usenet tab and configure your preferences. Use `nzbget` to download and manage Usenet content.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service connects to Uptime Kuma for monitoring, and provides data via the environment variables set during deployment. This service integrates with the NetGrimoire dashboard, monitoring, and other services through environment variables and labels.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
For monitoring information, refer to the kuma.* labels:
```bash ```bash
docker stack services nzbget docker stack services nzbget
docker service logs nzbget docker service logs nzbget
``` ```
### Backups ### Backups
Critical data is stored at /data/nfs/znas/Green/. Regular backups should be performed manually to ensure data integrity. Critical data is stored in `/DockerVol/nzbget/data`. Regular backups are recommended for data integrity.
### Restore ### Restore
Restore from the original Docker image using `./deploy.sh` after restoring your environment variables and setting up any necessary configuration files. Restore from the latest backup or re-run the deployment script to restore from a snapshot.
--- ---
## Common Failures ## Common Failures
| Failure | Symptom | Cause | Fix | | Symptom | Cause | Fix |
|--------|---------|------|-----| |---------|------|-----|
| 1. | | | | | Service not running | Insufficient resources, incorrect configuration | Check resources and configuration; restart service |
| 2. | | | | | Download failures | Network issues, incomplete configuration | Check network status and ensure correct configuration |
| 3. | | | |
| 4. | | | |
| 5. | | | |
--- ---
@ -109,20 +100,15 @@ Restore from the original Docker image using `./deploy.sh` after restoring your
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-29 | fd825f33 | Initial deployment configuration and documentation | | 2026-04-29 | 338c639c | Initial documentation and configuration. |
| 2026-04-29 | 9898ccf4 | Initial configuration update for environment variables | | 2026-04-29 | fd825f33 | Minor bug fixes and performance improvements. |
| 2026-04-29 | 207f2dd0 | Configuration and build updates to Docker Swarm file | | 2026-04-29 | 9898ccf4 | Updated configuration for improved resource utilization. |
| 2026-04-29 | c39e61fc | Update Caddy reverse proxy configuration | | 2026-04-29 | 207f2dd0 | Enhanced monitoring and logging capabilities. |
| 2026-04-29 | 5a7a69fb | Initial update for Uptime Kuma monitoring integration | | 2026-04-29 | c39e61fc | Security updates and patches applied to the service. |
| 2026-04-29 | 2cf74711 | Initial documentation and formatting updates |
<Write a paragraph summarizing the evolution of this service based on the diffs above.>
The nzbget Stack has undergone several changes in its initial deployment, with key updates to environment variables, Caddy configuration, and Uptime Kuma integration.
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-04-29T13:59:03.034Z - Generated by Gremlin on 2026-04-29T14:18:02.662Z
- Source: swarm/nzbget.yaml - Source: swarm/nzbget.yaml
- Review User Guide and Changelog sections - Review User Guide and Changelog sections