adding docker example updates
This commit is contained in:
@@ -50,27 +50,87 @@ It integrates with **Sonarr** and **Radarr**, listens for import/rename/upgrade
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Quick Start (Docker)
|
||||
## 🚀 Quick Start (Docker Compose)
|
||||
|
||||
```bash
|
||||
# 1. Copy configuration templates
|
||||
cp .env.template .env
|
||||
cp .env.secrets.template .env.secrets
|
||||
|
||||
# 2. Edit your configuration files
|
||||
# .env - paths and preferences (safe to share)
|
||||
# .env.secrets - API keys and passwords (never commit)
|
||||
|
||||
# 3. Start NFOGuard
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
**Docker Compose (Recommended)**:
|
||||
```yaml
|
||||
version: '3.8'
|
||||
services:
|
||||
nfoguard:
|
||||
image: ghcr.io/your-org/nfoguard:latest
|
||||
container_name: nfoguard
|
||||
ports:
|
||||
- "8080:8080"
|
||||
volumes:
|
||||
- /mnt/unionfs/Media:/media:rw
|
||||
- ./data:/app/data
|
||||
- ./.env:/app/.env:ro # Main configuration
|
||||
- ./.env.secrets:/app/.env.secrets:ro # Secure API keys
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
**Docker Run (Alternative)**:
|
||||
```bash
|
||||
docker run -d \
|
||||
--name=NFOGuard \
|
||||
-p 8080:8080 \
|
||||
-v /mnt/unionfs/Media:/media:rw \
|
||||
-v /opt/NFOGuard/data:/app/data \
|
||||
-e TV_PATHS="/media/TV/tv,/media/TV/tv6" \
|
||||
-e MOVIE_PATHS="/media/Movies/movies,/media/Movies/movies6" \
|
||||
-v /opt/NFOGuard/.env:/app/.env:ro \
|
||||
-v /opt/NFOGuard/.env.secrets:/app/.env.secrets:ro \
|
||||
ghcr.io/your-org/NFOGuard:latest
|
||||
⚙️ Environment Variables
|
||||
Variable Default Description
|
||||
TV_PATHS /media/tv,/media/tv6 Comma-separated list of TV root paths
|
||||
MOVIE_PATHS /media/movies,/media/movies6 Comma-separated list of Movie root paths
|
||||
DB_PATH /app/data/media_dates.db Path to SQLite database
|
||||
MANAGE_NFO true Write/update NFO files
|
||||
FIX_DIR_MTIMES true Sync directory/file mtimes to import date
|
||||
LOCK_METADATA true Add <lockdata> in NFOs
|
||||
BATCH_DELAY 5.0 Delay before processing batched events
|
||||
DEBUG false Enable verbose logging
|
||||
```
|
||||
|
||||
## 🔧 Configuration Files
|
||||
|
||||
NFOGuard uses a **secure two-file configuration system**:
|
||||
|
||||
### **`.env` - Main Configuration** (safe to share)
|
||||
```bash
|
||||
# Media paths
|
||||
MOVIE_PATHS=/media/Movies/movies,/media/Movies/movies6
|
||||
TV_PATHS=/media/TV/tv,/media/TV/tv6
|
||||
|
||||
# Release date priority (digital, physical, theatrical)
|
||||
RELEASE_DATE_PRIORITY=digital,physical,theatrical
|
||||
PREFER_RELEASE_DATES_OVER_FILE_DATES=true
|
||||
ALLOW_FILE_DATE_FALLBACK=false
|
||||
|
||||
# Database connection
|
||||
RADARR_DB_HOST=radarr-postgres
|
||||
RADARR_DB_PORT=5432
|
||||
RADARR_DB_NAME=radarr
|
||||
RADARR_DB_USER=postgres
|
||||
```
|
||||
|
||||
### **`.env.secrets` - Sensitive Data** (never commit)
|
||||
```bash
|
||||
# Database password
|
||||
RADARR_DB_PASSWORD=your_actual_password
|
||||
|
||||
# API keys
|
||||
TMDB_API_KEY=your_tmdb_api_key
|
||||
RADARR_API_KEY=your_radarr_api_key
|
||||
SONARR_API_KEY=your_sonarr_api_key
|
||||
```
|
||||
|
||||
**Security Features**:
|
||||
- 🔐 **API key masking** in logs automatically
|
||||
- 🚫 **Git protection** - secrets never committed
|
||||
- 🛠️ **Easy debugging** - main .env safe to share
|
||||
|
||||
🔌 API Endpoints
|
||||
|
||||
|
||||
Reference in New Issue
Block a user