aniani/icecast-server
1
0
Fork 0
mirror of https://gitlab.xiph.org/xiph/icecast-server.git synced 2024-12-04 14:46:30 -05:00
Code

- more xhtmlification of the icecast docs

Browse Source 
svn path=/icecast/trunk/icecast/; revision=7789
This commit is contained in:
j 2004-09-18 16:50:19 +00:00
parent 40ba95a6a6
commit 936cedefb8
4 changed files with 47 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/icecast2_basicsetup.html
View File

@ -7,20 +7,22 @@
</head> </head>
<body> <body>
<div class="boxtest"> <div class="boxtest">
<body bgcolor="#efefef" text="#323232" link="#0000ff" vlink="#800080" alink="#ff0000">
<h1>Icecast 2 Basic Setup</h1> <h1>Icecast 2 Basic Setup</h1>
<table width="100%"><tr><td bgcolor="#007B79" height="10" align="center"></td></tr></table> <table width="100%"><tr><td bgcolor="#007B79" height="10" align="center"></td></tr></table>
<p>
<br /> <br />
<br /> <br />
<br /> <br />
</p>
<h2>Basic Requirements</h2> <h2>Basic Requirements</h2>
<p>This section will describe the essential requirements in setting up a simple Internet radio station. It is by no means a complete list but should give you enough to get started.</p> <p>This section will describe the essential requirements in setting up a simple Internet radio station. It is by no means a complete list but should give you enough to get started.</p>
<p>There are two major components involved: the streaming server (icecast in this case) and the source client. The icecast server will be the place where all listeners of your station will connect. The source client (in general) runs on a separate machine than icecast, but does not necessarily need to. Source clients send the content to icecast and provide the stream data (encoded audio) that is then relayed out to listeners by icecast.</p> <p>There are two major components involved: the streaming server (icecast in this case) and the source client. The icecast server will be the place where all listeners of your station will connect. The source client (in general) runs on a separate machine than icecast, but does not necessarily need to. Source clients send the content to icecast and provide the stream data (encoded audio) that is then relayed out to listeners by icecast.</p>
<p>It is important to note that not all source clients work with icecast2. You will need to check to make sure that icecast2 is supported by your chosen source client.</p> <p>It is important to note that not all source clients work with icecast2. You will need to check to make sure that icecast2 is supported by your chosen source client.</p>
<p>
<br /> <br />
<br /> <br />
<br /> <br />
</p>
<h2>The Basics</h2> <h2>The Basics</h2>
<p>Each icecast server can house multiple broadcasts (or mountpoints) each containing a separate stream of content. A listener can only listen to a single mountpoint at a time. This means you can have a single icecast server contain either multiple broadcasts with different content, or possibly the same broadcast but with streams of different bitrates or qualities. In this case each broadcast or stream is a separate mountpoint.</p> <p>Each icecast server can house multiple broadcasts (or mountpoints) each containing a separate stream of content. A listener can only listen to a single mountpoint at a time. This means you can have a single icecast server contain either multiple broadcasts with different content, or possibly the same broadcast but with streams of different bitrates or qualities. In this case each broadcast or stream is a separate mountpoint.</p>
<p>At this point, the steps outlined here related to the Unix version or Win32 console version of icecast. Icecast is also available in a Win32 GUI version, and the steps are similar in setup, but not quite the same.</p> <p>At this point, the steps outlined here related to the Unix version or Win32 console version of icecast. Icecast is also available in a Win32 GUI version, and the steps are similar in setup, but not quite the same.</p>
@ -57,10 +59,11 @@ source password - from &lt;source-password&gt;<br />
<p>Additionally, you will need to choose a mountpoint and specify this in the source client. Icecast does not need to know about each mount point (although you can configure settings for specific mountpoint - this is covered under Advanced configuration) there are, however, some points to mention regarding mountpoints. All Ogg Vorbis streams should have mountpoints that end in .ogg (i,e. /mystream.ogg). This is due to the lazy way most media players infer the type of stream. MP3 streams usually do not contain an extension (/mystream). Mount points also should not contain any spaces or odd characters (again due to the lazy way many of the media players are coded).</p> <p>Additionally, you will need to choose a mountpoint and specify this in the source client. Icecast does not need to know about each mount point (although you can configure settings for specific mountpoint - this is covered under Advanced configuration) there are, however, some points to mention regarding mountpoints. All Ogg Vorbis streams should have mountpoints that end in .ogg (i,e. /mystream.ogg). This is due to the lazy way most media players infer the type of stream. MP3 streams usually do not contain an extension (/mystream). Mount points also should not contain any spaces or odd characters (again due to the lazy way many of the media players are coded).</p>
<p>Once you have configured your source client, you should be able to connect it to the icecast server. Verify that it is connected by hitting the stats.xml URL that was mentioned above.</p> <p>Once you have configured your source client, you should be able to connect it to the icecast server. Verify that it is connected by hitting the stats.xml URL that was mentioned above.</p>
<p>Now that you have the source connnected, listening to the stream involves simply opening the appropriate following URL in a browser: http://yourip:port/mounpointyouspecified.m3u. So, for instance, if you attached your source client to an icecast server located at 192.168.1.10:8000 with a mountpoint of /mystream.ogg, then you would open : http://192.168.1.10:8000/mystream.ogg.m3u. Note that the .m3u extention will serve up a link that opens most media players. Also it is important to note that m3u need not contain only MP3 stream, it can contain streams of arbitrary content-type and is used by icecast to serve a playlist that represents your broadcast to listening clients. Alternatively you can open up the stream URL directly within your media player (http://192.168.1.10:8000/mystream.ogg in this case)</p> <p>Now that you have the source connnected, listening to the stream involves simply opening the appropriate following URL in a browser: http://yourip:port/mounpointyouspecified.m3u. So, for instance, if you attached your source client to an icecast server located at 192.168.1.10:8000 with a mountpoint of /mystream.ogg, then you would open : http://192.168.1.10:8000/mystream.ogg.m3u. Note that the .m3u extention will serve up a link that opens most media players. Also it is important to note that m3u need not contain only MP3 stream, it can contain streams of arbitrary content-type and is used by icecast to serve a playlist that represents your broadcast to listening clients. Alternatively you can open up the stream URL directly within your media player (http://192.168.1.10:8000/mystream.ogg in this case)</p>
<p>
<br /> <br />
<br /> <br />
<br /> <br />
</p>
</div> </div>
</body> </body>
</html> </html>

