migrate to librespot and s6-overlay

Dockerfile

@@ -1,31 +1,37 @@
 FROM ubuntu:latest
 
+# set version for s6 overlay
+ARG S6_OVERLAY_VERSION="3.2.0.2"
+ARG S6_OVERLAY_ARCH="x86_64"
+
 RUN usermod -aG audio ubuntu
 
 RUN apt update && apt upgrade -y \
  && apt install -y \
     darkice \
     icecast2 \
+    iproute2 \
     pulseaudio \
- && apt clean \
- && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* ~/.cache /root/.cache
-
-COPY darkice.cfg /etc/darkice.cfg
-
-COPY spotifyd.conf /etc/spotifyd.conf
+    wget \
+    xz-utils \
+ && apt clean
 
-COPY spotifyd /usr/local/bin/spotifyd
-RUN chmod +x /usr/local/bin/spotifyd
+# add s6 overlay
+ADD https://github.com/just-containers/s6-overlay/releases/download/v${S6_OVERLAY_VERSION}/s6-overlay-noarch.tar.xz /tmp
+RUN tar -C / -Jxpf /tmp/s6-overlay-noarch.tar.xz
+ADD https://github.com/just-containers/s6-overlay/releases/download/v${S6_OVERLAY_VERSION}/s6-overlay-${S6_OVERLAY_ARCH}.tar.xz /tmp
+RUN tar -C / -Jxpf /tmp/s6-overlay-${S6_OVERLAY_ARCH}.tar.xz
 
-COPY configure.sh /usr/local/bin/configure.sh
-RUN chmod +x /usr/local/bin/configure.sh
+# add s6 optional symlinks
+ADD https://github.com/just-containers/s6-overlay/releases/download/v${S6_OVERLAY_VERSION}/s6-overlay-symlinks-noarch.tar.xz /tmp
+RUN tar -C / -Jxpf /tmp/s6-overlay-symlinks-noarch.tar.xz
+ADD https://github.com/just-containers/s6-overlay/releases/download/v${S6_OVERLAY_VERSION}/s6-overlay-symlinks-arch.tar.xz /tmp
+RUN tar -C / -Jxpf /tmp/s6-overlay-symlinks-arch.tar.xz
 
-COPY start.sh /usr/local/bin/start.sh
-RUN chmod +x /usr/local/bin/start.sh
+RUN rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* ~/.cache /root/.cache
 
-COPY entry.sh /usr/local/bin/entry.sh
-RUN chmod +x /usr/local/bin/entry.sh
+ADD rootfs /
 
 EXPOSE 8000
 
-ENTRYPOINT ["/usr/local/bin/entry.sh"]
+ENTRYPOINT ["/init"]

README.md

@@ -6,7 +6,7 @@ Stream your Spotify collection
 
 A docker image that creates a new device on Spotify (called "Daemon"), which streams what you're listening to Icecast.
 
