icecast2_config_file.html 20.4 KB
Newer Older
1 2 3 4 5 6 7
<LINK REL=STYLESHEET TYPE= "text/css" HREF= "style.css">
<div class=boxtest>
<body bgcolor="#efefef" text="#323232" link="#0000ff" vlink="#800080" alink="#ff0000">
<h1>Icecast 2 Config File</h1>
<table width=100%><tr><td bgcolor="#007B79" height="10" align="center"></td></tr></table>
<h3>Overview</h3>
<p>
vanguardist's avatar
vanguardist committed
8
This section will describe each section of the config file and is grouped into the following sections:
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
</p>
<li><a href="#limits">Limits</a>
<li><a href="#authentication">Authentication</a>
<li><a href="#yp">YP Directory Settings</a>
<li><a href="#misc">Misc Server settings</a>
<li><a href="#relay">Relay settings</a>
<li><a href="#mount">Mount Specific settings</a>
<li><a href="#path">File path settings</a>
<li><a href="#log">Logging</a>
<li><a href="#security">Security</a>

<br>
<br>
<br>
<a name="limits"></a>
<h2>Limits</h2>
<pre>
    &lt;limits&gt;
27 28 29 30 31 32 33 34 35 36
        &lt;clients&gt;100&lt;/clients&gt;
        &lt;sources&gt;2&lt;/sources&gt;
        &lt;threadpool&gt;5&lt;/threadpool&gt;
        &lt;queue-size&gt;102400&lt;/queue-size&gt;
        &lt;client-timeout&gt;30&lt;/client-timeout&gt;
        &lt;header-timeout&gt;15&lt;/header-timeout&gt;
        &lt;source-timeout&gt;10&lt;/source-timeout&gt;
        &lt;burst-on-connect&gt;1&lt;/burst-on-connect&gt;
        &lt;burst-size&gt;65536&lt;/burst-size&gt;
    &lt;/limits&gt;
37
</pre>
vanguardist's avatar
vanguardist committed
38
<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.
39 40 41
</p>
<h4>clients</h4>
<div class=indentedbox>
vanguardist's avatar
vanguardist committed
42
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).
43 44 45
</div>
<h4>sources</h4>
<div class=indentedbox>
vanguardist's avatar
vanguardist committed
46
Maximum number of connected sources supported by the server.
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
</div>
<h4>threadpool</h4>
<div class=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>
<div class=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>
<div class=indentedbox>
This does not seem to be used.
</div>
<h4>header-timeout</h4>
<div class=indentedbox>
vanguardist's avatar
vanguardist committed
62
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.
63 64 65 66 67
</div>
<h4>source-timeout</h4>
<div class=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>
68 69 70 71
<h4>burst-on-connect</h4>
<div class=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>
72 73 74 75 76 77 78
<h4>burst-size</h4>
<div class=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>
79 80 81 82 83 84 85
<br>
<br>
<br>
<a name="authentication"></a>
<h2>Authentication</h2>
<pre>
    &lt;authentication&gt;
86 87 88 89 90
        &lt;source-password&gt;hackme&lt;/source-password&gt;
        &lt;relay-password&gt;hackme&lt;/relay-password&gt;
        &lt;admin-user&gt;admin&lt;/admin-user&gt;
        &lt;admin-password&gt;hackme&lt;/admin-password&gt;
    &lt;/authentication&gt;
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
</pre>
<p>This section contains all the users and passwords used for administration purposes or to connect sources and relays.
</p>
<h4>source-password</h4>
<div class=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>
<div class=indentedbox>
Currently not used.
</div>
<h4>admin-user</h4>
<h4>admin-password</h4>
<div class=indentedbox>
The username/password used for all administration functions.  This includes retrieving statistics, accessing the web-based administration screens, etc.  A list of these functions can be found in the "Administration" section of the manual.
</div>
<br>
<br>
<br>
<a name="yp"></a>
<h2>YP Directory Settings</h2>
<pre>
    &lt;directory&gt;
