.env.example

# Arr Stack Environment Configuration
# 
# IMPORTANT: Copy this file to .env and customize ALL values for your system
#            The stack will NOT work without setting these variables!
#
# cp .env.example .env

# =============================================================================
# VPN CONFIGURATION (REQUIRED - MUST BE SET)
# =============================================================================
VPN_PROVIDER=nordvpn
VPN_TYPE=openvpn
VPN_USERNAME=your_vpn_username
VPN_PASSWORD=your_vpn_password

# Optional VPN settings (leave empty for auto-selection)
VPN_REGION=
VPN_COUNTRY=
# VPN_PRIVATE_KEY=your_wireguard_private_key  # For Wireguard
# VPN_ADDRESSES=your_wireguard_addresses      # For Wireguard

# =============================================================================
# PATH CONFIGURATION (REQUIRED - MUST BE SET)
# =============================================================================
# These paths MUST exist and be writable by UID/GID 1000:1000
# The compose file has NO fallback values - these variables are mandatory!

# Base path for all application configuration files
# Each service will create its own subdirectory under this path
CONFIG_ROOT=/home/user/docker/configs

# Base path for media library
# Subdirectories: music/, movies/, tv/
MEDIA_ROOT=/home/user/media

# Downloads directory (shared by all download clients)
DOWNLOADS_ROOT=/home/user/downloads

# =============================================================================
# TIMEZONE CONFIGURATION (RECOMMENDED)
# =============================================================================
# Set timezone to match your VPN exit node location for optimal functionality
# Examples:
# - Netherlands VPN exit: TZ=Europe/Amsterdam
# - Germany VPN exit: TZ=Europe/Berlin  
# - US East VPN exit: TZ=America/New_York
# - US West VPN exit: TZ=America/Los_Angeles
# - Canada VPN exit: TZ=America/Toronto
# Default if not set: Europe/London
TZ=Europe/London

# =============================================================================
# RESOURCE LIMITS (OPTIONAL)
# =============================================================================
# Configure memory and CPU limits for each service to prevent resource exhaustion
# Defaults are conservative and suitable for most systems

# VPN and Infrastructure
GLUETUN_MEMORY_LIMIT=512M
GLUETUN_CPU_LIMIT=1.0
WATCHTOWER_MEMORY_LIMIT=256M
WATCHTOWER_CPU_LIMIT=0.5

# Core Media Management (moderate resource usage)
LIDARR_MEMORY_LIMIT=1G
LIDARR_CPU_LIMIT=1.0
RADARR_MEMORY_LIMIT=1G
RADARR_CPU_LIMIT=1.0
SONARR_MEMORY_LIMIT=1G
SONARR_CPU_LIMIT=1.0

# Supporting Services (lighter resource usage)
PROWLARR_MEMORY_LIMIT=512M
PROWLARR_CPU_LIMIT=0.5
BAZARR_MEMORY_LIMIT=512M
BAZARR_CPU_LIMIT=0.5
REQUESTRR_MEMORY_LIMIT=512M
REQUESTRR_CPU_LIMIT=0.5

# Resource-Intensive Services
FLARESOLVERR_MEMORY_LIMIT=1G      # Browser automation needs more memory
FLARESOLVERR_CPU_LIMIT=1.0
OVERSEERR_MEMORY_LIMIT=1G         # Web UI with database
OVERSEERR_CPU_LIMIT=1.0

# Download Clients (highest resource usage)
QBITTORRENT_MEMORY_LIMIT=2G       # BitTorrent can be memory intensive
QBITTORRENT_CPU_LIMIT=2.0
SABNZBD_MEMORY_LIMIT=2G           # Usenet processing needs resources
SABNZBD_CPU_LIMIT=2.0
NZBHYDRA2_MEMORY_LIMIT=1G         # Meta-search with caching
NZBHYDRA2_CPU_LIMIT=1.0

# =============================================================================
# TOTAL RESOURCE CALCULATION
# =============================================================================
# Default total limits (approximate):
# - Memory: ~15.5GB (adjust based on your system)
# - CPU: ~14.5 cores (adjust based on your system)
#
# For systems with limited resources, consider reducing limits:
# - 8GB RAM system: Reduce all memory limits by 50%
# - 4-core system: Reduce all CPU limits by 50%

# =============================================================================
# OPTIONAL CONFIGURATION
# =============================================================================

# Flaresolverr logging (default: info)
LOG_LEVEL=info
LOG_HTML=false
CAPTCHA_SOLVER=none

# =============================================================================
# EXAMPLE DIRECTORY STRUCTURE
# =============================================================================
# Based on the above configuration, your directory structure should look like:
#
# /home/user/
# ├── docker/
# │   └── configs/           # CONFIG_ROOT
# │       ├── gluetun/
# │       ├── sonarr/
# │       ├── radarr/
# │       ├── lidarr/
# │       ├── prowlarr/
# │       ├── bazarr/
# │       ├── overseerr/
# │       ├── requestrr/
# │       ├── qbittorrent/
# │       ├── sabnzbd/
# │       └── nzbhydra2/
# ├── media/                 # MEDIA_ROOT
# │   ├── music/
# │   ├── movies/
# │   └── tv/
# └── downloads/             # DOWNLOADS_ROOT
#     ├── incomplete/        # SABnzbd incomplete downloads
#     └── [completed files]
#
# Make sure all directories are owned by UID/GID 1000:1000:
# sudo chown -R 1000:1000 /home/user/docker /home/user/media /home/user/downloads