formatting and small updates

2022-10-24 09:48:10 +01:00
parent 90f8603e3b
commit 5e874320ee
25 changed files with 38 additions and 33 deletions
@@ -2,21 +2,26 @@

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

-Please note if you want the development version of the image including Airplay 2 support, please pull the image with the `development` tag using the following command:
-```
-docker pull mikebrady/shairport-sync:development
-```
+Versions with tags including `-classic` provide classic AirPlay, the same as Shairport Sync versions up to 3.3.9. 

-When using the below commands, you should replace `mikebrady/shairport-sync` with `mikbrady/shairport-sync:development`.
+(**Note:** At this time, `stable` tags may not be available.)

 ## Example Docker Compose File
 See the `docker-compose.yaml` file in this folder for an example.

 ## Docker Run

+To run the latest stable release of Shairport Sync, which provides AirPlay 2 service:
+
 ```
 $ docker run -d --restart unless-stopped --net host --device /dev/snd \
-    mikebrady/shairport-sync
+    mikebrady/shairport-sync:stable
+```
+To run the classic version:
+
+```
+$ docker run -d --restart unless-stopped --net host --device /dev/snd \
+    mikebrady/shairport-sync:stable-classic
 ```

 ### Options
@@ -24,7 +29,7 @@ $ docker run -d --restart unless-stopped --net host --device /dev/snd \
 Command line options will be passed to Shairport Sync. Here is an example:
 ```
 $ docker run -d --restart unless-stopped --net host --device /dev/snd \
-    mikebrady/shairport-sync:development \
+    mikebrady/shairport-sync:stable \
    -v --statistics -a DenSystem -d hw:0 -c PCM
 ```
 This will send 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.
@@ -37,7 +42,7 @@ To get access to the full range of configuration options, pass the configuration
 ### Build Example (for arm7 devices)

 ```
-docker buildx build --platform linux/arm/v7 -f ./docker/Dockerfile --build-arg SHAIRPORT_SYNC_BRANCH=development --build-arg NQPTP_BRANCH=development --no-cache -t shairport-sync:unstable-development .
+docker buildx build --platform linux/arm/v7 -f ./docker/Dockerfile --build-arg SHAIRPORT_SYNC_BRANCH=development --build-arg NQPTP_BRANCH=development --no-cache -t shairport-sync:development .
 ```

 `SHAIRPORT_SYNC_BRANCH` and `NQPTP_BRANCH` are required to ensure the image is built using the expected branch.
@@ -1,3 +1,3 @@
-# Classic (AirPlay 1 Only) Docker Image
+# Classic (aka AirPlay 1 Only) Docker Image

 See the [Shairport Sync Docker Hub Repo](https://hub.docker.com/r/mikebrady/shairport-sync) for available tags.
@@ -1,2 +1,2 @@
 #!/command/execlineb -S0
-/run/s6/basedir/bin/halt
+/run/s6/basedir/bin/halt
@@ -1,4 +1,4 @@
 #!/command/with-contenv sh
 rm -rf /var/run/dbus.pid
 echo "Starting dbus"
-exec dbus-daemon --system --nofork
+exec dbus-daemon --system --nofork
@@ -1 +1 @@
-longrun
+longrun
@@ -1,2 +1,2 @@
 #!/command/execlineb -S0
-/run/s6/basedir/bin/halt
+/run/s6/basedir/bin/halt
@@ -5,4 +5,4 @@ while [ ! -f /var/run/dbus.pid ]; do
  sleep 5
 done
 echo "Starting avahi"
-exec avahi-daemon --no-chroot
+exec avahi-daemon --no-chroot
@@ -1 +1 @@
-longrun
+longrun
@@ -1,2 +1,2 @@
 #!/bin/sh
-echo "STARTING - $(date)"
+echo "STARTING - $(date)"
@@ -1 +1 @@
-oneshot
+oneshot
@@ -1 +1 @@
-/etc/s6-overlay/s6-rc.d/startup/script.sh
+/etc/s6-overlay/s6-rc.d/startup/script.sh
@@ -10,4 +10,4 @@ dbus-daemon --system

 avahi-daemon --daemonize --no-chroot

-su-exec shairport-sync shairport-sync "$@"
+su-exec shairport-sync shairport-sync "$@"
@@ -2,7 +2,7 @@

 services:
  shairport-sync:
-    image: mikebrady/shairport-sync:development
+    image: mikebrady/shairport-sync:stable
    network_mode: host
    restart: unless-stopped
    devices:
@@ -12,4 +12,4 @@ services:
    logging:
      options:
        max-size: "200k"
-        max-file: "10"
+        max-file: "10"
@@ -1,2 +1,2 @@
 #!/command/execlineb -S0
-/run/s6/basedir/bin/halt
+/run/s6/basedir/bin/halt
@@ -1,4 +1,4 @@
 #!/command/with-contenv sh
 rm -rf /var/run/dbus.pid
 echo "Starting dbus"
-exec dbus-daemon --system --nofork
+exec dbus-daemon --system --nofork
@@ -1 +1 @@
-longrun
+longrun
@@ -1,2 +1,2 @@
 #!/command/execlineb -S0
-/run/s6/basedir/bin/halt
+/run/s6/basedir/bin/halt
@@ -5,4 +5,4 @@ while [ ! -f /var/run/dbus.pid ]; do
  sleep 5
 done
 echo "Starting avahi"
-exec avahi-daemon --no-chroot
+exec avahi-daemon --no-chroot
@@ -1 +1 @@
-longrun
+longrun
@@ -1,2 +1,2 @@
 #!/command/execlineb -S0
-/run/s6/basedir/bin/halt
+/run/s6/basedir/bin/halt
@@ -1,3 +1,3 @@
 #!/command/with-contenv sh
 echo "Starting nqptp"
-exec /usr/local/bin/nqptp
+exec /usr/local/bin/nqptp
@@ -1 +1 @@
-longrun
+longrun
@@ -1,2 +1,2 @@
 #!/bin/sh
-echo "STARTING - $(date)"
+echo "STARTING - $(date)"
@@ -1 +1 @@
-oneshot
+oneshot
@@ -1 +1 @@
-/etc/s6-overlay/s6-rc.d/startup/script.sh
+/etc/s6-overlay/s6-rc.d/startup/script.sh