-
-
Notifications
You must be signed in to change notification settings - Fork 6
Environment Variables
Fabio Valentino edited this page Sep 20, 2024
·
9 revisions
Name | Info | Default | Mandatory |
---|---|---|---|
SPOTIPY_CLIENT_ID | Get this from https://developer.spotify.com/dashboard | None | Yes |
SPOTIPY_CLIENT_SECRET | Get this from https://developer.spotify.com/dashboard | None | Yes |
SPOTIPY_REDIRECT_URI | Get this from https://developer.spotify.com/dashboard | http://127.0.0.1:8080/ | Yes |
SUBSONIC_API_HOST | Subsonic API host, with http:// or https:// | None | Yes |
SUBSONIC_API_PORT | Subsonic API port | None | Yes |
SUBSONIC_API_USER | Subsonic API user | None | Yes |
SUBSONIC_API_PASS | Subsonic API password | None | Yes |
SUBSONIC_API_BASE_URL | Subsonic API Base Url, if your Navidrome ND_BASEURL param is "/music", set this to /music | Empty | No |
ITEMS_PER_PLAYLIST | How many items per playlists for recommendations playlists, take care to not set this too high | 100 | No |
PLAYLIST_PREFIX | Playlists prefix name, every Spotisub created playlist will have this prefix for better filtering, if set Empty playlists won't have a prefix | "Spotisub - " | No |
EXCLUDED_WORDS | List of excluded words separated by comma used to filter search results from the subsonic library, working only in case of text comparison, not working if ISRCs matches | acoustic,instrumental,demo | No |
NUM_USER_PLAYLISTS | How many custom recommendations playlist to generate | 5 | No |
SCHEDULER_ENABLED | Set to 0 to disable the integrated scheduler, you will need to use the rest APIs if you disable this | 1 | No |
ARTIST_GEN_SCHED | Interval in hours to schedule the artists recommendations generation, set to 0 to disable this generator | 1 | No |
ARTIST_TOP_GEN_SCHED | Interval in hours to schedule the top artists playlist import, set to 0 to disable this generator | 1 | No |
RECOMEND_GEN_SCHED | Interval in hours to schedule the custom recommendations generation, set to 0 to disable this generator | 4 | No |
PLAYLIST_GEN_SCHED | Interval in hours to schedule the custom playlist import, set to 0 to disable this generator | 3 | No |
SAVED_GEN_SCHED | Interval in hours to schedule the saved tracks playlist import, set to 0 to disable this generator | 2 | No |
SPOTDL_ENABLED | Automate the missing track download process using spotdl, set to 1 to enable | 0 | No |
SPOTDL_OUT_FORMAT | Spotdl output format, included the full absolute path to your music directory | "/music/{artist}/{artists} - {album} ({year}) - {track-number} - {title}.{output-ext}" | Yes if SPOTDL_ENABLED is 1 |
LIDARR_ENABLED | Set to 1 to enable Lidarr integration, used altogether with spotdl. If lidarr is enabled and an artist isn't found in lidarr library, the matching song won't be downloaded | 0 | no |
LIDARR_IP | Lidarr IP | Empty | Yes if LIDARR_ENABLED is 1 |
LIDARR_PORT | Lidarr port number | Empty | Yes if LIDARR_ENABLED is 1 |
LIDARR_BASE_API_PATH | Lidarr base path, usually you don't need to edit this | Empty | No |
LIDARR_TOKEN | Your Lidarr API Key. Get this in Lidarr > Settings > General > Security | Empty | Yes if LIDARR_ENABLED is 1 |
LIDARR_USE_SSL | Set to 1 if you are using a SSL certificate | 0 | No |
LOG_LEVEL | Log level | 40 | No |
Remember to add volume mapping to your music inside docker-compose file if you enable SPOTDL:
- "/path/to/your/music:/music"
For spotdl format examples please refer to: https://spotdl.github.io/spotify-downloader/usage/
Installing Spotisub
Configuring Spotisub
GUI
Rest API