icecast2_config_file.html 28.4 KB
Newer Older
j's avatar
j committed
1 2 3 4 5 6 7 8 9
<?xml version="1.0"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Icecast v2.0 Documentation</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
<div class="boxtest">
10
<h1>Icecast 2 Config File</h1>
j's avatar
j committed
11
<hr id='titlebar' />
12 13
<h3>Overview</h3>
<p>
vanguardist's avatar
vanguardist committed
14
This section will describe each section of the config file and is grouped into the following sections:
15
</p>
j's avatar
j committed
16
<ul>
17 18 19 20 21 22 23 24 25
<li><a href="#limits">Limits</a></li>
<li><a href="#authentication">Authentication</a></li>
<li><a href="#yp">YP Directory Settings</a></li>
<li><a href="#misc">Misc Server settings</a></li>
<li><a href="#relay">Relay settings</a></li>
<li><a href="#mount">Mount Specific settings</a></li>
<li><a href="#path">File path settings</a></li>
<li><a href="#log">Logging</a></li>
<li><a href="#security">Security</a></li>
j's avatar
j committed
26 27
</ul>
<p>
j's avatar
j committed
28 29 30
<br />
<br />
<br />
j's avatar
j committed
31
</p>
32 33 34 35
<a name="limits"></a>
<h2>Limits</h2>
<pre>
    &lt;limits&gt;
36 37 38 39 40 41 42 43 44 45
        &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;
46
</pre>
vanguardist's avatar
vanguardist committed
47
<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.
48 49
</p>
<h4>clients</h4>
j's avatar
j committed
50
<div class="indentedbox">
vanguardist's avatar
vanguardist committed
51
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).
52 53
</div>
<h4>sources</h4>
j's avatar
j committed
54
<div class="indentedbox">
vanguardist's avatar
vanguardist committed
55
Maximum number of connected sources supported by the server.
56 57
</div>
<h4>threadpool</h4>
j's avatar
j committed
58
<div class="indentedbox">
59 60 61
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>
j's avatar
j committed
62
<div class="indentedbox">
63 64 65
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>
j's avatar
j committed
66
<div class="indentedbox">
67 68 69
This does not seem to be used.
</div>
<h4>header-timeout</h4>
j's avatar
j committed
70
<div class="indentedbox">
vanguardist's avatar
vanguardist committed
71
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.
72 73
</div>
<h4>source-timeout</h4>
j's avatar
j committed
74
<div class="indentedbox">
75 76
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>
77
<h4>burst-on-connect</h4>
j's avatar
j committed
78
<div class="indentedbox">
79 80
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>
81
<h4>burst-size</h4>
j's avatar
j committed
82
<div class="indentedbox">
83 84 85 86 87
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>
j's avatar
j committed
88
<p>
j's avatar
j committed
89 90 91
<br />
<br />
<br />
j's avatar
j committed
92
</p>
93 94 95 96
<a name="authentication"></a>
<h2>Authentication</h2>
<pre>
    &lt;authentication&gt;
97
        &lt;source-password&gt;hackme&lt;/source-password&gt;
98
        &lt;relay-user&gt;relay&lt;/relay-user&gt;
99 100 101 102
        &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;
103 104 105 106
</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>
j's avatar
j committed
107
<div class="indentedbox">
108 109
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>
110 111 112 113 114
<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>
115
<h4>relay-password</h4>
j's avatar
j committed
116
<div class="indentedbox">
117 118
Used in the master server as part of the authentication when a slave requests
the list of streams to relay.
119 120 121
</div>
<h4>admin-user</h4>
<h4>admin-password</h4>
j's avatar
j committed
122
<div class="indentedbox">
123 124
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>
j's avatar
j committed
125
<p>
j's avatar
j committed
126 127 128
<br />
<br />
<br />
j's avatar
j committed
129
</p>
130 131 132 133
<a name="yp"></a>
<h2>YP Directory Settings</h2>
<pre>
    &lt;directory&gt;
134 135 136
        &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;
