NNTmux

https://github.com/nntmux/newznab-tmux
Admin
NNTmux is a modern Usenet indexer built on Laravel, featuring multi-threaded processing, advanced...
Tokens:70,443
Snippets:713
Trust Score:6.9
License:GPL-3.0
Update:1 month ago
Show doc for...
Tokens:
Raw
### Quick Start Commands

Source: https://github.com/nntmux/newznab-tmux/blob/master/DOCKER.md

Commands to copy and configure the environment, build and start the Docker containers, install NNTmux, and build frontend assets. Requires Docker Compose v2.22+ and a GitHub token for Composer.

```bash
# 1. Copy and configure your environment
cp .env.example .env
# Edit .env — set DB credentials, COMPOSER_AUTH, and uncomment the
# "Docker service hostnames" block at the bottom.

# 2. Build and start
make build
make up

# 3. Install NNTmux (first run only)
make artisan cmd="nntmux:install"

# 4. Build frontend assets
make npm-build
```

--------------------------------

### Hetzner and OVH Terraform setup commands

Source: https://github.com/nntmux/newznab-tmux/blob/master/README.md

Use these commands to prepare and apply a Hetzner or OVH deployment. Copy the example backend and tfvars files, edit them, then run init, plan, and apply with the selected provider.

```bash
provider=hetzner # or ovh
cp "infra/terraform/$provider/backend.hcl.example" "infra/terraform/$provider/backend.hcl"
cp "infra/terraform/$provider/terraform.tfvars.example" "infra/terraform/$provider/terraform.tfvars"
# Edit the files; use a unique state key for each provider and environment.
deploy/select.sh "$provider" terraform init -backend-config=backend.hcl
deploy/select.sh "$provider" terraform plan -out=deployment.tfplan
deploy/select.sh "$provider" terraform apply deployment.tfplan
```

--------------------------------

### Install and start Elasticsearch

Source: https://github.com/nntmux/newznab-tmux/wiki/Search-Engines

Install Elasticsearch 8.x on Debian/Ubuntu: add the Elastic GPG key and apt repository, install the package, set heap memory in /etc/elasticsearch/jvm.options (e.g., -Xms2g and -Xmx2g), enable and start the systemd service, then verify the cluster health endpoint.

```bash
wget -qO - https://artifacts.elastic.co/GPG-KEY-elasticsearch | sudo apt-key add -
echo "deb https://artifacts.elastic.co/packages/8.x/apt stable main" | sudo tee /etc/apt/sources.list.d/elastic-8.x.list

# Install
sudo apt update
sudo apt install elasticsearch

# Configure memory (edit /etc/elasticsearch/jvm.options)
# -Xms2g
# -Xmx2g

# Start service
sudo systemctl enable elasticsearch
sudo systemctl start elasticsearch

# Verify
curl -X GET "localhost:9200/_cluster/health?pretty"
```

--------------------------------

### Install Composer globally

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

Run these commands to download and verify the Composer installer, install Composer to /usr/local/bin, and verify the installation with 'composer -V'. The verification step checks the SHA384 hash against the official pubkeys page and aborts if corrupt.

```bash
cd /var/www
sudo chmod 777 .
php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
php -r 'if (hash_file("SHA384", "composer-setup.php") === preg_filter("#^.*?<pre>|</pre>.*$#s", "", file_get_contents("https://composer.github.io/pubkeys.html"))) { echo "Installer verified"; } else { echo "Installer corrupt"; unlink("composer-setup.php"); } echo PHP_EOL;'
sudo php composer-setup.php --install-dir=/usr/local/bin --filename=composer
php -r "unlink('composer-setup.php');"
composer -V
```

--------------------------------

### Install required tools

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

Install the essential command-line tools needed for the installation: software-properties-common, git, make, curl, wget, and unzip.

```bash
sudo apt install -y software-properties-common git make curl wget unzip
```

--------------------------------

### Install and configure newznab-tmux

Source: https://github.com/nntmux/newznab-tmux/wiki/Home

Commands to clone the repository, set up the environment file, and run the installer and startup process.

```bash
# 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
```

--------------------------------

### Install Composer

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

Downloads and installs Composer globally. Verifies the installation with the version command.

```bash
cd ~
curl -sS https://getcomposer.org/installer | php
sudo mv composer.phar /usr/local/bin/composer
composer --version
```

--------------------------------

### Install required tools

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

Installs essential command-line tools: p7zip-full, mediainfo, lame, ffmpeg, and tmux.

```bash
sudo apt install -y p7zip-full mediainfo lame ffmpeg tmux
```

--------------------------------

### Install Supervisor on Ubuntu

Source: https://github.com/nntmux/newznab-tmux/wiki/Email-queue

Installs Supervisor on Ubuntu. This is the first step before configuring queue workers.

```bash
sudo apt-get install supervisor
```

--------------------------------

### Install MariaDB server and client

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

Updates the package list and installs MariaDB server and client packages.

```bash
sudo apt update
sudo apt install -y mariadb-server mariadb-client
```

--------------------------------

### Clone the newznab-tmux repository

Source: https://github.com/nntmux/newznab-tmux/blob/master/README.md

Clones the newznab-tmux repository from GitHub and changes into the project directory. This is the first step of the quick start installation.

```bash
git clone https://github.com/NNTmux/newznab-tmux.git
cd newznab-tmux
```

--------------------------------

### Database Initial Setup

Source: https://github.com/nntmux/newznab-tmux/blob/master/README.md

Run migrations and seed initial data (categories, groups, etc.) for the database.

```bash
# Run migrations
php artisan migrate

# Seed initial data (categories, groups, etc.)
php artisan db:seed
```

--------------------------------

### Install ManticoreSearch on Debian/Ubuntu

Source: https://github.com/nntmux/newznab-tmux/wiki/Search-Engines

Install ManticoreSearch on Debian/Ubuntu by adding the official repository, installing the manticore and manticore-columnar-lib packages, enabling and starting the service, and verifying with a MySQL command.

