docs(downloads): recommend single shared download folder
Refines the filesystem-access guidance after realising the simplest setup is to skip the per-protocol folder split entirely — point Soulseek + qBit + SAB / NZBGet at the same download folder and SoulSync reads one place. - webui/index.html: warning card tone shifted from 'this is a caveat' to 'here's the easiest fix' — leads with the single- folder recommendation, demotes the per-protocol mount option to a fallback. Icon swapped from ⚠️ to 💡 to match the shifted framing. - docker-compose.yml: comment block restructured. EASIEST SETUP now leads (reuse the existing ./downloads mount, point every client there). SEPARATE FOLDERS demoted to a second option with the same commented placeholders for users who want them.
This commit is contained in:
Broque Thomas
parent
0468816367
commit
43f3121abd
3 changed files with 16 additions and 10 deletions
|
|
@ -51,11 +51,17 @@ services:
|
|||
#
|
||||
# ─── Torrent / Usenet download sources (Prowlarr integration) ────────
|
||||
# If you use the Torrent Only or Usenet Only download sources, SoulSync
|
||||
# needs to read the files your torrent / usenet client downloads. The
|
||||
# mount path INSIDE SoulSync must MATCH the save_path your torrent or
|
||||
# usenet client reports — easiest is to use the same path on both
|
||||
# sides. Uncomment + edit the host path to point at the client's
|
||||
# download folder:
|
||||
# needs to read the files your torrent / usenet client downloads.
|
||||
#
|
||||
# EASIEST SETUP: point qBittorrent, SABnzbd / NZBGet, AND slskd at the
|
||||
# SAME download folder. The ./downloads mount above is reused; nothing
|
||||
# new to add here. Just configure each client's download path to
|
||||
# /downloads (inside its own container) — files land in the same place
|
||||
# SoulSync already reads from.
|
||||
#
|
||||
# SEPARATE FOLDERS (if you prefer): uncomment + edit these to point at
|
||||
# the client's download folder. The in-container path must MATCH the
|
||||
# save_path the client reports.
|
||||
# - /path/to/qbittorrent/downloads:/downloads/torrents:rw
|
||||
# - /path/to/sabnzbd/complete:/downloads/usenet:rw
|
||||
# Then set the torrent client's save path to /downloads/torrents and
|
||||
|
|
|
|||
|
|
@ -4972,12 +4972,12 @@
|
|||
Configure your Prowlarr instance to feed search results, and pick a torrent client and/or usenet client to handle the actual downloads. You only need to set up the protocols you actually use.
|
||||
</div>
|
||||
<div class="ind-hero-warning">
|
||||
<div class="ind-hero-warning-title">⚠️ Filesystem access required</div>
|
||||
<div class="ind-hero-warning-title">💡 Filesystem access — easiest setup</div>
|
||||
<div class="ind-hero-warning-body">
|
||||
Your torrent / usenet client downloads to <strong>its own folder</strong> (not Soulseek's). SoulSync needs read access to that folder to import the files.
|
||||
Torrent and usenet clients write files to <strong>their own download folders</strong>, not Soulseek's. SoulSync needs read access to those folders to import the files. <strong>Simplest fix:</strong> point all your downloaders (Soulseek, qBittorrent, SABnzbd / NZBGet) at the <em>same</em> download folder. One folder, one path to worry about, everything just works.
|
||||
<ul>
|
||||
<li><strong>Bare-metal (everything on one PC):</strong> works out of the box — SoulSync reads the path directly.</li>
|
||||
<li><strong>Docker:</strong> map the client's save folder into the SoulSync container at the <em>same path</em> the client reports. Commented examples are in <code>docker-compose.yml</code> — uncomment and edit the host paths.</li>
|
||||
<li><strong>Bare-metal:</strong> just set every client's download path to the same folder (e.g. your existing slskd folder). Done.</li>
|
||||
<li><strong>Docker:</strong> easiest is to reuse the <code>./downloads</code> mount you already have for slskd — point qBit and SAB at <code>/downloads</code> inside their containers too. Or use the commented placeholders in <code>docker-compose.yml</code> if you want separate folders.</li>
|
||||
<li><strong>Remote client (NAS / different host):</strong> mount the remote folder locally (SMB / NFS / rclone) before SoulSync can see it.</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3415,7 +3415,7 @@ function closeHelperSearch() {
|
|||
const WHATS_NEW = {
|
||||
'2.6.0': [
|
||||
{ unreleased: true },
|
||||
{ title: 'Docker mount heads-up for torrent / usenet sources', desc: 'added an orange warning card on the Indexers & Downloaders tab explaining the filesystem-access requirement up front. torrent and usenet clients each download to their own folders (not Soulseek\'s), so SoulSync needs read access to those paths — works out of the box on bare-metal, needs a volume mount on Docker, needs SMB / NFS / rclone on remote-NAS setups. docker-compose.yml gained commented placeholder mounts for /downloads/torrents and /downloads/usenet that users can uncomment + edit to point at their qBit / SAB save folders.' },
|
||||
{ title: 'Filesystem-access heads-up for torrent / usenet sources', desc: 'new advisory card on the Indexers & Downloaders tab explaining the cleanest setup: point ALL your downloaders (Soulseek, qBittorrent, SABnzbd / NZBGet) at the same download folder. One folder, one mount, everything just works. Bare-metal needs no change; Docker users can reuse the existing ./downloads mount and just configure each client to write there. docker-compose.yml updated to call this out as the easiest path, with optional commented placeholders for users who prefer separate folders per protocol.' },
|
||||
{ title: 'Torrent and Usenet downloads', desc: 'two new download sources live in the Download Source dropdown: <strong>Torrent Only (via Prowlarr)</strong> and <strong>Usenet Only (via Prowlarr)</strong>. they reuse the Prowlarr + torrent client + usenet client you set up on the Indexers & Downloaders tab. searches go through Prowlarr filtered by protocol, picked releases get handed to your torrent client or usenet client, and the resulting files get walked through archive_pipeline (extracts .zip / .rar / .tar when the client didn\'t already do it) and handed to the matching pipeline. both sources are also available in hybrid mode alongside soulseek / youtube / tidal / etc. one caveat: SoulSync needs read access to the torrent / usenet client\'s save_path — works out of the box for everything-on-one-box setups, but remote downloader hosts will need a future sync step.' },
|
||||
{ title: 'Archive pipeline module (groundwork for torrent / usenet downloads)', desc: 'new core/archive_pipeline.py — walks a directory for audio files (recursive, case-insensitive extensions), extracts zip / tar / tar.gz / rar / 7z archives in-place (rar and 7z are optional deps that warn but don\'t crash if absent), and rejects any archive member trying to escape the destination via path traversal. shared helper the upcoming torrent and usenet download plugins both consume — usenet downloaders usually auto-extract, but the occasional torrent ships an album in a .rar and SoulSync handles it now. 21 unit tests cover the walker + zip + tar extraction + path-traversal protection.' },
|
||||
{ title: 'Indexers & Downloaders tab restyled with collapsible sections', desc: 'tab now opens with an intro hero card explaining the flow (indexers find releases → downloader fetches them → SoulSync imports) and folds the rest into three collapsible sections: Indexers, Torrent Client, Usenet Client. each section gets a per-service color accent (Prowlarr orange, torrent sky-blue, usenet violet), a status dot in the header (green when Test Connection succeeds, red on failure, grey before testing), and Lidarr-style indexer cards with protocol badges instead of the inline emoji list. Indexers section is open by default; the downloader sections start collapsed since not everyone uses both protocols.' },
|
||||
|
|
|
|||
Loading…
Reference in a new issue