Update sample env; reorganize

Add PUID/GID support to Docker container

Fixup rebase

Author: avedor

Dockerfile

@@ -12,12 +12,14 @@ RUN GOOS=linux GOARCH=$TARGETARCH go build -o explo ./src/main/
 
 FROM python:3.12-alpine
 
-# Install runtime deps: libc compat, ffmpeg, yt-dlp, tzdata
+# Install runtime deps: libc compat, ffmpeg, yt-dlp, tzdata, shadow for user management, su-exec for user switching
 RUN apk add --no-cache \
     libc6-compat \
     ffmpeg \
     yt-dlp \
-    tzdata 
+    tzdata \
+    shadow \
+    su-exec 
 
 # Install ytmusicapi in the container
 RUN pip install --no-cache-dir ytmusicapi
@@ -33,7 +35,11 @@ COPY src/downloader/youtube_music/search_ytmusic.py .
 
 RUN chmod +x /start.sh ./explo
 
-# Can be defined from compose as well 
+# Can be defined from compose as well
 ENV WEEKLY_EXPLORATION_SCHEDULE="15 0 * * 2"
 
+# Default PUID and PGID
+ENV PUID=1000
+ENV PGID=1000
+
 CMD ["/start.sh"]

docker-compose.yaml

@@ -10,6 +10,8 @@ services:
       # - $PLAYLIST_DIR:$PLAYLIST_DIR # for MPD. Both paths should be as defined in .env (e.g /my/playlists/:/my/playlists/)
     environment:
       - TZ=UTC # Change this to the timezone set in ListenBrainz (default is UTC)
+      - PUID=1000 # User ID for file permissions (optional, defaults to 1000)
+      - PGID=1000 # Group ID for file permissions (optional, defaults to 1000)
 
       - WEEKLY_EXPLORATION_SCHEDULE=15 00 * * 2 # Runs weekly, every Tuesday 15 minutes past midnight
       - WEEKLY_EXPLORATION_FLAGS= # Run weekly exploration with default settings

docker/start.sh

@@ -1,9 +1,45 @@
 #!/bin/sh
+
+# Handle PUID/PGID
+if [ "$PUID" != "0" ] && [ "$PGID" != "0" ]; then
+    echo "[setup] Setting up user with PUID=$PUID and PGID=$PGID"
+
+    # Create group if it doesn't exist
+    if ! getent group explo > /dev/null 2>&1; then
+        groupadd -g "$PGID" explo
+    fi
+
+    # Create user if it doesn't exist
+    if ! getent passwd explo > /dev/null 2>&1; then
+        useradd -u "$PUID" -g "$PGID" -d /opt/explo -s /bin/sh explo
+    fi
+
+    # Ensure explo user owns the working directory and data directory
+    chown -R explo:explo /opt/explo
+    [ -d /data ] && chown -R explo:explo /data
+
+    # If running as non-root, exec as the explo user
+    if [ "$(id -u)" = "0" ]; then
+        exec su-exec explo "$0" "$@"
+    fi
+fi
+
 echo "[setup] Initializing cron jobs..."
 
+# Determine which user to run cron jobs as
+CRON_USER="root"
+if [ "$PUID" != "0" ] && [ "$PGID" != "0" ]; then
+    CRON_USER="explo"
+    # Create crontab directory for explo user if it doesn't exist
+    mkdir -p /var/spool/cron/crontabs
+    touch "/var/spool/cron/crontabs/$CRON_USER"
+    chown "$CRON_USER:$CRON_USER" "/var/spool/cron/crontabs/$CRON_USER"
+fi
+
 if [ -n "$CRON_SCHEDULE" ]; then
-    echo "$CRON_SCHEDULE apk add --upgrade yt-dlp && cd /opt/explo && ./explo >> /proc/1/fd/1 2>&1" > /etc/crontabs/root
-    chmod 600 /etc/crontabs/root
+    cmd="apk add --upgrade yt-dlp && cd /opt/explo && ./explo >> /proc/1/fd/1 2>&1"
+    echo "$CRON_SCHEDULE $cmd" > "/var/spool/cron/crontabs/$CRON_USER"
+    chmod 600 "/var/spool/cron/crontabs/$CRON_USER"
     echo "[setup] Registered single CRON_SCHEDULE job: $CRON_SCHEDULE"
     crond -f -l 2
 fi
@@ -23,13 +59,13 @@ for var in $(env | grep "_SCHEDULE=" | cut -d= -f1); do
   # Default: just run explo if flags are empty
   cmd="apk add --upgrade yt-dlp && cd /opt/explo && ./explo $flags >> /proc/1/fd/1 2>&1"
 
-  echo "$schedule $cmd" >> /etc/crontabs/root
+  echo "$schedule $cmd" >> "/var/spool/cron/crontabs/$CRON_USER"
   echo "[setup] Registered job: $job"
   echo "        Schedule: $schedule"
   echo "        Command : ./explo $flags"
 done
 
-chmod 600 /etc/crontabs/root
+chmod 600 "/var/spool/cron/crontabs/$CRON_USER"
 
 echo "[setup] Starting cron..."
 crond -f -l 2

go.sum

@@ -57,15 +57,14 @@ golang.org/x/image v0.0.0-20191009234506-e7c1f5e7dbb8/go.mod h1:FeLwcggjj3mMvU+o
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/net v0.0.0-20201110031124-69a78807bb2b h1:uwuIcX0g4Yl1NC5XAz37xsr2lTtcqevgzYNVt49waME=
 golang.org/x/net v0.0.0-20201110031124-69a78807bb2b/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
