XiphWiki - User contributions [en]

Icecast Server/Getting Started

2014-11-27T20:22:09Z

ToddShepard: First finished version, smaller fixes, removing Draft template, adding Icecast category

This article describes how to get an [[Icecast]] server up and running. On this resulting server you can connect with a Source Client, like [[IceS]], and stream music or video to listener clients. To get started with using Icecast you should first understand how everything works together.

== How it works ==

[[File:Flowchart icecast.png|800px|center|Graphic showing the flow from source clients through Icecast to listeners]]

The graphic above shows how Icecast basically works.

A source client, for example IceS, connects to the server on a specified mountpoint. A mountpoint could be described as a file on a normal local file system.<br />
The listener accesses the mountpoint – the "file" – and can listen to the content – the stream. The server now offers the stream it gets form the source client on that specified mountpoint.
Now listeners can connect to this mountpoint like they would to a normal file on a remote server.

Icecast sends the data it receives from the source client to the listeners, to everyone the same bitstream in realtime.<br />
It is not possible to use Icecast with static files (like ogg or mp3 files), Icecast always needs an source client which sends the bitstream!

== Getting Icecast ==

Before you can actually start to set up the server, you have to download the source code (or alternatively a binary package on Windows). This "Getting Started" is written for the server version '''2.4.1''', but should work with at least every 2.4.x version.

