sbcrumb
01cd31505a
📚 Documentation Updates: • Updated CHANGELOG.md with comprehensive v0.6.0 feature list • Enhanced README.md with new TV processing endpoints and examples • Updated SETUP.md with required Sonarr API key configuration • Enhanced TESTING.md with v0.6.0 TV testing procedures • Updated .env templates with proper Sonarr requirements 🔧 Configuration Updates: • Mark SONARR_API_KEY as REQUIRED for v0.6.0+ Enhanced TV NFOs • Updated version examples from 0.5.1 to 0.6.0 • Added JSON response examples for new TV endpoints • Clarified URL-safe vs URL-encoded endpoint options 📋 Complete File Review: • Verified all Python imports are consistent across modules • Confirmed all typing imports (Dict, Any, List, Optional) are present • Validated configuration templates match actual requirements • Added comprehensive testing procedures for TV enhancements ✅ Ready for Production: • All endpoints documented with examples • Configuration requirements clearly specified • Testing procedures comprehensive for troubleshooting • Backward compatibility maintained throughout
136 lines
4.9 KiB
Bash
136 lines
4.9 KiB
Bash
# NFOGuard Environment Configuration Template
|
|
# Copy this to .env and customize for your setup
|
|
|
|
# ===========================================
|
|
# MEDIA PATHS (REQUIRED)
|
|
# ===========================================
|
|
# Paths where your movies and TV shows are stored inside the container
|
|
# Adjust these to match YOUR directory structure
|
|
TV_PATHS=/media/TV/tv,/media/TV/tv6
|
|
MOVIE_PATHS=/media/Movies/movies,/media/Movies/movies6
|
|
|
|
# ===========================================
|
|
# DATABASE CONFIGURATION
|
|
# ===========================================
|
|
# NFOGuard SQLite database location
|
|
DB_PATH=/app/data/media_dates.db
|
|
|
|
# ===========================================
|
|
# RADARR DATABASE CONNECTION (REQUIRED)
|
|
# ===========================================
|
|
# Connection to Radarr's PostgreSQL database
|
|
# NOTE: Database password should be set in .env.secrets file
|
|
RADARR_DB_HOST=radarr-postgres
|
|
RADARR_DB_PORT=5432
|
|
RADARR_DB_NAME=radarr
|
|
RADARR_DB_USER=radarr
|
|
|
|
# ===========================================
|
|
# RADARR API (OPTIONAL - for fallback)
|
|
# ===========================================
|
|
# Only needed if you want API fallback (not recommended for performance)
|
|
# NOTE: API key should be set in .env.secrets file
|
|
RADARR_URL=http://radarr:7878
|
|
|
|
# ===========================================
|
|
# SONARR API (REQUIRED for Enhanced TV NFOs - v0.6.0+)
|
|
# ===========================================
|
|
# Required for TV processing and enhanced NFO generation with metadata
|
|
# NOTE: API key should be set in .env.secrets file
|
|
SONARR_URL=http://sonarr:8989
|
|
|
|
# ===========================================
|
|
# EXTERNAL APIs FOR DIGITAL RELEASE DATES
|
|
# ===========================================
|
|
# NOTE: All API keys should be set in .env.secrets file
|
|
# See .env.secrets.template for required keys:
|
|
# - TMDB_API_KEY (recommended for digital release dates)
|
|
# - OMDB_API_KEY (optional for DVD/digital release dates)
|
|
# - JELLYSEERR_API_KEY (optional for additional digital release data)
|
|
|
|
# Jellyseerr URL (optional)
|
|
JELLYSEERR_URL=http://jellyseerr:5055
|
|
|
|
# ===========================================
|
|
# NFO MANAGEMENT
|
|
# ===========================================
|
|
# Whether to create/update .nfo files
|
|
MANAGE_NFO=true
|
|
|
|
# Whether to fix file modification times to match import dates
|
|
FIX_DIR_MTIMES=true
|
|
|
|
# Whether to add <lockdata> tags to prevent metadata drift
|
|
LOCK_METADATA=true
|
|
|
|
# Brand name to add to NFO files
|
|
MANAGER_BRAND=NFOGuard
|
|
|
|
# ===========================================
|
|
# PROCESSING SETTINGS
|
|
# ===========================================
|
|
# Delay before processing batched webhook events (seconds)
|
|
BATCH_DELAY=5.0
|
|
|
|
# Maximum concurrent series processing
|
|
MAX_CONCURRENT_SERIES=3
|
|
|
|
# Movie date strategy: import_then_digital or digital_then_import
|
|
MOVIE_PRIORITY=import_then_digital
|
|
|
|
# Smart fallback: prefer release dates over file dates for manual imports (true/false)
|
|
PREFER_RELEASE_DATES_OVER_FILE_DATES=true
|
|
|
|
# Allow file dates as absolute last resort (true/false)
|
|
# If false, movies with no valid import AND no release dates will be skipped entirely
|
|
ALLOW_FILE_DATE_FALLBACK=false
|
|
|
|
# Fallback priority order when no valid Radarr import exists (comma-separated)
|
|
# Options: digital, physical, theatrical
|
|
# digital = VOD/streaming release, physical = DVD/Blu-ray, theatrical = cinema release
|
|
RELEASE_DATE_PRIORITY=digital,physical,theatrical
|
|
|
|
# Smart date validation: automatically prefer theatrical over unreasonably late digital/physical dates
|
|
# Example: "The Craft (1996)" theatrical vs "The Craft (2022)" physical → chooses 1996 theatrical
|
|
ENABLE_SMART_DATE_VALIDATION=true
|
|
|
|
# Maximum reasonable gap between theatrical and digital/physical release (in years)
|
|
# If digital/physical is more than this many years after theatrical, prefer theatrical instead
|
|
MAX_RELEASE_DATE_GAP_YEARS=10
|
|
|
|
# TMDB country for regional release date preferences
|
|
TMDB_COUNTRY=US
|
|
|
|
# TMDB release type priority (comma-separated numbers)
|
|
# 1=Premiere, 2=Limited Theatrical, 3=Theatrical, 4=Digital, 5=Physical, 6=TV Premiere
|
|
# Default: 4,5,3,2,6,1 (Digital → Physical → Theatrical → Limited → TV → Premiere)
|
|
TMDB_TYPE_PRIORITY=4,5,3,2,6,1
|
|
|
|
# When to query APIs: always, if_missing, never
|
|
MOVIE_POLL_MODE=always
|
|
|
|
# Update mode: backfill_only or overwrite
|
|
MOVIE_DATE_UPDATE_MODE=backfill_only
|
|
|
|
# ===========================================
|
|
# TV SERIES PROCESSING
|
|
# ===========================================
|
|
# Season directory naming format (supports {season} placeholder)
|
|
# Examples: "Season {season:02d}" -> "Season 01", "S{season:02d}" -> "S01"
|
|
TV_SEASON_DIR_FORMAT=Season {season:02d}
|
|
|
|
# Season directory detection pattern (lowercase, what to look for at start of dir name)
|
|
# Examples: "season " -> matches "Season 01", "s" -> matches "S01", "season" -> matches "Season01"
|
|
TV_SEASON_DIR_PATTERN=season
|
|
|
|
# ===========================================
|
|
# LOGGING
|
|
# ===========================================
|
|
# Enable debug logging
|
|
DEBUG=false
|
|
|
|
# ===========================================
|
|
# SERVER
|
|
# ===========================================
|
|
# Port to run the webhook server on
|
|
PORT=8080 |