CAJUN Installation

Obtaining & Installing CAJUN

The first step is to obtain the CAJUN software. You need to download the latest release from the http://www.cajun.nu website. The package will come in one of two formats:

Unpacking (installing) from tarball

If you've downloaded a cajun-nnn.tar.gz file (where nnn is the version number of the version you downloaded), you simply need to install it in the usual spot:

	shell# cd /usr/share/
	shell# tar -xzf /tmp/cajun-nnn.tar.gz

where nnn is the version number of the version you downloaded. This will place all files in the /usr/share/cajun directory. Note that it's possible a release will unpack into the /usr/share/cajun-nnn directory; if this happens, we slipped up - just type:

	mv /usr/share/cajun-nnn /usr/share/cajun

where here (again) nnn is the version number of the version you downloaded.

Installing from RPM

If you've downloaded an rpm file, simply install it in the usual manner:

	shell# rpm -i /tmp/cajun-nnn.rpm

where nnn is the version number of the version you downloaded. This will place all files in the /usr/share/cajun directory, and will perform some configuration on your machine.

Package Dependancies

The CAJUN software relies on other software packages to do its job. Once you've got the main CAJUN package installed, you can check to see whether these other packages are already installed. After they're installed, you can go on to configure the CAJUN software.

Before installing, check your RPM database to see if a suitable version of that package is already installed by default; for example,

	rpm -qa | grep 'apache\|httpd'

will show you what Apache RPMs are installed.

Your life will be much easier if you download and install RPMs instead of building from source. The RedHat CDs have many of these packages. Or, you can go to the indicated website to get the latest release. We recommend using the latest *stable* packages - not development releases.

Once you locate the RPMs, you can install them with 'rpm -i'. Note that the rpm command may inform you that other, unrelated packages are required; you'll need to install those first.

MySQL: www.mysql.com/downloads

why it's needed / what it does:
MySQL is a database. A database stores information. CAJUN stores configuration information as well as mp3 info in MySQL.
how to get it:
You'll need the following rpms from a RedHat CD or ftp site:
```
	mysql, mysql-server and mysql-devel
```
Or, if you're downloading from mysql.com, you'll need to go for the links to "server," "client programs" and "libraries and header files for development." They end up giving you the same three rpm files.
how to install it:
```
	rpm -i mysql-nnn.rpm mysql-server-nnn.rpm mysql-devel-nnn.rpm
```
where nnn is the version number of the version you downloaded.
how to set it up:
After installing MySQL, you'll need to setup the MySQL database. To do that, run /usr/share/cajun/install/setup-database. See the documentation for setup-database for more information.
notes:
In the future, scripts will be available to upgrade from previous versions of CAJUN, so you don't lose the contents of your database.

Apache: httpd.apache.org/download.cgi

why it's needed / what it does:
Apache is a web server that runs on your computer to serve web pages to a web browser. CAJUN needs Apache to serve configuration web pages to you (the user) so that you can configure CAJUN.
how to get it:
You'll need the following rpm:
```
	apache
```
in more recent versions of Apache, the name is changed to:
```
	httpd
```
You only need one, httpd or apache.
how to install it:
```
	rpm -i apache-nnn.rpm
```
or
```
	rpm -i httpd-nnn.rpm
```
depending on which one you downloaded. Here, nnn is the version number of the version you downloaded. If it complains that it conflicts with a bunch of things that are already installed, chances are you already have Apache installed.
how to set it up:
Run $cajun/install/apache--cajun-style as root. This sets up several things in Apache to CAJUNize it. See the documentation for apache--cajun-style for a description of what it configures.)
notes:
1. Note that Apache is only needed for CAJUN configuration; it's not needed for normal CAJUN operation. To reduce boot-up time and reduce memory usage, you'll want to make sure apache doesn't start automatically. See the Bootup/Tuning section for more information.
2. When you're ready to use Apache to configure your machine, simply log in as root and type /etc/rc.d/init.d/httpd start. Remember this, so when you want to tweak your CAJUN 4 months from now, you remember that you have to start Apache first.

Perl and Perl modules: www.perl.org

