From 88a728d9341d6a528c3a20ee0ca8a096dd88517a Mon Sep 17 00:00:00 2001 From: James Barnett Date: Sat, 18 Aug 2018 23:25:36 +0100 Subject: Update README.md --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c3e5a3d..946e1f5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,24 @@ -# airsonos-docker -Docker images for the now defunct Airsonos +# Airsonos Docker Images +Docker images for the now defunct [Airsonos project](https://github.com/stephen/airsonos), which provides AirPlay support for all Sonos speakers. These images are the easiest way to get Airsonos running on both x86 and ARM devices. + +The currently published NPM version of Airsonos does not support iOS 9+ devices. A fix for this is included in these images, via the mounted helper.js file. + +## Usage +There are 2 different images available, depending on if you want to run on x86 or ARM architecture. +If you don't know which to use, the x86 is probably the one you want. + +Airsonos must be run using [host networking](https://docs.docker.com/network/host/), to allow access to the Sonos devices on your network from within the container. + +### x86 +``` +$ docker run -d --name airsonos --network=host jbarnett/airsonos +``` + +### arm32v7 (e.g. Raspberry Pi 2 and 3) +``` +$ docker run -d --name airsonos --network=host jbarnett/airsonos:arm32v7 +``` + +## Note +I didn't bother trying to optimise the image size and as a result they're around 800mb. The base image is Debian Jessie which you may already have a cached layer for anyway. +I might rebuild them using Alpine at some point. -- cgit v1.2.3