You can get the latest releases on [http://icecast.org/download/ icecast.org]

Windows users should download the binary package, while others can download the source. There may be compiled versions on Homebrew (Mac OS) or apt-get (Debian, Ubuntu, …), but these could be outdated, so I will explain how to compile form source in the next step.

Windows users who downloaded the binary package – and extracted it to some location – can skip the next step and continue with "The configuration".

== Compiling ==

After downloading the source package you like, you have to extract it. After that you will have to use your console and change directory (cd) to your extracted files.

<pre>
$ cd /path/to/icecast-source
</pre>

After doing that you have to run the configuration tool, then compile and install it. You may have to install additional dependencies first, when done, run the following commands.

<pre>
$ ./configure
$ make
$ make install
</pre>

== The configuration ==

After installing Icecast, you are just one step away from using it! You have to configure it. Icecast is shipped with a default configuration. The default configuration can be found
* on Linux here: <pre>/etc/icecast.xml</pre> or <pre>/etc/icecast2/icecast.xml</pre>
* on Mac OS here: <pre>/etc/icecast.xml</pre> or <pre>/usr/local/etc/icecast.xml</pre>
* on Windows here: <pre>/path/to/extracted/icecast/etc/icecast.xml</pre>

You can now edit this file and save it to a location where you like it, or just leave it there, however you will need the full path to start the server, so you should remember it. To set up the server you should edit some fields in this xml file, like setting the right passwords, and hostname.

It is never wrong to set up these values, especially if you plan running a public server.

<pre>
<location>The server's location</location>
<admin>admin@yourdomain.tld</admin>
</pre>

You always should change the passwords from ''hackme'' to something more secure.

<pre>
<authentication>

<source-password>myfancypassword</source-password>

<relay-password>youshallnotpass</relay-password>


<admin-user>admin</admin-user>
<admin-password>anotherfancypassword</admin-password>
</authentication>
</pre>

If you plan to run a public server and/or a server with [[Yellow Pages]] listing, you should change the hostname to one where your server can be accessed from.

<pre>

<hostname>streams.yourdomain.tld</hostname>
</pre>

Setting up more advanced things like relays, Yellow Pages listing and various other things will be explained in following in-depth parts of this Getting started.

== Starting the server ==

To start your first server, type

<pre>
$ icecast -c /path/to/icecast.xml
</pre>

into your console. If you did everything correctly Icecast should start and listen for connections on the default port. You can access it by typing http://127.0.0.1:8000/ into your web browser. If you see a page which says '''Icecast2 Status''' on top, you have done everything right and finished the basic part of this Getting started!

== What next? ==

If you want in-depth infos, you should look at the following articles.

* If you want to start streaming, have a look at [[IceS/Getting Started]]
* If you want to go deeper into configuring your server, have a look at [[Icecast/Advanced Configuration]]

[[Category:Icecast]]

Icecast Server/Getting Started

2014-11-27T20:08:55Z

ToddShepard: Finished article for review.

{{Draft}}

This article describes how to get an [[Icecast]] server up and running. On this resulting server you can connect with a Source Client, like [[IceS]], and stream music or video to listener clients. To get started with using Icecast you should first understand how everything works together.

== How it works ==

[[File:Flowchart icecast.png|800px|center|Graphic showing the flow from source clients through Icecast to listeners]]

The graphic above shows how Icecast basically works.

A source client, for example IceS, connects to the server on a specified mountpoint. A mountpoint could be described as a file on a normal local file system.<br />
The listener accesses the mountpoint – the "file" – and can listen to the content – the stream. The server now offers the stream it gets form the source client on that specified mountpoint.
Now listeners can connect to this mountpoint like they would to a normal file on a remote server.

Icecast sends the data it receives from the source client to the listeners, to everyone the same bitstream in realtime.<br />
It is not possible to use Icecast with static files (like ogg or mp3 files), Icecast always needs an source client which sends the bitstream!

== Getting Icecast ==

Before you can actually start to set up the server, you have to download the source code (or alternatively a binary package on Windows). This "Getting Started" is written for the server version '''2.4.1''', but should work with at least every 2.4.x version.

You can get the latest releases on [http://downloads.xiph.org/releases/icecast/ downloads.xiph.org]

Windows users should download the binary package, while others can download the source. There may be compiled versions on Homebrew (Mac OS) or apt-get (Debian, Ubuntu, …), but these could be outdated, so I will explain how to compile form source in the next step.

Windows users who downloaded the binary package – and extracted it to some location – can skip the next step and continue with "The configuration".

== Compiling ==

After downloading the source package you like, you have to extract it. After that you will have to use your console and change directory (cd) to your extracted files.

<pre>
$ cd /path/to/icecast-source
</pre>

After doing that you have to run the configuration tool, then compile and install it. You may have to install additional dependencies first, when done, run the following commands.

<pre>
$ ./configure
$ make
$ make install
</pre>

== The configuration ==

After installing Icecast, you are just one step away from using it! You have to configure it. Icecast is shipped with a default configuration. The default configuration can be found
* on Linux here: <pre>/etc/icecast.xml</pre> or <pre>/etc/icecast2/icecast.xml</pre>
* on Mac OS here: <pre>/etc/icecast.xml</pre> or <pre>/usr/local/etc/icecast.xml</pre>
* on Windows here: <pre>/path/to/extracted/icecast/etc/icecast.xml</pre>

You can now edit this file and save it to a location where you like it, or just leave it there, however you will need the full path to start the server, so you should remember it. To set up the server you should edit some fields in this xml file, like setting the right passwords, and hostname.

It is never wrong to set up these values, especially if you plan running a public server.

<pre>
<location>The server's location</location>
<admin>admin@yourdomain.tld</admin>
</pre>

You always should change the passwords from ''hackme'' to something more secure.

<pre>
<authentication>

<source-password>myfancypassword</source-password>

<relay-password>youshallnotpass</relay-password>


<admin-user>admin</admin-user>
<admin-password>anotherfancypassword</admin-password>
</authentication>
</pre>

If you plan to run a public server and/or a server with [[Yellow Pages]] listing, you should change the hostname to the hostname/IP where your server can be accessed from.

<pre>

<hostname>streams.yourdomain.tld</hostname>
</pre>

Setting up more advanced things like relays, Yellow Pages listing and various other things will be explained in following in-depth parts of this Getting started.

== Starting your first server ==

To start your first server, type

<pre>
$ icecast -c /path/to/icecast.xml
</pre>

into your console. If you did everything correctly Icecast should start and listen for connections on the default port. You can access it by typing http://127.0.0.1:8000/ into your web browser. If you see a page which says '''Icecast2 Status''' on top, you have done everything right and finished the basic part of this Getting started!

== What next? ==

If you if you want in-depth infos, you should look at the following articles.

* If you want to start streaming, have a look at [[IceS/Getting Started]]
* If you want to go deeper into configuring your server, have a look at [[Icecast/Advanced Configuration]]

Icecast Server/Getting Started

2014-11-26T21:21:46Z

ToddShepard: Still work in progress, started working on How it works

File:Flowchart icecast.png

2014-11-26T20:53:48Z

ToddShepard: This graphic shows how the audio/video stream passes from the source client over the Icecast server to the listeners.

This graphic shows how the audio/video stream passes from the source client over the [[Icecast]] server to the listeners.

Icecast Server

2014-11-24T21:05:05Z

ToddShepard: Hide table of contents

'''Icecast''' is an open source multi-platform streaming server. It supports [[Ogg]] [[Vorbis]], Ogg [[Theora]], [[Opus]], WebM and MP3.

== External links ==

* [http://www.icecast.org/ Icecast homepage]
* [http://dir.xiph.org/index.php Stream directory]
* [http://www.nabble.com/Icecast-f2880.html Icecast archive] - an Icecast mailing list archive that combines both user and dev lists. It is hosted by [http://www.nabble.com/ Nabble]. You can search or browse Icecast discussions here.

== Development ==

*trunk http://svn.xiph.org/icecast/trunk/icecast
*kh-branch https://github.com/karlheyes/icecast-kh

== Wish List ==

As good ideas are never a waste, and for tracking purposes, please list all the features you're missing in icecast trunk as separate tickets on https://trac.xiph.org/newticket

Note: please check that the feature you request is not already in trunk before posting !

== Icecast articles ==

{{Special:PrefixIndex/Icecast/}}

[[Category:Xiph-related Software]]
__NOTOC__

Icecast Server

2014-11-24T20:51:10Z

ToddShepard: Added list of Icecast articles to this main article

Icecast:ReleaseCheckList

2014-11-24T20:41:58Z

ToddShepard: moved Icecast:ReleaseCheckList to Icecast/ReleaseCheckList: Fixing namespace

#REDIRECT [[Icecast/ReleaseCheckList]]

Icecast Server/Release Checklist

2014-11-24T20:41:58Z

ToddShepard: moved Icecast:ReleaseCheckList to Icecast/ReleaseCheckList: Fixing namespace

* Update documentation
* Check version in configure.in
* Ensure everything is committed
* Test on all Release critical systems
* Test on all other systems you have access to
* Update README, NEWS, HACKING and TODO
* Update and set release date in ChangeLog
* Ensure everything is committed including last changes to ChangeLog.
* Tag the release in VCS
* make distcheck
* commit resulting tarball to releases directory for replication
* update download page
* update news page
* add "Version" and close "Milestone" in trac
* post on IRC (+topic)
* post on icecast and icecast-dev
* create downstream bugs to facilitate adoption

== packaging specific ==
* update debian packaging
** copy and rename release tar-ball
** unpack debian.tar
** add release to 'changelog'
** tar up with right name
** verify version and checksums are correct in .dsc
* update RPM packaging
** change version in .spec
** change tarball name in .spec
** change debian tarball name in .spec
** update icecast-fix-no-add-needed.patch to apply cleanly
* windows
** TBD
* OBS
** osc delete all old files (tarballs)
** osc add new files (tarballs)
** (build locally -- feeling lucky, punk?)
** osc commit
** verify builds on dashboard and in repos