# ============================================================================= # Scraparr Configuration # ============================================================================= # # Environment Variable Substitution: # You can use ${VAR_NAME} syntax to reference environment variables. # This allows keeping secrets out of your config file. # # Supported syntax: # ${VAR_NAME} - Required env var (fails if not set) # ${VAR_NAME:-default} - Optional env var with fallback default # # Examples: # api_key: ${SONARR_API_KEY} # url: http://${HOST:-localhost}:${PORT:-8989} # # Docker Compose usage: # environment: # - SONARR_API_KEY=your-secret-key # Or use env_file: # env_file: # - .env # Contains SONARR_API_KEY=xxx # # Docker secrets via *_FILE are supported when configuring Scraparr directly # with environment variables, e.g. SONARR_API_KEY_FILE=/run/secrets/sonarr_api_key. # They are not used by ${VAR_NAME} substitution in this YAML file. # # Kubernetes usage: # Mount secrets as environment variables using envFrom/secretRef # # ============================================================================= general: # Exporter Listening Address and Port # address: 0.0.0.0 # Optional # port: 7100 # Optional # Exporter Metrics Path # path: /metrics # Optional # Log level: DEBUG, INFO, WARNING, ERROR, CRITICAL # log_level: INFO # Optional auth: # Basic Auth # username: user # Optional # password: pass # Optional # Bearer Token # token: token # Optional sonarr: url: http://sonarr:8989 api_key: key # Or use: ${SONARR_API_KEY} # alias: sonarr # Optional to Differentiate between multiple Services # api_version: v3 # Optional to use a different API Version # interval: 30 # Optional to set a different Interval in Seconds # detailed: true # Get Data per Series # episode_quality_stats: true # Fetch episode quality metrics (N extra API calls, disable for performance) # exclude: # Optional list of rootFolderPaths to exclude from metrics # - /data/test radarr: url: http://radarr:7878 api_key: key # Or use: ${RADARR_API_KEY} # alias: radarr # Optional to Differentiate between multiple Services # api_version: v3 # Optional to use a different API Version # interval: 30 # Optional to set a different Interval in Seconds # detailed: true # Get Data per Movie prowlarr: url: http://prowlarr:9696 api_key: key # Or use: ${PROWLARR_API_KEY} # alias: prowlarr # Optional to Differentiate between multiple Services # api_version: v1 # Optional to use a different API Version # interval: 30 # Optional to set a different Interval in Seconds # detailed: true # Get Data per Application/Indexer bazarr: url: http://bazarr:6767 api_key: key # Or use: ${BAZARR_API_KEY} # alias: bazarr # Optional to Differentiate between multiple Services # interval: 30 # Optional to set a different Interval in Seconds # detailed: true # Get Data per Series readarr: url: http://readarr:8787 api_key: key # Or use: ${READARR_API_KEY} # alias: prowlarr # Optional to Differentiate between multiple Services # api_version: v1 # Optional to use a different API Version # interval: 30 # Optional to set a different Interval in Seconds # detailed: true # Get Data per Book seerr: url: http://seerr:5055 api_key: key # Or use: ${SEERR_API_KEY} # alias: seerr # Optional to Differentiate between multiple Services # interval: 30 # Optional to set a different Interval in Seconds # detailed: true # Get Data per Request/Issue whisparr: url: http://whisparr:6969 api_key: key # Or use: ${WHISPARR_API_KEY} # alias: whisparr # Optional to Differentiate between multiple Services # interval: 30 # Optional to set a different Interval in Seconds # detailed: true # Get Data per Performer/Scene # episode_quality_stats: true # Fetch episode quality metrics (N extra API calls, disable for performance) lidarr: url: http://lidarr:8096 api_key: key # Or use: ${LIDARR_API_KEY} # alias: lidarr # Optional to Differentiate between multiple Services # interval: 30 # Optional to set a different Interval in Seconds # within: 30 # Optional to set a timeframe in seconds to search for sessions (default: 300) # detailed: true # Get Data per Artist jellyfin: url: http://jellyfin:8096 api_key: key # Or use: ${JELLYFIN_API_KEY} # alias: jellyfin # Optional to Differentiate between multiple Services # interval: 30 # Optional to set a different Interval in Seconds # within: 30 # Optional to set a timeframe in seconds to search for sessions (default: 300) # detailed: true # Get Data per User kavita: url: http://kavita:5000 api_key: key # alias: kavita # Optional to Differentiate between multiple Services # interval: 30 # Optional to set a different Interval in Seconds # detailed: true # Get Data per Library # exclude: # Optional list of library names or IDs to exclude from metrics # - Test Library