Skip to content

Home

Jump to bottom Edit New page
DariusIII edited this page Dec 31, 2025 · 4 revisions

Welcome to the NNTmux Wiki

NNTmux is a modern Usenet indexer built on Laravel 12, designed for high performance and scalability. It automatically scans Usenet, collects headers, and organizes them into searchable releases with rich metadata from TMDB, TVDB, IMDB, and more.

Quick Links

Getting Started

Core Documentation

Features

Reference

Requirements

Component Minimum Recommended
PHP 8.2+ 8.3+
MariaDB 10.6+ 11.4+
MySQL 8.0+ 8.0+
Composer 2.x Latest
Node.js 18+ 20+
OS Ubuntu 22.04 Ubuntu 24.04
RAM 4GB 16GB+
Disk 50GB 250GB+ SSD

Quick Start

# Clone repository
git clone https://github.com/NNTmux/newznab-tmux.git
cd newznab-tmux

# Configure environment
cp .env.example .env
nano .env  # Edit with your settings

# Run installer
php artisan nntmux:install

# Start processing
php artisan tmux:start

For detailed instructions, see the Ubuntu Install Guide.

Key Features

Processing

  • Multi-threaded processing via tmux with parallel header retrieval, release creation, and post-processing
  • Multiprocessing commands for high-performance parallel operations
  • Smart categorization using pipeline-based release categorization

Metadata

  • TV matching from TMDB, TVDB, TVMaze, and Trakt
  • Movie matching from TMDB, OMDB, and IMDB
  • Anime support via AniList integration
  • Game metadata from Steam and GiantBomb

Search

  • ManticoreSearch integration for fast full-text search
  • Elasticsearch support as alternative
  • Offset-based parallel indexing for high-performance population

Monitoring

  • Laravel Horizon for queue monitoring and management
  • Laravel Pulse for application performance monitoring
  • Laravel Telescope for debugging (development)

Common Commands

Processing Control

php artisan tmux:start          # Start processing
php artisan tmux:stop           # Stop processing
php artisan tmux:attach         # View processing

TV Reprocessing

php artisan tv:reprocess-unmatched         # Reprocess unmatched TV releases
php artisan tv:reprocess-missing-episodes  # Fix releases with missing episodes
php artisan tv:reprocess --guid=xxx        # Reprocess specific release

Maintenance

php artisan nntmux:optimize-tables   # Optimize database tables
php artisan pulse:clear              # Clear Pulse monitoring data
php artisan optimize:clear           # Clear all caches

Search Indexes

php artisan manticore:create-indexes              # Create Manticore indexes
php artisan nntmux:populate --manticore --releases  # Populate releases
php artisan nntmux:populate --manticore --predb     # Populate PreDB

See Console Commands for the complete reference.

Getting Help

Recent Updates

Framework

  • Updated to Laravel 12 with latest features
  • PHP 8.3 support with improved performance
  • Modern frontend stack with Vite, Tailwind CSS, and Vue 3

TV & Movie Processing

  • Pipeline-based TV postprocessing with postprocess:tv-pipeline
  • Commands for targeted reprocessing:
    • tv:reprocess-unmatched - Releases with no show match
    • tv:reprocess-missing-episodes - Releases with show but no episode match
  • Reset shows for reprocessing with nntmux:reset-tv-show

Search & Performance

  • ManticoreSearch integration with manticore:create-indexes
  • High-performance offset-based parallel index population
  • Elasticsearch reindexing improvements

Monitoring

  • Laravel Pulse integration for real-time metrics
  • Laravel Horizon for queue management
  • System metrics collection with metrics:collect

Processing

  • Multiprocessing commands for parallel operations
  • Improved release name fixing with multiple methods
  • Enhanced categorization with pipeline architecture

Project Links

Add a custom footer

Getting Started

Core Documentation

Features

API & Integration

Help

Clone this wiki locally