nntmux/newznab-tmux

A Usenet Indexer

3.0.1 2024-04-28 13:33 UTC

Requires

• php: ^8.2
• ext-bcmath: *
• ext-ctype: *
• ext-curl: *
• ext-exif: *
• ext-fileinfo: *
• ext-filter: *
• ext-gd: *
• ext-hash: *
• ext-iconv: *
• ext-intl: *
• ext-json: *
• ext-mbstring: *
• ext-mysqlnd: *
• ext-openssl: *
• ext-pcre: *
• ext-pdo: *
• ext-pdo_mysql: *
• ext-session: *
• ext-simplexml: *
• ext-sockets: *
• ext-sodium: *
• ext-spl: *
• ext-xmlwriter: *
• ext-zlib: *
• aharen/omdbapi: ^2.1
• anhskohbo/no-captcha: dev-master
• b3rs3rk/steamfront: dev-master
• bacon/bacon-qr-code: ^3.0
• bhuvidya/laravel-countries: dev-master
• brick/math: ^0.11
• canihavesomecoffee/thetvdbapi: ^2.0
• dariusiii/php-itunes-api: ^1.0
• dariusiii/rarinfo: ^2.7
• dariusiii/tmdb-laravel: ^7.0
• dborsatto/php-giantbomb: ^2.2
• divineomega/php-cli-progress-bar: ^2.1
• fakerphp/faker: ^1.23
• genealabs/laravel-caffeine: ^11.0
• geoip2/geoip2: ^3.0
• google/recaptcha: ^1.3
• guzzlehttp/guzzle: ^7.2
• imdbphp/imdbphp: ^8.1
• intervention/image: ^3.3
• joshpinkney/tv-maze-php-api: dev-master
• jrean/laravel-user-verification: ^12.0
• junaidnasir/larainvite: ^7.0
• kevinlebrun/colors.php: ^1.0
• laravel/framework: ^11.5
• laravel/horizon: ^5.23
• laravel/pulse: dev-validation-errors
• laravel/sanctum: ^4.0
• laravel/scout: ^10.8
• laravel/telescope: ^5.0
• laravel/tinker: ^2.9
• laravel/ui: ^4.4
• laravelcollective/html: ^6.4
• league/climate: ^3.8
• livewire/livewire: ^3.4
• livewire/volt: ^1.0
• mailerlite/laravel-elasticsearch: ^11.1
• manticoresoftware/manticoresearch-php: ^3.0
• marcreichel/igdb-laravel: ^4.2
• mhor/php-mediainfo: ^5.6
• monicahq/laravel-cloudflare: ^3.6
• monolog/monolog: ^3.5
• mtownsend/xml-to-array: ^2.0
• nesbot/carbon: ^3.3
• opis/closure: ^3.6
• pear/net_nntp: ^1.6.0
• php-ffmpeg/php-ffmpeg: ^1.2
• php-http/guzzle7-adapter: ^1.0
• php-http/message: ^1.16
• pragmarx/google2fa-laravel: ^2.2
• predis/predis: ^2.2
• propaganistas/laravel-disposable-email: ^2.3
• ramsey/uuid: ^4.7
• riari/laravel-forum: ^6.0
• sentry/sentry-laravel: ^4.3
• smarty/smarty: ^4.3
• spatie/async: ^1.6
• spatie/laravel-backup: ^8.6
• spatie/laravel-directory-cleanup: ^1.10
• spatie/laravel-fractal: ^6.1
• spatie/laravel-ignition: ^2.4
• spatie/laravel-image-optimizer: ^1.8
• spatie/laravel-permission: ^6.3
• sspat/es-query-sanitizer: ^1.0
• stechstudio/laravel-zipstream: ^4.14
• symfony/http-client: ^7.0
• symfony/postmark-mailer: ^7.0
• symfony/process: ^7.0
• vlucas/phpdotenv: ^5.6
• voku/simple_html_dom: ^4.8
• ytake/laravel-smarty: ^8.0

Requires (Dev)

• barryvdh/laravel-ide-helper: ^3.0
• beyondcode/laravel-dump-server: ^2.0
• captainhook/captainhook: ^5.4
• captainhook/plugin-composer: ^5.2
• driftingly/rector-laravel: ^0.29
• ergebnis/composer-normalize: ^2.30
• friendsofphp/php-cs-fixer: ^3.49
• jubeki/laravel-code-style: ^2.0
• larastan/larastan: ^2.8
• laravel/breeze: ^2.0
• laravel/pint: ^1.13
• laravel/sail: ^1.26
• mockery/mockery: ^1.6
• nunomaduro/collision: ^8.0
• php-coveralls/php-coveralls: ^2.4
• phpunit/phpunit: ^11.0
• rector/rector: ^0.18.13

Suggests

• ext-gd: to use GD library based image processing.
• ext-imagick: to use Imagick based image processing.
• ext-xdebug: For developement work

GPL-3.0-only

• NNTmux Team

• laravel
• eloquent
• usenet
• indexer
• NNTmux
• newznab-tmux

README

NNTmux automatically scans usenet, similar to the way google search bots scan the internet. It does this by collecting usenet headers and temporarily storing them in a database until they can be collated into posts/releases. It provides a web-based front-end providing search, browse, and programmable (API) functionality.

This project is a fork of the open source usenet indexer newznab plus: https://github.com/anth0/nnplus and open source nZEDb usenet indexer https://github.com/nZEDb/nZEDb

NNTmux improves upon the original design, implementing several new features including:

• Optional multi-threaded processing (header retrieval, release creation, post-processing etc)
• Advanced search features (name, subject, category, post-date etc)
• Intelligent local caching of metadata
• Tmux (terminal session multiplexing) engine that provides thread, database and performance monitoring
• Image and video samples

Prerequisites

System Administration know-how. NNTmux is not plug-n-play software. Installation and operation requires a moderate amount of administration experience. NNTmux is designed and developed with GNU/Linux operating systems. Certain features are not available on other platforms. A competent Windows administrator should be able to run NNTmux on a Windows OS.

Hardware

64GB RAM, 8 cores(16 threads) and 320GB disk space minimum.

If you wish to use more than 5 threads an eight core CPU is beneficial.

The overall speed of NNTmux is largely governed by performance of the database. As many of the database tables should be held within system RAM as possible. See Database Section below.

Software

PHP 8.2+ (and various modules)
MariaDB 10+ or MySQL 8+ (Postgres is not supported)

The installation guides have more detailed software requirements.

Database

Most (if not all) distributions ship MySQL with a default configuration that will perform well on a Raspberry Pi. If you wish to store more that 500K releases, these default settings will quickly lead to poor performance. Expect this.

As a general rule of thumb the database will need a minimum of 1-2G buffer RAM for every million releases you intend to store. That RAM should be assigned to this parameter:

• innodb_buffer_pool_size

Use mysqltuner.pl for recommendations for these and other important tuner parameters. Also refer to the nZEDb project's wiki page: https://github.com/nZEDb/nZEDb/wiki/Database-tuning. This is particularly important before you start any large imports or backfills.

Installation

Follow NNTmux Ubuntu install guide:

https://github.com/NNTmux/newznab-tmux/wiki/Ubuntu-Install-guide

For composer install and getting NNTmux follow this guide:

https://github.com/NNTmux/newznab-tmux/wiki/Installing-Composer

Docker

NNTmux uses Laravel Sail to manage docker container. To start docker container, edit your .env and then run:

./sail up -d

Support

Support is given on discord: https://discord.gg/GjgGSzkrjh

Licenses

NNTmux is GPL v3. See LICENSE.txt for the full license.

All external libraries will have their full licenses in their respective folders.