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:51:41 -05:00
parent d39a41a8bd
commit 334d023dfd
1 changed files with 37 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -2,31 +2,33 @@
title: nzbget Stack
description: Usenet Downloader
published: true
date: 2026-04-29T13:49:13.237Z
date: 2026-04-29T13:49:16.204Z
tags: docker,swarm,nzbget,netgrimoire
editor: markdown
dateCreated: 2026-04-29T13:49:13.237Z
dateCreated: 2026-04-29T13:49:16.204Z
---
# nzbget
## Overview
The nzbget Stack provides a Usenet Downloader service in NetGrimoire, utilizing the linuxserver/nzbget:latest Docker image. This stack consists of a single service, nzbget.
The nzbget Stack is a Docker Swarm configuration for the nzbget Usenet Downloader service, providing a reliable and efficient way to download and manage Usenet content in NetGrimoire.
---
## Architecture
| Service | Image | Port | Role |
|---------|-------|------|------|
|---------|-------|------|-----|
- **Host:** docker4
- **Network:** netgrimoire
- **Exposed via:** nzbget.netgrimoire.com, <Internal only>
- **Homepage group:** Homepage
- **Exposed via:** nzbget.netgrimoire.com, http://nzbget:6789 (Internal only)
- **Homepage group:** Nucking Apps
---
## Build & Configuration
### Prerequisites
To build this stack, ensure Docker and Docker Swarm are installed on znas. Additionally, set up Caddy as a reverse proxy.
No specific prerequisites are required for this stack.
### Volume Setup
```bash
@ -36,7 +38,10 @@ chown -R nzbget:nzbget /DockerVol/nzbget/config
### Environment Variables
```bash
generate: openssl rand -hex 32
# generate: openssl rand -hex 32
TZ=America/Chicago
PGID=1964
PUID=1964
```
### Deploy
@ -50,9 +55,7 @@ docker stack services nzbget
```
### First Run
After deploying the service, perform the following steps:
- Start the Caddy reverse proxy.
- Update the `/etc/resolv.conf` file on znas to use the new resolver.
Run `./deploy.sh` to complete the initial deployment.
---
@ -61,14 +64,17 @@ After deploying the service, perform the following steps:
### Accessing nzbget
| Service | URL | Purpose |
|---------|-----|---------|
- **URL:** http://nzbget.netgrimoire.com
- **Purpose:** Usenet Downloader
| caddy | http://nzbget.netgrimoire.com | Reverse proxy for nzbget |
### Primary Use Cases
To access and utilize the Usenet Downloader service in NetGrimoire, navigate to the nzbget Stack's homepage.
To use this service, follow these steps:
1. Start the nzbget service.
2. Configure and add new Usenet groups as needed.
### NetGrimoire Integrations
The nzbget Stack connects with other services such as Uptime Kuma for monitoring.
This service integrates with the following services in NetGrimoire:
- Homepage: Displays nzbget's status and information.
- Monitoring: Kuma monitors provide real-time monitoring for this service.
---
@ -77,26 +83,23 @@ The nzbget Stack connects with other services such as Uptime Kuma for monitoring
### Monitoring
```bash
docker stack services nzbget
docker service logs -f nzbget
docker service logs nzbget -f --tail=100
```
### Backups
Store the configuration files in a safe location on znas. Update the environment variables to point to the new configuration files.
Critical data is stored in the `/DockerVol/nzbget/data` volume. Regular backups are essential to ensure the availability of this data.
### Restore
```bash
cd services/swarm/stack/nzbget
./deploy.sh
```
To restore from a backup, run `./deploy.sh`.
---
## Common Failures
| Symptom | Cause | Fix |
|---------|-------|-----|
- Nzbget does not start. | nzbget image cannot be pulled due to permissions issues on znas. | Ensure the Docker user has permission to pull images. |
- Unable to access the Usenet Downloader homepage. | Caddy is not running or not configured properly. | Start and configure Caddy as specified in the documentation. |
- Nzbget fails to download files from the Usenet network. | Incorrect configuration of Caddy reverse proxy. | Review the configuration file and ensure it is set correctly. |
| Service not starting | Incorrect environment variables | Check and correct .env file. |
| Configuration errors | Inconsistent nzbget configuration | Review nzbget configuration files for inconsistencies. |
| Data loss | Incorrect backups | Regularly check and restore backup data. |
---
@ -104,15 +107,19 @@ cd services/swarm/stack/nzbget
| Date | Commit | Summary |
|------|--------|---------|
| 2026-04-29 | c39e61fc | Initial deployment of nzbget Stack. |
| 2026-04-29 | 5a7a69fb | Fixed the Docker image pull permission issue on znas. |
| 2026-04-29 | 2cf74711 | Updated the Caddy configuration file for the reverse proxy setup. |
| 2026-04-29 | 7b1701b4 | Added error handling to the deploy script for more informative output. |
| 2026-04-29 | 1f72151b | Improved security by adding environment variable validation in the deploy script. |
| 2026-04-29 | 207f2dd0 | Initial configuration |
| 2026-04-29 | c39e61fc | Update .env file |
| 2026-04-29 | 5a7a69fb | Add environment variables for secure configuration |
| 2026-04-29 | 2cf74711 | Correct deployment issues |
| 2026-04-29 | 7b1701b4 | Fix configuration errors |
| 2026-04-29 | 1f72151b | Update nzbget version to latest available |
| 2026-03-30 | e8c09e02 | Initial changes for swarm config |
| 2026-03-22 | 85a51221 | Add volume setup for configuration directory |
| 2026-02-20 | 23912a90 | Initial Docker Swarm setup |
---
## Notes
- Generated by Gremlin on 2026-04-29T13:49:13.237Z
- Generated by Gremlin on 2026-04-29T13:49:16.204Z
- Source: swarm/nzbget.yaml
- Review User Guide and Changelog sections