-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome to the comprehensive documentation for RemoveSamples-NZBGet, a modern NZBGet extension for intelligent sample file detection and removal.
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.
- Installation Guide - Step-by-step installation for all platforms (Docker, Unraid, Linux, Windows, macOS)
- Configuration Reference - Complete settings documentation with examples and best practices
- Testing Guide - Comprehensive testing procedures to verify functionality across different platforms
- Workflow Integration - Integration with Sonarr/Radarr/Lidarr and optimal script ordering
- Detection Logic - Technical details of how sample detection algorithms work
- Comparison with DeleteSamples - Why RemoveSamples is superior to the legacy DeleteSamples.py script
- Troubleshooting Guide - Solutions to common issues across all platforms and environments
- FAQ - Frequently asked questions with detailed answers
- Contributing - Development guidelines, testing procedures, and how to contribute to the project
- 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
- Dropdown configuration - No more editing configuration files
- Real-time feedback - Clear status messages and logging
- Professional integration - Seamless NZBGet experience
- Comprehensive testing - Full test coverage with automated CI/CD
- Error handling - Graceful handling of edge cases
- Performance optimized - Minimal impact on your system
| 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 |
Extension Settings → RemoveSamples
├── Remove Directories: Yes
├── Remove Files: Yes
├── Debug: No
├── Video Size Threshold: 150 MB
└── Audio Size Threshold: 2 MB
Movie.Name.2023.sample.mkvsample.mp4preview_sample.avi-
samples/directory - Video files under size threshold
-
Movie.Name.2023.1080p.mkv(normal size) -
soundtrack.mp3(no sample pattern) -
behind-the-scenes.mp4(above threshold)
RemoveSamples includes comprehensive testing procedures for all platforms:
- Linux Testing - Ubuntu, Debian, CentOS, RHEL
- Docker Testing - LinuxServer, Official containers
- Unraid Testing - Complete Unraid procedures
- Windows Testing - Native and PowerShell
- macOS Testing - Homebrew and manual installations
# 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 procedureRemoveSamples 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
🎉 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:
- Settings → Extension Manager
- Find "RemoveSamples"
- Click Install
- 🐛 Bug Reports: GitHub Issues
- 💬 Discussions: GitHub Discussions
- 🔒 Security Issues: anunnaki.astronaut@machinamindmeld.com
- 📖 Documentation: You're here!
New to RemoveSamples? Start here:
- Installation Guide → Set up the extension
- Configuration Reference → Configure settings
- Testing Guide → Verify it works
- Workflow Integration → Integrate with your setup
Having issues?
- Troubleshooting Guide → Solve common problems
- FAQ → Quick answers to frequent questions
Want to contribute?
- Contributing → Development guidelines and how to help
Technical details:
- Detection Logic → How the algorithms work
- Comparison with DeleteSamples → Technical comparison with legacy solutions
Ready to get started? → Installation Guide
Questions? → FAQ | GitHub Discussions