icecast.xml.in 9.37 KB
Newer Older
Jack Moffitt's avatar
Jack Moffitt committed
1
<icecast>
2
    <!-- IMPORTANT!
3 4
         Especially for inexperienced users:
         Start out by ONLY changing all passwords and restarting Icecast.
5 6 7 8
         For detailed setup instructions please refer to the documentation.
         It's also available here: http://icecast.org/docs/
    -->

9 10 11 12 13 14
    <!-- location and admin are two strings that are e.g. visible
	 on the server info page of the icecast web interface -->
    <location>Earth</location>
    <!-- If you are listing streams on a YP, this MUST be a working email! -->
    <admin>icemaster@localhost</admin>

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
         It affects mainly the urls generated by Icecast for playlists and YP
66
         listings. You MUST configure it properly for YP listings to work!
67
         This is NOT your homepage address, it's the hostname for THIS server.
68
    -->
69
    <hostname>localhost</hostname>
Jack Moffitt's avatar
Jack Moffitt committed
70

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

89

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

         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.
96
         If you don't want this, comment out the following line or read up on CORS.
97 98 99 100 101 102 103 104
    -->
    <http-headers>
        <header name="Access-Control-Allow-Origin" value="*" />
    </http-headers>


    <!-- Relaying
         You don't need this if you only have one server.
105
         Please refer to the documentation for a detailed explanation.
106
    -->
107 108 109 110
    <!--<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>-->
111

112
    <!-- Setting this makes all relays on-demand unless overridden, this is
113 114 115 116
         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
117 118
    <!--
    <relay>
119
        <server>127.0.0.1</server>
120
        <port>8080</port>
121 122
        <mount>/example.ogg</mount>
        <local-mount>/different.ogg</local-mount>
123
        <on-demand>0</on-demand>
124

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

129 130 131

    <!-- Mountpoints
         Only define <mount> sections if you want to use advanced options,
132 133 134
	 like alternative usernames or passwords
         All <mount> sections below are disabled by default,
         to activate them remove the comment markers around them and restart.
135 136
    -->

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

    <!-- Normal mounts -->
154
    <!--
155
    <mount type="normal">
156
        <mount-name>/example-complex.ogg</mount-name>
157

158 159 160 161
        <username>othersource</username>
        <password>hackmemore</password>

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

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

197
    <fileserve>1</fileserve>
198

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

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

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

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

    <security>
        <chroot>0</chroot>
        <!--
        <changeowner>
            <user>nobody</user>
            <group>nogroup</group>
248
        </changeowner>
249 250
        -->
    </security>
Jack Moffitt's avatar
Jack Moffitt committed
251
</icecast>