114 115 116
        &lt;yp-url-timeout&gt;15&lt;/yp-url-timeout&gt;
        &lt;yp-url&gt;http://dir.xiph.org/cgi-bin/yp-cgi&lt;/yp-url&gt;
    &lt;/directory&gt;
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
</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>
<div class=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>
<div class=indentedbox>
The URL which icecast2 uses to communicate with the Directory server.  The value for this setting is provided by the owner of the Directory server.
</div>
<br>
<br>
<br>
<a name="misc"></a>
<h2>Misc Server Settings</h2>
<pre>
    &lt;hostname&gt;localhost&lt;hostname&gt;

    &lt;-- You can use these two if you only want a single listener --&gt;
137 138
    &lt;-- &lt;port&gt;8000&lt;/port&gt; --&gt;
    &lt;-- &lt;bind-address&gt;127.0.0.1&lt;/bind-address&gt; --&gt;
139

140
    &lt;-- You may have multiple &lt;listen-socket&gt; elements --&gt;
141
    &lt;listen-socket&gt;
142 143 144
        &lt;port&gt;8000&lt;/port&gt;
        &lt;bind-address&gt;127.0.0.1&lt;/bind-address&gt;
    &lt;/listen-socket&gt;
145

146
    &lt;fileserve&gt;1&lt;/fileserve&gt;
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
</pre>
<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>
<div class=indentedbox>
The TCP port that will be used to accept client connections.
</div>
<h4>bind-address</h4>
<div class=indentedbox>
And option IP address that can be used to bind to a specific network card.  If not supplied, then &lt;hostname&gt; will be used.
</div>
<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 &lt;paths&gt;&lt;webroot&gt; configuration setting.
</div>
<br>
<br>
<br>
<a name="relay"></a>
<h2>Relay Settings</h2>
<pre>
168 169 170 171
    &lt;master-server&gt;127.0.0.1&lt;/master-server&gt;
    &lt;master-server-port&gt;8001&lt;/master-server-port&gt;
    &lt;master-update-interval&gt;120&lt;/master-update-interval&gt;
    &lt;master-password&gt;hackme&lt;/master-password&gt;
172 173

    &lt;relay&gt;
174 175 176 177 178 179
        &lt;server&gt;127.0.0.1&lt;/server&gt;
        &lt;port&gt;8001&lt;/port&gt;
        &lt;mount&gt;example.ogg&lt;/mount&gt;
        &lt;local-mount&gt;different.ogg&lt;/local-mount&gt;
        &lt;relay-shoutcast-metadata&gt;0&lt;/relay-shoutcast-metadata&gt;
    &lt;/relay&gt;
180
</pre>
vanguardist's avatar
vanguardist committed
181
<p>This section contains the server's relay settings. There are two types of relays: a "Master server relay" or a "Specific Mountpoint relay."  A Master server relay is only supported between icecast2 servers and is used to relays all mountpoints on a remote icecast2 server.   
182 183

<h3>Master Relay</h3>
vanguardist's avatar
vanguardist committed
184
The following diagram shows the basics of doing a Master relay.  Note that Server 1 is configured with the &lt;master-server&gt;, &lt;master-server-port&gt;, etc settings and Server 2 is the server from which Server 1 will pull all attached mountpoints and relay them.  Using a Master Server relay, ALL mountpoints on Server 2 will be relayed.  If only specific mountpoints need to be relayed, then you must configure Server 1 as a "Specific Mountpoint Relay".  Both Master server relays and Specific Mountpoint relays begin their "relaying" when the Server is started.
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213

<pre>
      |-----|                       |-----|
      |     |  all mountpoints      |     | /mount1
      |     | &lt;-------------------  |     | /mount2.ogg
      |-----|                       |-----| /mount3
      Icecast 2                     Icecast 2 
      Server 1                      Server 2
      (RELAY SERVER)                (MASTER SERVER)

     configured with
     &lt;master-server&gt;
     settings 

</pre>

A server is configured as a Master Server relay by specifying the &lt;master-server&gt;, &lt;master-server-port&gt;,&lt;master-update-interval&gt;,&lt;master-password&gt; values in the config file.  The server that is being relayed does not need any special configuration.

