index.html 7.74 KB
Newer Older
ePirat's avatar
ePirat committed
1
<!DOCTYPE html>
2 3
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
4
<head>
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <meta name="description" content="None">
  
  <link rel="shortcut icon" href="./img/favicon.ico">
  <title>Introduction - Icecast Docs</title>
  <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>

  <link rel="stylesheet" href="./css/theme.css" type="text/css" />
  <link rel="stylesheet" href="./css/theme_extra.css" type="text/css" />
  <link rel="stylesheet" href="./css/highlight.css">
  
  <script>
    // Current page data
    var mkdocs_page_name = "Introduction";
    var mkdocs_page_input_path = "index.md";
    var mkdocs_page_url = "/";
  </script>
  
  <script src="./js/jquery-2.1.1.min.js"></script>
  <script src="./js/modernizr-2.8.3.min.js"></script>
  <script type="text/javascript" src="./js/highlight.pack.js"></script> 
  
29
</head>
ePirat's avatar
ePirat committed
30

31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
      <div class="wy-side-nav-search">
        <a href="." class="icon icon-home"> Icecast Docs</a>
        
      </div>

      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
	<ul class="current">
	  
          
            <li class="toctree-l1 current">
		
    <a class="current" href=".">Introduction</a>
    <ul class="subnav">
            
    <li class="toctree-l2"><a href="#icecast-25-beta-2-documentation">Icecast 2.5 Beta 2 Documentation</a></li>
    

    <li class="toctree-l2"><a href="#prerequisites">Prerequisites</a></li>
    

    <li class="toctree-l2"><a href="#what-platforms-are-supported">What platforms are supported?</a></li>
    

    <li class="toctree-l2"><a href="#buildinstall">Build/Install</a></li>
    

    <li class="toctree-l2"><a href="#where-do-i-go-for-questions">Where do I go for questions?</a></li>
    

    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <a class="" href="basic_setup/">Basic Setup</a>
	    </li>
          
            <li class="toctree-l1">
		
    <a class="" href="config_file/">Configuration File</a>
	    </li>
          
            <li class="toctree-l1">
		
    <a class="" href="server_stats/">Server Statistics</a>
	    </li>
          
            <li class="toctree-l1">
		
    <a class="" href="auth/">Authentication</a>
	    </li>
          
            <li class="toctree-l1">
		
    <a class="" href="relaying/">Relaying</a>
	    </li>
          
            <li class="toctree-l1">
		
    <a class="" href="yp/">Listing in a YellowPage Directory</a>
	    </li>
          
            <li class="toctree-l1">
		
    <a class="" href="admin_interface/">Admin Interface</a>
	    </li>
          
            <li class="toctree-l1">
		
    <a class="" href="win32/">Windows Specific</a>
	    </li>
          
        </ul>
      </div>
      &nbsp;
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
ePirat's avatar
ePirat committed
115

116 117 118 119 120
      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href=".">Icecast Docs</a>
      </nav>
ePirat's avatar
ePirat committed
121 122

      
123 124 125 126 127 128
      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href=".">Docs</a> &raquo;</li>
    
ePirat's avatar
ePirat committed
129
      
130 131 132 133 134
    
    <li>Introduction</li>
    <li class="wy-breadcrumbs-aside">
      
    </li>
ePirat's avatar
ePirat committed
135
  </ul>
136
  <hr/>
ePirat's avatar
ePirat committed
137
</div>
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
          <div role="main">
            <div class="section">
              
                <h1 id="icecast-25-beta-2-documentation">Icecast 2.5 Beta 2 Documentation</h1>
<p>Icecast is a streaming media server which currently supports Ogg Vorbis and MP3 audio streams.
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 commuincation and interaction.</p>
<p>Icecast is distributed under the GNU GPL, version 2. A copy of this license is included with
this software in the COPYING file.</p>
<p>There are two major parts to most streaming media servers: The component providing the
content (what we call source clients) and the component which is responsible for serving that
content to listeners (this is the function of Icecast).</p>
<h1 id="prerequisites">Prerequisites</h1>
<p>Icecast requires the following packages:</p>
<ul>
<li><a href="http://xmlsoft.org/downloads.html">libxml2</a></li>
<li><a href="http://xmlsoft.org/XSLT/downloads.html">libxslt</a></li>
<li><a href="http://curl.haxx.se/download.html">curl</a> Version &gt;= 7.10</li>
<li><a href="http://www.vorbis.com/files">libogg/libvorbis</a> Version &gt;= 1.0</li>
<li><a href="https://www.openssl.org/source/">OpenSSL</a> (Optional, enable if SSL support is desired)</li>
</ul>
<h1 id="what-platforms-are-supported">What platforms are supported?</h1>
<p>Currently the following Unix platforms are supported:</p>
<ul>
<li>Linux (Most flavors including Redhat and Debian)</li>
<li>FreeBSD</li>
<li>OpenBSD</li>
<li>Solaris</li>
</ul>
<p>Currently the following Windows platforms are supported:</p>
<ul>
<li>Windows Vista</li>
<li>Windows 7</li>
<li>Windows 8</li>
<li>Windows 10</li>
<li>Windows Server 2003</li>
<li>Windows Server 2008</li>
<li>Windows Server 2012</li>
</ul>
<h1 id="buildinstall">Build/Install</h1>
<p>To build Icecast on a Unix platform, perform the following:</p>
<p>Run</p>
<pre><code>./configure
ePirat's avatar
ePirat committed
182 183 184
make
make install
</code></pre>
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
<p>to build and install this release.</p>
<p>A sample config file will be placed in <code>/usr/local/etc</code> (on UNIX) or in the current working
directory (on Win32) and is called <code>icecast.xml</code>.</p>
<p>Documentation for Icecast is available in the doc directory, by viewing <code>doc/index.html</code> in a
browser.</p>
<h1 id="where-do-i-go-for-questions">Where do I go for questions?</h1>
<p>There are many ways to contact the icecast development team, best ways are:</p>
<ul>
<li>The <a href="http://lists.xiph.org/mailman/listinfo/icecast">Icecast Mailing list</a></li>
<li>The <a href="http://lists.xiph.org/mailman/listinfo/icecast-dev">Icecast Developer Mailing list</a>, for more development-related questions.</li>
<li>Icecast IRC Chat at the <a href="irc://irc.freenode.net:6667/#icecast">#icecast</a> channel on irc.freenode.net</li>
</ul>
              
            </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="basic_setup/" class="btn btn-neutral float-right" title="Basic Setup">Next <span class="icon icon-circle-arrow-right"></span></a>
      
      
    </div>
  
209

210
  <hr/>
211

212 213 214 215
  <div role="contentinfo">
    <!-- Copyright etc -->
    
  </div>
216

217 218 219 220 221
  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>.
</footer>
      
        </div>
      </div>
222

223
    </section>
ePirat's avatar
ePirat committed
224

225
  </div>
ePirat's avatar
ePirat committed
226

227 228 229 230 231 232 233 234 235 236 237
  <div class="rst-versions" role="note" style="cursor: pointer">
    <span class="rst-current-version" data-toggle="rst-current-version">
      
      
      
        <span style="margin-left: 15px"><a href="basic_setup/" style="color: #fcfcfc">Next &raquo;</a></span>
      
    </span>
</div>
    <script>var base_url = '.';</script>
    <script src="./js/theme.js"></script>
ePirat's avatar
ePirat committed
238

239
</body>
240
</html>
241 242 243 244 245

<!--
MkDocs version : 0.17.2
Build Date UTC : 2017-11-20 19:03:57
-->