```bash
wget https://repo.manticoresearch.com/manticore-repo.noarch.deb
sudo dpkg -i manticore-repo.noarch.deb
sudo apt update

# Install
sudo apt install manticore manticore-columnar-lib

# Start service
sudo systemctl enable manticore
sudo systemctl start manticore

# Verify
mysql -h 127.0.0.1 -P 9306 -e "SHOW STATUS"
```

--------------------------------

### Update and Backfill Commands Usage Examples

Source: https://github.com/nntmux/newznab-tmux/wiki/Console-Commands

Examples of commands for updating binaries, backfilling groups, updating headers, and running a full update cycle for a group.

```bash
# Update all active groups
php artisan update:binaries
```

```bash
# Backfill a specific group
php artisan backfill:group --group="alt.binaries.teevee"
```

```bash
# Update headers for one group
php artisan group:update-headers --group="alt.binaries.movies"
```

```bash
# Run full update cycle for a group
php artisan group:update-all
```

--------------------------------

### Install and configure ManticoreSearch

Source: https://github.com/nntmux/newznab-tmux/blob/master/README.md

Install ManticoreSearch via apt, set SEARCH_ENGINE=manticore in .env, and build indexes with php artisan nntmux:index-manticore.

```bash
# Install ManticoreSearch
wget https://repo.manticoresearch.com/manticore-repo.noarch.deb
sudo dpkg -i manticore-repo.noarch.deb
sudo apt update
sudo apt install manticore

# Configure in .env
SEARCH_ENGINE=manticore
MANTICORE_HOST=127.0.0.1
MANTICORE_PORT=9308

# Build indexes
php artisan nntmux:index-manticore
```

--------------------------------

### GET /details

Source: https://github.com/nntmux/newznab-tmux/blob/master/docs/nntmux_api_v2.md

Retrieves details for a specific release by GUID.

```APIDOC
## GET /details

### Description
Retrieves details for a specific release by GUID.

### Method
GET

### Endpoint
/details

### Parameters
#### Query Parameters
- **id** (string) - Required - GUID of the release

### Response
#### Success Response (200)
(No explicit response body example provided)
```

--------------------------------

### Copy Terraform example files and run Terraform init, plan, and apply

Source: https://github.com/nntmux/newznab-tmux/blob/master/README.md

Copies example backend and variable files to a secure directory, then initializes, plans, and applies Terraform to generate the Ansible inventory. Use an encrypted S3 state backend with locking and a key separate from every cloud deployment.

```bash
cp infra/terraform/baremetal/backend.hcl.example /secure/baremetal-backend.hcl
cp infra/terraform/baremetal/terraform.tfvars.example /secure/baremetal.tfvars
terraform -chdir=infra/terraform/baremetal init -backend-config=/secure/baremetal-backend.hcl
terraform -chdir=infra/terraform/baremetal plan -var-file=/secure/baremetal.tfvars -out=/secure/baremetal.tfplan
terraform -chdir=infra/terraform/baremetal apply /secure/baremetal.tfplan
```

--------------------------------

### Install PHP dependencies with Composer

Source: https://github.com/nntmux/newznab-tmux/blob/master/README.md

Installs PHP dependencies using Composer with optimizations for production. Run this after cloning the repository.

```bash
composer install --no-dev --optimize-autoloader
```

--------------------------------

### Install and configure Elasticsearch

Source: https://github.com/nntmux/newznab-tmux/blob/master/README.md

Install Elasticsearch 8.x via apt, set SEARCH_ENGINE=elasticsearch in .env, and build indexes with php artisan nntmux:index-elasticsearch.

```bash
# Install Elasticsearch
wget -qO - https://artifacts.elastic.co/GPG-KEY-elasticsearch | sudo apt-key add -
echo "deb https://artifacts.elastic.co/packages/8.x/apt stable main" | sudo tee /etc/apt/sources.list.d/elastic-8.x.list
sudo apt update && sudo apt install elasticsearch

# Configure in .env
SEARCH_ENGINE=elasticsearch
ELASTICSEARCH_HOST=127.0.0.1
ELASTICSEARCH_PORT=9200

# Build indexes
php artisan nntmux:index-elasticsearch
```

--------------------------------

### Verify PHP installation

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

Checks the installed PHP version to confirm the installation succeeded.

```bash
php -v
```

--------------------------------

### Copy and configure environment file

Source: https://github.com/nntmux/newznab-tmux/blob/master/README.md

Copies the example environment file to .env and generates an application key. This is required before configuring the .env file.

```bash
cp .env.example .env
php artisan key:generate
```

--------------------------------

### Install frontend assets with npm

Source: https://github.com/nntmux/newznab-tmux/blob/master/README.md

Installs Node.js dependencies and builds the frontend assets. Requires Node.js 18+ and npm.

```bash
npm install
npm run build
```

--------------------------------

### Database and PreDB Command Usage Examples

Source: https://github.com/nntmux/newznab-tmux/wiki/Console-Commands

Examples of running database maintenance and PreDB commands via the Artisan CLI. Includes commands for optimizing tables, resetting postprocessing for a category, checking PreDB matches, importing NZBs, and finding size mismatches.

```bash
# Optimize tables
php artisan nntmux:optimize-tables

# Reset postprocessing for a category
php artisan nntmux:resetpp --category=5000

# Check releases against PreDB
php artisan predb:check

# Import NZB files
php artisan nntmux:import-nzbs --path=/path/to/nzbs

# Find size mismatches
php artisan nntmux:find-size-mismatches --direction=bigger
```

--------------------------------

### Install Node.js for frontend assets

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

Adds the NodeSource repository for Node.js 20.x and installs Node.js. Verifies both Node.js and npm versions.

```bash
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt install -y nodejs
node --version
npm --version
```

--------------------------------

### Set up control node virtual environment and install Ansible dependencies

Source: https://github.com/nntmux/newznab-tmux/blob/master/README.md

