| 1 |
<!DOCTYPE html> |
| 2 |
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| 3 |
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| 4 |
<head> |
| 5 |
<meta charset="utf-8"> |
| 6 |
<meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| 7 |
<meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| 8 |
<meta name="description" content="None"> |
| 9 |
|
| 10 |
<link rel="shortcut icon" href="./img/favicon.ico"> |
| 11 |
<title>Introduction - Icecast Docs</title> |
| 12 |
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'> |
| 13 |
|
| 14 |
<link rel="stylesheet" href="./css/theme.css" type="text/css" /> |
| 15 |
<link rel="stylesheet" href="./css/theme_extra.css" type="text/css" /> |
| 16 |
<link rel="stylesheet" href="./css/highlight.css"> |
| 17 |
|
| 18 |
<script> |
| 19 |
// Current page data |
| 20 |
var mkdocs_page_name = "Introduction"; |
| 21 |
var mkdocs_page_input_path = "index.md"; |
| 22 |
var mkdocs_page_url = "/"; |
| 23 |
</script> |
| 24 |
|
| 25 |
<script src="./js/jquery-2.1.1.min.js"></script> |
| 26 |
<script src="./js/modernizr-2.8.3.min.js"></script> |
| 27 |
<script type="text/javascript" src="./js/highlight.pack.js"></script> |
| 28 |
|
| 29 |
</head> |
| 30 |
|
| 31 |
<body class="wy-body-for-nav" role="document"> |
| 32 |
|
| 33 |
<div class="wy-grid-for-nav"> |
| 34 |
|
| 35 |
|
| 36 |
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> |
| 37 |
<div class="wy-side-nav-search"> |
| 38 |
<a href="." class="icon icon-home"> Icecast Docs</a> |
| 39 |
|
| 40 |
</div> |
| 41 |
|
| 42 |
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| 43 |
<ul class="current"> |
| 44 |
|
| 45 |
|
| 46 |
<li class="toctree-l1 current"> |
| 47 |
|
| 48 |
<a class="current" href=".">Introduction</a> |
| 49 |
<ul class="subnav"> |
| 50 |
|
| 51 |
<li class="toctree-l2"><a href="#icecast-250-documentation">Icecast 2.5.0 Documentation</a></li> |
| 52 |
|
| 53 |
|
| 54 |
<li class="toctree-l2"><a href="#prerequisites">Prerequisites</a></li> |
| 55 |
|
| 56 |
|
| 57 |
<li class="toctree-l2"><a href="#what-platforms-are-supported">What platforms are supported?</a></li> |
| 58 |
|
| 59 |
|
| 60 |
<li class="toctree-l2"><a href="#buildinstall">Build/Install</a></li> |
| 61 |
|
| 62 |
|
| 63 |
<li class="toctree-l2"><a href="#where-do-i-go-for-questions">Where do I go for questions?</a></li> |
| 64 |
|
| 65 |
|
| 66 |
</ul> |
| 67 |
</li> |
| 68 |
|
| 69 |
<li class="toctree-l1"> |
| 70 |
|
| 71 |
<a class="" href="basic_setup/">Basic Setup</a> |
| 72 |
</li> |
| 73 |
|
| 74 |
<li class="toctree-l1"> |
| 75 |
|
| 76 |
<a class="" href="config_file/">Configuration File</a> |
| 77 |
</li> |
| 78 |
|
| 79 |
<li class="toctree-l1"> |
| 80 |
|
| 81 |
<a class="" href="server_stats/">Server Statistics</a> |
| 82 |
</li> |
| 83 |
|
| 84 |
<li class="toctree-l1"> |
| 85 |
|
| 86 |
<a class="" href="auth/">Authentication</a> |
| 87 |
</li> |
| 88 |
|
| 89 |
<li class="toctree-l1"> |
| 90 |
|
| 91 |
<a class="" href="relaying/">Relaying</a> |
| 92 |
</li> |
| 93 |
|
| 94 |
<li class="toctree-l1"> |
| 95 |
|
| 96 |
<a class="" href="yp/">Listing in a YellowPage Directory</a> |
| 97 |
</li> |
| 98 |
|
| 99 |
<li class="toctree-l1"> |
| 100 |
|
| 101 |
<a class="" href="admin_interface/">Admin Interface</a> |
| 102 |
</li> |
| 103 |
|
| 104 |
<li class="toctree-l1"> |
| 105 |
|
| 106 |
<a class="" href="win32/">Windows Specific</a> |
| 107 |
</li> |
| 108 |
|
| 109 |
</ul> |
| 110 |
</div> |
| 111 |
|
| 112 |
</nav> |
| 113 |
|
| 114 |
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| 115 |
|
| 116 |
|
| 117 |
<nav class="wy-nav-top" role="navigation" aria-label="top navigation"> |
| 118 |
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| 119 |
<a href=".">Icecast Docs</a> |
| 120 |
</nav> |
| 121 |
|
| 122 |
|
| 123 |
<div class="wy-nav-content"> |
| 124 |
<div class="rst-content"> |
| 125 |
<div role="navigation" aria-label="breadcrumbs navigation"> |
| 126 |
<ul class="wy-breadcrumbs"> |
| 127 |
<li><a href=".">Docs</a> »</li> |
| 128 |
|
| 129 |
|
| 130 |
|
| 131 |
<li>Introduction</li> |
| 132 |
<li class="wy-breadcrumbs-aside"> |
| 133 |
|
| 134 |
</li> |
| 135 |
</ul> |
| 136 |
<hr/> |
| 137 |
</div> |
| 138 |
<div role="main"> |
| 139 |
<div class="section"> |
| 140 |
|
| 141 |
<h1 id="icecast-250-documentation">Icecast 2.5.0 Documentation</h1> |
| 142 |
<p>Icecast is a streaming media server which currently supports Ogg Vorbis and MP3 audio streams. |
| 143 |
It can be used to create an Internet radio station or a privately running jukebox and many |
| 144 |
things in between. It is very versatile in that new formats can be added relatively easily |
| 145 |
and supports open standards for commuincation and interaction.</p> |
| 146 |
<p>Icecast is distributed under the GNU GPL, version 2. A copy of this license is included with |
| 147 |
this software in the COPYING file.</p> |
| 148 |
<p>There are two major parts to most streaming media servers: The component providing the |
| 149 |
content (what we call source clients) and the component which is responsible for serving that |
| 150 |
content to listeners (this is the function of Icecast).</p> |
| 151 |
<h1 id="prerequisites">Prerequisites</h1> |
| 152 |
<p>Icecast requires the following packages:</p> |
| 153 |
<ul> |
| 154 |
<li><a href="http://xmlsoft.org/downloads.html">libxml2</a></li> |
| 155 |
<li><a href="http://xmlsoft.org/XSLT/downloads.html">libxslt</a></li> |
| 156 |
<li><a href="http://curl.haxx.se/download.html">curl</a> Version >= 7.10</li> |
| 157 |
<li><a href="http://www.vorbis.com/files">libogg/libvorbis</a> Version >= 1.0</li> |
| 158 |
<li><a href="https://www.openssl.org/source/">OpenSSL</a> (Optional, enable if SSL support is desired)</li> |
| 159 |
</ul> |
| 160 |
<h1 id="what-platforms-are-supported">What platforms are supported?</h1> |
| 161 |
<p>Currently the following Unix platforms are supported:</p> |
| 162 |
<ul> |
| 163 |
<li>Linux (Most flavors including Redhat and Debian)</li> |
| 164 |
<li>FreeBSD</li> |
| 165 |
<li>OpenBSD</li> |
| 166 |
<li>Solaris</li> |
| 167 |
</ul> |
| 168 |
<p>Currently the following Windows platforms are supported:</p> |
| 169 |
<ul> |
| 170 |
<li>Windows Vista</li> |
| 171 |
<li>Windows 7</li> |
| 172 |
<li>Windows 8</li> |
| 173 |
<li>Windows 10</li> |
| 174 |
<li>Windows Server 2003</li> |
| 175 |
<li>Windows Server 2008</li> |
| 176 |
<li>Windows Server 2012</li> |
| 177 |
</ul> |
| 178 |
<h1 id="buildinstall">Build/Install</h1> |
| 179 |
<p>To build Icecast on a Unix platform, perform the following:</p> |
| 180 |
<p>Run</p> |
| 181 |
<pre><code>./configure |
| 182 |
make |
| 183 |
make install |
| 184 |
</code></pre> |
| 185 |
<p>to build and install this release.</p> |
| 186 |
<p>A sample config file will be placed in <code>/usr/local/etc</code> (on UNIX) or in the current working |
| 187 |
directory (on Win32) and is called <code>icecast.xml</code>.</p> |
| 188 |
<p>Documentation for Icecast is available in the doc directory, by viewing <code>doc/index.html</code> in a |
| 189 |
browser.</p> |
| 190 |
<h1 id="where-do-i-go-for-questions">Where do I go for questions?</h1> |
| 191 |
<p>There are many ways to contact the icecast development team, best ways are:</p> |
| 192 |
<ul> |
| 193 |
<li>The <a href="http://lists.xiph.org/mailman/listinfo/icecast">Icecast Mailing list</a></li> |
| 194 |
<li>The <a href="http://lists.xiph.org/mailman/listinfo/icecast-dev">Icecast Developer Mailing list</a>, for more development-related questions.</li> |
| 195 |
<li>Icecast IRC Chat at the <a href="ircs://irc.libera.chat:6697/#icecast">#icecast</a> channel on libera.chat</li> |
| 196 |
</ul> |
| 197 |
|
| 198 |
</div> |
| 199 |
</div> |
| 200 |
<footer> |
| 201 |
|
| 202 |
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| 203 |
|
| 204 |
<a href="basic_setup/" class="btn btn-neutral float-right" title="Basic Setup">Next <span class="icon icon-circle-arrow-right"></span></a> |
| 205 |
|
| 206 |
|
| 207 |
</div> |
| 208 |
|
| 209 |
|
| 210 |
<hr/> |
| 211 |
|
| 212 |
<div role="contentinfo"> |
| 213 |
<!-- Copyright etc --> |
| 214 |
|
| 215 |
</div> |
| 216 |
|
| 217 |
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| 218 |
</footer> |
| 219 |
|
| 220 |
</div> |
| 221 |
</div> |
| 222 |
|
| 223 |
</section> |
| 224 |
|
| 225 |
</div> |
| 226 |
|
| 227 |
<div class="rst-versions" role="note" style="cursor: pointer"> |
| 228 |
<span class="rst-current-version" data-toggle="rst-current-version"> |
| 229 |
|
| 230 |
|
| 231 |
|
| 232 |
<span style="margin-left: 15px"><a href="basic_setup/" style="color: #fcfcfc">Next »</a></span> |
| 233 |
|
| 234 |
</span> |
| 235 |
</div> |
| 236 |
<script>var base_url = '.';</script> |
| 237 |
<script src="./js/theme.js"></script> |
| 238 |
|
| 239 |
</body> |
| 240 |
</html> |
| 241 |
|
| 242 |
<!-- |
| 243 |
MkDocs version : 0.17.2 |
| 244 |
Build Date UTC : 2017-11-20 19:03:57 |
| 245 |
--> |