$Id: ReadMe.txt,v 1.5 2004/03/12 01:08:03 varenet Exp $

Copyright: 2002-2004 Regis BOUDIN, Thibaut VARENE

    This package is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This package is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this package; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA


mod_musicindex is an Apache module aimed at being a C implementation of the
Perl module Apache::MP3 (http://search.cpan.org/dist/Apache-MP3/).

It allows nice displaying of directories containing MP3 or Ogg Vorbis files,
including sorting them on various fields, streaming and/or downloading them,
constructing playlists and searching them.
It features a cache subsystem, currently based on mirroring the tree
structure handled by the module, storing files data into flat text files.
It can also delegate streaming of files to an icecast server, as long as they
can be accessed using the same URI ("staticdir" option).
If you add a picture of a CD cover in a directory, it will be displayed in the
upper left corner of the web page. The file must be named "cover.jpg",
"cover.png" or "cover.gif".

The musicindex directory contains a musicindex.css file you can easily
tweak to modify the display of the pages.

This is a beta release, use it at your own risks.

This software is under heavy development and testing, and feedback would be
greatly appreciated.

Don't hesitate to mail puffin@esiee.fr with subject "mod_musicindex"

You need to have the following libraries installed:
 - Ogg Bitstream Library (libogg)
 - Vorbis Library (libvorbis)
 - ID3 tag reading library from the MAD project (libid3tag0)
 - MPEG audio decoder library (libmad0)

This module is pure C and works with Apache 1.3 and Apache 2

Here's a sample httpd.conf extract:

LoadModule musicindex_module /usr/libexec/httpd/mod_musicindex.so
<Directory /var/www/MP3/>
    Options Indexes MultiViews FollowSymlinks
    AllowOverride None
    MusicLister
    MusicSortOrder      artist album track title
    MusicFields		title artist album track length bitrate
    MusicAllowDownload
    MusicAllowStream
    MusicAllowSearch
    MusicCachePath	/tmp/musicindex
    MusicPageTitle	MyName
    MusicIceServer      [ice.domain.my]:8000
</Directory>

Please note that, as any configuration example, it must adapted to your own
system. Please refer to necessary manpages, documentation and howtos.

There are some default values for MusicSortOrder, MusicFields and MusicPageTitle, so these
variables aren't mandatory.
The search system is _very_ experimental, as well as cache subsystem.
To disable any of these features, just remove the appropriate line in the conf
example above.
Note that setting an icecast server automatically enable streaming.
If the MusicIceServer begins with a semicolon ':', the module assumes that
the icecast server is running on the same host than the webserver, and the
number following the semicolon is the port which icecast listens for clients.


Don't forget to reload apache.

More info can be found on the project home page:
http://freshmeat.net/projects/musicindex/

Enjoy!

NB: Icons were downloaded from http://art.gnome.org/icons.php.
From http://art.gnome.org/icons.php:
 Most of the icons of this section were done by Tuomas "tigert" Kuosamen
 and Jakub "jimmac" Steiner. Some icons were done by Garrett LeSage, Ed
 Halley, and Roman "star" Beigelbeck.

The current stylesheet (musicindex.css) is mostly inspired from the original
Apache::MP3 one.

The mod_musicindex devel team.
