First attempt at additional airplay 1 build and releases process.

2021-06-30 21:00:09 +01:00
parent db580c26dc
commit 5ab2b67a61
8 changed files with 219 additions and 7 deletions
@@ -0,0 +1,57 @@
+# Builds & pushes a docker image when a release occurs.
+
+# The following tags are created:
+# 'latest' & 'latest-airplay1'
+# '[RELEASE TAG]' & '[RELEASE TAG]-airplay1'
+
+name: Build and push docker images on release.
+
+on:
+  release:
+    types: [ published ]
+ 
+jobs:
+  main:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Set SHAIRPORT_SYNC_BRANCH env.
+        run: echo "SHAIRPORT_SYNC_BRANCH=${GITHUB_REF##*/}" >> $GITHUB_ENV
+      - name: Set up ssh agent
+        uses: webfactory/ssh-agent@v0.5.2 # Can be removed when no longer pulling from private repos.
+        with:
+          ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+      - name: Login to Docker Registry
+        uses: docker/login-action@v1
+        with:
+          registry: registry.nova.do
+          username: ${{ secrets.DOCKER_REGISTRY_USER }}
+          password: ${{ secrets.DOCKER_REGISTRY_TOKEN }}
+      - name: Build and push
+        uses: docker/build-push-action@v2
+        with:
+          context: ./
+          file: ./docker/Dockerfile
+          platforms: linux/386,linux/amd64,linux/arm/v6,linux/arm64,linux/arm/v7
+          push: true
+          tags: [ registry.nova.do/shairport-sync:latest, registry.nova.do/shairport-sync:${{ github.event.release.tag_name }} ]
+          build-args: |
+            SHAIRPORT_SYNC_BRANCH=${{ env.SHAIRPORT_SYNC_BRANCH }}
+          ssh: default=${{ env.SSH_AUTH_SOCK }} # Can be removed when no longer pulling from private repos.
+      - name: Build and push (AirPlay 1)
+        uses: docker/build-push-action@v2
+        with:
+          context: ./
+          file: ./docker/airplay1/Dockerfile-AirPlay1
+          platforms: linux/386,linux/amd64,linux/arm/v6,linux/arm64,linux/arm/v7
+          push: true
+          tags: [ registry.nova.do/shairport-sync:latest-airplay1, registry.nova.do/shairport-sync:${{ github.event.release.tag_name }}-airplay1 ]
+          build-args: |
+            SHAIRPORT_SYNC_BRANCH=${{ env.SHAIRPORT_SYNC_BRANCH }}
@@ -1,5 +1,6 @@
-# Pushes to tag 'unstable-BRANCH'.
-# Releases are pushed to latest and tagged - see docker-build-releases.yaml.
+# Builds & pushes a docker image when a commit is made to one of the branches specified below.
+# Tag pattern: 'unstable-[BRANCH NAME]'.
+# See docker-build-releases.yaml for release build process.

 name: Build and push docker image based on specified branches.

@@ -38,7 +39,17 @@ jobs:
          file: ./docker/Dockerfile
          platforms: linux/386,linux/amd64,linux/arm/v6,linux/arm64,linux/arm/v7
          push: true
-          tags: registry.nova.do/shairport-sync:unstable-${{ env.SHAIRPORT_SYNC_BRANCH }}
+          tags: [registry.nova.do/shairport-sync:unstable-${{ env.SHAIRPORT_SYNC_BRANCH }}]
          build-args: |
            SHAIRPORT_SYNC_BRANCH=${{ env.SHAIRPORT_SYNC_BRANCH }}
-          ssh: default=${{ env.SSH_AUTH_SOCK }} # Can be removed when no longer pulling from private repos.
+          ssh: default=${{ env.SSH_AUTH_SOCK }} # Can be removed when no longer pulling from private repos.
+      - name: Build and push (AirPlay 1)
+        uses: docker/build-push-action@v2
+        with:
+          context: ./
+          file: ./docker/airplay1/Dockerfile
+          platforms: linux/386,linux/amd64,linux/arm/v6,linux/arm64,linux/arm/v7
+          push: true
+          tags: [registry.nova.do/shairport-sync:unstable-${{ env.SHAIRPORT_SYNC_BRANCH }}-airplay1]
+          build-args: |
+            SHAIRPORT_SYNC_BRANCH=${{ env.SHAIRPORT_SYNC_BRANCH }}
@@ -67,7 +67,7 @@ WORKDIR /

 WORKDIR /shairport-sync
 COPY . .
-RUN git checkout $SHAIRPORT_SYNC_BRANCH
+RUN git checkout "$SHAIRPORT_SYNC_BRANCH"
 RUN git submodule init
 RUN git submodule update
 RUN autoreconf -fi
@@ -2,6 +2,30 @@

 Available at: https://hub.docker.com/r/mikebrady/shairport-sync

+## Example Docker Compose File
+See the `docker-compose.yaml` file in this folder for an example.
+
+## Basic Usage
+
+```
+$ docker run -d --restart unless-stopped --net host --device /dev/snd \
+    mikebrady/shairport-sync
+```
+The above command will run Shairport Sync as a daemon in a Docker container, accessing the computer's ALSA audio infrastructure. It will send audio to the default output device and make no use of any hardware mixers the default device might have. The AirPlay service name will be the host's `hostname` with the first letter capitalised, e.g. `Ubuntu`.
+
+## Options
+
+Any options you add to the command above will be passed to Shairport Sync. Here is an example:
+```
+$ docker run -d --restart unless-stopped --net host --device /dev/snd \
+    mikebrady/shairport-sync -a DenSystem -- -d hw:0 -c PCM
+```
+This will sent audio to alsa hardware device `hw:0` and make use of the that device's mixer control called `PCM`. The service will be visible as `DenSystem` on the network.
+
+## Configuration File
+
+Edit the configuration file `/etc/shairport-sync.conf` in the container (or use the `-v` option to mirror an external copy of `shairport-sync.conf` in to `/etc/shairport-sync.conf`) to get access to the full range of configuration options.
+
 ## Build Example (for arm7 devices)

 TODO: remove `--ssh` when going public as this is only for private repos.
