Listen Sockets

Icecast 2.5.x page

This page discusses the topic in context of Icecast 2.5.x. The situation for 2.4.x might be different.

Overview

Icecast supports to listen on multiple sockets. Each socket is configured via a <listen-socket />. Each listen socket supports a number of options.

Configuration

The <listen-socket /> tag is used to configure listen sockets. Options are defined via sub-tags.

Properties

Option	Required	Type	Default	Description
`id`	no	id	none	Identifier for the listen socket
`on-behalf-of`	no	URI	none	TODO
`type`	no	socket type	`normal`	Type of the listen socket. One of `normal`, or `virtual`

Sub-tags

Option	Required	Type	Default	Description
`port`	no	port number	`8000`	The port number to listen on (0-65535, but in most cases 1025-49151)
`tls`	no	TLS mode	`disabled`	The TLS mode to be used for this listen socket.
`bind-address`	no	FQDN	any	The hostname used to listen on. If the hostname resolves to multiple addresses, the system defaults will be used to find the most suitable address. If mapping of legacy IP is supported via IPv6 sockets IPv6 addresses are preferred.
`client-address`	no	FQDN	none	The outbound address used by this listen socket. This is specifically used by `type="virtual"` listen sockets.
`so-sndbuf`	no	positive integer	system default	The send buffer to be used with client connections on this listen socket. It is not recommended to alter this value.
`listen-backlog`	no	positive integer	Icecast default	The listen backlog to use for the listen socket. On very busy servers with a lot clients connecting at the same time it might be useful to increase this value slightly (e.g. to 15). A very high value suggests misconfiguration or system overload.
`authentication`	no	Authentication block	none	Additional authentication configuration specific to this listen socket. This is generally not needed.
`http-headers`	no	HTTP headers block	none	Additional HTTP headers specific to this listen socket. This is generally not needed.
`shoutcast-compat`	no	boolean	`false`	Whether this listen socket should accept shoutcast legacy clients. This value should be kept at it's default even for most shoutcast legacy enabled setups. See also `shoutcast-mount`.
`shoutcast-mount`	no	mount point	none	The mount point to use for shoutcast legacy clients. This will create another listen socket with the correct values as per requirements of shoutcast. This is mostly for software from the 90s.
`trusted-proxy`	no	URI	none	The URI of the id of any listen sockets (likely `type="virtual"`) that terminate the client's connection (e.g. reverse proxies). Setting this allows those proxies to act on behalf of the client.