README.md 3.27 KB
Newer Older
1
Icecast 2 - README
Ed "oddsock" Zaleski's avatar
Ed "oddsock" Zaleski committed
2
---------------------------------------------------------------------
Michael Smith's avatar
Michael Smith committed
3

4 5 6
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
7
in legacy mode, but this is not officially supported.
8

Karl Heyes's avatar
Karl Heyes committed
9 10 11 12
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
13

14 15
Icecast is distributed under the GNU GPL, version 2. A copy of this
license is included with this software in the COPYING file.
Ed "oddsock" Zaleski's avatar
Ed "oddsock" Zaleski committed
16

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

Ed "oddsock" Zaleski's avatar
Ed "oddsock" Zaleski committed
19 20
Prerequisites
---------------------------------------------------------------------
21 22 23 24 25 26
Icecast requires the following packages:

-   [libxml2][1]
-   [libxslt][2]
-   [curl][3] (>= version 7.10 required)
-   [ogg/vorbis][4] (>= version 1.0 required)
Ed "oddsock" Zaleski's avatar
Ed "oddsock" Zaleski committed
27

28 29 30
__NOTE__: Icecast may be compiled without curl, however this will
disable Stream Directory server interaction (YP) and URL based 
authentication.
Ed "oddsock" Zaleski's avatar
Ed "oddsock" Zaleski committed
31

Karl Heyes's avatar
Karl Heyes committed
32
A note about prerequisite packages
Ed "oddsock" Zaleski's avatar
Ed "oddsock" Zaleski committed
33
---------------------------------------------------------------------
Karl Heyes's avatar
Karl Heyes committed
34 35 36 37
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
38
Icecast from source then the runtime system is not enough. You will also
Karl Heyes's avatar
Karl Heyes committed
39
need a development package named something like libxslt-devel
Ed "oddsock" Zaleski's avatar
Ed "oddsock" Zaleski committed
40 41 42

Build/Install
---------------------------------------------------------------------
43
To build Icecast on a Unix platform, perform the following steps:
Michael Smith's avatar
Michael Smith committed
44 45

Run
46 47 48

    ./configure
    make
49
    make install  # as root
Michael Smith's avatar
Michael Smith committed
50

Karl Heyes's avatar
Karl Heyes committed
51
This is the typical procedure if you download the tar file.  If you retrive
Thomas B. Rücker's avatar
Thomas B. Rücker committed
52 53
the code from Git or want to rebuild the configure then run `./autogen.sh`
instead of configure above. Most people do not need to run autogen.sh
Michael Smith's avatar
Michael Smith committed
54

Thomas B. Rücker's avatar
Thomas B. Rücker committed
55 56 57
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`
58

59
Documentation for Icecast is available in the doc directory, by 
60 61 62
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][5].
Michael Smith's avatar
Michael Smith committed
63

64 65 66 67 68 69 70
If you have problems with setting up Icecast, please join the 
[Icecast mailing list][6] and then email icecast@xiph.org.
In case you have patches or want to discuss development issues,
please join the [Icecast developer mailing list][7] and then
email icecast-dev@xiph.org.
Or come and see us on irc.freenode.net, channel [#icecast][8]
(please be patient, people are not always at their computers).
Michael Smith's avatar
Michael Smith committed
71

72 73 74 75 76
[1]: http://xmlsoft.org/downloads.html
[2]: http://xmlsoft.org/XSLT/downloads.html
[3]: http://curl.haxx.se/download.html
[4]: http://www.vorbis.com/files
[5]: http://icecast.org/docs/
Thomas B. Rücker's avatar
Thomas B. Rücker committed
77
[6]: http://lists.xiph.org/mailman/listinfo/icecast
78
[7]: http://lists.xiph.org/mailman/listinfo/icecast-dev
Thomas B. Rücker's avatar
Thomas B. Rücker committed
79
[8]: https://webchat.freenode.net/?channels=#icecast