diff --git a/.env.template b/.env.template new file mode 100644 index 0000000..dd8abce --- /dev/null +++ b/.env.template @@ -0,0 +1,155 @@ +# =========================================== +# NFOGuard Configuration Template +# =========================================== +# Copy this file to .env and customize for your setup +# Sensitive data (API keys, passwords) go in .env.secrets + +# =========================================== +# MEDIA PATHS (REQUIRED) - CONFIGURE THESE FIRST +# =========================================== +# Container paths (what NFOGuard sees inside the Docker container) +MOVIE_PATHS=/media/Movies/movies,/media/Movies/movies6 +TV_PATHS=/media/TV/tv,/media/TV/tv6 + +# Radarr paths (what Radarr sees on your host system) +RADARR_ROOT_FOLDERS=/mnt/unionfs/Media/Movies/movies,/mnt/unionfs/Media/Movies/movies6 + +# Sonarr paths (what Sonarr sees on your host system) +SONARR_ROOT_FOLDERS=/mnt/unionfs/Media/TV/tv,/mnt/unionfs/Media/TV/tv6 + +# Download detection paths (for identifying downloads vs existing files) +DOWNLOAD_PATH_INDICATORS=/downloads/,/nzbget/,/completed/,/sabnzbd/,/torrents/ + +# =========================================== +# DATABASE CONFIGURATION +# =========================================== +# NFOGuard SQLite database location +DB_PATH=/app/data/media_dates.db + +# Log file directory +LOG_DIR=/app/data/logs + +# =========================================== +# RADARR DATABASE CONNECTION (REQUIRED) +# =========================================== +# NFOGuard requires direct access to Radarr's database for movie processing +# Radarr does not provide API access for the data NFOGuard needs + +# Database type - postgresql or sqlite +RADARR_DB_TYPE=postgresql + +# PostgreSQL settings (most common for modern Radarr installations) +RADARR_DB_HOST=192.168.1.100 +RADARR_DB_PORT=5432 +RADARR_DB_NAME=radarr-main +RADARR_DB_USER=postgres +# Password goes in .env.secrets as RADARR_DB_PASSWORD + +# SQLite settings (for older Radarr installations using SQLite) +# Uncomment and set the path to your radarr.db file if using SQLite: +# RADARR_DB_TYPE=sqlite +# RADARR_DB_PATH=/path/to/radarr.db +# For Docker: Mount Radarr's AppData directory and point to the .db file +# Common paths: +# - Docker: /config/radarr.db (if Radarr config is mounted) +# - Windows: C:\ProgramData\Radarr\radarr.db +# - Linux: ~/.config/Radarr/radarr.db + +# =========================================== +# API CONNECTIONS (OPTIONAL) +# =========================================== +# API keys are stored in .env.secrets for security +RADARR_URL=http://radarr:7878 +SONARR_URL=http://sonarr:8989 +JELLYSEERR_URL=http://jellyseerr:5055 + +# =========================================== +# RELEASE DATE PROCESSING +# =========================================== +# Priority order for release date fallbacks +RELEASE_DATE_PRIORITY=digital,physical,theatrical +# Alternative: RELEASE_DATE_PRIORITY=digital,theatrical,physical + +# Enable smart date validation +ENABLE_SMART_DATE_VALIDATION=true + +# Maximum years between release dates (prevents invalid dates) +MAX_RELEASE_DATE_GAP_YEARS=10 + +# Prefer API release dates over file modification dates for manual imports +PREFER_RELEASE_DATES_OVER_FILE_DATES=true + +# Disable file date fallback completely (recommended for clean imports) +ALLOW_FILE_DATE_FALLBACK=false + +# TMDB country for regional release date preferences +TMDB_COUNTRY=US + +# =========================================== +# NFO FILE MANAGEMENT +# =========================================== +# Create/update .nfo files +MANAGE_NFO=true + +# Update file modification times to match import dates +FIX_DIR_MTIMES=true + +# Add lockdata tags to prevent metadata overwrites +LOCK_METADATA=true + +# Brand name in NFO comments +MANAGER_BRAND=NFOGuard + +# =========================================== +# PROCESSING BEHAVIOR +# =========================================== +# Movie date update strategy (overwrite, preserve, smart) +MOVIE_DATE_UPDATE_MODE=overwrite + +# Preserve existing dates when found +MOVIE_PRESERVE_EXISTING=false + +# When to update existing dates (always, missing_only, never) +UPDATE_MODE=always + +# File modification time behavior (update, leave_alone) +MTIME_BEHAVIOR=update + +# =========================================== +# PERFORMANCE & BATCHING +# =========================================== +# Delay before processing batched events (seconds) +BATCH_DELAY=5.0 + +# Maximum concurrent series processing +MAX_CONCURRENT_SERIES=3 + +# API timeout in seconds +TIMEOUT_SECONDS=45 + +# =========================================== +# DEBUGGING & LOGGING +# =========================================== +# Enable verbose logging (true/false) +DEBUG=false + +# Enable path mapping debug output (true/false) +PATH_DEBUG=false + +# Suppress TVDB API warnings (true/false) - TVDB failures are common and non-critical +SUPPRESS_TVDB_WARNINGS=true + +# =========================================== +# SERVER CONFIGURATION +# =========================================== +# Port for webhook server +PORT=8080 + +# =========================================== +# EXAMPLE CONFIGURATION NOTES +# =========================================== +# 1. Copy this file to .env +# 2. Update MOVIE_PATHS and TV_PATHS to match your container mount points +# 3. Update RADARR_ROOT_FOLDERS and SONARR_ROOT_FOLDERS to match your *arr apps' paths +# 4. Copy .env.secrets.template to .env.secrets and add your API keys/passwords +# 5. Adjust other settings as needed for your setup