</p>
<h4>master-server</h4>
<div class=indentedbox>
This is the IP for the server which contains the mountpoints to be relayed (Master Server).  
</div>
<h4>master-server-port</h4>
<div class=indentedbox>
This is the TCP Port for the server which contains the mountpoints to be relayed (Master Server).
</div>
<h4>master-update-interval</h4>
<div class=indentedbox>
vanguardist's avatar
vanguardist committed
214
The interval (in seconds) that the Relay Server will poll the Master Server for any new mountpoints to relay.
215 216 217 218 219 220 221
</div>
<h4>master-password</h4>
<div class=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>
<h3>Specific Mountpoint Relay</h3>
vanguardist's avatar
vanguardist committed
222
The following diagram shows the basics of doing a Specific Mountpoint relay.  Note that Server 1 is configured with the &lt;relay&gt; 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.
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241

<pre>
      |-----|                       |-----|
      |     |      /mount3          |     | /mount1
      |     | &lt;-------------------  |     | /mount2.ogg
      |-----|                       |-----| /mount3
      Icecast 2                     Icecast 2/Shoutcast/Icecast
      Server 1                      Server 2
      (RELAY SERVER)                (REMOTE SERVER)

     configured with
     &lt;relay&gt;
     settings 

</pre>

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 &lt;relay&gt; XML chunk in the config file for each mountpoint to be relayed.  The server that is being relayed does not need any special configuration.

242 243 244 245 246 247 248 249 250
<pre>
    &lt;relay&gt;
        &lt;server&gt;127.0.0.1&lt;/server&gt;
        &lt;port&gt;8001&lt;/port&gt;
        &lt;mount&gt;example.ogg&lt;/mount&gt;
        &lt;local-mount&gt;different.ogg&lt;/local-mount&gt;
        &lt;relay-shoutcast-metadata&gt;0&lt;/relay-shoutcast-metadata&gt;
    &lt;/relay&gt;
</pre>
251 252 253 254 255 256 257 258 259 260 261 262

</p>
<h4>server</h4>
<div class=indentedbox>
This is the IP for the server which contains the mountpoint to be relayed.
</div>
<h4>port</h4>
<div class=indentedbox>
This is the TCP Port for the server which contains the mountpoint to be relayed.
</div>
<h4>mount</h4>
<div class=indentedbox>
vanguardist's avatar
vanguardist committed
263
The mountpoint located on the remote server.  If you are relaying a shoutcast stream, this must be '/'.
264 265 266 267 268 269 270
</div>
<h4>local-mount</h4>
<div class=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>
<div class=indentedbox>
vanguardist's avatar
vanguardist committed
271
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).
272 273 274 275 276 277 278 279
</div>
<br>
<br>
<br>
<a name="mount"></a>
<h2>Mount Specific Settings</h2>
<pre>
    &lt;mount&gt;
280 281 282 283 284 285 286 287
        &lt;mount-name&gt;/example-complex.ogg&lt;/mount-name&gt;
        &lt;username&gt;othersource&lt;/username&gt;
        &lt;password&gt;hackmemore&lt;/password&gt;
        &lt;max-listeners&gt;1&lt;/max-listeners&gt;
        &lt;dump-file&gt;/tmp/dump-example1.ogg&lt;/dump-file&gt;
        &lt;fallback-mount&gt;example2.ogg&lt;/fallback-mount&gt;
        &lt;fallback-override&gt;1&lt;/fallback-override&gt;
        &lt;burst-size&gt;65536&lt;/burst-size&gt;
288 289
        &lt;authentication type="htpasswd"&gt;
                &lt;option name="filename" value="myauth"/&gt;
290
                &lt;option name="allow_duplicate_users" value="0"/&gt;
291 292
        &lt;/authentication&gt;

293
    &lt;/mount&gt;