Creates a Python virtual environment, installs pinned Ansible requirements, activates the environment, and installs required Ansible collections. Run these commands on a Linux/WSL control node with Python 3.12 and Terraform >=1.10,<2.0.

```bash
python3 -m venv .venv-ansible
.venv-anshell/bin/pip install -r infra/ansible/requirements.txt
source .venv-anshell/bin/activate
ansible-galaxy collection install -r infra/ansible/requirements.yml
```

--------------------------------

### Start Horizon with Supervisor

Source: https://github.com/nntmux/newznab-tmux/wiki/Laravel-Horizon

Commands to update Supervisor configuration and start the Horizon process after creating the configuration file.

```bash
sudo supervisorctl reread
```

```bash
sudo supervisorctl update
```

```bash
sudo supervisorctl start laravel-horizon:*
```

--------------------------------

### Initialize and apply Terraform for AWS infrastructure

Source: https://github.com/nntmux/newznab-tmux/blob/master/README.md

Use this sequence to set up the Terraform backend and apply the infrastructure. Requires an existing S3 bucket, Route 53 zone, and AWS credentials. The commands copy example configuration files, initialize the backend, plan, and apply the deployment.

```bash
cd infra/terraform/aws
cp backend.hcl.example backend.hcl
cp terraform.tfvars.example terraform.tfvars
# Edit both files with your existing bucket, region, zone, and hostname.
terraform init -backend-config=backend.hcl
terraform plan -out=deployment.tfplan
terraform apply deployment.tfplan
terraform output
```

--------------------------------

### Install and verify nntmux deployment

Source: https://github.com/nntmux/newznab-tmux/blob/master/README.md

Installs the nntmux indexer on a single host and verifies the installation. Add --check for a preview that skips Python bootstrap, builds, database changes, certificate issuance, and lifecycle operations. Rerunning installation preserves application identity, database contents, group settings, and processing activation.

```bash
python3 deploy/baremetal/deploy.py install --host indexer \
  --inventory /secure/hosts.yml --settings /secure/indexer-settings.yml \
  --vault-vars /secure/indexer-vault.yml
python3 deploy/baremetal/deploy.py verify --host indexer --inventory /secure/hosts.yml
```

--------------------------------

### TV Processing Commands Usage

Source: https://github.com/nntmux/newznab-tmux/wiki/Console-Commands

Examples of commands for TV processing: reprocessing unmatched releases, missing episodes, specific GUIDs, resetting a show, and running the TV pipeline.

```bash
# Reprocess all unmatched TV releases
php artisan tv:reprocess-unmatched

# Reprocess releases with shows matched but episodes missing
php artisan tv:reprocess-missing-episodes

# Reprocess a specific TV release by GUID
php artisan tv:reprocess --guid=abc123def456

# Reset a TV show for reprocessing
php artisan nntmux:reset-tv-show --videos_id=12345

# Run TV pipeline postprocessing
php artisan postprocess:tv-pipeline
```

--------------------------------

### Install build tools for Ubuntu/Debian

Source: https://github.com/nntmux/newznab-tmux/wiki/RapidYenc

Installs the required build tools (build-essential, cmake, curl, tar, coreutils) on Ubuntu/Debian systems for compiling RapidYenc.

```bash
sudo apt update
sudo apt install build-essential cmake curl tar coreutils
```

--------------------------------

### Install PHP 8.3 and extensions

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

Installs PHP 8.3 CLI, FPM, and required extensions along with Redis server. The command spans multiple lines using backslashes.

```bash
sudo apt install -y php8.3-cli php8.3-dev php8.3-common php8.3-curl \
    php8.3-gd php8.3-mysql php8.3-mbstring php8.3-xml php8.3-intl \
    php8.3-fpm php8.3-bcmath php8.3-zip php8.3-imagick php8.3-redis \
    php-pear redis-server
```

--------------------------------

### Run General Postprocessing by GUID

Source: https://github.com/nntmux/newznab-tmux/wiki/TV-Movie-Processing

Command to run general postprocessing by GUID using the postprocess:guid artisan command.

```bash
# Run general postprocessing by GUID
php artisan postprocess:guid
```

--------------------------------

### Sorting Response Example (sort=size_desc)

Source: https://github.com/nntmux/newznab-tmux/blob/master/docs/nntmux_api_v2.md

Example HTTP response showing releases ordered largest-to-smallest when sort=size_desc is used. Includes pagination and quota metadata.

```http
HTTP/1.1 200 OK
Content-Type: application/json
{
  "Total": 2,
  "apiCurrent": 0,
  "apiMax": 100,
  "grabCurrent": 0,
  "grabMax": 100,
  "apiOldestTime": "",
  "grabOldestTime": "",
  "results": [
    { "title": "Ubuntu ISO x64", "size": 734003200 },
    { "title": "Ubuntu ISO x86", "size": 367001600 }
  ]
}
```

--------------------------------

### Quick Reference Commands

Source: https://github.com/nntmux/newznab-tmux/blob/master/AGENTS.md

Essential commands for common development tasks. Run tests with a filter, format changed files with Pint, start the processing engine, build frontend assets, and refresh cached routes. These commands should be run on the WSL host unless using Sail for Compose lifecycle.

```bash
php artisan test --compact --filter=TestName  # Run single test (PHPUnit only)
./vendor/bin/pint --dirty                     # Format changed files
php artisan tmux:start                        # Start processing engine
npm run build                                 # Required after frontend changes
php artisan route:cache                       # Refresh cached routes if new routes seem missing
```

--------------------------------

### Start Supervisor Worker Processes

Source: https://github.com/nntmux/newznab-tmux/wiki/Email-queue

Commands to update Supervisor configuration and start the queue worker processes after creating the configuration file.

```bash
sudo supervisorctl reread
```

```bash
sudo supervisorctl update
```

```bash
sudo supervisorctl start laravel-worker:*
```

--------------------------------

### Start IRC Scraper Command

