]> git.ipfire.org Git - thirdparty/shairport-sync.git/commitdiff
Small documentation updates.
authorMike Brady <4265913+mikebrady@users.noreply.github.com>
Wed, 26 Oct 2022 13:23:35 +0000 (14:23 +0100)
committerMike Brady <4265913+mikebrady@users.noreply.github.com>
Wed, 26 Oct 2022 13:23:35 +0000 (14:23 +0100)
docker/README.md
docker/classic/start.sh [deleted file]
docker/docker-compose.yaml

index 648996cb869388adcec0e06b30243c51a59bd563..295d2170a25900432cb2c0660bb2231815eb1b77 100644 (file)
@@ -2,26 +2,31 @@
 
 Available at: https://hub.docker.com/r/mikebrady/shairport-sync
 
-Versions with tags including `-classic` provide classic AirPlay, the same as Shairport Sync versions up to 3.3.9. 
+Shairport Sync provides limited AirPlay 2 functionality. Versions with tags including `-classic` only provide classic AirPlay (aka "AirPlay 1"), the same as Shairport Sync versions up to 3.3.9.
+
+### Tags
+* `latest` and `latest-classic` are images of the most recent releases. These should be the most stable and updated only when a new release is made.
+* `rolling` and `rolling-classic` are images of the latest updates in the `master` branch that have not yet been incorporated in a release. These may be updated frequently but should be stable.
+* `development` and `development-classic` are images of the latest pushes to the `development` branch. These will be less stable and may be actually faulty. They will be updated frequently.
+* Version Tags, e.g. `4.1` are images of specific releases.
 
-(**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:
+To run the latest release of Shairport Sync, which provides AirPlay 2 service:
 
 ```
 $ docker run -d --restart unless-stopped --net host --device /dev/snd \
-    mikebrady/shairport-sync:stable
+    mikebrady/shairport-sync:latest
 ```
 To run the classic version:
 
 ```
 $ docker run -d --restart unless-stopped --net host --device /dev/snd \
-    mikebrady/shairport-sync:stable-classic
+    mikebrady/shairport-sync:latest-classic
 ```
 
 ### Options
@@ -29,7 +34,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:stable \
+    mikebrady/shairport-sync:latest \
     -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.
diff --git a/docker/classic/start.sh b/docker/classic/start.sh
deleted file mode 100644 (file)
index 23b41ef..0000000
+++ /dev/null
@@ -1,13 +0,0 @@
-#!/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 "$@"
index 5867d7baf7b88ddd87bcd0db93b526121d4c8878..8883129872060d965d6628c89f9905265620b1a9 100644 (file)
@@ -2,7 +2,7 @@
 
 services:
   shairport-sync:
-    image: mikebrady/shairport-sync:stable
+    image: mikebrady/shairport-sync:latest
     network_mode: host
     restart: unless-stopped
     devices: