icecast2_config_file.html 24.1 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 98 99 100 101
        &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;
102 103 104 105
</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
106
<div class="indentedbox">
107 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>
<h4>relay-password</h4>
j's avatar
j committed
110
<div class="indentedbox">
111 112 113 114
Currently not used.
</div>
<h4>admin-user</h4>
<h4>admin-password</h4>
j's avatar
j committed
115
<div class="indentedbox">
116 117
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
118
<p>
j's avatar
j committed
119 120 121
<br />
<br />
<br />
j's avatar
j committed
122
</p>
123 124 125 126
<a name="yp"></a>
<h2>YP Directory Settings</h2>
<pre>
    &lt;directory&gt;
127 128 129
        &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;
130 131 132 133
</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
134
<div class="indentedbox">
135 136 137
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
138
<div class="indentedbox">
139 140
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
141
<p>
j's avatar
j committed
142 143 144
<br />
<br />
<br />
j's avatar
j committed
145
</p>
146 147 148 149 150 151
<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;
152 153
    &lt;-- &lt;port&gt;8000&lt;/port&gt; --&gt;
    &lt;-- &lt;bind-address&gt;127.0.0.1&lt;/bind-address&gt; --&gt;
154

155
    &lt;-- You may have multiple &lt;listen-socket&gt; elements --&gt;
156
    &lt;listen-socket&gt;
157 158 159
        &lt;port&gt;8000&lt;/port&gt;
        &lt;bind-address&gt;127.0.0.1&lt;/bind-address&gt;
    &lt;/listen-socket&gt;
160 161 162 163 164
    &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;
165

166
    &lt;fileserve&gt;1&lt;/fileserve&gt;
167
    &lt;shoutcast-mount&gt;/live.nsv&lt;/shoutcast-mount&gt;
168 169 170 171
</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>
j's avatar
j committed
172
<div class="indentedbox">
173 174 175
The TCP port that will be used to accept client connections.
</div>
<h4>bind-address</h4>
j's avatar
j committed
176
<div class="indentedbox">
177 178
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>
179 180
<h4>shoutcast-compat</h4>
<div class="indentedbox">
giles's avatar
giles committed
181
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.
182
</div>
183
<h4>fileserve</h4>
j's avatar
j committed
184
<div class="indentedbox">
185 186
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>
187 188 189 190 191 192
<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
193
<p>
j's avatar
j committed
194 195 196
<br />
<br />
<br />
j's avatar
j committed
197
</p>
198 199 200
<a name="relay"></a>
<h2>Relay Settings</h2>
<pre>
201 202 203 204
    &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;
205 206

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

240
<h4>master-server</h4>
j's avatar
j committed
241
<div class="indentedbox">
242 243 244
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
245
<div class="indentedbox">
246 247 248
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
249
<div class="indentedbox">
vanguardist's avatar
vanguardist committed
250
The interval (in seconds) that the Relay Server will poll the Master Server for any new mountpoints to relay.
251 252
</div>
<h4>master-password</h4>
j's avatar
j committed
253
<div class="indentedbox">
254 255
This is the admin password on the Master server.  It is used to query the server for a list of mountpoints to relay.
</div>
j's avatar
j committed
256
<br />
257
<h3>Specific Mountpoint Relay</h3>
vanguardist's avatar
vanguardist committed
258
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.
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277

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

278 279 280 281
<pre>
    &lt;relay&gt;
        &lt;server&gt;127.0.0.1&lt;/server&gt;
        &lt;port&gt;8001&lt;/port&gt;
282
        &lt;mount&gt;/example.ogg&lt;/mount&gt;
283
        &lt;local-mount&gt;/different.ogg&lt;/local-mount&gt;
284 285
        &lt;username&gt;joe&lt;/username&gt;
        &lt;password&gt;soap&lt;/password&gt;
286 287 288
        &lt;relay-shoutcast-metadata&gt;0&lt;/relay-shoutcast-metadata&gt;
    &lt;/relay&gt;
</pre>
289

290

291
<h4>server</h4>
j's avatar
j committed
292
<div class="indentedbox">
293 294 295
This is the IP for the server which contains the mountpoint to be relayed.
</div>
<h4>port</h4>
j's avatar
j committed
296
<div class="indentedbox">
297 298 299
This is the TCP Port for the server which contains the mountpoint to be relayed.
</div>
<h4>mount</h4>
j's avatar
j committed
300
<div class="indentedbox">
vanguardist's avatar
vanguardist committed
301
The mountpoint located on the remote server.  If you are relaying a shoutcast stream, this must be '/'.
302 303
</div>
<h4>local-mount</h4>
j's avatar
j committed
304
<div class="indentedbox">
305 306
The name to use for the local mountpoint.  This is what the mount will be named on the RELAY SERVER.
</div>
307 308 309 310 311 312 313 314
<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>
315
<h4>relay-shoutcast-metadata</h4>
j's avatar
j committed
316
<div class="indentedbox">
vanguardist's avatar
vanguardist committed
317
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).
318
</div>
j's avatar
j committed
319
<p>
j's avatar
j committed
320 321 322
<br />
<br />
<br />
j's avatar
j committed
323
</p>
324 325 326 327
<a name="mount"></a>
<h2>Mount Specific Settings</h2>
<pre>
    &lt;mount&gt;