Source: https://github.com/nntmux/newznab-tmux/wiki/Console-Commands

Command to start the IRC scraper for collecting PRE information from IRC pre-channels.

```bash
# Start IRC scraper
php artisan irc:scrape
```

--------------------------------

### Get help for any Artisan command

Source: https://github.com/nntmux/newznab-tmux/wiki/Console-Commands

Run any command with -h or --help to see detailed options.

```bash
php artisan command:name --help
```

--------------------------------

### Reprocess a Single TV Release by GUID

Source: https://github.com/nntmux/newznab-tmux/wiki/TV-Movie-Processing

Use this command to reprocess a specific TV release by providing its GUID.

```bash
# Reprocess by GUID
php artisan tv:reprocess --guid=abc123def456
```

--------------------------------

### Restart Manticore and finish package configuration

Source: https://github.com/nntmux/newznab-tmux/blob/master/docs/manticore-ubuntu-package.md

Stop, reset, start, and check Manticore status, then run dpkg --configure -a.

```bash
sudo systemctl stop manticore || true
sudo systemctl reset-failed manticore
sudo systemctl start manticore
sudo systemctl status manticore --no-pager
sudo journalctl -u manticore -n 100 --no-pager
sudo dpkg --configure -a
```

--------------------------------

### Update and upgrade system packages

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

Run these commands to update all packages and reboot the system. This is the first step in the installation process.

```bash
sudo apt update
sudo apt upgrade -y
sudo apt dist-upgrade -y
sudo reboot
```

--------------------------------

### Install latest unrar

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

Downloads and installs the latest unrar from rarlab.com, replacing the outdated repository version. Includes cleanup of the installation directory.

```bash
mkdir -p ~/unrar_install && cd ~/unrar_install
wget https://www.rarlab.com/rar/rarlinux-x64-701.tar.gz
tar -xzf rarlinux-x64-701.tar.gz
sudo cp rar/unrar /usr/local/bin/
sudo chmod 755 /usr/local/bin/unrar
cd ~ && rm -rf ~/unrar_install
```

--------------------------------

### Secure MariaDB installation

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

Runs the mysql_secure_installation script to secure the MariaDB installation.

```bash
sudo mysql_secure_installation
```

--------------------------------

### Verify unrar installation

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

Checks the installed unrar version.

```bash
unrar --version
```

--------------------------------

### Release Processing Commands Usage Examples

Source: https://github.com/nntmux/newznab-tmux/wiki/Console-Commands

Examples of commands for processing releases, fixing names, removing unwanted releases, running additional postprocessing, recategorizing, and deleting releases.

```bash
# Process releases for all groups
php artisan releases:process
```

```bash
# Fix release names
php artisan releases:fix-names
```

```bash
# Remove unwanted releases
php artisan releases:remove-crap
```

```bash
# Run additional postprocessing for a specific release
php artisan releases:additional --guid=abc123
```

```bash
# Recategorize releases
php artisan nntmux:recategorize-releases
```

```bash
# Delete releases matching criteria
php artisan nntmux:delete-releases --help
```

--------------------------------

### Run benchmark with 512 KiB articles

Source: https://github.com/nntmux/newznab-tmux/wiki/RapidYenc

Runs the benchmark with a reduced article size of 524288 bytes (512 KiB) for a shorter test. Requires development dependencies installed and should be run from the checkout root.

```bash
php scripts/benchmark-yenc.php --size=524288 --native="$(pwd)/storage/app/rapidyenc/librapidyenc.so"
```

--------------------------------

### Run full benchmark

Source: https://github.com/nntmux/newznab-tmux/wiki/RapidYenc

Runs the benchmark script with the native library path. Requires development dependencies installed and should be run from the checkout root.

```bash
php scripts/benchmark-yenc.php --native="$(pwd)/storage/app/rapidyenc/librapidyenc.so"
```

--------------------------------

### Reprocess Release by GUID

Source: https://github.com/nntmux/newznab-tmux/wiki/TV-Movie-Processing

Command to reprocess a release by GUID using the tv:reprocess artisan command.

```bash
php artisan tv:reprocess --guid=<release_guid>
```

--------------------------------

### Kill root tmux and start as correct user

Source: https://github.com/nntmux/newznab-tmux/wiki/Troubleshooting

Kill the root tmux server and start a new tmux session as the correct user. Adjust the path and user as needed.

```bash
# Kill root tmux session
sudo tmux kill-server

# Start as correct user
su - youruser -c "cd /var/www/nntmux && php artisan tmux:start"
```

--------------------------------

### MySQL Tuner Script

Source: https://github.com/nntmux/newznab-tmux/blob/master/README.md

Download and run MySQLTuner-perl to get tuning recommendations for your database.

```bash
wget https://raw.githubusercontent.com/major/MySQLTuner-perl/master/mysqltuner.pl
perl mysqltuner.pl
```

--------------------------------

### Add MariaDB repository for Ubuntu 24.04

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

Installs required packages and adds the MariaDB signing key for the official repository.

```bash
sudo apt install -y apt-transport-https curl
sudo mkdir -p /etc/apt/keyrings
sudo curl -o /etc/apt/keyrings/mariadb-keyring.pgp 'https://mariadb.org/mariadb_release_signing_key.pgp'
```

--------------------------------

### GET /capabilities

Source: https://github.com/nntmux/newznab-tmux/blob/master/docs/nntmux_api_v2.md

Retrieves server capabilities and supported features.

```APIDOC
## GET /capabilities

### Description
Retrieves server capabilities and supported features.

### Method
GET

### Endpoint
/capabilities

### Parameters
None

### Response
#### Success Response (200)
- **server** (object) - Server information
- **limits** (object) - API limits
- **searching** (object) - Search capabilities
- **registration** (object) - Registration settings
- **categories** (object) - Category list
- **groups** (object) - Group list
- **genres** (object) - Genre list

#### Response Example
{
  "server": {},
  "limits": {},
  "searching": {},
  "registration": {},
  "categories": {},
  "groups": {},
  "genres": {}
}
```

