https://github.com/nntmux/newznab-tmux
Laravel based usenet indexer
https://github.com/nntmux/newznab-tmux
apache gplv3 indexer laravel mariadb newsgroups nginx nntp nzb php sphinx tmux usenet
Last synced: 5 days ago
JSON representation
Laravel based usenet indexer
- Host: GitHub
- URL: https://github.com/nntmux/newznab-tmux
- Owner: NNTmux
- License: gpl-3.0
- Created: 2014-08-04T12:03:17.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2025-05-14T21:06:33.000Z (7 months ago)
- Last Synced: 2025-05-15T18:10:04.875Z (7 months ago)
- Topics: apache, gplv3, indexer, laravel, mariadb, newsgroups, nginx, nntp, nzb, php, sphinx, tmux, usenet
- Language: JavaScript
- Homepage:
- Size: 197 MB
- Stars: 227
- Watchers: 19
- Forks: 56
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/anth0/nnplus) and [nZEDb](https://github.com/nZEDb/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](http://mysqltuner.pl) and set `innodb_buffer_pool_size` appropriately (1-2GB per million releases).
For further tuning advice, see:
- [How do I tune MySQL for performance?](https://stackoverflow.com/questions/1047497/how-do-i-tune-mysql-for-performance)
- [How to optimize MySQL server performance?](https://stackoverflow.com/questions/600032/how-to-optimize-mysql-server-performance)
- [How to optimize MariaDB for large databases?](https://stackoverflow.com/questions/32421909/how-to-optimize-mariadb-for-large-databases)
## Installation
Follow the [Ubuntu install guide](https://github.com/NNTmux/newznab-tmux/wiki/Ubuntu-Install-guide) and [Composer install guide](https://github.com/NNTmux/newznab-tmux/wiki/Installing-Composer).
## 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
- Active development: see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines
- Support: [Discord](https://discord.gg/GjgGSzkrjh)
## License
NNTmux is GPL v3. See LICENSE for details. External libraries include their own licenses in respective folders.