[xiph-commits] r18890 - icecast/trunk/icecast/doc

[dm8tbr at svn.xiph.org]

Author: dm8tbr
Date: 2013-03-30 00:09:14 -0700 (Sat, 30 Mar 2013)
New Revision: 18890

Modified:
   icecast/trunk/icecast/doc/icecast2_config_file.html
Log:
Adding "A word of warning" to Icecast config file documentation.


Modified: icecast/trunk/icecast/doc/icecast2_config_file.html
===================================================================
--- icecast/trunk/icecast/doc/icecast2_config_file.html	2013-03-29 16:49:46 UTC (rev 18889)
+++ icecast/trunk/icecast/doc/icecast2_config_file.html	2013-03-30 07:09:14 UTC (rev 18890)
@@ -29,6 +29,20 @@
 <br />
 <br />
 </p>
+<h2>A word of warning</h2>
+<p>
+Please note that, especially for new Icecast users, editing the config file can be quite tricky. <strong>It is thus recommended to start by just changing all passwords, nothing else.</strong> You can then use the source-password to bring up an initial stream and get more comfortable with how Icecast works.
+</p>
+<p>
+Should you need to customize the configuration, then make a backup of your working config file, before you make any changes. If Icecast refuses to start it is in most cases due to a malformed config file. In such a case running the following command should point out most XML syntax problems.
+<pre>xmllint icecast.xml</pre>
+Also check the Icecast error.log for additional hints.
+</p>
+<p>
+<br />
+<br />
+<br />
+</p>
 <a name="limits"></a>
 <h2>Limits</h2>
 <pre>