From 32b2bbe85b6a010bf40e194682b645f0c19c41ae Mon Sep 17 00:00:00 2001 From: Mike Brady Date: Mon, 21 May 2018 13:37:43 +0100 Subject: [PATCH 1/5] Update INSTALL.md --- INSTALL.md | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 71 insertions(+), 2 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index cf3978ca..cefe4bd1 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,4 +1,73 @@ -Installation Instructions +Simple Installation Instructions == +Shairport Sync can be installed in lots of different Linux and Unix machines, and there are lots of variations to consider -- see the [README.md](https://github.com/mikebrady/shairport-sync/blob/master/README.md) page for a fuller discussion. But here are really simple instructions for building and installing it on a Raspberry Pi B, 2B, 3B or 3B+. It is assumed that the Pi is running Raspbian Stretch Lite -- a GUI isn't needed, since Shairport Sync runs as a daemon program. -Please refer to README.md for installation instructions. +### Configure and Update +Do the usual update and upgrade: +``` +# apt-get update +# apt-get upgrade +# rpi-update +``` +(Separately, if you haven't done so already, consider using the `raspi-config` tool to expand the file system to use the entire card.) + +### Activate the Improved Audio Driver +Check the file `/boot/config.txt` and, if it's not there already, edit it to add the following line: +``` +audio_pwm_mode=2 +``` +Reboot. + +### Remove Old Copies +Before you begin building Shairport Sync, it's best to search and remove any existing copies. Use the command `$ which shairport-sync` to find them. For example, if `shairport-sync` has been installed previously, this might happen: +``` +$ which shairport-sync +/usr/local/bin/shairport-sync +$ sudo rm /usr/local/bin/shairport-sync +... +``` +Do this until no more are found. + +### Build and Install +Okay,now let's get the tools and sources for building and installing Shairport Sync. + +First, install the packages needed by Shairport Sync: +``` +# apt-get install build-essential git xmltoman autoconf automake libtool libdaemon-dev libpopt-dev libconfig-dev libasound2-dev avahi-daemon libavahi-client-dev libssl-dev +``` +Next, download Shairport Sync, configure it, compile and install it: +``` +$ git clone https://github.com/mikebrady/shairport-sync.git +$ cd shairport-sync +$ autoreconf -fi +$ ./configure --sysconfdir=/etc --with-alsa --with-avahi --with-ssl=openssl --with-systemd +$ make +$ sudo make install +``` + +Now to comfigure Shairport Sync. +Here are the important options for the Shairport Sync configuration file at `/etc/shairport-sync.conf`: +``` +// Sample Configuration File for Shairport Sync on a Raspberry Pi using the built-in audio DAC +general = +{ + drift_tolerance_in_seconds = 0.010; + volume_range_db = 50; +}; + +alsa = +{ + output_device = "hw:0"; + mixer_control_name = "PCM"; +}; + +``` +Fourth, enable Shairport Sync to start automatically on boot up: +``` +$ sudo systemctl enable shairport-sync +``` +Fifth, either reboot the Pi or start the service: +``` +$ sudo systemctl start shairport-sync +``` +Sixth, enjoy! From dc45693517ed32e9694c54c44328322926bd3bfe Mon Sep 17 00:00:00 2001 From: Mike Brady Date: Mon, 21 May 2018 13:43:32 +0100 Subject: [PATCH 2/5] Update INSTALL.md --- INSTALL.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index cefe4bd1..2e0a913d 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,6 +1,6 @@ Simple Installation Instructions == -Shairport Sync can be installed in lots of different Linux and Unix machines, and there are lots of variations to consider -- see the [README.md](https://github.com/mikebrady/shairport-sync/blob/master/README.md) page for a fuller discussion. But here are really simple instructions for building and installing it on a Raspberry Pi B, 2B, 3B or 3B+. It is assumed that the Pi is running Raspbian Stretch Lite -- a GUI isn't needed, since Shairport Sync runs as a daemon program. +Shairport Sync can be installed in lots of different Linux and Unix machines, and there are lots of variations to consider – see the [README.md](https://github.com/mikebrady/shairport-sync/blob/master/README.md) page for a fuller discussion. But here are really simple instructions for building and installing it on a Raspberry Pi B, 2B, 3B or 3B+. It is assumed that the Pi is running Raspbian Stretch Lite – a GUI isn't needed, since Shairport Sync runs as a daemon program. ### Configure and Update Do the usual update and upgrade: @@ -19,17 +19,17 @@ audio_pwm_mode=2 Reboot. ### Remove Old Copies -Before you begin building Shairport Sync, it's best to search and remove any existing copies. Use the command `$ which shairport-sync` to find them. For example, if `shairport-sync` has been installed previously, this might happen: +Before you begin building Shairport Sync, it's best to search for and remove any existing copies of the applicatioon, called `shairport-sync`. Use the command `$ which shairport-sync` to find them. For example, if `shairport-sync` has been installed previously, this might happen: ``` $ which shairport-sync /usr/local/bin/shairport-sync $ sudo rm /usr/local/bin/shairport-sync ... ``` -Do this until no more are found. +You can see that the `which` command located a copy of `shairports-sync` in the direcotry `/usr/local/bin` and then we removed it with the `rm` command. Do this until no more copies of `shairport-sync` are found. ### Build and Install -Okay,now let's get the tools and sources for building and installing Shairport Sync. +Okay, now let's get the tools and sources for building and installing Shairport Sync. First, install the packages needed by Shairport Sync: ``` @@ -45,8 +45,7 @@ $ make $ sudo make install ``` -Now to comfigure Shairport Sync. -Here are the important options for the Shairport Sync configuration file at `/etc/shairport-sync.conf`: +Now to configure Shairport Sync. Here are the important options for the Shairport Sync configuration file at `/etc/shairport-sync.conf`: ``` // Sample Configuration File for Shairport Sync on a Raspberry Pi using the built-in audio DAC general = @@ -57,17 +56,17 @@ general = alsa = { - output_device = "hw:0"; + output_device = "hw:0"; mixer_control_name = "PCM"; }; ``` -Fourth, enable Shairport Sync to start automatically on boot up: +The next step is to enable Shairport Sync to start automatically on boot up: ``` $ sudo systemctl enable shairport-sync ``` -Fifth, either reboot the Pi or start the service: +Finally, either reboot the Pi or start the `shairport-sync` service: ``` $ sudo systemctl start shairport-sync ``` -Sixth, enjoy! +The Shairport Sync AirPlay service should now appear on the network for your devices to find. Connect to it and enjoy. From 08243de4e7bc351b820cfc9b7852eaea546177ba Mon Sep 17 00:00:00 2001 From: Mike Brady Date: Mon, 21 May 2018 17:17:35 +0100 Subject: [PATCH 3/5] Update INSTALL.md --- INSTALL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/INSTALL.md b/INSTALL.md index 2e0a913d..26f1c317 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -12,7 +12,7 @@ Do the usual update and upgrade: (Separately, if you haven't done so already, consider using the `raspi-config` tool to expand the file system to use the entire card.) ### Activate the Improved Audio Driver -Check the file `/boot/config.txt` and, if it's not there already, edit it to add the following line: +Check the file `/boot/config.txt` and, if it's not there already, add the following line: ``` audio_pwm_mode=2 ``` From d411c8f790dddc0f483ec100c5a5cbd6e0f313af Mon Sep 17 00:00:00 2001 From: Mike Brady Date: Mon, 21 May 2018 17:19:46 +0100 Subject: [PATCH 4/5] Update INSTALL.md --- INSTALL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/INSTALL.md b/INSTALL.md index 26f1c317..b5105fd0 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -69,4 +69,4 @@ Finally, either reboot the Pi or start the `shairport-sync` service: ``` $ sudo systemctl start shairport-sync ``` -The Shairport Sync AirPlay service should now appear on the network for your devices to find. Connect to it and enjoy. +The Shairport Sync AirPlay service should now appear on the network with a service name derived from the Pi's `hostname`. Connect to it and enjoy... From 9f397df89e54c65af1e1b2924bc64dbab5452c3e Mon Sep 17 00:00:00 2001 From: Mike Brady Date: Mon, 21 May 2018 17:21:49 +0100 Subject: [PATCH 5/5] Update INSTALL.md --- INSTALL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/INSTALL.md b/INSTALL.md index b5105fd0..1efda16b 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -69,4 +69,4 @@ Finally, either reboot the Pi or start the `shairport-sync` service: ``` $ sudo systemctl start shairport-sync ``` -The Shairport Sync AirPlay service should now appear on the network with a service name derived from the Pi's `hostname`. Connect to it and enjoy... +The Shairport Sync AirPlay service should now appear on the network with a service name make from the Pi's `hostname` with the first letter capitalised, e.g. hostname `raspberrypi` give a service name `Raspberrypi`. Connect to it and enjoy...