NZB Flow

NZB Flow Logo

A powerful GUI application to automate usenet posting. Built with modern web technologies, it orchestrates external CLI tools for the complete posting workflow: rar for compression, parpar for par2 creation, and nyuu for posting.

Quick Start

Download

πŸ“₯ Download Latest Release

Prerequisites

The application requires access to three external CLI commands:

  • RAR: Automatically detects WinRAR installation on Windows
  • ParPar & Nyuu: Built-in installation option through Node.js

Setup

  1. Configure Servers: Set up your usenet server settings in the main settings screen
  2. Multiple Servers: Full support with profile linking
  3. Default Profile: Comes with sensible defaults for posting
  4. Start Posting: Simply drag and drop files to begin

πŸ“š Check out the profile settings docs for detailed and advanced posting settings.

Features

🎯 Core Functionality

  • Easy drag and drop interface
  • Smart queue system: Separate queues for compression/par2 creation and uploading
  • Profile-based settings for different posting scenarios
  • Folder monitoring with profile assignment
  • Approval system for upload tasks (optional)

πŸ” Security & Obfuscation

  • Complete obfuscation capabilities:
    • Random file names
    • Random archive passwords with encrypted headers
    • Subject obfuscation
    • YENC name obfuscation
    • Filename metadata obfuscation
    • Fully customizable nyuu templates

βš™οΈ Advanced Options

  • RAR Configuration:
    • Preserve folder structure
    • Custom volume sizes
    • Solid archive support
    • File exclusion patterns
    • Option to disable RAR completely
  • ParPar Options: Advanced redundancy and slice settings
  • Nyuu Customization: Post checks, retry attempts, and comprehensive CLI options
  • Custom CLI Arguments for all external tools

🌐 Automation & Integration

  • Optional API server for remote control
  • WebSocket server for real-time updates
  • Automatic updates (configurable)
  • Automatic file generation (.txt, .nfo, etc.) per post

Documentation

Topic Description
πŸ“ Profile Settings Comprehensive guide to posting profiles and all available options
πŸ“… Queue System Details about the dual-queue architecture and settings
🌐 API Server Remote control API with Postman collection
πŸ”Œ WebSocket Server Real-time event system documentation
πŸ“ Content Templates File generation and templating system

Configuration

Replace Existing Files

Under General Settings, the β€œReplace existing files” option controls conflict resolution:

  • βœ… Enabled: Deletes existing files (rar/par folders, NZB files) before starting new jobs
  • ❌ Disabled: Automatically renames tasks (e.g., β€œpost-name-1”, β€œpost-name-2”) to avoid conflicts

⚠️ Note: Disabling this option will also alter the post name to match the renamed task.

External Tool Documentation

Tool Documentation Link
RAR CLI Complete Command Reference
ParPar CLI Full Help Documentation
Nyuu CLI Complete Usage Guide

Troubleshooting

Common Issues

Special Characters in Post Names

⚠️ Important: Avoid special characters in post names as they can cause file creation errors.

Use only alphanumeric characters, spaces, hyphens, and underscores for reliable operation.


Development

Project Status

NZB Flow is an active passion project focused on providing a robust usenet posting solution. While built on Electron (for UI familiarity), all core operations use native CLI executables for optimal performance.

Current Focus Areas:

  • Performance testing and optimization
  • UI/UX improvements for better table layouts
  • Enhanced mobile responsiveness

Planned Features:

  • πŸ”„ Backup server support per profile with automatic failover
  • 🎨 Visual improvements for better wide-screen layouts
  • πŸ“¦ More compression format support

πŸ’¬ Suggest Features: Have ideas? Open an issue on GitHub!

Build From Source

Prerequisites: Node.js and pnpm

Install Dependencies

pnpm install

Build for Production

# Windows
pnpm build:win

# macOS
pnpm build:mac

# Linux
pnpm build:linux

Development Mode

pnpm dev

Repository: github.com/db1996/nzb-flow License: View License


Copyright © 2024 NZB Flow. Distributed under MIT License.

This site uses Just the Docs, a documentation theme for Jekyll.