<p>This section contains information about the admin interface of icecast. Through this interface the user can manipulate many server features. From it you can gather statistics, mov e listeners from mountpoint to mountpoint, disconnect connected sources, disconnect connected listeners, and many other activities. Each function is enumerated here as well as an example usage of the function.</p>
<p>Each of these functions requires authentication via the <admin-username> and <admin-password> specified in the icecast config file. It is also important to note that in all the examples 192.168.1.10 is used as the example host and 8000 is used as the example port for the icecast server.</p>
<br>
<br>
<br>
<br/>
<br/>
<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.
<h3>Metadata Update</h3>
<h4>description</h4>
<divclass=indentedbox>
<divclass="indentedbox">
This function provides the ability for either a source client or any external program to update the metadata information for a particular mountpoint. Currently the only metadata supported is song title and only for MP3 streams.
This function provides the ability for either a source client or any external program to update the "fallback mountpoint" for a particular mountpoint. Fallback mounts are those that are used in the even of a source client disconnection. If a source client disconnects for some reason that all currently connected clients are sent immediately to the fallback mountpoint.
This function provides the ability to migrate currently connected listeners from one mountpoint to another. This function requires 2 mountpoints to be passed in: mount (the *from* mountpoint) and destination (the *to* mountpoint). After processing this function all currently connected listeners on mount will be connected to destination. Note that the destination mountpoint must exist and have a sounce client already feeding it a stream.
This function provides the ability to disconnect a specific listener of a currently connected mountpoint. Listeners are identified by a unique id that can be retrieved by via the "List Clients" admin function. This id must be passed in to the request. After processing this request, the listener will no longer be connected to the mountpoint.
This function will provide the ability to disconnect a specific mountpoint from the server. The mountpoint to be disconnected is specified via the variable "mount".
This admin function provides the ability to query the internal statistics kept by the icecast server. Almost all information about the internal workings of the server such as the mountpoints connected, how many client requests have been served, how many listeners for each mountpoint, etc, are available via this admin function.<br>
<divclass="indentedbox">
This admin function provides the ability to query the internal statistics kept by the icecast server. Almost all information about the internal workings of the server such as the mountpoints connected, how many client requests have been served, how many listeners for each mountpoint, etc, are available via this admin function.<br/>
Note that this admin function can also be invoked via the http://server:port/admin/stats.xml syntax, however this syntax should not be used and will eventually become deprecated.
</div>
<h4>example</h4>
<pre>
http://192.168.1.10:8000/admin/stats
</pre>
<br>
<br>
<br/>
<br/>
<h3>List Mounts</h3>
<h4>description</h4>
<divclass=indentedbox>
<divclass="indentedbox">
This admin function provides the ability to view all the currently connected mountpoints.
</div>
<h4>example</h4>
<pre>
http://192.168.1.10:8000/admin/listmounts
</pre>
<br>
<br>
<br>
<br/>
<br/>
<br/>
<h2>Web-Based Admin Interface</h2>
<p>As an alternative to manually invoking these URLs, a web-based admin interface was developed. This interface provides the same functions that were identified and described above but presents them in a little nicer way. The Web-Based Admin Interface to icecast is shipped with icecast provided in the "admin" directory and comes ready to use. All the user needs to do is set the path to this directory in the config file via the <adminroot> config variable.</p>
<p>The Web-Based Admin Interface is a series of XSLT files which are used to display all the XML obtained via the URL admin interface. This can be changed and modified to suit the user's need. Knowledge of XSLT and transformations from XML to HTML are required in order to make changes to these scripts.</p>
<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.
<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>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>
<br>
<br>
<br>
<br/>
<br/>
<br/>
<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>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>
<tableborder=1width=75%>
<tableborder="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>
<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/>
<pre>
<source-password> - will be used by the source client
<admin-password> - will be used to access admin features of icecast
[2003-10-31 13:04:49] INFO main/main.c icecast server started
</pre>
<p>You can also verify that it started by visiting the following URL : http://yourip:port/admin/stats.xml. You should be prompted for a username and password. Enter the username "admin" and the password you entered for <admin-password>. If all is well, you should see an small XML tree which represents icecast statistics (more about that later).</p>
<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 <listen-socket><br>
source password - from <source-password><br>
<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 <listen-socket><br/>
source password - from <source-password><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>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>
This section will describe each section of the config file and is grouped into the following sections:
...
...
@@ -17,9 +24,9 @@ This section will describe each section of the config file and is grouped into t
<li><ahref="#log">Logging</a>
<li><ahref="#security">Security</a>
<br>
<br>
<br>
<br/>
<br/>
<br/>
<aname="limits"></a>
<h2>Limits</h2>
<pre>
...
...
@@ -38,47 +45,47 @@ This section will describe each section of the config file and is grouped into t
<p>This section contains server level settings that, in general, do not need to be changed. Only modify this section if you are know what you are doing.
</p>
<h4>clients</h4>
<divclass=indentedbox>
<divclass="indentedbox">
Total number of concurrent clients supported by the server. Listeners are considered clients, but so is accesses to any static content (i.e. fileserved content) and also any requests to gather stats. These are max *concurrent* connections for the entire server (not per mountpoint).
</div>
<h4>sources</h4>
<divclass=indentedbox>
<divclass="indentedbox">
Maximum number of connected sources supported by the server.
</div>
<h4>threadpool</h4>
<divclass=indentedbox>
<divclass="indentedbox">
This is the number of threads that are started to handle client connections. You may need to increase this value if you are running a high traffic stream. This recommended value is for a small to medium traffic server.
</div>
<h4>queue-size</h4>
<divclass=indentedbox>
<divclass="indentedbox">
This is the maximum size (in bytes) of a client (listener) queue. A listener may temporarily lag behind due to network congestion and in this case an internal queue is maintained for each listener. If the queue grows larger than this config value, then the listener will be removed from the stream.
</div>
<h4>client-timeout</h4>
<divclass=indentedbox>
<divclass="indentedbox">
This does not seem to be used.
</div>
<h4>header-timeout</h4>
<divclass=indentedbox>
<divclass="indentedbox">
The maximum time (in seconds) to wait for a request to come in once the client has made a connection to the server. In general this value should not need to be tweaked.
</div>
<h4>source-timeout</h4>
<divclass=indentedbox>
<divclass="indentedbox">
If a connected source does not send any data within this timeout period (in seconds), then the source connection will be removed from the server.
</div>
<h4>burst-on-connect</h4>
<divclass=indentedbox>
<divclass="indentedbox">
With this enabled, a connecting client will be sent a burst of audio data from the stream. This will have the effect of reducing the startup time for the stream from the perspective of the listener. This is due to the fact that most media players have local buffers that must be filled before the stream begins to play. This may introduce a small latency in the stream (difference in time between when the source plays a clip and the listener hears a clip). If this latency is important to you, then you can disable this feature. The latency is bitrate-dependent, but as an example, for a 128kbps stream, the latency between the source and the player is ~ 1.5 secs WITHOUT burst on connect, and WITH burst on connect the latency is 3 secs.
</div>
<h4>burst-size</h4>
<divclass=indentedbox>
<divclass="indentedbox">
The burst size is the amount of data (in bytes) to burst to a client at connection time. Like
burst-on-connect, this is to quickly fill the pre-buffer used by media players. The default
is 64kbytes which is a typical size used by most clients so changing it is not usually required.
This setting applies to all mountpoints.
</div>
<br>
<br>
<br>
<br/>
<br/>
<br/>
<aname="authentication"></a>
<h2>Authentication</h2>
<pre>
...
...
@@ -92,21 +99,21 @@ This setting applies to all mountpoints.
<p>This section contains all the users and passwords used for administration purposes or to connect sources and relays.
</p>
<h4>source-password</h4>
<divclass=indentedbox>
<divclass="indentedbox">
The unencrypted password used by sources to connect to icecast2. Currently, the username for all source connections must be 'source'. This is likely to change in the future.
</div>
<h4>relay-password</h4>
<divclass=indentedbox>
<divclass="indentedbox">
Currently not used.
</div>
<h4>admin-user</h4>
<h4>admin-password</h4>
<divclass=indentedbox>
<divclass="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.
</div>
<br>
<br>
<br>
<br/>
<br/>
<br/>
<aname="yp"></a>
<h2>YP Directory Settings</h2>
<pre>
...
...
@@ -118,16 +125,16 @@ The username/password used for all administration functions. This includes retr
<p>This section contains all the settings for listing a stream on any of the Icecast2 YP Directory servers. Multiple occurances of this section can be specified in order to be listed on multiple directory servers.
</p>
<h4>yp-url-timeout</h4>
<divclass=indentedbox>
<divclass="indentedbox">
This value is the maximum time icecast2 will wait for a response from a particular directory server. The recommended value should be sufficient for most directory servers.
</div>
<h4>yp-url</h4>
<divclass=indentedbox>
<divclass="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.
</div>
<br>
<br>
<br>
<br/>
<br/>
<br/>
<aname="misc"></a>
<h2>Misc Server Settings</h2>
<pre>
...
...
@@ -148,20 +155,20 @@ The URL which icecast2 uses to communicate with the Directory server. The value
<p>This section contains miscellaneous server settings. Note that multiple listen-socket sections may be configured in order to have icecast2 listen on multiple network interfaces. If a bind-address is not specified for a particular listen-socket, then the hostname parameter will be used to specify the address that will be bound.
</p>
<h4>port</h4>
<divclass=indentedbox>
<divclass="indentedbox">
The TCP port that will be used to accept client connections.
</div>
<h4>bind-address</h4>
<divclass=indentedbox>
<divclass="indentedbox">
And option IP address that can be used to bind to a specific network card. If not supplied, then <hostname> will be used.
</div>
<h4>fileserve</h4>
<divclass=indentedbox>
<divclass="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 <paths><webroot> configuration setting.
</div>
<br>
<br>
<br>
<br/>
<br/>
<br/>
<aname="relay"></a>
<h2>Relay Settings</h2>
<pre>
...
...
@@ -202,22 +209,22 @@ A server is configured as a Master Server relay by specifying the <master-ser
</p>
<h4>master-server</h4>
<divclass=indentedbox>
<divclass="indentedbox">
This is the IP for the server which contains the mountpoints to be relayed (Master Server).
</div>
<h4>master-server-port</h4>
<divclass=indentedbox>
<divclass="indentedbox">
This is the TCP Port for the server which contains the mountpoints to be relayed (Master Server).
</div>
<h4>master-update-interval</h4>
<divclass=indentedbox>
<divclass="indentedbox">
The interval (in seconds) that the Relay Server will poll the Master Server for any new mountpoints to relay.
</div>
<h4>master-password</h4>
<divclass=indentedbox>
<divclass="indentedbox">
This is the admin password on the Master server. It is used to query the server for a list of mountpoints to relay.
</div>
<br>
<br/>
<h3>Specific Mountpoint Relay</h3>
The following diagram shows the basics of doing a Specific Mountpoint relay. Note that Server 1 is configured with the <relay> settings and Server 2 is the server from which Server 1 will pull the specified mountpoint(s) and relay them. Using a Specific Mountpoint Relay, only those mountpoints specified on Server 1 will be relayed from Server 2.
...
...
@@ -251,28 +258,28 @@ A server is configured as a Specific Mountpoint Server relay by specifying a <
</p>
<h4>server</h4>
<divclass=indentedbox>
<divclass="indentedbox">
This is the IP for the server which contains the mountpoint to be relayed.
</div>
<h4>port</h4>
<divclass=indentedbox>
<divclass="indentedbox">
This is the TCP Port for the server which contains the mountpoint to be relayed.
</div>
<h4>mount</h4>
<divclass=indentedbox>
<divclass="indentedbox">
The mountpoint located on the remote server. If you are relaying a shoutcast stream, this must be '/'.
</div>
<h4>local-mount</h4>
<divclass=indentedbox>
<divclass="indentedbox">
The name to use for the local mountpoint. This is what the mount will be named on the RELAY SERVER.
</div>
<h4>relay-shoutcast-metadata</h4>
<divclass=indentedbox>
<divclass="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).
</div>
<br>
<br>
<br>
<br/>
<br/>
<br/>
<aname="mount"></a>
<h2>Mount Specific Settings</h2>
<pre>
...
...
@@ -295,46 +302,46 @@ If you are relaying a Shoutcast stream, you need to specify this indicator to al
<p>This section contains settings which apply only to a specific mountpoint. Within this section you can reserve a specific mountpoint and set a source username/password for that mountpoint (not yet implemented) as well as specify individual settings which will apply only to the supplied mountpoint.
</p>
<h4>mount-name</h4>
<divclass=indentedbox>
<divclass="indentedbox">
The name of the mount point for which these settings apply.
</div>
<h4>username</h4>
<divclass=indentedbox>
<divclass="indentedbox">
An optional value which will set the username that a source must use to connect using this mountpoint.
</div>
<h4>password</h4>
<divclass=indentedbox>
<divclass="indentedbox">
An optional value which will set the password that a source must use to connect using this mountpoint.
</div>
<h4>max-listeners</h4>
<divclass=indentedbox>
<divclass="indentedbox">
An optional value which will set the maximum number of listeners that can be attached to this mountpoint.
</div>
<h4>dump-file</h4>
<divclass=indentedbox>
<divclass="indentedbox">
An optional value which will set the filename which will be a dump of the stream coming through on this mountpoint.
</div>
<h4>fallback-mount</h4>
<divclass=indentedbox>
<divclass="indentedbox">
This specifies a mountpoint that is used in the case of a source disconnect. If listeners are connected to the mount specified by the <mount-name> config value, then if the source is disconnected; all currently connected clients will be moved to the fallback-mount.
</div>
<h4>fallback-override</h4>
<divclass=indentedbox>
<divclass="indentedbox">
When enabled, this allows a connecting source client or relay on this mountpoint to move
listening clients back from the fallback mount.
</div>
<h4>burst-size</h4>
<divclass=indentedbox>
<divclass="indentedbox">
This optional setting allows for providing a burst size which overrides the default burst size
as defined in limits. The value is in bytes.
</div>
<h4>authentication</h4>
<divclass=indentedbox>
<divclass="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 <ahref="icecast2_listenerauth.html">here</a>.
</div>
<br>
<br>
<br>
<br/>
<br/>
<br/>
<aname="path"></a>
<h2>Path Settings</h2>
<pre>
...
...
@@ -350,32 +357,32 @@ This specifies that the named mount point will require listener authentication.
<p>This section contains paths which are used for various things within icecast. All paths should not end in a '/'.
</p>
<h4>basedir</h4>
<divclass=indentedbox>
<divclass="indentedbox">
This path is used in conjunction with the chroot settings, and specified the base directory that is chrooted to when the server is started. This feature is not supported on win32.
</div>
<h4>logdir</h4>
<divclass=indentedbox>
<divclass="indentedbox">
This path specifies the base directory used for logging. Both the error.log and access.log will be created relative to this directory.
</div>
<h4>pidfile</h4>
<divclass=indentedbox>
<divclass="indentedbox">
This pathname specifies the file to write at startup and to remove at normal shutdown. The file contains the process id of the icecast process. This could be read and used for sending signals icecast.
</div>
<h4>webroot</h4>
<divclass=indentedbox>
<divclass="indentedbox">
This path specifies the base directory used for all static file requests. This directory can contain all standard file types (including mp3s and ogg vorbis files). For example, if webroot is set to /var/share/icecast2, and a request for http://server:port/mp3/stuff.mp3 comes in, then the file /var/share/icecast2/mp3/stuff.mp3 will be served.
</div>
<h4>adminroot</h4>
<divclass=indentedbox>
<divclass="indentedbox">
This path specifies the base directory used for all admin requests. More specifically, this is used to hold the XSLT scripts used for the web-based admin interface. The admin directory contained within the icecast distribution contains these files.
</div>
<h4>alias source="/foo" dest="/bar"</h4>
<divclass=indentedbox>
<divclass="indentedbox">
Aliases are used to provide a way to create multiple mountpoints that refer to the same mountpoint.
</div>
<br>
<br>
<br>
<br/>
<br/>
<br/>
<aname="log"></a>
<h2>Logging Settings</h2>
<pre>
...
...
@@ -389,24 +396,24 @@ Aliases are used to provide a way to create multiple mountpoints that refer to t
</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.
<h4>accesslog</h4>
<divclass=indentedbox>
<divclass="indentedbox">
Into this file, all requests made to the icecast2 will be logged. This file is relative to the path specified by the <logdir> config value.
</div>
<h4>errorlog</h4>
<divclass=indentedbox>
<divclass="indentedbox">
All icecast generated log messages will be written to this file. If the loglevel is set too high (Debug for instance) then this file can grow fairly large over time. Currently, there is no log-rotation implemented.
</div>
<h4>loglevel</h4>
<divclass=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 :
<divclass="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 :
<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
<br>
<br/>
<aname="security"></a>
<h2>Security Settings</h2>
<pre>
...
...
@@ -421,11 +428,11 @@ Indicates what messages are logged by icecast. Log messages are categorized int
<p>This section contains configuration settings that can be used to secure the icecast server by performing a chroot to a secured location. This is currently not supported on win32.
</p>
<h4>chroot</h4>
<divclass=indentedbox>
<divclass="indentedbox">
An indicator which specifies whether a chroot() will be done when the server is started. The chrooted path is specified by the <basedir> configuration value.
</div>
<h4>changeowner</h4>
<divclass=indentedbox>
<divclass="indentedbox">
This section indicates the user and group that will own the icecast process when it is started. These need to be valid users on the system.
