This section contains server level settings that, in general, do not need to be changed. Only modify this section if you are know what you are doing.

clientsTotal number of concurrent clients supported by the server. Listeners are considered clients, but so is accesses to any static content (i.e. fileserved content) and also any requests to gather stats. These are max *concurrent* connections for the entire server (not per mountpoint). sourcesMaximum number of connected sources supported by the server. threadpoolThis is the number of threads that are started to handle client connections. You may need to increase this value if you are running a high traffic stream. This recommended value is for a small to medium traffic server. queue-sizeThis is the maximum size (in bytes) of a client (listener) queue. A listener may temporarily lag behind due to network congestion and in this case an internal queue is maintained for each listener. If the queue grows larger than this config value, then the listener will be removed from the stream. client-timeoutThis does not seem to be used. header-timeoutThe maximum time (in seconds) to wait for a request to come in once the client has made a connection to the server. In general this value should not need to be tweaked. source-timeoutIf a connected source does not send any data within this timeout period (in seconds), then the source connection will be removed from the server. burst-on-connectWith this enabled, a connecting client will be sent a burst of audio data from the stream. This will have the effect of reducing the startup time for the stream from the perspective of the listener. This is due to the fact that most media players have local buffers that must be filled before the stream begins to play. This may introduce a small latency in the stream (difference in time between when the source plays a clip and the listener hears a clip). If this latency is important to you, then you can disable this feature. The latency is bitrate-dependent, but as an example, for a 128kbps stream, the latency between the source and the player is ~ 1.5 secs WITHOUT burst on connect, and WITH burst on connect the latency is 3 secs. burst-sizeThe burst size is the amount of data (in bytes) to burst to a client at connection time. Like burst-on-connect, this is to quickly fill the pre-buffer used by media players. The default is 64kbytes which is a typical size used by most clients so changing it is not usually required. This setting applies to all mountpoints.

Authenticationhackmerelayhackmeadminhackme

This section contains all the users and passwords used for administration purposes or to connect sources and relays.

source-passwordThe unencrypted password used by sources to connect to icecast2. Currently, the username for all source connections must be 'source'. This is likely to change in the future. relay-userUsed in the master server as part of the authentication when a slave requests the list of streams to relay. The default username is 'relay' relay-passwordUsed in the master server as part of the authentication when a slave requests the list of streams to relay. admin-useradmin-passwordThe 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.

YP Directory Settings15http://dir.xiph.org/cgi-bin/yp-cgi

This section contains all the settings for listing a stream on any of the Icecast2 YP Directory servers. Multiple occurances of this section can be specified in order to be listed on multiple directory servers.

yp-url-timeoutThis value is the maximum time icecast2 will wait for a response from a particular directory server. The recommended value should be sufficient for most directory servers. yp-urlThe URL which icecast2 uses to communicate with the Directory server. The value for this setting is provided by the owner of the Directory server.

Misc Server Settingslocalhost

8000 --> 127.0.0.1 -->

elements -->8000127.0.0.1

8001127.0.0.11

1/live.nsvThis section contains miscellaneous server settings. Note that multiple listen-socket sections may be configured in order to have icecast2 listen on multiple network interfaces. If a bind-address is not specified for a particular listen-socket, then the socket will be bound to all interfaces. Generally, you won't need to set bind-address. There is an internal limit of 20 listening sockets currently, which may be extended in later releases.

portThe TCP port that will be used to accept client connections. bind-addressAn optional IP address that can be used to bind to a specific network card. If not supplied, then it will bind to all interfaces. shoutcast-compatThis optional flag will indicate that this port will operate in 'shoutcast-compatibility' mode. Due to major differences in the source client connection protocol, if you wish to use any of the shoutcast DJ tools, you will need to configure at least one socket as shoutcast-compatible. Note that when in this mode, only source clients (and specifically shoutcast source clients) will be able to attach to this port. All listeners may connect to any of the ports defined without this flag. Also, for proper Shoutcast DSP compatibility, you must define a listen socket with a port one less than the one defined as 'shoutcast-compat'. This means if you define 8001 as shoutcast-compat, then you will need to define a listen port of 8000 and it must not also be defined as shoutcast-compat. See the example config file in the distribution for more info. fileserveThis flag turns on the icecast2 fileserver from which static files can be served. All files are served relative to the path specified in the configuration setting. shoutcast-mountAn optional mountpoint to use when shoutcast DSP compatible clients connect. The default is /stream but can be overridden here to use an alternative name which may include an extension that some clients require for certain formats.

