Commit 2c4b31ce authored by Marvin Scholz's avatar Marvin Scholz
Browse files

Use div's instead of new HTML5 tags for the whole website

parent 8fb9ac10
......@@ -2,7 +2,7 @@
title: 3rd Party Applications
permalink: /apps/
---
<article id="source-clients" markdown="1">
<div class="article" id="source-clients" markdown="1">
# Source Clients
These source clients are known to work with Icecast
......@@ -54,9 +54,9 @@ These source clients are known to work with Icecast
[broadcastmyself]: http://novastreamapps.blogspot.fr
[koalasan]: http://koalasan.net
</article>
</div>
<article id="players" markdown="1">
<div class="article" id="players" markdown="1">
# Mediaplayers that support Icecast streams
These media players are known to work with Icecast
......@@ -86,9 +86,9 @@ These media players are known to work with Icecast
[tunein-radio]: http://tunein.com/get-tunein/
[internet-radio-box]: http://www.eingrad.com/products/internet-radio-box/
</article>
</div>
<article id="misc" markdown="1">
<div class="article" id="misc" markdown="1">
# Other Applications/Services
Miscellaneous other _stuff_
......@@ -100,4 +100,4 @@ Miscellaneous other _stuff_
[amptracker]: http://amptracker.com/
</article>
</div>
......@@ -2,7 +2,7 @@
title: Contact
permalink: /contact/
---
<article id="mailing-list" markdown="1">
<div class="article" id="mailing-list" markdown="1">
# Mailing List
The Icecast Mailing Lists (and their archives) are one of the first places to
check for questions that may have been answered in the past.
......@@ -20,9 +20,9 @@ Then simply follow the directions from there.
More details as well as access to the web-accessible archives of the mailing lists can be
found [here](http://lists.xiph.org/mailman/listinfo/icecast) (for the icecast list) and
[here](http://lists.xiph.org/mailman/listinfo/icecast-dev) (for the icecast-dev list).
</article>
</div>
<article id="contact-info" markdown="1">
<div class="article" id="contact-info" markdown="1">
# Contact Information
## IRC
......@@ -41,5 +41,5 @@ or another flaw on icecast.org. For questions, use the mailing list above.
Mail: [{{ site.email }}](mailto:{{ site.email }})
</article>
</div>
......@@ -3,15 +3,15 @@ title: Admin Interface
version: 2.0.1
---
<article markdown="1">
<div class="article" markdown="1">
# Overview
This section contains information about the admin interface of icecast. Through this interface the user can manipulate many server features. From it you can gather statistics, move listeners from mountpoint to mountpoint, disconnect connected sources, disconnect connected listeners, and many other activities. Each function is enumerated here as well as an example usage of the function.
Each of these functions requires HTTP authentication via the appropriate username and password. For mount-specific functions, you may use either the `<admin-username>` and `<admin-password>` specified in the icecast config file, or the username and password specified for that mountpoint (if any). For general functions (not specific to a single mountpoint), you must use the admin username and password. It is also important to note that in all the examples 192.168.1.10 is used as the example host and 8000 is used as the example port for the Icecast server.
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Admin Functions (mount specific)
All these admin functions are mount specific in that they only apply to a particular mountpoint
(as opposed to applying to the entire server). Each of these functions requires a mountpoint to
......@@ -66,9 +66,9 @@ to be disconnected is specified via the variable `mount`.
Example:
`http://192.168.1.10:8000/admin/killsource?mount=/mystream.ogg`
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Admin Functions (general)
## Stats
......@@ -88,9 +88,9 @@ The list mounts function provides the ability to view all the currently connecte
Example:
`http://192.168.1.10:8000/admin/listmounts`
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Web-Based Admin Interface
As an alternative to manually invoking these URLs, a web-based admin interface was developed. This
interface provides the same functions that were identified and described above but presents them in
......@@ -106,4 +106,4 @@ The main URL for the Web-Based Admin Interface is:
From this URL all of the other admin functions can be exercised.
</article>
\ No newline at end of file
</div>
\ No newline at end of file
......@@ -3,15 +3,15 @@ title: Listener Authentication
version: 2.1.0
---
<article markdown="1">
<div class="article" markdown="1">
# Listener Authentication
Listener authentication is a feature of Icecast which allows you to secure a certain mountpoint such that in order to listen,
a listener must pass some verification test. With this feature, a simple pay-for-play operation (eg. user/pass), or some filtering
based on the listener connection can be performed. This section will show you the basics of setting up and maintaining this component.
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# htpasswd Listener Authentication
## Config File Entries
......@@ -73,12 +73,12 @@ username and password.
This page will serve a m3u with the username and password and in most cases should open the correct media player and begin playing your stream.
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# A note about players and authentication
We do not have an exaustive list of players that support listener authentication.
We use standard HTTP basic authentication, and in general, many media players support this if they support anything at all.
Winamp and Foobar2000 support HTTP basic authentication on Windows, and XMMS supports it on UNIX platforms.
</article>
\ No newline at end of file
</div>
\ No newline at end of file
......@@ -3,7 +3,7 @@ title: Basic Setup
version: 2.0.1
---
<article markdown="1">
<div class="article" markdown="1">
# Basic Requirements
This section will describe the essential requirements in setting up a simple Internet radio station. It is by no means a complete list but should give you enough to get started.
......@@ -12,9 +12,9 @@ The Icecast server will be the place where all listeners of your station will co
It is important to note that not all source clients work with Icecast 2. You will need to check to make sure that Icecast 2 is supported by your chosen source client.
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# The Basics
Each Icecast server can house multiple broadcasts (or mountpoints) each containing a separate stream of content. A 'mountpoint' is a unique name on your server identifying a particular stream - it looks like a filename, such as '/stream.ogg'. A listener can only listen to a single mountpoint at a time. This means you can have a single Icecast server contain either multiple broadcasts with different content, or possibly the same broadcast but with streams of different bitrates or qualities. In this case each broadcast or stream is a separate mountpoint.
......@@ -67,5 +67,5 @@ only MP3 stream, it can contain streams of arbitrary content-type and is used by
to listening clients. Alternatively you can open up the stream URL directly within your media player (`http://192.168.1.10:8000/mystream.ogg`
in this case)
</article>
</div>
......@@ -3,7 +3,7 @@ title: Config File
version: 2.0.1
---
<article markdown="1">
<div class="article" markdown="1">
# Overview
This section will describe each section of the config file and is grouped into the following sections:
......@@ -17,9 +17,9 @@ This section will describe each section of the config file and is grouped into t
- [Logging](#log)
- [Security](#security)
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Limits
{:#limits}
......@@ -65,9 +65,9 @@ source-timeout
: If a connected source does not send any data within this timeout period (in seconds),
then the source connection will be removed from the server.
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Authentication
{:#authentication}
......@@ -92,9 +92,9 @@ admin-user/admin-password
: The username/password used for all administration functions. This includes retrieving statistics, accessing the web-based
administration screens, etc. A list of these functions can be found in the "Administration" section of the manual.
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# YP Directory Settings
{:#yp}
......@@ -116,9 +116,9 @@ yp-url
: The URL which Icecast uses to communicate with the Directory server.
The value for this setting is provided by the owner of the Directory server.
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Misc Server Settings
{:#misc}
......@@ -149,9 +149,9 @@ bind-address
fileserve
: This flag turns on the icecast2 fileserver from which static files can be served. All files are served relative to the path specified in the `<paths><webroot>` configuration setting.
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Relay Settings
{:#relay}
......@@ -255,9 +255,9 @@ relay-shoutcast-metadata
: If you are relaying a Shoutcast stream, you need to specify this indicator to also relay the metadata (song titles) that is part of the Shoutcast stream.
`1`: enabled, `0`: disabled
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Mount Specific Settings
{:#mountsettings}
......@@ -293,9 +293,9 @@ dump-file
fallback-mount
: This specifies a mountpoint that is used in the case of a source disconnect. If listeners are connected to the mount specified by the `<mount-name>` config value, then if the source is disconnected; all currently connected clients will be moved to the fallback-mount.
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Path Settings
{:#path}
......@@ -336,9 +336,9 @@ alias
: Aliases are used to provide a way to create multiple mountpoints that refer to the same mountpoint.
For example: `<alias source="/foo" dest="/bar">`
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Logging Settings
{:#log}
......@@ -372,9 +372,9 @@ loglevel
- loglevel = `2`: Warn, Error messages are printed
- loglevel = `1`: Error messages only are printed
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Security Settings
{:#security}
......@@ -399,4 +399,4 @@ changeowner
: This section indicates the user and group that will own the icecast process when it is started.
These need to be valid users on the system.
</article>
\ No newline at end of file
</div>
\ No newline at end of file
......@@ -3,7 +3,7 @@ title: FAQ
version: 2.0.1
---
<article markdown="1">
<div class="article" markdown="1">
# General Questions
## What is Icecast?
......@@ -36,4 +36,4 @@ In addition, the web directory can hold multiple status transforms, if you can't
## What can I use to listen to an Icecast stream?
We maintain a list of Icecast-compatible audio players at [icecast.org](http://www.icecast.org/).
</article>
</div>
......@@ -3,7 +3,7 @@ title: Glossary
version: 2.0.1
---
<article markdown="1">
<div class="article" markdown="1">
Source client
: A source client is an external program which is responsible for sending content data to Icecast.
Some source clients that support Icecast 2 are Oddcast, Ices 2, Ices 0.3 and DarkIce.
......@@ -26,4 +26,4 @@ Fallback mountpoint
: A fallback mountpoint is configured with a parent mountpoint. In the event of the parent mountpoint losing connection with Icecast,
Icecast will then move all clients currently connected to the now defunct mountpoint to it's fallback mountpoint.
</article>
</div>
......@@ -3,7 +3,7 @@ title: Table of Contents
version: 2.0.1
---
<article markdown="1">
<div class="article" markdown="1">
# Pages
- [Introduction](introduction.html)
......@@ -18,9 +18,9 @@ version: 2.0.1
- [Glossary](glossary.html)
- [FAQ](faq.html)
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Icecast {{ page.version }} Readme
Icecast is a streaming media server which currently supports Ogg
Vorbis and MP3 audio streams. It can be used to create an Internet
......@@ -32,9 +32,9 @@ interaction.
Icecast is distributed under the GNU GPL, version 2. A copy of this
license is included with this software in the COPYING file.
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Prerequisites
Icecast requires the following packages:
......@@ -45,9 +45,9 @@ Icecast requires the following packages:
- [ogg/vorbis](http://www.vorbis.com/files) (>= version 1.0 required)
- openssl (optional, enable if SSL support is desired)
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# A Note About RPMS
This section only applies to you if your operating system uses RPMS.
......@@ -58,9 +58,9 @@ normal RPMS for each package.
please check the websites for each of the prerequisite packages for
appropriate download links for RPMS.
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Build/Install
To build icecast on a Unix platform, perform the following:
......@@ -80,4 +80,4 @@ viewing `doc/index.html` in a browser.
Please email us at icecast@xiph.org, or come and see us
at irc.freenode.net, channel #icecast, if you have any troubles.
</article>
</div>
......@@ -3,14 +3,14 @@ title: Introduction
version: 2.0.1
---
<article markdown="1">
<div class="article" markdown="1">
# What is Icecast?
Icecast is a streaming media server which currently supports Ogg Vorbis and MP3 audio streams. It can be used to create an Internet radio station or a privately running jukebox and many things in between. It is very versatile in that new formats can be added relatively easily and supports open standards for commuincation and interaction.
There are two major parts to most streaming media servers: the component providing the content (what we call source clients) and the component which is responsible for serving that content to listeners (this is the function of icecast).
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# What platforms are supported?
Currently the following Unix platforms are supported:
......@@ -25,9 +25,9 @@ Currently the following Windows platforms are supported:
- Windows 2000
- Windows XP
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Where do I go for questions?
There are many ways to contact the icecast development team
......@@ -41,4 +41,4 @@ Alternate Ways:
- team@icecast.org
</article>
</div>
......@@ -3,15 +3,15 @@ title: Relaying
version: 2.0.1
---
<article markdown="1">
<div class="article" markdown="1">
# Overview
Relaying is the process by which one server mirrors one or more streams from a remote server. The servers
need not be of the same type (i.e. Icecast can relay from Shoutcast). Relaying is used primarily for large
broadcasts that need to distribute listening clients across multiple physical machines.
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Type of Relays
There are two types of relays that icecast supports.
The first type is when both master and slave servers are Icecast 2 servers. In this case, a “master-slave” relay
......@@ -24,9 +24,9 @@ The second type of relay is a “single-broadcast” relay. In this case, the sl
server IP, port and mount and only the mountpoint specified is relayed. In order to relay a broadcast stream on
a Shoutcast server, you must use the “single-broadcast” relay and specify a mountpoint of `/`.
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Setting Up a Master-Slave Relay
In order to setup a relay of this type both servers (the one you wish to relay and the one doing the relaying)
need to be Icecast 2 servers. The following configuration snippet is used as an example:
......@@ -46,9 +46,9 @@ and will begin to relay all mountpoints connected to the master server. Addition
and if so, the slave server will relay those as well. Note that the names of the mountpoints on the slave server will
be identical to those on the master server.
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Setting Up a Single-Broadcast Relay
In this case, the master server need not be an Icecast 2 server. Supported master servers for a single-broadcast
relay are Shoutcast, Icecast 1.x, and of course Icecast 2. The following configuration snippet is used as an example:
......@@ -72,4 +72,4 @@ Additionally, if the server is a Shoutcast server, then the `<mount>` must be sp
And if you want the Shoutcast relay stream to have metadata contained within it (Shoutcast metadata is embedded
in the stream itself) then the `<relay-shoutcast-metadata>` needs to be set to `1`.
</article>
</div>
......@@ -3,7 +3,7 @@ title: Server Statistics
version: 2.0.1
---
<article markdown="1">
<div class="article" markdown="1">
# Overview
This section contains information about the server statistics available from Icecast.
An example stats XML tree will be shown and each element will be described. The following
......@@ -72,4 +72,4 @@ public
type
: Media type of the stream.
</article>
</div>
......@@ -3,7 +3,7 @@ title: Win32 Specifics
version: 2.0.1
---
<article markdown="1">
<div class="article" markdown="1">
# Overview
The win32 port of icecast2 is simply a UI framework around the core Icecast 2 server.
The win32 version of Icecast 2 directly uses the main executable of Icecast (statically included)
......@@ -12,9 +12,9 @@ and simply provides a GUI interface to Icecast 2.
Most of the features of Icecast 2 are available in the Win32 port.
__A notable absence is IPv6 support.__
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Server Status Tab
The server status tab contains information regarding statistics that are global to the server. There are two types of statistics in icecast2: source level and global statistics. Global statistics are cumulative stats from all sources offered by the server. Source level statistics are stats which apply only to a single source attached to the server.
......@@ -37,18 +37,18 @@ Any stat that is contained on the Server Status tab can be displayed as the Icec
## Removing source level stats from the Server Status Tab
To remove a source level stat that you have inserted onto the Server Status Tab, simple right click that statistic and select "Delete from Global Stats". The stat will be deleted from the Server Status tab, but will still remain on the source level Stats tab.
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Editing The Icecast Config File
Editing the icecast2 configuration file is a very simple process. For a description of what each field means, see the main icecast documenation. Changes to the icecast2 configuration can only be done while the server is stopped. To edit the current server configuration file, select "Configuration/Edit Configuration" from the main menu.
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Stats Tab
The stats tab contains a view of all the connected mountpoints and the statistics that go along with them. Each connected mountpoint is displayed in the left pane of the window, and all stats for the selected mountpoint are displayed in the right pane of the window.
![Screenshot of Icecast Windows GUI - Server Status Tab](img/stats1.jpg)
</article>
</div>
......@@ -3,7 +3,7 @@ title: YP Directories
version: 2.0.1
---
<article markdown="1">
<div class="article" markdown="1">
# Overview
A YP (Yellow Pages) directory is a listing of broadcast streams. Icecast 2 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.
......@@ -12,9 +12,9 @@ This means that you cannot list your stream in the Shoutcast YP directory.
In the Icecast configuration file are all the currently available YP directory servers. Listing your stream in a YP is
a combination of settings in the Icecast configuration file and also in your source client.
</article>
</div>
<article markdown="1">
<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.
......@@ -29,13 +29,13 @@ If Icecast has been built with YP support, then the following configuration opti
Multiple directory XML chunks can be specified in order to be listed in multiple directories.
</article>
</div>
<article markdown="1">
<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.
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.
</article>
</div>
......@@ -3,15 +3,15 @@ title: Admin Interface
version: 2.0.2
---
<article markdown="1">
<div class="article" markdown="1">
# Overview
This section contains information about the admin interface of icecast. Through this interface the user can manipulate many server features. From it you can gather statistics, move listeners from mountpoint to mountpoint, disconnect connected sources, disconnect connected listeners, and many other activities. Each function is enumerated here as well as an example usage of the function.
Each of these functions requires HTTP authentication via the appropriate username and password. For mount-specific functions, you may use either the `<admin-username>` and `<admin-password>` specified in the icecast config file, or the username and password specified for that mountpoint (if any). For general functions (not specific to a single mountpoint), you must use the admin username and password. It is also important to note that in all the examples 192.168.1.10 is used as the example host and 8000 is used as the example port for the Icecast server.
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Admin Functions (mount specific)
All these admin functions are mount specific in that they only apply to a particular mountpoint
(as opposed to applying to the entire server). Each of these functions requires a mountpoint to
......@@ -66,9 +66,9 @@ to be disconnected is specified via the variable `mount`.
Example:
`http://192.168.1.10:8000/admin/killsource?mount=/mystream.ogg`
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Admin Functions (general)
## Stats
......@@ -88,9 +88,9 @@ The list mounts function provides the ability to view all the currently connecte
Example:
`http://192.168.1.10:8000/admin/listmounts`
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# Web-Based Admin Interface
As an alternative to manually invoking these URLs, a web-based admin interface was developed. This
interface provides the same functions that were identified and described above but presents them in
......@@ -106,4 +106,4 @@ The main URL for the Web-Based Admin Interface is:
From this URL all of the other admin functions can be exercised.
</article>
\ No newline at end of file
</div>
\ No newline at end of file
......@@ -3,15 +3,15 @@ title: Listener Authentication
version: 2.1.0
---
<article markdown="1">
<div class="article" markdown="1">
# Listener Authentication
Listener authentication is a feature of Icecast which allows you to secure a certain mountpoint such that in order to listen,
a listener must pass some verification test. With this feature, a simple pay-for-play operation (eg. user/pass), or some filtering
based on the listener connection can be performed. This section will show you the basics of setting up and maintaining this component.
</article>
</div>
<article markdown="1">
<div class="article" markdown="1">
# htpasswd Listener Authentication
## Config File Entries
......@@ -73,12 +73,12 @@ username and password.
This page will serve a m3u with the username and password and in most cases should open the correct media player and begin playing your stream.
</article>