328 329 330 331 332
        &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;
333
        &lt;fallback-mount&gt;/example2.ogg&lt;/fallback-mount&gt;
334
        &lt;fallback-override&gt;1&lt;/fallback-override&gt;
Karl Heyes's avatar
Karl Heyes committed
335
        &lt;no-yp&gt;1&lt;/no-yp&gt;
336
        &lt;hidden&gt;1&lt;/hidden&gt;
337
        &lt;burst-size&gt;65536&lt;/burst-size&gt;
338 339
        &lt;authentication type="htpasswd"&gt;
                &lt;option name="filename" value="myauth"/&gt;
340
                &lt;option name="allow_duplicate_users" value="0"/&gt;
341 342
        &lt;/authentication&gt;

343
    &lt;/mount&gt;
344
</pre>
vanguardist's avatar
vanguardist committed
345
<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.
346 347
</p>
<h4>mount-name</h4>
j's avatar
j committed
348
<div class="indentedbox">
349 350 351
The name of the mount point for which these settings apply.
</div>
<h4>username</h4>
j's avatar
j committed
352
<div class="indentedbox">
353 354 355
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
356
<div class="indentedbox">
357 358 359
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
360
<div class="indentedbox">
361 362 363
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
364
<div class="indentedbox">
365 366 367
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
368
<div class="indentedbox">
Karl Heyes's avatar
Karl Heyes committed
369 370 371 372 373 374 375 376 377
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. 
378
</div>
379
<h4>fallback-override</h4>
j's avatar
j committed
380
<div class="indentedbox">
381 382 383
When enabled, this allows a connecting source client or relay on this mountpoint to move
listening clients back from the fallback mount.
</div>
Karl Heyes's avatar
Karl Heyes committed
384 385 386 387 388 389
<h4>no-yp</h4>
<div class="indentedbox">
Setting this option prevents this mountpoint from advertising on YP.  The default is 0 so YP
advertising occurs however you may want to prevent it here if you intend listeners to connect
to a local relay instead
</div>
390
<h4>burst-size</h4>
j's avatar
j committed
391
<div class="indentedbox">
392 393 394
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>
395 396 397 398 399 400
<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>
401
<h4>authentication</h4>
j's avatar
j committed
402
<div class="indentedbox">
403
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>.
404
</div>
j's avatar
j committed
405
<p>
j's avatar
j committed
406 407 408
<br />
<br />
<br />
j's avatar
j committed
409
</p>
410 411 412 413
<a name="path"></a>
<h2>Path Settings</h2>
<pre>
    &lt;paths&gt;
414 415 416 417 418
        &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;
419
        &lt;alias source="/foo" dest="/bar"/&gt;
420
    &lt;/paths&gt;
421 422 423 424
</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
425
<div class="indentedbox">
426 427 428
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
429
<div class="indentedbox">
430 431
This path specifies the base directory used for logging. Both the error.log and access.log will be created relative to this directory.  
</div>
432
<h4>pidfile</h4>
j's avatar
j committed
433
<div class="indentedbox">
434 435
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>
436
<h4>webroot</h4>
j's avatar
j committed
437
<div class="indentedbox">
438 439 440
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
441
<div class="indentedbox">
442 443 444
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
445
<div class="indentedbox">
446 447
Aliases are used to provide a way to create multiple mountpoints that refer to the same mountpoint.
</div>
j's avatar
j committed
448
<p>
j's avatar
j committed
449 450 451
<br />
<br />
<br />
j's avatar
j committed
452
</p>
453 454 455 456 457 458
<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;
459
        &lt;playlistlog&gt;playlist.log&lt;/playlistlog&gt;
460 461 462 463 464 465
      	&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.
466
</p>
467
<h4>accesslog</h4>
j's avatar
j committed
468
<div class="indentedbox">
469 470 471
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
472
<div class="indentedbox">
473 474
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>
475 476 477 478
<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>
479
<h4>loglevel</h4>
j's avatar
j committed
480 481
<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
482
<ul>
483 484 485 486
<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
487
</ul>
488
</div>
j's avatar
j committed
489
<br />
490 491 492 493 494 495 496 497 498 499 500 501 502 503
<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
504
<div class="indentedbox">
505 506 507
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
508
<div class="indentedbox">
509 510 511 512 513
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>