Skip to content

GitLab

Commit 0081d9f7 authored by j's avatar j
Browse files

This Page Tentatively Validates As XHTML 1.0 Strict (Tentatively Valid)! 

svn path=/icecast/trunk/icecast/; revision=7792
parent 35cbc4a3
Hide whitespace changes
Inline Side-by-side
Showing with 54 additions and 49 deletions
doc/icecast2_admin.html 100755 → 100644
View file @ 0081d9f7
......@@ -7,7 +7,6 @@
</head>
<body>
<div class="boxtest">
<body bgcolor="#efefef" text="#323232" link="#0000ff" vlink="#800080" alink="#ff0000">
<h1>Icecast 2 Admin Interface</h1>
<hr id='titlebar' />
<br />
......@@ -21,6 +20,7 @@
<br />
<h2>Admin Functions (mount specific)</h2>
<p>All these admin functions are mount specific in that they only apply to a particular mountpoint (as opposed to applying to the entire server). Each of these functions requires a mountpoint to be specified as input.
</p>
<h3>Metadata Update</h3>
<h4>description</h4>
<div class="indentedbox">
......@@ -28,7 +28,7 @@ This function provides the ability for either a source client or any external pr
</div>
<h4>example</h4>
<pre>
http://192.168.1.10:8000/admin/metadata?mount=/mystream&mode=updinfo&song=ACDC+Back+In+Black
http://192.168.1.10:8000/admin/metadata?mount=/mystream&amp;mode=updinfo&amp;song=ACDC+Back+In+Black
</pre>
<br />
<br />
......@@ -39,7 +39,7 @@ This function provides the ability for either a source client or any external pr
</div>
<h4>example</h4>
<pre>
http://192.168.1.10:8000/admin/fallbacks?mount=/mystream.ogg&fallback=/myfallback.ogg
http://192.168.1.10:8000/admin/fallbacks?mount=/mystream.ogg&amp;fallback=/myfallback.ogg
</pre>
<br />
<br />
......@@ -61,7 +61,7 @@ This function provides the ability to migrate currently connected listeners from
</div>
<h4>example</h4>
<pre>
http://192.168.1.10:8000/admin/moveclients?mount=/mystream.ogg&destination=/mynewstream.ogg
http://192.168.1.10:8000/admin/moveclients?mount=/mystream.ogg&amp;destination=/mynewstream.ogg
</pre>
<br />
<br />
......@@ -72,7 +72,7 @@ This function provides the ability to disconnect a specific listener of a curren
</div>
<h4>example</h4>
<pre>
http://192.168.1.10:8000/admin/killclient?mount=/mystream.ogg&id=21
http://192.168.1.10:8000/admin/killclient?mount=/mystream.ogg&amp;id=21
</pre>
<br />
<br />
......@@ -122,7 +122,7 @@ http://192.168.1.10:8000/admin/stats.xsl
</pre>
<p>From this URL all of the other admin functions can be exercised.</p>
<p>Modification of existing XSLT transforms in /admin is allowed, but new files cannot be created here. Creation of new XSLT transforms as well as modification of existing transforms is allowed in /web. These work using the document returned by /admin/stats.xml. To see the XML document that is applied to each admin XSLT, just change the .xsl to .xml in your request (i.e. /admin/listclients.xml). You can then code your XSLT transform accordingly.
<br />
</p>
</div>
</body>
</html>
doc/icecast2_basicsetup.html 100755 → 100644
View file @ 0081d9f7
......@@ -27,14 +27,16 @@
<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>The first step in the process is to find and install the icecast2 server itself. How to do this is not contained within this documentation. After installation you should have and icecast binary and 3 directories</p>
<center>
<div style="text-align:center;">
<table border="1" width="75%">
<tr><td>conf</td><td>Contains the icecast configuration file (icecast.xml) which defines all the configuration parameters for the server.</td></tr>
<tr><td>admin</td><td>Contains xslt files which are used by the icecast server to provide a web-based front end to the administration capabilities of the server.</td></tr>
<tr><td>logs</td><td>This is a blank directory which (if specified in the config file) will contain all the logs (there are 2) for icecast.</td></tr>
</table>
</center>
<p>The next step is to edit the icecast.xml file and set the appropriate values. Most of the default values are fine as provided, and for a basic setup the following entries should be changed :<br /><br />
</div>
<p>The next step is to edit the icecast.xml file and set the appropriate values. Most of the default values are fine as provided, and for a basic setup the following entries should be changed :
<br /><br />
</p>
<pre>
&lt;source-password&gt; - will be used by the source client
&lt;admin-password&gt; - will be used to access admin features of icecast
......@@ -55,7 +57,8 @@ icecast -c /path/to/icecast.xml
<p>Now that the icecast server is started you must now configure your source client. The information you will need for the source client is the following : <br />
<br />
IP address and Port of the icecast server - both of these come from &lt;listen-socket&gt;<br />
source password - from &lt;source-password&gt;<br />
source password - from &lt;source-password&gt;
</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>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>
......
doc/icecast2_config_file.html 100755 → 100644
View file @ 0081d9f7
......@@ -14,15 +14,15 @@
This section will describe each section of the config file and is grouped into the following sections:
</p>
<ul>
<li><a href="#limits">Limits</a>
<li><a href="#authentication">Authentication</a>
<li><a href="#yp">YP Directory Settings</a>
<li><a href="#misc">Misc Server settings</a>
<li><a href="#relay">Relay settings</a>
<li><a href="#mount">Mount Specific settings</a>
<li><a href="#path">File path settings</a>
<li><a href="#log">Logging</a>
<li><a href="#security">Security</a>
<li><a href="#limits">Limits</a></li>
<li><a href="#authentication">Authentication</a></li>
<li><a href="#yp">YP Directory Settings</a></li>
<li><a href="#misc">Misc Server settings</a></li>
<li><a href="#relay">Relay settings</a></li>
<li><a href="#mount">Mount Specific settings</a></li>
<li><a href="#path">File path settings</a></li>
<li><a href="#log">Logging</a></li>
<li><a href="#security">Security</a></li>
</ul>
<p>
<br />
......@@ -196,10 +196,11 @@ This flag turns on the icecast2 fileserver from which static files can be served
&lt;/relay&gt;
</pre>
<p>This section contains the server's relay settings. There are two types of relays: a "Master server relay" or a "Specific Mountpoint relay." A Master server relay is only supported between icecast2 servers and is used to relays all mountpoints on a remote icecast2 server.
</p>
<h3>Master Relay</h3>
<p>
The following diagram shows the basics of doing a Master relay. Note that Server 1 is configured with the &lt;master-server&gt;, &lt;master-server-port&gt;, etc settings and Server 2 is the server from which Server 1 will pull all attached mountpoints and relay them. Using a Master Server relay, ALL mountpoints on Server 2 will be relayed. If only specific mountpoints need to be relayed, then you must configure Server 1 as a "Specific Mountpoint Relay". Both Master server relays and Specific Mountpoint relays begin their "relaying" when the Server is started.
</p>
<pre>
|-----| |-----|
| | all mountpoints | | /mount1
......@@ -214,10 +215,10 @@ The following diagram shows the basics of doing a Master relay. Note that Serve
settings
</pre>
<p>
A server is configured as a Master Server relay by specifying the &lt;master-server&gt;, &lt;master-server-port&gt;,&lt;master-update-interval&gt;,&lt;master-password&gt; values in the config file. The server that is being relayed does not need any special configuration.
</p>
<h4>master-server</h4>
<div class="indentedbox">
This is the IP for the server which contains the mountpoints to be relayed (Master Server).
......@@ -266,7 +267,7 @@ A server is configured as a Specific Mountpoint Server relay by specifying a &lt
&lt;/relay&gt;
</pre>
</p>
<h4>server</h4>
<div class="indentedbox">
This is the IP for the server which contains the mountpoint to be relayed.
......@@ -411,6 +412,7 @@ Aliases are used to provide a way to create multiple mountpoints that refer to t
<p>This section contains information relating to logging within icecast. There are two logfiles currently generated by icecast, an error.log (where all log messages are placed) and an access.log (where all stream/admin/http requests are logged).
</p>
<p>Note that on non-win32 platforms, a HUP signal can be sent to icecast in which the log files are re-opened for appending giving the ability move/remove the log files.
</p>
<h4>accesslog</h4>
<div class="indentedbox">
Into this file, all requests made to the icecast2 will be logged. This file is relative to the path specified by the &lt;logdir&gt; config value.
......@@ -422,15 +424,13 @@ All icecast generated log messages will be written to this file. If the logleve
<h4>loglevel</h4>
<div class="indentedbox">
Indicates what messages are logged by icecast. Log messages are categorized into one of 4 types, Debug, Info, Warn, and Error.<br /><br />The following mapping can be used to set the appropraite value :
</div>
<br />
<br />
<ul>
<li>loglevel = 4 - Debug, 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 = 1 - Error messages only are printed
<li>loglevel = 4 - Debug, Info, Warn, Error messages are printed</li>
<li>loglevel = 3 - Info, Warn, Error messages are printed</li>
<li>loglevel = 2 - Warn, Error messages are printed</li>
<li>loglevel = 1 - Error messages only are printed</li>
</ul>
</div>
<br />
<a name="security"></a>
<h2>Security Settings</h2>
......
doc/icecast2_faq.html 100755 → 100644
View file @ 0081d9f7
......@@ -30,7 +30,7 @@ A source client is an external program which is responsible for sending content
<h4>What is icecast, the program?</h4>
<div class="indentedbox">
<p>
icecast streams audio to listeners, and is compatible with Nullsoft’s Shoutcast.
icecast streams audio to listeners, and is compatible with Nullsoft`s Shoutcast.
</p>
</div>
<h4>What is libshout ?</h4>
......@@ -60,7 +60,7 @@ icecast streams audio to listeners, and is compatible with Nullsoft
<p>
Check your icecast configuration file for an element
called &lt;webroot&gt;. This directory contains web stuff.
In it, place a file called “status.xsl” that
In it, place a file called "status.xsl" that
transforms an <acronym>XML</acronym> file containing stream
data into a web page
(either <acronym>XHTML</acronym> or <acronym>HTML</acronym>).
......@@ -73,7 +73,7 @@ icecast streams audio to listeners, and is compatible with Nullsoft
<p>
In addition, the web directory can
hold multiple status transforms, if you can’t decide which
hold multiple status transforms, if you can't decide which
one you want.
</p>
</div>
......
doc/icecast2_glossary.html 100755 → 100644
View file @ 0081d9f7
......@@ -12,17 +12,17 @@
<br />
<br />
<br />
<a name="source client"></a>
<a name="source_client"></a>
<h4>source client</h4>
<div class="indentedbox">
A source client is an external program which is responsible for sending content data to icecast. Some source clients that support icecast2 are Oddcast, ices2, ices0.3, and DarkIce.
</div>
<a name="slave server"></a>
<a name="slave_server"></a>
<h4>slave server (Relay)</h4>
<div class="indentedbox">
The slave server in a relay configuration is the server that is pulling the data from the master server. It acts as a listening client to the master server.
</div>
<a name="master server"></a>
<a name="master_server"></a>
<h4>master server (Relay)</h4>
<div class="indentedbox">
The master server in a relay configuration is the server that has the stream that is being relayed.
......
doc/icecast2_introduction.html 100755 → 100644
View file @ 0081d9f7
File mode changed from 100755 to 100644
doc/icecast2_listenerauth.html 100755 → 100644
View file @ 0081d9f7
......@@ -31,24 +31,24 @@
&lt;/mount&gt;
</pre>
<p>To support listener authentication you MUST provide at a minimum &lt;mount-name&gt; and &lt;authentication&gt;. The mount-name is the name of the mountpoint that you will use to connect your source client with and authentication configures what type of icecast2 authenticator to use. Currently, only a single type "htpasswd" is implemented. New authenticators will be added later. Each authenticator has a variable number of options that are required and these are specified as shown in the example. The htpasswd authenticator requires a few parameters. The first, filename, specifies the name of the file to use to store users and passwords. Note that this file need not exist (and probably will not exist when you first set it up). Icecast has built-in support for managing users and passwords via the web admin interface. More on this later in this section. The second option, allow_duplicate_users, if set to 0, will prevent multiple connections using the same username. Setting this value to 1 will enable mutltiple connections from the same username on a given mountpoint. Note there is no way to specify a "max connections" for a particular user.
</p>
<p>Icecast supports a mixture of streams that require listener authentication and those that do not. Only mounts that are named in the config file can be configured for listener authentication.</p>
<br />
<br />
<br />
<h3>Configuring Users and Passwords</h3>
<p>Once the appropriate entries are made to the config file, connect your source client (using the mountpoint you named in the config file). To configure users and passwords for this stream you must use the web-based admin interface. Navigate to http://server:ip/admin/stats.xsl to begin. If you have configured everything properly, you should see a screen like the following :</p>
<img border="1" src="listener_auth1.jpg" />
<img src="listener_auth1.jpg" alt="Screenshot of http://server:ip/admin/stats.xsl" />
<p>You will see a red key in front of all mountpoint configured for listener authentication. Also note that this page will only show CONNECTED mountpoints.</p>
<p>To manage users and passwords for this mountpoint, click on the red key or follow the "Manage Authentication" link. The following screen will be shown :</p>
<img border="1" src="listener_auth2.jpg" />
<img src="listener_auth2.jpg" alt="Screenshot of Manage Authentication" />
<p>This screen will show all the users configured for this mountpoint. Adding users is as simple as entering a username and password in the fields and clicking "Add New User". Note that usernames MUST be unique and there are NO restrictions on passwords. You can delete users by clicking the appropriate delete link next to each user.</p>
<br />
<br />
<br />
<h3>Finishing it all off</h3>
<p>Ok, so you've created your users, and you have everything setup properly, how do your users login ? Well, we've provided a simple login form that you can use for this purpose. This page (http://server:port/auth.xsl) will bring up a form that users can use to enter their username and password.</p>
<img border="1" src="listener_auth3.jpg" />
<img src="listener_auth3.jpg" alt="Screenshot of http://server:port/auth.xsl" />
<p>This page will serve a m3u with the username and password and in most cases should open the correct media player and begin playing your stream</p>
<br />
<br />
......
doc/icecast2_relay.html 100755 → 100644
View file @ 0081d9f7
File mode changed from 100755 to 100644
doc/icecast2_stats.html 100755 → 100644
View file @ 0081d9f7
......@@ -85,5 +85,6 @@ Media type of the stream.
<br />
<br />
<br />
</div>
</body>
</html>
doc/icecast2_win32.html 100755 → 100644
View file @ 0081d9f7
......@@ -27,7 +27,7 @@ Examples of global statistics are:
The number of sources that have attempted connections
Total number of attempted connections to the server
</pre>
</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 Stats tab.
</p>
......@@ -35,7 +35,7 @@ The Server Status tab contains at a minimal the global stats for the server. Ad
<p>
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>
<img src="windowtitle.jpg" />
<img src="windowtitle.jpg" alt="Screenshot of Icecast Windows GUI - Server Status Tab" />
<br />
<br />
<br />
......@@ -53,7 +53,7 @@ Editing the icecast2 configuration file is a very simple process. For a descrip
<p>
The stats tab contains a view of all the connected mountpoints and the statistics that go along with them. Each connected mountpoint is displayed in the left pane of the window, and all stats for the selected mountpoint are displayed in the right pane of the window.
</p>
<img src="stats1.jpg" />
<img src="stats1.jpg" alt="Screenshot of Icecast Windows GUI - Stats Tab" />
</div>
</body>
......
doc/icecast2_yp.html 100755 → 100644
View file @ 0081d9f7
File mode changed from 100755 to 100644
doc/index.html 100755 → 100644
View file @ 0081d9f7
......@@ -8,7 +8,7 @@
<body>
<div class="boxtest">
<h1>Icecast 2 Documentation Table of Contents</h1>
<hr id='titlebar'>
<hr id='titlebar' />
<ul>
<li><a href="icecast2_introduction.html">Introduction</a></li>
<li><a href="icecast2_basicsetup.html">Basic Setup</a></li>
......
doc/index_win32.html
View file @ 0081d9f7
......@@ -8,7 +8,7 @@
<body>
<div class="boxtest">
<h1>Icecast 2 - Win32 Specific Documentation</h1>
<hr id='titlebar'>
<hr id='titlebar' />
<p>
The win32 port of icecast2 is simply a UI framework around the core icecast2 server. The win32 version of icecast2 uses directly the main executable of icecast (statically included) and simply provides a nicer, friendlier interface to icecast2.
</p>
......
doc/win32_section1.html
View file @ 0081d9f7
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<?xml version="1.0"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Icecast v2.0 Documentation</title>
<link rel="stylesheet" type="text/css" href="style.css" />
......
doc/win32_section3.html
View file @ 0081d9f7
......@@ -12,7 +12,7 @@
<p>
Explanation of the stats tab here
</p>
<img src="stats1.jpg"><br />
<img src="stats1.jpg" /><br />
</div>
</body>
</html>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment