icecast.xml.in 8.94 KB
Newer Older
Jack Moffitt's avatar
Jack Moffitt committed
1
<icecast>
2
3
4
    <!-- location and admin are two arbitrary strings that are e.g. visible
         on the server info page of the icecast web interface
         (server_version.xsl). -->
5
    <location>Earth</location>
6
7
    <admin>icemaster@localhost</admin>

8
    <!-- IMPORTANT!
9
10
         Especially for inexperienced users:
         Start out by ONLY changing all passwords and restarting Icecast.
11
12
13
14
         For detailed setup instructions please refer to the documentation.
         It's also available here: http://icecast.org/docs/
    -->

15
16
17
    <limits>
        <clients>100</clients>
        <sources>2</sources>
18
        <queue-size>524288</queue-size>
19
20
21
        <client-timeout>30</client-timeout>
        <header-timeout>15</header-timeout>
        <source-timeout>10</source-timeout>
22
23
24
        <!-- If enabled, this will provide a burst of data when a client 
             first connects, thereby significantly reducing the startup 
             time for listeners that do substantial buffering. However,
25
26
27
28
             it also significantly increases latency between the source
             client and listening client.  For low-latency setups, you
             might want to disable this. -->
        <burst-on-connect>1</burst-on-connect>
29
30
31
32
        <!-- same as burst-on-connect, but this allows for being more
             specific on how much to burst. Most people won't need to
             change from the default 64k. Applies to all mountpoints  -->
        <burst-size>65535</burst-size>
33
    </limits>
Jack Moffitt's avatar
Jack Moffitt committed
34

35
36
    <authentication>
        <!-- Sources log in with username 'source' -->
37
        <source-password>hackme</source-password>
38
        <!-- Relays log in with username 'relay' -->
39
        <relay-password>hackme</relay-password>
40
41
42
43
44
45

        <!-- Admin logs in with the username given below -->
        <admin-user>admin</admin-user>
        <admin-password>hackme</admin-password>
    </authentication>

46
47
48
49
50
51
    <!-- set the mountpoint for a shoutcast source to use, the default if not
         specified is /stream but you can change it here if an alternative is
         wanted or an extension is required
    <shoutcast-mount>/live.nsv</shoutcast-mount>
    -->

52
53
    <!-- Uncomment this if you want directory listings -->
    <!--
54
55
56
    <directory>
        <yp-url-timeout>15</yp-url-timeout>
        <yp-url>http://dir.xiph.org/cgi-bin/yp-cgi</yp-url>
57
    </directory>
58
    -->
Jack Moffitt's avatar
Jack Moffitt committed
59

60
    <!-- This is the hostname other people will use to connect to your server.
61
62
63
         It affects mainly the urls generated by Icecast for playlists and yp
         listings. You MUST configure it properly for YP listings to work!
    -->
64
    <hostname>localhost</hostname>
Jack Moffitt's avatar
Jack Moffitt committed
65

66
67
68
69
    <!-- You may have multiple <listener> elements -->
    <listen-socket>
        <port>8000</port>
        <!-- <bind-address>127.0.0.1</bind-address> -->
70
        <!-- <shoutcast-mount>/stream</shoutcast-mount> -->
71
72
73
    </listen-socket>
    <!--
    <listen-socket>
74
        <port>8080</port>
75
76
    </listen-socket>
    -->
77
78
79
80
81
82
83
    <!--
    <listen-socket>
        <port>8443</port>
        <ssl>1</ssl>
    </listen-socket>
    -->

84

85
86
87
88
89
90
91
92
    <!-- Global header settings 
         Headers defined here will be returned for every HTTP request to Icecast.
    -->
    <http-headers>
        <!-- Make Icecast public content/API by default
             This will make streams easier embeddable (some HTML5 functionality needs it).
             Also it allows direct access to e.g. /status-json.xsl from other sites.
             If you don't want this, comment out the following line or read up on CORS.
93
        -->    
94
95
96
97
98
99
100
101
        <header name="Access-Control-Allow-Origin" value="*" />
    </http-headers>


    <!-- Relaying
         You don't need this if you only have one server.
         Please refer to the config for a detailed explanation.
    -->
102
103
104
105
    <!--<master-server>127.0.0.1</master-server>-->
    <!--<master-server-port>8001</master-server-port>-->
    <!--<master-update-interval>120</master-update-interval>-->
    <!--<master-password>hackme</master-password>-->
106
107
108
109
110
111

    <!-- setting this makes all relays on-demand unless overridden, this is
         useful for master relays which do not have <relay> definitions here.
         The default is 0 -->
    <!--<relays-on-demand>1</relays-on-demand>-->

Michael Smith's avatar
Michael Smith committed
112
113
    <!--
    <relay>
114
        <server>127.0.0.1</server>
115
        <port>8080</port>
116
117
        <mount>/example.ogg</mount>
        <local-mount>/different.ogg</local-mount>
118
        <on-demand>0</on-demand>
119

120
        <relay-shoutcast-metadata>0</relay-shoutcast-metadata>
Michael Smith's avatar
Michael Smith committed
121
122
    </relay>
    -->
123