-golang.org/x/sync v0.15.0 h1:KWH3jNZsfyT6xfAfKiz6MRNmd46ByHDYaZ7KSkCtdW8=
-golang.org/x/sync v0.15.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA=
+golang.org/x/sync v0.17.0 h1:l60nONMj9l5drqw6jlhIELNv9I0A4OFgRsG9k2oT9Ug=
+golang.org/x/sync v0.17.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20200602225109-6fdc65e7d980/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
-golang.org/x/text v0.3.3 h1:cokOdA+Jmi5PJGXLlLllQSgYigAEfHXJAERHVMaCc2k=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.29.0 h1:1neNs90w9YzJ9BocxfsQNHKuAT4pkghyXc4nhZ6sJvk=
 golang.org/x/text v0.29.0/go.mod h1:7MhJOA9CD2qZyOKYazxdYMF85OwPdEr9jTtBpO7ydH4=

sample.env

@@ -69,6 +69,17 @@ YOUTUBE_API_KEY=
 # Minimal Bitrate (default: 256)
 # MIN_BITRATE=256
 
+# === Lidarr Configuration ===
+
+# LIDARR_API_KEY=
+# LIDARR_RETRY=
+# LIDARR_DL_ATTEMPTS=
+# LIDARR_DIR=
+# MIGRATE_DOWNLOADS=
+# LIDARR_TIMEOUT=
+# LIDARR_SCHEME=
+# LIDARR_URL=
+
 # === Metadata / Formatting ===
 
 # Set to true to merge featured artists into title (recommended), false appends them to artist field (default: true)

src/config/config.go

@@ -54,19 +54,6 @@ type Credentials struct {
 	Salt     string
 }
 
-type DiscoveryConfig struct {
-	Discovery    string `env:"DISCOVERY_SERVICE" env-default:"listenbrainz"`
-	Separator    string `env:"FILENAME_SEPARATOR" env-default:" "`
-	Listenbrainz Listenbrainz
-}
-
-type Filters struct {
-	Extensions  []string `env:"EXTENSIONS" env-default:"flac,mp3"`
-	MinBitDepth int      `env:"MIN_BIT_DEPTH" env-default:"8"`
-	MinBitRate  int      `env:"MIN_BITRATE" env-default:"256"`
-	FilterList  []string `env:"FILTER_LIST" env-default:"live,remix,instrumental,extended"`
-}
-
 type Lidarr struct {
 	APIKey           string        `env:"LIDARR_API_KEY"`
 	Retry            int           `env:"LIDARR_RETRY" env-default:"5"`       // Number of times to check search status before skipping the track
@@ -98,6 +85,13 @@ type DownloadConfig struct {
 	Services     []string `env:"DOWNLOAD_SERVICES" env-default:"youtube"`
 }
 
+type Filters struct {
+	Extensions  []string `env:"EXTENSIONS" env-default:"flac,mp3"`
+	MinBitDepth int      `env:"MIN_BIT_DEPTH" env-default:"8"`
+	MinBitRate  int      `env:"MIN_BITRATE" env-default:"256"`
+	FilterList  []string `env:"FILTER_LIST" env-default:"live,remix,instrumental,extended"`
+}
+
 type Youtube struct {
 	APIKey     string `env:"YOUTUBE_API_KEY"`
 	FfmpegPath string `env:"FFMPEG_PATH"`
@@ -128,17 +122,19 @@ type SlskdMon struct {
 	Duration time.Duration `env:"SLSKD_MONITOR_DURATION" env-default:"15m"`
 }
 
+type DiscoveryConfig struct {
+	Discovery    string `env:"DISCOVERY_SERVICE" env-default:"listenbrainz"`
+	Listenbrainz Listenbrainz
+}
+
 type Listenbrainz struct {
 	Discovery      string `env:"LISTENBRAINZ_DISCOVERY" env-default:"playlist"`
 	User           string `env:"LISTENBRAINZ_USER"`
 	ImportPlaylist string
 	SingleArtist   bool `env:"SINGLE_ARTIST" env-default:"true"`
 }
 
-func (cfg *Config) ReadEnv() {
-}
-
-func ReadEnv() Config {
+func ReadEnv() {
 	var cfg Config
 
 	// Try to read from .env file first

src/downloader/lidarr.go

@@ -301,6 +301,21 @@ func (c Lidarr) findBestAlbumMatch(track *models.Track) (*Album, error) {
 	return &topMatch, nil
 }
 
+func (c Lidarr) getDownloadStatus() (DownloadStatus, error) {
+	reqParams := "/api/v0/transfers/downloads"
+
+	body, err := c.HttpClient.MakeRequest("GET", c.Cfg.URL+reqParams, nil, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	var status DownloadStatus
+	if err := util.ParseResp(body, &status); err != nil {
+		return nil, err
+	}
+	return status, nil
+}
+
 func (c Lidarr) MonitorDownloads(tracks []*models.Track) error {
 	monitorCfg := MonitorConfig{
 		CheckInterval:   1 * time.Minute,
@@ -322,21 +337,6 @@ func (c Lidarr) MonitorDownloads(tracks []*models.Track) error {
 	return nil
 }
 
-func (c Lidarr) getDownloadStatus() (DownloadStatus, error) {
-	reqParams := "/api/v0/transfers/downloads"
-
-	body, err := c.HttpClient.MakeRequest("GET", c.Cfg.URL+reqParams, nil, nil)
-	if err != nil {
-		return nil, err
-	}
-
-	var status DownloadStatus
-	if err := util.ParseResp(body, &status); err != nil {
-		return nil, err
-	}
-	return status, nil
-}
-
 func (c Lidarr) cleanupTrack(track *models.Track, fileID string) {
 	if err := c.deleteSearch(track.ID); err != nil {
 		debug.Debug(fmt.Sprintf("[slskd] failed to delete search request: %v", err))