22
doc/icecast2_config_file.html
View File

@ -7,13 +7,13 @@
</head> </head>
<body> <body>
<div class="boxtest"> <div class="boxtest">
<body bgcolor="#efefef" text="#323232" link="#0000ff" vlink="#800080" alink="#ff0000">
<h1>Icecast 2 Config File</h1> <h1>Icecast 2 Config File</h1>
<table width="100%"><tr><td bgcolor="#007B79" height="10" align="center"></td></tr></table> <table width="100%"><tr><td bgcolor="#007B79" height="10" align="center"></td></tr></table>
<h3>Overview</h3> <h3>Overview</h3>
<p> <p>
This section will describe each section of the config file and is grouped into the following sections: This section will describe each section of the config file and is grouped into the following sections:
</p> </p>
<ul>
<li><a href="#limits">Limits</a> <li><a href="#limits">Limits</a>
<li><a href="#authentication">Authentication</a> <li><a href="#authentication">Authentication</a>
<li><a href="#yp">YP Directory Settings</a> <li><a href="#yp">YP Directory Settings</a>
@ -23,10 +23,12 @@ This section will describe each section of the config file and is grouped into t
<li><a href="#path">File path settings</a> <li><a href="#path">File path settings</a>
<li><a href="#log">Logging</a> <li><a href="#log">Logging</a>
<li><a href="#security">Security</a> <li><a href="#security">Security</a>
</ul>
<p>
<br /> <br />
<br /> <br />
<br /> <br />
</p>
<a name="limits"></a> <a name="limits"></a>
<h2>Limits</h2> <h2>Limits</h2>
<pre> <pre>
@ -83,9 +85,11 @@ burst-on-connect, this is to quickly fill the pre-buffer used by media players.
is 64kbytes which is a typical size used by most clients so changing it is not usually required. is 64kbytes which is a typical size used by most clients so changing it is not usually required.
This setting applies to all mountpoints. This setting applies to all mountpoints.
</div> </div>
<p>
<br /> <br />
<br /> <br />
<br /> <br />
</p>
<a name="authentication"></a> <a name="authentication"></a>
<h2>Authentication</h2> <h2>Authentication</h2>
<pre> <pre>
@ -111,9 +115,11 @@ Currently not used.
<div class="indentedbox"> <div class="indentedbox">
The username/password used for all administration functions. This includes retrieving statistics, accessing the web-based administration screens, etc. A list of these functions can be found in the "Administration" section of the manual. The username/password used for all administration functions. This includes retrieving statistics, accessing the web-based administration screens, etc. A list of these functions can be found in the "Administration" section of the manual.
</div> </div>
<p>
<br /> <br />
<br /> <br />
<br /> <br />
</p>
<a name="yp"></a> <a name="yp"></a>
<h2>YP Directory Settings</h2> <h2>YP Directory Settings</h2>
<pre> <pre>
@ -132,9 +138,11 @@ This value is the maximum time icecast2 will wait for a response from a particul
<div class="indentedbox"> <div class="indentedbox">
The URL which icecast2 uses to communicate with the Directory server. The value for this setting is provided by the owner of the Directory server. The URL which icecast2 uses to communicate with the Directory server. The value for this setting is provided by the owner of the Directory server.
</div> </div>
<p>
<br /> <br />
<br /> <br />
<br /> <br />
</p>
<a name="misc"></a> <a name="misc"></a>
<h2>Misc Server Settings</h2> <h2>Misc Server Settings</h2>
<pre> <pre>
@ -166,9 +174,11 @@ And option IP address that can be used to bind to a specific network card. If n
<div class="indentedbox"> <div class="indentedbox">
This flag turns on the icecast2 fileserver from which static files can be served. All files are served relative to the path specified in the &lt;paths&gt;&lt;webroot&gt; configuration setting. This flag turns on the icecast2 fileserver from which static files can be served. All files are served relative to the path specified in the &lt;paths&gt;&lt;webroot&gt; configuration setting.
</div> </div>
<p>
<br /> <br />
<br /> <br />
<br /> <br />
</p>
<a name="relay"></a> <a name="relay"></a>
<h2>Relay Settings</h2> <h2>Relay Settings</h2>
<pre> <pre>
@ -277,9 +287,11 @@ The name to use for the local mountpoint. This is what the mount will be named
<div class="indentedbox"> <div class="indentedbox">
If you are relaying a Shoutcast stream, you need to specify this indicator to also relay the metadata (song titles) that is part of the Shoutcast stream (1=enabled, 0=disabled). If you are relaying a Shoutcast stream, you need to specify this indicator to also relay the metadata (song titles) that is part of the Shoutcast stream (1=enabled, 0=disabled).
</div> </div>
<p>
<br /> <br />
<br /> <br />
<br /> <br />
</p>
<a name="mount"></a> <a name="mount"></a>
<h2>Mount Specific Settings</h2> <h2>Mount Specific Settings</h2>
<pre> <pre>
@ -339,9 +351,11 @@ as defined in limits. The value is in bytes.
<div class="indentedbox"> <div class="indentedbox">
This specifies that the named mount point will require listener authentication. Currently, we only support a file-based authentication scheme (type=htpasswd). Users and encrypted password are placed in this file (separated by a :) and all requests for this mountpoint will require that a user and password be supplied for authentication purposes. These values are passed in via normal HTTP Basic Authentication means (i.e. http://user:password@stream:port/mountpoint.ogg). Users and Passwords are maintained via the web admin interface. A mountpoint configured with an authenticator will display a red key next to the mount point name on the admin screens. You can read more about listener authentication <a href="icecast2_listenerauth.html">here</a>. This specifies that the named mount point will require listener authentication. Currently, we only support a file-based authentication scheme (type=htpasswd). Users and encrypted password are placed in this file (separated by a :) and all requests for this mountpoint will require that a user and password be supplied for authentication purposes. These values are passed in via normal HTTP Basic Authentication means (i.e. http://user:password@stream:port/mountpoint.ogg). Users and Passwords are maintained via the web admin interface. A mountpoint configured with an authenticator will display a red key next to the mount point name on the admin screens. You can read more about listener authentication <a href="icecast2_listenerauth.html">here</a>.
</div> </div>
<p>
<br /> <br />
<br /> <br />
<br /> <br />
</p>
<a name="path"></a> <a name="path"></a>
<h2>Path Settings</h2> <h2>Path Settings</h2>
<pre> <pre>
@ -380,9 +394,11 @@ This path specifies the base directory used for all admin requests. More specif
<div class="indentedbox"> <div class="indentedbox">
Aliases are used to provide a way to create multiple mountpoints that refer to the same mountpoint. Aliases are used to provide a way to create multiple mountpoints that refer to the same mountpoint.
</div> </div>
<p>
<br /> <br />
<br /> <br />
<br /> <br />
</p>
<a name="log"></a> <a name="log"></a>
<h2>Logging Settings</h2> <h2>Logging Settings</h2>
<pre> <pre>
@ -409,10 +425,12 @@ Indicates what messages are logged by icecast. Log messages are categorized int
</div> </div>
<br /> <br />
<br /> <br />
<ul>
<li>loglevel = 4 - Debug, Info, Warn, Error messages are printed <li>loglevel = 4 - Debug, Info, Warn, Error messages are printed
<li>loglevel = 3 - Info, Warn, Error messages are printed <li>loglevel = 3 - Info, Warn, Error messages are printed
<li>loglevel = 2 - Warn, Error messages are printed <li>loglevel = 2 - Warn, Error messages are printed
<li>loglevel = 1 - Error messages only are printed <li>loglevel = 1 - Error messages only are printed
</ul>
<br /> <br />
<a name="security"></a> <a name="security"></a>
<h2>Security Settings</h2> <h2>Security Settings</h2>

30
doc/icecast2_introduction.html
View File

@ -22,25 +22,33 @@
<br /> <br />
<h2>What platforms are supported ?</h2> <h2>What platforms are supported ?</h2>
<p>Currently the following Unix platforms are supported:</p> <p>Currently the following Unix platforms are supported:</p>
<li>Linux (Most flavors including Redhat and Debian) <ul>
<li>FreeBSD <li>Linux (Most flavors including Redhat and Debian)</li>
<li>OpenBSD <li>FreeBSD</li>
<li>Solaris <li>OpenBSD</li>
<li>Solaris</li>
</ul>
<p>Currently the following Windows platforms are supported:</p> <p>Currently the following Windows platforms are supported:</p>
<li>Windows NT <ul>
<li>Windows 2000 <li>Windows NT</li>
<li>Windows XP <li>Windows 2000</li>
<li>Windows XP</li>
</ul>
<br /> <br />
<br /> <br />
<br /> <br />
<h2>Where do I go for questions?</h2> <h2>Where do I go for questions?</h2>
<p>There are many ways to contact the icecast development team</p> <p>There are many ways to contact the icecast development team</p>
<h3>Best Ways</h3> <h3>Best Ways</h3>
<li>Icecast mailing list <a href="http://www.xiph.org/archives">http://www.xiph.org/archives</a> <ul>
<li>Icecast Developers mailing list <a href="http://www.xiph.org/archives">http://www.xiph.org/archives</a> <li>Icecast mailing list <a href="http://www.xiph.org/archives">http://www.xiph.org/archives</a></li>
<li>Icecast IRC chat room - irc.freenode.net : #icecast <li>Icecast Developers mailing list <a href="http://www.xiph.org/archives">http://www.xiph.org/archives</a></li>
<li>Icecast IRC chat room - irc.freenode.net : #icecast</li>
</ul>
<h3>Alternate Ways</h3> <h3>Alternate Ways</h3>
<li>team@icecast.org <ul>
<li>team@icecast.org</li>
</ul>
<br /> <br />
<br /> <br />
<br /> <br />

6
doc/win32_section1.html
View File

@ -20,7 +20,6 @@ Examples of global statistics are :
The number of sources that have attempted connections The number of sources that have attempted connections
Total number of attempted connections to the server Total number of attempted connections to the server
</pre> </pre>
</p>
<p> <p>
The Server Status tab contains at a minimal the global stats for the server. Additionally, you may add source specific stats to this tab. The intent is to provide a single "dashboard view" of what's going on in the server. To add source statistics to the Server Status tab, see the section on the <a href="win32_section3.html">Stats</a> tab. The Server Status tab contains at a minimal the global stats for the server. Additionally, you may add source specific stats to this tab. The intent is to provide a single "dashboard view" of what's going on in the server. To add source statistics to the Server Status tab, see the section on the <a href="win32_section3.html">Stats</a> tab.
</p> </p>
@ -29,11 +28,10 @@ The Server Status tab contains at a minimal the global stats for the server. Ad
Any stat that is contained on the Server Status tab can be displayed as the icecast2 window title. This provides yet another mechanism by which you can view activities on the server. To enable this feature, right click on any stat in the Server Status tab as seen below : Any stat that is contained on the Server Status tab can be displayed as the icecast2 window title. This provides yet another mechanism by which you can view activities on the server. To enable this feature, right click on any stat in the Server Status tab as seen below :
</p> </p>
<img src="windowtitle.jpg" /> <img src="windowtitle.jpg" />
<p>
<h3>Removing source level stats from the Server Status Tab</h3> <h3>Removing source level stats from the Server Status Tab</h3>
<p> <p>
To remove a source level stat that you have inserted onto the Server Status Tab, simple right click that statistic and select "Delete from Global Stats". The stat will be deleted from the Server Status tab, but will still remain on the source level Stats tab. To remove a source level stat that you have inserted onto the Server Status Tab, simple right click that statistic and select "Delete from Global Stats". The stat will be deleted from the Server Status tab, but will still remain on the source level Stats tab.
</p>
</p> </p>
</div> </div>
</body>
</html>