docker: optimizations

- linux host: use pulse unix socket - mpd: run as user (pi / root) - less config adjustments for docker environment
MiczFlor · Nov 1, 2023 · 3ddfe59 · 3ddfe59
1 parent 6f1efb8
commit 3ddfe59
Show file tree

Hide file tree

Showing 12 changed files with 99 additions and 105 deletions.
diff --git a/.dockerignore b/.dockerignore
@@ -1,12 +1,10 @@
-.git
 .dockerignore
 .DS_Store
 
 # Application
 docker
 docs
 installation
-src
 shared
 
 # webapp

diff --git a/docker/armv7/jukebox.Dockerfile b/docker/armv7/jukebox.Dockerfile
@@ -5,22 +5,19 @@ FROM arm32v7/debian:buster-slim
 # These are only dependencies that are required to get as close to the
 # Raspberry Pi environment as possible.
 RUN apt-get update && apt-get install -y \
-    alsa-utils \
     libasound2-dev \
-    libasound2-plugins \
     pulseaudio \
     pulseaudio-utils \
     --no-install-recommends \
     && rm -rf /var/lib/apt/lists/*
 
-RUN usermod -aG audio,pulse,pulse-access root
+ARG UID
+ARG USER
+ARG HOME
+ENV INSTALLATION_PATH ${HOME}/RPi-Jukebox-RFID
 
-ENV HOME /root
-ENV MPD_HOST mpd
-ENV INSTALLATION_DIR /home/pi/RPi-Jukebox-RFID
-ENV DOCKER_DIR ${INSTALLATION_DIR}/docker
-
-WORKDIR $INSTALLATION_DIR
+RUN test ${UID} -gt 0 && useradd -m -u ${UID} ${USER} || continue
+RUN usermod -aG pulse ${USER}
 
 # Jukebox
 # Install all Jukebox dependencies
@@ -34,13 +31,12 @@ RUN apt-get update && apt-get install -qq -y \
 #resolvconf
 #python3-spidev
 
-COPY . ${INSTALLATION_DIR}
-
 # Install Jukebox
 # Install libzmq with Websocket support from pre-compiled source
-ENV ZMQ_TMP_DIR libzmq
-ENV ZMQ_PREFIX /usr/local
-RUN cd ${HOME} && mkdir ${ZMQ_TMP_DIR} && cd ${ZMQ_TMP_DIR}; \
+ENV ZMQ_TMP_DIR "/root/libzmq"
+ENV ZMQ_PREFIX "/usr/local"
+ENV ZMQ_DRAFT_API 1
+RUN mkdir -p ${ZMQ_TMP_DIR} && cd ${ZMQ_TMP_DIR}; \
     wget --quiet --load-cookies /tmp/cookies.txt "https://docs.google.com/uc?export=download&confirm=$(wget --quiet --save-cookies /tmp/cookies.txt --keep-session-cookies --no-check-certificate 'https://docs.google.com/uc?export=download&id=1KP6BqLF-i2dCUsHhOUpOwwuOmKsB5GKY' -O- | sed -rn 's/.*confirm=([0-9A-Za-z_]+).*/\1\n/p')&id=1KP6BqLF-i2dCUsHhOUpOwwuOmKsB5GKY" -O libzmq.tar.gz && rm -rf /tmp/cookies.txt; \
     tar -xzf libzmq.tar.gz; \
     rm -f libzmq.tar.gz; \
@@ -49,26 +45,29 @@ RUN cd ${HOME} && mkdir ${ZMQ_TMP_DIR} && cd ${ZMQ_TMP_DIR}; \
 # Install libzmq with Websocket and compile
 # ENV LIBSODIUM_VERSION 1.0.18
 # ENV ZMQ_VERSION 4.3.4
-# RUN cd ${HOME} && mkdir ${ZMQ_TMP_DIR} && cd ${ZMQ_TMP_DIR}; \
+# RUN mkdir -p ${ZMQ_TMP_DIR} && cd ${ZMQ_TMP_DIR}; \
 #     wget --quiet https://github.com/jedisct1/libsodium/releases/download/${LIBSODIUM_VERSION}-RELEASE/libsodium-${LIBSODIUM_VERSION}.tar.gz; \
 #     tar -zxvf libsodium-${LIBSODIUM_VERSION}.tar.gz; \
 #     cd libsodium-${LIBSODIUM_VERSION}/; \
 #     ./configure; \
 #     make && make install
-# RUN cd ${HOME}/${ZMQ_TMP_DIR}; \
+# RUN cd ${ZMQ_TMP_DIR}; \
 #     wget https://github.com/zeromq/libzmq/releases/download/v${ZMQ_VERSION}/zeromq-${ZMQ_VERSION}.tar.gz -O libzmq.tar.gz; \
 #     tar -xzf libzmq.tar.gz; \
 #     zeromq-${ZMQ_VERSION}/configure --prefix=${ZMQ_PREFIX} --enable-drafts; \
 #     make && make install;
 
