Commit 312e5038 authored by Marvin Scholz's avatar Marvin Scholz

Some changes to make compatible with mkdocs

parent bce1614e
This diff is collapsed.
---
title: Win32 Specifics
version: 2.4.99.1
---
{::options auto_ids="true" /}
<div class="article" markdown="1">
The Win32 port of Icecast 2 is a simple command line application,
it used to be a UI framework around the core Icecast 2 server.
......@@ -17,5 +9,3 @@ __A notable absence is IPv6 support.__
We are planning to reintroduce the capability to start Icecast
as a Windows Service in the 2.5.0 release.
</div>
---
title: YP Directories
version: 2.4.99.1
---
{::options auto_ids="true" /}
<div class="article" markdown="1">
# Overview
A YP directory is a listing of broadcast streams. Icecast has it own YP directory located at
[http://dir.xiph.org](http://dir.xiph.org). Currently Icecast can only be listed in an Icecast-supported YP directory.
......@@ -15,44 +7,42 @@ In the Icecast configuration file are all the currently available YP directory s
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 YP directory.
</div>
<div class="article" markdown="1">
# Configuring Icecast for YP Support
First of all, Icecast must have been built with YP support. This is automatically done if you have libcurl installed.
If libcurl is not detected when icecats is compiled, then YP support is disabled.
If Icecast has been built with YP support, then the following configuration options control the YP directory settings:
{% highlight xml %}
```xml
<directory>
<yp-url-timeout>15</yp-url-timeout>
<yp-url>http://dir.xiph.org/cgi-bin/yp-cgi</yp-url>
</directory>
{% endhighlight %}
```
Multiple directory XML chunks can be specified in order to be listed in multiple directories.
## Further options that play a significant role in YP listings
### `<hostname>`
The hostname option **MUST** be set to a name that resolves to the machine this Icecast server runs on.
hostname
: The hostname option **MUST** be set to a name that resolves to the machine this Icecast server runs on.
### `<listener-socket><port>`
The **first** `listener-socke`+`port` entry is used to build the URL advertized to the YP server.
listener-socket port
: The **first** `listener-socket`+`port` entry is used to build the URL advertized to the YP 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.
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.
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>` contact
If you are listing on a YP, then this field **MUST** contain a valid email address of a technical contact
on your side. YP admins will use this to reach you in case your server is misconfigured and causes problems
for the YP directory. An invalid or unreachable address is likely to get your radio/server/network banned from YP.
admin
: If you are listing on a YP, then this field **MUST** contain a valid email address of a technical contact
on your side. YP admins will use this to reach you in case your server is misconfigured and causes problems
for the YP directory. An invalid or unreachable address is likely to get your radio/server/network banned from YP.
### Verifying the advertized URL
......@@ -60,15 +50,13 @@ After adjusting the settings and configuring your source client, you should veri
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 YP server. Common misconfigurations are:
* `<hostname>` set to `localhost`
* `<hostname>` set to some address that does **NOT** point to the Icecast server
* hostname has AAAA record but Icecast not bound to `::`
* multiple `<listener-socket>` entries, but the first one is not publicly reachable
This is also one of the checks performed by a YP server. Common misconfigurations are:
</div>
* `<hostname>` set to `localhost`
* `<hostname>` set to some address that does **NOT** point to the Icecast server
* hostname has AAAA record but Icecast not bound to `::`
* multiple `<listener-socket>` entries, but the first one is not publicly reachable
<div class="article" markdown="1">
# Configuring Your Source Client for YP Support
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 YP listing of the stream.
......@@ -77,9 +65,6 @@ for further details.
If a mountpoint is being listed on a YP, then you will see some additional statistics relating to the YP such as
`last-touch`, `currently-playing`, etc.
</div>
<div class="article" markdown="1">
# 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
......@@ -91,18 +76,15 @@ Please note that YP directories will check both IPv6 and IPv4 availability of st
for further hints.
Should you still have problems listing on [http://dir.xiph.org](dir.xiph.org), then please:
* set your logging to `4` (debug)
* reload/restart Icecast
* 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](Icecast users mailing list) (else the following step will fail!)
* send a mail to [mailto:icecast@xiph.org](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. The *filtered* error.log prepared previously (as an attachment)
* wait for replies from the mailing list
</div>
* Set your logging to `4` (debug)
* Reload/restart Icecast
* 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](Icecast users mailing list) (else the following step will fail!)
* Send a mail to [mailto:icecast@xiph.org](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. The *filtered* error.log prepared previously (as an attachment)
* Wait for replies from the mailing list
......@@ -10,7 +10,6 @@ pages:
- [relaying.md, Relaying]
- [yp.md, Listing in a YellowPage Directory]
- [admin_interface.md, Admin Interface]
- [advanced_config.md, Advanced Configuration]
- [win32.md, Windows Specific]
markdown_extensions: [def_list, admonition]
\ No newline at end of file
markdown_extensions: [def_list, admonition]
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment