sbcrumb/nfoguard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Complete TV webhook processing modes documentation update

Browse Source 
📚 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:
SBCrumb
2025-09-11 11:26:39 -04:00
parent ac2753509d
commit 86d2cee1f9
4 changed files with 68 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
TESTING.md
+24
View File
@@ -140,6 +140,30 @@ curl -X POST "http://localhost:8080/tv/scan-episode" \
# Verify enhanced NFO was created with metadata
find /media/TV/tv -name "S01E*.nfo" | head -1 | xargs cat
# Should show: <title>, <plot>, <rating>, <runtime>, timestamps
# Test TV webhook processing modes
export TV_WEBHOOK_PROCESSING_MODE=targeted # or series
# Download episode in Sonarr and check logs for processing mode
```
### Step 7: Test TV Webhook Processing Modes (v0.6.0+)
```bash
# Test targeted mode (default - processes only webhook episodes)
echo "TV_WEBHOOK_PROCESSING_MODE=targeted" >> .env
docker restart nfoguard
# Download single episode in Sonarr, check logs should show:
# "Using targeted episode processing for 1 episodes"
# "Completed targeted processing: 1/1 episodes processed"
# Test series mode (processes entire series)
echo "TV_WEBHOOK_PROCESSING_MODE=series" >> .env
docker restart nfoguard
# Download single episode in Sonarr, check logs should show:
# "Using series processing mode (fallback or configured)"
# "Processing TV series: Show Name"
# "Found X episodes on disk"
```
## 🛠 Why These Tests Are Needed