From: Mike Brady <4265913+mikebrady@users.noreply.github.com>
Date: Fri, 20 May 2022 11:52:37 +0000 (+0100)
Subject: Update FREEBSD.md
X-Git-Tag: 4.1-rc1~24^2~205
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c5ddf3f6a10565d5b9bc4a5344f8f5f0a1abfb35;p=thirdparty%2Fshairport-sync.git

Update FREEBSD.md
---

diff --git a/FREEBSD.md b/FREEBSD.md
index 66efdfa9..f53ab925 100644
--- a/FREEBSD.md
+++ b/FREEBSD.md
@@ -1,16 +1,14 @@
-Shairport Sync on FreeBSD using `sndio` [Needs updating for Airplay 2]
+Shairport Sync on FreeBSD using `sndio` [Partly updated for Airplay 2]
 ----
 Shairport Sync runs natively on FreeBSD using the `sndio` back end, thanks to the work of [Tobias Kortkamp (t6)](https://github.com/t6).
 
 [`sndio`](http://www.sndio.org) is *"a small audio and MIDI framework part of the OpenBSD project and ported to FreeBSD, Linux and NetBSD"* developed by Alexandre Ratchov (see also [this paper](http://www.openbsd.org/papers/asiabsdcon2010_sndio.pdf) for more details).
 
-This is an initial note about installing Shairport Sync on FreeBSD.
-
-The build instructions here install back ends both for `sndio` and ALSA. ALSA is, or course, the Advanced Linux Sound Architecture, so it is not "native" to FreeBSD, but has been ported to some architectures under FreeBSD. 
+The build instructions here install back ends for `sndio` and/or `ALSA`. `ALSA` is, or course, the Advanced Linux Sound Architecture, so it is not "native" to FreeBSD, but has been ported to some architectures under FreeBSD. 
 
 General
 ----
-This build was done on a default build of `FreeBSD 11.0-RELEASE-p9`.
+This build was done on a default build of `freebsd 12.3-RELEASE-p5`.
 
 First, update everything:
 ```
@@ -45,26 +43,38 @@ Reboot for these changes to take effect.
 Building
 ----
 
-Install the packages that are needed for Shairport Sync to be downloaded and built successfully:
+Install the packages that are needed for Shairport Sync to be downloaded and built:
 ```
 # pkg install git autotools pkgconf popt libconfig openssl sndio
 ```
 Add `alsa-utils` if you're wish to use ALSA. Omit `sndio` if you don't intend to use the `sndio` subsystem.
-Add `libplist libsodium ffmpeg e2fsprogs-libuuid` if you are building for AirPlay 2.
+
+Add `libplist libsodium ffmpeg e2fsprogs-libuuid vim` if you are building for AirPlay 2.
+
+At this point, if you intend to build Shairport Sync for AirPlay 2, you should build and install `NQPTP`, a companion application that provides AirPlay 2 timing support for Shairport Sync. You'll find the software itself and an installation guide [here](https://github.com/mikebrady/nqptp/blob/main/README.md) (guide not yet updated for FreeBSD). Once you have built, installed and enabled NQPTP, you can proceed with building Shairport Sync.
 
 Now, download Shairport Sync from GitHub:
 ```
 $ git clone https://github.com/mikebrady/shairport-sync.git
 $ cd shairport-sync
 ```
-Next, configure the build and compile it:
+If you are building the AirPlay 2 version of Shairport Sync, for the present you should checkout the `development` version:
+
+```
+$ git checkout development
+```
+
+Next, configure the build and compile the `shairport-sync` application:
 
 ```
 $ autoreconf -i -f
-$ ./configure  --with-libdaemon --with-avahi --with-ssl=openssl  --with-sndio --with-libdaemon --with-os=freebsd --with-freebsd-service
+$ ./configure  --with-avahi --with-ssl=openssl --with-sndio --with-os=freebsd --with-freebsd-service
 $ make
 ```
-Add `--with-alsa` if you wish to include the ALSA back end. Omit the `--with-sndio` if you don't want the `sndio` back end. Omit the `--with-freebsd-service` if you don't want to install a FreeBSD startup script, runtime folder and user and group -- see below for more details.
+Add `--with-alsa` if you wish to include the ALSA back end. Omit the `--with-sndio` if you don't want the `sndio` back end.
+
+Omit the `--with-freebsd-service` if you don't want to install a FreeBSD startup script, runtime folder and user and group -- see below for more details.
+
 Add `--with-airplay-2` if you wish to build the AirPlay 2 version of Shairport Sync.
 
 Installation
@@ -77,7 +87,7 @@ $ su
 # make install
 ```
 
-With the `./configure` options shown above, this will install the `shairport-sync` program along with a sample configuration file at `/usr/local/etc/shairport-sync.conf`. A service startup script will also be installed to launch Shairport Sync as a daemon. In addition, a `shairport-sync` user and group will be added and a directory will be created at `/var/run/shairport-sync` owned by the user `shairport-sync`. This will be used to hold the daemon's PID file.
+With the `./configure` options shown above, this will install the `shairport-sync` program along with a sample configuration file at `/usr/local/etc/shairport-sync.conf`. A service startup script will also be installed to launch Shairport Sync as a daemon. In addition, a `shairport-sync` user and group will be added to enable `shairport-sync` to run with a low level of privilige (a primitive form of extra security).
 
 Finally, edit `/usr/local/etc/shairport-sync.conf` to customise your installation, e.g. service name, etc. To make the `shairport-sync` daemon load at startup, add the following line to `/etc/rc.conf`: