Gronod
e5b2fc8ea4
- Document background polling and on-demand mode in README - Add POLL_INTERVAL to all config examples (Docker, Compose, .env) - New 'Background Polling' section in Features - Sanitize leaked credentials in .env.example
87 lines
4.2 KiB
Plaintext
87 lines
4.2 KiB
Plaintext
# sofarr Configuration
|
|
# Copy this file to .env and update with your values
|
|
|
|
# =============================================================================
|
|
# SERVER SETTINGS
|
|
# =============================================================================
|
|
PORT=3001
|
|
|
|
# Logging level: debug, info, warn, error, silent
|
|
# - debug: Verbose logging for troubleshooting
|
|
# - info: Standard operational logging (default)
|
|
# - warn: Only warnings and errors
|
|
# - error: Only errors
|
|
# - silent: No logging
|
|
LOG_LEVEL=info
|
|
|
|
# Background polling interval in milliseconds (default: 5000)
|
|
# sofarr polls all services in the background and caches results so
|
|
# dashboard requests are near-instant.
|
|
# Set to 0, "off", "false", or "disabled" to disable background polling.
|
|
# When disabled, data is fetched on-demand when a user opens the dashboard
|
|
# and cached for 30 seconds so other users benefit from the same fetch.
|
|
# POLL_INTERVAL=5000
|
|
|
|
# =============================================================================
|
|
# EMBY (Authentication - Required)
|
|
# =============================================================================
|
|
EMBY_URL=https://emby.example.com
|
|
EMBY_API_KEY=your-emby-api-key-here
|
|
|
|
# =============================================================================
|
|
# SABNZBD INSTANCES (JSON Array Format)
|
|
# Add one or more SABnzbd instances as a single-line JSON array
|
|
# Format: [{"name":"instance-name","url":"https://...","apiKey":"..."}]
|
|
# =============================================================================
|
|
SABNZBD_INSTANCES=[{"name":"primary","url":"https://sabnzbd.example.com","apiKey":"your-sabnzbd-api-key"}]
|
|
|
|
# Legacy single-instance format (optional - still supported)
|
|
# SABNZBD_URL=https://sabnzbd.example.com
|
|
# SABNZBD_API_KEY=your-sabnzbd-api-key
|
|
|
|
# =============================================================================
|
|
# QBITTORRENT INSTANCES (JSON Array Format)
|
|
# Add one or more qBittorrent instances as a single-line JSON array
|
|
# Uses username/password authentication (not API key)
|
|
# Format: [{"name":"instance-name","url":"https://...","username":"...","password":"..."}]
|
|
# =============================================================================
|
|
QBITTORRENT_INSTANCES=[{"name":"main","url":"https://qbittorrent.example.com","username":"admin","password":"your-password"}]
|
|
|
|
# Legacy single-instance format (optional - still supported)
|
|
# QBITTORRENT_URL=https://qbittorrent.example.com
|
|
# QBITTORRENT_USERNAME=admin
|
|
# QBITTORRENT_PASSWORD=your-password
|
|
|
|
# =============================================================================
|
|
# SONARR INSTANCES (JSON Array Format)
|
|
# Add one or more Sonarr instances as a single-line JSON array
|
|
# Format: [{"name":"instance-name","url":"https://...","apiKey":"..."}]
|
|
# =============================================================================
|
|
SONARR_INSTANCES=[{"name":"main","url":"https://sonarr.example.com","apiKey":"your-sonarr-api-key"}]
|
|
|
|
# Legacy single-instance format (optional - still supported)
|
|
# SONARR_URL=https://sonarr.example.com
|
|
# SONARR_API_KEY=your-sonarr-api-key
|
|
|
|
# =============================================================================
|
|
# RADARR INSTANCES (JSON Array Format)
|
|
# Add one or more Radarr instances as a single-line JSON array
|
|
# Format: [{"name":"instance-name","url":"https://...","apiKey":"..."}]
|
|
# =============================================================================
|
|
RADARR_INSTANCES=[{"name":"main","url":"https://radarr.example.com","apiKey":"your-radarr-api-key"}]
|
|
|
|
# Legacy single-instance format (optional - still supported)
|
|
# RADARR_URL=https://radarr.example.com
|
|
# RADARR_API_KEY=your-radarr-api-key
|
|
|
|
# =============================================================================
|
|
# NOTES
|
|
# =============================================================================
|
|
# 1. All JSON arrays must be on a single line (no line breaks)
|
|
# 2. Instance "name" can be anything descriptive (e.g., "main", "4k", "backup")
|
|
# 3. URLs should include protocol (http:// or https://)
|
|
# 4. For qBittorrent, ensure Web UI is enabled in settings
|
|
# 5. User downloads are matched by tags in Sonarr/Radarr - tag your media!
|
|
# 6. Background polling keeps data fresh; disable it for low-resource setups
|
|
# =============================================================================
|