Dockerfile

#################################################################
# ===  Build Node                                         ====  #
#
# Container to build GStreamer plugins written in Rust

FROM rust:slim-bullseye AS builder
LABEL org.opencontainers.image.authors="jojo141185"
LABEL org.opencontainers.image.source="https://github.com/jojo141185/mopidy-docker/"
# Automatic platform ARGs in the global scope
# This feature is only available when using the BuildKit backend.
ARG TARGETPLATFORM
ARG TARGETARCH
ARG TARGETVARIANT
# Define Image version [latest, develop, release]
ARG IMG_VERSION 

# Print Info about current build Target
RUN printf "I'm building for TARGETPLATFORM=${TARGETPLATFORM}" \
    && printf ", TARGETARCH=${TARGETARCH}" \
    && printf ", TARGETVARIANT=${TARGETVARIANT} \n" \
    && printf "With uname -s : " && uname -s \
    && printf "and  uname -m : " && uname -mm

RUN echo "Build Image in version: $IMG_VERSION"

# Switch to the root user while we do our changes
USER root

# Install build dependencies and libraries 
RUN apt-get update \
    && apt-get install -yq --no-install-recommends \
        build-essential \
        cmake \
        curl \
        jq \
        git \
        patch \
        libgstreamer-plugins-base1.0-dev \
        libgstreamer1.0-dev \
        libcsound64-dev \
        libclang-11-dev \
        libpango1.0-dev  \
        libdav1d-dev \
        # libgtk-4-dev \ Only in bookworm
    && rm -rf /var/lib/apt/lists/*

WORKDIR /usr/src/gst-plugins-rs

# ---------------------------------
# ---  GStreamer Plugins        ---
#
# Get source of gst-plugins-rs
#
# # - Select the branch or tag to use
# RUN if [ "$IMG_VERSION" = "latest" ]; then \
#         GST_PLUGINS_RS_TAG=main; \
#     elif [ "$IMG_VERSION" = "develop" ]; then \
#         GST_PLUGINS_RS_TAG=main; \
#     elif [ "$IMG_VERSION" = "release" ]; then \
#         GST_PLUGINS_RS_TAG=$(curl -s https://gitlab.freedesktop.org/api/v4/projects/gstreamer%2Fgst-plugins-rs/repository/tags | jq -r '.[0].name'); \
#     else \
#         echo "Invalid version info for gst-plugins-rs: $IMG_VERSION"; \
#         exit 1; \
#     fi \ 
#     && echo "Selected branch or tag for gst-plugins-rs: $GST_PLUGINS_RS_TAG" \
#     # - Clone repository of gst-plugins-rs to workdir
#     && git clone -c advice.detachedHead=false \
# 	--single-branch --depth 1 \
# 	--branch ${GST_PLUGINS_RS_TAG} \
# 	https://gitlab.freedesktop.org/gstreamer/gst-plugins-rs.git ./
#
# # - EXPERIMENTAL: For gstreamer-spotify set upgraded version number of dependency librespot to 0.4.2 
# RUN sed -i 's/librespot = { version = "0.4", default-features = false }/librespot = { version = "0.4.2", default-features = false }/g' audio/spotify/Cargo.toml

# We currently require a forked version of gstreamer-spotify plugin which supports token-based login
RUN GST_PLUGINS_RS_TAG="spotify-access-token-logging" \
    && echo "Selected branch or tag for gst-plugins-rs: $GST_PLUGINS_RS_TAG" \
    # - Clone repository of gst-plugins-rs to workdir
    && git clone -c advice.detachedHead=false \
    --single-branch --depth 1 \
    --branch ${GST_PLUGINS_RS_TAG} \
    https://gitlab.freedesktop.org/kingosticks/gst-plugins-rs.git ./


# Build GStreamer plugins written in Rust
#
# Set Cargo environment variables
# Enabling cargo's sparse registry protocol is the easiest fix for 
# Error "Value too large for defined data type;" on arm/v7 and linux/386
# https://github.com/rust-lang/cargo/issues/8719
#ENV CARGO_REGISTRIES_CRATES_IO_PROTOCOL sparse
ENV DEST_DIR /target/gst-plugins-rs
ENV CARGO_PROFILE_RELEASE_DEBUG false
# Cargo Build, with options:
# --release: do a release (not dev) build
# --no-default-features: disables the default features of the package (optional)
# --config net.git-fetch-with-cli=true: Uses command-line git instead of  built-in libgit2 to fix OOM Problem (exit code: 137) 
RUN export CSOUND_LIB_DIR="/usr/lib/$(uname -m)-linux-gnu" \
    && export PLUGINS_DIR=$(pkg-config --variable=pluginsdir gstreamer-1.0) \
    && export SO_SUFFIX=so \
    && cargo build --release --no-default-features --config net.git-fetch-with-cli=true \
        # List of packages to build
        --package gst-plugin-spotify \
    # Use install command to create directory (-d), copy and print filenames (-v), and set attributes/permissions (-m)
    && install -v -d ${DEST_DIR}/${PLUGINS_DIR} \
    && install -v -m 755 target/release/*.${SO_SUFFIX} ${DEST_DIR}/${PLUGINS_DIR} \
    && cargo clean

# ---------------------------------
#
#################################################################


#################################################################
# ===  Release Node                                       ====  #
#
# Container for mopidy  

FROM debian:bookworm-slim AS release
# Define Image version [latest, develop, release]
ARG IMG_VERSION 

# Switch to the root user while we do our changes
USER root
WORKDIR /

# Install GStreamer and other required Debian packages
RUN apt-get update \
    && apt-get install -y --no-install-recommends \
        sudo \
        build-essential \
        nodejs \
        npm \
        cmake \
        curl \
        jq \
        git \
        wget \
        gnupg2 \
        gcc \
        dumb-init \
        graphviz-dev \
        pkg-config \
        pulseaudio \
        libasound2-dev \
        libdbus-glib-1-dev \
        libgirepository1.0-dev \
        libcairo2-dev \
        # Install Python
        python3-dev \
        python3-gst-1.0 \
        python3-setuptools \
        python3-pip \
        # GStreamer (Plugins)
        gstreamer1.0-pulseaudio \
        gstreamer1.0-alsa \
        gstreamer1.0-tools \
        gstreamer1.0-plugins-good \
        gstreamer1.0-plugins-bad \
        gstreamer1.0-plugins-ugly \
        gstreamer1.0-libav \
    && rm -rf /var/lib/apt/lists/* \
    && apt-get clean

# Adjust pip configuration to ensure compatibility with Bookworm and forthcoming Debian images with this Dockerfile
# PEP 668 introduces a method for Linux distributions to inform pip about restricting package installations outside a virtual environment.
# This can be globally disabled, eliminating the need to append '--break-system-packages' to every pip command.
RUN pip3 config set global.break-system-packages true \
    && cp $HOME/.config/pip/pip.conf /etc/pip.conf

# Copy builded target data from Builder DEST_DIR to root
# Note: target directory tree links directly to $GST_PLUGIN_PATH
COPY --from=builder /target/gst-plugins-rs/ /

# ---------------------------------
# ---  Mopidy                   ---
#
# Define steps for installation based on IMG_VERSION
# - If "release", install from APT
# - If "latest" or "develop", clone and install from source
RUN if [ "$IMG_VERSION" = "release" ]; then \
        # Install Mopidy from apt repository
        # see https://docs.mopidy.com/en/latest/installation/debian/
        echo "Installing Mopidy from APT for release version" \
        && mkdir -p /etc/apt/keyrings \
        && wget -q -O /etc/apt/keyrings/mopidy-archive-keyring.gpg https://apt.mopidy.com/mopidy.gpg \
        && wget -q -O /etc/apt/sources.list.d/mopidy.list https://apt.mopidy.com/bookworm.list \
        && apt-get update \
        && apt-get install -y mopidy \
        && rm -rf /var/lib/apt/lists/*; \
    else \
        # Install Mopidy from GitHub for "latest" or "develop" versions
        if [ "$IMG_VERSION" = "latest" ]; then \
            echo "Installing Mopidy from latest pre-release from GitHub" \
            && MOPIDY_BRANCH_OR_TAG=$(curl -s https://api.github.com/repos/mopidy/mopidy/releases | jq -r 'map(select(.draft == false)) | .[0].tag_name'); \
        elif [ "$IMG_VERSION" = "develop" ]; then \
            echo "Installing Mopidy from main branch from GitHub" \
            && MOPIDY_BRANCH_OR_TAG=main; \
        else \
            echo "Invalid version info for Mopidy: $IMG_VERSION" \
            && exit 1; \
        fi \
        && echo "Selected branch or tag for Mopidy: $MOPIDY_BRANCH_OR_TAG" \
        && git clone --depth 1 --single-branch -b ${MOPIDY_BRANCH_OR_TAG} https://github.com/mopidy/mopidy.git mopidy \
        && cd mopidy \
        && python3 -m pip install . \
        && cd .. \
        && rm -rf mopidy \
        # Create mopidy user
        && useradd -r -m -d /var/lib/mopidy -s /usr/sbin/nologin mopidy; \
    fi
#
# ---------------------------------

# ---------------------------------
# --- Iris WebUI                 --
#
# Clone Iris from the repository and install in development mode.
# This allows a binding at "/iris" to map to your local folder for development, rather than
# installing using pip.
# Note: ADD helps prevent RUN caching issues. When HEAD changes in repo, our cache will be invalidated!
ADD https://api.github.com/repos/jaedb/Iris/git/refs/heads/master version.json

RUN if [ "$IMG_VERSION" = "latest" ]; then \
        IRIS_BRANCH_OR_TAG=master; \
    elif [ "$IMG_VERSION" = "develop" ]; then \
        IRIS_BRANCH_OR_TAG=develop; \
    elif [ "$IMG_VERSION" = "release" ]; then \
        IRIS_BRANCH_OR_TAG=$(curl -s https://api.github.com/repos/jaedb/Iris/releases/latest | jq -r .tag_name); \
    else \
        echo "Invalid version info for Iris: $IMG_VERSION"; \
        exit 1; \
    fi \
    && echo "Selected branch or tag for iris: $IRIS_BRANCH_OR_TAG" \
    # Clone Iris to workdir and install in development mode
    && git clone --depth 1 --single-branch -b ${IRIS_BRANCH_OR_TAG} https://github.com/jaedb/Iris.git /iris \
    && cd /iris \
    && npm install \
    && npm run prod \
    && python3 setup.py develop \
    # Enable container mode (disable restart option, etc.)
    && echo "1" >> /IS_CONTAINER \
    # Copy Version file
    && cp /iris/VERSION /
#
# ---------------------------------

# ---------------------------------
# --- Plugin Mopidy-Spotify     ---
#
RUN if [ "$IMG_VERSION" = "latest" ]; then \
        # Get latest pre-release
        MOPSPOT_BRANCH_OR_TAG=$(curl -s https://api.github.com/repos/mopidy/mopidy-spotify/releases | jq -r 'map(select(.draft == false)) | .[0].tag_name'); \
    elif [ "$IMG_VERSION" = "develop" ]; then \
        MOPSPOT_BRANCH_OR_TAG=main; \
    elif [ "$IMG_VERSION" = "release" ]; then \
        ## Get latest stable release. This is Currently not working / compatible -> take pre-release instead!
        #MOPSPOT_BRANCH_OR_TAG=$(curl -s https://api.github.com/repos/mopidy/mopidy-spotify/releases | jq -r 'map(select(.draft == false and .prerelease == false)) | .[0].tag_name'); \
        # Get latest pre-release
        MOPSPOT_BRANCH_OR_TAG=$(curl -s https://api.github.com/repos/mopidy/mopidy-spotify/releases | jq -r 'map(select(.draft == false)) | .[0].tag_name'); \
    else \
        echo "Invalid version info for Mopidy-Spotify: $IMG_VERSION"; \
        exit 1; \
    fi \
    && echo "Selected branch or tag for Mopidy-Spotify: $MOPSPOT_BRANCH_OR_TAG" \
    && git clone --depth 1 --single-branch -b ${MOPSPOT_BRANCH_OR_TAG} https://github.com/mopidy/mopidy-spotify.git mopidy-spotify \
    && cd mopidy-spotify \
    && python3 -m pip install . \
    && cd .. \
    && rm -rf mopidy-spotify

# ---------------------------------

# ---------------------------------
# ---  Pip Packages             ---
#
# Install additional mopidy extensions and Python dependencies via pip
COPY requirements.txt .
RUN python3 -m pip install -r requirements.txt
#
# ---------------------------------

# Cleanup
RUN apt-get clean all \
    && rm -rf /var/lib/apt/lists/* \
    && rm -rf /root/.cache \
    && rm -rf /iris/node_modules

# Define user and group to run mopidy
ENV DOCKER_USER=mopidy
ENV DOCKER_GROUP=audio

# Start helper script.
COPY docker/entrypoint.sh /entrypoint.sh

# Copy Default configuration for mopidy
COPY docker/mopidy/mopidy.example.conf /mopidy/config/mopidy.conf

# Copy the pulse-client configuratrion
COPY docker/mopidy/pulse-client.conf /etc/pulse/client.conf

# Set environment variables for Home and local music directory
ENV HOME=/var/lib/mopidy
ENV XDG_MUSIC_DIR=/media

# Create environment and s to run mopidy and iris
RUN set -ex \
    # Create docker user and add groups
    && id -u $DOCKER_USER &>/dev/null || useradd -ms /bin/bash $DOCKER_USER \
    && usermod -aG audio,sudo,pulse-access,$DOCKER_GROUP $DOCKER_USER \
    # Create mopidy config directory and set symlink
    && mkdir -p "$HOME/.config" \
    && ln -s /config "$HOME/.config/mopidy" \
    # Create local directory
    && mkdir -p "$HOME/local" \
    # Add XDG_MUSIC_DIR to user-dirs to make it available for user
    && echo "XDG_MUSIC_DIR=\"$XDG_MUSIC_DIR\"" >> "$HOME/.config/user-dirs.dirs" \
    # Allow docker user to run system commands (restart, local scan, etc) with sudo
    && echo "$DOCKER_USER ALL=NOPASSWD: /iris/mopidy_iris/system.sh" >> /etc/sudoers \
    # Configure sudo to keep XDG_MUSIC_DIR
    && echo "Defaults env_keep += \"XDG_MUSIC_DIR\"" >> /etc/sudoers \
    # Set permissions
    && chmod -R +x /entrypoint.sh \
    && chown -R $DOCKER_USER:$DOCKER_GROUP $HOME

# Set permissions that allows any user to run mopidy
RUN chmod go+rwx -R /iris /version.json

# Runs as mopidy user by default.
USER $DOCKER_USER:$DOCKER_GROUP

# Define volumes
VOLUME ["/var/lib/mopidy/local"]

# Port-List to expose:
# 6600 - (optional) Exposes MPD server (if you use for example ncmpcpp client).
# 6680 - (optional) Exposes HTTP server (if you use your browser as client).
# 5555/udp - (optional) Exposes UDP streaming for FIFE sink (e.g. for visualizers).
EXPOSE 6600 6680 5555/udp

ENTRYPOINT ["/usr/bin/dumb-init", "/entrypoint.sh"]
CMD ["mopidy"]

#
#################################################################