README 2.44 KB
Newer Older
1 2
icecast 2.x - README
---------------------------------------------------------------------
Michael Smith's avatar
Michael Smith committed
3

Karl Heyes's avatar
Karl Heyes committed
4 5 6 7 8 9 10
Icecast is a streaming media server which currently supports Ogg
streaming including the vorbis and theora codecs. Also icecast can
handle other streams like MP3/AAC/NSV.
It can be used to create an Internet radio station or a privately
running jukebox and many things in between. It is very versatile in
that new formats can be added relatively easily and supports open
standards for communication and interaction.
Michael Smith's avatar
Michael Smith committed
11

12 13
Icecast is distributed under the GNU GPL, version 2. A copy of this
license is included with this software in the COPYING file.
14 15 16 17 18 19 20 21 22

Prerequisites
---------------------------------------------------------------------
icecast requires the following packages :

* libxml2 - http://xmlsoft.org/downloads.html
* libxslt - http://xmlsoft.org/XSLT/downloads.html
* curl - http://curl.haxx.se/download.html (>= version 7.10 required)
  NOTE: icecast may be compiled without curl, however this will
Karl Heyes's avatar
Karl Heyes committed
23 24
        disable Stream Directory server interaction (YP) and URL based 
        authentication.
25 26
* ogg/vorbis - http://www.vorbis.com/files (>= version 1.0 required)

Karl Heyes's avatar
Karl Heyes committed
27
A note about prerequisite packages
28
---------------------------------------------------------------------
Karl Heyes's avatar
Karl Heyes committed
29 30 31 32 33 34
Most distributions have some sort of package management repository for
pre-built packages (eg rpm, deb etc).  These setups often have a runtime
package, which is usually installed for you by default, and enables you
to run applications that depend on them.  However if you are building
icecast from source then the runtime system is not enough. You will also
need a development package named something like libxslt-devel
35 36 37

Build/Install
---------------------------------------------------------------------
38
To build icecast on a Unix platform, perform the following :
Michael Smith's avatar
Michael Smith committed
39 40 41 42 43 44

Run
   ./configure
   make
   make install

Karl Heyes's avatar
Karl Heyes committed
45 46 47
This is the typical procedure if you download the tar file.  If you retrive
the code from subversion or want to rebuild the configure then run autogen.sh
instead of the configure above. Most people do not need to run autogen.sh
Michael Smith's avatar
Michael Smith committed
48

49 50
A sample config file will be placed in /usr/local/etc (on UNIX) or in 
the current working directory (on Win32) and is called icecast.xml
51

52
Documentation for icecast is available in the doc directory, by 
53
viewing doc/index.html in a browser.
Michael Smith's avatar
Michael Smith committed
54 55

Please email us at icecast@xiph.org or icecast-dev@xiph.org, or come and see
56
us at irc.freenode.net, channel #icecast, if you have any troubles.
Michael Smith's avatar
Michael Smith committed
57