why it's needed / what it does:
Perl is the language in which CAJUN is written. You'll need a Perl interpreter to get your CAJUN functioning.
Perl modules are helper programs that CAJUN uses so the authors don't have spend time duplicating what others have already done.
how to get it:
You'll need at least version 5.8.0 of Perl. Note that just about every distribution of Linux comes with Perl pre-installed, so you likely won't need to get this one. If it's not included with your distribution, you'll have to hunt down the rpms or get the source and build/install it yourself. The Perl people seem to want us end-users to build Perl from source.
You still need to install the Perl modules that CAJUN needs. There's a handy internet archive of perl modules called CPAN, and with that, it's fairly easy to get the modules CAJUN needs. CPAN is the Comprehensive Perl Archive Network at http://www.perl.org/CPAN. People who write Perl modules post their software there, so others can download it easily.
But it's even easier than that - CAJUN automates these steps for you. As root, run $cajun/install/install-CPAN-modules. See the documentation for install-CPAN-modules to find out what goes on under the hood or if that script should not work for some reason.
how to install it:
See above
how to set it up:
Nothing to do, really.
notes:
1. If you are prompted for manual configuration, just say "no".
2. If you're ever asked to "follow dependancies and prepend them to the queue?", answer yes.
3. If you're asked "Do you want to modify/update your configuration," it means you already have that module installed. Answer no if you like the one you have or yes if you'd like the newer one. It's likely that either will be sufficient.
4. Any other questions you're asked and are not sure of the answer, accept the default.

icecast: www.icecast.org (optional component)*

why it's needed / what it does:
To summarize Icecast (and Shoutcast) quickly, they are a way to broadcast audio streams. A core server accepts mp3- or ogg-encoded audio streams from encoders, and broadcasts them to clients, who then listen to the audio via soundcard and speakers. This can be setup on just one machine in your home/car or the stream can go to all the machines in your home. Public servers on the internet with enough bandwidth often support hundreds of clients listening to many different audio streams.

There are, then, three components to an Icecast/Shoutcast setup:
1. An Icecast server (to manage the connections)
2. One or more encoders (to supply audio data to the server)
3. One or more clients (to listen to the data from the server)
CAJUN can act as either an encoder or client:
- To use CAJUN as a client, see the section Using the Icecast Client audio device. This is useful, for instance, if you have a friend running an Icecast or Shoutcast server; so you can listen in on his or her music stream. This is also the way to get your CAJUN to let you listen to internet radio stations.
- To get CAJUN to act as an encoder/server, you'll need to install the libshout library and Shout Perl module. This would be useful, for instance, in a home or office - many clients can be listening to CAJUN's audio at once. Or, perhaps a large mobile home? This is a great way to make your own internet radio and have it broadcast what's playing on your cajun (should you have the internet bandwidth to be an internet radio server and share your tunes with the world).
Here's a summary of what there is to get:
- Icecast is a program that acts as the encoder/server on Linux systems. It is a free program that is compatible with Nullsoft's Shoutcast protocol.
- libshout is a library to make it easy to interface with an icecast server in 'c'.
- The Shout Perl module brings the ease of use of libshout to the world of Perl (the language in which CAJUN is written).
how to get it:
Note: This installation is only needed to become an Icecast encoder/server.

Go to http://developer.icecast.org/libshout/ and download the latest version of libshout (either source or rpm) and the perl module Shout.
how to install it:
```
	rpm -i libshout-nnn.rpm
```
where nnn is the version number of the version you downloaded.
Or, if you got the source for libshout, make and install it.

Next, make and install the Shout Perl module. As far as we know, there's no rpm option for this one.
how to set it up:

To get the icecast server to startup automatically with each reboot, add this line to /etc/rc.d/rc.local (or some equivalent startup script):
```
	/usr/local/icecast/bin/icecast -b
```
Make sure to modify /usr/local/icecast in the line to be the location that icecast was installed.
notes:
*This Icecast installation step is optional and only for those who want their CAJUN to act as an Icecast encoder/server. To use CAJUN as a client, see the section on Using the Icecast Client audio device.

As soon as you're done with installation, you're ready to go on to configuration.