icecast.xml.in 9.12 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
        <!-- If enabled, this will provide a burst of data when a client
             first connects, thereby significantly reducing the startup
24
             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
    <!-- Uncommenting this enables publishing to the streaming directory at:
Thomas B. Rücker's avatar
Thomas B. Rücker committed
53
	 http://dir.xiph.org/
54 55 56
         Please read the Icecast documentation about publishing to directories
         very carefully, as it is not enough to just uncomment this.
    -->
57
    <!--
58 59 60
    <directory>
        <yp-url-timeout>15</yp-url-timeout>
        <yp-url>http://dir.xiph.org/cgi-bin/yp-cgi</yp-url>
61
    </directory>
62
    -->
Jack Moffitt's avatar
Jack Moffitt committed
63

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

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

88

89
    <!-- Global header settings
90
         Headers defined here will be returned for every HTTP request to Icecast.
91 92 93 94

         The ACAO header makes 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.
95
         If you don't want this, comment out the following line or read up on CORS.
96 97 98 99 100 101 102 103 104 105
    -->
    <http-headers>
        <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.
    -->
106 107 108 109
    <!--<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>-->
110 111 112 113 114 115

    <!-- 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
116 117
    <!--
    <relay>
118
        <server>127.0.0.1</server>
119
        <port>8080</port>
120 121
        <mount>/example.ogg</mount>
        <local-mount>/different.ogg</local-mount>
122
        <on-demand>0</on-demand>
123

124
        <relay-shoutcast-metadata>0</relay-shoutcast-metadata>
Michael Smith's avatar
Michael Smith committed
125 126
    </relay>
    -->
127

128 129 130

    <!-- Mountpoints
         Only define <mount> sections if you want to use advanced options,
131
         like alternative usernames or passwords
132 133
    -->

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

    <!-- Normal mounts -->
151
    <!--
152
    <mount type="normal">
153
        <mount-name>/example-complex.ogg</mount-name>
154

155 156 157 158
        <username>othersource</username>
        <password>hackmemore</password>

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

180
    <!--
181
    <mount type="normal">
182 183 184 185 186 187
        <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"/>
188 189
            <option name="headers"         value="x-pragma,x-token"/>
            <option name="header_prefix"   value="ClientHeader."/>
190 191
        </authentication>
    </mount>
192
    -->
193

194
    <fileserve>1</fileserve>
195

196
    <paths>
197
        <!-- basedir is only used if chroot is enabled -->
198
        <basedir>@pkgdatadir@</basedir>
199 200 201

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

        <!-- 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.
          -->
        <!--
212
        <alias source="/foo" destination="/bar"/>
213
        -->
214 215 216
        <!-- Aliases: can also be used for simple redirections as well,
             this example will redirect all requests for http://server:port/ to
             the status page
217
        -->
218 219
        <alias source="/" destination="/status.xsl"/>
        <!-- The certificate file needs to contain both public and private part.
220
             Both should be PEM encoded.
221
        <ssl-certificate>@pkgdatadir@/icecast.pem</ssl-certificate>
222
        -->
223
    </paths>
Jack Moffitt's avatar
Jack Moffitt committed
224

225 226 227
    <logging>
        <accesslog>access.log</accesslog>
        <errorlog>error.log</errorlog>
228
        <!-- <playlistlog>playlist.log</playlistlog> -->
229 230
        <loglevel>3</loglevel> <!-- 4 Debug, 3 Info, 2 Warn, 1 Error -->
        <logsize>10000</logsize> <!-- Max size of a logfile -->
231 232 233 234 235 236
        <!-- 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> -->
237 238 239 240 241 242 243 244
    </logging>

    <security>
        <chroot>0</chroot>
        <!--
        <changeowner>
            <user>nobody</user>
            <group>nogroup</group>
245
        </changeowner>
246 247
        -->
    </security>
Jack Moffitt's avatar
Jack Moffitt committed
248
</icecast>