From bb0599c585636f9445e6dd40648a8e6f009f6440 Mon Sep 17 00:00:00 2001 From: Broque Thomas <26755000+Nezreka@users.noreply.github.com> Date: Tue, 10 Mar 2026 15:46:03 -0700 Subject: [PATCH] update docs --- webui/static/docs.js | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/webui/static/docs.js b/webui/static/docs.js index 6d9e6f27..8222bb26 100644 --- a/webui/static/docs.js +++ b/webui/static/docs.js @@ -18,7 +18,7 @@ const DOCS_SECTIONS = [

Overview

SoulSync is a self-hosted music download, sync, and library management platform. It connects to Spotify, Apple Music/iTunes, Tidal, YouTube, and Beatport for metadata, and uses Soulseek (via slskd) as the primary download source. Your library is served through Plex, Jellyfin, or Navidrome.

-

🎵 Download Music

Search and download tracks in FLAC, MP3, and more from Soulseek, with automatic metadata tagging and file organization.

+

🎵 Download Music

Search and download tracks in FLAC, MP3, and more from Soulseek, YouTube, or Tidal, with automatic metadata tagging and file organization.

🔄 Playlist Sync

Mirror playlists from Spotify, YouTube, Tidal, and Beatport. Discover official metadata and sync to your media server.

📚 Library Management

Browse, edit, and enrich your music library with metadata from 7 services. Write tags directly to audio files.

🤖 Automations

Schedule tasks, chain workflows with signals, and get notified via Discord, Pushbullet, or Telegram.

@@ -30,12 +30,12 @@ const DOCS_SECTIONS = [

First-Time Setup

After launching SoulSync, head to the Settings page to configure your services. At minimum you need:

    -
  1. Soulseek (slskd) — Enter your slskd URL and API key. This is required for downloading music.
    2. +
  2. Download Source — Connect at least one download source: Soulseek (slskd), YouTube, or Tidal. Soulseek offers the best quality selection; YouTube and Tidal work as alternatives or fallbacks in Hybrid mode.
  3. Media Server — Connect Plex, Jellyfin, or Navidrome so SoulSync knows where your library lives and can trigger scans.
  4. Spotify (Recommended) — Connect Spotify for the richest metadata. Create an app at developer.spotify.com, enter your Client ID and Secret, then click Authenticate.
  5. Download Path — Set your download and transfer paths in the Download Settings section. The transfer path should point to your media server's monitored folder.
-
💡
You can start using SoulSync with just Soulseek connected. Spotify and other services add metadata enrichment but aren't strictly required — iTunes/Apple Music is always available as a free fallback.
+
💡
You can start using SoulSync with just one download source (Soulseek, YouTube, or Tidal). Spotify and other services add metadata enrichment but aren't strictly required — iTunes/Apple Music is always available as a free fallback.

Connecting Services

@@ -45,11 +45,12 @@ const DOCS_SECTIONS = [ SpotifyPrimary metadata source (artists, albums, tracks, cover art, genres)OAuth — Client ID + Secret iTunes / Apple MusicFallback metadata source, always free, no auth neededNone - Soulseek (slskd)Music download sourceURL + API key - PlexMedia server — library scanning and metadata syncURL + Token - JellyfinMedia server — library scanningURL + API Key - NavidromeMedia server — auto-detects changesURL + Username + Password - TidalPlaylist import, optional download sourceOAuth — Client ID + Secret + Soulseek (slskd)Download source — P2P network, best for lossless and rare musicURL + API key + YouTubeDownload source — audio extraction via yt-dlpNone (optional cookies browser) + TidalDownload source + playlist importOAuth — Client ID + Secret + PlexMedia server — library scanning, metadata sync, audio streamingURL + Token + JellyfinMedia server — library scanning, audio streamingURL + API Key + NavidromeMedia server — auto-detects changes, audio streamingURL + Username + Password Last.fmEnrichment — listener stats, tags, bios, similar artistsAPI Key GeniusEnrichment — lyrics, descriptions, alternate namesAccess Token AcoustIDAudio fingerprint verification of downloadsAPI Key @@ -62,8 +63,8 @@ const DOCS_SECTIONS = [

SoulSync uses a sidebar navigation layout. The left sidebar contains links to every page, a media player at the bottom, and service status indicators. The main content area changes based on the selected page.