Getting Started
Get yoink up and running in minutes.
There are two ways to deploy yoink:
Docker Compose
Recommended. One command to get everything running.
From Source
Build and run locally for development or custom deployments.
Before You Start
yoink needs at least one download source to be useful:
- Tidal - accepts a self-hosted hifi-api proxy or uses publicly available instances
- SoulSeek - requires a running slskd instance
Metadata-only providers (Deezer, MusicBrainz) enrich your library with additional artist and album information but cannot download audio files. They are enabled by default and require no configuration.
After Installation
Once yoink is running, you'll want to:
- Configure your providers - especially your download sources
- Review your settings - audio quality, parallel downloads, lyrics
- Search for music - find and add artists to your library