sbcrumb
bd9ce8f48d
Major features and improvements: 🚀 THREE-TIER PERFORMANCE OPTIMIZATION: - Tier 1: NFO file caching (99% faster, instant recovery) - Tier 2: Database caching (90% faster, skip API calls) - Tier 3: Full API processing (normal speed, only when needed) - Extended to both movies AND TV episodes for complete coverage 🌍 INTERNATIONAL RELEASE DATE SUPPORT: - Smart fallback hierarchy: US → English-speaking countries → any country - Handles movies without US release dates (e.g., The Fabric of Christmas 2023) - Prioritizes culturally relevant dates while ensuring comprehensive coverage 🎬 TMDB ID FALLBACK SYSTEM: - Support for movies with TMDB IDs but no IMDb IDs (e.g., For the One 2024) - Tolerant XML parsing handles NFO files with trailing URLs - Extracts premiered dates from existing NFO files as fallback source 📊 ENHANCED DEBUGGING & MONITORING: - Failed movies logged to logs/failed_movies.log for troubleshooting - Comprehensive logging shows which optimization tier is used - Enhanced IMDb/TMDB ID detection with detailed status messages 🔧 DATABASE REBUILD CAPABILITIES: - Instant recovery from existing NFO files without API calls - Perfect for migrations, disaster recovery, and system rebuilds - Maintains performance even with thousands of movies/episodes 💾 SMART CACHING & NFO MANAGEMENT: - NFOGuard fields properly positioned at bottom for Emby plugin compatibility - Database-first optimization eliminates redundant API calls - Intelligent should_query logic prevents unnecessary processing Technical improvements include tolerant XML parsing, three-tier optimization for TV episodes, English-speaking country prioritization, TMDB fallback processing, failed movies debug logging, comprehensive database rebuild support, and performance optimizations eliminating 90%+ processing time on warm systems.
391 lines
11 KiB
Markdown
391 lines
11 KiB
Markdown
# NFOGuard
|
||
|
||
[](https://hub.docker.com/r/sbcrumb/nfoguard)
|
||
[](https://hub.docker.com/r/sbcrumb/nfoguard)
|
||
[](https://hub.docker.com/r/sbcrumb/nfoguard)
|
||
|
||
**Automated NFO file management for Radarr and Sonarr with intelligent date handling**
|
||
|
||
---
|
||
|
||
> **⚠️ ALPHA SOFTWARE NOTICE ⚠️**
|
||
>
|
||
> NFOGuard is currently in **Alpha** stage. While functional, it may have bugs or missing features.
|
||
>
|
||
> **🔌 Emby Plugin Included**: The Emby companion plugin is now bundled directly into the Docker image — no extra steps required.
|
||
>
|
||
> **💬 Community Feedback**: Join our Discord if you’d like to share feedback, test new features early, or discuss improvements with other users:
|
||
>
|
||
> **[Join Discord: https://discord.gg/bbD9Pmtr](https://discord.gg/bbD9Pmtr)**
|
||
>
|
||
> *If the Discord link has expired, please [open an issue](https://github.com/sbcrumb/NFOguard/issues) and we'll provide an updated link.*
|
||
|
||
---
|
||
|
||
NFOGuard automatically updates movie and TV show NFO files with proper release dates and metadata when triggered by Radarr/Sonarr webhooks. It preserves existing metadata while adding clean, accurate date information at the bottom of NFO files.
|
||
|
||
## ✨ Features
|
||
|
||
- 🎬 **Movie & TV Support** - Works with both Radarr and Sonarr
|
||
- 📅 **Smart Date Handling** - Prioritizes digital, physical, and theatrical release dates
|
||
- 🔄 **Webhook Integration** - Triggers automatically on import, upgrade, and rename
|
||
- 🗄️ **Database Integration** - Direct PostgreSQL access for better performance
|
||
- 📝 **NFO Preservation** - Maintains existing metadata, adds fields cleanly at bottom
|
||
- 🔒 **Metadata Locking** - Prevents overwrites with lockdata tags
|
||
- ⚡ **Batch Processing** - Efficient handling of multiple files
|
||
- 🐳 **Docker Ready** - Easy deployment with Docker Compose
|
||
|
||
## 🚀 Quick Start
|
||
|
||
### 1. Download Configuration Files
|
||
|
||
```bash
|
||
wget https://raw.githubusercontent.com/sbcrumb/NFOguard/main/.env.template
|
||
wget https://raw.githubusercontent.com/sbcrumb/NFOguard/main/.env.secrets.template
|
||
wget https://raw.githubusercontent.com/sbcrumb/NFOguard/main/docker-compose.example.yml
|
||
```
|
||
|
||
### 2. Configure Environment
|
||
|
||
```bash
|
||
# Copy and edit main configuration
|
||
cp .env.template .env
|
||
nano .env
|
||
|
||
# Copy and edit secrets (API keys, passwords)
|
||
cp .env.secrets.template .env.secrets
|
||
nano .env.secrets
|
||
chmod 600 .env.secrets
|
||
|
||
# Copy and edit Docker Compose
|
||
cp docker-compose.example.yml docker-compose.yml
|
||
nano docker-compose.yml
|
||
```
|
||
|
||
### 3. Deploy
|
||
|
||
```bash
|
||
# Create data directory
|
||
mkdir -p ./data
|
||
|
||
# Start NFOGuard
|
||
docker-compose up -d
|
||
|
||
# Check logs
|
||
docker-compose logs -f nfoguard
|
||
|
||
# Verify health
|
||
curl http://localhost:8080/health
|
||
```
|
||
|
||
## ⚙️ Configuration
|
||
|
||
### Environment Files
|
||
|
||
| File | Purpose | Contains |
|
||
|------|---------|----------|
|
||
| `.env` | Main configuration | Paths, behavior settings, non-sensitive options |
|
||
| `.env.secrets` | Sensitive data | API keys, passwords, database credentials |
|
||
|
||
### Key Configuration Options
|
||
|
||
**Media Paths** (Required):
|
||
```bash
|
||
# Container paths (what NFOGuard sees)
|
||
MOVIE_PATHS=/media/Movies/movies,/media/Movies/movies6
|
||
TV_PATHS=/media/TV/tv,/media/TV/tv6
|
||
|
||
# *arr application paths (what your apps see)
|
||
RADARR_ROOT_FOLDERS=/mnt/unionfs/Media/Movies/movies
|
||
SONARR_ROOT_FOLDERS=/mnt/unionfs/Media/TV/tv
|
||
```
|
||
|
||
**Release Date Priority**:
|
||
```bash
|
||
RELEASE_DATE_PRIORITY=digital,physical,theatrical
|
||
```
|
||
|
||
**Debug Mode**:
|
||
```bash
|
||
DEBUG=false # Clean production logs
|
||
SUPPRESS_TVDB_WARNINGS=true # Hide non-critical API failures
|
||
```
|
||
|
||
## 🐳 Docker Images
|
||
|
||
### Production (Stable)
|
||
```yaml
|
||
image: sbcrumb/nfoguard:latest
|
||
```
|
||
|
||
### Development (Latest Features)
|
||
```yaml
|
||
image: sbcrumb/nfoguard:dev
|
||
```
|
||
|
||
### Specific Version
|
||
```yaml
|
||
image: sbcrumb/nfoguard:v1.5.5
|
||
```
|
||
|
||
## 🔗 Webhook Setup
|
||
|
||
Configure these webhook URLs in your applications:
|
||
|
||
**Radarr**: `http://nfoguard:8080/webhook/radarr`
|
||
**Sonarr**: `http://nfoguard:8080/webhook/sonarr`
|
||
|
||
**Triggers**: On Import, On Upgrade, On Rename
|
||
|
||
## 🔄 Manual Operations
|
||
|
||
### Manual Scanning
|
||
|
||
Trigger manual scans via API endpoints:
|
||
|
||
```bash
|
||
# Manual scan all media (movies and TV)
|
||
curl -X POST "http://localhost:8080/manual/scan?scan_type=both"
|
||
|
||
# Manual scan TV only
|
||
curl -X POST "http://localhost:8080/manual/scan?scan_type=tv"
|
||
|
||
# Manual scan movies only
|
||
curl -X POST "http://localhost:8080/manual/scan?scan_type=movies"
|
||
|
||
# Manual scan specific path
|
||
curl -X POST "http://localhost:8080/manual/scan?path=/media/movies"
|
||
|
||
# Bulk update all movies from Radarr database
|
||
curl -X POST "http://localhost:8080/bulk/update"
|
||
```
|
||
|
||
### API Endpoints
|
||
|
||
| Endpoint | Method | Purpose |
|
||
|----------|--------|---------|
|
||
| `/health` | GET | Health check |
|
||
| `/webhook/radarr` | POST | Radarr webhook handler |
|
||
| `/webhook/sonarr` | POST | Sonarr webhook handler |
|
||
| `/manual/scan` | POST | Manual media scanning |
|
||
| `/bulk/update` | POST | Bulk movie updates from Radarr DB |
|
||
|
||
### Manual Scan Parameters
|
||
|
||
- `scan_type`: `both`, `movies`, `tv`
|
||
- `path`: Specific directory path to scan
|
||
- Use for initial setup or fixing existing media
|
||
|
||
## 📁 Volume Mapping
|
||
|
||
Critical: Update `docker-compose.yml` with your actual paths:
|
||
|
||
```yaml
|
||
volumes:
|
||
- ./data:/app/data # NFOGuard data
|
||
- /your/movies/path:/media/Movies/movies:rw # Movie library
|
||
- /your/tv/path:/media/TV/tv:rw # TV library
|
||
```
|
||
|
||
### Common Examples
|
||
|
||
**Unraid**:
|
||
```yaml
|
||
- /mnt/user/Media/Movies:/media/Movies/movies:rw
|
||
- /mnt/user/Media/TV:/media/TV/tv:rw
|
||
```
|
||
|
||
**Synology**:
|
||
```yaml
|
||
- /volume1/Media/Movies:/media/Movies/movies:rw
|
||
- /volume1/Media/TV:/media/TV/tv:rw
|
||
```
|
||
|
||
**Standard Linux**:
|
||
```yaml
|
||
- /home/user/media/movies:/media/Movies/movies:rw
|
||
- /home/user/media/tv:/media/TV/tv:rw
|
||
```
|
||
|
||
## 🔧 Troubleshooting
|
||
|
||
### Check Logs
|
||
```bash
|
||
docker-compose logs -f nfoguard
|
||
```
|
||
|
||
### Enable Debug Mode
|
||
```bash
|
||
# In .env file
|
||
DEBUG=true
|
||
PATH_DEBUG=true
|
||
```
|
||
|
||
### Health Check
|
||
```bash
|
||
curl http://localhost:8080/health
|
||
```
|
||
|
||
### Common Issues
|
||
|
||
1. **Permission Errors**: Ensure NFOGuard can write to mounted directories
|
||
2. **Path Mapping**: Verify container paths match `.env` configuration
|
||
3. **Webhooks**: Check URLs and ensure port 8080 is accessible
|
||
4. **Database**: Verify PostgreSQL credentials in `.env.secrets`
|
||
|
||
## 📊 What NFOGuard Does
|
||
|
||
### Before
|
||
```xml
|
||
<movie>
|
||
<title>Movie Title</title>
|
||
<year>2023</year>
|
||
<!-- Existing Radarr metadata -->
|
||
</movie>
|
||
```
|
||
|
||
### After
|
||
```xml
|
||
<movie>
|
||
<title>Movie Title</title>
|
||
<year>2023</year>
|
||
<!-- Existing Radarr metadata preserved -->
|
||
|
||
<!-- NFOGuard additions at bottom -->
|
||
<digital_release_date>2023-03-15</digital_release_date>
|
||
<lockdata>true</lockdata>
|
||
<!-- Manager: NFOGuard -->
|
||
</movie>
|
||
```
|
||
|
||
## 📋 Requirements
|
||
|
||
- Docker and Docker Compose
|
||
- Radarr and/or Sonarr
|
||
- Media files in accessible directories
|
||
- Network connectivity between services
|
||
|
||
## 📁 Directory Structure Requirements
|
||
|
||
NFOGuard identifies movies and TV shows using two methods: directory names with IMDb IDs (primary) or NFO files with IMDb IDs (fallback). Your media should follow these conventions:
|
||
|
||
### 🎬 **Movies**
|
||
|
||
**Directory Structure:**
|
||
```
|
||
/movies/
|
||
└── Movie Title (2024) [tt1234567]/
|
||
├── movie.mkv
|
||
└── movie.nfo (created by NFOGuard)
|
||
```
|
||
|
||
**Identification Methods:**
|
||
1. **Primary**: Directory name contains IMDb ID in brackets: `[tt1234567]` or `[imdb-tt1234567]`
|
||
2. **Fallback**: NFO file with IMDb ID in movie.nfo file (see NFO format below)
|
||
3. **Video file** required: `.mkv`, `.mp4`, `.avi`, `.mov`, `.m4v`
|
||
4. **Case insensitive** - `[TT1234567]` works too
|
||
|
||
**Examples:**
|
||
```
|
||
✅ Action Film (2024) [tt1234567]/
|
||
✅ Drama Movie [imdb-tt7654321]/
|
||
✅ SciFi Thriller (2023) [TT9876543]/
|
||
❌ Missing IMDB Directory/
|
||
```
|
||
|
||
### 📺 **TV Shows**
|
||
|
||
**Directory Structure:**
|
||
```
|
||
/tv/
|
||
└── Series Title (2024) [tt1234567]/
|
||
├── Season 01/
|
||
│ ├── Series S01E01.mkv
|
||
│ ├── Series S01E02.mkv
|
||
│ ├── S01E01.nfo (created by NFOGuard)
|
||
│ └── S01E02.nfo (created by NFOGuard)
|
||
├── Season 02/
|
||
└── tvshow.nfo (created by NFOGuard)
|
||
```
|
||
|
||
**Identification Methods:**
|
||
1. **Primary**: Series directory contains IMDb ID: `[tt1234567]` or `[imdb-tt1234567]`
|
||
2. **Fallback**: NFO file with IMDb ID in tvshow.nfo file (see NFO format below)
|
||
3. **Season directories** must match pattern: `Season 01`, `Season 1`, `season 01` etc.
|
||
4. **Episode files** must contain season/episode info:
|
||
- **SxxExx format**: `S01E01`, `S1E1`, `s01e01`
|
||
- **Dot format**: `1.1`, `01.01`
|
||
5. **Video extensions**: `.mkv`, `.mp4`, `.avi`, `.mov`, `.m4v`, `.ts`, `.m2ts`
|
||
|
||
**Examples:**
|
||
```
|
||
✅ Drama Series (2024) [tt1234567]/
|
||
├── Season 01/
|
||
│ ├── Drama S01E01.mkv
|
||
│ └── Drama S01E02.mkv
|
||
└── Season 02/
|
||
|
||
✅ Comedy Show [tt7654321]/
|
||
└── Season 1/
|
||
├── Comedy 1.1.mkv
|
||
└── Comedy 1.2.mkv
|
||
|
||
❌ Series Without IMDB []/
|
||
❌ Series [tt1234567]/Episode01.mkv (no season directory)
|
||
❌ Series [tt1234567]/Season 1/RandomName.mkv (no episode pattern)
|
||
```
|
||
|
||
### 📄 **NFO File Identification Format**
|
||
|
||
NFOGuard can extract IMDb IDs from existing NFO files using these XML tags:
|
||
|
||
**Movie NFO (movie.nfo):**
|
||
```xml
|
||
<!-- Method 1: uniqueid tag (preferred) -->
|
||
<uniqueid type="imdb">tt1234567</uniqueid>
|
||
|
||
<!-- Method 2: imdbid tag -->
|
||
<imdbid>tt1234567</imdbid>
|
||
|
||
<!-- Method 3: imdb tag -->
|
||
<imdb>tt1234567</imdb>
|
||
```
|
||
|
||
**TV Show NFO (tvshow.nfo):**
|
||
```xml
|
||
<!-- Same format as movies -->
|
||
<uniqueid type="imdb">tt1234567</uniqueid>
|
||
<imdbid>tt1234567</imdbid>
|
||
<imdb>tt1234567</imdb>
|
||
```
|
||
|
||
**Episode NFO Files:**
|
||
NFOGuard creates standardized episode NFO files using the pattern `S##E##.nfo`:
|
||
- `S01E01.nfo` for Season 1, Episode 1
|
||
- `S02E05.nfo` for Season 2, Episode 5
|
||
- Always zero-padded format (S01E01, not S1E1)
|
||
- **Smart Rename**: NFOGuard will find existing NFO files (created by Sonarr/other tools), extract their metadata, and rename them to the standard format
|
||
|
||
### 🚫 **What Gets Skipped**
|
||
NFOGuard will ignore:
|
||
- Directories without IMDb IDs in brackets AND no NFO files with IMDb IDs
|
||
- Directories without video files
|
||
- TV episodes without recognizable season/episode patterns
|
||
- Season directories that don't match "Season X" format
|
||
|
||
## 🆘 Support
|
||
|
||
- **Issues**: [GitHub Issues](https://github.com/sbcrumb/NFOguard/issues)
|
||
- **Documentation**: See `SETUP.md` for detailed instructions
|
||
- **Docker Hub**: [`sbcrumb/nfoguard`](https://hub.docker.com/r/sbcrumb/nfoguard)
|
||
|
||
## 📄 License
|
||
|
||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||
|
||
Commercial licensing and enterprise features may be available separately. Contact us for more information.
|
||
|
||
---
|
||
|
||
**NFOGuard** - Keeping your media metadata clean and organized! 🎯
|