chore: update to examples and readme

2025-10-20 09:32:28 -04:00
parent f6a161a014
commit 148937ae08
7 changed files with 227 additions and 180 deletions
@@ -0,0 +1,41 @@
+# NFOGuard Secrets Configuration Template
+# Copy this to .env.secrets and add your actual API keys
+# This file should NOT be committed to version control
+# Add .env.secrets to your .gitignore
+
+# ===========================================
+# NFOGUARD DATABASE CREDENTIALS (REQUIRED)
+# ===========================================
+# NFOGuard PostgreSQL database password (REQUIRED for v2.6+)
+DB_PASSWORD=your_secure_nfoguard_password
+# Optional: Override default database user (defaults to 'nfoguard')
+# DB_USER=nfoguard
+
+# ===========================================
+# RADARR DATABASE CREDENTIALS (OPTIONAL)
+# ===========================================
+# Database password for external Radarr PostgreSQL connection (optional optimization)
+RADARR_DB_PASSWORD=your_radarr_db_password
+
+# ===========================================
+# API KEYS (SENSITIVE DATA)
+# ===========================================
+# TMDB API key for digital release dates
+TMDB_API_KEY=your_tmdb_api_key
+
+# OMDb API key for DVD/digital release dates (optional)
+OMDB_API_KEY=your_omdb_api_key
+
+# Radarr API key (optional - for fallback only)
+RADARR_API_KEY=your_radarr_api_key
+
+# Sonarr API key (REQUIRED for v0.6.0+ Enhanced TV NFO Generation)
+SONARR_API_KEY=your_sonarr_api_key
+
+# Jellyseerr API key (optional)
+JELLYSEERR_API_KEY=your_jellyseerr_api_key
+
+# TVDB API key (RECOMMENDED for v0.6.1+ Emby TV NFO Compatibility)
+# Required to convert IMDB IDs to TVDB IDs for proper Emby metadata loading
+# Get free API key at: https://thetvdb.com/api-information
+TVDB_API_KEY=your_tvdb_api_key