294
</pre>
vanguardist's avatar
vanguardist committed
295
<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.
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
</p>
<h4>mount-name</h4>
<div class=indentedbox>
The name of the mount point for which these settings apply.
</div>
<h4>username</h4>
<div class=indentedbox>
An optional value which will set the username that a source must use to connect using this mountpoint.
</div>
<h4>password</h4>
<div class=indentedbox>
An optional value which will set the password that a source must use to connect using this mountpoint.
</div>
<h4>max-listeners</h4>
<div class=indentedbox>
An optional value which will set the maximum number of listeners that can be attached to this mountpoint.
</div>
<h4>dump-file</h4>
<div class=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>
<div class=indentedbox>
vanguardist's avatar
vanguardist committed
319
This specifies a mountpoint that is used in the case of a source disconnect.  If listeners are connected to the mount specified by the &lt;mount-name&gt; config value, then if the source is disconnected; all currently connected clients will be moved to the fallback-mount.
320
</div>
321 322 323 324 325 326 327 328 329 330
<h4>fallback-override</h4>
<div class=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>
<div class=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>
331 332
<h4>authentication</h4>
<div class=indentedbox>
333
This specifies that the named mount point will require listener authentication.  Currently, we only support a file-based authentication scheme (type=htpasswd).  Users and encrypted password are placed in this file (separated by a :) and all requests for this mountpoint will require that a user and password be supplied for authentication purposes.  These values are passed in via normal HTTP Basic Authentication means (i.e. http://user:password@stream:port/mountpoint.ogg).  Users and Passwords are maintained via the web admin interface.  A mountpoint configured with an authenticator will display a red key next to the mount point name on the admin screens.  You can read more about listener authentication <a href="icecast2_listenerauth.html">here</a>.
334
</div>
335 336 337 338 339 340 341
<br>
<br>
<br>
<a name="path"></a>
<h2>Path Settings</h2>
<pre>
    &lt;paths&gt;
342 343 344 345 346
        &lt;basedir&gt;./&lt;/basedir&gt;
        &lt;logdir&gt;./logs&lt;/logdir&gt;
        &lt;pidfile&gt;./icecast.pid&lt;/pidfile&gt;
        &lt;webroot&gt;./web&lt;/webroot&gt;
        &lt;adminroot&gt;./admin&lt;/adminroot&gt;
347
        &lt;alias source="/foo" dest="/bar"/&gt;
348
    &lt;/paths&gt;
349 350 351 352 353 354 355 356 357 358 359
</pre>
<p>This section contains paths which are used for various things within icecast.  All paths should not end in a '/'.
</p>
<h4>basedir</h4>
<div class=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>
<div class=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>
360 361 362 363
<h4>pidfile</h4>
<div class=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>
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
<h4>webroot</h4>
<div class=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>
<div class=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>
<div class=indentedbox>
Aliases are used to provide a way to create multiple mountpoints that refer to the same mountpoint.
</div>
<br>
<br>
<br>
<a name="log"></a>
<h2>Logging Settings</h2>
<pre>
    &lt;logging&gt;
        &lt;accesslog&gt;access.log&lt;/accesslog&gt;
        &lt;errorlog&gt;error.log&lt;/errorlog&gt;
      	&lt;loglevel&gt;4&lt;/loglevel&gt; &lt;-- 4 Debug, 3 Info, 2 Warn, 1 Error --&gt;
    &lt;/logging&gt;
</pre>
<p>This section contains information relating to logging within icecast.  There are two logfiles currently generated by icecast, an error.log (where all log messages are placed) and an access.log (where all stream/admin/http requests are logged).
</p>
<p>Note that on non-win32 platforms, a HUP signal can be sent to icecast in which the log files are re-opened for appending giving the ability move/remove the log files.
<h4>accesslog</h4>
<div class=indentedbox>
Into this file, all requests made to the icecast2 will be logged.  This file is relative to the path specified by the &lt;logdir&gt; config value.
</div>
<h4>errorlog</h4>
<div class=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>
<div class=indentedbox>
Indicates what messages are logged by icecast.  Log messages are categorized into one of 4 types, Debug, Info, Warn, and Error.<br><br>The following mapping can be used to set the appropraite value :
</div>
<br>
<br>
<li>loglevel = 4 - Debug, Info, Warn, Error messages are printed
<li>loglevel = 3 - Info, Warn, Error messages are printed
<li>loglevel = 2 - Warn, Error messages are printed
<li>loglevel = 1 - Error messages only are printed
<br>
<a name="security"></a>
<h2>Security Settings</h2>
<pre>
    &lt;security&gt;
        &lt;chroot&gt;0&lt;/chroot&gt;
        &lt;changeowner&gt;
            &lt;user&gt;nobody&lt;/user&gt;
            &lt;group&gt;nogroup&lt;/group&gt;
	&lt;/changeowner&gt;
    &lt;/security&gt;
</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>
<div class=indentedbox>
An indicator which specifies whether a chroot() will be done when the server is started.  The chrooted path is specified by the &lt;basedir&gt; configuration value.
</div>
<h4>changeowner</h4>
<div class=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.
</div>
</div>
</body>
</html>