yoink

SoulSeek is a download-only provider. It works through slskd, a web-based SoulSeek client that exposes a REST API.

SoulSeek doesn't use provider-specific IDs. It searches by artist name, album title, and track title. This means it can download music discovered through any metadata provider, not just tracks linked to a specific service.

Prerequisites

A running slskd instance
A SoulSeek account (create one in slskd's settings or at slsknet.org)

Setup with Docker Compose

Add slskd to your compose file

compose.yaml

services:
  slskd:
    image: slskd/slskd
    container_name: slskd
    restart: unless-stopped
    ports:
      - "5030:5030"
    environment:
      SLSKD_REMOTE_CONFIGURATION: true
      SLSKD_SLSK_USERNAME: your_slsk_username
      SLSKD_SLSK_PASSWORD: your_slsk_password
    volumes:
      - slskd-data:/app
      - ./music:/music

Mount slskd's downloads into the yoink container

yoink needs to read completed downloads from slskd's download directory:

compose.yaml (yoink service)

volumes:
  - yoink-data:/data
  - ./music:/music
  - slskd-data:/slskd-downloads:ro

Enable SoulSeek in yoink

compose.yaml (yoink service)

environment:
  SOULSEEK_ENABLED: true
  SLSKD_BASE_URL: http://slskd:5030
  SLSKD_DOWNLOADS_DIR: /slskd-downloads
  # If slskd has web auth enabled:
  # SLSKD_USERNAME: your_web_username
  # SLSKD_PASSWORD: your_web_password

How It Works

yoink sends a search query to slskd's REST API (artist + album + track name)
slskd searches the SoulSeek network for matching files
yoink scores the candidates and picks the best match
slskd downloads the file from the SoulSeek peer
yoink reads the completed file, tags it with metadata, and moves it to MUSIC_ROOT

SoulSeek downloads depend on peer availability. Downloads may be slow or fail if no online peer is sharing the file you need.

Environment Variables

Variable	Description	Default
`SOULSEEK_ENABLED`	Enable or disable SoulSeek	`false`
`SLSKD_BASE_URL`	slskd REST API endpoint	`http://127.0.0.1:5030`
`SLSKD_USERNAME`	slskd web auth username
`SLSKD_PASSWORD`	slskd web auth password
`SLSKD_DOWNLOADS_DIR`	Path where slskd stores completed downloads	`slskd-data/downloads`

SoulSeek