Annotation of elwix/config/etc/default/icecast.xml.sample, revision 1.1.1.1

1.1       misho       1: <icecast>
                      2:     <limits>
                      3:         <clients>100</clients>
                      4:         <sources>2</sources>
                      5:         <threadpool>5</threadpool>
                      6:         <queue-size>524288</queue-size>
                      7:         <client-timeout>30</client-timeout>
                      8:         <header-timeout>15</header-timeout>
                      9:         <source-timeout>10</source-timeout>
                     10:         <!-- If enabled, this will provide a burst of data when a client 
                     11:              first connects, thereby significantly reducing the startup 
                     12:              time for listeners that do substantial buffering. However,
                     13:              it also significantly increases latency between the source
                     14:              client and listening client.  For low-latency setups, you
                     15:              might want to disable this. -->
                     16:         <burst-on-connect>1</burst-on-connect>
                     17:         <!-- same as burst-on-connect, but this allows for being more
                     18:              specific on how much to burst. Most people won't need to
                     19:              change from the default 64k. Applies to all mountpoints  -->
                     20:         <burst-size>65535</burst-size>
                     21:     </limits>
                     22: 
                     23:     <authentication>
                     24:         <!-- Sources log in with username 'source' -->
                     25:         <source-password>hackme</source-password>
                     26:         <!-- Relays log in username 'relay' -->
                     27:         <relay-password>hackme</relay-password>
                     28: 
                     29:         <!-- Admin logs in with the username given below -->
                     30:         <admin-user>admin</admin-user>
                     31:         <admin-password>hackme</admin-password>
                     32:     </authentication>
                     33: 
                     34:     <!-- set the mountpoint for a shoutcast source to use, the default if not
                     35:          specified is /stream but you can change it here if an alternative is
                     36:          wanted or an extension is required
                     37:     <shoutcast-mount>/live.nsv</shoutcast-mount>
                     38:     -->
                     39: 
                     40:     <!-- Uncomment this if you want directory listings -->
                     41:     <!--
                     42:     <directory>
                     43:         <yp-url-timeout>15</yp-url-timeout>
                     44:         <yp-url>http://dir.xiph.org/cgi-bin/yp-cgi</yp-url>
                     45:     </directory>
                     46:      -->
                     47: 
                     48:     <!-- This is the hostname other people will use to connect to your server.
                     49:     It affects mainly the urls generated by Icecast for playlists and yp
                     50:     listings. -->
                     51:     <hostname>localhost</hostname>
                     52: 
                     53:     <!-- You may have multiple <listener> elements -->
                     54:     <listen-socket>
                     55:         <port>8000</port>
                     56:         <!-- <bind-address>127.0.0.1</bind-address> -->
                     57:         <!-- <shoutcast-mount>/stream</shoutcast-mount> -->
                     58:     </listen-socket>
                     59:     <!--
                     60:     <listen-socket>
                     61:         <port>8001</port>
                     62:     </listen-socket>
                     63:     -->
                     64: 
                     65:     <!--<master-server>127.0.0.1</master-server>-->
                     66:     <!--<master-server-port>8001</master-server-port>-->
                     67:     <!--<master-update-interval>120</master-update-interval>-->
                     68:     <!--<master-password>hackme</master-password>-->
                     69: 
                     70:     <!-- setting this makes all relays on-demand unless overridden, this is
                     71:          useful for master relays which do not have <relay> definitions here.
                     72:          The default is 0 -->
                     73:     <!--<relays-on-demand>1</relays-on-demand>-->
                     74: 
                     75:     <!--
                     76:     <relay>
                     77:         <server>127.0.0.1</server>
                     78:         <port>8001</port>
                     79:         <mount>/example.ogg</mount>
                     80:         <local-mount>/different.ogg</local-mount>
                     81:         <on-demand>0</on-demand>
                     82: 
                     83:         <relay-shoutcast-metadata>0</relay-shoutcast-metadata>
                     84:     </relay>
                     85:     -->
                     86: 
                     87:     <!-- Only define a <mount> section if you want to use advanced options,
                     88:          like alternative usernames or passwords
                     89:     <mount>
                     90:         <mount-name>/example-complex.ogg</mount-name>
                     91: 
                     92:         <username>othersource</username>
                     93:         <password>hackmemore</password>
                     94: 
                     95:         <max-listeners>1</max-listeners>
                     96:         <dump-file>/tmp/dump-example1.ogg</dump-file>
                     97:         <burst-size>65536</burst-size>
                     98:         <fallback-mount>/example2.ogg</fallback-mount>
                     99:         <fallback-override>1</fallback-override>
                    100:         <fallback-when-full>1</fallback-when-full>
                    101:         <intro>/example_intro.ogg</intro>
                    102:         <hidden>1</hidden>
                    103:         <no-yp>1</no-yp>
                    104:         <authentication type="htpasswd">
                    105:                 <option name="filename" value="myauth"/>
                    106:                 <option name="allow_duplicate_users" value="0"/>
                    107:         </authentication>
                    108:         <on-connect>/home/icecast/bin/stream-start</on-connect>
                    109:         <on-disconnect>/home/icecast/bin/stream-stop</on-disconnect>
                    110:     </mount>
                    111: 
                    112:     <mount>
                    113:         <mount-name>/auth_example.ogg</mount-name>
                    114:         <authentication type="url">
                    115:             <option name="mount_add"       value="http://myauthserver.net/notify_mount.php"/>
                    116:             <option name="mount_remove"    value="http://myauthserver.net/notify_mount.php"/>
                    117:             <option name="listener_add"    value="http://myauthserver.net/notify_listener.php"/>
                    118:             <option name="listener_remove" value="http://myauthserver.net/notify_listener.php"/>
                    119:         </authentication>
                    120:     </mount>
                    121: 
                    122:     -->
                    123: 
                    124:     <fileserve>1</fileserve>
                    125: 
                    126:     <paths>
                    127:                <!-- basedir is only used if chroot is enabled -->
                    128:         <basedir>/usr/local/share/icecast</basedir>
                    129: 
                    130:         <!-- Note that if <chroot> is turned on below, these paths must both
                    131:              be relative to the new root, not the original root -->
                    132:         <logdir>/usr/local/var/log/icecast</logdir>
                    133:         <webroot>/usr/local/share/icecast/web</webroot>
                    134:         <adminroot>/usr/local/share/icecast/admin</adminroot>
                    135:         <!-- <pidfile>/usr/local/share/icecast/icecast.pid</pidfile> -->
                    136: 
                    137:         <!-- Aliases: treat requests for 'source' path as being for 'dest' path
                    138:              May be made specific to a port or bound address using the "port"
                    139:              and "bind-address" attributes.
                    140:           -->
                    141:         <!--
                    142:         <alias source="/foo" dest="/bar"/>
                    143:           -->
                    144:         <!-- Aliases: can also be used for simple redirections as well,
                    145:              this example will redirect all requests for http://server:port/ to
                    146:              the status page
                    147:           -->
                    148:         <alias source="/" dest="/status.xsl"/>
                    149:     </paths>
                    150: 
                    151:     <logging>
                    152:         <accesslog>access.log</accesslog>
                    153:         <errorlog>error.log</errorlog>
                    154:         <!-- <playlistlog>playlist.log</playlistlog> -->
                    155:        <loglevel>3</loglevel> <!-- 4 Debug, 3 Info, 2 Warn, 1 Error -->
                    156:        <logsize>10000</logsize> <!-- Max size of a logfile -->
                    157:         <!-- If logarchive is enabled (1), then when logsize is reached
                    158:              the logfile will be moved to [error|access|playlist].log.DATESTAMP,
                    159:              otherwise it will be moved to [error|access|playlist].log.old.
                    160:              Default is non-archive mode (i.e. overwrite)
                    161:         -->
                    162:         <!-- <logarchive>1</logarchive> -->
                    163:     </logging>
                    164: 
                    165:     <security>
                    166:         <chroot>0</chroot>
                    167:         <!--
                    168:         <changeowner>
                    169:             <user>nobody</user>
                    170:             <group>nogroup</group>
                    171:         </changeowner>
                    172:         -->
                    173:     </security>
                    174: </icecast>

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>