-It uses the excellent [spotifyd](https://github.com/Spotifyd/spotifyd).
+It uses the excellent [librespot](https://github.com/librespot-org/librespot).
 
 ## How?
 
@@ -16,11 +16,15 @@ services:
   spotify-stream:
     container_name: spotify-stream
     environment:
-    - SPOTIFY_DEVICE_NAME=Daemon
+    - LIBRESPOT_DEVICE_NAME=Daemon
     # possible values: audiodongle, avr, computer, smartphone, speaker, stb, tablet, tv
-    - SPOTIFY_DEVICE_TYPE=computer
-    - SPOTIFY_INITIAL_VOLUME=90
-    - SPOTIFY_ZEROCONF_PORT=1234
+    - LIBRESPOT_DEVICE_TYPE=computer
+    - LIBRESPOT_CACHE=/spotify-stream/cache
+    - LIBRESPOT_INITIAL_VOLUME=90
+    - LIBRESPOT_ZEROCONF_PORT=1234
+    - [email protected]
+    - ICECAST_HOSTNAME=my.ip.address
+    - ICECAST_LOCATION=New\ York
     - ICECAST_USERNAME=admin
     - ICECAST_PASSWORD=spotify
     - DARKICE_MOUNT_POINT=spotify
@@ -29,15 +33,17 @@ services:
     image: meiser79/spotify-stream:latest
     network_mode: host
     restart: unless-stopped
+    volumes:
+    - ./cache:/spotify-stream/cache
 ```
 
 Then connect to the stream via `http://my.ip.address:8000/spotify`.
 
 ## Disclaimer
 
-[spotifyd](https://github.com/Spotifyd/spotifyd) binary was compiled via `cargo build --release --features pulseaudio_backend` and was included here to accelerate building time. You should compile it by yourself.
+[librespot](https://github.com/librespot-org/librespot) binary was compiled via `cargo build --release --no-default-features --features "pulseaudio-backend with-libmdns"` and was included here to accelerate building time. You should compile it by yourself.
 
 ## Legal
-Spotify Stream is licensed under MIT.
+Spotify Stream is licensed under MIT, it's based on [Trugamr's project](https://github.com/Trugamr/spotify-stream).
 
 SPOTIFY is a trademark of Spotify AB.

rootfs/etc/librespot.conf

@@ -0,0 +1,109 @@
+# Please see https://github.com/librespot-org/librespot/wiki/Options
+# for configuration details and a full list of options and flags.
+
+# You can also find a full list with `librespot -h`.
+
+# To avoid name collisions environment variables must be prepended with
+# `LIBRESPOT_`, so option/flag `foo-bar` becomes `LIBRESPOT_FOO_BAR`.
+
+# Invalid environment variables will be ignored.
+
+# default values may vary from librespot defaults.
+# Commenting out the environment variable will fallback to librespot's default
+# unless otherwise noted.
+
+# Flags can be set to either "on" or "off".
+# Empty values may cause errors.
+
+# Only log warning and error messages.
+LIBRESPOT_QUIET=off
+
+# Automatically play similar songs when your music ends.
+# Respects client autoplay setting if commented out. Forces autoplay on or off when active.
+# This value is either "on" or "off".
+LIBRESPOT_AUTOPLAY=off
+
+# Disable caching of the audio data.
+# Enabling audio data caching can take up a lot of space
+# if you don't limit the cache size with LIBRESPOT_CACHE_SIZE_LIMIT.
+# It can also wear out your Micro SD card. You have been warned. 
+LIBRESPOT_DISABLE_AUDIO_CACHE=on
+
+# Disable caching of credentials.
+# Caching of credentials is not necessary so long as
+# LIBRESPOT_DISABLE_DISCOVERY is not set.
+LIBRESPOT_DISABLE_CREDENTIAL_CACHE=off
+
+# Play all tracks at approximately the same apparent volume.
+LIBRESPOT_ENABLE_VOLUME_NORMALISATION=on
+
+# Enable verbose log output.
+#LIBRESPOT_VERBOSE=off
+
+# Disable zeroconf discovery mode.
+#LIBRESPOT_DISABLE_DISCOVERY=off
+
+# Options will fallback to their defaults if commented out,
+# otherwise they must have a valid value.
+
+# Device name.
+# Librespot defaults to "Librespot".
+LIBRESPOT_DEVICE_NAME="Deamon"
+
+# Bitrate (kbps) {96|160|320}. Defaults to 160.
+LIBRESPOT_BITRATE="320"
+
+# Output format {F64|F32|S32|S24|S24_3|S16}. Defaults to S16.
+#LIBRESPOT_FORMAT="S16"
+
+# Displayed device type. Defaults to speaker.
+LIBRESPOT_DEVICE_TYPE="computer"
+
+# Limits the size of the cache for audio files.
+# It's possible to use suffixes like K, M or G, e.g. 16G for example.
+# Highly advised if audio caching isn't disabled. Otherwise the cache
+# size is only limited by disk space.
+#LIBRESPOT_CACHE_SIZE_LIMIT=""
+
+# Audio backend to use, alsa or pulseaudio. Defaults to alsa.
+LIBRESPOT_BACKEND="pulseaudio"
+
+# Username used to sign in with.
+# Credentials are not required if LIBRESPOT_DISABLE_DISCOVERY is not set.
+#LIBRESPOT_USERNAME=""
+
+# Password used to sign in with.
+#LIBRESPOT_PASSWORD=""
+
+# Audio device to use, use `librespot --device ?` to list options.
+# Defaults to the system's default.
+#LIBRESPOT_DEVICE="default"
+
+# Initial volume in % from 0 - 100.
+# Defaults to 50 For the alsa mixer: the current volume.
+LIBRESPOT_INITIAL_VOLUME="90"
+
+# Volume control scale type {cubic|fixed|linear|log}.
+# Defaults to log.
+#LIBRESPOT_VOLUME_CTRL="log"
+
+# Range of the volume control (dB) from 0.0 to 100.0.
+# Default for softvol: 60.0.
+# For the alsa mixer: what the control supports.
+#LIBRESPOT_VOLUME_RANGE="60.0"
+
+# Pregain (dB) applied by volume normalisation from -10.0 to 10.0.
+# Defaults to 0.0.
+#LIBRESPOT_NORMALISATION_PREGAIN="0.0"
+
+# Threshold (dBFS) at which point the dynamic limiter engages
+# to prevent clipping from 0.0 to -10.0.
+# Defaults to -2.0.
+#LIBRESPOT_NORMALISATION_THRESHOLD="-2.0"
+
+# The port the internal server advertises over zeroconf 1 - 65535.
+# Ports <= 1024 may require root privileges.
+LIBRESPOT_ZEROCONF_PORT="1234"
+
+# HTTP proxy to use when connecting.
+#LIBRESPOT_PROXY=""

rootfs/etc/s6-overlay/s6-rc.d/init-darkice/run

@@ -0,0 +1,9 @@
+#!/usr/bin/with-contenv bash
+
+echo "🔑 updating darkice credentials"
+sed -i -r "s/^password.*$/password = $ICECAST_PASSWORD/" /etc/darkice.cfg 
+
+echo "🔨 updating darkice config"
+sed -i -r "s/^mountPoint.*$/mountPoint = $DARKICE_MOUNT_POINT/" /etc/darkice.cfg
+sed -i -r "s/^name.*$/name = $DARKICE_NAME/" /etc/darkice.cfg
+sed -i -r "s/^description.*$/description = $DARKICE_DESCRIPTION/" /etc/darkice.cfg

rootfs/etc/s6-overlay/s6-rc.d/init-darkice/type

@@ -0,0 +1 @@
+oneshot

rootfs/etc/s6-overlay/s6-rc.d/init-darkice/up

@@ -0,0 +1 @@
+/etc/s6-overlay/s6-rc.d/init-darkice/run

rootfs/etc/s6-overlay/s6-rc.d/init-icecast/run

@@ -0,0 +1,22 @@
+#!/usr/bin/with-contenv bash
+
+echo "🔑 updating icecast config"
+
+sed -i -r "s/(<admin>).*(<\\/admin>)/\1$ICECAST_ADMIN\2/ig" /etc/icecast2/icecast.xml
+sed -i -r "s/(<hostname>).*(<\\/hostname>)/\1$ICECAST_HOSTNAME\2/ig" /etc/icecast2/icecast.xml
+sed -i -r "s/(<location>).*(<\\/location>)/\1$ICECAST_LOCATION\2/ig" /etc/icecast2/icecast.xml
+sed -i -r "s/(<burst-on-connect>).*(<\\/burst-on-connect>)/\10\2/ig" /etc/icecast2/icecast.xml
+
+echo "🔑 updating icecast credentials"
+
+# update username
+sed -i -r "s/(<admin-user>).*(<\\/admin-user>)/\1$ICECAST_USERNAME\2/ig" /etc/icecast2/icecast.xml
+
+# update passwords
+for tag in source-password relay-password admin-password password
+do
+  sed -i -r "s/(<$tag>).*(<\\/$tag>)/\1$ICECAST_PASSWORD\2/ig" /etc/icecast2/icecast.xml
+done
+
+echo "🔨 updating icecast's metadata"
+wget -q -O - --user $ICECAST_USERNAME --password $ICECAST_PASSWORD http://localhost:8000/admin/metadata?mount=/$DARKICE_MOUNT_POINT\&mode=updinfo\&song="${DARKICE_NAME/\\/}"

rootfs/etc/s6-overlay/s6-rc.d/init-icecast/type

@@ -0,0 +1 @@
+oneshot

rootfs/etc/s6-overlay/s6-rc.d/init-icecast/up

@@ -0,0 +1 @@
+/etc/s6-overlay/s6-rc.d/init-icecast/run

rootfs/etc/s6-overlay/s6-rc.d/svc-darkice/run

@@ -0,0 +1,4 @@
+#!/usr/bin/with-contenv bash
+
+export HOME="$( getent passwd ubuntu | cut -d: -f6 )"
+exec s6-setuidgid ubuntu darkice -c /etc/darkice.cfg

rootfs/etc/s6-overlay/s6-rc.d/svc-darkice/type

@@ -0,0 +1 @@
+longrun

rootfs/etc/s6-overlay/s6-rc.d/svc-darkice/up

@@ -0,0 +1 @@
+/etc/s6-overlay/s6-rc.d/svc-darkice/run

rootfs/etc/s6-overlay/s6-rc.d/svc-dbus/run

@@ -0,0 +1,3 @@
+#!/usr/bin/with-contenv bash
+
+exec dbus-daemon --system --nofork

rootfs/etc/s6-overlay/s6-rc.d/svc-dbus/type

@@ -0,0 +1 @@
+longrun

rootfs/etc/s6-overlay/s6-rc.d/svc-dbus/up

@@ -0,0 +1 @@
+/etc/s6-overlay/s6-rc.d/svc-dbus/run

rootfs/etc/s6-overlay/s6-rc.d/svc-icecast/run

@@ -0,0 +1,3 @@
+#!/usr/bin/with-contenv bash
+
+exec s6-setuidgid icecast2 icecast2 -c /etc/icecast2/icecast.xml

rootfs/etc/s6-overlay/s6-rc.d/svc-icecast/type

@@ -0,0 +1 @@
+longrun

rootfs/etc/s6-overlay/s6-rc.d/svc-icecast/up

@@ -0,0 +1 @@
+/etc/s6-overlay/s6-rc.d/svc-icecast/run

rootfs/etc/s6-overlay/s6-rc.d/svc-librespot/run

@@ -0,0 +1,4 @@
+#!/usr/bin/with-contenv bash
+
+export HOME="$( getent passwd ubuntu | cut -d: -f6 )"
+exec s6-setuidgid ubuntu librespot --name $LIBRESPOT_DEVICE_NAME --device-type $LIBRESPOT_DEVICE_TYPE --backend pulseaudio --bitrate 320 --cache $LIBRESPOT_CACHE --disable-audio-cache --enable-volume-normalisation --initial-volume $LIBRESPOT_INITIAL_VOLUME --zeroconf-port $LIBRESPOT_ZEROCONF_PORT --autoplay off

rootfs/etc/s6-overlay/s6-rc.d/svc-librespot/type

@@ -0,0 +1 @@
+longrun

rootfs/etc/s6-overlay/s6-rc.d/svc-librespot/up

@@ -0,0 +1 @@
+/etc/s6-overlay/s6-rc.d/svc-librespot/run

rootfs/etc/s6-overlay/s6-rc.d/svc-pulseaudio/run

@@ -0,0 +1,4 @@
+#!/usr/bin/with-contenv bash
+
+export HOME="$( getent passwd ubuntu | cut -d: -f6 )"
+exec s6-setuidgid ubuntu pulseaudio

rootfs/etc/s6-overlay/s6-rc.d/svc-pulseaudio/type

@@ -0,0 +1 @@
+longrun

rootfs/etc/s6-overlay/s6-rc.d/svc-pulseaudio/up

@@ -0,0 +1 @@
+/etc/s6-overlay/s6-rc.d/svc-pulseaudio/run