yoink

Configuration

Complete environment variable reference for yoink.

All configuration is done via environment variables. In Docker, set them in the environment: block of your compose.yaml. When running from source, use a .env file.

Core Settings

VariableDescriptionDefault
MUSIC_ROOTDirectory where tagged downloads are saved./music (Docker: /music)
DATABASE_URLSQLite connection stringsqlite:./yoink.db?mode=rwc (Docker: sqlite:/data/yoink.db?mode=rwc)
DEFAULT_QUALITYPreferred audio quality. See quality levels.LOSSLESS
DOWNLOAD_MAX_PARALLEL_TRACKSConcurrent track downloads per album job (1–16)1
DOWNLOAD_LYRICSAuto-fetch lyrics from LRCLib and embed in filesfalse
LOG_FORMATLog output format: pretty or jsonpretty

Provider Toggles

Each provider can be independently enabled or disabled.

VariableDefault
TIDAL_ENABLEDtrue
DEEZER_ENABLEDtrue
MUSICBRAINZ_ENABLEDtrue
SOULSEEK_ENABLEDfalse

See the Providers section for provider-specific configuration.

Tidal

VariableDescriptionDefault
TIDAL_API_BASE_URLURL of your hifi-api proxy

SoulSeek / slskd

VariableDescriptionDefault
SLSKD_BASE_URLslskd REST API endpointhttp://127.0.0.1:5030
SLSKD_USERNAMEslskd web auth username (leave blank if auth is disabled)
SLSKD_PASSWORDslskd web auth password
SLSKD_DOWNLOADS_DIRLocal path where slskd stores completed downloadsslskd-data/downloads

Authentication

VariableDescriptionDefault
AUTH_DISABLEDDisable authentication entirelyfalse
AUTH_SESSION_SECRETSession signing secret. Required when auth is enabled.
AUTH_INIT_ADMIN_USERNAMEBootstrap admin username (first boot only)
AUTH_INIT_ADMIN_PASSWORDBootstrap admin password (first boot only)

See the authentication page for setup details.

Docker-Only Settings

VariableDescriptionDefault
PUIDUser ID for the container process1000
PGIDGroup ID for the container process1000

On this page