MyFavMirrors
/
owntone-server
mirror of https://github.com/owntone/owntone-server.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[docs] Updates to INSTALL.md 

- document --enable-install-user and --disable-install-systemd
- drop LSB init stuff (outdated)
- drop libevent 2.0 notes (outdated)
This commit is contained in:
ejurgensen 2021-08-31 22:48:33 +02:00
parent ab6bdf0db1
commit 28ff1b71f2
1 changed files with 64 additions and 85 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

149
INSTALL.md
View File

@ -29,32 +29,48 @@ sudo apt-get install \
Note that OwnTone will also work with other versions and flavours of Note that OwnTone will also work with other versions and flavours of
libgcrypt and libcurl, so the above are just suggestions. libgcrypt and libcurl, so the above are just suggestions.
Optional packages: The following features require extra packages, and that you add a configure
argument when you run ./configure:
Feature | Configure argument | Packages Feature | Configure argument | Packages
---------------------|--------------------------|------------------------------------------------ ---------------------|--------------------------|-------------------------------------
Chromecast | `--enable-chromecast` | libgnutls*-dev libprotobuf-c-dev Chromecast | `--enable-chromecast` | libgnutls*-dev
Spotify (built-in) | `--disable-spotify` | libprotobuf-c-dev
Spotify (libspotify) | `--enable-libspotify` | libspotify-dev Spotify (libspotify) | `--enable-libspotify` | libspotify-dev
Player web UI | `--disable-webinterface` | libwebsockets-dev
Live web UI | `--with-libwebsockets` | libwebsockets-dev
Pulseaudio | `--with-pulseaudio` | libpulse-dev Pulseaudio | `--with-pulseaudio` | libpulse-dev
These features can be disabled saving you package dependencies:
Feature | Configure argument | Packages
---------------------|--------------------------|-------------------------------------
Spotify (built-in) | `--disable-spotify` | libprotobuf-c-dev
Player web UI | `--disable-webinterface` | libwebsockets-dev
Live web UI | `--without-libwebsockets`| libwebsockets-dev
Then run the following (adding configure arguments for optional features): Then run the following (adding configure arguments for optional features):
```bash ```bash
git clone https://github.com/owntone/owntone-server.git git clone https://github.com/owntone/owntone-server.git
cd owntone-server cd owntone-server
autoreconf -i autoreconf -i
./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var --enable-install-user
make make
sudo make install sudo make install
``` ```
Finally, read the section [Long version - after installation Using `--enable-install-user` means that `make install` will also add system
](#Long-version---after-installation) in the bottom of this document, which user and group for owntone.
describes configuration, setting up init scripts and adding a system user.
Also see the [README.md](README.md) for usage information. With the above configure arguments, a systemd service file will be installed to
`/etc/systemd/system/owntone.service` so that the server will start on boot.
Use `--disable-install-systemd` if you don't want that.
Now edit `/etc/owntone.conf`. Note the guide at the top highlighting which
settings that normally require modification.
Start the server with `sudo systemctl start owntone` and check that it is
running with `sudo systemctl status owntone`.
See the [README.md](README.md) for usage information.
## Quick version for Fedora ## Quick version for Fedora
@ -89,29 +105,31 @@ Then run the following:
```bash ```bash
autoreconf -i autoreconf -i
./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var --enable-install-user
make make
sudo make install sudo make install
``` ```
Finally, read the section [Long version - after installation Using `--enable-install-user` means that `make install` will also add system
](#Long-version---after-installation) in the bottom of this document, which user and group for owntone.
describes configuration, setting up init scripts and adding a system user.
Also see the README for usage information. With the above configure arguments, a systemd service file will be installed to
`/etc/systemd/system/owntone.service` so that the server will start on boot.
Use `--disable-install-systemd` if you don't want that.
Now edit `/etc/owntone.conf`. Note the guide at the top highlighting which
settings that normally require modification.
Start the server with `sudo systemctl start owntone` and check that it is
running with `sudo systemctl status owntone`.
See the [README.md](README.md) for usage information.
## Quick version for FreeBSD ## Quick version for FreeBSD
You can use the ports framework to handle dependencies and build options, so There is a script in the 'scripts' folder that will at least attempt to do all
the following is sufficient to build from source on FreeBSD: the work for you. And should the script not work for you, you can still look
through it and use it as an installation guide.
```sh
cd /usr/ports/audio/forked-daapd
make install
```
Otherwise, there is a script in the 'scripts' folder that will at least attempt
to do all the work for you. And should the script not work for you,
you can still look through it and use it as an installation guide.
## Quick version for macOS (using Homebrew) ## Quick version for macOS (using Homebrew)
@ -121,9 +139,11 @@ all the steps that you need to execute:
## "Quick" version for macOS (using macports) ## "Quick" version for macOS (using macports)
Caution: macports requires many downloads and lots of time to install Caution:
(and sometimes build) ports... you'll want a decent network connection 1) this approach may be out of date, consider using the Homebrew method above
and some patience! since it is continuously tested.
2) macports requires many downloads and lots of time to install (and sometimes
build) ports... you'll want a decent network connection and some patience!
Install macports (which requires Xcode): Install macports (which requires Xcode):
https://www.macports.org/install.php https://www.macports.org/install.php
@ -236,8 +256,8 @@ Libraries:
from <http://avahi.org/> from <http://avahi.org/>
- sqlite3 3.5.0+ with unlock notify API enabled (read below) - sqlite3 3.5.0+ with unlock notify API enabled (read below)
from <http://sqlite.org/download.html> from <http://sqlite.org/download.html>
- libav 9+ or ffmpeg 0.11+ - ffmpeg (libav)
from <http://libav.org/> or <http://ffmpeg.org/> from <http://ffmpeg.org/>
- libconfuse - libconfuse
from <http://www.nongnu.org/confuse/> from <http://www.nongnu.org/confuse/>
- libevent 2.0+ (best with 2.1.4+) - libevent 2.0+ (best with 2.1.4+)
@ -280,10 +300,6 @@ enable the unlock notify API (you can check for the presence of the
sqlite3_unlock_notify symbol in the sqlite3 library). Refer to the sqlite3 sqlite3_unlock_notify symbol in the sqlite3 library). Refer to the sqlite3
documentation, look for `SQLITE_ENABLE_UNLOCK_NOTIFY`. documentation, look for `SQLITE_ENABLE_UNLOCK_NOTIFY`.
libav (or ffmpeg) is a central piece of OwnTone and most other FLOSS
multimedia applications. The version of libav you use will potentially have a
great influence on your experience with OwnTone.
## Long version - building and installing ## Long version - building and installing
Start by generating the build system by running `autoreconf -i`. This will Start by generating the build system by running `autoreconf -i`. This will
@ -351,11 +367,18 @@ present (with headers). Use `--without-pulseaudio` to disable.
Recommended build settings: Recommended build settings:
```bash ```bash
./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var --enable-install-user
``` ```
After configure run the usual make, and if that went well, `sudo make install`. After configure run the usual make, and if that went well, `sudo make install`.
With the above configure arguments, a systemd service file will be installed to
`/etc/systemd/system/owntone.service` so that the server will start on boot.
Use `--disable-install-systemd` if you don't want that.
Using `--enable-install-user` means that `make install` will also add a system
user and group for owntone.
You may see two kinds of warnings during make. You may see two kinds of warnings during make.
First, `/usr/bin/antlr3` may generate a long series of warnings that First, `/usr/bin/antlr3` may generate a long series of warnings that
begin like this: begin like this:
@ -375,59 +398,15 @@ RSPLexer.c:2674:16: warning: unused variable `_type' [-Wunused-variable]
You can safely ignore all of these warnings. You can safely ignore all of these warnings.
## Long version - after installation
After installation: After installation:
- edit the configuration file, `/etc/owntone.conf` - edit the configuration file, `/etc/owntone.conf`
- make sure the Avahi daemon is installed and running (Debian: - make sure the Avahi daemon is installed and running (Debian:
`apt install avahi-daemon`) `apt install avahi-daemon`)
Note that `sudo make install` will not install any system files to start the OwnTone will drop privileges to any user you specify in the configuration file
service after boot, and it will not setup a system user. if it's started as root.
OwnTone will drop privileges to any user you'll specify in the This user must have read permission to your library and read/write permissions
configuration file if it's started as root. to the database location (`$localstatedir/cache/owntone` by default).
This user must have read permission on your library (you can create a group for
this and make the user a member of the group, for instance) and read/write
permissions on the database location (`$localstatedir/cache/owntone` by
default).
If your system uses systemd then you might be able to use the service file
included, see `owntone.service`.
Otherwise you might need an init script to start OwnTone at boot. A simple
init script will do, OwnTone daemonizes all by itself and creates a
pidfile under `/var/run`. Different distributions have different standards for
init scripts and some do not use init scripts anymore; check the documentation
for your distribution.
For dependency-based boot systems, here are the OwnTone dependencies:
- local filesystems
- network filesystems, if needed in your setup (library on NFS, ...)
- networking
- NTP
- Avahi daemon
The LSB header below sums it up:
```bash
### BEGIN INIT INFO
# Provides: owntone
# Required-Start: $local_fs $remote_fs $network $time
# Required-Stop: $local_fs $remote_fs $network $time
# Should-Start: avahi
# Should-Stop: avahi
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: DAAP/DACP (iTunes) server, support for AirPlay and Spotify
# Description: OwnTone is an iTunes-compatible media server for sharing
# your media library over the local network with DAAP/DACP
# clients like iTunes. Like iTunes, it can be controlled by
# Apple Remote (and compatibles) and stream music directly to
# AirPlay devices. It also supports streaming to RSP clients
# (Roku devices) and streaming from Spotify.
### END INIT INFO
```