icecast2_relay.html 4.32 KB
Newer Older
j's avatar
j committed
1 2 3 4 5 6 7 8 9
<?xml version="1.0"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Icecast v2.0 Documentation</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
<div class="boxtest">
10
<h1>Icecast 2 Relaying</h1>
j's avatar
j committed
11
<hr id='titlebar' />
j's avatar
j committed
12 13 14
<br />
<br />
<br />
15 16
<h2>Overview</h2>
<p>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.</p>
j's avatar
j committed
17 18
<br />
<br />
19
<h2>Type of Relays</h2>
vanguardist's avatar
vanguardist committed
20
<p>There are two types of relays that icecast supports.  The first type is when both master and slave servers are icecast2 servers.  In this case, a "master-slave" relay can be setup such that all that needs to be done is configure the slave server with the connection information (serverip:port) of the master server and the slave will mirror all mountpoints on the master server.  The slave will also periodically check the master server to see if any new mountpoints have attached and if so will relay those as well.  The second type of relay is a "single-broadcast" relay.  In this case, the slave server is configured with a serverip+port+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 "/".</p>
j's avatar
j committed
21 22 23
<br />
<br />
<br />
24
<h2>Setting Up A Master-Slave Relay</h2>
vanguardist's avatar
vanguardist committed
25
<p>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 icecast2 servers. The following configuration snippet is used as an example:</p>
26 27 28 29 30 31 32
<pre>
    &lt;master-server&gt;192.168.1.11&lt;/master-server&gt;
    &lt;master-server-port&gt;8001&lt;/master-server-port&gt;
    &lt;master-update-interval&gt;120&lt;/master-update-interval&gt;
    &lt;master-password&gt;hackme&lt;/master-password&gt;
</pre>
In this example, this configuration is setup in the server which will be doing the relaying (slave server).  The master server in this case need not be configured (and actually is unaware of the relaying being performed) as a relay.  When the slave server is started, it will connect to the master server located at 192.168.1.11:8001 and will begin to relay all mountpoints connected to the master server.  Additionally, every master-update-interval (120 seconds in this case) the slave server will poll the master server to see if any new mountpoints have connected, 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.
j's avatar
j committed
33 34 35
<br />
<br />
<br />
36 37 38 39 40 41 42 43 44 45 46 47
<h2>Setting Up A Single-Broadcast Relay</h2>
<p>In this case, the master server need not be an icecast2 server.  Supported master servers for a single-broadcast relay are Shoutcast, Icecast1.x, and of course Icecast2. The following configuration snippet is used as an example:</p>
<pre>   
    &lt;relay&gt;
        &lt;server&gt;192.168.1.11&lt;/server&gt;
        &lt;port&gt;8001&lt;/port&gt;
        &lt;mount&gt;/example.ogg&lt;/mount&gt;
        &lt;local-mount&gt;/different.ogg&lt;/local-mount&gt;
        &lt;relay-shoutcast-metadata&gt;0&lt;/relay-shoutcast-metadata&gt;
    &lt;/relay&gt;
</pre>
<p>In this example, this configuration is also setup in the server which will be doing the relaying (slave server).  The master server in this case need not be configured (and actually is unaware of the relaying being performed) as a relay.  When the slave server is started, it will connect to the master server located at 192.168.1.11:8001 and will begin to relay only the mountpoint specified (/example.ogg in this case).  Using this type of relay, the user can override the local mountpoint name and make it something entirely different than the one on the master server.  Additionally, if the server is a Shoutcast server, then the &lt;mount&gt; must be specified as /.  And if you want the Shoutcast relay stream to have metadata contained within it (Shoutcast metadata is embedded in the stream itself) then the &lt;relay-shoutcast-metadata&gt; needs to be set to 1.</p>
j's avatar
j committed
48 49 50
<br />
<br />
<br />
51 52 53
</div>
</body>
</html>