[docs] Update to reflect player web interface and libwebsockets dependency

This commit is contained in:
ejurgensen 2018-06-05 23:04:34 +02:00
parent db6bbd76bd
commit 565f0b07bd
3 changed files with 17 additions and 12 deletions

17
INSTALL
View File

@ -41,6 +41,7 @@ Optional packages:
LastFM | --enable-lastfm | libcurl4-gnutls-dev OR libcurl4-openssl-dev LastFM | --enable-lastfm | libcurl4-gnutls-dev OR libcurl4-openssl-dev
iTunes XML | --disable-itunes | libplist-dev iTunes XML | --disable-itunes | libplist-dev
Device verification | --disable-verification | libplist-dev libsodium-dev Device verification | --disable-verification | libplist-dev libsodium-dev
Player web UI | --disable-webinterface | libwebsockets-dev
Live web UI | --with-libwebsockets | libwebsockets-dev Live web UI | --with-libwebsockets | libwebsockets-dev
Pulseaudio | --with-pulseaudio | libpulse-dev Pulseaudio | --with-pulseaudio | libpulse-dev
@ -72,7 +73,7 @@ sudo yum install \
git automake autoconf gettext-devel gperf gawk libtool \ git automake autoconf gettext-devel gperf gawk libtool \
sqlite-devel libconfuse-devel libunistring-devel mxml-devel libevent-devel \ sqlite-devel libconfuse-devel libunistring-devel mxml-devel libevent-devel \
avahi-devel libgcrypt-devel zlib-devel alsa-lib-devel ffmpeg-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: Clone the forked-daapd repo:
@ -125,7 +126,7 @@ Afterwards, you can optionally install Oracle's newer version, and then
sudo port install \ sudo port install \
autoconf automake libtool pkgconfig git gperf libgcrypt \ 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: Download, configure, build and install the Mini-XML library:
http://www.msweet.org/projects.php/Mini-XML http://www.msweet.org/projects.php/Mini-XML
@ -239,7 +240,7 @@ Libraries:
from <http://www.gnutls.org/> from <http://www.gnutls.org/>
- libprotobuf-c (optional - Chromecast support) - libprotobuf-c (optional - Chromecast support)
from <https://github.com/protobuf-c/protobuf-c/wiki> from <https://github.com/protobuf-c/protobuf-c/wiki>
- libwebsockets (optional - websocket support) - libwebsockets 2.0.2+ (optional - websocket support)
from <https://libwebsockets.org/> from <https://libwebsockets.org/>
If using binary packages, remember that you need the development packages to 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 Support for Chromecast devices is optional. Use --enable-chromecast to enable
this feature. this feature.
Building with libwebsockets is optional. Websockets improve the UI of the web The player web interface is optional. Use --disable-webinterface to disable
interface. It will be enabled if the library is present (with headers). Use this feature.
--without-libwebsockets to disable.
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 Building with Pulseaudio is optional. It will be enabled if the library is
present (with headers). Use --without-pulseaudio to disable. present (with headers). Use --without-pulseaudio to disable.

View File

@ -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). 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 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 check. No web interface? Then check the top of forked-daapd's log file (usually
forked-daapd's log file (usually /var/log/forked-daapd.log). /var/log/forked-daapd.log).
Note that you are viewing a snapshot of the instructions that may or may not 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 match the version of forked-daapd that you are using. Go to
@ -117,11 +117,11 @@ probably obsolete when you read it :-)
## Web interface ## 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). 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, Use the web interface to control playback, trigger manual library rescans, pair
select speakers, authenticate with Spotify, etc. with remotes, select speakers, authenticate with Spotify, etc.
## Using Remote ## Using Remote

View File

@ -11,7 +11,7 @@ fi
DEPS="gmake autoconf automake libtool gettext gperf glib pkgconf wget git \ DEPS="gmake autoconf automake libtool gettext gperf glib pkgconf wget git \
ffmpeg libconfuse libevent mxml libgcrypt libunistring libiconv \ 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 "The script can install the following dependency packages for you:"
echo $DEPS echo $DEPS
read -p "Should the script install these packages? [y/N] " yn read -p "Should the script install these packages? [y/N] " yn