-RUN pip3 install --pre pyzmq \
-        --install-option=--enable-drafts \
-        --install-option=--zmq=${ZMQ_PREFIX}
+USER ${USER}
+WORKDIR ${HOME}
+COPY --chown=${USER}:${USER} . ${INSTALLATION_PATH}/
 
-RUN pip3 install --no-cache-dir -r ${INSTALLATION_DIR}/requirements.txt
+RUN pip3 install --no-cache-dir -r ${INSTALLATION_PATH}/requirements.txt
+RUN pip3 install --no-cache-dir --pre --no-binary pyzmq pyzmq
 
 EXPOSE 5555 5556
 
+WORKDIR ${INSTALLATION_PATH}/src/jukebox
+
 # Run Jukebox
 # CMD bash
-CMD python3 ${INSTALLATION_DIR}/src/jukebox/run_jukebox.py
+CMD python3 ${INSTALLATION_PATH}/src/jukebox/run_jukebox.py
diff --git a/docker/config/docker.pulse.mpd.conf b/docker/config/docker.pulse.mpd.conf
@@ -11,7 +11,7 @@
 # be disabled and audio files will only be accepted over ipc socket (using
 # file:// protocol) or streaming files over an accepted protocol.
 #
-music_directory		        "/home/pi/RPi-Jukebox-RFID/shared/audiofolders"
+music_directory		        "~/RPi-Jukebox-RFID/shared/audiofolders"
 #
 # This setting sets the MPD internal playlist directory. The purpose of this
 # directory is storage for playlists created by MPD. The server will use
@@ -67,7 +67,7 @@ sticker_file                   "~/.config/mpd/sticker.sql"
 # initialization. This setting is disabled by default and MPD is run as the
 # current user.
 #
-user				"root"
+# user				"root"
 #
 # This setting specifies the group that MPD will run as. If not specified
 # primary group of user specified with "user" setting will be used (if set).

diff --git a/docker/config/jukebox.overrides.yaml b/docker/config/jukebox.overrides.yaml
@@ -1,7 +1,2 @@
 playermpd:
   host: mpd
-  mpd_conf: /etc/mpd.conf
-pulse:
-  outputs:
-    primary:
-      pulse_sink_name: Channel_1__Channel_2.2
diff --git a/docker/docker-compose.linux.yml b/docker/docker-compose.linux.yml
@@ -1,10 +1,29 @@
-version: "3.9"
-
-services:
-  mpd:
-    devices:
-      - /dev/snd
-
-  jukebox:
-    devices:
-      - /dev/snd
+version: "3.9"
+
+services:
+  mpd:
+    build:
+      args:
+        - UID=${UID:-1000}
+        - USER=pi
+        - HOME=/home/pi
+    environment:
+      - PULSE_SERVER=unix:/tmp/pulse-sock
+    volumes:
+      - ../shared/audiofolders:/home/pi/RPi-Jukebox-RFID/shared/audiofolders
+      - ../shared/playlists:/home/pi/.config/mpd/playlists
+      - ./config/docker.pulse.mpd.conf:/home/pi/.config/mpd/mpd.conf
+      - $XDG_RUNTIME_DIR/pulse/native:/tmp/pulse-sock
+
+  jukebox:
+    build:
+      args:
+        - UID=${UID:-1000}
+        - USER=pi
+        - HOME=/home/pi
+    environment:
+      - PULSE_SERVER=unix:/tmp/pulse-sock
+    volumes:
+      - ../shared:/home/pi/RPi-Jukebox-RFID/shared
+      - ./config/docker.pulse.mpd.conf:/home/pi/.config/mpd/mpd.conf
+      - $XDG_RUNTIME_DIR/pulse/native:/tmp/pulse-sock
diff --git a/docker/docker-compose.mac.yml b/docker/docker-compose.mac.yml
@@ -2,16 +2,11 @@ version: "3.9"
 
 services:
   mpd:
-    environment:
-      - PULSE_SERVER=tcp:host.docker.internal:4713
     volumes:
-      - ./config/docker.pulse.mpd.conf:/root/.config/mpd/mpd.conf:rw
       - ~/.config/pulse:/root/.config/pulse
       - /usr/local/Cellar/pulseaudio/14.2/etc/pulse:/etc/pulse
 
   jukebox:
-    environment:
-      - PULSE_SERVER=tcp:host.docker.internal:4713
     volumes:
       - ~/.config/pulse:/root/.config/pulse
       - /usr/local/Cellar/pulseaudio/14.2/etc/pulse:/etc/pulse
