Listing in a YellowPage Directory - Icecast Docs

# Overview

A YP directory is a listing of broadcast streams. The Icecast project has it own directory located at http://dir.xiph.org.

The Icecast configuration file contains entries for all the currently enabled directory servers. Listing your stream in a directory is a combination of settings in the Icecast configuration file and also in your source client. It is of great importance to configure Icecast correctly, as even one wrong setting can prevent listings to be accepted by a directory.

# Configuring Icecast for Directory Support

First of all, Icecast must have been built with directory support. This is automatically done if you have libcurl installed. If libcurl is not detected when icecast is compiled, then directory support is disabled and listing attempts will fail. If Icecast has been built with directory support, then the following configuration options control the directory settings:

    <directory>
        <yp-url-timeout>15</yp-url-timeout>
        <yp-url>http://dir.xiph.org/cgi-bin/yp-cgi</yp-url>
    </directory>

Multiple directory XML chunks can be specified in order to be listed in multiple directories.

In the default configuration the directory settings are commented out by being enclosed in `<!--` and `-->`. By removing these comment markers and restarting/reloading Icecast the entry becomes active.

## Further options that play a significant role in directory listings

hostname
  The hostname option MUST be set to a name that resolves to the machine this Icecast server runs on (IP address is also permissible, but proper domain name is preferred).
listener-socket port
  The first `listener-socket`+`port` entry in the configuration is used to build the URL advertized to the directory server.
listener-socket bind-address
  If you don't specify an explicit `bind-address`, including `::` and `0.0.0.0`, then the default bind behaviour of your operating system will apply, this may have unexpected consequences for dual-stack (IPv6 and IPv4) setups. Icecast may end up only listening on IPv4.

If your hostname resolves to both an AAAA and an A record (IPv6 and IPv4), then you MUST verify, that Icecast listens to both. If in doubt create two listener-socket entries and use `::` and `0.0.0.0` as the respective `bind-address`.

admin
  If you are listing on a directory, then this field MUST contain a valid email address of a technical contact on your side. Directory admins will use this to reach you in case your server is misconfigured and causes problems for listeners and the directory. An invalid or unreachable address is likely to get your radio/server/network banned from the directory.

### Verifying the advertized URL

After adjusting the settings and configuring your source client, you should verify your setup: Go to the Icecast web interface, specifically the admin part `/admin/` and look for the `listenurl` values of your streams. These URLs MUST work from the public internet, or your listings will fail.

This is also one of the checks performed by a directory server. Common misconfigurations are:

- `<hostname>` set to `localhost` instead of correct domain name
- `<hostname>` set to some address that does NOT point to the Icecast server, but e.g. a homepage
- hostname has AAAA record but Icecast not bound to IPv6
- multiple `<listener-socket>` entries, but the first one is not publicly reachable

# Configuring Your Source Client for Directory Listings

This is usually covered in the source client documentation. More specifically, the source client needs to provide the HTTP header `Ice-Public: 1` on connect in order to enable directory listing of the stream. This can however be overridden in the server side mount point settings, refer to “Icecast Config File” for further details.
If a mountpoint is being listed on a directory, then you will see some additional statistics relating to the directory such as `last-touch`, `currently-playing`, etc.

# Troubleshooting

As with all Icecast problems, the error log is the goto place to start. If necessary temporary increase the log level to `4` (debug) and reload the Icecast config. All relevant messages will contain `YP`. Especially those messages that tell you that something `failed` will contain important hints and or messages from the directory server. If your entry submission is directly rejected the server will tell why, if your entry gets delisted after submission, then you will see updates/touches fail. Depending on the directory server the stream reachability check will be deferred, so you will see a successfull initial submission, but if your stream is found to be unreachable it will be delisted and updates will fail. Please note that directories will check both IPv6 and IPv4 availability of streams. See the list of common misconfigurations for further hints.

Should you still have problems listing on http://dir.xiph.org, then please:

- Set your logging to `4` (debug)
- Reload/restart Icecast
- Go through the common misconfigurations
- Make sure your streams are running and marked public (either by source setting or mountpoint override)
- Wait for one hour
- Filter the error log for messages, from the last hour, that are beginning with `yp/`
- Join the http://lists.xiph.org/mailman/listinfo/icecast (else the following step will fail!)
- Send a mail to mailto:icecast@xiph.org containing:
  1. The public URL of your Icecast server - e.g. `http://icecast.example.org:8000/` (Even if you have removed the status pages! This does NOT mean your homepage.)
  2. The `<hostname>`, `<listen-socket>` and `<directory>` sections of your `icecast.xml`
  3. Your Icecast version and operating system / distribution
  4. The filtered error.log prepared previously (as an attachment)
- Wait for replies from the mailing list

« Previous Next »