--------------------------------

### Small installation MariaDB configuration (16GB RAM, <1M releases)

Source: https://github.com/nntmux/newznab-tmux/wiki/Database-Tuning

Use this configuration for small NNTmux installations with less than 1 million releases and 16GB of RAM. It sets InnoDB buffer pool to 8G, disables query cache, and enables slow query logging.

```ini
[mysqld]
# InnoDB Settings
innodb_buffer_pool_size = 8G
innodb_buffer_pool_instances = 8
innodb_log_file_size = 512M
innodb_log_buffer_size = 64M
innodb_flush_log_at_trx_commit = 2
innodb_flush_method = O_DIRECT
innodb_file_per_table = 1
innodb_io_capacity = 2000
innodb_io_capacity_max = 4000

# Query Cache (disable for MariaDB 10.2+)
query_cache_type = 0
query_cache_size = 0

# Connections
max_connections = 200
thread_cache_size = 50

# Temp Tables
tmp_table_size = 256M
max_heap_table_size = 256M

# Buffer Sizes
join_buffer_size = 4M
sort_buffer_size = 4M
read_buffer_size = 2M
read_rnd_buffer_size = 4M

# Table Cache
table_open_cache = 4000
table_definition_cache = 2000

# Logging
slow_query_log = 1
slow_query_log_file = /var/log/mysql/slow.log
long_query_time = 2
```

--------------------------------

### Start and stop nntmux processing

Source: https://github.com/nntmux/newznab-tmux/blob/master/README.md

Starts or stops the nntmux processing services (Horizon, scheduler, renewal timer, backup timer). Start enables reboot recovery; stop disables it. The tmux session belongs to user nntmux and is named nntmux.

```bash
python3 deploy/baremetal/deploy.py processing-start --host indexer --inventory /secure/hosts.yml
python3 deploy/baremetal/deploy.py processing-stop --host indexer --inventory /secure/hosts.yml
```

--------------------------------

### PHP Extension Missing - Install Common Extensions

Source: https://github.com/nntmux/newznab-tmux/wiki/Troubleshooting

When an extension is missing, install common PHP 8.3 extensions via apt and verify with php -m.

```bash
# Install common extensions
sudo apt install php8.3-{curl,mbstring,xml,zip,gd,intl,pcntl,mysql}

# Verify
php -m | grep -i extension_name
```

--------------------------------

### Start IRC scraper manually

Source: https://github.com/nntmux/newznab-tmux/wiki/IRC-Pre-Channels

Starts the IRC scraper manually and tests the connection without scraping. Use these commands when you need to run the scraper outside of tmux or verify connectivity.

```bash
# Start IRC scraper
php artisan nntmux:irc

# Test connection without scraping
php artisan nntmux:irc-test
```

--------------------------------

### GET /getnzb

Source: https://github.com/nntmux/newznab-tmux/blob/master/docs/nntmux_api_v2.md

Retrieves an NZB file by GUID. Redirects to a download URL with the API token.

```APIDOC
## GET /getnzb

### Description
Retrieves an NZB file by GUID. Redirects to a download URL with the API token.

### Method
GET

### Endpoint
/getnzb

### Parameters
#### Query Parameters
- **id** (string) - Required - GUID of the NZB
- **del** (string) - Optional - If set to 1, deletes the NZB after retrieval

### Response
#### Success Response (302)
- **Location** (header) - Redirect URL with API token

#### Error Response (404)
- **body** (JSON) - Error details

#### Response Example
(No explicit success response body example provided)
```

--------------------------------

### ManticoreSearch configuration file

Source: https://github.com/nntmux/newznab-tmux/wiki/Search-Engines

Example ManticoreSearch configuration file (/etc/manticoresearch/manticore.conf) with MySQL and HTTP listeners, logging, memory, and threading settings.

```conf
searchd {
    listen = 127.0.0.1:9306:mysql
    listen = 127.0.0.1:9308:http
    
    log = /var/log/manticore/searchd.log
    query_log = /var/log/manticore/query.log
    pid_file = /run/manticore/searchd.pid
    
    # Memory settings
    rt_mem_limit = 512M
    
    # Query settings
    max_packet_size = 128M
    
    # Threading
    workers = threads
    binlog_path = /var/lib/manticore/binlog
}
```

--------------------------------

### Movie Processing Commands Usage

Source: https://github.com/nntmux/newznab-tmux/wiki/Console-Commands

Examples of commands for movie processing: fetching movie data by IMDb ID, processing adult releases, and post-processing by GUID.

```bash
# Fetch movie data for specific IMDb ID
php artisan nntmux:fetch-movie --imdb=tt1234567

# Process adult releases
php artisan nntmux:process-adult

# Post process by GUID
php artisan postprocess:guid
```

--------------------------------

### Large installation MariaDB configuration (64GB+ RAM, 10M+ releases)

Source: https://github.com/nntmux/newznab-tmux/wiki/Database-Tuning

Use this configuration for large NNTmux installations with 10 million or more releases and 64GB or more of RAM. It sets InnoDB buffer pool to 48G, enables slow query logging, and increases various buffer and cache sizes.

```ini
[mysqld]
# InnoDB Settings
innodb_buffer_pool_size = 48G
innodb_buffer_pool_instances = 32
innodb_log_file_size = 2G
innodb_log_buffer_size = 256M
innodb_flush_log_at_trx_commit = 2
innodb_flush_method = O_DIRECT
innodb_file_per_table = 1
innodb_io_capacity = 8000
innodb_io_capacity_max = 16000
innodb_read_io_threads = 16
innodb_write_io_threads = 16
innodb_purge_threads = 4

# Query Cache
query_cache_type = 0
query_cache_size = 0

# Connections
max_connections = 800
thread_cache_size = 200

# Temp Tables
tmp_table_size = 1G
max_heap_table_size = 1G

# Buffer Sizes
join_buffer_size = 16M
sort_buffer_size = 16M
read_buffer_size = 8M
read_rnd_buffer_size = 16M

# Table Cache
table_open_cache = 16000
table_definition_cache = 8000

# Logging
slow_query_log = 1
slow_query_log_file = /var/log/mysql/slow.log
long_query_time = 0.5
```

--------------------------------

### Create and enable systemd service for IRC scraper

Source: https://github.com/nntmux/newznab-tmux/wiki/IRC-Pre-Channels

Creates a systemd service for persistent IRC scraping. The service runs as www-data, restarts on failure, and is enabled and started with systemctl commands.

```ini
# /etc/systemd/system/nntmux-irc.service
[Unit]
Description=NNTmux IRC Pre Scraper
After=network.target

[Service]
Type=simple
User=www-data
WorkingDirectory=/var/www/nntmux
ExecStart=/usr/bin/php artisan nntmux:irc
Restart=always
RestartSec=10

[Install]
WantedBy=multi-user.target
```

```bash
sudo systemctl enable nntmux-irc
sudo systemctl start nntmux-irc
```

--------------------------------

### Rebuild assets and fix permissions

Source: https://github.com/nntmux/newznab-tmux/wiki/Troubleshooting

Commands to install npm dependencies, build assets, and fix permissions on the public/build directory to resolve CSS/JS not loading.

```bash
# Rebuild assets
npm install
npm run build

# Check permissions
chmod -R 755 public/build
```

--------------------------------

### Query predb.ovh API

Source: https://github.com/nntmux/newznab-tmux/wiki/IRC-Pre-Channels

Example API call to predb.ovh to search for a release by name. The API is recommended and provides RSS feeds, SQL dumps, and SphinxSearch.

```bash
curl "https://predb.ovh/api/v1/?q=release.name"
```

--------------------------------

### GET /capabilities

Source: https://github.com/nntmux/newznab-tmux/blob/master/docs/nntmux_api_v2.md

Public endpoint that returns API capabilities. No authentication required.

```APIDOC
## GET /capabilities

### Description
Public endpoint that returns API capabilities. No authentication required.

### Method
GET

### Endpoint
/capabilities

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- No documented response fields.

#### Response Example
No documented response body.
```

--------------------------------

### Cache Configuration, Routes, and Views for Production

Source: https://github.com/nntmux/newznab-tmux/wiki/Configuration

Use these commands in production to cache configuration, routes, and views for improved performance.

```bash
php artisan config:cache
php artisan route:cache
php artisan view:cache
```

--------------------------------

### Quarantine binlog files

Source: https://github.com/nntmux/newznab-tmux/blob/master/docs/manticore-ubuntu-package.md

Move binlog files to a quarantine directory to allow Manticore to start from flushed table data while preserving files for analysis.

```bash
stamp=$(date +%Y%m%d-%H%M%S)
sudo install -d -m 0755 /var/lib/manticore/binlog-quarantine-$stamp
sudo find /var/lib/manticore/data -maxdepth 1 -type f \
  \( -name 'binlog*' -o -name '*.binlog*' \) \
  -exec mv -t /var/lib/manticore/binlog-quarantine-$stamp {} +

sudo systemctl start manticore
sudo systemctl status manticore --no-pager
sudo journalctl -u manticore -n 100 --no-pager
sudo dpkg --configure -a
```

--------------------------------

### php artisan postprocess:guid

Source: https://github.com/nntmux/newznab-tmux/wiki/TV-Movie-Processing

Post process releases by GUID character. This command is used to run general postprocessing on releases identified by their GUID.

```APIDOC
## [CLI] php artisan postprocess:guid

### Description
Post process releases by GUID character.

### Method
CLI

### Endpoint
`php artisan postprocess:guid`

### Parameters
None documented.

### Request Example
```bash
php artisan postprocess:guid
```

### Response
#### Success Response
No explicit response documented.

```

--------------------------------

### Configure Supervisor for Laravel Horizon

Source: https://github.com/nntmux/newznab-tmux/wiki/Laravel-Horizon

Supervisor configuration file (laravel-horizon.conf) that starts and monitors the Horizon process. Adjust the 'user' and 'command' paths as needed.

```ini
[program:laravel-horizon]
process_name=%(program_name)s
command=php /var/www/NNTmux/artisan horizon
autostart=true
autorestart=true
user=your user here
redirect_stderr=true
stdout_logfile=/var/www/NNTmux/storage/logs/horizon.log
```

--------------------------------

### MariaBackup Full Backup, Prepare, and Restore

Source: https://github.com/nntmux/newznab-tmux/wiki/Database-Tuning

These commands perform a hot full backup with MariaBackup, prepare it for restore, and then restore it. The restore process stops MariaDB, clears the data directory, copies back the backup, fixes permissions, and restarts the service.

```bash
# Full backup (hot, no locking)
mariabackup --backup --target-dir=/backup/full \
    --user=root --password=yourpass

# Prepare backup
mariabackup --prepare --target-dir=/backup/full

# Restore
systemctl stop mariadb
rm -rf /var/lib/mysql/*
mariabackup --copy-back --target-dir=/backup/full
chown -R mysql:mysql /var/lib/mysql
systemctl start mariadb
```

--------------------------------

### Create MariaDB repository configuration

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

Creates the /etc/apt/sources.list.d/mariadb.sources file with the MariaDB 11.4 repository for Ubuntu 24.04 (noble). Change 'noble' to 'jammy' for Ubuntu 22.04.

```bash
sudo tee /etc/apt/sources.list.d/mariadb.sources <<EOF
# MariaDB 11.4 repository
X-Repolib-Name: MariaDB
Types: deb
URIs: https://deb.mariadb.org/11.4/ubuntu
Suites: noble
Components: main main/debug
Signed-By: /etc/apt/keyrings/mariadb-keyring.pgp
EOF
```

--------------------------------

### Dotenv configuration for production secrets