diff --git a/docker/docker-compose.windows.yml b/docker/docker-compose.windows.yml
diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml
@@ -3,37 +3,43 @@ version: "3.9"
 services:
   mpd:
     build:
+      args:
+        - UID=0
+        - USER=root
+        - HOME=/root
       context: ../
       dockerfile: ./docker/mpd.Dockerfile
     container_name: mpd
-    ports:
-      - 6600:6600
-      - 8800:8800
+    environment:
+      - PULSE_SERVER=tcp:host.docker.internal:4713
     restart: unless-stopped
     volumes:
-      - ../shared/audiofolders:/home/pi/RPi-Jukebox-RFID/shared/audiofolders:rw
-      - ../shared/playlists:/root/.config/mpd/playlists:rw
-      - ./config/docker.mpd.conf:/root/.config/mpd/mpd.conf:rw
+      - ../shared/audiofolders:/root/RPi-Jukebox-RFID/shared/audiofolders
+      - ../shared/playlists:/root/.config/mpd/playlists
+      - ./config/docker.pulse.mpd.conf:/root/.config/mpd/mpd.conf
 
   jukebox:
     build:
+      args:
+        - UID=0
+        - USER=root
+        - HOME=/root
       context: ../
       dockerfile: ./docker/jukebox.Dockerfile
     container_name: jukebox
     depends_on:
       - mpd
-    links:
-      - mpd
+    environment:
+      - PULSE_SERVER=tcp:host.docker.internal:4713
     ports:
       - 5555:5555
       - 5556:5556
       - 5557:5557
     restart: unless-stopped
     tty: true
     volumes:
-      - ../src/jukebox:/home/pi/RPi-Jukebox-RFID/src/jukebox
-      - ../shared:/home/pi/RPi-Jukebox-RFID/shared
-      - ./config/docker.mpd.conf:/etc/mpd.conf
+      - ../shared:/root/RPi-Jukebox-RFID/shared
+      - ./config/docker.pulse.mpd.conf:/root/.config/mpd/mpd.conf
 
   webapp:
     build:
@@ -44,10 +50,8 @@ services:
       - jukebox
     environment:
       - CHOKIDAR_USEPOLLING=true
-    links:
-      - jukebox
     ports:
-      - 3001:3000
+      - 3000:3000
     restart: unless-stopped
     volumes:
       - ../src/webapp:/home/node/webapp

diff --git a/docker/jukebox.Dockerfile b/docker/jukebox.Dockerfile
@@ -5,36 +5,38 @@ FROM debian:bullseye-slim
 # These are only dependencies that are required to get as close to the
 # Raspberry Pi environment as possible.
 RUN apt-get update && apt-get install -y \
-    alsa-utils \
     libasound2-dev \
