nils/shairport-sync
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

formatting and small updates

Browse Source
This commit is contained in:
Mike Brady
2022-10-24 09:48:10 +01:00
parent 90f8603e3b
commit 5e874320ee
25 changed files with 38 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docker/README.md
+13 -8
View File
@@ -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.