Source: https://github.com/nntmux/newznab-tmux/blob/master/README.md

Populate the Terraform-created Secrets Manager secret outside Terraform with this UTF-8 dotenv string. Start from .env.example, add metadata keys, and use deployment-specific values. Single-quote passwords containing $ or #. Database identity/password changes and APP_KEY rotation are refused by normal release commands.

```dotenv
APP_ENV=production
APP_DEBUG=false
APP_URL=https://indexer.example.com
APP_KEY=base64:REPLACE_WITH_A_GENERATED_32_BYTE_KEY
DB_CONNECTION=mariadb
DB_HOST=mariadb
DB_PORT=3306
DB_DATABASE=nntmux
DB_USERNAME=nntmux
DB_PASSWORD='REPLACE_WITH_APPLICATION_DB_PASSWORD'
DB_ROOTPASSWORD='REPLACE_WITH_SEPARATE_ROOT_PASSWORD'
REDIS_HOST=redis
REDIS_PORT=6379
REDIS_PASSWORD=null
CACHE_STORE=redis
SESSION_DRIVER=redis
QUEUE_CONNECTION=redis
SEARCH_DRIVER=manticore
MANTICORESEARCH_HOST=manticore
MANTICORESEARCH_PORT=9308
MANTICORESEARCH_HOSTS=
TRUSTED_PROXIES=172.30.42.0/24
COVERS_PATH=/app/storage/covers
PATH_TO_NZBS=/app/storage/nzb
TEMP_UNRAR_PATH=/app/storage/tmp/unrar
TEMP_UNZIP_PATH=/app/storage/tmp/unzip
ADMIN_USER=admin
ADMIN_PASS='REPLACE_WITH_AT_LEAST_12_CHARACTERS'
ADMIN_EMAIL=admin@example.com
NNTP_SERVER=news.example.com
NNTP_PORT=563
NNTP_SSLENABLED=true
NNTP_USERNAME='REPLACE_WITH_NNTP_USERNAME'
NNTP_PASSWORD='REPLACE_WITH_NNTP_PASSWORD'
USE_ALTERNATE_NNTP_SERVER=false
```

--------------------------------

### Rebuild caches for production

Source: https://github.com/nntmux/newznab-tmux/wiki/Console-Commands

Runs optimize, config:cache, route:cache, and view:cache to rebuild all caches for production.

```bash
# Rebuild caches for production
php artisan optimize
php artisan config:cache
php artisan route:cache
php artisan view:cache
```

--------------------------------

### Check Headers Exist - SQL Counts

Source: https://github.com/nntmux/newznab-tmux/wiki/Troubleshooting

Query the binaries and parts tables to verify headers have been downloaded.

```sql
SELECT COUNT(*) FROM binaries;
SELECT COUNT(*) FROM parts;
```

--------------------------------

### Composer Install Fails - Update and Retry

Source: https://github.com/nntmux/newznab-tmux/wiki/Troubleshooting

When Composer reports that requirements cannot be resolved, update Composer, clear its cache, and retry the install without cache.

```bash
# Update composer
composer self-update

# Clear cache and retry
composer clear-cache
composer install --no-cache
```

--------------------------------

### Frontend build commands

Source: https://github.com/nntmux/newznab-tmux/blob/master/AGENTS.md

Run these commands if frontend changes are not reflected in the UI. Ask the user which one they need.

```bash
npm run build
```

```bash
npm run dev
```

```bash
composer run dev
```

--------------------------------

### Start tmux processing

Source: https://github.com/nntmux/newznab-tmux/wiki/IRC-Pre-Channels

Starts tmux processing, which automatically runs the IRC scraper. Enable or disable this behavior in the admin panel under Tmux Settings.

```bash
php artisan tmux:start
```

--------------------------------

### Run database migrations

Source: https://github.com/nntmux/newznab-tmux/blob/master/README.md

Runs the database migrations using Artisan. This sets up the database schema after the .env file is configured.

```bash
php artisan migrate
```

--------------------------------

### File Paths Configuration (.env)

Source: https://github.com/nntmux/newznab-tmux/wiki/Configuration

Paths to external binaries (unrar, 7z, ffmpeg, mediainfo) and storage paths for NZB files and cover images.

```env
# Path to unrar binary
UNRAR_PATH=/usr/bin/unrar

# Path to 7zip binary
SEVENZIP_PATH=/usr/bin/7z

# Path to ffmpeg binary
FFMPEG_PATH=/usr/bin/ffmpeg

# Path to mediainfo binary
MEDIAINFO_PATH=/usr/bin/mediainfo

# NZB storage path
NZB_PATH=/var/www/nntmux/resources/nzb

# Cover images path
COVERS_PATH=/var/www/nntmux/public/covers
```

--------------------------------

### Check public/build directory

Source: https://github.com/nntmux/newznab-tmux/wiki/Troubleshooting

Command to list the contents of the public/build directory, used to verify that built assets exist.

```bash
ls -la public/build/
```

--------------------------------

### Create custom MariaDB configuration file

Source: https://github.com/nntmux/newznab-tmux/wiki/Database-Tuning

Use this command to create a custom MariaDB configuration file for NNTmux database tuning. It opens the file in the nano editor for editing.

```bash
sudo nano /etc/mysql/mariadb.conf.d/99-nntmux.cnf
```

--------------------------------

### Test API keys (nntmux:test-apis)

Source: https://github.com/nntmux/newznab-tmux/wiki/Troubleshooting

Run the artisan command to verify API keys are valid.

```bash
php artisan nntmux:test-apis
```

--------------------------------

### Initialize and release via AWS Systems Manager send-command

Source: https://github.com/nntmux/newznab-tmux/blob/master/README.md

Run this command after EC2 cloud-init finishes to initialize the volume and deploy the application. The instance must have outbound access to AWS APIs, image registries, NNTP, and enabled metadata services. DNS must resolve to the Elastic IP before Caddy can obtain its certificate.

