[xiph-commits] r9327 - icecast/branches/kh/icecast/doc
karl at motherfish-iii.xiph.org
karl at motherfish-iii.xiph.org
Mon May 30 09:49:43 PDT 2005
Author: karl
Date: 2005-05-30 09:49:41 -0700 (Mon, 30 May 2005)
New Revision: 9327
Modified:
icecast/branches/kh/icecast/doc/icecast2_config_file.html
Log:
docs update
Modified: icecast/branches/kh/icecast/doc/icecast2_config_file.html
===================================================================
--- icecast/branches/kh/icecast/doc/icecast2_config_file.html 2005-05-30 15:32:45 UTC (rev 9326)
+++ icecast/branches/kh/icecast/doc/icecast2_config_file.html 2005-05-30 16:49:41 UTC (rev 9327)
@@ -221,6 +221,7 @@
<password>soap</password>
<relay-shoutcast-metadata>0</relay-shoutcast-metadata>
<on-demand>0</on-demand>
+ <enable>1</enable>
</relay>
</pre>
<p>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.
@@ -314,6 +315,7 @@
<password>soap</password>
<relay-shoutcast-metadata>0</relay-shoutcast-metadata>
<on-demand>1</on-demand>
+ <enable>1</enable>
</relay>
</pre>
@@ -351,6 +353,14 @@
An on-demand relay will only retrieve the stream if there are listeners connected
(1=enabled, 0=disabled).
</div>
+<h4>enable</h4>
+<div class="indentedbox">
+ <p>The default setting is 1 which means that the relay is active, so it connection
+ attempts occur when they need to etc. If enable is 0 then the mountpoint name is
+ reserved but nothing else occurs, so it is useful if a source of the relay is known
+ to be having problems. Can be updated over HUP or via the admin pages.
+ </p>
+</div>
<p>
<br />
@@ -366,10 +376,18 @@
<password>hackmemore</password>
<max-listeners>1</max-listeners>
<dump-file>/tmp/dump-example1.ogg</dump-file>
- <intro>/path/to/intro.ogg</intro>
+ <intro>/intro.ogg</intro>
<fallback-mount>/example2.ogg</fallback-mount>
<fallback-override>1</fallback-override>
- <no-yp>1</no-yp>
+ <fallback-when-full>1</fallback-when-full>
+ <public>1</public>
+ <stream-name>My audio stream</stream-name>
+ <stream-description>My audio description</stream-description>
+ <stream-url>http://some.place.com</stream-url>
+ <genre>classical</genre>
+ <bitrate>64</bitrate>
+ <type>application/ogg</type>
+ <subtype>vorbis</subtype>
<hidden>1</hidden>
<burst-size>65536</burst-size>
<mp3-metadata-interval>8192</mp3-metadata-interval>
@@ -377,11 +395,21 @@
<option name="filename" value="myauth"/>
<option name="allow_duplicate_users" value="0"/>
</authentication>
-
+ <on-connect>/home/icecast/bin/source-start</on-connect>
+ <on-disconnect>/home/icecast/bin/source-end</on-disconnect>
</mount>
</pre>
-<p>This section contains settings which apply only to a specific mountpoint. Within this section you can reserve a specific mountpoint and set a source username/password for that mountpoint (not yet implemented) as well as specify individual settings which will apply only to the supplied mountpoint.
+<p>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.
</p>
+<p>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.
+</p>
<h4>mount-name</h4>
<div class="indentedbox">
The name of the mount point for which these settings apply.
@@ -406,7 +434,7 @@
<div class="indentedbox">
An 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.
+streaming format. The specified file is appended to webroot before being opened.
</div>
<h4>fallback-mount</h4>
<div class="indentedbox">
@@ -425,12 +453,74 @@
When enabled, this allows a connecting source client or relay on this mountpoint to move
listening clients back from the fallback mount.
</div>
+<h4>fallback-when-full</h4>
+<div class="indentedbox">
+ <p>When set to 1, this will cause new listeners (when the max listener has been reached)
+ to move to the fallback mount if there is one specified.
+ </p>
+</div>
<h4>no-yp</h4>
<div class="indentedbox">
-Setting this option prevents this mountpoint from advertising on YP. The default is 0 so YP
-advertising occurs however you may want to prevent it here if you intend listeners to connect
-to a local relay instead
+ <p>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 <public>
+ </p>
</div>
+<h4>public</h4>
+<div class="indentedbox">
+ <p>The 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.
+ </p>
+</div>
+<h4>stream-name</h4>
+<div class="indentedbox">
+ <p>Setting this will add the specified name to the stats (and therefore YP) for this
+ mountpoint even if the source client/relay provide one.
+ </p>
+</div>
+<h4>stream-description</h4>
+<div class="indentedbox">
+ <p>Setting this will add the specified description to the stats (and therefore YP) for
+ this mountpoint even if the source client/relay provide one.
+ </p>
+</div>
+<h4>stream-url</h4>
+<div class="indentedbox">
+ <p>Setting 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.
+ </p>
+</div>
+<h4>genre</h4>
+<div class="indentedbox">
+ <p>Setting 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.
+ </p>
+</div>
+<h4>bitrate</h4>
+<div class="indentedbox">
+ <p>Setting 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.
+ </p>
+</div>
+<h4>type</h4>
+<div class="indentedbox">
+ <p>Setting 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.
+ </p>
+</div>
+<h4>subtype</h4>
+<div class="indentedbox">
+ <p>Setting 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
+ </p>
+</div>
<h4>burst-size</h4>
<div class="indentedbox">
This optional setting allows for providing a burst size which overrides the default burst size
@@ -459,6 +549,20 @@
<div class="indentedbox">
This 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 <a href="icecast2_listenerauth.html">here</a>.
</div>
+<h4>on-connect</h4>
+<div class="indentedbox">
+ <p>State a program that is run when the source is started. It is passed 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
+ </p>
+</div>
+<h4>on-disconnect</h4>
+<div class="indentedbox">
+ <p>State a program that is run when the source ends. It is passed 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
+ </p>
+</div>
<p>
<br />
<br />
More information about the commits
mailing list