Relay Settings127.0.0.18001120relayhackme0

127.0.0.18001/example.ogg/different.oggjoesoap00

This section contains the server's relay settings. There are two types of relays: a "Master server relay" or a "Specific Mountpoint relay." A Master server relay is only supported between icecast2 servers and is used to relays all mountpoints on a remote icecast2 server.

Master RelayThe following diagram shows the basics of doing a Master relay. Note that Server 1 is configured with the , , etc settings and Server 2 is the server from which Server 1 will pull all attached mountpoints and relay them. Using a Master Server relay, ALL mountpoints on Server 2 will be relayed. If only specific mountpoints need to be relayed, then you must configure Server 1 as a "Specific Mountpoint Relay". Both Master server relays and Specific Mountpoint relays begin their "relaying" when the Server is started.

A server is configured as a Master Server relay by specifying the , ,, values in the config file. The server that is being relayed does not need any special configuration.

master-serverThis is the IP for the server which contains the mountpoints to be relayed (Master Server). master-server-portThis is the TCP Port for the server which contains the mountpoints to be relayed (Master Server). master-update-intervalThe interval (in seconds) that the Relay Server will poll the Master Server for any new mountpoints to relay. master-usernameThis is the relay username on the master server. It is used to query the server for a list of mountpoints to relay. If not specified then 'relay' is used master-passwordThis is the relay password on the Master server. It is used to query the server for a list of mountpoints to relay. relays-on-demandChanges the default on-demand setting for relays, so a stream is only relayed if listeners are connected. 1=enabled, 0=disabled (default).

Specific Mountpoint Relays can be configured to relay from an Icecast 2 server, as well as Icecast 1.x and Shoutcast. A server is configured as a Specific Mountpoint Server relay by specifying a XML chunk in the config file for each mountpoint to be relayed. The server that is being relayed does not need any special configuration. 127.0.0.18001/example.ogg/different.oggjoesoap01

serverThis is the IP for the server which contains the mountpoint to be relayed. portThis is the TCP Port for the server which contains the mountpoint to be relayed. mountThe mountpoint located on the remote server. If you are relaying a shoutcast stream, this must be '/'. local-mountThe name to use for the local mountpoint. This is what the mount will be named on the RELAY SERVER. usernameThe source of the relay may require authentication itself, if so state the username here. passwordThe source of the relay may require authentication itself, if so state the password here. relay-shoutcast-metadataIf 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). on-demandAn on-demand relay will only retrieve the stream if there are listeners connected 1=enabled, 0=disabled (default is ).

This section contains the settings which apply only to a specific mountpoint and applies to an incoming stream whether it is a relay or a source client. The purpose of the mount definition is to state certain information that can override either global/default settings or settings provided from the incoming stream.

A mount does not need to be stated for each incoming source although you may want to specific certain settings like the maximum number of listeners or a mountpoint specific username/password. As a general rule, only define what you need to but each mount definition needs at least the mount-name. Changes to most of these will apply across a configuration file re-read even on active streams, however some only apply when the stream starts or ends.

mount-nameThe name of the mount point for which these settings apply. usernameAn optional value which will set the username that a source must use to connect using this mountpoint. passwordAn optional value which will set the password that a source must use to connect using this mountpoint. max-listenersAn optional value which will set the maximum number of listeners that can be attached to this mountpoint. max-listener-durationAn optional value which will set the length of time a listener will stay connected to the stream. An auth component may override this. dump-fileAn optional value which will set the filename which will be a dump of the stream coming through on this mountpoint. introAn optional value which will specify the file those contents will be sent to new listeners when they connect but before the normal stream is sent. Make sure the format of the file specified matches the streaming format. The specified file is appended to webroot before being opened.

fallback-mountThis optional value specifies a mountpoint that clients are automatically moved to if the source shuts down or is not streaming at the time a listener connects. Only one can be listed in each mount and should refer to another mountpoint on the same server that is streaming in the same streaming format.If clients cannot fallback to another mountpoint, due to a missing fallback-mount or it states a mountpoint that is just not available, then those clients will be disconnected. If clients are falling back to a mountpoint and the fallback-mount is not actively streaming but defines a fallback-mount itself then those clients may be moved there instead. This multi-level fallback allows clients to cascade several mountpoints. A fallback mount can also state a file that is located in webroot. This is useful for playing a pre-recorded file in the case of a stream going down. It will repeat until either the listener disconnects or a stream comes back available and takes the listeners back. As per usual, the file format should match the stream format, failing to do so may cause problems with playback.