```bash
aws ssm send-command --region REGION --instance-ids INSTANCE_ID \
  --document-name AWS-RunShellScript \
  --parameters '{"commands":["/opt/nntmux/volume.sh initialize","systemctl start nntmux-data.service","systemctl restart docker.service","/opt/nntmux/deploy.sh initialize sha256:REPLACE_WITH_64_HEX_DIGITS","systemctl start nntmux.service"]}'
```

--------------------------------

### Create NNTmux database and user

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

SQL statements to create the nntmux database, user, and grant privileges. Replace 'YourPassword' with a strong password.

```sql
-- Create database
CREATE DATABASE nntmux CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

-- Create user (replace 'YourPassword' with a strong password)
CREATE USER 'nntmux'@'localhost' IDENTIFIED BY 'YourPassword';

-- Grant privileges
GRANT ALL PRIVILEGES ON nntmux.* TO 'nntmux'@'localhost';
FLUSH PRIVILEGES;

-- Exit
EXIT;
```

--------------------------------

### GET /anime

Source: https://github.com/nntmux/newznab-tmux/blob/master/docs/nntmux_api_v2.md

Searches for anime using one or more identifiers.

```APIDOC
## GET /anime

### Description
Searches for anime using one or more identifiers.

### Method
GET

### Endpoint
/anime

### Parameters
#### Query Parameters
- **id** (string) - Optional - Anime identifier
- **anidbid** (string) - Optional - AniDB identifier
- **anilistid** (string) - Optional - AniList identifier

### Response
#### Success Response (200)
(No explicit response body example provided)
```

--------------------------------

### Connect to MariaDB as root

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

Connects to the MariaDB server as the root user to create the database and user.

```bash
sudo mysql -u root -p
```

--------------------------------

### GET /books

Source: https://github.com/nntmux/newznab-tmux/blob/master/docs/nntmux_api_v2.md

Searches for books using a required identifier.

```APIDOC
## GET /books

### Description
Searches for books using a required identifier.

### Method
GET

### Endpoint
/books

### Parameters
#### Query Parameters
- **id** (string) - Required - Book identifier

### Response
#### Success Response (200)
(No explicit response body example provided)
```

--------------------------------

### Find MariaDB configuration file location

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

Displays the default options and configuration file paths used by MariaDB.

```bash
mysqld -v --help | grep -A 1 'Default options'
```

--------------------------------

### GET /audio

Source: https://github.com/nntmux/newznab-tmux/blob/master/docs/nntmux_api_v2.md

Searches for audio content using a required identifier.

```APIDOC
## GET /audio

### Description
Searches for audio content using a required identifier.

### Method
GET

### Endpoint
/audio

### Parameters
#### Query Parameters
- **id** (string) - Required - Audio identifier

### Response
#### Success Response (200)
(No explicit response body example provided)
```

--------------------------------

### Monitor queries with SHOW PROCESSLIST

Source: https://github.com/nntmux/newznab-tmux/wiki/Troubleshooting

SQL command to show the current database processes, useful for monitoring active queries and identifying slow ones.

```sql
SHOW PROCESSLIST;
```

--------------------------------

### GET /movies

Source: https://github.com/nntmux/newznab-tmux/blob/master/docs/nntmux_api_v2.md

Searches for movies using various identifiers and optional filters.

```APIDOC
## GET /movies

### Description
Searches for movies using various identifiers and optional filters.

### Method
GET

### Endpoint
/movies

### Parameters
#### Query Parameters
- **imdbid** (string) - Optional - IMDb identifier
- **tmdbid** (string) - Optional - TMDb identifier
- **traktid** (string) - Optional - Trakt identifier
- **id** (string) - Optional - Generic identifier
- **cat** (string) - Optional - Category filter
- **maxage** (string) - Optional - Maximum age filter
- **minsize** (string) - Optional - Minimum size filter
- **sort** (string) - Optional - Sort order
- **offset** (string) - Optional - Pagination offset
- **limit** (string) - Optional - Number of results

### Response
#### Success Response (200)
(No explicit response body example provided)
```

--------------------------------

### IRC Pre-Scraping Configuration (.env)

Source: https://github.com/nntmux/newznab-tmux/wiki/Configuration

Settings for scraping release information from IRC pre-channels. SCRAPE_IRC_ENABLED must be true. Includes server, port, TLS, username, optional password, realname, and channels.

```env
SCRAPE_IRC_ENABLED=true
SCRAPE_IRC_SERVER=irc.synirc.net
SCRAPE_IRC_PORT=6697
SCRAPE_IRC_TLS=true
SCRAPE_IRC_USERNAME=YourUniqueNickname
SCRAPE_IRC_PASSWORD=                  # Optional, for registered nicks
SCRAPE_IRC_REALNAME=Your Name
SCRAPE_IRC_CHANNELS=#PreNNTmux,#nZEDbPRE
```

--------------------------------

### Processing control commands

Source: https://github.com/nntmux/newznab-tmux/wiki/Home

Commands to start, stop, or attach to the tmux processing sessions.

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

--------------------------------

### Build RapidYenc library

Source: https://github.com/nntmux/newznab-tmux/wiki/RapidYenc

Runs the build script from the NNTmux checkout root. No arguments are needed; paths are resolved relative to the script's checkout. The script pins an upstream commit, verifies the archive checksum, builds a Release library, and atomically replaces the existing .so only after successful compilation.

```bash
./scripts/build-rapidyenc.sh
```

--------------------------------

### Import pre data from predb.ovh dump

Source: https://github.com/nntmux/newznab-tmux/wiki/IRC-Pre-Channels

Downloads the latest predb.ovh SQL dump, decompresses it, and imports it using the artisan command. The dump is a CSV file.

```bash
# Download latest dump
wget https://predb.ovh/download/predb_dump.csv.gz
gunzip predb_dump.csv.gz

# Import
php artisan nntmux:import-predb --file=predb_dump.csv
```
Tokens:
Raw