Schema
threads
type: integer
notes: Number of threads to utilize.
Setting to -1 will use all available threads
anon_metrics_enable
type: bool
notes: If enabled, allows anonymous metrics. This allows capture of which run types and settings are used to understand app usage
deemix
arl
type: string
notes: Cookie required for Deezer download functionality.
download_path
type: string
notes: Path that spotify_sync will download songs into.
max_bitrate
type: string
oneOf: '128', '320', 'lossless'
notes: The highest download quality to attempt. '320' & 'lossless' require a Deezer Hi-Fi account.
skip_low_quality
type: boolean
notes: If true and max_bitrate > '128', check that the Deezer account has privileges to stream the requested quality. If not, exit before downloads commence.
This is especially useful if you rotate Deezer Hi-Fi free trials and don't want to accidentally download 128kbps once your trial has ended.
strict_matching
type: boolean
notes: If true, only successfully match a Spotify song to Deezer via it's ISRC. Setting to false allows fallback to Title - Artist - Album search.
spotify
username
type: string
notes: Your Spotify account username.
This can be found in your account overview, it is important it is set correctly
custom_application/enabled
type: boolean
notes: Whether to use your own Spotify OAuth2 application instead
OAuth2 is currently implemented via PCKE and access tokens stay on your device. However if you'd like to create and use you're own OAuth application you can
custom_application/client_id
type: string
notes: Client id of Spotify application.
custom_application/client_secret
type: string
notes: Client secret of Spotify application.
custom_application/scope
type: string
notes: The scope to use when authenticating to your Spotify account. If unsure, leave as default.
custom_application/redirect_uri_port
type: string
notes: Any usable host port, must match what application has been setup with. If unsure, leave as default.
playlists/enabled
type: boolean
notes: Include playlist songs in download
playlists/owner_only
type: boolean
notes: Only download playlists you've created yourself, not followed.
playlists/excluded
type: array of strings
notes: A list of playlists you wish to be excluded from download (case sensitive).
To view all playlists associated with your account run:
spotify_sync stats playlists
pushover
enabled
type: boolean
notes: Enable Pushover notifications for run modes.
user_key
type: string
notes: Pushover user key.
api_token
type: string
notes: Pushover token (per Pushover application).
autoscan
enabled
type: boolean
notes: Enable autoscan integration. Assumes you have set this up correctly and created rewrite rules if needed.
endpoint
type: string
notes: The API endpoint to POST to.
auth_enabled
type: boolean
notes: Enable basic auth
username
type: string
notes: Basic auth username
password
type: string
notes: Basic auth password
Last updated