Note that the fallback file is not timed so be careful if you intend to relay this. They are fine on slave streams but don't use them on master streams, if you do then the relay will consume stream data at a faster rate and the listeners on the relay would eventually get kicked off.

fallback-overrideWhen enabled, this allows a connecting source client or relay on this mountpoint to move listening clients back from the fallback mount. fallback-when-fullWhen set to 1, this will cause new listeners, when the max listener count for the mountpoint has been reached, to move to the fallback mount if there is one specified.

no-yp (deprecated)Setting this option prevents this mountpoint from advertising on YP. The default is 0 so YP advertising can occur however you may want to prevent it here if you intend listeners to connect to a local relay instead. Deprecated option, replaced by

publicThe default setting for this is -1 indicating that it is up to the source client or relay to determine if this mountpoint should advertise. A setting of 0 will prevent any advertising and a setting of 1 will force it to advertise. If you do force advertising you may need to set other settings listed below as the YP server can refuse to advertise if there is not enough information provided.

stream-nameSetting this will add the specified name to the stats (and therefore YP) for this mountpoint even if the source client/relay provide one.

stream-descriptionSetting this will add the specified description to the stats (and therefore YP) for this mountpoint even if the source client/relay provide one.

stream-urlSetting this will add the specified URL to the stats (and therefore YP) for this mountpoint even if the source client/relay provide one. The URL is generally for directing people to a website.

genreSetting this will add the specified genre to the stats (and therefore YP) for this mountpoint even if the source client/relay provide one. This can be anything be using certain key words can help searches in the YP directories.

bitrateSetting this will add the specified bitrate to the stats (and therefore YP) for this mountpoint even if the source client/relay provide one. This is stated in kbps.

typeSetting this will add the specified mime type to the stats (and therefore YP) for this mountpoint even if the source client/relay provide one. It is very unlikely that this will be needed.

subtypeSetting this will add the specified subtype to the stats (and therefore YP) for this mountpoint. The subtype is really to help the YP server to identify the components of the type. An example setting is vorbis/theora do indicate the codecs in an Ogg stream

burst-sizeThis optional setting allows for providing a burst size which overrides the default burst size as defined in limits. The value is in bytes. mp3-metadata-intervalThis optional setting specifies what interval, in bytes, there is between metadata updates within shoutcast compatible streams. This only applies to new listeners connecting on this mountpoint, not existing listeners falling back to this mountpoint. The default is either the hardcoded server default or the value passed from a relay.