137 138 139 140
</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>
j's avatar
j committed
141
<div class="indentedbox">
142 143 144
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>
j's avatar
j committed
145
<div class="indentedbox">
146 147
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>
j's avatar
j committed
148
<p>
j's avatar
j committed
149 150 151
<br />
<br />
<br />
j's avatar
j committed
152
</p>
153 154 155 156 157
<a name="misc"></a>
<h2>Misc Server Settings</h2>
<pre>
    &lt;hostname&gt;localhost&lt;hostname&gt;

158
    &lt;-- You can use these two if you only want a single listening socket --&gt;
159 160
    &lt;-- &lt;port&gt;8000&lt;/port&gt; --&gt;
    &lt;-- &lt;bind-address&gt;127.0.0.1&lt;/bind-address&gt; --&gt;
161

162
    &lt;-- You may have multiple &lt;listen-socket&gt; elements --&gt;
163
    &lt;listen-socket&gt;
164 165 166
        &lt;port&gt;8000&lt;/port&gt;
        &lt;bind-address&gt;127.0.0.1&lt;/bind-address&gt;
    &lt;/listen-socket&gt;
167 168 169 170 171
    &lt;listen-socket&gt;
        &lt;port&gt;8001&lt;/port&gt;
        &lt;bind-address&gt;127.0.0.1&lt;/bind-address&gt;
        &lt;shoutcast-compat&gt;1&lt;/shoutcast-compat&gt;
    &lt;/listen-socket&gt;
172

173
    &lt;fileserve&gt;1&lt;/fileserve&gt;
174
    &lt;shoutcast-mount&gt;/live.nsv&lt;/shoutcast-mount&gt;
175
</pre>
176
<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 socket will be bound to all interfaces. Generally, you won't need to set bind-address.
177 178
</p>
<h4>port</h4>
j's avatar
j committed
179
<div class="indentedbox">
180 181 182
The TCP port that will be used to accept client connections.
</div>
<h4>bind-address</h4>
j's avatar
j committed
183
<div class="indentedbox">
184
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.
185
</div>
186 187
<h4>shoutcast-compat</h4>
<div class="indentedbox">
giles's avatar
giles committed
188
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.
189
</div>
190
<h4>fileserve</h4>
j's avatar
j committed
191
<div class="indentedbox">
192 193
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>
194 195 196 197 198 199
<h4>shoutcast-mount</h4>
<div class="indentedbox">
An optional mountpoint to use when shoutcast DSP compatible clients connect. The default is /stream but can
be overridden here to use an alternative name which may include an extension that some clients require for
certain formats.
</div>
j's avatar
j committed
200
<p>
j's avatar
j committed
201 202 203
<br />
<br />
<br />
j's avatar
j committed
204
</p>
205 206 207
<a name="relay"></a>
<h2>Relay Settings</h2>
<pre>
208 209 210
    &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;
211
    &lt;master-username&gt;relay&lt;/master-username&gt;
212
    &lt;master-password&gt;hackme&lt;/master-password&gt;
213 214

    &lt;relay&gt;
215 216
        &lt;server&gt;127.0.0.1&lt;/server&gt;
        &lt;port&gt;8001&lt;/port&gt;
217
        &lt;mount&gt;/example.ogg&lt;/mount&gt;
218
        &lt;local-mount&gt;/different.ogg&lt;/local-mount&gt;
219 220
        &lt;username&gt;joe&lt;/username&gt;
        &lt;password&gt;soap&lt;/password&gt;
221 222
        &lt;relay-shoutcast-metadata&gt;0&lt;/relay-shoutcast-metadata&gt;
    &lt;/relay&gt;
223
</pre>
vanguardist's avatar
vanguardist committed
224
<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.   
225
</p>
226
<h3>Master Relay</h3>
227
<p>
vanguardist's avatar
vanguardist committed
228
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.
229
</p>
230 231 232 233 234 235 236 237 238 239 240 241 242 243
<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>
244
<p>
245 246
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>
247

248
<h4>master-server</h4>
j's avatar
j committed
249
<div class="indentedbox">
250 251 252
This is the IP for the server which contains the mountpoints to be relayed (Master Server).  
</div>
<h4>master-server-port</h4>
j's avatar
j committed
253
<div class="indentedbox">
254 255 256
This is the TCP Port for the server which contains the mountpoints to be relayed (Master Server).
</div>
<h4>master-update-interval</h4>
j's avatar
j committed
257
<div class="indentedbox">
vanguardist's avatar
vanguardist committed
258
The interval (in seconds) that the Relay Server will poll the Master Server for any new mountpoints to relay.
259
</div>
260 261 262 263 264 265
<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>
266
<h4>master-password</h4>
j's avatar
j committed
267
<div class="indentedbox">
268 269
This is the relay password on the Master server.  It is used to query the
server for a list of mountpoints to relay.
270
</div>
j's avatar
j committed
271
<br />
272
<h3>Specific Mountpoint Relay</h3>
vanguardist's avatar
vanguardist committed
273
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.
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292

<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.

293 294 295 296
<pre>
    &lt;relay&gt;
        &lt;server&gt;127.0.0.1&lt;/server&gt;
        &lt;port&gt;8001&lt;/port&gt;
297
        &lt;mount&gt;/example.ogg&lt;/mount&gt;
298
        &lt;local-mount&gt;/different.ogg&lt;/local-mount&gt;
299 300
        &lt;username&gt;joe&lt;/username&gt;
        &lt;password&gt;soap&lt;/password&gt;
301 302 303
        &lt;relay-shoutcast-metadata&gt;0&lt;/relay-shoutcast-metadata&gt;
    &lt;/relay&gt;
</pre>
304

305

306
<h4>server</h4>
j's avatar
j committed
307
<div class="indentedbox">
308 309 310
This is the IP for the server which contains the mountpoint to be relayed.
</div>
<h4>port</h4>
j's avatar
j committed
311
<div class="indentedbox">
312 313 314
This is the TCP Port for the server which contains the mountpoint to be relayed.
</div>
<h4>mount</h4>
j's avatar
j committed
315
<div class="indentedbox">
vanguardist's avatar
vanguardist committed
316
The mountpoint located on the remote server.  If you are relaying a shoutcast stream, this must be '/'.
317 318
</div>
<h4>local-mount</h4>
j's avatar
j committed
319
<div class="indentedbox">
320 321
The name to use for the local mountpoint.  This is what the mount will be named on the RELAY SERVER.
</div>
322 323 324 325 326 327 328 329
<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>
330
<h4>relay-shoutcast-metadata</h4>
j's avatar
j committed
331
<div class="indentedbox">
vanguardist's avatar
vanguardist committed
332
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).
333
</div>
j's avatar
j committed
334
<p>
j's avatar
j committed
335 336 337
<br />
<br />
<br />
j's avatar
j committed
338
</p>
339 340 341 342
<a name="mount"></a>
<h2>Mount Specific Settings</h2>
<pre>
    &lt;mount&gt;
343 344 345 346 347
        &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;
348
        &lt;fallback-mount&gt;/example2.ogg&lt;/fallback-mount&gt;
349
        &lt;fallback-override&gt;1&lt;/fallback-override&gt;
350 351 352 353 354 355 356 357
        &lt;public&gt;1&lt;/public&gt;
        &lt;stream-name&gt;My audio stream&lt;/stream-name&gt;
        &lt;stream-description&gt;My audio description&lt;/stream-description&gt;
        &lt;stream-url&gt;http://some.place.com&lt;/stream-url&gt;
        &lt;genre&gt;classical&lt;/genre&gt;
        &lt;bitrate&gt;64&lt;/bitrate&gt;
        &lt;type&gt;application/ogg&lt;/type&gt;
        &lt;subtype&gt;vorbis&lt;/subtype&gt;
358
        &lt;hidden&gt;1&lt;/hidden&gt;
359
        &lt;burst-size&gt;65536&lt;/burst-size&gt;
360
        &lt;mp3-metadata-interval&gt;4096&lt;/mp3-metadata-interval&gt;
361 362
        &lt;authentication type="htpasswd"&gt;
                &lt;option name="filename" value="myauth"/&gt;
363
                &lt;option name="allow_duplicate_users" value="0"/&gt;
364 365
        &lt;/authentication&gt;

366
    &lt;/mount&gt;
