nntmux/newznab-tmux

A Usenet Indexer

Fund package maintenance!
DariusIII
Patreon

Installs: 143

Dependents: 0

Suggesters: 0

Security: 0

Stars: 245

Watchers: 20

Forks: 57

Open Issues: 0

Language:JavaScript

Type:project

pkg:composer/nntmux/newznab-tmux

4.1 2025-09-05 19:13 UTC

README

Latest Stable Version License Become a Patron!

NNTmux

NNTmux is a modern Usenet indexer built on Laravel, designed for high performance and scalability. It automatically scans Usenet, collects headers, and organizes them into searchable releases. The project is actively maintained and features multi-threaded processing, advanced search, and a web-based front-end with API access.

This project is a fork of newznab plus and nZEDb, with significant improvements:

  • Multi-threaded processing (header retrieval, release creation, post-processing)
  • Advanced search (name, subject, category, post-date)
  • Intelligent local caching of metadata
  • Tmux engine for thread, database, and performance monitoring
  • Image and video sample support
  • Modern frontend stack: Vite, Tailwind CSS, Vue 3
  • Dockerized development via Laravel Sail

Prerequisites

  • System administration experience (Linux recommended)
  • PHP 8.3+ and required extensions
  • MariaDB 10+ or MySQL 8+ (Postgres not supported)
  • Node.js for frontend assets
  • Recommended: 64GB RAM, 8+ cores, 320GB+ disk space

Database Tuning

For large-scale indexing, tune your database for performance. Use mysqltuner.pl and set innodb_buffer_pool_size appropriately (1-2GB per million releases).

For further tuning advice, see:

Installation

Follow the Ubuntu install guide and Composer install guide.

Docker & Development

NNTmux uses Laravel Sail for Docker-based development. To start:

  1. Edit your .env file for configuration.
  2. Run:
    ./sail up -d
    

Frontend assets use Vite, Tailwind CSS, and Vue 3. See package.json for scripts and dependencies.

Contribution & Support

License

NNTmux is GPL v3. See LICENSE for details. External libraries include their own licenses in respective folders.