]> git.ipfire.org Git - thirdparty/shairport-sync.git/blob - OPENBSD.md
Update check_classic_systemd_full.yml
[thirdparty/shairport-sync.git] / OPENBSD.md
1 Shairport Sync on OpenBSD [AirPlay 2 Not Supported]
2 ----
3 This is a note about installing Shairport Sync on OpenBSD. Shairport Sync compiles and runs natively on OpenBSD using the `sndio` back end. For general information on `sndio` please follow [this link](http://www.sndio.org).
4
5 Unlike FreeBSD, it seems that OpenBSD does not use the directory `/usr/local/etc` as a system configuration directory ("`sysconfdir`") but follows the same practice as Linux in using `/etc` as the default `sysconfdir`.
6
7 General
8 ----
9 This build was done on a default build of `OpenBSD 6.6 GENERIC.MP#5 amd64`. Following [this guide](https://www.openbsd.org/faq/faq15.html), `/etc/installurl` was created with the to refer to the standard repository:
10 ```
11 https://ftp.openbsd.org/pub/OpenBSD
12 ```
13 You might have a [closer or faster](https://www.openbsd.org/ftp.html) repository to use instead.
14
15 Next, although it may not always be necessary, apply any outstanding system updates and [update the packages](https://unix.stackexchange.com/questions/23579/how-to-apply-updates-on-openbsd-netbsd-and-freebsd).
16
17 First, update the system:
18 ```
19 # syspatch
20 ```
21 Now update the packages:
22 ```
23 # pkg_add -Uu
24 ```
25 Install the Avahi subsystem ([search](https://www.openbsd.org/faq/faq15.html) using, for example, `# pkg_info -Q avahi`).
26 ```
27 # pkg_add avahi
28 ```
29 A number of libraries will be installed to support Avahi, including the D-Bus system.
30 Enable the D-Bus and Avahi subsystems to [start automatically](http://openbsd-archive.7691.n7.nabble.com/starting-avahi-the-proper-way-td311612.html):
31 ```
32 # rcctl enable messagebus avahi_daemon
33 # rcctl start messagebus avahi_daemon
34 ```
35 Building
36 ----
37
38 Install the following packages (e.g. using `pkg_add` in superuser mode) needed to download and build Shairport Sync:
39 ```
40 # pkg_add autoconf automake popt libconfig git
41 ```
42 Note the versions of `autoconf` and `automake` you choose (`2.69` and `1.16` at the time of writing) and add them as shell variable definitions for -- they could be placed in the user's `.profile` file to be automatically executed at login:
43 ```
44 export AUTOCONF_VERSION=2.69
45 export AUTOMAKE_VERSION=1.16
46 ```
47 Now, download Shairport Sync from GitHub:
48 ```
49 $ git clone https://github.com/mikebrady/shairport-sync.git
50 $ cd shairport-sync
51 ```
52 Next, configure and compile shairport-sync:
53 ```
54 $ autoreconf -fi
55 $ ./configure --sysconfdir=/etc --with-avahi --with-ssl=openssl --with-libdaemon \
56 --with-sndio --with-os=openbsd
57 $ make
58 ```
59 The application is called `shairport-sync`. Check that it's running correctly by executing the following command:
60 ```
61 $ ./shairport-sync -V
62 ```
63 This will execute the application and it will return its version information and terminate, for example:
64 ```
65 3.3.6-libdaemon-OpenSSL-Avahi-sndio-sysconfdir:/etc
66 ```
67 There is no make install yet -- you're on your own.
68
69 Using the `sndio` backend
70 ----
71 The `sndio` back end does not yet have a hardware volume control facility.
72 You should set the volume to maximum before use, using, for example, the `mixerctl` command.