367
</pre>
368 369 370 371 372 373 374 375 376 377
<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.
378 379
</p>
<h4>mount-name</h4>
j's avatar
j committed
380
<div class="indentedbox">
381 382 383
The name of the mount point for which these settings apply.
</div>
<h4>username</h4>
j's avatar
j committed
384
<div class="indentedbox">
385 386 387
An optional value which will set the username that a source must use to connect using this mountpoint.
</div>
<h4>password</h4>
j's avatar
j committed
388
<div class="indentedbox">
389 390 391
An optional value which will set the password that a source must use to connect using this mountpoint.
</div>
<h4>max-listeners</h4>
j's avatar
j committed
392
<div class="indentedbox">
393 394 395
An optional value which will set the maximum number of listeners that can be attached to this mountpoint.
</div>
<h4>dump-file</h4>
j's avatar
j committed
396
<div class="indentedbox">
397 398 399
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>
j's avatar
j committed
400
<div class="indentedbox">
Karl Heyes's avatar
Karl Heyes committed
401 402 403 404 405 406 407 408 409
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. 
410
</div>
411
<h4>fallback-override</h4>
j's avatar
j committed
412
<div class="indentedbox">
413 414 415
When enabled, this allows a connecting source client or relay on this mountpoint to move
listening clients back from the fallback mount.
</div>
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
<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 &lt;public&gt;
    </p>
</div>
<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
    mountpoint even if the source client/relay provide one.  The URL is generally for 
    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>
Karl Heyes's avatar
Karl Heyes committed
472
<div class="indentedbox">
473 474 475 476
    <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>
Karl Heyes's avatar
Karl Heyes committed
477
</div>
478
<h4>burst-size</h4>
j's avatar
j committed
479
<div class="indentedbox">
480 481 482
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>
483 484 485 486 487 488 489
<h4>mp3-metadata-interval</h4>
<div class="indentedbox">
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.
</div>
490 491 492 493 494 495
<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>
496
<h4>authentication</h4>
j's avatar
j committed
497
<div class="indentedbox">
498
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>.
499
</div>
j's avatar
j committed
500
<p>
j's avatar
j committed
501 502 503
<br />
<br />
<br />
j's avatar
j committed
504
</p>
505 506 507 508
<a name="path"></a>
<h2>Path Settings</h2>
<pre>
    &lt;paths&gt;
509 510 511 512 513
        &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;
514
        &lt;alias source="/foo" dest="/bar"/&gt;
515
    &lt;/paths&gt;
516 517 518 519
</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>
j's avatar
j committed
520
<div class="indentedbox">
521 522 523
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>
j's avatar
j committed
524
<div class="indentedbox">
525 526
This path specifies the base directory used for logging. Both the error.log and access.log will be created relative to this directory.  
</div>
527
<h4>pidfile</h4>
j's avatar
j committed
528
<div class="indentedbox">
529 530
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>
531
<h4>webroot</h4>
j's avatar
j committed
532
<div class="indentedbox">
533 534 535
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>
j's avatar
j committed
536
<div class="indentedbox">
537 538 539
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>
j's avatar
j committed
540
<div class="indentedbox">
541 542
Aliases are used to provide a way to create multiple mountpoints that refer to the same mountpoint.
</div>
j's avatar
j committed
543
<p>
j's avatar
j committed
544 545 546
<br />
<br />
<br />
j's avatar
j committed
547
</p>
548 549 550 551 552 553
<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;
554
        &lt;playlistlog&gt;playlist.log&lt;/playlistlog&gt;
555 556 557 558 559 560
      	&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.
561
</p>
562
<h4>accesslog</h4>
j's avatar
j committed
563
<div class="indentedbox">
564 565 566
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>
j's avatar
j committed
567
<div class="indentedbox">
568 569
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>
570 571 572 573
<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>
574
<h4>loglevel</h4>
j's avatar
j committed
575 576
<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 :
j's avatar
j committed
577
<ul>
578 579 580 581
<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>
j's avatar
j committed
582
</ul>
583
</div>
j's avatar
j committed
584
<br />
585 586 587 588 589 590 591 592 593 594 595 596 597 598
<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>
j's avatar
j committed
599
<div class="indentedbox">
600 601 602
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>
j's avatar
j committed
603
<div class="indentedbox">
604 605 606 607 608
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>