2004-09-18 10:31:39 -04:00
<?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 >
2005-08-16 22:40:29 -04:00
< title > Icecast v2.x Documentation< / title >
2004-09-18 10:31:39 -04:00
< link rel = "stylesheet" type = "text/css" href = "style.css" / >
< / head >
< body >
< div class = "boxtest" >
2003-11-12 22:50:30 -05:00
< h1 > Icecast 2 Config File< / h1 >
2004-09-18 16:14:50 -04:00
< hr id = 'titlebar' / >
2003-11-12 22:50:30 -05:00
< h3 > Overview< / h3 >
< p >
2003-11-18 12:23:55 -05:00
This section will describe each section of the config file and is grouped into the following sections:
2003-11-12 22:50:30 -05:00
< / p >
2004-09-18 12:50:19 -04:00
< ul >
2004-09-18 17:01:39 -04:00
< li > < a href = "#limits" > Limits< / a > < / li >
< li > < a href = "#authentication" > Authentication< / a > < / li >
2008-01-28 22:24:47 -05:00
< li > < a href = "#yp" > Stream Directory Settings< / a > < / li >
2004-09-18 17:01:39 -04:00
< 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 >
2004-09-18 12:50:19 -04:00
< / ul >
< p >
2004-09-18 10:31:39 -04:00
< br / >
< br / >
< br / >
2004-09-18 12:50:19 -04:00
< / p >
2013-03-30 03:09:14 -04:00
< h2 > A word of warning< / h2 >
< p >
2014-03-01 11:38:15 -05:00
Please note that, especially for new Icecast users, editing the config file can be quite tricky. < strong > It is thus recommended to make a backup of the original config file and then start by just changing all passwords, nothing else.< / strong > You can then use the source-password to bring up an initial stream and get more comfortable with how Icecast works.
2013-03-30 03:09:14 -04:00
< / p >
< p >
Should you need to customize the configuration, then make a backup of your working config file, before you make any changes. If Icecast refuses to start it is in most cases due to a malformed config file. In such a case running the following command should point out most XML syntax problems.
< pre > xmllint icecast.xml< / pre >
2014-05-04 12:53:20 -04:00
< strong > A known limitation of Icecast 2.4.0 is that it will segfault on empty XML tags, so please don't use them (e.g. < webroot> < /webroot> ).< / strong > < br / > < br / >
Also check the Icecast error.log for additional hints in case of all problems!
2013-03-30 03:09:14 -04:00
< / p >
< p >
< br / >
< br / >
< br / >
< / p >
2003-11-12 22:50:30 -05:00
< a name = "limits" > < / a >
< h2 > Limits< / h2 >
< pre >
< limits>
2004-08-20 15:22:37 -04:00
< clients> 100< /clients>
< sources> 2< /sources>
< queue-size> 102400< /queue-size>
< client-timeout> 30< /client-timeout>
< header-timeout> 15< /header-timeout>
< source-timeout> 10< /source-timeout>
< burst-on-connect> 1< /burst-on-connect>
< burst-size> 65536< /burst-size>
< /limits>
2003-11-12 22:50:30 -05:00
< / pre >
2011-12-03 04:25:36 -05:00
< p > This section contains server level settings that, in general, do not need to be changed. Only modify this section if you know what you are doing.
2003-11-12 22:50:30 -05:00
< / p >
< h4 > clients< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2014-05-04 12:53:20 -04:00
Total number of concurrent clients supported by the server. Listeners are considered clients, but so are accesses to any static content (i.e. fileserved content) and also any requests to gather stats. These are max < strong > concurrent< / strong > connections for the entire server (not per mountpoint).
2003-11-12 22:50:30 -05:00
< / div >
< h4 > sources< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2008-01-28 22:24:47 -05:00
Maximum number of connected sources supported by the server. This includes active relays and source clients
2003-11-12 22:50:30 -05:00
< / div >
< h4 > queue-size< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2008-01-28 22:24:47 -05:00
This is the maximum size (in bytes) of the stream queue. A listener may temporarily lag behind
due to network congestion and in this case an internal queue is maintained for the listeners.
If the queue grows larger than this config value, then it is truncated and any listeners found
will be removed from the stream.< br / >
This will be the default setting for the streams which is 512k unless overridden here. You can
override this in the individual mount settings which can be useful if you have a mixture of high
bandwidth video and low bitrate audio streams.
2003-11-12 22:50:30 -05:00
< / div >
< h4 > client-timeout< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2003-11-12 22:50:30 -05:00
This does not seem to be used.
< / div >
< h4 > header-timeout< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2003-11-18 12:23:55 -05:00
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.
2003-11-12 22:50:30 -05:00
< / div >
< h4 > source-timeout< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2003-11-12 22:50:30 -05:00
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 >
2004-04-29 11:23:13 -04:00
< h4 > burst-on-connect< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2008-01-28 22:24:47 -05:00
This setting is really just an alias for burst-size. When enabled the burst-size is 64 kbytes
and disabled the burst-size is 0 kbytes. This option is deprecated, use burst-size instead.
2004-04-29 11:23:13 -04:00
< / div >
2004-08-20 15:22:37 -04:00
< h4 > burst-size< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2004-08-20 15:22:37 -04:00
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
2008-01-28 22:24:47 -05:00
is 64 kbytes which is a typical size used by most clients so changing it is not usually required.
This setting applies to all mountpoints unless overridden in the mount settings.
2014-02-16 05:14:28 -05:00
Ensure that this value is smaller than queue-size, if necessary increase queue-size to be larger than your desired burst-size. Failure to do so might result in aborted listener client connection attempts, due to initial burst leading to the connection already exceeding the queue-size limit.
2004-08-20 15:22:37 -04:00
< / div >
2004-09-18 12:50:19 -04:00
< p >
2004-09-18 10:31:39 -04:00
< br / >
< br / >
< br / >
2004-09-18 12:50:19 -04:00
< / p >
2003-11-12 22:50:30 -05:00
< a name = "authentication" > < / a >
< h2 > Authentication< / h2 >
< pre >
< authentication>
2004-08-20 15:22:37 -04:00
< source-password> hackme< /source-password>
2005-05-12 20:35:08 -04:00
< relay-user> relay< /relay-user>
2004-08-20 15:22:37 -04:00
< relay-password> hackme< /relay-password>
< admin-user> admin< /admin-user>
< admin-password> hackme< /admin-password>
< /authentication>
2003-11-12 22:50:30 -05:00
< / pre >
2008-01-28 22:24:47 -05:00
< p > This section contains all the usernames and passwords used for administration purposes or to connect sources and relays.
2003-11-12 22:50:30 -05:00
< / p >
< h4 > source-password< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2008-01-28 22:24:47 -05:00
The unencrypted password used by sources to connect to icecast2. The default username
for all source connections is 'source' but this option allows to specify a default
password. This and the username can be changed in the individual mount sections.
2003-11-12 22:50:30 -05:00
< / div >
2005-05-12 20:35:08 -04:00
< h4 > relay-user< / h4 >
< div class = "indentedbox" >
Used in the master server as part of the authentication when a slave requests
the list of streams to relay. The default username is 'relay'
< / div >
2003-11-12 22:50:30 -05:00
< h4 > relay-password< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2005-05-12 20:35:08 -04:00
Used in the master server as part of the authentication when a slave requests
the list of streams to relay.
2003-11-12 22:50:30 -05:00
< / div >
< h4 > admin-user< / h4 >
< h4 > admin-password< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2003-11-12 22:50:30 -05:00
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 >
2004-09-18 12:50:19 -04:00
< p >
2004-09-18 10:31:39 -04:00
< br / >
< br / >
< br / >
2004-09-18 12:50:19 -04:00
< / p >
2003-11-12 22:50:30 -05:00
< a name = "yp" > < / a >
2008-01-28 22:24:47 -05:00
< h2 > Stream Directory Settings< / h2 >
2003-11-12 22:50:30 -05:00
< pre >
< directory>
2004-08-20 15:22:37 -04:00
< yp-url-timeout> 15< /yp-url-timeout>
< yp-url> http://dir.xiph.org/cgi-bin/yp-cgi< /yp-url>
< /directory>
2003-11-12 22:50:30 -05:00
< / pre >
< 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 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2003-11-12 22:50:30 -05:00
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 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2003-11-12 22:50:30 -05:00
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 >
2004-09-18 12:50:19 -04:00
< p >
2004-09-18 10:31:39 -04:00
< br / >
< br / >
< br / >
2004-09-18 12:50:19 -04:00
< / p >
2003-11-12 22:50:30 -05:00
< a name = "misc" > < / a >
< h2 > Misc Server Settings< / h2 >
2008-01-28 22:24:47 -05:00
< p > Server wide settings.< / p >
2003-11-12 22:50:30 -05:00
< pre >
2011-12-03 04:25:36 -05:00
< hostname> localhost< /hostname>
< location> earth< /location>
< admin> icemaster@localhost< /admin>
2008-01-28 22:24:47 -05:00
< fileserve> 1< /fileserve>
< server-id> icecast 2.3< /server-id>
< / pre >
< h4 > hostname< / h4 >
< div class = "indentedbox" >
This is the DNS name or IP address that will be used for the stream directory lookups or
possibily the playlist generation if a Host header is not provided. While localhost is shown
as an example, in fact you will want something that your listeners can use.
< / div >
2011-12-03 04:25:36 -05:00
< h4 > location< / h4 >
< div class = "indentedbox" >
This sets the location string for this icecast instance. It will be shown e.g in the
web interface.
< / div >
< h4 > admin< / h4 >
< div class = "indentedbox" >
This should contain contact details for getting in touch with the server administrator.
Usually this will be an email address, but as this can be an arbitrary string it could also
be a phone number. This will be shown e.g. in the web interface.
< / div >
2008-01-28 22:24:47 -05:00
< h4 > fileserve< / h4 >
< 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 < paths> < webroot> configuration
setting. By default the setting is enabled so that requests for the images on the status
page are retrievable.
< / div >
< h4 > server-id< / h4 >
< div class = "indentedbox" >
This optional setting allows for the administrator of the server to override the default
server identification. The default is icecast followed by a version number and most will
not care to change it however this setting will change that.
< / div >
2003-11-12 22:50:30 -05:00
2008-01-28 22:24:47 -05:00
< p > The following shows how you can specify the listening settings for the server.< / p > < p > The
first shows an example of a common and simple way to define a listening socket
< pre >
< listen-socket>
< port> 8000< /port>
< /listen-socket>
< / pre >
< p > Using this as a basis we can extend this with an < bind-address> setting to limit which
address icecast will listen on. Most will not need to use bind-address and often get confused
by using it when there is no need. Another possibility is to use an < ssl> boolean setting
which informs icecast that a secured connection is to be used. A common use for using a secure
connection would be for admin page access.< / p >
< p > The following shows how we can extend a single listen-socket to work with shoutcast style
source clients. There are two issues shoutcast source clients have over icecast source clients,
one is the lack of mountpoint and the second is the requirement of two ports. Both of these
issues are handled by a simple addition in the listen-socket.< / p >
< pre >
< listen-socket>
< port> 8000< /port>
< shoutcast-mount> /live.mp3< /shoutcast-mount>
< /listen-socket>
< / pre >
< p > As before the port specified is allocated but this time the shoutcast-mount implicity defines
a second listening socket whose port number is always one higher than the port defined, this also
informs icecast of which mountpoint the shoutcast source client on this socket will be using.
Using this approach you can allow multiple shoutcast source clients to connect at the same time.
< p > The following is just to show the longer approach to defining shoutcast compatability.< / p >
< pre >
< shoutcast-mount> /live.nsv< /shoutcast-mount>
2003-11-12 22:50:30 -05:00
2011-12-03 02:02:22 -05:00
< !-- You may have multiple < listen-socket> elements -->
2003-11-12 22:50:30 -05:00
< listen-socket>
2004-08-20 15:22:37 -04:00
< port> 8000< /port>
< /listen-socket>
2008-01-28 22:24:47 -05:00
2004-11-11 10:47:33 -05:00
< listen-socket>
< port> 8001< /port>
< shoutcast-compat> 1< /shoutcast-compat>
< /listen-socket>
2003-11-12 22:50:30 -05:00
< / pre >
2008-01-28 22:24:47 -05:00
< p > Note that multiple listen-socket sections may be configured in order to have icecast2 listen
on multiple network interfaces or multiple ports.
2005-08-16 10:58:33 -04:00
If a bind-address is not specified for a particular listen-socket, then the socket will be
2008-01-28 22:24:47 -05:00
bound to all interfaces (including IPv6 if available). For most people, the bind-address option
will not be required and often confuses people.
2003-11-12 22:50:30 -05:00
< / p >
< h4 > port< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2003-11-12 22:50:30 -05:00
The TCP port that will be used to accept client connections.
< / div >
< h4 > bind-address< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2005-02-27 20:08:04 -05:00
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.
2003-11-12 22:50:30 -05:00
< / div >
2008-01-28 22:24:47 -05:00
< h4 > shoutcast-mount< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2008-01-28 22:24:47 -05:00
An optional mountpoint setting to be used when shoutcast DSP compatible clients connect. The
default global setting is /stream but can be overridden here to use an alternative name which
may include an extension that some clients require for certain formats.< br / > < 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
shoutcast-compat approach as this implicitly defines the second listening socket and allows
for specifying multiple sockets using different mountpoints for shoutcast source
clients. The shoutcast-mount outside of a listen-socket group is the global setting of the
mountpoint to use.
2003-11-12 22:50:30 -05:00
< / div >
2008-01-28 22:24:47 -05:00
< h4 > shoutcast-compat< / h4 >
2004-11-17 11:02:04 -05:00
< div class = "indentedbox" >
2008-01-28 22:24:47 -05:00
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 'shoutcast-compat'. This means if you define 8001 as shoutcast-compat, then you will need to define a listen port of 8000 and it must not also be defined as shoutcast-compat. See the example config file in the distribution for more info.
2004-11-17 11:02:04 -05:00
< / div >
2004-09-18 12:50:19 -04:00
< p >
2004-09-18 10:31:39 -04:00
< br / >
< br / >
< br / >
2004-09-18 12:50:19 -04:00
< / p >
2003-11-12 22:50:30 -05:00
< a name = "relay" > < / a >
2008-01-28 22:24:47 -05:00
< h2 > Relaying Streams< / h2 >
< p > This section contains the servers relay settings. The relays are implemented using a pull system where
the receiving server connects as if its a listener to the sending server. There are two types of relay
setups: a "Master server relay" or a "Specific Mountpoint relay."
< / p >
< h3 > Master Relay< / h3 >
< p >
A Master server relay is only supported between icecast2 servers and is used to relay a number of
mountpoints from a remote icecast2 server.
2003-11-12 22:50:30 -05:00
< pre >
2004-08-20 15:22:37 -04:00
< master-server> 127.0.0.1< /master-server>
< master-server-port> 8001< /master-server-port>
< master-update-interval> 120< /master-update-interval>
2005-05-12 20:35:08 -04:00
< master-username> relay< /master-username>
2004-08-20 15:22:37 -04:00
< master-password> hackme< /master-password>
2005-06-08 21:51:47 -04:00
< relays-on-demand> 0< /relays-on-demand>
2003-11-12 22:50:30 -05:00
< / pre >
2008-01-28 22:24:47 -05:00
< br / >
< p > The following diagram shows the basics of using a Master relay. Please note that the slave is
configured with the < master-server> , < master-server-port> , etc settings and the
master is the icecast server from which the slave will pull mountpoints and relay them. Using a
Master server relay, all non-hidden mountpoints on the master can be relayed using this mechanism. < / p >
< br / >
< img src = "masterslave.png" >
2004-09-18 17:01:39 -04:00
< p >
2003-11-12 22:50:30 -05:00
A server is configured as a Master Server relay by specifying the < master-server> , < master-server-port> ,< master-update-interval> ,< master-password> values in the config file. The server that is being relayed does not need any special configuration.
< / p >
2004-09-18 17:01:39 -04:00
2003-11-12 22:50:30 -05:00
< h4 > master-server< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2005-08-16 22:40:29 -04:00
This is the IP for the server which contains the mountpoints to be relayed (Master Server).
2003-11-12 22:50:30 -05:00
< / div >
< h4 > master-server-port< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2003-11-12 22:50:30 -05:00
This is the TCP Port for the server which contains the mountpoints to be relayed (Master Server).
< / div >
< h4 > master-update-interval< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2003-11-18 12:23:55 -05:00
The interval (in seconds) that the Relay Server will poll the Master Server for any new mountpoints to relay.
2003-11-12 22:50:30 -05:00
< / div >
2005-05-12 20:35:08 -04:00
< h4 > master-username< / h4 >
< div class = "indentedbox" >
This is the relay username on the master server. It is used to query the
server for a list of mountpoints to relay. If not specified then 'relay' is
used
< / div >
2003-11-12 22:50:30 -05:00
< h4 > master-password< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2005-05-12 20:35:08 -04:00
This is the relay password on the Master server. It is used to query the
server for a list of mountpoints to relay.
2003-11-12 22:50:30 -05:00
< / div >
2005-06-08 21:51:47 -04:00
< h4 > relays-on-demand< / h4 >
< div class = "indentedbox" >
2008-01-28 22:24:47 -05:00
Global on-demand setting for relays. Because you do not have individual relay options when using a
master server relay, you still may want those relays to only pull the stream when there is at least
one listener on the slave. The typical case here is to avoid surplus bandwidth costs when no one is
listening.
2005-06-08 21:51:47 -04:00
< / div >
2004-09-18 10:31:39 -04:00
< br / >
2003-11-12 22:50:30 -05:00
< h3 > Specific Mountpoint Relay< / h3 >
2008-01-28 22:24:47 -05:00
< p >
If only specific mountpoints need to be relayed, then you can configure Icecast with a "Specific
Mountpoint Relay".
< / p >
The following diagram shows the basics of using a Specific Mountpoint relay. Note that the relaying
Icecast is configured with the < relay> settings and will pull the specified mountpoint(s) and
relay them to the listeners. Using a Specific Mountpoint Relay, only those mountpoints specified
will be relayed.
2003-11-12 22:50:30 -05:00
2008-01-28 22:24:47 -05:00
< br / > < br / >
< img src = "relay.png" >
< p >
2003-11-12 22:50:30 -05:00
Specific Mountpoint Relays can be configured to relay from an Icecast 2 server, as well as Icecast 1.x and Shoutcast.
A server is configured as a Specific Mountpoint Server relay by specifying a < relay> XML chunk in the config file for each mountpoint to be relayed. The server that is being relayed does not need any special configuration.
2008-01-28 22:24:47 -05:00
< / p >
2004-08-20 15:22:37 -04:00
< pre >
< relay>
< server> 127.0.0.1< /server>
< port> 8001< /port>
2004-09-30 20:47:52 -04:00
< mount> /example.ogg< /mount>
2004-09-30 20:39:37 -04:00
< local-mount> /different.ogg< /local-mount>
2004-12-09 12:08:52 -05:00
< username> joe< /username>
< password> soap< /password>
2004-08-20 15:22:37 -04:00
< relay-shoutcast-metadata> 0< /relay-shoutcast-metadata>
2005-06-08 21:51:47 -04:00
< on-demand> 1< /on-demand>
2004-08-20 15:22:37 -04:00
< /relay>
< / pre >
2003-11-12 22:50:30 -05:00
2004-09-18 17:01:39 -04:00
2003-11-12 22:50:30 -05:00
< h4 > server< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2003-11-12 22:50:30 -05:00
This is the IP for the server which contains the mountpoint to be relayed.
< / div >
< h4 > port< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2003-11-12 22:50:30 -05:00
This is the TCP Port for the server which contains the mountpoint to be relayed.
< / div >
< h4 > mount< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2008-01-28 22:24:47 -05:00
The mountpoint located on the remote server. If you are relaying a shoutcast stream, this
should be a '/' or '/;name'.
2003-11-12 22:50:30 -05:00
< / div >
< h4 > local-mount< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2008-01-28 22:24:47 -05:00
The name to use for the local mountpoint. This is what the mount will be named on the relaying
server. By default the remote mountpoint name is used.
2003-11-12 22:50:30 -05:00
< / div >
2004-12-09 12:08:52 -05:00
< h4 > username< / h4 >
< div class = "indentedbox" >
The source of the relay may require authentication itself, if so state the username here.
< / div >
< h4 > password< / h4 >
< div class = "indentedbox" >
The source of the relay may require authentication itself, if so state the password here.
< / div >
2003-11-12 22:50:30 -05:00
< h4 > relay-shoutcast-metadata< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2008-01-28 22:24:47 -05:00
If you are relaying a Shoutcast stream, you may want to specify this indicator to also relay
the metadata (song titles) that are part of the Shoutcast data stream (1=enabled, 0=disabled).
By default this is enabled but it is up to the remote server on whether it sends any.
2003-11-12 22:50:30 -05:00
< / div >
2005-06-08 21:51:47 -04:00
< h4 > on-demand< / h4 >
< div class = "indentedbox" >
2008-01-28 22:24:47 -05:00
< p > An on-demand relay will only retrieve the stream if there are listeners requesting the
stream. 1=enabled, 0=disabled (default is < relays-on-demand> ). This is useful in cases
where you want to limit bandwidth costs when no one is listening. < / p >
2005-06-08 21:51:47 -04:00
< / div >
2004-09-18 12:50:19 -04:00
< p >
2004-09-18 10:31:39 -04:00
< br / >
< br / >
< br / >
2004-09-18 12:50:19 -04:00
< / p >
2003-11-12 22:50:30 -05:00
< a name = "mount" > < / a >
< h2 > Mount Specific Settings< / h2 >
< pre >
< mount>
2004-08-20 15:22:37 -04:00
< mount-name> /example-complex.ogg< /mount-name>
< username> othersource< /username>
< password> hackmemore< /password>
< max-listeners> 1< /max-listeners>
2005-08-23 15:00:15 -04:00
< max-listener-duration> 3600< /max-listener-duration>
2004-08-20 15:22:37 -04:00
< dump-file> /tmp/dump-example1.ogg< /dump-file>
2005-06-03 11:35:52 -04:00
< intro> /intro.ogg< /intro>
2004-09-30 20:47:52 -04:00
< fallback-mount> /example2.ogg< /fallback-mount>
2004-08-20 15:22:37 -04:00
< fallback-override> 1< /fallback-override>
2005-08-23 14:40:20 -04:00
< fallback-when-full> 1< /fallback-when-full>
2008-01-28 22:24:47 -05:00
< charset> ISO8859-1< /charset>
2005-05-30 10:50:57 -04:00
< public> 1< /public>
< stream-name> My audio stream< /stream-name>
< stream-description> My audio description< /stream-description>
< stream-url> http://some.place.com< /stream-url>
< genre> classical< /genre>
< bitrate> 64< /bitrate>
< type> application/ogg< /type>
< subtype> vorbis< /subtype>
2004-11-22 13:21:48 -05:00
< hidden> 1< /hidden>
2004-08-20 15:22:37 -04:00
< burst-size> 65536< /burst-size>
2005-05-07 16:18:13 -04:00
< mp3-metadata-interval> 4096< /mp3-metadata-interval>
2013-02-24 11:19:53 -05:00
< authentication type="xxxxxx">
< !-- See listener authentiaction documentation -->
2004-04-30 10:36:07 -04:00
< /authentication>
2005-06-09 20:37:09 -04:00
< on-connect> /home/icecast/bin/source-start< /on-connect>
< on-disconnect> /home/icecast/bin/source-end< /on-disconnect>
2004-08-20 15:22:37 -04:00
< /mount>
2003-11-12 22:50:30 -05:00
< / pre >
2005-05-30 10:50:57 -04:00
< 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.
2003-11-12 22:50:30 -05:00
< / p >
< h4 > mount-name< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2003-11-12 22:50:30 -05:00
The name of the mount point for which these settings apply.
< / div >
< h4 > username< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2011-12-03 04:25:36 -05:00
An optional value which will set the username that a source must use to connect using this mountpoint.< br / >
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 'source'. If this value is not present the default username is 'source'.
2003-11-12 22:50:30 -05:00
< / div >
< h4 > password< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2013-02-24 11:19:53 -05:00
An optional value which will set the password that a source must use to connect using this mountpoint.< br / >
2014-05-04 11:37:50 -04:00
There is also a < a href = "icecast2_auth.html#stream_auth" > URL based authentication method< / a > for sources that can be used instead.
2003-11-12 22:50:30 -05:00
< / div >
< h4 > max-listeners< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2003-11-12 22:50:30 -05:00
An optional value which will set the maximum number of listeners that can be attached to this mountpoint.
< / div >
2005-08-23 15:00:15 -04:00
< h4 > max-listener-duration< / h4 >
< div class = "indentedbox" >
An optional value which will set the length of time a listener will stay connected to the
stream. An auth component may override this.
< / div >
2003-11-12 22:50:30 -05:00
< h4 > dump-file< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2003-11-12 22:50:30 -05:00
An optional value which will set the filename which will be a dump of the stream coming through on this mountpoint.
2013-02-23 19:41:15 -05:00
This filename is processed with strftime(3). This allows to use variables like %F.
2003-11-12 22:50:30 -05:00
< / div >
2005-06-03 11:35:52 -04:00
< h4 > intro< / h4 >
< div class = "indentedbox" >
< p > 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.
< / p >
< / div >
2003-11-12 22:50:30 -05:00
< h4 > fallback-mount< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2004-10-29 13:19:03 -04:00
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
2005-08-16 22:40:29 -04:00
streaming format.< br >
2004-10-29 13:19:03 -04:00
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.
2005-08-16 22:40:29 -04:00
This multi-level fallback allows clients to cascade several mountpoints.
2005-06-10 11:42:06 -04:00
< p > 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.
< / p >
< p > 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.
< / p >
2003-11-12 22:50:30 -05:00
< / div >
2004-08-20 15:22:37 -04:00
< h4 > fallback-override< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2004-08-20 15:22:37 -04:00
When enabled, this allows a connecting source client or relay on this mountpoint to move
listening clients back from the fallback mount.
< / div >
2005-08-23 14:40:20 -04:00
< h4 > fallback-when-full< / h4 >
< div class = "indentedbox" >
< p > When set to 1, 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.
< / p >
< / div >
2005-05-30 10:50:57 -04:00
< h4 > no-yp (deprecated)< / h4 >
< div class = "indentedbox" >
< p > Setting this option prevents this mountpoint from advertising on YP. The default is 0
so YP advertising can occur however you may want to prevent it here if you intend listeners
to connect to a local relay instead. Deprecated option, replaced by < public>
< / p >
< / div >
2008-01-28 22:24:47 -05:00
< h4 > charset< / h4 >
< div class = "indentedbox" >
< p > 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.< / p >
< p > 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.
< p > The source clients can also specify a charset= parameter to the metadata update URL if
they so wish.< / p >
< / div >
2005-05-30 10:50:57 -04:00
< h4 > public< / h4 >
< div class = "indentedbox" >
< p > The default setting for this is -1 indicating that it is up to the source client or
relay to determine if this mountpoint should advertise. A setting of 0 will prevent any
advertising and a setting of 1 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.
< / p >
< / div >
< h4 > stream-name< / h4 >
< div class = "indentedbox" >
< p > Setting this will add the specified name to the stats (and therefore YP) for this
mountpoint even if the source client/relay provide one.
< / p >
< / div >
< h4 > stream-description< / h4 >
< div class = "indentedbox" >
< p > Setting this will add the specified description to the stats (and therefore YP) for
this mountpoint even if the source client/relay provide one.
< / p >
< / div >
< h4 > stream-url< / h4 >
< div class = "indentedbox" >
< p > Setting this will add the specified URL to the stats (and therefore YP) for this
2005-08-16 22:40:29 -04:00
mountpoint even if the source client/relay provide one. The URL is generally for
2005-05-30 10:50:57 -04:00
directing people to a website.
< / p >
< / div >
< h4 > genre< / h4 >
< div class = "indentedbox" >
< p > Setting this will add the specified genre to the stats (and therefore YP) for this
mountpoint even if the source client/relay provide one. This can be anything be using
certain key words can help searches in the YP directories.
< / p >
< / div >
< h4 > bitrate< / h4 >
< div class = "indentedbox" >
< p > Setting this will add the specified bitrate to the stats (and therefore YP) for this
mountpoint even if the source client/relay provide one. This is stated in kbps.
< / p >
< / div >
< h4 > type< / h4 >
< div class = "indentedbox" >
< p > 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. It is very unlikely that
this will be needed.
< / p >
< / div >
< h4 > subtype< / h4 >
2004-11-21 10:51:49 -05:00
< div class = "indentedbox" >
2005-05-30 10:50:57 -04:00
< p > 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
< / p >
2004-11-21 10:51:49 -05:00
< / div >
2004-08-20 15:22:37 -04:00
< h4 > burst-size< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2004-08-20 15:22:37 -04:00
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 >
2005-05-07 16:18:13 -04:00
< h4 > mp3-metadata-interval< / h4 >
< div class = "indentedbox" >
2005-06-08 21:51:47 -04:00
< p > 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.
< / p >
2005-05-07 16:18:13 -04:00
< / div >
2004-11-22 13:21:48 -05:00
< h4 > hidden< / h4 >
< div class = "indentedbox" >
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
< / div >
2004-04-30 10:36:07 -04:00
< h4 > authentication< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2014-05-04 11:37:50 -04:00
This specifies that the named mount point will require listener (or source) authentication. Currently, we support a file-based authentication scheme (type=htpasswd) 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. You can read more about listener authentication and URL based source authentication < a href = "icecast2_auth.html" > here< / a > .
2004-04-30 10:36:07 -04:00
< / div >
2005-06-09 20:37:09 -04:00
< h4 > on-connect< / h4 >
< div class = "indentedbox" >
< p > 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. This option is not available on win32
< / p >
< / div >
< h4 > on-disconnect< / h4 >
< div class = "indentedbox" >
< p > 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. This option is not available on win32
< / p >
< / div >
2004-09-18 12:50:19 -04:00
< p >
2004-09-18 10:31:39 -04:00
< br / >
< br / >
< br / >
2004-09-18 12:50:19 -04:00
< / p >
2003-11-12 22:50:30 -05:00
< a name = "path" > < / a >
< h2 > Path Settings< / h2 >
< pre >
< paths>
2004-08-20 15:22:37 -04:00
< basedir> ./< /basedir>
< logdir> ./logs< /logdir>
< pidfile> ./icecast.pid< /pidfile>
< webroot> ./web< /webroot>
< adminroot> ./admin< /adminroot>
2008-01-28 22:24:47 -05:00
< allow-ip> /path/to/ip_allowlist< /allow-ip>
< deny-ip> /path_to_ip_denylist< /deny-ip>
2003-11-12 22:50:30 -05:00
< alias source="/foo" dest="/bar"/>
2004-08-20 15:22:37 -04:00
< /paths>
2003-11-12 22:50:30 -05:00
< / pre >
2007-02-28 18:00:22 -05:00
< p > This section contains paths which are used for various things within icecast. All paths (other than any aliases) should not end in a '/'.
2003-11-12 22:50:30 -05:00
< / p >
< h4 > basedir< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2003-11-12 22:50:30 -05:00
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 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2005-08-16 22:40:29 -04:00
This path specifies the base directory used for logging. Both the error.log and access.log will be created relative to this directory.
2003-11-12 22:50:30 -05:00
< / div >
2003-12-01 18:30:13 -05:00
< h4 > pidfile< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2003-12-01 18:30:13 -05:00
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 >
2003-11-12 22:50:30 -05:00
< h4 > webroot< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2003-11-12 22:50:30 -05:00
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 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2003-11-12 22:50:30 -05:00
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 >
2008-01-28 22:24:47 -05:00
< h4 > allow-ip< / h4 >
< div class = "indentedbox" >
If specified, this specifies 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. The format of the file is simple, one IP per line.
< / div >
< h4 > deny-ip< / h4 >
< div class = "indentedbox" >
If specified, this specifies 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. The format of the file is simple, one IP per line.
< / div >
2003-11-12 22:50:30 -05:00
< h4 > alias source="/foo" dest="/bar"< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2003-11-12 22:50:30 -05:00
Aliases are used to provide a way to create multiple mountpoints that refer to the same mountpoint.
< / div >
2004-09-18 12:50:19 -04:00
< p >
2004-09-18 10:31:39 -04:00
< br / >
< br / >
< br / >
2004-09-18 12:50:19 -04:00
< / p >
2003-11-12 22:50:30 -05:00
< a name = "log" > < / a >
< h2 > Logging Settings< / h2 >
< pre >
< logging>
< accesslog> access.log< /accesslog>
< errorlog> error.log< /errorlog>
2004-11-15 23:04:02 -05:00
< playlistlog> playlist.log< /playlistlog>
2011-12-03 02:02:22 -05:00
< loglevel> 4< /loglevel> < !-- 4 Debug, 3 Info, 2 Warn, 1 Error -->
2003-11-12 22:50:30 -05:00
< /logging>
< / pre >
2014-05-04 11:07:38 -04:00
< p > This section contains information relating to logging within icecast. There are three logfiles currently generated by icecast, an error.log (where all log messages are placed), an access.log (where all stream/admin/http requests are logged) and an optional playlist.log.
2003-11-12 22:50:30 -05:00
< / 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.
2004-09-18 17:01:39 -04:00
< / p >
2014-05-04 11:07:38 -04:00
< p > If you set any of the filenames to a simple dash (e.g. < accesslog> -< /accesslog> ) then Icecast will direct the log output to STDERR instead of a file.
< / p >
2003-11-12 22:50:30 -05:00
< h4 > accesslog< / h4 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2003-11-12 22:50:30 -05:00
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 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2003-11-12 22:50:30 -05:00
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 >
2004-11-15 23:04:02 -05:00
< h4 > playlistlog< / h4 >
< div class = "indentedbox" >
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.
< / div >
2005-10-24 10:51:54 -04:00
< h4 > logsize< / h4 >
< div class = "indentedbox" >
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 logfile.old, or add a timestamp to the archived file (if logarchive is enabled).
< / div >
< h4 > logarchive< / h4 >
< div class = "indentedbox" >
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 logfile.old (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.
< / div >
2003-11-12 22:50:30 -05:00
< h4 > loglevel< / h4 >
2004-09-18 10:31:39 -04:00
< 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 :
2004-09-18 12:50:19 -04:00
< ul >
2004-09-18 17:01:39 -04:00
< 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 >
2004-09-18 12:50:19 -04:00
< / ul >
2004-09-18 17:01:39 -04:00
< / div >
2004-09-18 10:31:39 -04:00
< br / >
2003-11-12 22:50:30 -05:00
< a name = "security" > < / a >
< h2 > Security Settings< / h2 >
< pre >
< security>
< chroot> 0< /chroot>
< changeowner>
< user> nobody< /user>
< group> nogroup< /group>
< /changeowner>
< /security>
< / pre >
< 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 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2003-11-12 22:50:30 -05:00
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 >
2004-09-18 10:31:39 -04:00
< div class = "indentedbox" >
2003-11-12 22:50:30 -05:00
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.
< / div >
< / div >
< / body >
< / html >
