Allstarr
A media server proxy that integrates music streaming providers with your local library. Works with Jellyfin and Subsonic-compatible servers. When a song isn't in your local library, it gets fetched from your configured provider, downloaded, and served to your client. The downloaded song then lives in your library for next time.
Quick Start
Using Docker (recommended):
# 1. Download the docker-compose.yml file and the .env.example file to a folder on the machine you have Docker
curl -O https://raw.githubusercontent.com/SoPat712/allstarr/refs/heads/main/docker-compose.yml \
-O https://raw.githubusercontent.com/SoPat712/allstarr/refs/heads/main/.env.example
# 2. Configure environment
cp .env.example .env
vi .env # Edit with your settings
# 3. Pull the latest image
docker-compose pull
# 4. Start services
docker-compose up -d
# 5. Check status
docker-compose ps
docker-compose logs -f
The proxy will be available at http://localhost:5274.
Web Dashboard
Allstarr includes a web UI for easy configuration and playlist management, accessible at http://localhost:5275
Features
- Playlist Management: Link Jellyfin playlists to Spotify playlists with just a few clicks
- Provider Matching: It should fill in the gaps of your Jellyfin library with tracks from your selected provider
- WebUI: Update settings without manually editing .env files
- Music: Using multiple sources for music (optimized for SquidWTF right now, though)
- Lyrics: Using multiple sources for lyrics - Jellyfin local, Spotify Lyrics API, LyricsPlus (multi-source), and LRCLib
- Scrobbling: Track your listening history to Last.fm and ListenBrainz with automatic scrobbling
- Downloads Management: View, download, and manage your kept files through the web UI
- Diagnostics: Monitor system performance, memory usage, cache statistics, and endpoint usage
Quick Setup with Web UI
- Access the dashboard at
http://localhost:5275 - Configure Spotify (Configuration tab):
- Enable Spotify API
- Add your
sp_dccookie from Spotify (see instructions in UI) - The cookie age is automatically tracked
- Link playlists (Link Playlists tab):
- View all your Jellyfin playlists
- Click "Link to Spotify" on any playlist
- Paste the Spotify playlist ID, URL, or
spotify:playlist:URI - Accepts formats like:
37i9dQZF1DXcBWIGoYBM5M(just the ID)spotify:playlist:37i9dQZF1DXcBWIGoYBM5M(Spotify URI)https://open.spotify.com/playlist/37i9dQZF1DXcBWIGoYBM5M(full URL)
- Restart to apply changes (should be a banner)
Then, proceeed to Active Playlists, which shows you which Spotify playlists are currently being monitored and filled with tracks, and lets you do a bunch of useful operations on them.
Configuration Persistence
The web UI updates your .env file directly. Changes persist across container restarts, but require a restart to take effect. In development mode, the .env file is in your project root. In Docker, it's at /app/.env.
There's an environment variable to modify this.
Recommended workflow: Use the sp_dc cookie method alongside the Spotify Import Plugin.
<<<<<<< HEAD
Nginx Proxy Setup (Required)
||||||| f68706f
Nginx Proxy Setup (Required)
=======
Nginx Proxy Setup (Optional)
beta
This service only exposes ports internally. You can use nginx to proxy to it, however PLEASE take significant precautions before exposing this! Everyone decides their own level of risk, but this is currently untested, potentially dangerous software, with almost unfettered access to your Jellyfin server. My recommendation is use Tailscale or something similar!
server {
listen 443 ssl http2;
server_name your-domain.com;
ssl_certificate /etc/letsencrypt/live/your-domain.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/your-domain.com/privkey.pem;
ssl_protocols TLSv1.2 TLSv1.3;
# Security headers
add_header Strict-Transport-Security "max-age=31536000" always;
add_header X-Content-Type-Options "nosniff" always;
# Streaming settings
proxy_buffering off;
proxy_request_buffering off;
proxy_read_timeout 600s;
location / {
proxy_pass http://allstarr:8080;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
}
}
Security: Don't trust me or my code, or anyone for that matter (Zero-trust, get it?), use Tailscale or Pangolin or Cloudflare Zero-Trust or anything like it please
Why "Allstarr"?
This project brings together all the music streaming providers into one unified library - making them all stars in your collection.
Features
- Dual Backend Support: Works with Jellyfin and Subsonic-compatible servers (Navidrome, Airsonic, etc.)
- Multi-Provider Architecture: Pluggable system for streaming providers (Deezer, Qobuz, SquidWTF)
- Transparent Proxy: Sits between your music clients and media server
- Automatic Search: Searches streaming providers when songs aren't local
- On-the-Fly Downloads: Songs download and cache for future use
- Favorite to Keep: When you favorite an external track, it's automatically copied to a permanent
/keptfolder separate from the cache - External Playlist Support: Search and download playlists from Deezer, Qobuz, and SquidWTF with M3U generation
- Hi-Res Audio: SquidWTF supports up to 24-bit/192kHz FLAC
- Full Metadata: Downloaded files include complete ID3 tags (title, artist, album, track number, year, genre, BPM, ISRC, etc.) and cover art
- Organized Library: Downloads save in
Artist/Album/Trackfolder structure - Artist Deduplication: Merges local and streaming artists to avoid duplicates
- Album Enrichment: Adds missing tracks to local albums from streaming providers
- Cover Art Proxy: Serves cover art for external content
- Spotify Playlist Injection (Jellyfin only): Intercepts Spotify Import plugin playlists (Release Radar, Discover Weekly) and fills them with tracks auto-matched from streaming providers
- Lyrics Support: Multi-source lyrics fetching from Jellyfin local files, Spotify Lyrics API (synchronized), LyricsPlus (multi-source aggregator), and LRCLib (community database)
- Scrobbling Support: Track your listening history to Last.fm and ListenBrainz
Supported Backends
Jellyfin
Jellyfin is a free and open-source media server. Allstarr connects via the Jellyfin API using your Jellyfin user login. (I plan to move this to api key if possible)
Compatible Jellyfin clients:
Working on getting more currently
Subsonic/Navidrome
Navidrome and other Subsonic-compatible servers are supported via the Subsonic API.
Compatible Subsonic clients:
PC
Android
iOS
Want to improve client compatibility? Pull requests are welcome!
Incompatible Clients
These clients are not compatible with Allstarr due to architectural limitations:
- Symfonium - Uses offline-first architecture and never queries the server for searches, making streaming provider integration impossible. See details
See CLIENTS.md for more detailed client information.
Supported Music Providers
- SquidWTF - Quality: FLAC (Hi-Res 24-bit/192kHz & CD-Lossless 16-bit/44.1kHz), AAC
- Deezer - Quality: FLAC, MP3_320, MP3_128
- Qobuz - Quality: FLAC, FLAC_24_HIGH (Hi-Res 24-bit/192kHz), FLAC_24_LOW, FLAC_16, MP3_320
Choose your preferred provider via the MUSIC_SERVICE environment variable. Additional providers may be added in future releases.
Requirements
- A running media server:
- Jellyfin: Any recent version with API access enabled
- Subsonic: Navidrome or other Subsonic-compatible server
- Docker and Docker Compose (recommended) - includes Redis and Spotify Lyrics API sidecars
- Redis is used for caching (search results, playlists, lyrics, etc.)
- Spotify Lyrics API provides synchronized lyrics for Spotify tracks
- Credentials for at least one music provider (IF NOT USING SQUIDWTF):
- Deezer: ARL token from browser cookies
- Qobuz: User ID + User Auth Token from browser localStorage (see Wiki guide)
- OR .NET 10.0 SDK for manual installation (requires separate Redis setup)
Configuration
Environment Setup
-
Create your environment file
cp .env.example .env -
Edit the
.envfile with your configuration:For Jellyfin backend:
# Backend selection BACKEND_TYPE=Jellyfin # Jellyfin server URL JELLYFIN_URL=http://localhost:8096 # API key (get from Jellyfin Dashboard > API Keys) JELLYFIN_API_KEY=your-api-key-here # User ID (from Jellyfin Dashboard > Users > click user > check URL) JELLYFIN_USER_ID=your-user-id-here # Music library ID (optional, auto-detected if not set) JELLYFIN_LIBRARY_ID=For Subsonic/Navidrome backend:
# Backend selection BACKEND_TYPE=Subsonic # Navidrome/Subsonic server URL SUBSONIC_URL=http://localhost:4533Common settings (both backends):
# Path where downloaded songs will be stored DOWNLOAD_PATH=./downloads # Music service to use: SquidWTF, Deezer, or Qobuz MUSIC_SERVICE=SquidWTF # Storage mode: Permanent or Cache STORAGE_MODE=PermanentSee the full
.env.examplefor all available options including Deezer/Qobuz credentials. -
Configure your client
Point your music client to
http://localhost:5274instead of your media server directly.
Tip
: Make sure the
DOWNLOAD_PATHpoints to a directory that your media server can scan, so downloaded songs appear in your library.
<<<<<<< HEAD
Advanced Configuration
Backend Selection
| Setting | Description |
|---|---|
Backend:Type |
Backend type: Subsonic or Jellyfin (default: Subsonic) |
Jellyfin Settings
| Setting | Description |
|---|---|
Jellyfin:Url |
URL of your Jellyfin server |
Jellyfin:ApiKey |
API key (get from Jellyfin Dashboard > API Keys) |
Jellyfin:UserId |
User ID for library access |
Jellyfin:LibraryId |
Music library ID (optional, auto-detected) |
Jellyfin:MusicService |
Music provider: SquidWTF, Deezer, or Qobuz |
Subsonic Settings
| Setting | Description |
|---|---|
Subsonic:Url |
URL of your Navidrome/Subsonic server |
Subsonic:MusicService |
Music provider: SquidWTF, Deezer, or Qobuz (default: SquidWTF) |
Shared Settings
| Setting | Description |
|---|---|
Library:DownloadPath |
Directory where downloaded songs are stored |
*:ExplicitFilter |
Content filter: All, ExplicitOnly, or CleanOnly |
*:DownloadMode |
Download mode: Track or Album |
*:StorageMode |
Storage mode: Permanent or Cache |
*:CacheDurationHours |
Cache expiration time in hours |
*:EnableExternalPlaylists |
Enable external playlist support |
SquidWTF Settings
| Setting | Description |
|---|---|
SquidWTF:Quality |
Preferred audio quality: FLAC, MP3_320, MP3_128. If not specified, the highest available quality for your account will be used |
Load Balancing & Reliability:
SquidWTF uses a round-robin load balancing strategy across multiple backup API endpoints to distribute requests evenly and prevent overwhelming any single provider. Each request automatically rotates to the next endpoint in the pool, with automatic fallback to other endpoints if one fails. This ensures high availability and prevents rate limiting by distributing load across multiple providers.
Deezer Settings
| Setting | Description |
|---|---|
Deezer:Arl |
Your Deezer ARL token (required if using Deezer) |
Deezer:ArlFallback |
Backup ARL token if primary fails |
Deezer:Quality |
Preferred audio quality: FLAC, MP3_320, MP3_128. If not specified, the highest available quality for your account will be used |
Qobuz Settings
| Setting | Description |
|---|---|
Qobuz:UserAuthToken |
Your Qobuz User Auth Token (required if using Qobuz) - How to get it |
Qobuz:UserId |
Your Qobuz User ID (required if using Qobuz) |
Qobuz:Quality |
Preferred audio quality: FLAC, FLAC_24_HIGH, FLAC_24_LOW, FLAC_16, MP3_320. If not specified, the highest available quality will be used |
External Playlists
Allstarr supports discovering and downloading playlists from your streaming providers (SquidWTF, Deezer, and Qobuz).
| Setting | Description |
|---|---|
Subsonic:EnableExternalPlaylists |
Enable/disable external playlist support (default: true) |
Subsonic:PlaylistsDirectory |
Directory name where M3U playlist files are created (default: playlists) |
How it works:
- Search for playlists from an external provider using the global search in your Subsonic client
- When you "star" (favorite) a playlist, Allstarr automatically downloads all tracks
- An M3U playlist file is created in
{DownloadPath}/playlists/with relative paths to downloaded tracks - Individual tracks are added to the M3U as they are played or downloaded
Environment variable:
# To disable playlists
Subsonic__EnableExternalPlaylists=false
Note
: Due to client-side filtering, playlists from streaming providers may not appear in the "Playlists" tab of some clients, but will show up in global search results.
Spotify Playlist Injection (Jellyfin Only)
Allstarr automatically fills your Spotify playlists (like Release Radar and Discover Weekly) with tracks from your configured streaming provider (SquidWTF, Deezer, or Qobuz). This works by intercepting playlists created by the Jellyfin Spotify Import plugin and matching missing tracks with your streaming service.
Prerequisites
-
Install the Jellyfin Spotify Import Plugin
- Navigate to Jellyfin Dashboard → Plugins → Catalog
- Search for "Spotify Import" by Viperinius
- Install and restart Jellyfin
- Plugin repository: Viperinius/jellyfin-plugin-spotify-import
-
Configure the Spotify Import Plugin
- Go to Jellyfin Dashboard → Plugins → Spotify Import
- Connect your Spotify account
- Select which playlists to sync (e.g., Release Radar, Discover Weekly)
- Set a sync schedule (the plugin will create playlists in Jellyfin)
-
Configure Allstarr
- Enable Spotify Import in Allstarr (see configuration below)
- Link your Jellyfin playlists to Spotify playlists via the Web UI
- Uses your existing
JELLYFIN_URLandJELLYFIN_API_KEYsettings
Configuration
| Setting | Description |
|---|---|
SpotifyImport:Enabled |
Enable Spotify playlist injection (default: false) |
SpotifyImport:MatchingIntervalHours |
How often to run track matching in hours (default: 24, set to 0 for startup only) |
SpotifyImport:Playlists |
JSON array of playlists (managed via Web UI) |
Environment variables example:
# Enable the feature
SPOTIFY_IMPORT_ENABLED=true
# Matching interval (24 hours = once per day)
SPOTIFY_IMPORT_MATCHING_INTERVAL_HOURS=24
# Playlists (use Web UI to manage instead of editing manually)
SPOTIFY_IMPORT_PLAYLISTS=[["Discover Weekly","37i9dQZEVXcV6s7Dm7RXsU","first"],["Release Radar","37i9dQZEVXbng2vDHnfQlC","first"]]
How It Works
-
Spotify Import Plugin Runs
- Plugin fetches your Spotify playlists
- Creates/updates playlists in Jellyfin with tracks already in your library
- Generates "missing tracks" JSON files for songs not found locally
-
Allstarr Matches Tracks (on startup + every 24 hours by default)
- Reads missing tracks files from the Jellyfin plugin
- For each missing track, searches your streaming provider (SquidWTF, Deezer, or Qobuz)
- Uses fuzzy matching to find the best match (title + artist similarity)
- Rate-limited to avoid overwhelming the service (150ms delay between searches)
- Pre-builds playlist cache for instant loading
-
You Open the Playlist in Jellyfin
- Allstarr intercepts the request
- Returns a merged list: local tracks + matched streaming tracks
- Loads instantly from cache!
-
You Play a Track
- Local tracks stream from Jellyfin normally
- Matched tracks download from streaming provider on-demand
- Downloaded tracks are saved to your library for future use
Manual API Triggers
You can manually trigger operations via the admin API:
# Get API key from your .env file
API_KEY="your-api-key-here"
# Fetch missing tracks from Jellyfin plugin
curl "http://localhost:5274/spotify/sync?api_key=$API_KEY"
# Trigger track matching (searches streaming provider)
curl "http://localhost:5274/spotify/match?api_key=$API_KEY"
# Match all playlists (refresh all matches)
curl "http://localhost:5274/spotify/match-all?api_key=$API_KEY"
# Clear cache and rebuild
curl "http://localhost:5274/spotify/clear-cache?api_key=$API_KEY"
# Refresh specific playlist
curl "http://localhost:5274/spotify/refresh-playlist?playlistId=PLAYLIST_ID&api_key=$API_KEY"
Web UI Management
The easiest way to manage Spotify playlists is through the Web UI at http://localhost:5275:
- Link Playlists Tab: Link Jellyfin playlists to Spotify playlists
- Active Playlists Tab: View status, trigger matching, and manage playlists
- Configuration Tab: Enable/disable Spotify Import and adjust settings
Troubleshooting
Playlists are empty:
- Check that the Spotify Import plugin is running and creating playlists
- Verify playlists are linked in the Web UI
- Check logs:
docker-compose logs -f allstarr | grep -i spotify
Tracks aren't matching:
- Ensure your streaming provider is configured (
MUSIC_SERVICE, credentials) - Manually trigger matching via Web UI or API
- Check that the Jellyfin plugin generated missing tracks files
Performance:
- Matching runs in background with rate limiting (150ms between searches)
- First match may take a few minutes for large playlists
- Subsequent loads are instant (served from cache)
Notes
- Uses your existing
JELLYFIN_URLandJELLYFIN_API_KEYsettings - Matched tracks cached for fast loading
- Missing tracks cache persists across restarts (Redis + file cache)
- Rate limiting prevents overwhelming your streaming provider
- Only works with Jellyfin backend (not Subsonic/Navidrome)
Getting Credentials
Deezer ARL Token
See the Wiki guide for detailed instructions on obtaining your Deezer ARL token.
Qobuz Credentials
See the Wiki guide for detailed instructions on obtaining your Qobuz User ID and User Auth Token.
Limitations
- Playlist Search: Subsonic clients like Aonsoku filter playlists client-side from a cached
getPlaylistscall. Streaming provider playlists appear in global search (search3) but not in the Playlists tab filter. - Region Restrictions: Some tracks may be unavailable depending on your region and provider.
- Token Expiration: Provider authentication tokens expire and need periodic refresh.
Architecture
┌─────────────────┐
┌───▶│ Jellyfin │
┌─────────────────┐ ┌──────────────────┐ │ │ Server │
│ Music Client │────▶│ Allstarr │───┤ └─────────────────┘
│ (Aonsoku, │◀────│ (Proxy) │◀──┤
│ Finamp, etc.) │ │ │ │ ┌─────────────────┐
└─────────────────┘ └────────┬─────────┘ └───▶│ Navidrome │
│ │ (Subsonic) │
▼ └─────────────────┘
┌─────────────────┐
│ Music Providers │
│ - SquidWTF │
│ - Deezer │
│ - Qobuz │
└─────────────────┘
The proxy intercepts requests from your music client and:
- Forwards library requests to your configured backend (Jellyfin or Subsonic)
- Merges results with content from your music provider
- Downloads and caches external tracks on-demand
- Serves audio streams transparently
Note: Only the controller matching your configured BACKEND_TYPE is registered at runtime, preventing route conflicts and ensuring clean API separation.
||||||| f68706f
Advanced Configuration
Backend Selection
| Setting | Description |
|---|---|
Backend:Type |
Backend type: Subsonic or Jellyfin (default: Subsonic) |
Jellyfin Settings
| Setting | Description |
|---|---|
Jellyfin:Url |
URL of your Jellyfin server |
Jellyfin:ApiKey |
API key (get from Jellyfin Dashboard > API Keys) |
Jellyfin:UserId |
User ID for library access |
Jellyfin:LibraryId |
Music library ID (optional, auto-detected) |
Jellyfin:MusicService |
Music provider: SquidWTF, Deezer, or Qobuz |
Subsonic Settings
| Setting | Description |
|---|---|
Subsonic:Url |
URL of your Navidrome/Subsonic server |
Subsonic:MusicService |
Music provider: SquidWTF, Deezer, or Qobuz (default: SquidWTF) |
Shared Settings
| Setting | Description |
|---|---|
Library:DownloadPath |
Directory where downloaded songs are stored |
*:ExplicitFilter |
Content filter: All, ExplicitOnly, or CleanOnly |
*:DownloadMode |
Download mode: Track or Album |
*:StorageMode |
Storage mode: Permanent or Cache |
*:CacheDurationHours |
Cache expiration time in hours |
*:EnableExternalPlaylists |
Enable external playlist support |
SquidWTF Settings
| Setting | Description |
|---|---|
SquidWTF:Quality |
Preferred audio quality: FLAC, MP3_320, MP3_128. If not specified, the highest available quality for your account will be used |
Load Balancing & Reliability:
SquidWTF uses a round-robin load balancing strategy across multiple backup API endpoints to distribute requests evenly and prevent overwhelming any single provider. Each request automatically rotates to the next endpoint in the pool, with automatic fallback to other endpoints if one fails. This ensures high availability and prevents rate limiting by distributing load across multiple providers.
Deezer Settings
| Setting | Description |
|---|---|
Deezer:Arl |
Your Deezer ARL token (required if using Deezer) |
Deezer:ArlFallback |
Backup ARL token if primary fails |
Deezer:Quality |
Preferred audio quality: FLAC, MP3_320, MP3_128. If not specified, the highest available quality for your account will be used |
Qobuz Settings
| Setting | Description |
|---|---|
Qobuz:UserAuthToken |
Your Qobuz User Auth Token (required if using Qobuz) - How to get it |
Qobuz:UserId |
Your Qobuz User ID (required if using Qobuz) |
Qobuz:Quality |
Preferred audio quality: FLAC, FLAC_24_HIGH, FLAC_24_LOW, FLAC_16, MP3_320. If not specified, the highest available quality will be used |
External Playlists
Allstarr supports discovering and downloading playlists from your streaming providers (SquidWTF, Deezer, and Qobuz).
| Setting | Description |
|---|---|
Subsonic:EnableExternalPlaylists |
Enable/disable external playlist support (default: true) |
Subsonic:PlaylistsDirectory |
Directory name where M3U playlist files are created (default: playlists) |
How it works:
- Search for playlists from an external provider using the global search in your Subsonic client
- When you "star" (favorite) a playlist, Allstarr automatically downloads all tracks
- An M3U playlist file is created in
{DownloadPath}/playlists/with relative paths to downloaded tracks - Individual tracks are added to the M3U as they are played or downloaded
Environment variable:
# To disable playlists
Subsonic__EnableExternalPlaylists=false
Note
: Due to client-side filtering, playlists from streaming providers may not appear in the "Playlists" tab of some clients, but will show up in global search results.
Spotify Playlist Injection (Jellyfin Only)
Allstarr automatically fills your Spotify playlists (like Release Radar and Discover Weekly) with tracks from your configured streaming provider (SquidWTF, Deezer, or Qobuz). This works by intercepting playlists created by the Jellyfin Spotify Import plugin and matching missing tracks with your streaming service.
Prerequisites
-
Install the Jellyfin Spotify Import Plugin
- Navigate to Jellyfin Dashboard → Plugins → Catalog
- Search for "Spotify Import" by Viperinius
- Install and restart Jellyfin
- Plugin repository: Viperinius/jellyfin-plugin-spotify-import
-
Configure the Spotify Import Plugin
- Go to Jellyfin Dashboard → Plugins → Spotify Import
- Connect your Spotify account
- Select which playlists to sync (e.g., Release Radar, Discover Weekly)
- Set a sync schedule (the plugin will create playlists in Jellyfin)
-
Configure Allstarr
- Enable Spotify Import in Allstarr (see configuration below)
- Link your Jellyfin playlists to Spotify playlists via the Web UI
- Uses your existing
JELLYFIN_URLandJELLYFIN_API_KEYsettings
Configuration
| Setting | Description |
|---|---|
SpotifyImport:Enabled |
Enable Spotify playlist injection (default: false) |
SpotifyImport:MatchingIntervalHours |
How often to run track matching in hours (default: 24, set to 0 for startup only) |
SpotifyImport:Playlists |
JSON array of playlists (managed via Web UI) |
Environment variables example:
# Enable the feature
SPOTIFY_IMPORT_ENABLED=true
# Matching interval (24 hours = once per day)
SPOTIFY_IMPORT_MATCHING_INTERVAL_HOURS=24
# Playlists (use Web UI to manage instead of editing manually)
SPOTIFY_IMPORT_PLAYLISTS=[["Discover Weekly","37i9dQZEVXcV6s7Dm7RXsU","first"],["Release Radar","37i9dQZEVXbng2vDHnfQlC","first"]]
How It Works
-
Spotify Import Plugin Runs
- Plugin fetches your Spotify playlists
- Creates/updates playlists in Jellyfin with tracks already in your library
- Generates "missing tracks" JSON files for songs not found locally
-
Allstarr Matches Tracks (on startup + every 24 hours by default)
- Reads missing tracks files from the Jellyfin plugin
- For each missing track, searches your streaming provider (SquidWTF, Deezer, or Qobuz)
- Uses fuzzy matching to find the best match (title + artist similarity)
- Rate-limited to avoid overwhelming the service (150ms delay between searches)
- Pre-builds playlist cache for instant loading
-
You Open the Playlist in Jellyfin
- Allstarr intercepts the request
- Returns a merged list: local tracks + matched streaming tracks
- Loads instantly from cache!
-
You Play a Track
- Local tracks stream from Jellyfin normally
- Matched tracks download from streaming provider on-demand
- Downloaded tracks are saved to your library for future use
Manual API Triggers
You can manually trigger operations via the admin API:
# Get API key from your .env file
API_KEY="your-api-key-here"
# Fetch missing tracks from Jellyfin plugin
curl "http://localhost:5274/spotify/sync?api_key=$API_KEY"
# Trigger track matching (searches streaming provider)
curl "http://localhost:5274/spotify/match?api_key=$API_KEY"
# Match all playlists (refresh all matches)
curl "http://localhost:5274/spotify/match-all?api_key=$API_KEY"
# Clear cache and rebuild
curl "http://localhost:5274/spotify/clear-cache?api_key=$API_KEY"
# Refresh specific playlist
curl "http://localhost:5274/spotify/refresh-playlist?playlistId=PLAYLIST_ID&api_key=$API_KEY"
Web UI Management
The easiest way to manage Spotify playlists is through the Web UI at http://localhost:5275:
- Link Playlists Tab: Link Jellyfin playlists to Spotify playlists
- Active Playlists Tab: View status, trigger matching, and manage playlists
- Configuration Tab: Enable/disable Spotify Import and adjust settings
Troubleshooting
Playlists are empty:
- Check that the Spotify Import plugin is running and creating playlists
- Verify playlists are linked in the Web UI
- Check logs:
docker-compose logs -f allstarr | grep -i spotify
Tracks aren't matching:
- Ensure your streaming provider is configured (
MUSIC_SERVICE, credentials) - Manually trigger matching via Web UI or API
- Check that the Jellyfin plugin generated missing tracks files
Performance:
- Matching runs in background with rate limiting (150ms between searches)
- First match may take a few minutes for large playlists
- Subsequent loads are instant (served from cache)
Notes
- Uses your existing
JELLYFIN_URLandJELLYFIN_API_KEYsettings - Matched tracks cached for fast loading
- Missing tracks cache persists across restarts (Redis + file cache)
- Rate limiting prevents overwhelming your streaming provider
- Only works with Jellyfin backend (not Subsonic/Navidrome)
Getting Credentials
Deezer ARL Token
See the Wiki guide for detailed instructions on obtaining your Deezer ARL token.
Qobuz Credentials
See the Wiki guide for detailed instructions on obtaining your Qobuz User ID and User Auth Token.
Limitations
- Playlist Search: Subsonic clients like Aonsoku filter playlists client-side from a cached
getPlaylistscall. Streaming provider playlists appear in global search (search3) but not in the Playlists tab filter. - Region Restrictions: Some tracks may be unavailable depending on your region and provider.
- Token Expiration: Provider authentication tokens expire and need periodic refresh.
Architecture
┌─────────────────┐
┌───▶│ Jellyfin │
┌─────────────────┐ ┌──────────────────┐ │ │ Server │
│ Music Client │────▶│ Allstarr │───┤ └─────────────────┘
│ (Aonsoku, │◀────│ (Proxy) │◀──┤
│ Finamp, etc.) │ │ │ │ ┌─────────────────┐
└─────────────────┘ └────────┬─────────┘ └───▶│ Navidrome │
│ │ (Subsonic) │
▼ └─────────────────┘
┌─────────────────┐
│ Music Providers │
│ - SquidWTF │
│ - Deezer │
│ - Qobuz │
└─────────────────┘
The proxy intercepts requests from your music client and:
- Forwards library requests to your configured backend (Jellyfin or Subsonic)
- Merges results with content from your music provider
- Downloads and caches external tracks on-demand
- Serves audio streams transparently
Note: Only the controller matching your configured BACKEND_TYPE is registered at runtime, preventing route conflicts and ensuring clean API separation.
For detailed configuration options, see CONFIGURATION.md.
beta
Manual Installation
If you prefer to run Allstarr without Docker:
-
Clone the repository
git clone https://github.com/SoPat712/allstarr.git cd allstarr -
Restore dependencies
dotnet restore -
Configure the application
Edit
allstarr/appsettings.json:For Jellyfin:
{ "Backend": { "Type": "Jellyfin" }, "Jellyfin": { "Url": "http://localhost:8096", "ApiKey": "your-api-key", "UserId": "your-user-id", "MusicService": "SquidWTF" }, "Library": { "DownloadPath": "./downloads" } }For Subsonic/Navidrome:
{ "Backend": { "Type": "Subsonic" }, "Subsonic": { "Url": "http://localhost:4533", "MusicService": "SquidWTF" }, "Library": { "DownloadPath": "./downloads" } } -
Run the server
cd allstarr dotnet runThe proxy will start on
http://localhost:5274by default. -
Configure your client
Point your music client to
http://localhost:5274instead of your media server directly.
Documentation
- CONFIGURATION.md - Detailed configuration guide for all settings
- ARCHITECTURE.md - Technical architecture and API documentation
- CLIENTS.md - Client compatibility and setup
- CONTRIBUTING.md - Development setup and contribution guidelines
Limitations
- Playlist Search: Subsonic clients like Aonsoku filter playlists client-side from a cached
getPlaylistscall. Streaming provider playlists appear in global search (search3) but not in the Playlists tab filter. - Region Restrictions: Some tracks may be unavailable depending on your region and provider.
- Token Expiration: Provider authentication tokens expire and need periodic refresh.
License
GPL-3.0
Acknowledgments
- octo-fiesta - The original
- octo-fiestarr - The fork that introduced me to this idea based on the above
- Jellyfin Spotify Import Plugin - The plugin that I strongly recommend using alongside this repo
- Jellyfin - The free and open-source media server
- Navidrome - The excellent self-hosted music server
- Subsonic API - The API specification
- Hi-Fi API - These people do some great work, and you should thank them for this even existing!
- Deezer - Music streaming service
- Qobuz - Hi-Res music streaming service
- spotify-lyrics-api - Thank them for the fact that we have access to Spotify's lyrics!
- LRCLIB - The GOATS for giving us a free api for lyrics! They power LRCGET, which I'm sure some of you have heard of