Skip to content

Commit

Permalink
document changes
Browse files Browse the repository at this point in the history
  • Loading branch information
LumePart committed Jan 12, 2025
1 parent b26e2ce commit 9aa70c3
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions sample.env
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Music system you use (jellyfin, mpd, plex or subsonic)
# Music system you use (emby, jellyfin, mpd, plex or subsonic)
EXPLO_SYSTEM=subsonic
# Address of music system (required for jellyfin, plex and subsonic)
# Address of music system (required for emby, jellyfin, plex and subsonic)
SYSTEM_URL=http://127.0.0.1:4533
# User which has admin access to the music server (required for subsonic and plex)
SYSTEM_USERNAME=
# Password for the user (required for subsonic and plex)
SYSTEM_PASSWORD=
# API Key from music server (required for jellyfin)
# API Key from music server (required for emby, jellyfin)
API_KEY=
# Directory where to download tracks (required)
# PS! It's recommended to make a separate directory (under the music library) for Explo
Expand All @@ -27,6 +27,7 @@ YOUTUBE_API_KEY=
# Keywords to ignore on videos downloaded by youtube (separated by only commas)
# FILTER_LIST="live,remix,instrumental"
# Library in Jellyfin/Plex to use (optional, leave empty to create a new library based on DOWNLOAD_DIR)
# PS! When defining a pre-made library make sure that it doesn't overwrite file metadata.
# LIBRARY_NAME=
# Define a custom filename sepatator for special characters
# FILENAME_SEPARATOR=
Expand All @@ -35,11 +36,11 @@ YOUTUBE_API_KEY=
# 'playlist' to get tracks from Weekly Exploration playlist, anything else gets it from API (not the best recommendations). 'test' will download 1 song
# LISTENBRAINZ_DISCOVERY=playlist
# Time to sleep (in minutes) between scanning and querying tracks from your system (If using Subsonic, Jellyfin)
# SLEEP=1
# SLEEP=2
# Whether to provide additional info for debugging
# DEBUG=false

## Metadata (formatting details, structure, etc.)

# true keeps only the main artist in the artist field; all featured artists go to the title (helps with keeping library clean, might limit ListenBrainz for recognizing the song)
# SINGLE_ARTIST=false
# SINGLE_ARTIST=true

0 comments on commit 9aa70c3

Please sign in to comment.