| 1 |
<!DOCTYPE html> |
| 2 |
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| 3 |
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| 4 |
<head> |
| 5 |
<meta charset="utf-8"> |
| 6 |
<meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| 7 |
<meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| 8 |
|
| 9 |
|
| 10 |
<link rel="shortcut icon" href="../img/favicon.ico"> |
| 11 |
<title>Listing in a YellowPage Directory - Icecast Docs</title> |
| 12 |
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'> |
| 13 |
|
| 14 |
<link rel="stylesheet" href="../css/theme.css" type="text/css" /> |
| 15 |
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" /> |
| 16 |
<link rel="stylesheet" href="../css/highlight.css"> |
| 17 |
|
| 18 |
<script> |
| 19 |
// Current page data |
| 20 |
var mkdocs_page_name = "Listing in a YellowPage Directory"; |
| 21 |
var mkdocs_page_input_path = "yp.md"; |
| 22 |
var mkdocs_page_url = "/yp/"; |
| 23 |
</script> |
| 24 |
|
| 25 |
<script src="../js/jquery-2.1.1.min.js"></script> |
| 26 |
<script src="../js/modernizr-2.8.3.min.js"></script> |
| 27 |
<script type="text/javascript" src="../js/highlight.pack.js"></script> |
| 28 |
|
| 29 |
</head> |
| 30 |
|
| 31 |
<body class="wy-body-for-nav" role="document"> |
| 32 |
|
| 33 |
<div class="wy-grid-for-nav"> |
| 34 |
|
| 35 |
|
| 36 |
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> |
| 37 |
<div class="wy-side-nav-search"> |
| 38 |
<a href=".." class="icon icon-home"> Icecast Docs</a> |
| 39 |
|
| 40 |
</div> |
| 41 |
|
| 42 |
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| 43 |
<ul class="current"> |
| 44 |
|
| 45 |
|
| 46 |
<li class="toctree-l1"> |
| 47 |
|
| 48 |
<a class="" href="..">Introduction</a> |
| 49 |
</li> |
| 50 |
|
| 51 |
<li class="toctree-l1"> |
| 52 |
|
| 53 |
<a class="" href="../basic_setup/">Basic Setup</a> |
| 54 |
</li> |
| 55 |
|
| 56 |
<li class="toctree-l1"> |
| 57 |
|
| 58 |
<a class="" href="../config_file/">Configuration File</a> |
| 59 |
</li> |
| 60 |
|
| 61 |
<li class="toctree-l1"> |
| 62 |
|
| 63 |
<a class="" href="../server_stats/">Server Statistics</a> |
| 64 |
</li> |
| 65 |
|
| 66 |
<li class="toctree-l1"> |
| 67 |
|
| 68 |
<a class="" href="../auth/">Authentication</a> |
| 69 |
</li> |
| 70 |
|
| 71 |
<li class="toctree-l1"> |
| 72 |
|
| 73 |
<a class="" href="../relaying/">Relaying</a> |
| 74 |
</li> |
| 75 |
|
| 76 |
<li class="toctree-l1 current"> |
| 77 |
|
| 78 |
<a class="current" href="./">Listing in a YellowPage Directory</a> |
| 79 |
<ul class="subnav"> |
| 80 |
|
| 81 |
<li class="toctree-l2"><a href="#overview">Overview</a></li> |
| 82 |
|
| 83 |
|
| 84 |
<li class="toctree-l2"><a href="#configuring-icecast-for-directory-support">Configuring Icecast for Directory Support</a></li> |
| 85 |
|
| 86 |
<ul> |
| 87 |
|
| 88 |
<li><a class="toctree-l3" href="#further-options-that-play-a-significant-role-in-directory-listings">Further options that play a significant role in directory listings</a></li> |
| 89 |
|
| 90 |
</ul> |
| 91 |
|
| 92 |
|
| 93 |
<li class="toctree-l2"><a href="#configuring-your-source-client-for-directory-listings">Configuring Your Source Client for Directory Listings</a></li> |
| 94 |
|
| 95 |
|
| 96 |
<li class="toctree-l2"><a href="#troubleshooting">Troubleshooting</a></li> |
| 97 |
|
| 98 |
|
| 99 |
</ul> |
| 100 |
</li> |
| 101 |
|
| 102 |
<li class="toctree-l1"> |
| 103 |
|
| 104 |
<a class="" href="../admin_interface/">Admin Interface</a> |
| 105 |
</li> |
| 106 |
|
| 107 |
<li class="toctree-l1"> |
| 108 |
|
| 109 |
<a class="" href="../win32/">Windows Specific</a> |
| 110 |
</li> |
| 111 |
|
| 112 |
</ul> |
| 113 |
</div> |
| 114 |
|
| 115 |
</nav> |
| 116 |
|
| 117 |
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| 118 |
|
| 119 |
|
| 120 |
<nav class="wy-nav-top" role="navigation" aria-label="top navigation"> |
| 121 |
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| 122 |
<a href="..">Icecast Docs</a> |
| 123 |
</nav> |
| 124 |
|
| 125 |
|
| 126 |
<div class="wy-nav-content"> |
| 127 |
<div class="rst-content"> |
| 128 |
<div role="navigation" aria-label="breadcrumbs navigation"> |
| 129 |
<ul class="wy-breadcrumbs"> |
| 130 |
<li><a href="..">Docs</a> »</li> |
| 131 |
|
| 132 |
|
| 133 |
|
| 134 |
<li>Listing in a YellowPage Directory</li> |
| 135 |
<li class="wy-breadcrumbs-aside"> |
| 136 |
|
| 137 |
</li> |
| 138 |
</ul> |
| 139 |
<hr/> |
| 140 |
</div> |
| 141 |
<div role="main"> |
| 142 |
<div class="section"> |
| 143 |
|
| 144 |
<h1 id="overview">Overview</h1> |
| 145 |
<p>A YP directory is a listing of broadcast streams. The Icecast project has it own directory located at |
| 146 |
<a href="http://dir.xiph.org">http://dir.xiph.org</a>.</p> |
| 147 |
<p>The Icecast configuration file contains entries for all the currently enabled directory servers. Listing your stream in a directory is |
| 148 |
a combination of settings in the Icecast configuration file and also in your source client. It is of great importance |
| 149 |
to configure Icecast correctly, as even one wrong setting can prevent listings to be accepted by a directory.</p> |
| 150 |
<h1 id="configuring-icecast-for-directory-support">Configuring Icecast for Directory Support</h1> |
| 151 |
<p>First of all, Icecast must have been built with directory support. This is automatically done if you have libcurl installed. |
| 152 |
If libcurl is not detected when icecast is compiled, then directory support is disabled and listing attempts will fail. |
| 153 |
If Icecast has been built with directory support, then the following configuration options control the directory settings:</p> |
| 154 |
<pre><code class="xml"><directory> |
| 155 |
<yp-url-timeout>15</yp-url-timeout> |
| 156 |
<yp-url>http://dir.xiph.org/cgi-bin/yp-cgi</yp-url> |
| 157 |
</directory> |
| 158 |
</code></pre> |
| 159 |
|
| 160 |
<p>Multiple directory XML chunks can be specified in order to be listed in multiple directories.</p> |
| 161 |
<p>In the default configuration the directory settings are commented out by being enclosed in <code><!--</code> and <code>--></code>. |
| 162 |
By removing these comment markers and restarting/reloading Icecast the entry becomes active.</p> |
| 163 |
<h2 id="further-options-that-play-a-significant-role-in-directory-listings">Further options that play a significant role in directory listings</h2> |
| 164 |
<dl> |
| 165 |
<dt>hostname</dt> |
| 166 |
<dd>The hostname option <strong>MUST</strong> be set to a name that resolves to the machine this Icecast server runs on |
| 167 |
(IP address is also permissible, but proper domain name is preferred).</dd> |
| 168 |
<dt>listener-socket port</dt> |
| 169 |
<dd>The <strong>first</strong> <code>listener-socket</code>+<code>port</code> entry in the configuration is used to build the URL advertized to the directory server.</dd> |
| 170 |
<dt>listener-socket bind-address</dt> |
| 171 |
<dd>If you don't specify an explicit <code>bind-address</code>, including <code>::</code> and <code>0.0.0.0</code>, then the default |
| 172 |
bind behaviour of your operating system will apply, this may have unexpected consequences for dual-stack |
| 173 |
(IPv6 and IPv4) setups. Icecast may end up only listening on IPv4.</dd> |
| 174 |
</dl> |
| 175 |
<p>If your hostname resolves to both an AAAA and an A record (IPv6 and IPv4), then you <strong>MUST</strong> verify, |
| 176 |
that Icecast listens to both. If in doubt create two listener-socket entries and use <code>::</code> and <code>0.0.0.0</code> |
| 177 |
as the respective <code>bind-address</code>.</p> |
| 178 |
<dl> |
| 179 |
<dt>admin</dt> |
| 180 |
<dd>If you are listing on a directory, then this field <strong>MUST</strong> contain a valid email address of a technical contact |
| 181 |
on your side. Directory admins will use this to reach you in case your server is misconfigured and causes problems |
| 182 |
for listeners and the directory. An invalid or unreachable address is likely to get your radio/server/network banned from the directory.</dd> |
| 183 |
</dl> |
| 184 |
<h3 id="verifying-the-advertized-url">Verifying the advertized URL</h3> |
| 185 |
<p>After adjusting the settings and configuring your source client, you should verify your setup: |
| 186 |
Go to the Icecast web interface, specifically the admin part <code>/admin/</code> and look for the <code>listenurl</code> values |
| 187 |
of your streams. These URLs <strong>MUST</strong> work from the public internet, or your listings will fail.</p> |
| 188 |
<p>This is also one of the checks performed by a directory server. Common misconfigurations are:</p> |
| 189 |
<ul> |
| 190 |
<li><code><hostname></code> set to <code>localhost</code> instead of correct domain name</li> |
| 191 |
<li><code><hostname></code> set to some address that does <strong>NOT</strong> point to the Icecast server, but e.g. a homepage</li> |
| 192 |
<li>hostname has AAAA record but Icecast not bound to IPv6</li> |
| 193 |
<li>multiple <code><listener-socket></code> entries, but the first one is not publicly reachable</li> |
| 194 |
</ul> |
| 195 |
<h1 id="configuring-your-source-client-for-directory-listings">Configuring Your Source Client for Directory Listings</h1> |
| 196 |
<p>This is usually covered in the source client documentation. More specifically, the source client needs to provide |
| 197 |
the HTTP header <code>Ice-Public: 1</code> on connect in order to enable directory listing of the stream. |
| 198 |
This can however be overridden in the server side mount point settings, refer to “<a href="../config-file.html#mountsettings">Icecast Config File</a>” |
| 199 |
for further details.<br /> |
| 200 |
If a mountpoint is being listed on a directory, then you will see some additional statistics relating to the directory such as |
| 201 |
<code>last-touch</code>, <code>currently-playing</code>, etc.</p> |
| 202 |
<h1 id="troubleshooting">Troubleshooting</h1> |
| 203 |
<p>As with all Icecast problems, the error log is the goto place to start. If necessary temporary increase the log level to |
| 204 |
<code>4</code> (debug) and reload the Icecast config. All relevant messages will contain <code>YP</code>. Especially those messages that tell |
| 205 |
you that something <code>failed</code> will contain important hints and or messages from the directory server. If your entry submission |
| 206 |
is directly rejected the server will tell why, if your entry gets delisted after submission, then you will see |
| 207 |
updates/touches fail. Depending on the directory server the stream reachability check will be deferred, so you will see |
| 208 |
a successfull initial submission, but if your stream is found to be unreachable it will be delisted and updates will fail. |
| 209 |
Please note that directories will check both IPv6 and IPv4 availability of streams. See the list of common misconfigurations |
| 210 |
for further hints.</p> |
| 211 |
<p>Should you still have problems listing on <a href="../dir.xiph.org">http://dir.xiph.org</a>, then please:</p> |
| 212 |
<ul> |
| 213 |
<li>Set your logging to <code>4</code> (debug)</li> |
| 214 |
<li>Reload/restart Icecast</li> |
| 215 |
<li>Go through the common misconfigurations</li> |
| 216 |
<li>Make sure your streams are running and marked public (either by source setting or mountpoint override)</li> |
| 217 |
<li>Wait for <strong>one hour</strong></li> |
| 218 |
<li>Filter the error log for messages, from the last hour, that are beginning with <code>yp/</code></li> |
| 219 |
<li>Join the <a href="../Icecast users mailing list">http://lists.xiph.org/mailman/listinfo/icecast</a> (else the following step will fail!)</li> |
| 220 |
<li>Send a mail to <a href="../[email protected]">mailto:[email protected]</a> containing:<ol> |
| 221 |
<li>The public URL of your Icecast server - e.g. <code>http://icecast.example.org:8000/</code> (Even if you have removed the status pages! This does <strong>NOT</strong> mean your homepage.)</li> |
| 222 |
<li>The <code><hostname></code>, <code><listen-socket></code> and <code><directory></code> sections of your <code>icecast.xml</code></li> |
| 223 |
<li>Your Icecast version and operating system / distribution</li> |
| 224 |
<li>The <em>filtered</em> error.log prepared previously (as an attachment)</li> |
| 225 |
</ol> |
| 226 |
</li> |
| 227 |
<li>Wait for replies from the mailing list</li> |
| 228 |
</ul> |
| 229 |
|
| 230 |
</div> |
| 231 |
</div> |
| 232 |
<footer> |
| 233 |
|
| 234 |
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| 235 |
|
| 236 |
<a href="../admin_interface/" class="btn btn-neutral float-right" title="Admin Interface">Next <span class="icon icon-circle-arrow-right"></span></a> |
| 237 |
|
| 238 |
|
| 239 |
<a href="../relaying/" class="btn btn-neutral" title="Relaying"><span class="icon icon-circle-arrow-left"></span> Previous</a> |
| 240 |
|
| 241 |
</div> |
| 242 |
|
| 243 |
|
| 244 |
<hr/> |
| 245 |
|
| 246 |
<div role="contentinfo"> |
| 247 |
<!-- Copyright etc --> |
| 248 |
|
| 249 |
</div> |
| 250 |
|
| 251 |
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| 252 |
</footer> |
| 253 |
|
| 254 |
</div> |
| 255 |
</div> |
| 256 |
|
| 257 |
</section> |
| 258 |
|
| 259 |
</div> |
| 260 |
|
| 261 |
<div class="rst-versions" role="note" style="cursor: pointer"> |
| 262 |
<span class="rst-current-version" data-toggle="rst-current-version"> |
| 263 |
|
| 264 |
|
| 265 |
<span><a href="../relaying/" style="color: #fcfcfc;">« Previous</a></span> |
| 266 |
|
| 267 |
|
| 268 |
<span style="margin-left: 15px"><a href="../admin_interface/" style="color: #fcfcfc">Next »</a></span> |
| 269 |
|
| 270 |
</span> |
| 271 |
</div> |
| 272 |
<script>var base_url = '..';</script> |
| 273 |
<script src="../js/theme.js"></script> |
| 274 |
|
| 275 |
</body> |
| 276 |
</html> |