<p>Note that multiple listen-socket sections may be configured in order to have Icecast listen on multiple network
interfaces or multiple ports. If a bind-address is not specified for a particular listen-socket, then the socket
will be bound to all interfaces (including IPv6 if available). For most people, the bind-address option will not
be required and often confuses people.</p>
<dl>
<dt>port</dt>
<dd>The TCP port that will be used to accept client connections.</dd>
<dt>bind-address</dt>
<dd>An optional IP address that can be used to bind to a specific network
card. If not supplied, then it will bind to all interfaces.</dd>
<dt>ssl</dt>
<dd>If set to 1 will enable HTTPS on this listen-socket. Icecast must have been compiled against openSSL to be able
to do so.</dd>
<dt>shoutcast-mount</dt>
<dd>An optional mountpoint setting to be used when shoutcast DSP compatible clients connect. The default global setting
is <code>/stream</code> but can be overridden here to use an alternative name which may include an extension that some clients
require for certain formats.<br/>
Defining this within a listen-socket group tells Icecast that this port and the subsequent port are to be used for
Shoutcast compatible source clients. This is an alternative to the <code>shoutcast-compat</code> approach as this implicitly
defines the second listening socket and allows for specifying multiple sockets using different mountpoints for
shoutcast source clients. The <code>shoutcast-mount</code> outside of a <code>listen-socket</code> group is the global setting of the
mountpoint to use.</dd>
<dt>shoutcast-compat</dt>
<dd>This optional flag will indicate that this port will operate in Shoutcast compatibility mode. Due to major differences
in the source client connection protocol, if you wish to use any of the shoutcast DJ tools, you will need to configure
at least one socket as shoutcast-compatible. Note that when in this mode, only source clients (and specifically shoutcast
source clients) will be able to attach to this port. All listeners may connect to any of the ports defined without this flag.
Also, for proper Shoutcast DSP compatibility, you must define a listen socket with a port one less than the one defined as
<code>shoutcast-compat</code>. This means if you define <code>8001</code> as <code>shoutcast-compat</code>, then you will need to define a listen port
of <code>8000</code> and it must not also be defined as <code>shoutcast-compat</code>. See the example config file in the distribution for more info.</dd>
<p>Icecast can be configured to send custom HTTP headers. This is available as a global setting and inside mountpoints. This section explains the global settings.</p>
<p>This functionality was introduced mainly to enable the use of simplified cross-origin resource sharing. The Icecast default configuration contains the first header, as seen in the above exmple, for this reason.</p>
<dl>
<dt>http-headers</dt>
<dd>This element is placed anywhere inside the main section of the icecast config. It will contain <code><header></code> child elements, that specify the actual headers one by one.</dd>
<dt>header</dt>
<dd>This tag specifies the actual header to be sent to a HTTP client in response to every request.
This tag can contain the following attributes:
<ul>
<li><code>name</code> is required and its value specifies the HTTP header field name.</li>
<li><code>value</code> is required and its value specifies the HTTP header field value.</li>
<li><code>status</code> is optional and limits sending the header to certain HTTP status codes. If not specified, the default is to return the header for every HTTP status code. This attribute is only available for global headers, at the moment.</li>
</ul>
</dd>
</dl>
<p>At the moment only global headers will be sent in case the HTTP status is not “200”. This is subject to change in the future.
Avoid placing comments inside <code><http-headers></code> as, in this release, it will prevent icecast from parsing further <code><header></code> tags.</p>
</div>
<divclass="article">
<h3id="relay">Relaying Streams</h3>
<p>This section contains the servers relay settings. The relays are implemented using a pull system where the receiving
server connects as if it’s a listener to the sending server.<br/>
There are two types of relay setups:<br/>
a “Master server relay” or a “Specific Mountpoint relay.”</p>
<h4id="master-relay">Master Relay</h4>
<p>A Master server relay is only supported between Icecast servers and is used to relay a number of
<p>This section contains the settings which apply only to a specific mountpoint and applies to an incoming
stream whether it is a relay or a source client. The purpose of the mount definition is to state certain
information that can override either global/default settings or settings provided from the incoming stream.</p>
<p>A mount does not need to be stated for each incoming source although you may want to specific certain settings
like the maximum number of listeners or a mountpoint specific username/password. As a general rule, only define
what you need to but each mount definition needs at least the mount-name. Changes to most of these will apply
across a configuration file re-read even on active streams, however some only apply when the stream starts or
ends.</p>
<dl>
<dt>type</dt>
<dd>The type of the mount point (default: “normal”). A mount of type “default”
can be used to specify common values for multiple mountpoints.<br/>
Note that default mountpoints won’t merge with other mount blocks.
You only get those values if no <code>type="normal"</code> mount block exists
corresponding to your mountpoint.</dd>
<dt>mount-name</dt>
<dd>The name of the mount point for which these settings apply.
MUST NOT be used in case of mount type “default”.</dd>
<dt>username</dt>
<dd>An optional value which will set the username that a source must use to connect using this mountpoint.
Do not set this value unless you are sure that the source clients connecting to the mount point can be
configured to send a username other than <code>source</code>.<br/>
If this value is not present the default username is <code>source</code>.</dd>
<dt>password</dt>
<dd>An optional value which will set the password that a source must use to connect using this mountpoint.
There is also a <ahref="auth.html#stream-auth">URL based authentication method</a> for sources that can be used instead.</dd>
<dt>max-listeners</dt>
<dd>An optional value which will set the maximum number of listeners that can be attached to this mountpoint.</dd>
<dt>max-listener-duration</dt>
<dd>An optional value which will set the length of time a listener will stay connected to the stream.<br/>
An auth component may override this.</dd>
<dt>dump-file</dt>
<dd>An optional value which will set the filename which will be a dump of the stream coming through
on this mountpoint. This filename is processed with strftime(3). This allows to use variables like <code>%F</code>.</dd>
<dt>intro</dt>
<dd>An optional value which will specify the file those contents will be sent to new listeners when they
connect but before the normal stream is sent. Make sure the format of the file specified matches the
streaming format. The specified file is appended to webroot before being opened.</dd>
<dt>fallback-mount</dt>
<dd>This optional value specifies a mountpoint that clients are automatically moved
to if the source shuts down or is not streaming at the time a listener connects. Only one can be
listed in each mount and should refer to another mountpoint on the same server that is streaming in
the same streaming format.<br/>
If clients cannot fallback to another mountpoint, due to a missing
fallback-mount or it states a mountpoint that is just not available, then those clients will be
disconnected. If clients are falling back to a mountpoint and the fallback-mount is not actively
streaming but defines a fallback-mount itself then those clients may be moved there instead. This
multi-level fallback allows clients to cascade several mountpoints.<br/>
A fallback mount can also state a file that is located in webroot. This is useful for playing a
pre-recorded file in the case of a stream going down. It will repeat until either the listener
disconnects or a stream comes back available and takes the listeners back. As per usual, the file
format should match the stream format, failing to do so may cause problems with playback.<br/>
Note that the fallback file is not timed so be careful if you intend to relay this. They are fine
on slave streams but don’t use them on master streams, if you do then the relay will consume stream
data at a faster rate and the listeners on the relay would eventually get kicked off.</dd>
<dt>fallback-override</dt>
<dd>When enabled, this allows a connecting source client or relay on this mountpoint to move listening
clients back from the fallback mount.</dd>
<dt>fallback-when-full</dt>
<dd>When set to <code>1</code>, this will cause new listeners, when the max listener count for the mountpoint has
been reached, to move to the fallback mount if there is one specified.</dd>
<dt><del>no-yp</del> (deprecated)</dt>
<dd>Setting this option prevents this mountpoint from advertising on YP. The default is <code>0</code> so YP advertising
can occur however you may want to prevent it here if you intend listeners to connect to a local relay instead.<br/>
Deprecated option, replaced by <code><public></code></dd>
<dt>charset</dt>
<dd>For non-Ogg streams like MP3, the metadata that is inserted into the stream often has no defined character set.
We have traditionally assumed UTF8 as it allows for multiple language sets on the web pages and stream directory,
however many source clients for MP3 type streams have assumed Latin1 (ISO 8859-1) or leave it to whatever character
set is in use on the source client system.<br/>
This character mismatch has been known to cause a problem as the stats engine and stream directory servers want UTF8
so now we assume Latin1 for non-Ogg streams (to handle the common case) but you can specify an alternative character
set with this option.<br/>
The source clients can also specify a <code>charset=</code> parameter to the metadata update URL if they so wish.</dd>
<dt>public</dt>
<dd>The default setting for this is <code>-1</code> indicating that it is up to the source client or relay to determine if this mountpoint
should advertise. A setting of <code>0</code> will prevent any advertising and a setting of <code>1</code> will force it to advertise.
If you do force advertising you may need to set other settings listed below as the YP server can refuse to advertise
if there is not enough information provided.</dd>
<dt>stream-name</dt>
<dd>Setting this will add the specified name to the stats (and therefore YP) for this mountpoint even if the source client/relay provide one.</dd>
<dt>stream-description</dt>
<dd>Setting this will add the specified description to the stats (and therefore YP) for this mountpoint even if the source client/relay provide one.</dd>
<dt>stream-url</dt>
<dd>Setting this will add the specified URL to the stats (and therefore YP) for this mountpoint even if the source client/relay provide one.<br/>
The URL is generally for directing people to a website.</dd>
<dt>genre</dt>
<dd>Setting this will add the specified genre to the stats (and therefore YP) for this mountpoint even if the source client/relay provide one.<br/>
This can be anything be using certain key words can help searches in the YP directories.</dd>
<dt>bitrate</dt>
<dd>Setting this will add the specified bitrate to the stats (and therefore YP) for this mountpoint even if the source client/relay provide one.<br/>
This is stated in kbps.</dd>
<dt>type</dt>
<dd>Setting this will add the specified mime type to the stats (and therefore YP) for this mountpoint even if the source client/relay provide one.<br/>
It is very unlikely that this will be needed.</dd>
<dt>subtype</dt>
<dd>Setting this will add the specified subtype to the stats (and therefore YP) for this mountpoint.
The subtype is really to help the YP server to identify the components of the type.
An example setting is vorbis/theora do indicate the codecs in an Ogg stream</dd>
<dt>burst-size</dt>
<dd>This optional setting allows for providing a burst size which overrides the default burst size as defined in limits.<br/>
The value is in bytes.</dd>
<dt>mp3-metadata-interval</dt>
<dd>This optional setting specifies what interval, in bytes, there is between metadata updates within shoutcast compatible streams.
This only applies to new listeners connecting on this mountpoint, not existing listeners falling back to this mountpoint. The
default is either the hardcoded server default or the value passed from a relay.</dd>
<dt>hidden</dt>
<dd>Enable this to prevent this mount from being shown on the xsl pages. This is mainly for cases where a local relay is configured
and you do not want the source of the local relay to be shown.</dd>
<dt>authentication</dt>
<dd>This specifies that the named mount point will require listener (or source) authentication. Currently, we support a file-based
authentication scheme (<code>type=htpasswd</code>) and URL based authentication request forwarding. A mountpoint configured with an authenticator
will display a red key next to the mount point name on the admin screens.<br/>
You can read more about listener authentication and URL based source authentication <ahref="auth.html">here</a>.</dd>
<dt>http-headers</dt>
<dd>This element is placed anywhere inside the mount section of the icecast config. It will contain <code><header></code> child elements, that specify the actual HTTP headers one by one.</dd>
<dt>header</dt>
<dd>This tag specifies the actual header to be sent to a HTTP client in response to every request for this mount point, but currently only if the HTTP status code is “200”.
This tag can contain the following attributes:
<ul>
<li><code>name</code> is required and its value specifies the HTTP header field name.</li>
<li><code>value</code> is required and its value specifies the HTTP header field value.</li>
</ul>
</dd>
<dt>on-connect</dt>
<dd>State a program that is run when the source is started. It is passed a parameter which is the name of the mountpoint that is starting.
The processing of the stream does not wait for the script to end.
Caution should be exercised as there is a small chance of stream file descriptors being mixed up with script file descriptors, if the FD numbers go above 1024. This will be further addressed in the next Icecast release.
<em>This option is not available on Win32</em></dd>
<dt>on-disconnect</dt>
<dd>State a program that is run when the source ends. It is passed a parameter which is the name of the mountpoint that has ended.
The processing of the stream does not wait for the script to end.<br/>
Caution should be exercised as there is a small chance of stream file descriptors being mixed up with script file descriptors, if the FD numbers go above 1024. This will be further addressed in the next Icecast release.
<em>This option is not available on Win32</em></dd>
<p>This section contains paths which are used for various things within icecast. All paths (other than any aliases) should not end in a <code>/</code>.</p>
<dl>
<dt>basedir</dt>
<dd>This path is used in conjunction with the chroot settings, and specified the base directory that is chrooted to when the server is started.<br/>
<em>This feature is not supported on Win32.</em></dd>
<dt>logdir</dt>
<dd>This path specifies the base directory used for logging. Both the <code>error.log</code> and <code>access.log</code> will be created relative to this directory.</dd>
<dt>pidfile</dt>
<dd>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.<br/>
This could be read and used for sending signals to Icecast.</dd>
<dt>webroot</dt>
<dd>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 <code>/var/share/icecast2</code>, and a request for
<code>http://server:port/mp3/stuff.mp3</code> comes in, then the file <code>/var/share/icecast2/mp3/stuff.mp3</code> will be served.</dd>
<dt>adminroot</dt>
<dd>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.</dd>
<dt>allow-ip</dt>
<dd>If specified, this points to the location of a file that contains a list of IP addresses that will be allowed to connect to Icecast.
This could be useful in cases where a master only feeds known slaves.<br/>
The format of the file is simple, one IP per line.</dd>
<dt>deny-ip</dt>
<dd>If specified, this points to the location of a file that contains a list of IP addressess that will be dropped immediately.
This is mainly for problem clients when you have no access to any firewall configuration.<br/>
The format of the file is simple, one IP per line.</dd>
<dt>alias</dt>
<dd>Aliases are used to provide a way to create multiple mountpoints that refer to the same mountpoint.<br/>
For example: <code><alias source="/foo" dest="/bar"></code></dd>
<dt>ssl-certificate</dt>
<dd>If specified, this points to the location of a file that contains <em>both</em> the X.509 private and public key.
This is required for HTTPS support to be enabled. Please note that the user Icecast is running as must be able to read the file. Failing to ensure this will cause a “Invalid cert file” WARN message, just as if the file wasn’t there.</dd>
<dt>ssl-allowed-ciphers</dt>
<dd>This optional tag specifies the list of allowed ciphers passed on to the SSL library.
Icecast contains a set of defaults conforming to current best practices and you should <em>only</em> override those, using this tag, if you know exactly what you are doing.</dd>
<p>This section contains information relating to logging within Icecast. There are three logfiles currently generated by Icecast,
an <code>error.log</code> (where all log messages are placed), an <code>access.log</code> (where all stream/admin/http requests are logged) and an
optional <code>playlist.log</code>. </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>
<p>If you set any of the filenames to a simple dash (e.g. <code><accesslog>-</accesslog></code>) then Icecast will direct the log output to
STDERR instead of a file.</p>
<dl>
<dt>accesslog</dt>
<dd>Into this file, all requests made to the icecast2 will be logged. This file is relative to the path specified by the <code><logdir></code> config value.</dd>
<dt>errorlog</dt>
<dd>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.</dd>
<dt>playlistlog</dt>
<dd>Into this file, a log of all metadata for each mountpoint will be written. The format of the logfile will most likely change over time
as we narrow in on a standard format for this. Currently, the file is pipe delimited. This option is optional and can be removed entirely
from the config file.</dd>
<dt>logsize</dt>
<dd>This value specifies (in Kbytes) the maxmimum size of any of the log files. When the logfile grows beyond this value, icecast will either
rename it to <code>logfile.old</code>, or add a timestamp to the archived file (if logarchive is enabled).</dd>
<dt>logarchive</dt>
<dd>If this value is set, then Icecast will append a timestamp to the end of the logfile name when logsize has been reached. If disabled, then
the default behavior is to rename the logfile to <code>logfile.old</code> (overwriting any previously saved logfiles). We disable this by default to
prevent the filling up of filesystems for people who don’t care (or know) that their logs are growing.</dd>
<dt>loglevel</dt>
<dd>Indicates what messages are logged by icecast. Log messages are categorized into one of 4 types, Debug, Info, Warn, and Error.<br/>
<p>The following mapping can be used to set the appropriate value:</p>
<ul>
<li>loglevel = <code>4</code>: Debug, Info, Warn, Error messages are printed</li>
<li>loglevel = <code>3</code>: Info, Warn, Error messages are printed</li>
<li>loglevel = <code>2</code>: Warn, Error messages are printed</li>
<li>loglevel = <code>1</code>: Error messages only are printed</li>
<p>This section contains configuration settings that can be used to secure the icecast server by performing a chroot to a secured location or changing user and group on start-up. The latter allows icecast to bind to priviledged ports like 80 and 443, by being started as root and then dropping to the configured user/group after binding listener-sockets.
<em>This is currently not supported on Win32.</em></p>
<dl>
<dt>chroot</dt>
<dd>An indicator which specifies whether a <code>chroot()</code> will be done when the server is started.
The chrooted path is specified by the <code><basedir></code> configuration value.
Setting up and using a chroot is an advanced concept and not in the scope of this document.</dd>
<dt>changeowner</dt>
<dd>This section indicates the user and group that will own the icecast process when it is started.<br/>
These need to be valid users on the system. Icecast must be started as root for this to work.</dd>
</dl>
</div>
</div>
<divclass="footer">
<p>Support icecast development at <ahref="http://icecast.org">icecast.org</a></p>
