Rivendellaudio/INSTALL

This is the installation file for the Rivendell package.

MANDATORY PREREQUISITES
You will need the following installed and configured properly on your 
system before building Rivendell:

Apache Web Server
Included with most distros, or available from: http://www.apache.org/.

Cdda2Wav
A CD ripper engine.  Included in most distributions, but also available from 
http://www.cdda2wav.de/.

ID3Lib
An audio metadata tag library.  Included in most distros, or available at 
http://id3lib.sourceforge.net/.

LibCurl, v7.19.0 or later
A client-side URL transfer library.  Included with most distros, or
available at: http://curl.haxx.se/libcurl/.

LibParanoia
A library for ripping audio CDs.  Included in most distributions, but also 
available from http://www.xiph.org/paranoia/.

LibSndFile
An audio file support library, written by Erik de Castro Lopo.  Included with
most distros, or you can find it at http://www.mega-nerd.com/libsndfile/.

mySQL Database Server
Included in most Linux distributions.  See http://www.mysql.com/.

PAM Pluggable Authentication Modules
A suite of shared libraries that enable the local system administrator to 
choose how applications authenticate users.  Included with virtually all modern
distros, or see http://www.kernel.org/pub/linux/libs/pam/.

OggVorbis - Open Source Audio Coding Library.  Needed for OggVorbis
importing and exporting.  Included with most distros, or available at: 
http://www.xiph.org/.

Qt Toolkit, v3.3 or better
Most modern Linux distros include this.  It's typically installed as part
of the KDE Desktop Environment, although KDE is by no means required.
It can also be downloaded directly from TrollTech (http://www.trolltech.com/).

Secret Rabbit Code
A sample-rate converter library, written by Erik de Castro Lopo.  Included
with most distros, or you can find it at http://www.mega-nerd.com/SRC/.

SoundTouch Audio Processing Library
A library for altering the pitch and/or tempo of digital audio data.
Available at http://www.surina.net/soundtouch/.

X11 Window System
Virtually all Linux distros should include this.


OPTIONAL PREREQUISITES
The following components are optional, but needed at build- and run- time in
order for particular features to work:

One or more audio driver libraries.  Choices are:

  AudioScience HPI Driver - v3.00 or greater.
  For supporting AudioScience's line of high-end professional audio adapters.  
  See http://www.audioscience.com/.

  The JACK Audio Connection Kit
  A low latency audio server, designed from the ground up for
  professional audio work.  See http://jackit.sourceforge.net/.
  Further information on running Rivendell with the JACK driver can be
  found in 'docs/JACK.txt'.

  The Advanced Linux Sound Architecture (ALSA) v1.0 or greater.
  The standard soundcard driver for Linux for kernels 2.6.x or later.
  See http://www.alsa-project.org/.

Free Lossless Audio Codec (FLAC), v1.2.x or greater
A "lossless" audio encoding library.  Included with most distros, or 
available from: http://flac.sourceforge.net/.

GPIO Driver
A kernel driver for the line of data-acquisition boards from 
MeasurementComputing.  See http://www.rivendellaudio.org/.

LAME - MPEG Layer 3 Encoder Library.  Needed for MPEG Layer 3 exporting.
Available at http://lame.sourceforge.net/.

MAD - MPEG Audio Decoder Library.  Needed for MPEG importing and playout.
Available at http://www.underbit.com/products/mad/.

TwoLAME - MPEG Layer 2 Encoder Library.  Needed for MPEG Layer 2 exporting and
capture.  Available at http://www.twolame.org/.


INSTALLATION
There are three major steps to getting a Rivendell system up and
running.  They are:

1)  Setting up pre-requisite software

2)  Installing the Rivendell package

3)  Initial configuration


1)  Setting Up Prerequisites

The major prerequisite piece of software needed for a functioning
Rivendell system is the mySQL database engine.  This needs to
be accessible from the target system (either by running on the local
host, or on a remote system) before Rivendell installation proper
is commenced.  In practice, this means that the 'mysqld' daemon is
running and can be connected to using the mysql(1) client.  You will
also need a login name/password for an account on the server with
administrative rights.

The process of configuring mySQL on a given host can be intricate and
is generally beyond the scope of this document.  Details can be found
in a number of books on the subject, as well as in the very extensive
documentation that accompanies the server itself.

If GPIO support is desired, this is also the time to install and test
the kernel GPIO driver. Full installation instructions as well as the 
list of currently supported GPIO boards are included in the package.


2)  Installing the Rivendell Package

Once the prerequisites are set up, installation is most often a matter of 
cd'ing to the top of the Rivendell source tree and typing
'./configure', 'make', followed (as root) by 'make install'.  Those
who obtained the source via CVS will need to do './autogen.sh' first.

The ./configure script will auto-detect what sound drivers (HPI, JACK
or ALSA) are available and enable build support accordingly.  To override
this behavior, it's possible to specify '--disable-hpi',
'--disable-jack' or '--disable-alsa' as an argument to './configure'.
Be sure to see the important additional information regarding
configuration in the 'docs/JACK.txt' or 'docs/ALSA.txt' files if you
plan on using those sound driver architectures.

Rivendell's web services components are installed in the directory specified
by the '--libexecdir=' parameter given to './configure' (default 
'EPREFIX/bin').  The proper location will vary widely on different distros 
according to how Apache is installed.  On SuSE (assuming the default setup),
the proper invocation is '--libexecdir=/srv/www/rd-bin'.  Additionally, 
Apache itself must be configured to use the specified directory.  The 
'./configure' script generates a configuration file snippet that can be
included into the Apache configuration to accomplish this in 
'conf/rd-bin.conf'.  On Ubuntu copy that file to the /etc/apache2/conf.d/
directory.


3)  Initial Configuration

Next, you'll need to install a small configuration file at
'/etc/rd.conf'.  A sample can be found in 'conf/rd.conf-sample'.  Much
of this can be used unchanged, with the exception of the entries in the 
[Identity] section.  These should be changed to reflect the user and group 
name of the system accounts that will be running Rivendell.

The directory for the audio sample data next needs to be created, as
so:

	mkdir /var/snd

This directory should owned, readable, writable and searchable by the user 
and group specified in the 'AudioOwner=' and 'AudioGroup=' entires in
'/etc/rd.conf' and readable and searchable by Others (mode 0775).

Finally, it's time to start things up.  Run 'rdadmin' from a shell
prompt.  For the first time startup, RDAdmin will prompt for a login
name/password on the mySQL server so that it can create the Rivendell
database.  To log into RDAdmin for the first time, enter a User Name of
'admin' with no password.

Much of the work in Rivendell gets done by three daemon processes,
named 'caed', 'ripcd' and 'rdcatchd'.  These daemons *must* be running
before attempting to start any of the Rivendell applications.  The
order in which they are started is important, and should be the same
as the order in which they are listed above.  For convienence, a Sys-V
style init script called 'rivendell' that can start, stop and restart 
the daemons properly is installed in '/etc/init.d/'.