README.md 3.49 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

Marvin Scholz's avatar
Marvin Scholz committed
4
5
[![Build Status](https://travis-ci.org/xiph/Icecast-Server.svg?branch=master)](https://travis-ci.org/xiph/Icecast-Server)

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

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

16
17
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
18

19
20
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
21
22
Prerequisites
---------------------------------------------------------------------
23
24
25
26
27
28
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
29

30
31
32
__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
33

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

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

Run
48
49
50

    ./configure
    make
51
    make install  # as root
Michael Smith's avatar
Michael Smith committed
52

Marvin Scholz's avatar
Marvin Scholz committed
53
54
This is the typical procedure if you download the tar file.

Marvin Scholz's avatar
Marvin Scholz committed
55
If you retrive the code from Git, make sure to clone recursively:
Marvin Scholz's avatar
Marvin Scholz committed
56
57
58
59
60

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

After that, create the configure script by running: `./autogen.sh`.
Now you can just follow the steps mentioned above.
Michael Smith's avatar
Michael Smith committed
61

Thomas B. Rücker's avatar
Thomas B. Rücker committed
62
63
64
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`
65

66
Documentation for Icecast is available in the doc directory, by 
67
68
69
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
70

71
72
73
74
75
76
77
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
78

79
80
81
82
83
[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
84
[6]: http://lists.xiph.org/mailman/listinfo/icecast
85
[7]: http://lists.xiph.org/mailman/listinfo/icecast-dev
Thomas B. Rücker's avatar
Thomas B. Rücker committed
86
[8]: https://webchat.freenode.net/?channels=#icecast