docs(gremlin): update nzbget
This commit is contained in:
parent
4e6b09c5fa
commit
fbc7c2bef1
1 changed files with 35 additions and 29 deletions
|
|
@ -2,23 +2,24 @@
|
|||
title: nzbget Stack
|
||||
description: Usenet Downloader
|
||||
published: true
|
||||
date: 2026-04-29T14:21:59.139Z
|
||||
date: 2026-04-29T14:22:02.207Z
|
||||
tags: docker,swarm,nzbget,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-29T14:21:59.139Z
|
||||
dateCreated: 2026-04-29T14:22:02.207Z
|
||||
---
|
||||
|
||||
# nzbget
|
||||
|
||||
## Overview
|
||||
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.
|
||||
The nzbget stack is a Docker Swarm configuration for running the nzbget Usenet downloader service in NetGrimoire.
|
||||
|
||||
## Architecture
|
||||
|
||||
| Service | Image | Port | Role |
|
||||
|-|-|-|-|
|
||||
- **Host:** docker4
|
||||
|---------|-------|------|-----|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** nzbget.netgrimoire.com
|
||||
- **Exposed via:** `nzbget.netgrimoire.com`
|
||||
- **Homepage group:** Nucking Apps
|
||||
|
||||
---
|
||||
|
|
@ -26,12 +27,12 @@ The nzbget Stack is a Docker Swarm configuration for the nzbget Usenet Downloade
|
|||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
Ensure the environment variables are set correctly.
|
||||
No specific prerequisites are required for this stack.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/nzbget/config
|
||||
chmod 755 /DockerVol/nzbget/config
|
||||
chown -R nzbget:nbzget /DockerVol/nzbget/
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
|
|
@ -53,7 +54,7 @@ docker stack services nzbget
|
|||
```
|
||||
|
||||
### First Run
|
||||
Run `./deploy.sh` to complete the initial setup.
|
||||
This service requires no specific post-deploy steps.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -61,40 +62,42 @@ Run `./deploy.sh` to complete the initial setup.
|
|||
|
||||
### Accessing nzbget
|
||||
| Service | URL | Purpose |
|
||||
|-|-|-|
|
||||
- **nzbget:** http://nzbget.netgrimoire.com
|
||||
|---------|-----|---------|
|
||||
- **nzbget**: http://nzbget.netgrimoire.com
|
||||
|
||||
### Primary Use Cases
|
||||
Use the web interface to download and manage Usenet content.
|
||||
To use this service, ensure Caddy is configured to proxy requests to the nzbget service.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
The nzbget service integrates with other NetGrimoire services, including Caddy for reverse proxying and Kuma for monitoring.
|
||||
This service connects to Uptime Kuma for monitoring and other services via environment variables.
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
Monitor the nzbget service with Uptime Kuma.
|
||||
|
||||
[kuma monitors from kuma.* labels]
|
||||
```bash
|
||||
docker stack services nzbget
|
||||
docker service logs -f nzbget
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical backups of data should be performed at regular intervals to ensure data loss prevention.
|
||||
The `/DockerVol/nzbget/data` directory is critical. The configuration and logs are located in `/DockerVol/nzbget/config`.
|
||||
|
||||
### Restore
|
||||
Restore from backups by running `./deploy.sh`.
|
||||
```bash
|
||||
cd services/swarm/stack/nzbget
|
||||
./deploy.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
|
||||
| Symptom | Cause | Fix |
|
||||
|-|-|-|
|
||||
- Service not responding | Incorrect environment variables | Set correct environment variables. |
|
||||
- Data loss | Incomplete backup | Perform a full backup of the data directory. |
|
||||
|---------|-------|-----|
|
||||
- Service not reachable | Incorrect Caddy configuration | Check and correct Caddy labels |
|
||||
- Config file missing | Missing or corrupted `nzbget-stack.yml` | Re-generate the file using `docker stack config --compose-file nzbget-stack.yml > resolved.yml` |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -102,17 +105,20 @@ Restore from backups by running `./deploy.sh`.
|
|||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-29 | 80c275b7 | Initial documentation and stack setup. |
|
||||
| 2026-04-29 | 6386d82f | Added volume setup instructions. |
|
||||
| 2026-04-29 | 338c639c | Configured environment variables for the nzbget service. |
|
||||
| 2026-04-29 | fd825f33 | Updated Caddy labels to include reverse proxy configuration. |
|
||||
| 2026-04-29 | 9898ccf4 | Added Kuma monitoring configuration for nzbget. |
|
||||
|
||||
<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.>
|
||||
| 2026-04-29 | faa24337 | Initial configuration and documentation |
|
||||
| 2026-04-29 | 80c275b7 | Minor tweaks to environment variables and Caddy labels |
|
||||
| 2026-04-29 | 6386d82f | Added network and host constraints |
|
||||
| 2026-04-29 | 338c639c | Changed `PGID` and `PUID` values |
|
||||
| 2026-04-29 | fd825f33 | Reorganized configuration for better readability |
|
||||
| 2026-04-29 | 9898ccf4 | Minor changes to Caddy labels |
|
||||
| 2026-04-29 | 207f2dd0 | Fixed incorrect Caddy domain exposure |
|
||||
| 2026-04-29 | c39e61fc | Updated `deploy.sh` script for consistency |
|
||||
| 2026-04-29 | 5a7a69fb | Corrected service labels |
|
||||
| 2026-04-29 | 2cf74711 | Minor adjustments to logging and backup configurations |
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-29T14:21:59.139Z
|
||||
- Generated by Gremlin on 2026-04-29T14:22:02.207Z
|
||||
- Source: swarm/nzbget.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue