1
0
mirror of https://gitlab.xiph.org/xiph/icecast-server.git synced 2024-11-03 04:17:17 -05:00
icecast-server/README.md
Ralph Giles b4565da411 Update git url.
The readme referred to the old git.xiph.org server, which is no
longer online.
2022-09-05 22:33:12 +00:00

3.5 KiB

Icecast 2 - README

Build Status

Icecast is a streaming media server which currently supports WebM and Ogg streaming including the Opus, Vorbis and Theora codecs. Also Icecast can handle other streams like MP3/AAC/NSV in legacy mode, but this is not officially supported.

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.

Icecast is distributed under the GNU GPL, version 2. A copy of this license is included with this software in the COPYING file.

The name of this software is spelled "Icecast" with a leading capital 'I' but with a lower case 'c'. Any other spelling is incorrect.

Prerequisites

Icecast requires the following packages:

NOTE: Icecast may be compiled without curl, however this will disable Stream Directory server interaction (YP) and URL based authentication.

A note about prerequisite packages

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

Build/Install

To build Icecast on a Unix platform, perform the following steps:

Run

./configure
make
make install  # as root

This is the typical procedure if you download the tar file.

If you retrive the code from Git, make sure to clone recursively:

git clone --recursive https://gitlab.xiph.org/xiph/icecast-server.git

After that, create the configure script by running: ./autogen.sh. Now you can just follow the steps mentioned above.

A sample config file will be placed in /usr/local/etc (on UNIX, also depends on path PREFIX) or in the current working directory (on Win32) and is called icecast.xml

Documentation for Icecast is available in the doc directory, by viewing doc/index.html in a browser. It's also installed to $PREFIX/share/doc/icecast/. Online documentation can be found on the Icecast Website.

If you have problems with setting up Icecast, please join the Icecast mailing list and then email icecast@xiph.org. In case you have patches or want to discuss development issues, please join the Icecast developer mailing list and then email icecast-dev@xiph.org. Or come and see us on irc.freenode.net, channel #icecast (please be patient, people are not always at their computers).