-    libasound2-plugins \
     pulseaudio \
     pulseaudio-utils \
     --no-install-recommends \
     && rm -rf /var/lib/apt/lists/*
 
-RUN usermod -aG audio,pulse,pulse-access root
+ARG UID
+ARG USER
+ARG HOME
+ENV INSTALLATION_PATH ${HOME}/RPi-Jukebox-RFID
 
-ENV HOME /root
-ENV INSTALLATION_PATH /home/pi/RPi-Jukebox-RFID
-
-WORKDIR $INSTALLATION_PATH
+RUN test ${UID} -gt 0 && useradd -m -u ${UID} ${USER} || continue
+RUN usermod -aG pulse ${USER}
 
 # Jukebox
 # Install all Jukebox dependencies
 RUN apt-get update && apt-get install -qq -y \
     --allow-downgrades --allow-remove-essential --allow-change-held-packages \
     gcc at wget \
-    espeak mpc mpg123 git ffmpeg spi-tools netcat alsa-tools \
+    espeak mpc mpg123 git ffmpeg spi-tools netcat \
     python3 python3-dev python3-pip python3-mutagen python3-gpiozero
 
-COPY . ${INSTALLATION_PATH}
+USER ${USER}
+WORKDIR ${HOME}
+COPY --chown=${USER}:${USER} . ${INSTALLATION_PATH}/
 
 RUN pip3 install --no-cache-dir -r ${INSTALLATION_PATH}/requirements.txt
 RUN pip3 install pyzmq
 
 EXPOSE 5555 5556
 
+WORKDIR ${INSTALLATION_PATH}/src/jukebox
+
 # Run Jukebox
-# CMD bash
 CMD python3 ${INSTALLATION_PATH}/src/jukebox/run_jukebox.py
diff --git a/docker/mpd.Dockerfile b/docker/mpd.Dockerfile
@@ -2,26 +2,23 @@ FROM debian:bullseye-slim
 
 RUN set -eux ; \
     apt-get update && apt-get install -y \
-    alsa-utils \
-    libasound2-dev \
-    libasound2-plugins \
     pulseaudio \
     pulseaudio-utils \
     mpd mpc \
     --no-install-recommends \
 	; \
 	rm -rf /var/lib/apt/lists/*
 
-ENV HOME /root
 
-RUN mkdir ${HOME}/.config ${HOME}/.config/mpd ; \
-    touch ${HOME}/.config/mpd/state
-RUN mkdir -p /home/pi/RPi-Jukebox-RFID/shared/audiofolders
-
-RUN usermod -aG audio,pulse,pulse-access root
+ARG UID
+ARG USER
+ARG HOME
 
-VOLUME ${HOME}/.config/mpd
+RUN useradd -m -u ${UID} ${USER} || continue
+RUN usermod -aG pulse ${USER}
 
-EXPOSE 6600
+USER ${USER}
+RUN mkdir -p ${HOME}/.config/mpd ; \
+    touch ${HOME}/.config/mpd/state
 
-CMD [ ! -s ~/.config/mpd/pid ] && mpd --stdout --no-daemon ${HOME}/.config/mpd/mpd.conf
+CMD mpd --stdout --no-daemon ${HOME}/.config/mpd/mpd.conf
diff --git a/docs/sphinx/developer/docker.rst b/docs/sphinx/developer/docker.rst
@@ -47,7 +47,6 @@ Prerequisites
       `Override file
       <https://github.com/MiczFlor/RPi-Jukebox-RFID/blob/future3/develop/docker/config/jukebox.overrides.yaml>`_
       in your ``jukebox.yaml``.
-    * **[Currently required]** Update all relative paths (``../..``) in to ``/home/pi/RPi-Jukebox-RFID``.
 
 4. Change directory into the ``./RPi-Jukebox-RFID/shared/audiofolders`` and copy a set of MP3 files into this folder (for more fun when testing).
 
@@ -97,6 +96,9 @@ Otherwise you might get the error message:
 Read these threads for details: `thread 1 <https://unix.stackexchange.com/questions/456909/socket-already-in-use-but-is-not-listed-mpd>`_
 and `thread 2 <https://stackoverflow.com/questions/5106674/error-address-already-in-use-while-binding-socket-with-address-but-the-port-num/5106755#5106755>`_
 
+The docker linux setup tries to mirror the current users pulseaudio socket from ``$XDG_RUNTIME_DIR/pulse/native`` to the containers ``mpd`` and ``jukebox``.
+If your pulseaudio socket is in another place, adjust path in docker/docker-compose.linux.yml. You can find out the socket path with the command ``pactl info``.
+To access the socket, the user inside the docker containers also must have the same UID as the user running docker. You can find out your UID by running ``id -u``. If your UID deviates from the default UID 1000, please run ``export UID=$(id -u)`` prior to any docker commands.
 
 Mac
 ^^^^^
@@ -152,7 +154,8 @@ Test & Develop
 
 The Dockerfile is defined to start all Phoniebox related services.
 
-Open `http://localhost:3001 <http://localhost:3001>`_ in your browser to see the web application.
+Windows: Open `host.docker.internal:3000 <http://host.docker.internal:3000>`_ in your browser to see the web application.
+Linux / Mac: Open `http://localhost:3000 <http://localhost:3000>`_ in your browser to see the web application.
 
 
 While the ``webapp`` container does not require a reload while working on it (hot-reload is enabled),
@@ -162,7 +165,7 @@ Instead of stopping and starting the ``docker-compose`` command, you can individ
 
 .. code-block:: bash
 
-    $ docker-compose -f docker/docker-compose.yml -f docker/docker-compose.[ENVIRONMENT].yml restart jukebox
+    $ docker compose -f docker/docker-compose.yml -f docker/docker-compose.[ENVIRONMENT].yml restart jukebox
 
 Known issues
 ----------------
@@ -230,14 +233,8 @@ The following command can be run on a Mac.
 
 .. code-block:: bash
 
-    $ docker build -f docker/jukebox.Dockerfile -t jukebox .
-    $ docker run -it --rm \
-        -v $(PWD)/src/jukebox:/home/pi/RPi-Jukebox-RFID/src/jukebox \
-        -v $(PWD)/shared/audiofolders:/home/pi/RPi-Jukebox-RFID/shared/audiofolders \
-        -v ~/.config/pulse:/root/.config/pulse \
-        -v /usr/local/Cellar/pulseaudio/14.2/etc/pulse/:/etc/pulse \
-        -e PULSE_SERVER=tcp:host.docker.internal:4713 \
-        --name jukebox jukebox
+    $ docker compose -f docker/docker-compose.yml -f docker/docker-compose.mac.yml build jukebox
+    $ docker compose -f docker/docker-compose.yml -f docker/docker-compose.mac.yml run --rm --name jukebox jukebox
 
 Resources
 ^^^^^^^^^^^