Complete TV webhook processing modes documentation update

📚 Comprehensive Documentation Update:
• Added TV webhook processing modes section to README.md
• Updated CHANGELOG.md with configurable processing feature details
• Enhanced SETUP.md with TV_WEBHOOK_PROCESSING_MODE configuration
• Added Step 7 testing procedures to TESTING.md for both modes

🔧 Configuration Documentation:
• Targeted Mode (default): Only process episodes mentioned in webhook
• Series Mode: Process entire series directory (legacy behavior)
• Smart fallback logic when episode data unavailable
• Clear examples and use case recommendations

📋 Testing Instructions:
• Step-by-step mode switching procedures
• Expected log output examples for each mode
• Environment variable configuration examples
• Docker restart procedures for testing

 User Benefits Documented:
• Efficiency comparison: targeted vs series processing
• File operation reduction for targeted mode
• Media server notification minimization
• Backward compatibility with existing setups
This commit is contained in:
2025-09-11 11:26:39 -04:00
parent ac2753509d
commit 86d2cee1f9
4 changed files with 68 additions and 0 deletions
+36
View File
@@ -521,6 +521,42 @@ NFOGuard now creates **full-featured NFO files** with rich metadata from Sonarr:
- ✅ **Runtime** and **ratings** data
- ✅ **Timestamps** showing when NFOGuard processed the file
- ✅ **Smart URL-safe endpoints** for processing individual seasons/episodes
- ✅ **Configurable processing modes** for webhook efficiency
## ⚙️ TV Webhook Processing Modes (v0.6.0+)
NFOGuard offers two processing modes for TV show webhooks:
### **Targeted Mode** (Default - `targeted`)
**Best for**: Efficient processing, minimal file operations
```bash
TV_WEBHOOK_PROCESSING_MODE=targeted
```
**Behavior**: Only processes episodes mentioned in the webhook
- ✅ **1 episode downloaded** → **1 episode processed**
- ✅ **Minimal file operations** - only touches new episode
- ✅ **Reduced notifications** to media servers
- ✅ **Faster processing** for single episode downloads
**Example**: Download S41E07 → Only S41E07.nfo gets updated
### **Series Mode** (`series`)
**Best for**: Comprehensive updates, database synchronization
```bash
TV_WEBHOOK_PROCESSING_MODE=series
```
**Behavior**: Processes entire TV series directory
- 📺 **1 episode downloaded****All series episodes processed**
- 🔄 **Complete sync** - ensures all episodes stay current
- 📋 **Database consistency** - all episode dates updated
- 🛠️ **Legacy behavior** - matches previous versions
**Example**: Download S41E07 → All 7 episodes in season get updated
### **Smart Fallback**
- If webhook contains no episode data → automatically uses series mode
- If targeted mode fails → falls back to series processing
- Configuration validated at startup with helpful error messages
🔍 Logging & Debugging
# Enable verbose logging