hiddenEnable this to prevent this mount from being shown on the xsl pages. This is mainly for cases where a local relay is configured and you do not want the source of the local relay to be shown authenticationThis specifies that the named mount point will require listener authentication. Currently, we only support a file-based authentication scheme (type=htpasswd). Users and encrypted password are placed in this file (separated by a :) and all requests for this mountpoint will require that a user and password be supplied for authentication purposes. These values are passed in via normal HTTP Basic Authentication means (i.e. http://user:password@stream:port/mountpoint.ogg). Users and Passwords are maintained via the web admin interface. A mountpoint configured with an authenticator will display a red key next to the mount point name on the admin screens. You can read more about listener authentication here. on-connectState a program that is run when the source is started. It is passed a parameter which is the name of the mountpoint that is starting. The processing of the stream does not wait for the script to end. This option is not available on win32

on-disconnectState a program that is run when the source ends. It is passed a parameter which is the name of the mountpoint that has ended. The processing of the stream does not wait for the script to end. This option is not available on win32

Path Settings././logs./icecast.pid./web./admin

This section contains paths which are used for various things within icecast. All paths should not end in a '/'.

basedirThis path is used in conjunction with the chroot settings, and specified the base directory that is chrooted to when the server is started. This feature is not supported on win32. logdirThis path specifies the base directory used for logging. Both the error.log and access.log will be created relative to this directory. pidfileThis pathname specifies the file to write at startup and to remove at normal shutdown. The file contains the process id of the icecast process. This could be read and used for sending signals icecast. webrootThis path specifies the base directory used for all static file requests. This directory can contain all standard file types (including mp3s and ogg vorbis files). For example, if webroot is set to /var/share/icecast2, and a request for http://server:port/mp3/stuff.mp3 comes in, then the file /var/share/icecast2/mp3/stuff.mp3 will be served. adminrootThis path specifies the base directory used for all admin requests. More specifically, this is used to hold the XSLT scripts used for the web-based admin interface. The admin directory contained within the icecast distribution contains these files. alias source="/foo" dest="/bar"Aliases are used to provide a way to create multiple mountpoints that refer to the same mountpoint.

Logging Settingsaccess.logerror.logplaylist.log4

This section contains information relating to logging within icecast. There are two logfiles currently generated by icecast, an error.log (where all log messages are placed) and an access.log (where all stream/admin/http requests are logged).

Note that on non-win32 platforms, a HUP signal can be sent to icecast in which the log files are re-opened for appending giving the ability move/remove the log files.

accesslogInto this file, all requests made to the icecast2 will be logged. This file is relative to the path specified by the config value. errorlogAll icecast generated log messages will be written to this file. If the loglevel is set too high (Debug for instance) then this file can grow fairly large over time. Currently, there is no log-rotation implemented. playlistlogInto this file, a log of all metadata for each mountpoint will be written. The format of the logfile will most likely change over time as we narrow in on a standard format for this. Currently, the file is pipe delimited. This option is optional and can be removed entirely from the config file. logsizeThis value specifies (in Kbytes) the maxmimum size of any of the log files. When the logfile grows beyond this value, icecast will either rename it to logfile.old, or add a timestamp to the archived file (if logarchive is enabled). logarchiveIf this value is set, then icecast will append a timestamp to the end of the logfile name when logsize has been reached. If disabled, then the default behavior is to rename the logfile to logfile.old (overwriting any previously saved logfiles). We disable this by default to prevent the filling up of filesystems for people who don't care (or know) that their logs are growing. loglevelIndicates what messages are logged by icecast. Log messages are categorized into one of 4 types, Debug, Info, Warn, and Error.

This section contains configuration settings that can be used to secure the icecast server by performing a chroot to a secured location. This is currently not supported on win32.

chrootAn indicator which specifies whether a chroot() will be done when the server is started. The chrooted path is specified by the configuration value. changeownerThis 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.

HOWTO: Setup an Oddcast & Icecast on WindowsLicense Copyright(C) 2005 by Daniel Mikusa <> TRZ Communications Service, Inc.Feel free to use / distribute this document however you want, so long as you do not remove the 'License' section of this document. If you decide to make any modifications please alert the original author.This document is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. In simple terms, USE AT YOUR OWN RISK.Goal The goal of this document is to instruct the reader on how to setup a private dedicated streaming solution.RequirementsYou will need the following:– 1 computer running Windows 2000 or XP w/ at least one sound card – 1 high speed Internet connection ( at least 256 kbps upload speed ) – live audio source This tutorial assumes that you have your PC setup running Windows 2000 or XP, that you have properly configured all hardware, and have setup your connection to the Internet.DownloadYour first step is to download the following programs.– OddCast can be downloaded from here http://www.oddsock.org/tools/oddcastv3/( I recommend the stand-alone version)– Icecast can be downloaded from here http://www.icecast.org/download.php( Get the Windows Version )Installation: OddCast We begin the installation process with OddCast. To launch the OddCast installer double click on the OddCast exe file that you downloaded in the previous step. You will be presented with the following screen.Click 'I Agree'

Do not change anything on this screen unless you know what you are doing. Just click 'Next'.Select the location of where OddCast should be installed, and click the 'Install' button.You will see this screen when the installation is complete. Click 'Close'. The installation of OddCast is now complete.Installation: Icecast The only other piece of software that we will need is Icecast. To install it, double click on the Icecast exe file that you downloaded. You will be presented with this screen.Click 'Next'.

Select the 'I accept the agreement', radio button. Then click 'Next'.Select the location of where Icecast should be installed. Then click 'Next'.

Select the location of where the Start Menu shortcuts should be created. Alternatively you can check the 'Don't create a Start Menu folder' box if you do not want these the be created. Then click 'Next'.Click 'Next'.

Click 'Install'.Here you can read the release notes if you are interested. Click 'Next' when you are done.Make sure that 'Install Icecast as a windows service' is checked, and click 'Finish'.The installation of Icecast is now complete.Configuration: Icecast The first thing we must do is configure Icecast. To do this we must start Icecast. On you desktop you should see and icon for Icecast. Double click it, to start Icecast. You should now see this screen.To configure Icecast go to the 'Configuration' menu, and select 'Edit Configuration'.Now a window will pop up containing the configuration file for Icecast. Please clear all of the text out of the window.Now copy and paste in the following text.

2055524288301510165535secret1secret2adminsecret3

localhost8000/mount.ogg311

1././logs./web./admin

access.logerror.log40

Go the 'File' menu, and click 'Save'. Then close the file. You are now back on the main screen. Click the 'Start Server' button. Icecast is now configured and running.Configuration: OddCast Double click the 'OddCast' shortcut that is on your desktop. This will launch OddCast giving you a screen like this.Click the 'Add Encoder' button. You will now see this.To configure the encoder, right click where it says 'Disconnected' and in the pop up menu click 'Configure'.Please set your settings as you see them in this picture. The click 'YP Settings'.

Please set your settings as you see them in this picture. Then click 'OK'.You will now be back on the main screen, where you should see in the middle of the window the text 'Live Recording'. In the pop up menu, below that select the sound card that you are using. In the pop up menu next to that select which input on the sound card you are using. Most sound cards have a line-in ( blue ) and microphone ( pink ). Select the one you have plugged your audio input cable into. The slider bar below the pop up menus can be used to adjust the level of the incoming audio. Adjust this as needed. Everything is now setup. We will now move on the the operation phase.Operation: Icecast There are two ways to run the Icecast server, always or as needed. If you want the Icecast server to always be running, go to the start menu, go to settings, go to control panel. Then go to the 'Administrative Tools' folder and click on 'Services'.Right Click on 'Icecast Media Server', and select 'Start' from the pop up menu.Alternatively if you just want to run the server as you need it, double click the 'Icecast' shortcut on your desktop.Click the 'Start Server' button.Operation: OddCast Operation of OddCast is very simple. Double click the 'OddCast' shortcut on your desktop.Click the 'Connect' button.You should now see that the stream is connected and using roughly 33 Kbps of bandwidth.Administration: Icecast You can now monitor you Icecast server by opening you favorite web browser and going to the following address.– http://localhost:8000/admin/ From there you will be prompted for a login and password. The login is 'admin' and the password is 'secret3'.Here you can see the general stats for you server and you can make sure that you streams are connected ok.Finishing We are now almost done. The last thing that you need to do, before you can listen to a stream is create a user that can access your stream.To create a user to listen to the scream, login to the Admin Menu as mentioned in the previous step. Click the 'List Mount points' link.Click on 'Manage Authentication'.

Now just type in the user name and password. Then click the 'Add New User' button. This will result in the user you've just created being able to access the stream.Listen Everything should now be setup properly, and the audio should be streaming. All you need to do now is to connect to the game and listen.Launch 'Winamp'. It is a free program that can be used to listen to Icecast streams. Go to the file menu, select 'Play URL'. Type in the following URL.– http://localhost:8000/mount.ogg Winamp will then ask you for a user and password type in the username and password that you created in the previous step. Make sure you do it in this format.– username:password ( no space in between, separated by a colon ) Press 'OK' and you should start hearing your stream.Tips– Make sure that you change the passwords that are given in the configuration files. There is no trick to this, just select good passwords and make sure that you replace them consistently with the defaults throughout this document. – There are other things in the configurations that you might like to change, the mount name, the quality of the broadcast, etc. Feel free to change these, just keep things consistent throughout this document and you'll have no problems. – There are some restrictions placed on the Icecast server in our configuration which limit the number of connections, feel free to adjust these to fit your needs. – You may notice that some of the URL's contain the word 'localhost', this is an alias that your computer understands which directs it to connect to itself. For this document to be useful, you will want to change all references to 'localhost' to your IP address or DNS name. – Please be aware that to connect to Icecast from a remote computer, you will need to make sure that there is no firewall running or that it is properly configured to forward Icecast traffic to the correct machine. All Icecast traffic runs on port 8000 by default. You can change the port in the Icecast configuration if you desire. – If you do not want your listeners to have to authenticate, then remove this piece from the configuration file and disregard the instructions which talk about authentication.