mirror of
https://github.com/SoPat712/allstarr.git
synced 2026-02-10 07:58:39 -05:00
129 lines
5.3 KiB
Plaintext
129 lines
5.3 KiB
Plaintext
# ===== BACKEND SELECTION =====
|
|
# Choose which media server backend to use: Subsonic or Jellyfin
|
|
BACKEND_TYPE=Subsonic
|
|
|
|
# ===== REDIS CACHE =====
|
|
# Enable Redis caching for metadata and images (default: true)
|
|
REDIS_ENABLED=true
|
|
|
|
# ===== SUBSONIC/NAVIDROME CONFIGURATION =====
|
|
# Server URL (required if using Subsonic backend)
|
|
SUBSONIC_URL=http://localhost:4533
|
|
|
|
# ===== JELLYFIN CONFIGURATION =====
|
|
# Server URL (required if using Jellyfin backend)
|
|
JELLYFIN_URL=http://localhost:8096
|
|
|
|
# API key for authentication (get from Jellyfin Dashboard > API Keys)
|
|
JELLYFIN_API_KEY=
|
|
|
|
# User ID (get from Jellyfin Dashboard > Users > click user > check URL)
|
|
JELLYFIN_USER_ID=
|
|
|
|
# Music library ID (optional, auto-detected if not set)
|
|
JELLYFIN_LIBRARY_ID=
|
|
|
|
# ===== MUSIC SOURCE SELECTION =====
|
|
# Music service to use: SquidWTF, Deezer, or Qobuz (default: SquidWTF)
|
|
MUSIC_SERVICE=SquidWTF
|
|
|
|
# Path where downloaded songs will be stored on the host (only applies if STORAGE_MODE=Permanent)
|
|
DOWNLOAD_PATH=./downloads
|
|
|
|
# ===== SQUIDWTF CONFIGURATION =====
|
|
# Different quality options for SquidWTF. Only FLAC supported right now
|
|
SQUIDWTF_QUALITY=FLAC
|
|
|
|
# ===== DEEZER CONFIGURATION =====
|
|
# Deezer ARL token (required if using Deezer)
|
|
# See README.md for instructions on how to get this token
|
|
DEEZER_ARL=your-deezer-arl-token
|
|
|
|
# Fallback ARL token (optional)
|
|
DEEZER_ARL_FALLBACK=
|
|
|
|
# Preferred audio quality: FLAC, MP3_320, MP3_128 (optional)
|
|
# If not specified, the highest available quality for your account will be used
|
|
DEEZER_QUALITY=
|
|
|
|
# ===== QOBUZ CONFIGURATION =====
|
|
# Qobuz user authentication token (required if using Qobuz)
|
|
# Get this from your browser after logging into play.qobuz.com
|
|
# See README.md for detailed instructions
|
|
QOBUZ_USER_AUTH_TOKEN=
|
|
|
|
# Qobuz user ID (required if using Qobuz)
|
|
# Get this from your browser after logging into play.qobuz.com
|
|
QOBUZ_USER_ID=
|
|
|
|
# Preferred audio quality: FLAC, FLAC_24_HIGH, FLAC_24_LOW, FLAC_16, MP3_320 (optional)
|
|
# If not specified, the highest available quality will be used
|
|
QOBUZ_QUALITY=
|
|
|
|
# ===== GENERAL SETTINGS =====
|
|
# External playlists support (optional, default: true)
|
|
# When enabled, allows searching and downloading playlists from Deezer/Qobuz
|
|
# Starring a playlist triggers automatic download of all tracks and creates an M3U file
|
|
ENABLE_EXTERNAL_PLAYLISTS=true
|
|
|
|
# Playlists directory name (optional, default: playlists)
|
|
# M3U playlist files will be created in {DOWNLOAD_PATH}/{PLAYLISTS_DIRECTORY}/
|
|
PLAYLISTS_DIRECTORY=playlists
|
|
|
|
# Explicit content filter (optional, default: All)
|
|
# - All: Show all tracks (no filtering)
|
|
# - ExplicitOnly: Exclude clean/edited versions, keep original explicit content
|
|
# - CleanOnly: Only show clean content (naturally clean or edited versions)
|
|
# Note: This only works with Deezer, Qobuz doesn't expose explicit content flags
|
|
EXPLICIT_FILTER=All
|
|
|
|
# Download mode (optional, default: Track)
|
|
# - Track: Download only the played track
|
|
# - Album: When playing a track, download the entire album in background
|
|
# The played track is downloaded first, remaining tracks are queued
|
|
DOWNLOAD_MODE=Track
|
|
|
|
# Storage mode (optional, default: Permanent)
|
|
# - Permanent: Files are saved to the library permanently and registered in the media server
|
|
# - Cache: Files are stored in /tmp and automatically cleaned up after CACHE_DURATION_HOURS
|
|
# Not registered in media server, ideal for streaming without library bloat
|
|
# Note: On Linux/Docker, you can customize cache location by setting TMPDIR environment variable
|
|
STORAGE_MODE=Permanent
|
|
|
|
# Cache duration in hours (optional, default: 1)
|
|
# Files older than this duration will be automatically deleted when STORAGE_MODE=Cache
|
|
# Based on last access time (updated each time the file is streamed)
|
|
# Cache location: /tmp/allstarr-cache (or $TMPDIR/allstarr-cache if TMPDIR is set)
|
|
CACHE_DURATION_HOURS=1
|
|
|
|
# ===== SPOTIFY PLAYLIST INJECTION (JELLYFIN ONLY) =====
|
|
# REQUIRES: Jellyfin Spotify Import Plugin (https://github.com/Viperinius/jellyfin-plugin-spotify-import)
|
|
# This feature intercepts Spotify Import plugin playlists (Release Radar, Discover Weekly) and fills them
|
|
# with tracks auto-matched from external providers (SquidWTF, Deezer, Qobuz)
|
|
# Uses JELLYFIN_URL and JELLYFIN_API_KEY configured above (no separate credentials needed)
|
|
|
|
# Enable Spotify playlist injection (optional, default: false)
|
|
SPOTIFY_IMPORT_ENABLED=false
|
|
|
|
# Sync schedule: When does the Spotify Import plugin run?
|
|
# Set these to match your plugin's sync schedule in Jellyfin
|
|
# Example: If plugin runs daily at 4:15 PM, set HOUR=16 and MINUTE=15
|
|
SPOTIFY_IMPORT_SYNC_START_HOUR=16
|
|
SPOTIFY_IMPORT_SYNC_START_MINUTE=15
|
|
|
|
# Sync window: How long to search for missing tracks files (in hours)
|
|
# The fetcher will check every 5 minutes within this window
|
|
# Example: If plugin runs at 4:15 PM and window is 2 hours, checks from 4:00 PM to 6:00 PM
|
|
SPOTIFY_IMPORT_SYNC_WINDOW_HOURS=2
|
|
|
|
# Playlist IDs to inject (comma-separated)
|
|
# Get IDs from Jellyfin playlist URLs: https://jellyfin.example.com/web/#/details?id=PLAYLIST_ID
|
|
# Example: SPOTIFY_IMPORT_PLAYLIST_IDS=4383a46d8bcac3be2ef9385053ea18df,ba50e26c867ec9d57ab2f7bf24cfd6b0
|
|
SPOTIFY_IMPORT_PLAYLIST_IDS=
|
|
|
|
# Playlist names (comma-separated, must match Spotify Import plugin format)
|
|
# IMPORTANT: Use the exact playlist names as they appear in Jellyfin
|
|
# Must be in same order as SPOTIFY_IMPORT_PLAYLIST_IDS
|
|
# Example: SPOTIFY_IMPORT_PLAYLIST_NAMES=Discover Weekly,Release Radar
|
|
SPOTIFY_IMPORT_PLAYLIST_NAMES=
|