-
Notifications
You must be signed in to change notification settings - Fork 13
Expand file tree
/
Copy pathsample.env
More file actions
130 lines (106 loc) · 4.65 KB
/
sample.env
File metadata and controls
130 lines (106 loc) · 4.65 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
# === Discovery Config ===
# Service which recommends songs (only 'listenbrainz' is supported)
# DISCOVERY_SERVICE=listenbrainz
# Your ListenBrainz username
LISTENBRAINZ_USER=
# 'playlist' to fetch weekly playlist (50 songs), 'api' for fewer songs (good for testing) (default: playlist)
# LISTENBRAINZ_DISCOVERY=playlist
# === Music System Configuration ===
# Music system you use: emby, jellyfin, mpd, plex or subsonic
EXPLO_SYSTEM=
# Address of your media system (e.g. http://127.0.0.1:4533)
SYSTEM_URL=
# Username with access to system (required for all except mpd)
SYSTEM_USERNAME=
# Password for the user (required for subsonic, recommended for plex)
SYSTEM_PASSWORD=
# Optional admin username for systems like Navidrome/Subsonic (used only for triggering library scans)
# ADMIN_SYSTEM_USERNAME=
# Optional admin password for systems like Navidrome/Subsonic (used only for triggering library scans)
# ADMIN_SYSTEM_PASSWORD=
# API Key from your media system (required for emby and jellyfin, optional for plex)
API_KEY=
# Name of the music library in your system (emby, jellyfin, plex)
LIBRARY_NAME=
# Mark playlist as public (subsonic)
# PUBLIC_PLAYLIST=false
# === Downloader Configuration ===
# Directory to store downloaded tracks. It's recommended to make a separate directory (under the music library) for Explo
# PS! This is only needed when running the binary version, in docker it's set through volume mapping
# DOWNLOAD_DIR=/path/to/musiclibrary/explo/
# Download/move tracks to a subdirectory named after the playlist
# USE_SUBDIRECTORY=true
# Keep original file permissions when moving files (set to false on Synology devices)
# KEEP_PERMISSIONS=true
# Comma-separated list (no spaces) of download services, in priority order (default: youtube)
# DOWNLOAD_SERVICES=youtube
# Directory for writing .m3u playlists (required only for MPD)
# PLAYLIST_DIR=/path/to/playlist/folder/
# === YouTube Configuration ===
# YouTube Data API key (required if using youtube)
YOUTUBE_API_KEY=
# Custom file extension for tracks (e.g mp3) (default: opus)
# TRACK_EXTENSION=opus
# Custom path to ffmpeg binary (default: defined in $PATH)
# FFMPEG_PATH=
# Custom path to yt-dlp binary (default: defined in $PATH)
# YTDLP_PATH=
# Path to (optional) cookies file (default: ./cookies.txt) (in docker this is set through volume mapping)
# COOKIES_PATH=./cookies.txt
# Comma-separated (without spaces) keywords to exclude from YouTube results (default: live,remix,instrumental,extended,clean,acapella)
# FILTER_LIST=live,remix,instrumental,extended
# === Slskd Configuration ===
# Slskd instance address (requires running instance)
# SLSKD_URL=
# Slskd API key
# SLSKD_API_KEY=
# Whether to move downloads under the DOWNLOAD_DIR or not (default: false)
# MIGRATE_DOWNLOADS=false
# Rename migrated track in {artist}-{title} format
# RENAME_TRACK=false
# Directory where slskd downloads tracks (default: /slskd/)
# PS! This is only needed on the binary version, in docker it's set through volume mapping
# SLSKD_DIR=/slskd/
# Number of times to check search status before skipping the track (default: 5)
# SLSKD_RETRY=5
# Number of download attempts for a track (default: 3)
# SLSKD_DL_ATTEMPTS=3
## Slskd Filtering
# Comma-separated (without spaces) file extensions to download from (default: flac,mp3)
# EXTENSIONS=flac,mp3
# Minimal Bit Depth (default: 8)
# MIN_BIT_DEPTH=8
# Minimal Bitrate (default: 256)
# MIN_BITRATE=256
# Comma-separated (without spaces) keywords to avoid, when filtering slskd results (default: live,remix,instrumental,extended,clean,acapella)
# FILTER_LIST=live,remix,instrumental,extended,clean,acapella
# === Metadata / Formatting ===
# Set to true to merge featured artists into title (recommended), false appends them to artist field (default: true)
# SINGLE_ARTIST=true
# Playlist name format: week (Weekly-Exploration-2026-Week5) or date (Weekly-Exploration-2026-01-31)
# PLAYLISTNAME_FORMAT=week
# === Notifications ===
## Discord
# Application's (bot) token
# DISCORD_BOT_TOKEN=
# Channel ID where to send notifications (supports multiple IDs, use comma (without spaces) to separate them)
# DISCORD_CHANNEL_ID=
## HTTP
# HTTP URL to send POST requests to (supports multiple URLs, use comma (without spaces) to separate them)
# HTTP_RECEIVER=
## Matrix
# User ID for Matrix
# MATRIX_USERID=
# Room ID to send notifications in
# MATRIX_ROOMID=
# Homeserver URL that the room is created in
# MATRIX_HOMESERVER_URL=
# Users Access token
# MATRIX_ACCESSTOKEN=
# === Misc ===
# Minutes to sleep between library scans (default: 2)
# SLEEP=2
# Set the log level (DEBUG, INFO, WARN, ERROR) (default: INFO)
# LOG_LEVEL=INFO
# Set a custom HTTP timeout for music servers (in seconds) (default: 10)
# CLIENT_HTTP_TIMEOUT=10