Skip to content

Home

Jump to bottom
dnzbk edited this page Jul 9, 2025 · 2 revisions

RemoveSamples-NZBGet Wiki

Welcome to the comprehensive documentation for RemoveSamples-NZBGet, a modern NZBGet extension for intelligent sample file detection and removal.

🎯 Overview

RemoveSamples is a next-generation NZBGet extension that automatically detects and removes sample files and directories before your media managers (Sonarr/Radarr/Lidarr/Prowlarr) process the downloads. Built with modern development practices, it replaces older solutions with advanced detection algorithms and user-friendly configuration.

📖 Complete Documentation

🚀 Getting Started

  1. Installation Guide - Step-by-step installation for all platforms (Docker, Unraid, Linux, Windows, macOS)
  2. Configuration Reference - Complete settings documentation with examples and best practices
  3. Testing Guide - Comprehensive testing procedures to verify functionality across different platforms
  4. Workflow Integration - Integration with Sonarr/Radarr/Lidarr and optimal script ordering

🔍 Understanding RemoveSamples

  1. Detection Logic - Technical details of how sample detection algorithms work
  2. Comparison with DeleteSamples - Why RemoveSamples is superior to the legacy DeleteSamples.py script

🛠️ Troubleshooting & Support

  1. Troubleshooting Guide - Solutions to common issues across all platforms and environments
  2. FAQ - Frequently asked questions with detailed answers

🤝 Community & Development

  1. Contributing - Development guidelines, testing procedures, and how to contribute to the project

✨ Key Features

Smart Detection

  • Pattern-based identification - Multiple filename patterns for comprehensive detection
  • Size-based filtering - Configurable thresholds for video and audio files
  • Directory cleanup - Removes entire sample directories

Modern Interface

  • Dropdown configuration - No more editing configuration files
  • Real-time feedback - Clear status messages and logging
  • Professional integration - Seamless NZBGet experience

Robust & Reliable

  • Comprehensive testing - Full test coverage with automated CI/CD
  • Error handling - Graceful handling of edge cases
  • Performance optimized - Minimal impact on your system

🆚 Why Choose RemoveSamples?

vs DeleteSamples.py (Legacy Script)

Feature DeleteSamples.py RemoveSamples
Configuration Manual file editing Modern dropdown interface
Directory Removal ❌ No ✅ Yes
Extension Format ❌ Legacy script ✅ Modern NZBGet extension
Pattern Detection ❌ Basic ✅ Advanced multi-pattern
Audio Support ❌ Limited ✅ Full configurable support
Testing ❌ None ✅ Comprehensive test suite
Maintenance ❌ Abandoned ✅ Active development

See detailed comparison →

🔧 Quick Configuration

Extension Settings → RemoveSamples
├── Remove Directories: Yes
├── Remove Files: Yes  
├── Debug: No
├── Video Size Threshold: 150 MB
└── Audio Size Threshold: 2 MB

📊 Sample Detection Examples

✅ Will Be Removed

  • Movie.Name.2023.sample.mkv
  • sample.mp4
  • preview_sample.avi
  • samples/ directory
  • Video files under size threshold

❌ Will Be Preserved

  • Movie.Name.2023.1080p.mkv (normal size)
  • soundtrack.mp3 (no sample pattern)
  • behind-the-scenes.mp4 (above threshold)

🧪 Testing Your Installation

RemoveSamples includes comprehensive testing procedures for all platforms:

Platform-Specific Testing

Quick Test Command

# Create test files and verify RemoveSamples works
cd /tmp && mkdir test && cd test
echo "content" > movie.sample.mkv && echo "content" > movie.1080p.mkv
# Run RemoveSamples test - see Testing Guide for complete procedure

Complete Testing Guide →

🛡️ Security & Quality

RemoveSamples is built with enterprise-grade practices:

  • Automated security scanning with CodeQL
  • Dependency vulnerability monitoring with Dependabot
  • Comprehensive test coverage with automated CI/CD
  • Professional code review workflow

🏆 Official Recognition

🎉 RemoveSamples has been officially adopted by the NZBGet team!

The extension is now available through the official NZBGet Extension Manager, making installation as simple as:

  1. Settings → Extension Manager
  2. Find "RemoveSamples"
  3. Click Install

📞 Support

📋 Documentation Navigation

New to RemoveSamples? Start here:

  1. Installation Guide → Set up the extension
  2. Configuration Reference → Configure settings
  3. Testing Guide → Verify it works
  4. Workflow Integration → Integrate with your setup

Having issues?

Want to contribute?

Technical details:

Ready to get started? → Installation Guide
Questions? → FAQ | GitHub Discussions

Clone this wiki locally