@@ -9,4 +33,7 @@ TODO: remove `--ssh` when going public as this is only for private repos.
 docker buildx build --ssh default=$SSH_AUTH_SOCK --platform linux/arm/v7 -f ./docker/Dockerfile --build-arg SHAIRPORT_SYNC_BRANCH=development -t registry.nova.do/shairport-sync:unstable-development .
 ```

-`SHAIRPORT_SYNC_BRANCH` is required to ensure the image is built using the expected branch.
+`SHAIRPORT_SYNC_BRANCH` is required to ensure the image is built using the expected branch.
+
+## AirPlay 1 Only
+The AirPlay1 only dockerfile is in the `airplay1` folder. This also includes the `start.sh` script used by the container.
@@ -0,0 +1,102 @@
+FROM alpine:3.12 AS builder-base
+# General Build System:
+RUN apk -U add \
+        git \
+        build-base \
+        autoconf \
+        automake \
+        libtool \
+        dbus \
+        su-exec \
+        alsa-lib-dev \
+        libdaemon-dev \
+        popt-dev \
+        mbedtls-dev \
+        soxr-dev \
+        avahi-dev \
+        libconfig-dev \
+        libsndfile-dev \
+        mosquitto-dev \
+        xmltoman
+
+# ALAC Build System:
+FROM builder-base AS builder-alac
+
+RUN git clone https://github.com/mikebrady/alac
+WORKDIR alac
+RUN autoreconf -fi
+RUN ./configure
+RUN make
+RUN make install
+
+# Shairport Sync Build System:
+FROM builder-base AS builder-sps
+
+# This will be modified by the Github Action Workflow and is required
+# to ensure the correct branch is being used.
+ARG SHAIRPORT_SYNC_BRANCH
+RUN test -n "$SHAIRPORT_SYNC_BRANCH"
+
+COPY --from=builder-alac /usr/local/lib/libalac.* /usr/local/lib/
+COPY --from=builder-alac /usr/local/lib/pkgconfig/alac.pc /usr/local/lib/pkgconfig/alac.pc
+COPY --from=builder-alac /usr/local/include /usr/local/include
+
+WORKDIR shairport-sync
+COPY . .
+RUN git checkout "$SHAIRPORT_SYNC_BRANCH"
+RUN autoreconf -fi
+RUN ./configure \
+        --with-alsa \
+        --with-dummy \
+        --with-pipe \
+        --with-stdout \
+        --with-avahi \
+        --with-ssl=mbedtls \
+        --with-soxr \
+        --sysconfdir=/etc \
+        --with-dbus-interface \
+        --with-mpris-interface \
+        --with-mqtt-client \
+        --with-apple-alac \
+        --with-convolution
+RUN make -j $(nproc)
+RUN make install
+
+# Shairport Sync Runtime System:
+FROM alpine:3.12
+
+RUN apk -U add \
+        alsa-lib \
+        dbus \
+        popt \
+        glib \
+        mbedtls \
+        soxr \
+        avahi \
+        libconfig \
+        libsndfile \
+        mosquitto-libs \
+        su-exec \
+        libgcc \
+        libgc++
+
+RUN rm -rf  /lib/apk/db/*
+
+COPY --from=builder-alac /usr/local/lib/libalac.* /usr/local/lib/
+COPY --from=builder-sps /etc/shairport-sync* /etc/
+COPY --from=builder-sps /etc/dbus-1/system.d/shairport-sync-dbus.conf /etc/dbus-1/system.d/
+COPY --from=builder-sps /etc/dbus-1/system.d/shairport-sync-mpris.conf /etc/dbus-1/system.d/
+COPY --from=builder-sps /usr/local/bin/shairport-sync /usr/local/bin/shairport-sync
+
+# Create non-root user for running the container -- running as the user 'shairport-sync' also allows
+# Shairport Sync to provide the D-Bus and MPRIS interfaces within the container
+
+RUN addgroup shairport-sync 
+RUN adduser -D shairport-sync -G shairport-sync
+
+# Add the shairport-sync user to the pre-existing audio group, which has ID 29, for access to the ALSA stuff
+RUN addgroup -g 29 docker_audio && addgroup shairport-sync docker_audio
+
+COPY start.sh /
+
+ENTRYPOINT [ "/start.sh" ]
@@ -0,0 +1,3 @@
+# AirPlay 1 Only Docker Image
+
+See the [Shairport Sync Docker Hub Repo](https://hub.docker.com/r/mikebrady/shairport-sync) for available tags. For the latest build, use `latest-airplay1`.
@@ -0,0 +1,13 @@
+#!/bin/sh
+
+set -e
+
+rm -rf /var/run/dbus.pid
+#mkdir -p /var/run/dbus
+
+dbus-uuidgen --ensure
+dbus-daemon --system
+
+avahi-daemon --daemonize --no-chroot
+
+su-exec shairport-sync shairport-sync $@
@@ -1,6 +1,5 @@
 # Example docker compose config.

-version: "3.8"
 services:
  shairport-sync:
    image: registry.nova.do/shairport-sync:unstable-development