124
125
126

    <!-- Mountpoints
         Only define <mount> sections if you want to use advanced options,
127
         like alternative usernames or passwords
128
129
    -->

130
131
132
133
134
    <!-- Default settings for all mounts that don't have a specific <mount type="normal">.
    -->
    <!-- 
    <mount type="default">
        <public>0</public>
135
        <intro>/server-wide-intro.ogg</intro>
136
        <max-listener-duration>3600</max-listener-duration>
137
        <authentication type="url">
138
                <option name="mount_add" value="http://auth.example.org/stream_start.php"/>
139
        </authentication>
140
141
        <http-headers>
                <header name="foo" value="bar" />
142
        </http-headers>
143
144
145
146
    </mount>
    -->

    <!-- Normal mounts -->
147
    <!--
148
    <mount type="normal">
149
        <mount-name>/example-complex.ogg</mount-name>
150

151
152
153
154
        <username>othersource</username>
        <password>hackmemore</password>

        <max-listeners>1</max-listeners>
155
        <dump-file>/tmp/dump-example1.ogg</dump-file>
156
        <burst-size>65536</burst-size>
157
        <fallback-mount>/example2.ogg</fallback-mount>
Karl Heyes's avatar
Karl Heyes committed
158
        <fallback-override>1</fallback-override>
159
        <fallback-when-full>1</fallback-when-full>
160
        <intro>/example_intro.ogg</intro>
161
        <hidden>1</hidden>
162
        <public>1</public>
163
164
        <authentication type="htpasswd">
                <option name="filename" value="myauth"/>
165
                <option name="allow_duplicate_users" value="0"/>
166
        </authentication>
167
        <http-headers>
168
                <header name="Access-Control-Allow-Origin" value="http://webplayer.example.org" />
169
                <header name="baz" value="quux" />
170
        </http-headers>
171
172
        <on-connect>/home/icecast/bin/stream-start</on-connect>
        <on-disconnect>/home/icecast/bin/stream-stop</on-disconnect>
173
    </mount>
174
    -->
175

176
    <!--
177
    <mount type="normal">
178
179
180
181
182
183
        <mount-name>/auth_example.ogg</mount-name>
        <authentication type="url">
            <option name="mount_add"       value="http://myauthserver.net/notify_mount.php"/>
            <option name="mount_remove"    value="http://myauthserver.net/notify_mount.php"/>
            <option name="listener_add"    value="http://myauthserver.net/notify_listener.php"/>
            <option name="listener_remove" value="http://myauthserver.net/notify_listener.php"/>
184
185
            <option name="headers"         value="x-pragma,x-token"/>
            <option name="header_prefix"   value="ClientHeader."/>
186
187
        </authentication>
    </mount>
188
    -->
189

190
    <fileserve>1</fileserve>
191

192
    <paths>
193
        <!-- basedir is only used if chroot is enabled -->
194
        <basedir>@pkgdatadir@</basedir>
195
196
197

        <!-- Note that if <chroot> is turned on below, these paths must both
             be relative to the new root, not the original root -->
198
        <logdir>@localstatedir@/log/@PACKAGE@</logdir>
199
200
        <webroot>@pkgdatadir@/web</webroot>
        <adminroot>@pkgdatadir@/admin</adminroot>
201
        <!-- <pidfile>@pkgdatadir@/icecast.pid</pidfile> -->
202
203
204
205
206
207

        <!-- Aliases: treat requests for 'source' path as being for 'dest' path
             May be made specific to a port or bound address using the "port"
             and "bind-address" attributes.
          -->
        <!--
208
        <alias source="/foo" destination="/bar"/>
209
        -->
210
211
212
        <!-- Aliases: can also be used for simple redirections as well,
             this example will redirect all requests for http://server:port/ to
             the status page
213
        -->
214
215
        <alias source="/" destination="/status.xsl"/>
        <!-- The certificate file needs to contain both public and private part.
216
             Both should be PEM encoded.
217
        <ssl-certificate>@pkgdatadir@/icecast.pem</ssl-certificate>
218
        -->
219
    </paths>
Jack Moffitt's avatar
Jack Moffitt committed
220

221
222
223
    <logging>
        <accesslog>access.log</accesslog>
        <errorlog>error.log</errorlog>
224
        <!-- <playlistlog>playlist.log</playlistlog> -->
225
226
        <loglevel>3</loglevel> <!-- 4 Debug, 3 Info, 2 Warn, 1 Error -->
        <logsize>10000</logsize> <!-- Max size of a logfile -->
227
228
229
230
231
232
        <!-- If logarchive is enabled (1), then when logsize is reached
             the logfile will be moved to [error|access|playlist].log.DATESTAMP,
             otherwise it will be moved to [error|access|playlist].log.old.
             Default is non-archive mode (i.e. overwrite)
        -->
        <!-- <logarchive>1</logarchive> -->
233
234
235
236
237
238
239
240
    </logging>

    <security>
        <chroot>0</chroot>
        <!--
        <changeowner>
            <user>nobody</user>
            <group>nogroup</group>
241
        </changeowner>
242
243
        -->
    </security>
Jack Moffitt's avatar
Jack Moffitt committed
244
</icecast>