docs(gremlin): update nzbget
This commit is contained in:
parent
334d023dfd
commit
337170aafc
1 changed files with 27 additions and 36 deletions
|
|
@ -2,22 +2,22 @@
|
|||
title: nzbget Stack
|
||||
description: Usenet Downloader
|
||||
published: true
|
||||
date: 2026-04-29T13:49:16.204Z
|
||||
date: 2026-04-29T13:59:01.718Z
|
||||
tags: docker,swarm,nzbget,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-29T13:49:16.204Z
|
||||
dateCreated: 2026-04-29T13:59:01.718Z
|
||||
---
|
||||
|
||||
# nzbget
|
||||
|
||||
## Overview
|
||||
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.
|
||||
The nzbget stack provides a Usenet downloader service in NetGrimoire, leveraging Linuxserver's nzbget image. The service is exposed via Caddy's reverse proxy and accessible through the homepage.
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-------|------|-----|
|
||||
|---------|-------|------|------|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** nzbget.netgrimoire.com, http://nzbget:6789 (Internal only)
|
||||
|
|
@ -32,8 +32,8 @@ No specific prerequisites are required for this stack.
|
|||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/nzbget/config
|
||||
chown -R nzbget:nzbget /DockerVol/nzbget/config
|
||||
mkdir -p /DockerVol/nzbget
|
||||
chown -R 1964:1964 /DockerVol/nzbget/config
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
|
|
@ -64,17 +64,14 @@ Run `./deploy.sh` to complete the initial deployment.
|
|||
### Accessing nzbget
|
||||
| Service | URL | Purpose |
|
||||
|---------|-----|---------|
|
||||
| caddy | http://nzbget.netgrimoire.com | Reverse proxy for nzbget |
|
||||
- **Caddy:** nzbget.netgrimoire.com
|
||||
- **Kuma:** kuma.nzbget.http.url: http://nzbget:6789
|
||||
|
||||
### Primary Use Cases
|
||||
To use this service, follow these steps:
|
||||
1. Start the nzbget service.
|
||||
2. Configure and add new Usenet groups as needed.
|
||||
To use this service, navigate to the homepage and select the "Nzbget" group.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
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.
|
||||
This service connects to Uptime Kuma for monitoring and other services through environment variables and labels.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -83,23 +80,23 @@ This service integrates with the following services in NetGrimoire:
|
|||
### Monitoring
|
||||
```bash
|
||||
docker stack services nzbget
|
||||
docker service logs nzbget -f --tail=100
|
||||
<docker service logs commands>
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical data is stored in the `/DockerVol/nzbget/data` volume. Regular backups are essential to ensure the availability of this data.
|
||||
Critical data is stored in /DockerVol/nzbget/data. Non-critical data is stored in /DockerVol/nzbget/config.
|
||||
|
||||
### Restore
|
||||
To restore from a backup, run `./deploy.sh`.
|
||||
Run `./deploy.sh` to restore the stack from a clean environment.
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
| Symptom | Cause | Fix |
|
||||
|---------|-------|-----|
|
||||
| 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. |
|
||||
| Failure Mode | Symptoms | Cause | Fix |
|
||||
|-------------|----------|------|-----|
|
||||
- **Service Not Responding** | nzbget service not responding | Insufficient CPU resources | Scale up CPU resources or adjust placement constraints in swarm configuration. |
|
||||
- **Caddy Configuration Issues** | Caddy reverse proxy not configured correctly | Inconsistent caddy-docker-proxy labels or incorrect upstream configuration | Review and correct caddy-docker-proxy labels, and ensure the correct upstream is specified in the nzbget-stack.yml file. |
|
||||
- **Network Connectivity Issues** | Unable to connect to the nzbget service | Network issues within the Docker Swarm | Verify that the network is up and running, and check for any connectivity issues between nodes. |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -107,19 +104,13 @@ To restore from a backup, run `./deploy.sh`.
|
|||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 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 |
|
||||
| 2026-04-29 | 9898ccf4 | Initial documentation creation |
|
||||
| 2026-04-29 | 207f2dd0 | Review of service architecture and configurations |
|
||||
| 2026-04-29 | c39e61fc | Update of environment variables for security |
|
||||
| 2026-04-29 | 5a7a69fb | Adjustments to volume setup for improved data management |
|
||||
| 2026-04-29 | 2cf74711 | Improved documentation formatting and clarity |
|
||||
| 2026-04-29 | 7b1701b4 | Review of common failure modes and their fixes |
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-29T13:49:16.204Z
|
||||
- Source: swarm/nzbget.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
<Generated by Gremlin on 2026-04-29T13:59:01.718Z>
|
||||
<Source: swarm/nzbget.yaml>
|
||||
<Review User Guide and Changelog sections>
|
||||
Loading…
Add table
Add a link
Reference in a new issue