Merge branch 'development'

Small documentation updates.
This commit is contained in:
Mike Brady
2022-10-26 14:35:32 +01:00
3 changed files with 12 additions and 20 deletions
+11 -6
View 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.
-13
View File
@@ -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 "$@"
+1 -1
View 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: