[!IMPORTANT]
If you use Soulseek, share files in slskd (http://localhost:5030/shares). Leechers get banned by the network.
Contents
Why SoulSync
Most self-hosted media setups are a relay race: one app wants things, another searches, a third downloads, a fourth tags, a fifth tells the server, and when a handoff fails nobody notices. SoulSync runs the whole race itself and keeps the receipts.
- It knows what you own. Every search, playlist and recommendation is checked against your real library, so "missing" means missing.
- It checks its work. Downloads are fingerprinted, sanity checked, quality ranked and quarantined when they don't hold up. Nothing lands in your library on faith.
- It explains itself. Stuck wishlist rows show exactly which releases were refused and why. Every download has an audit trail.
- It's one app for the whole house. Music, movies, TV, YouTube, podcasts and audiobooks, with profiles so everyone gets their own taste, playlists and history.
- It's only as big as you want it. Use one part or all of it. Customize in the sidebar hides what you don't use, and each profile picks its own.
At a glance
| |
|---|
| Download sources | Soulseek (slskd), Tidal, Qobuz, Deezer, HiFi, YouTube, SoundCloud, Lidarr, Torrent and Usenet (via Prowlarr). One source or a drag-ordered hybrid chain. |
| Metadata | Spotify (with or without an account), Apple Music / iTunes, Deezer, Discogs, MusicBrainz, plus 14 background enrichment workers |
| Media servers | Plex, Jellyfin, Navidrome, or SoulSync Standalone (no server needed) |
| Playlist sources | Spotify, Tidal, Qobuz, Deezer, YouTube, YouTube Music, Apple Music links, ListenBrainz, Last.fm, Beatport, SoulSync's own mixes, CSV / TSV / TXT / M3U files, and NewPipe backups |
| Video | Movies, TV and YouTube channels with TMDB / TVDB, Prowlarr, qBittorrent / Transmission / Deluge / SABnzbd / NZBGet, Plex and Jellyfin |
| Automation | Visual WHEN → DO → THEN builder, 60+ triggers and actions, Discord / Telegram / Pushbullet / webhook notifications |
| Network (optional) | MetaSync companion: share anonymous weekly taste signals with other SoulSync installs through SIN and get SoulSync Charts back as ready-to-sync playlists |
| Runs on | Docker (amd64 + arm64), Unraid, or plain Python 3.11 |
Music
Dashboard
The home screen is split in two: your music on the left, the machine on the right.
- Hero with a greeting, your library size, one-click Quick Scan and a menu for deep scans, match verification, repair and database backups.
- Worker orbs: every enrichment worker lives on its own animated stage. They drift while resting, pulse when busy, turn red on errors, and fly home into a grid of controls when you hover.
- Library Radio and Your Mixes, Recently Added / Fresh Releases / SoulSync Charts (when MetaSync is connected), and Recently Played (tap a song to play it again; repeats fold into one card).
- Playlist sync health: one honest number for how much of your playlists you own, the playlists missing the most, sorting by missing / last synced / next run / name, and running syncs pinned to the top.
- Up next: the next automations to fire, with run and pause on hover.
- An alerts band that stays invisible until a connection actually breaks.
Playlist sync
Bring a playlist in from anywhere, keep a mirror of it, and keep your media server's copy in step on a schedule.
This is the beginning of the README. Read the rest at the original. Read the full README ↗
