From 1b26d3aba5d9004bdf9ea8a4b46f9e30ef37b30e Mon Sep 17 00:00:00 2001
From: Philipp Schafft <phschafft@de.loewenfelsen.net>
Date: Thu, 22 Jun 2023 13:33:55 +0000
Subject: [PATCH] Cleanup: Updated the example configs so they are more in line
 with 2.5.x

---
 conf/icecast.xml.in                  | 38 ++++++++++++----------------
 conf/icecast_minimal.xml.in          |  1 -
 conf/icecast_shoutcast_compat.xml.in |  7 ++---
 conf/icecast_urlauth.xml.in          |  1 -
 4 files changed, 20 insertions(+), 27 deletions(-)

diff --git a/conf/icecast.xml.in b/conf/icecast.xml.in
index 36beb41c..448058e4 100644
--- a/conf/icecast.xml.in
+++ b/conf/icecast.xml.in
@@ -1,16 +1,22 @@
 <?xml version="1.0"?>
 <icecast>
-    <!-- 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). -->
+    <!-- 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>
+    <!-- This is the hostname other people will use to connect to your server.
+         It affects mainly the urls generated by Icecast for playlists and YP
+         listings. You MUST configure it properly for YP listings to work!
+         This is NOT your homepage address, it's the hostname for THIS server.
+    -->
+    <hostname>localhost</hostname>
 
     <!-- IMPORTANT!
          Especially for inexperienced users:
          Start out by ONLY changing all passwords and restarting Icecast.
          For detailed setup instructions please refer to the documentation.
-         It's also available here: http://icecast.org/docs/
+         It's also available here: https://icecast.org/docs/
     -->
 
     <limits>
@@ -20,16 +26,12 @@
         <client-timeout>30</client-timeout>
         <header-timeout>15</header-timeout>
         <source-timeout>10</source-timeout>
-        <!-- 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,
-             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>
-        <!-- 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  -->
+        <!-- This sets the burst size in [bytes]. This is the amount the
+             the server sends to a listener that connects to a stream.
+             This allows for a significantly reducing in startup time.
+             Most people won't need to change from the default 64k.
+             Applies to all mountpoints.
+        -->
         <burst-size>65535</burst-size>
     </limits>
 
@@ -58,12 +60,6 @@
     </directory>
     -->
 
-    <!-- This is the hostname other people will use to connect to your server.
-         It affects mainly the urls generated by Icecast for playlists and yp
-         listings. You MUST configure it properly for YP listings to work!
-    -->
-    <hostname>localhost</hostname>
-
     <!-- You may have multiple <listen-socket> elements -->
     <listen-socket>
         <port>8000</port>
@@ -188,8 +184,6 @@
     </mount>
     -->
 
-    <fileserve>1</fileserve>
-
     <paths>
         <!-- basedir is only used if chroot is enabled -->
         <basedir>@pkgdatadir@</basedir>
diff --git a/conf/icecast_minimal.xml.in b/conf/icecast_minimal.xml.in
index d50fbba5..0981f5eb 100644
--- a/conf/icecast_minimal.xml.in
+++ b/conf/icecast_minimal.xml.in
@@ -22,7 +22,6 @@
     <listen-socket>
         <port>8000</port>
     </listen-socket>
-    <fileserve>1</fileserve>
     <paths>
         <logdir>@localstatedir@/log/@PACKAGE@</logdir>
         <webroot>@pkgdatadir@/web</webroot>
diff --git a/conf/icecast_shoutcast_compat.xml.in b/conf/icecast_shoutcast_compat.xml.in
index 418646de..4df99f51 100644
--- a/conf/icecast_shoutcast_compat.xml.in
+++ b/conf/icecast_shoutcast_compat.xml.in
@@ -21,8 +21,10 @@
         <yp-url>http://dir.xiph.org/cgi-bin/yp-cgi</yp-url>
     </directory>
     <!-- This is the hostname other people will use to connect to your server.
-    It affects mainly the urls generated by Icecast for playlists and yp
-    listings. -->
+         It affects mainly the urls generated by Icecast for playlists and YP
+         listings. You MUST configure it properly for YP listings to work!
+         This is NOT your homepage address, it's the hostname for THIS server.
+    -->
     <hostname>localhost</hostname>
     <!-- You MUST define 2 ports, port and port +1 -->
     <listen-socket>
@@ -32,7 +34,6 @@
         <port>8000</port>
         <shoutcast-mount>/stream</shoutcast-mount>
     </listen-socket>
-    <fileserve>1</fileserve>
     <paths>
         <logdir>@localstatedir@/log/@PACKAGE@</logdir>
         <webroot>@pkgdatadir@/web</webroot>
diff --git a/conf/icecast_urlauth.xml.in b/conf/icecast_urlauth.xml.in
index 7492982a..a389f1bb 100644
--- a/conf/icecast_urlauth.xml.in
+++ b/conf/icecast_urlauth.xml.in
@@ -29,7 +29,6 @@
             <option name="listener_remove" value="http://myauthserver.net/action.php"/>
         </authentication>
     </mount>
-    <fileserve>1</fileserve>
     <paths>
         <basedir>@pkgdatadir@</basedir>
         <logdir>@localstatedir@/log/@PACKAGE@</logdir>