docs(gremlin): create nzbget
This commit is contained in:
parent
dafeef5be5
commit
88f4c62ee7
1 changed files with 124 additions and 0 deletions
124
Netgrimoire/Services/nzbget/nzbget.md
Normal file
124
Netgrimoire/Services/nzbget/nzbget.md
Normal file
|
|
@ -0,0 +1,124 @@
|
||||||
|
---
|
||||||
|
|
||||||
|
title: nzbget Stack
|
||||||
|
description: Usenet Downloader for NetGrimoire
|
||||||
|
|
||||||
|
published: true
|
||||||
|
date: 2026-04-29T13:06:17.760Z
|
||||||
|
tags: docker,swarm,nzbget,netgrimoire
|
||||||
|
editor: markdown
|
||||||
|
dateCreated: 2026-04-29T13:06:17.760Z
|
||||||
|
---
|
||||||
|
|
||||||
|
# nzbget
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
| Service | Image | Port | Role |
|
||||||
|
|-|-|-|-|
|
||||||
|
- **nzbget**: linuxserver/nzbget:latest | 6789 | HTTP |
|
||||||
|
|
||||||
|
Exposed via: nzbget.netgrimoire.com
|
||||||
|
|
||||||
|
- Homepage group: homepage.group=Nucking Apps
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Build & Configuration
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
This stack requires Docker Swarm, Caddy, and Uptime Kuma to be installed and running.
|
||||||
|
|
||||||
|
### Volume Setup
|
||||||
|
```bash
|
||||||
|
mkdir -p /DockerVol/nzbget/config
|
||||||
|
chown -R nzbget:nzbget /DockerVol/nzbget/config
|
||||||
|
```
|
||||||
|
|
||||||
|
### Environment Variables
|
||||||
|
```bash
|
||||||
|
# generate: openssl rand -hex 32
|
||||||
|
TZ=America/Chicago
|
||||||
|
PGID=1964
|
||||||
|
PUID=1964
|
||||||
|
CADDY_URL=http://nzbget.netgrimoire.com
|
||||||
|
KUMA_NZBGET_HTTP_NAME="nzbget"
|
||||||
|
KUMA_NZBGET_HTTP_URL="http://nzbget:6789"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Deploy
|
||||||
|
```bash
|
||||||
|
cd services/swarm/stack/nzbget
|
||||||
|
set -a && source .env && set +a
|
||||||
|
docker stack config --compose-file nzbget-stack.yml > resolved.yml
|
||||||
|
docker stack deploy --compose-file resolved.yml nzbget
|
||||||
|
rm resolved.yml
|
||||||
|
docker stack services nzbget
|
||||||
|
```
|
||||||
|
|
||||||
|
### First Run
|
||||||
|
- Ensure Caddy and Uptime Kuma are running.
|
||||||
|
- Set up any necessary environment variables.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## User Guide
|
||||||
|
|
||||||
|
### Accessing nzbget
|
||||||
|
| Service | URL | Purpose |
|
||||||
|
|-|-|-|
|
||||||
|
- **nzbget**: http://nzbget.netgrimoire.com | Usenet Downloader |
|
||||||
|
|
||||||
|
### 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.
|
||||||
|
|
||||||
|
### NetGrimoire Integrations
|
||||||
|
This service connects to other services through environment variables and labels:
|
||||||
|
- Caddy: `caddy.url=nzbget.netgrimoire.com`
|
||||||
|
- Uptime Kuma: `kuma.nzbget.http.name="nzbget"`
|
||||||
|
- kuma.nzbget.http.url=http://nzbget:6789
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Operations
|
||||||
|
|
||||||
|
### Monitoring
|
||||||
|
Use the following command to view logs and service status:
|
||||||
|
```bash
|
||||||
|
docker stack services nzbget
|
||||||
|
```
|
||||||
|
You can also access the service logs using `docker logs <service_name>`. To view Uptime Kuma monitoring, check the kuma.* labels.
|
||||||
|
|
||||||
|
### Backups
|
||||||
|
Critical backups are required for the `/DockerVol/nzbget/config` volume. This is where settings like NZB get sources and settings are stored.
|
||||||
|
|
||||||
|
### Restore
|
||||||
|
```bash
|
||||||
|
cd services/swarm/stack/nzbget
|
||||||
|
./deploy.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
3. **NZB Files Not Downloading**: Verify that the NZB get sources are correct, and logins are set properly in the configuration.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Changelog
|
||||||
|
|
||||||
|
| Date | Commit | Summary |
|
||||||
|
|------|--------|---------|
|
||||||
|
| 2026-04-29 | 1f72151b | Initial documentation for nzbget stack. |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
- Generated by Gremlin on 2026-04-29T13:06:17.760Z
|
||||||
|
- Source: swarm/nzbget.yaml
|
||||||
Loading…
Add table
Add a link
Reference in a new issue