From 565f0b07bd4b2f4c5ef993c94977cb7029e96166 Mon Sep 17 00:00:00 2001 From: ejurgensen Date: Tue, 5 Jun 2018 23:04:34 +0200 Subject: [PATCH] [docs] Update to reflect player web interface and libwebsockets dependency --- INSTALL | 17 +++++++++++------ README.md | 10 +++++----- scripts/freebsd_install_11.0.sh | 2 +- 3 files changed, 17 insertions(+), 12 deletions(-) diff --git a/INSTALL b/INSTALL index 4be9e456..0dd87bce 100644 --- a/INSTALL +++ b/INSTALL @@ -41,6 +41,7 @@ Optional packages: LastFM | --enable-lastfm | libcurl4-gnutls-dev OR libcurl4-openssl-dev iTunes XML | --disable-itunes | libplist-dev Device verification | --disable-verification | libplist-dev libsodium-dev + Player web UI | --disable-webinterface | libwebsockets-dev Live web UI | --with-libwebsockets | libwebsockets-dev Pulseaudio | --with-pulseaudio | libpulse-dev @@ -72,7 +73,7 @@ sudo yum install \ git automake autoconf gettext-devel gperf gawk libtool \ sqlite-devel libconfuse-devel libunistring-devel mxml-devel libevent-devel \ avahi-devel libgcrypt-devel zlib-devel alsa-lib-devel ffmpeg-devel \ - libplist-devel libsodium-devel json-c-devel + libplist-devel libsodium-devel json-c-devel libwebsockets-devel Clone the forked-daapd repo: @@ -125,7 +126,7 @@ Afterwards, you can optionally install Oracle's newer version, and then sudo port install \ autoconf automake libtool pkgconfig git gperf libgcrypt \ - libunistring libconfuse ffmpeg libevent json-c + libunistring libconfuse ffmpeg libevent json-c libwebsockets Download, configure, build and install the Mini-XML library: http://www.msweet.org/projects.php/Mini-XML @@ -239,7 +240,7 @@ Libraries: from - libprotobuf-c (optional - Chromecast support) from - - libwebsockets (optional - websocket support) + - libwebsockets 2.0.2+ (optional - websocket support) from If using binary packages, remember that you need the development packages to @@ -300,9 +301,13 @@ to disable this feature. Support for Chromecast devices is optional. Use --enable-chromecast to enable this feature. -Building with libwebsockets is optional. Websockets improve the UI of the web -interface. It will be enabled if the library is present (with headers). Use ---without-libwebsockets to disable. +The player web interface is optional. Use --disable-webinterface to disable +this feature. + +Building with libwebsockets is optional, but required if you want the player +web interface (so not required for the admin web interface, where websockets +only improve the UI). It will be enabled if the library is present (with +headers). Use --without-libwebsockets to disable. Building with Pulseaudio is optional. It will be enabled if the library is present (with headers). Use --without-pulseaudio to disable. diff --git a/README.md b/README.md index fafe85ce..3b51a106 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,8 @@ Before you continue, make sure you know what version of forked-daapd you have, and what features it was built with (e.g. Spotify support). How to find out? Go to the [web interface](http://forked-daapd.local:3689) and -check the information in the footer. No web interface? Then check the top of -forked-daapd's log file (usually /var/log/forked-daapd.log). +check. No web interface? Then check the top of forked-daapd's log file (usually +/var/log/forked-daapd.log). Note that you are viewing a snapshot of the instructions that may or may not match the version of forked-daapd that you are using. Go to @@ -117,11 +117,11 @@ probably obsolete when you read it :-) ## Web interface -You can find forked-daapd's admin web interface at [http://forked-daapd.local:3689](http://forked-daapd.local:3689) +You can find forked-daapd's web interface at [http://forked-daapd.local:3689](http://forked-daapd.local:3689) or alternatively at [http://[your_server_address_here]:3689](http://[your_server_address_here]:3689). -Use the web interface to trigger manual library rescans, pair with remotes, -select speakers, authenticate with Spotify, etc. +Use the web interface to control playback, trigger manual library rescans, pair +with remotes, select speakers, authenticate with Spotify, etc. ## Using Remote diff --git a/scripts/freebsd_install_11.0.sh b/scripts/freebsd_install_11.0.sh index 1207f523..a792c0bb 100644 --- a/scripts/freebsd_install_11.0.sh +++ b/scripts/freebsd_install_11.0.sh @@ -11,7 +11,7 @@ fi DEPS="gmake autoconf automake libtool gettext gperf glib pkgconf wget git \ ffmpeg libconfuse libevent mxml libgcrypt libunistring libiconv \ - libplist libinotify avahi sqlite3 alsa-lib libsodium json-c" + libplist libinotify avahi sqlite3 alsa-lib libsodium json-c libwebsockets" echo "The script can install the following dependency packages for you:" echo $DEPS read -p "Should the script install these packages? [y/N] " yn